id
int32 0
24.9k
| repo
stringlengths 5
58
| path
stringlengths 9
168
| func_name
stringlengths 9
130
| original_string
stringlengths 66
10.5k
| language
stringclasses 1
value | code
stringlengths 66
10.5k
| code_tokens
list | docstring
stringlengths 8
16k
| docstring_tokens
list | sha
stringlengths 40
40
| url
stringlengths 94
266
|
|---|---|---|---|---|---|---|---|---|---|---|---|
13,200
|
mongodb/mongo-ruby-driver
|
lib/mongo/collection.rb
|
Mongo.Collection.update_one
|
def update_one(filter, update, options = {})
find(filter, options).update_one(update, options)
end
|
ruby
|
def update_one(filter, update, options = {})
find(filter, options).update_one(update, options)
end
|
[
"def",
"update_one",
"(",
"filter",
",",
"update",
",",
"options",
"=",
"{",
"}",
")",
"find",
"(",
"filter",
",",
"options",
")",
".",
"update_one",
"(",
"update",
",",
"options",
")",
"end"
] |
Update a single document in the collection.
@example Update a single document in the collection.
collection.update_one({ name: 'test'}, '$set' => { name: 'test1'})
@param [ Hash ] filter The filter to use.
@param [ Hash ] update The update statement.
@param [ Hash ] options The options.
@option options [ true, false ] :upsert Whether to upsert if the
document doesn't exist.
@option options [ true, false ] :bypass_document_validation Whether or
not to skip document level validation.
@option options [ Hash ] :collation The collation to use.
@option options [ Array ] :array_filters A set of filters specifying to which array elements
an update should apply.
@option options [ Session ] :session The session to use.
@return [ Result ] The response from the database.
@since 2.1.0
|
[
"Update",
"a",
"single",
"document",
"in",
"the",
"collection",
"."
] |
dca26d0870cb3386fad9ccc1d17228097c1fe1c8
|
https://github.com/mongodb/mongo-ruby-driver/blob/dca26d0870cb3386fad9ccc1d17228097c1fe1c8/lib/mongo/collection.rb#L663-L665
|
13,201
|
mongodb/mongo-ruby-driver
|
lib/mongo/collection.rb
|
Mongo.Collection.find_one_and_update
|
def find_one_and_update(filter, update, options = {})
find(filter, options).find_one_and_update(update, options)
end
|
ruby
|
def find_one_and_update(filter, update, options = {})
find(filter, options).find_one_and_update(update, options)
end
|
[
"def",
"find_one_and_update",
"(",
"filter",
",",
"update",
",",
"options",
"=",
"{",
"}",
")",
"find",
"(",
"filter",
",",
"options",
")",
".",
"find_one_and_update",
"(",
"update",
",",
"options",
")",
"end"
] |
Finds a single document via findAndModify and updates it, returning the original doc unless
otherwise specified.
@example Find a document and update it, returning the original.
collection.find_one_and_update({ name: 'test' }, { "$set" => { name: 'test1' }})
@example Find a document and update it, returning the updated document.
collection.find_one_and_update({ name: 'test' }, { "$set" => { name: 'test1' }}, :return_document => :after)
@param [ Hash ] filter The filter to use.
@param [ BSON::Document ] update The update statement.
@param [ Hash ] options The options.
@option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
to run in milliseconds.
@option options [ Hash ] :projection The fields to include or exclude in the returned doc.
@option options [ Hash ] :sort The key and direction pairs by which the result set
will be sorted.
@option options [ Symbol ] :return_document Either :before or :after.
@option options [ true, false ] :upsert Whether to upsert if the document doesn't exist.
@option options [ true, false ] :bypass_document_validation Whether or
not to skip document level validation.
@option options [ Hash ] :write_concern The write concern options.
Defaults to the collection's write concern.
@option options [ Hash ] :collation The collation to use.
@option options [ Array ] :array_filters A set of filters specifying to which array elements
an update should apply.
@option options [ Session ] :session The session to use.
@return [ BSON::Document ] The document.
@since 2.1.0
|
[
"Finds",
"a",
"single",
"document",
"via",
"findAndModify",
"and",
"updates",
"it",
"returning",
"the",
"original",
"doc",
"unless",
"otherwise",
"specified",
"."
] |
dca26d0870cb3386fad9ccc1d17228097c1fe1c8
|
https://github.com/mongodb/mongo-ruby-driver/blob/dca26d0870cb3386fad9ccc1d17228097c1fe1c8/lib/mongo/collection.rb#L725-L727
|
13,202
|
mongodb/mongo-ruby-driver
|
lib/mongo/collection.rb
|
Mongo.Collection.find_one_and_replace
|
def find_one_and_replace(filter, replacement, options = {})
find(filter, options).find_one_and_update(replacement, options)
end
|
ruby
|
def find_one_and_replace(filter, replacement, options = {})
find(filter, options).find_one_and_update(replacement, options)
end
|
[
"def",
"find_one_and_replace",
"(",
"filter",
",",
"replacement",
",",
"options",
"=",
"{",
"}",
")",
"find",
"(",
"filter",
",",
"options",
")",
".",
"find_one_and_update",
"(",
"replacement",
",",
"options",
")",
"end"
] |
Finds a single document and replaces it, returning the original doc unless
otherwise specified.
@example Find a document and replace it, returning the original.
collection.find_one_and_replace({ name: 'test' }, { name: 'test1' })
@example Find a document and replace it, returning the new document.
collection.find_one_and_replace({ name: 'test' }, { name: 'test1' }, :return_document => :after)
@param [ Hash ] filter The filter to use.
@param [ BSON::Document ] replacement The replacement document.
@param [ Hash ] options The options.
@option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
to run in milliseconds.
@option options [ Hash ] :projection The fields to include or exclude in the returned doc.
@option options [ Hash ] :sort The key and direction pairs by which the result set
will be sorted.
@option options [ Symbol ] :return_document Either :before or :after.
@option options [ true, false ] :upsert Whether to upsert if the document doesn't exist.
@option options [ true, false ] :bypass_document_validation Whether or
not to skip document level validation.
@option options [ Hash ] :write_concern The write concern options.
Defaults to the collection's write concern.
@option options [ Hash ] :collation The collation to use.
@option options [ Session ] :session The session to use.
@return [ BSON::Document ] The document.
@since 2.1.0
|
[
"Finds",
"a",
"single",
"document",
"and",
"replaces",
"it",
"returning",
"the",
"original",
"doc",
"unless",
"otherwise",
"specified",
"."
] |
dca26d0870cb3386fad9ccc1d17228097c1fe1c8
|
https://github.com/mongodb/mongo-ruby-driver/blob/dca26d0870cb3386fad9ccc1d17228097c1fe1c8/lib/mongo/collection.rb#L759-L761
|
13,203
|
Katello/katello
|
app/controllers/katello/application_controller.rb
|
Katello.ApplicationController.render_bad_parameters
|
def render_bad_parameters(*args)
default_message = if request.xhr?
_('Invalid parameters sent in the request for this operation. Please contact a system administrator.')
else
_('Invalid parameters sent. You may have mistyped the address. If you continue having trouble with this, please contact an Administrator.')
end
exception = args.find { |o| o.is_a? Exception }
message = args.find { |o| o.is_a? String } || exception.try(:message) || default_message
status = if exception && exception.respond_to?(:status_code)
exception.status_code
else
400
end
if exception
log_exception exception
else
Rails.logger.warn message
end
respond_to do |format|
format.html do
render :template => 'common/400', :layout => !request.xhr?, :status => status,
:locals => {:message => message}
end
format.atom { head exception.status_code }
format.xml { head exception.status_code }
format.json { head exception.status_code }
end
User.current = nil
end
|
ruby
|
def render_bad_parameters(*args)
default_message = if request.xhr?
_('Invalid parameters sent in the request for this operation. Please contact a system administrator.')
else
_('Invalid parameters sent. You may have mistyped the address. If you continue having trouble with this, please contact an Administrator.')
end
exception = args.find { |o| o.is_a? Exception }
message = args.find { |o| o.is_a? String } || exception.try(:message) || default_message
status = if exception && exception.respond_to?(:status_code)
exception.status_code
else
400
end
if exception
log_exception exception
else
Rails.logger.warn message
end
respond_to do |format|
format.html do
render :template => 'common/400', :layout => !request.xhr?, :status => status,
:locals => {:message => message}
end
format.atom { head exception.status_code }
format.xml { head exception.status_code }
format.json { head exception.status_code }
end
User.current = nil
end
|
[
"def",
"render_bad_parameters",
"(",
"*",
"args",
")",
"default_message",
"=",
"if",
"request",
".",
"xhr?",
"_",
"(",
"'Invalid parameters sent in the request for this operation. Please contact a system administrator.'",
")",
"else",
"_",
"(",
"'Invalid parameters sent. You may have mistyped the address. If you continue having trouble with this, please contact an Administrator.'",
")",
"end",
"exception",
"=",
"args",
".",
"find",
"{",
"|",
"o",
"|",
"o",
".",
"is_a?",
"Exception",
"}",
"message",
"=",
"args",
".",
"find",
"{",
"|",
"o",
"|",
"o",
".",
"is_a?",
"String",
"}",
"||",
"exception",
".",
"try",
"(",
":message",
")",
"||",
"default_message",
"status",
"=",
"if",
"exception",
"&&",
"exception",
".",
"respond_to?",
"(",
":status_code",
")",
"exception",
".",
"status_code",
"else",
"400",
"end",
"if",
"exception",
"log_exception",
"exception",
"else",
"Rails",
".",
"logger",
".",
"warn",
"message",
"end",
"respond_to",
"do",
"|",
"format",
"|",
"format",
".",
"html",
"do",
"render",
":template",
"=>",
"'common/400'",
",",
":layout",
"=>",
"!",
"request",
".",
"xhr?",
",",
":status",
"=>",
"status",
",",
":locals",
"=>",
"{",
":message",
"=>",
"message",
"}",
"end",
"format",
".",
"atom",
"{",
"head",
"exception",
".",
"status_code",
"}",
"format",
".",
"xml",
"{",
"head",
"exception",
".",
"status_code",
"}",
"format",
".",
"json",
"{",
"head",
"exception",
".",
"status_code",
"}",
"end",
"User",
".",
"current",
"=",
"nil",
"end"
] |
render bad params to user
@overload render_bad_parameters()
render bad_parameters with `default_message` and status `400`
@overload render_bad_parameters(message)
render bad_parameters with `message` and status `400`
@param [String] message
@overload render_bad_parameters(error)
render bad_parameters with `error.message` and `error.status_code` if present
@param [Exception] error
@overload render_bad_parameters(error, message)
add `message` to overload `exception.message`
@param [String] message
@param [Exception] error
|
[
"render",
"bad",
"params",
"to",
"user"
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/controllers/katello/application_controller.rb#L100-L132
|
13,204
|
Katello/katello
|
app/controllers/katello/api/v2/sync_controller.rb
|
Katello.Api::V2::SyncController.find_object
|
def find_object
if params.key?(:product_id)
@obj = find_product
elsif params.key?(:repository_id)
@obj = find_repository
else
fail HttpErrors::NotFound, N_("Couldn't find subject of synchronization") if @obj.nil?
end
@obj
end
|
ruby
|
def find_object
if params.key?(:product_id)
@obj = find_product
elsif params.key?(:repository_id)
@obj = find_repository
else
fail HttpErrors::NotFound, N_("Couldn't find subject of synchronization") if @obj.nil?
end
@obj
end
|
[
"def",
"find_object",
"if",
"params",
".",
"key?",
"(",
":product_id",
")",
"@obj",
"=",
"find_product",
"elsif",
"params",
".",
"key?",
"(",
":repository_id",
")",
"@obj",
"=",
"find_repository",
"else",
"fail",
"HttpErrors",
"::",
"NotFound",
",",
"N_",
"(",
"\"Couldn't find subject of synchronization\"",
")",
"if",
"@obj",
".",
"nil?",
"end",
"@obj",
"end"
] |
used in unit tests
|
[
"used",
"in",
"unit",
"tests"
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/controllers/katello/api/v2/sync_controller.rb#L16-L25
|
13,205
|
Katello/katello
|
app/models/katello/kt_environment.rb
|
Katello.KTEnvironment.insert_successor
|
def insert_successor(create_params, path)
self.class.transaction do
new_successor = self.class.create!(create_params)
if library?
if path
old_successor = path.first
old_successor.prior = new_successor
end
save_successor new_successor
elsif successor.nil?
save_successor new_successor
else
old_successor = successor
old_successor.prior = new_successor
save_successor new_successor
end
fail HttpErrors::UnprocessableEntity, _('An environment is missing a prior') unless all_have_prior?
new_successor
end
end
|
ruby
|
def insert_successor(create_params, path)
self.class.transaction do
new_successor = self.class.create!(create_params)
if library?
if path
old_successor = path.first
old_successor.prior = new_successor
end
save_successor new_successor
elsif successor.nil?
save_successor new_successor
else
old_successor = successor
old_successor.prior = new_successor
save_successor new_successor
end
fail HttpErrors::UnprocessableEntity, _('An environment is missing a prior') unless all_have_prior?
new_successor
end
end
|
[
"def",
"insert_successor",
"(",
"create_params",
",",
"path",
")",
"self",
".",
"class",
".",
"transaction",
"do",
"new_successor",
"=",
"self",
".",
"class",
".",
"create!",
"(",
"create_params",
")",
"if",
"library?",
"if",
"path",
"old_successor",
"=",
"path",
".",
"first",
"old_successor",
".",
"prior",
"=",
"new_successor",
"end",
"save_successor",
"new_successor",
"elsif",
"successor",
".",
"nil?",
"save_successor",
"new_successor",
"else",
"old_successor",
"=",
"successor",
"old_successor",
".",
"prior",
"=",
"new_successor",
"save_successor",
"new_successor",
"end",
"fail",
"HttpErrors",
"::",
"UnprocessableEntity",
",",
"_",
"(",
"'An environment is missing a prior'",
")",
"unless",
"all_have_prior?",
"new_successor",
"end",
"end"
] |
creates new env from create_params with self as a prior
|
[
"creates",
"new",
"env",
"from",
"create_params",
"with",
"self",
"as",
"a",
"prior"
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/models/katello/kt_environment.rb#L104-L123
|
13,206
|
Katello/katello
|
app/models/katello/kt_environment.rb
|
Katello.KTEnvironment.full_path
|
def full_path
p = self
until p.prior.nil? || p.prior.library
p = p.prior
end
p.prior.nil? ? p.path : [p.prior] + p.path
end
|
ruby
|
def full_path
p = self
until p.prior.nil? || p.prior.library
p = p.prior
end
p.prior.nil? ? p.path : [p.prior] + p.path
end
|
[
"def",
"full_path",
"p",
"=",
"self",
"until",
"p",
".",
"prior",
".",
"nil?",
"||",
"p",
".",
"prior",
".",
"library",
"p",
"=",
"p",
".",
"prior",
"end",
"p",
".",
"prior",
".",
"nil?",
"?",
"p",
".",
"path",
":",
"[",
"p",
".",
"prior",
"]",
"+",
"p",
".",
"path",
"end"
] |
Unlike path which only gives the path from this environment going forward
Get the full path, that is go to the HEAD of the path this environment is on
and then give me that entire path
|
[
"Unlike",
"path",
"which",
"only",
"gives",
"the",
"path",
"from",
"this",
"environment",
"going",
"forward",
"Get",
"the",
"full",
"path",
"that",
"is",
"go",
"to",
"the",
"HEAD",
"of",
"the",
"path",
"this",
"environment",
"is",
"on",
"and",
"then",
"give",
"me",
"that",
"entire",
"path"
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/models/katello/kt_environment.rb#L196-L202
|
13,207
|
Katello/katello
|
app/helpers/katello/hosts_and_hostgroups_helper.rb
|
Katello.HostsAndHostgroupsHelper.content_options
|
def content_options(host, selected_id, object_type, options = {})
include_blank = options.fetch(:include_blank, nil)
include_blank = '<option></option>' if include_blank == true #check for true specifically
orgs = relevant_organizations(host)
all_options = []
orgs.each do |org|
content_object_options = ""
accessible_content_objects = if object_type == :lifecycle_environment
accessible_lifecycle_environments(org, host)
elsif object_type == :content_source
accessible_content_proxies(host)
end
accessible_content_objects.each do |content_object|
selected = selected_id == content_object.id ? 'selected' : ''
content_object_options << %(<option value="#{content_object.id}" class="kt-env" #{selected}>#{h(content_object.name)}</option>)
end
if orgs.count > 1
all_options << %(<optgroup label="#{org.name}">#{content_object_options}</optgroup>)
else
all_options << content_object_options
end
end
all_options = all_options.join
all_options.insert(0, include_blank) if include_blank
all_options.html_safe
end
|
ruby
|
def content_options(host, selected_id, object_type, options = {})
include_blank = options.fetch(:include_blank, nil)
include_blank = '<option></option>' if include_blank == true #check for true specifically
orgs = relevant_organizations(host)
all_options = []
orgs.each do |org|
content_object_options = ""
accessible_content_objects = if object_type == :lifecycle_environment
accessible_lifecycle_environments(org, host)
elsif object_type == :content_source
accessible_content_proxies(host)
end
accessible_content_objects.each do |content_object|
selected = selected_id == content_object.id ? 'selected' : ''
content_object_options << %(<option value="#{content_object.id}" class="kt-env" #{selected}>#{h(content_object.name)}</option>)
end
if orgs.count > 1
all_options << %(<optgroup label="#{org.name}">#{content_object_options}</optgroup>)
else
all_options << content_object_options
end
end
all_options = all_options.join
all_options.insert(0, include_blank) if include_blank
all_options.html_safe
end
|
[
"def",
"content_options",
"(",
"host",
",",
"selected_id",
",",
"object_type",
",",
"options",
"=",
"{",
"}",
")",
"include_blank",
"=",
"options",
".",
"fetch",
"(",
":include_blank",
",",
"nil",
")",
"include_blank",
"=",
"'<option></option>'",
"if",
"include_blank",
"==",
"true",
"#check for true specifically",
"orgs",
"=",
"relevant_organizations",
"(",
"host",
")",
"all_options",
"=",
"[",
"]",
"orgs",
".",
"each",
"do",
"|",
"org",
"|",
"content_object_options",
"=",
"\"\"",
"accessible_content_objects",
"=",
"if",
"object_type",
"==",
":lifecycle_environment",
"accessible_lifecycle_environments",
"(",
"org",
",",
"host",
")",
"elsif",
"object_type",
"==",
":content_source",
"accessible_content_proxies",
"(",
"host",
")",
"end",
"accessible_content_objects",
".",
"each",
"do",
"|",
"content_object",
"|",
"selected",
"=",
"selected_id",
"==",
"content_object",
".",
"id",
"?",
"'selected'",
":",
"''",
"content_object_options",
"<<",
"%(<option value=\"#{content_object.id}\" class=\"kt-env\" #{selected}>#{h(content_object.name)}</option>)",
"end",
"if",
"orgs",
".",
"count",
">",
"1",
"all_options",
"<<",
"%(<optgroup label=\"#{org.name}\">#{content_object_options}</optgroup>)",
"else",
"all_options",
"<<",
"content_object_options",
"end",
"end",
"all_options",
"=",
"all_options",
".",
"join",
"all_options",
".",
"insert",
"(",
"0",
",",
"include_blank",
")",
"if",
"include_blank",
"all_options",
".",
"html_safe",
"end"
] |
Generic method to provide a list of options in the UI
|
[
"Generic",
"method",
"to",
"provide",
"a",
"list",
"of",
"options",
"in",
"the",
"UI"
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/helpers/katello/hosts_and_hostgroups_helper.rb#L105-L132
|
13,208
|
Katello/katello
|
app/controllers/katello/sync_management_controller.rb
|
Katello.SyncManagementController.sync_repos
|
def sync_repos(repo_ids)
collected = []
repos = Repository.where(:id => repo_ids).syncable
repos.each do |repo|
if latest_task(repo).try(:state) != 'running'
ForemanTasks.async_task(::Actions::Katello::Repository::Sync, repo)
end
collected << format_sync_progress(repo)
end
collected
end
|
ruby
|
def sync_repos(repo_ids)
collected = []
repos = Repository.where(:id => repo_ids).syncable
repos.each do |repo|
if latest_task(repo).try(:state) != 'running'
ForemanTasks.async_task(::Actions::Katello::Repository::Sync, repo)
end
collected << format_sync_progress(repo)
end
collected
end
|
[
"def",
"sync_repos",
"(",
"repo_ids",
")",
"collected",
"=",
"[",
"]",
"repos",
"=",
"Repository",
".",
"where",
"(",
":id",
"=>",
"repo_ids",
")",
".",
"syncable",
"repos",
".",
"each",
"do",
"|",
"repo",
"|",
"if",
"latest_task",
"(",
"repo",
")",
".",
"try",
"(",
":state",
")",
"!=",
"'running'",
"ForemanTasks",
".",
"async_task",
"(",
"::",
"Actions",
"::",
"Katello",
"::",
"Repository",
"::",
"Sync",
",",
"repo",
")",
"end",
"collected",
"<<",
"format_sync_progress",
"(",
"repo",
")",
"end",
"collected",
"end"
] |
loop through checkbox list of products and sync
|
[
"loop",
"through",
"checkbox",
"list",
"of",
"products",
"and",
"sync"
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/controllers/katello/sync_management_controller.rb#L62-L72
|
13,209
|
Katello/katello
|
app/models/katello/repository.rb
|
Katello.Repository.dynflow_handled_last_sync?
|
def dynflow_handled_last_sync?(pulp_task_id)
task = ForemanTasks::Task::DynflowTask.for_action(::Actions::Katello::Repository::Sync).
for_resource(self).order(:started_at).last
return task && task.main_action.pulp_task_id == pulp_task_id
end
|
ruby
|
def dynflow_handled_last_sync?(pulp_task_id)
task = ForemanTasks::Task::DynflowTask.for_action(::Actions::Katello::Repository::Sync).
for_resource(self).order(:started_at).last
return task && task.main_action.pulp_task_id == pulp_task_id
end
|
[
"def",
"dynflow_handled_last_sync?",
"(",
"pulp_task_id",
")",
"task",
"=",
"ForemanTasks",
"::",
"Task",
"::",
"DynflowTask",
".",
"for_action",
"(",
"::",
"Actions",
"::",
"Katello",
"::",
"Repository",
"::",
"Sync",
")",
".",
"for_resource",
"(",
"self",
")",
".",
"order",
"(",
":started_at",
")",
".",
"last",
"return",
"task",
"&&",
"task",
".",
"main_action",
".",
"pulp_task_id",
"==",
"pulp_task_id",
"end"
] |
Returns true if the pulp_task_id was triggered by the last synchronization
action for the repository. Dynflow action handles the synchronization
by it's own so no need to synchronize it again in this callback. Since the
callbacks are run just after synchronization is finished, it should be enough
to check for the last synchronization task.
|
[
"Returns",
"true",
"if",
"the",
"pulp_task_id",
"was",
"triggered",
"by",
"the",
"last",
"synchronization",
"action",
"for",
"the",
"repository",
".",
"Dynflow",
"action",
"handles",
"the",
"synchronization",
"by",
"it",
"s",
"own",
"so",
"no",
"need",
"to",
"synchronize",
"it",
"again",
"in",
"this",
"callback",
".",
"Since",
"the",
"callbacks",
"are",
"run",
"just",
"after",
"synchronization",
"is",
"finished",
"it",
"should",
"be",
"enough",
"to",
"check",
"for",
"the",
"last",
"synchronization",
"task",
"."
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/models/katello/repository.rb#L342-L346
|
13,210
|
Katello/katello
|
app/models/katello/repository.rb
|
Katello.Repository.destroyable?
|
def destroyable?
if self.environment.try(:library?) && self.content_view.default?
if self.environment.organization.being_deleted?
return true
elsif self.custom? && self.deletable?
return true
elsif !self.custom? && self.redhat_deletable?
return true
else
errors.add(:base, _("Repository cannot be deleted since it has already been included in a published Content View. " \
"Please delete all Content View versions containing this repository before attempting to delete it."))
return false
end
end
return true
end
|
ruby
|
def destroyable?
if self.environment.try(:library?) && self.content_view.default?
if self.environment.organization.being_deleted?
return true
elsif self.custom? && self.deletable?
return true
elsif !self.custom? && self.redhat_deletable?
return true
else
errors.add(:base, _("Repository cannot be deleted since it has already been included in a published Content View. " \
"Please delete all Content View versions containing this repository before attempting to delete it."))
return false
end
end
return true
end
|
[
"def",
"destroyable?",
"if",
"self",
".",
"environment",
".",
"try",
"(",
":library?",
")",
"&&",
"self",
".",
"content_view",
".",
"default?",
"if",
"self",
".",
"environment",
".",
"organization",
".",
"being_deleted?",
"return",
"true",
"elsif",
"self",
".",
"custom?",
"&&",
"self",
".",
"deletable?",
"return",
"true",
"elsif",
"!",
"self",
".",
"custom?",
"&&",
"self",
".",
"redhat_deletable?",
"return",
"true",
"else",
"errors",
".",
"add",
"(",
":base",
",",
"_",
"(",
"\"Repository cannot be deleted since it has already been included in a published Content View. \"",
"\"Please delete all Content View versions containing this repository before attempting to delete it.\"",
")",
")",
"return",
"false",
"end",
"end",
"return",
"true",
"end"
] |
deleteable? is already taken by the authorization mixin
|
[
"deleteable?",
"is",
"already",
"taken",
"by",
"the",
"authorization",
"mixin"
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/models/katello/repository.rb#L575-L591
|
13,211
|
Katello/katello
|
app/models/katello/content_view.rb
|
Katello.ContentView.component_ids=
|
def component_ids=(component_version_ids_to_set)
content_view_components.destroy_all
component_version_ids_to_set.each do |content_view_version_id|
cvv = ContentViewVersion.find(content_view_version_id)
content_view_components.build(:content_view_version => cvv,
:latest => false,
:composite_content_view => self)
end
end
|
ruby
|
def component_ids=(component_version_ids_to_set)
content_view_components.destroy_all
component_version_ids_to_set.each do |content_view_version_id|
cvv = ContentViewVersion.find(content_view_version_id)
content_view_components.build(:content_view_version => cvv,
:latest => false,
:composite_content_view => self)
end
end
|
[
"def",
"component_ids",
"=",
"(",
"component_version_ids_to_set",
")",
"content_view_components",
".",
"destroy_all",
"component_version_ids_to_set",
".",
"each",
"do",
"|",
"content_view_version_id",
"|",
"cvv",
"=",
"ContentViewVersion",
".",
"find",
"(",
"content_view_version_id",
")",
"content_view_components",
".",
"build",
"(",
":content_view_version",
"=>",
"cvv",
",",
":latest",
"=>",
"false",
",",
":composite_content_view",
"=>",
"self",
")",
"end",
"end"
] |
Warning this call wipes out existing associations
And replaces them with the component version ids passed in.
|
[
"Warning",
"this",
"call",
"wipes",
"out",
"existing",
"associations",
"And",
"replaces",
"them",
"with",
"the",
"component",
"version",
"ids",
"passed",
"in",
"."
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/models/katello/content_view.rb#L119-L127
|
13,212
|
Katello/katello
|
app/models/katello/content_view.rb
|
Katello.ContentView.all_version_library_instances
|
def all_version_library_instances
all_repos = all_version_repos.where(:library_instance_id => nil).pluck("#{Katello::Repository.table_name}.id")
all_repos += all_version_repos.pluck(:library_instance_id)
Repository.where(:id => all_repos)
end
|
ruby
|
def all_version_library_instances
all_repos = all_version_repos.where(:library_instance_id => nil).pluck("#{Katello::Repository.table_name}.id")
all_repos += all_version_repos.pluck(:library_instance_id)
Repository.where(:id => all_repos)
end
|
[
"def",
"all_version_library_instances",
"all_repos",
"=",
"all_version_repos",
".",
"where",
"(",
":library_instance_id",
"=>",
"nil",
")",
".",
"pluck",
"(",
"\"#{Katello::Repository.table_name}.id\"",
")",
"all_repos",
"+=",
"all_version_repos",
".",
"pluck",
"(",
":library_instance_id",
")",
"Repository",
".",
"where",
"(",
":id",
"=>",
"all_repos",
")",
"end"
] |
get the library instances of all repos within this view
|
[
"get",
"the",
"library",
"instances",
"of",
"all",
"repos",
"within",
"this",
"view"
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/models/katello/content_view.rb#L367-L371
|
13,213
|
Katello/katello
|
app/models/katello/content_view.rb
|
Katello.ContentView.add_environment
|
def add_environment(env, version)
if self.content_view_environments.where(:environment_id => env.id).empty?
label = generate_cp_environment_label(env)
ContentViewEnvironment.create!(:name => label,
:label => label,
:cp_id => generate_cp_environment_id(env),
:environment_id => env.id,
:content_view => self,
:content_view_version => version
)
end
end
|
ruby
|
def add_environment(env, version)
if self.content_view_environments.where(:environment_id => env.id).empty?
label = generate_cp_environment_label(env)
ContentViewEnvironment.create!(:name => label,
:label => label,
:cp_id => generate_cp_environment_id(env),
:environment_id => env.id,
:content_view => self,
:content_view_version => version
)
end
end
|
[
"def",
"add_environment",
"(",
"env",
",",
"version",
")",
"if",
"self",
".",
"content_view_environments",
".",
"where",
"(",
":environment_id",
"=>",
"env",
".",
"id",
")",
".",
"empty?",
"label",
"=",
"generate_cp_environment_label",
"(",
"env",
")",
"ContentViewEnvironment",
".",
"create!",
"(",
":name",
"=>",
"label",
",",
":label",
"=>",
"label",
",",
":cp_id",
"=>",
"generate_cp_environment_id",
"(",
"env",
")",
",",
":environment_id",
"=>",
"env",
".",
"id",
",",
":content_view",
"=>",
"self",
",",
":content_view_version",
"=>",
"version",
")",
"end",
"end"
] |
Associate an environment with this content view. This can occur whenever
a version of the view is promoted to an environment. It is necessary for
candlepin to become aware that the view is available for consumers.
|
[
"Associate",
"an",
"environment",
"with",
"this",
"content",
"view",
".",
"This",
"can",
"occur",
"whenever",
"a",
"version",
"of",
"the",
"view",
"is",
"promoted",
"to",
"an",
"environment",
".",
"It",
"is",
"necessary",
"for",
"candlepin",
"to",
"become",
"aware",
"that",
"the",
"view",
"is",
"available",
"for",
"consumers",
"."
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/models/katello/content_view.rb#L463-L474
|
13,214
|
Katello/katello
|
app/models/katello/content_view.rb
|
Katello.ContentView.remove_environment
|
def remove_environment(env)
# Do not remove the content view environment, if there is still a view
# version in the environment.
if self.versions.in_environment(env).blank?
view_env = self.content_view_environments.where(:environment_id => env.id)
view_env.first.destroy unless view_env.blank?
end
end
|
ruby
|
def remove_environment(env)
# Do not remove the content view environment, if there is still a view
# version in the environment.
if self.versions.in_environment(env).blank?
view_env = self.content_view_environments.where(:environment_id => env.id)
view_env.first.destroy unless view_env.blank?
end
end
|
[
"def",
"remove_environment",
"(",
"env",
")",
"# Do not remove the content view environment, if there is still a view",
"# version in the environment.",
"if",
"self",
".",
"versions",
".",
"in_environment",
"(",
"env",
")",
".",
"blank?",
"view_env",
"=",
"self",
".",
"content_view_environments",
".",
"where",
"(",
":environment_id",
"=>",
"env",
".",
"id",
")",
"view_env",
".",
"first",
".",
"destroy",
"unless",
"view_env",
".",
"blank?",
"end",
"end"
] |
Unassociate an environment from this content view. This can occur whenever
a view is deleted from an environment. It is necessary to make candlepin
aware that the view is no longer available for consumers.
|
[
"Unassociate",
"an",
"environment",
"from",
"this",
"content",
"view",
".",
"This",
"can",
"occur",
"whenever",
"a",
"view",
"is",
"deleted",
"from",
"an",
"environment",
".",
"It",
"is",
"necessary",
"to",
"make",
"candlepin",
"aware",
"that",
"the",
"view",
"is",
"no",
"longer",
"available",
"for",
"consumers",
"."
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/models/katello/content_view.rb#L479-L486
|
13,215
|
Katello/katello
|
app/models/katello/pulp_sync_status.rb
|
Katello.PulpSyncProgress.format_errors
|
def format_errors(details)
errors = {messages: [], details: []}
if details && !details.key?(:finished_count)
details.each do |step, report|
if step == "content"
parse_content(report, errors)
else
parse_generic(report, errors)
end
end
end
errors
end
|
ruby
|
def format_errors(details)
errors = {messages: [], details: []}
if details && !details.key?(:finished_count)
details.each do |step, report|
if step == "content"
parse_content(report, errors)
else
parse_generic(report, errors)
end
end
end
errors
end
|
[
"def",
"format_errors",
"(",
"details",
")",
"errors",
"=",
"{",
"messages",
":",
"[",
"]",
",",
"details",
":",
"[",
"]",
"}",
"if",
"details",
"&&",
"!",
"details",
".",
"key?",
"(",
":finished_count",
")",
"details",
".",
"each",
"do",
"|",
"step",
",",
"report",
"|",
"if",
"step",
"==",
"\"content\"",
"parse_content",
"(",
"report",
",",
"errors",
")",
"else",
"parse_generic",
"(",
"report",
",",
"errors",
")",
"end",
"end",
"end",
"errors",
"end"
] |
Possible formats coming from pulp
We ignore this case:
{'finished_count' => {}}
We extract from this case:
{'content' => {'error' => ''},
'errata' => {'error' => ''},
'packages' => {'error' => ''},
'metadata' => {'error_details => ''}
}
|
[
"Possible",
"formats",
"coming",
"from",
"pulp"
] |
a1c9280067607999cae43bab89b53ba870856b76
|
https://github.com/Katello/katello/blob/a1c9280067607999cae43bab89b53ba870856b76/app/models/katello/pulp_sync_status.rb#L68-L82
|
13,216
|
3scale/3scale_toolbox
|
lib/3scale_toolbox/configuration.rb
|
ThreeScaleToolbox.Configuration.read
|
def read
@store.transaction(true) do
@store.roots.each_with_object({}) do |key, obj|
obj[key] = @store[key]
end
end
end
|
ruby
|
def read
@store.transaction(true) do
@store.roots.each_with_object({}) do |key, obj|
obj[key] = @store[key]
end
end
end
|
[
"def",
"read",
"@store",
".",
"transaction",
"(",
"true",
")",
"do",
"@store",
".",
"roots",
".",
"each_with_object",
"(",
"{",
"}",
")",
"do",
"|",
"key",
",",
"obj",
"|",
"obj",
"[",
"key",
"]",
"=",
"@store",
"[",
"key",
"]",
"end",
"end",
"end"
] |
returns copy of data stored
|
[
"returns",
"copy",
"of",
"data",
"stored"
] |
aeb19add0ae2348788b0b21f641bf88bf7003ea3
|
https://github.com/3scale/3scale_toolbox/blob/aeb19add0ae2348788b0b21f641bf88bf7003ea3/lib/3scale_toolbox/configuration.rb#L27-L33
|
13,217
|
3scale/3scale_toolbox
|
lib/3scale_toolbox/remotes.rb
|
ThreeScaleToolbox.Remotes.update
|
def update
config.update(:remotes) do |rmts|
yield(rmts || {}).tap do |new_rmts|
raise_invalid unless validate(new_rmts)
end
end
end
|
ruby
|
def update
config.update(:remotes) do |rmts|
yield(rmts || {}).tap do |new_rmts|
raise_invalid unless validate(new_rmts)
end
end
end
|
[
"def",
"update",
"config",
".",
"update",
"(",
":remotes",
")",
"do",
"|",
"rmts",
"|",
"yield",
"(",
"rmts",
"||",
"{",
"}",
")",
".",
"tap",
"do",
"|",
"new_rmts",
"|",
"raise_invalid",
"unless",
"validate",
"(",
"new_rmts",
")",
"end",
"end",
"end"
] |
Update remotes
Perform validation
|
[
"Update",
"remotes",
"Perform",
"validation"
] |
aeb19add0ae2348788b0b21f641bf88bf7003ea3
|
https://github.com/3scale/3scale_toolbox/blob/aeb19add0ae2348788b0b21f641bf88bf7003ea3/lib/3scale_toolbox/remotes.rb#L66-L72
|
13,218
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.subscribe
|
def subscribe(*topics)
# Create topic partition list with topics and no partition set
tpl = TopicPartitionList.new_native_tpl(topics.length)
topics.each do |topic|
Rdkafka::Bindings.rd_kafka_topic_partition_list_add(
tpl,
topic,
-1
)
end
# Subscribe to topic partition list and check this was successful
response = Rdkafka::Bindings.rd_kafka_subscribe(@native_kafka, tpl)
if response != 0
raise Rdkafka::RdkafkaError.new(response, "Error subscribing to '#{topics.join(', ')}'")
end
end
|
ruby
|
def subscribe(*topics)
# Create topic partition list with topics and no partition set
tpl = TopicPartitionList.new_native_tpl(topics.length)
topics.each do |topic|
Rdkafka::Bindings.rd_kafka_topic_partition_list_add(
tpl,
topic,
-1
)
end
# Subscribe to topic partition list and check this was successful
response = Rdkafka::Bindings.rd_kafka_subscribe(@native_kafka, tpl)
if response != 0
raise Rdkafka::RdkafkaError.new(response, "Error subscribing to '#{topics.join(', ')}'")
end
end
|
[
"def",
"subscribe",
"(",
"*",
"topics",
")",
"# Create topic partition list with topics and no partition set",
"tpl",
"=",
"TopicPartitionList",
".",
"new_native_tpl",
"(",
"topics",
".",
"length",
")",
"topics",
".",
"each",
"do",
"|",
"topic",
"|",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_topic_partition_list_add",
"(",
"tpl",
",",
"topic",
",",
"-",
"1",
")",
"end",
"# Subscribe to topic partition list and check this was successful",
"response",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_subscribe",
"(",
"@native_kafka",
",",
"tpl",
")",
"if",
"response",
"!=",
"0",
"raise",
"Rdkafka",
"::",
"RdkafkaError",
".",
"new",
"(",
"response",
",",
"\"Error subscribing to '#{topics.join(', ')}'\"",
")",
"end",
"end"
] |
Subscribe to one or more topics letting Kafka handle partition assignments.
@param topics [Array<String>] One or more topic names
@raise [RdkafkaError] When subscribing fails
@return [nil]
|
[
"Subscribe",
"to",
"one",
"or",
"more",
"topics",
"letting",
"Kafka",
"handle",
"partition",
"assignments",
"."
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L31-L47
|
13,219
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.unsubscribe
|
def unsubscribe
response = Rdkafka::Bindings.rd_kafka_unsubscribe(@native_kafka)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
end
|
ruby
|
def unsubscribe
response = Rdkafka::Bindings.rd_kafka_unsubscribe(@native_kafka)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
end
|
[
"def",
"unsubscribe",
"response",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_unsubscribe",
"(",
"@native_kafka",
")",
"if",
"response",
"!=",
"0",
"raise",
"Rdkafka",
"::",
"RdkafkaError",
".",
"new",
"(",
"response",
")",
"end",
"end"
] |
Unsubscribe from all subscribed topics.
@raise [RdkafkaError] When unsubscribing fails
@return [nil]
|
[
"Unsubscribe",
"from",
"all",
"subscribed",
"topics",
"."
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L54-L59
|
13,220
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.pause
|
def pause(list)
unless list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be a TopicPartitionList")
end
tpl = list.to_native_tpl
response = Rdkafka::Bindings.rd_kafka_pause_partitions(@native_kafka, tpl)
if response != 0
list = TopicPartitionList.from_native_tpl(tpl)
raise Rdkafka::RdkafkaTopicPartitionListError.new(response, list, "Error pausing '#{list.to_h}'")
end
end
|
ruby
|
def pause(list)
unless list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be a TopicPartitionList")
end
tpl = list.to_native_tpl
response = Rdkafka::Bindings.rd_kafka_pause_partitions(@native_kafka, tpl)
if response != 0
list = TopicPartitionList.from_native_tpl(tpl)
raise Rdkafka::RdkafkaTopicPartitionListError.new(response, list, "Error pausing '#{list.to_h}'")
end
end
|
[
"def",
"pause",
"(",
"list",
")",
"unless",
"list",
".",
"is_a?",
"(",
"TopicPartitionList",
")",
"raise",
"TypeError",
".",
"new",
"(",
"\"list has to be a TopicPartitionList\"",
")",
"end",
"tpl",
"=",
"list",
".",
"to_native_tpl",
"response",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_pause_partitions",
"(",
"@native_kafka",
",",
"tpl",
")",
"if",
"response",
"!=",
"0",
"list",
"=",
"TopicPartitionList",
".",
"from_native_tpl",
"(",
"tpl",
")",
"raise",
"Rdkafka",
"::",
"RdkafkaTopicPartitionListError",
".",
"new",
"(",
"response",
",",
"list",
",",
"\"Error pausing '#{list.to_h}'\"",
")",
"end",
"end"
] |
Pause producing or consumption for the provided list of partitions
@param list [TopicPartitionList] The topic with partitions to pause
@raise [RdkafkaTopicPartitionListError] When pausing subscription fails.
@return [nil]
|
[
"Pause",
"producing",
"or",
"consumption",
"for",
"the",
"provided",
"list",
"of",
"partitions"
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L68-L79
|
13,221
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.resume
|
def resume(list)
unless list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be a TopicPartitionList")
end
tpl = list.to_native_tpl
response = Rdkafka::Bindings.rd_kafka_resume_partitions(@native_kafka, tpl)
if response != 0
raise Rdkafka::RdkafkaError.new(response, "Error resume '#{list.to_h}'")
end
end
|
ruby
|
def resume(list)
unless list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be a TopicPartitionList")
end
tpl = list.to_native_tpl
response = Rdkafka::Bindings.rd_kafka_resume_partitions(@native_kafka, tpl)
if response != 0
raise Rdkafka::RdkafkaError.new(response, "Error resume '#{list.to_h}'")
end
end
|
[
"def",
"resume",
"(",
"list",
")",
"unless",
"list",
".",
"is_a?",
"(",
"TopicPartitionList",
")",
"raise",
"TypeError",
".",
"new",
"(",
"\"list has to be a TopicPartitionList\"",
")",
"end",
"tpl",
"=",
"list",
".",
"to_native_tpl",
"response",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_resume_partitions",
"(",
"@native_kafka",
",",
"tpl",
")",
"if",
"response",
"!=",
"0",
"raise",
"Rdkafka",
"::",
"RdkafkaError",
".",
"new",
"(",
"response",
",",
"\"Error resume '#{list.to_h}'\"",
")",
"end",
"end"
] |
Resume producing consumption for the provided list of partitions
@param list [TopicPartitionList] The topic with partitions to pause
@raise [RdkafkaError] When resume subscription fails.
@return [nil]
|
[
"Resume",
"producing",
"consumption",
"for",
"the",
"provided",
"list",
"of",
"partitions"
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L88-L97
|
13,222
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.subscription
|
def subscription
tpl = FFI::MemoryPointer.new(:pointer)
response = Rdkafka::Bindings.rd_kafka_subscription(@native_kafka, tpl)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
tpl = tpl.read(:pointer).tap { |it| it.autorelease = false }
begin
Rdkafka::Consumer::TopicPartitionList.from_native_tpl(tpl)
ensure
Rdkafka::Bindings.rd_kafka_topic_partition_list_destroy(tpl)
end
end
|
ruby
|
def subscription
tpl = FFI::MemoryPointer.new(:pointer)
response = Rdkafka::Bindings.rd_kafka_subscription(@native_kafka, tpl)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
tpl = tpl.read(:pointer).tap { |it| it.autorelease = false }
begin
Rdkafka::Consumer::TopicPartitionList.from_native_tpl(tpl)
ensure
Rdkafka::Bindings.rd_kafka_topic_partition_list_destroy(tpl)
end
end
|
[
"def",
"subscription",
"tpl",
"=",
"FFI",
"::",
"MemoryPointer",
".",
"new",
"(",
":pointer",
")",
"response",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_subscription",
"(",
"@native_kafka",
",",
"tpl",
")",
"if",
"response",
"!=",
"0",
"raise",
"Rdkafka",
"::",
"RdkafkaError",
".",
"new",
"(",
"response",
")",
"end",
"tpl",
"=",
"tpl",
".",
"read",
"(",
":pointer",
")",
".",
"tap",
"{",
"|",
"it",
"|",
"it",
".",
"autorelease",
"=",
"false",
"}",
"begin",
"Rdkafka",
"::",
"Consumer",
"::",
"TopicPartitionList",
".",
"from_native_tpl",
"(",
"tpl",
")",
"ensure",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_topic_partition_list_destroy",
"(",
"tpl",
")",
"end",
"end"
] |
Return the current subscription to topics and partitions
@raise [RdkafkaError] When getting the subscription fails.
@return [TopicPartitionList]
|
[
"Return",
"the",
"current",
"subscription",
"to",
"topics",
"and",
"partitions"
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L104-L117
|
13,223
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.assign
|
def assign(list)
unless list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be a TopicPartitionList")
end
tpl = list.to_native_tpl
response = Rdkafka::Bindings.rd_kafka_assign(@native_kafka, tpl)
if response != 0
raise Rdkafka::RdkafkaError.new(response, "Error assigning '#{list.to_h}'")
end
end
|
ruby
|
def assign(list)
unless list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be a TopicPartitionList")
end
tpl = list.to_native_tpl
response = Rdkafka::Bindings.rd_kafka_assign(@native_kafka, tpl)
if response != 0
raise Rdkafka::RdkafkaError.new(response, "Error assigning '#{list.to_h}'")
end
end
|
[
"def",
"assign",
"(",
"list",
")",
"unless",
"list",
".",
"is_a?",
"(",
"TopicPartitionList",
")",
"raise",
"TypeError",
".",
"new",
"(",
"\"list has to be a TopicPartitionList\"",
")",
"end",
"tpl",
"=",
"list",
".",
"to_native_tpl",
"response",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_assign",
"(",
"@native_kafka",
",",
"tpl",
")",
"if",
"response",
"!=",
"0",
"raise",
"Rdkafka",
"::",
"RdkafkaError",
".",
"new",
"(",
"response",
",",
"\"Error assigning '#{list.to_h}'\"",
")",
"end",
"end"
] |
Atomic assignment of partitions to consume
@param list [TopicPartitionList] The topic with partitions to assign
@raise [RdkafkaError] When assigning fails
|
[
"Atomic",
"assignment",
"of",
"partitions",
"to",
"consume"
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L124-L133
|
13,224
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.committed
|
def committed(list=nil, timeout_ms=1200)
if list.nil?
list = assignment
elsif !list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be nil or a TopicPartitionList")
end
tpl = list.to_native_tpl
response = Rdkafka::Bindings.rd_kafka_committed(@native_kafka, tpl, timeout_ms)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
TopicPartitionList.from_native_tpl(tpl)
end
|
ruby
|
def committed(list=nil, timeout_ms=1200)
if list.nil?
list = assignment
elsif !list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be nil or a TopicPartitionList")
end
tpl = list.to_native_tpl
response = Rdkafka::Bindings.rd_kafka_committed(@native_kafka, tpl, timeout_ms)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
TopicPartitionList.from_native_tpl(tpl)
end
|
[
"def",
"committed",
"(",
"list",
"=",
"nil",
",",
"timeout_ms",
"=",
"1200",
")",
"if",
"list",
".",
"nil?",
"list",
"=",
"assignment",
"elsif",
"!",
"list",
".",
"is_a?",
"(",
"TopicPartitionList",
")",
"raise",
"TypeError",
".",
"new",
"(",
"\"list has to be nil or a TopicPartitionList\"",
")",
"end",
"tpl",
"=",
"list",
".",
"to_native_tpl",
"response",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_committed",
"(",
"@native_kafka",
",",
"tpl",
",",
"timeout_ms",
")",
"if",
"response",
"!=",
"0",
"raise",
"Rdkafka",
"::",
"RdkafkaError",
".",
"new",
"(",
"response",
")",
"end",
"TopicPartitionList",
".",
"from_native_tpl",
"(",
"tpl",
")",
"end"
] |
Return the current committed offset per partition for this consumer group.
The offset field of each requested partition will either be set to stored offset or to -1001 in case there was no stored offset for that partition.
@param list [TopicPartitionList, nil] The topic with partitions to get the offsets for or nil to use the current subscription.
@param timeout_ms [Integer] The timeout for fetching this information.
@raise [RdkafkaError] When getting the committed positions fails.
@return [TopicPartitionList]
|
[
"Return",
"the",
"current",
"committed",
"offset",
"per",
"partition",
"for",
"this",
"consumer",
"group",
".",
"The",
"offset",
"field",
"of",
"each",
"requested",
"partition",
"will",
"either",
"be",
"set",
"to",
"stored",
"offset",
"or",
"to",
"-",
"1001",
"in",
"case",
"there",
"was",
"no",
"stored",
"offset",
"for",
"that",
"partition",
"."
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L165-L177
|
13,225
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.store_offset
|
def store_offset(message)
# rd_kafka_offset_store is one of the few calls that does not support
# a string as the topic, so create a native topic for it.
native_topic = Rdkafka::Bindings.rd_kafka_topic_new(
@native_kafka,
message.topic,
nil
)
response = Rdkafka::Bindings.rd_kafka_offset_store(
native_topic,
message.partition,
message.offset
)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
ensure
if native_topic && !native_topic.null?
Rdkafka::Bindings.rd_kafka_topic_destroy(native_topic)
end
end
|
ruby
|
def store_offset(message)
# rd_kafka_offset_store is one of the few calls that does not support
# a string as the topic, so create a native topic for it.
native_topic = Rdkafka::Bindings.rd_kafka_topic_new(
@native_kafka,
message.topic,
nil
)
response = Rdkafka::Bindings.rd_kafka_offset_store(
native_topic,
message.partition,
message.offset
)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
ensure
if native_topic && !native_topic.null?
Rdkafka::Bindings.rd_kafka_topic_destroy(native_topic)
end
end
|
[
"def",
"store_offset",
"(",
"message",
")",
"# rd_kafka_offset_store is one of the few calls that does not support",
"# a string as the topic, so create a native topic for it.",
"native_topic",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_topic_new",
"(",
"@native_kafka",
",",
"message",
".",
"topic",
",",
"nil",
")",
"response",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_offset_store",
"(",
"native_topic",
",",
"message",
".",
"partition",
",",
"message",
".",
"offset",
")",
"if",
"response",
"!=",
"0",
"raise",
"Rdkafka",
"::",
"RdkafkaError",
".",
"new",
"(",
"response",
")",
"end",
"ensure",
"if",
"native_topic",
"&&",
"!",
"native_topic",
".",
"null?",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_topic_destroy",
"(",
"native_topic",
")",
"end",
"end"
] |
Store offset of a message to be used in the next commit of this consumer
When using this `enable.auto.offset.store` should be set to `false` in the config.
@param message [Rdkafka::Consumer::Message] The message which offset will be stored
@raise [RdkafkaError] When storing the offset fails
@return [nil]
|
[
"Store",
"offset",
"of",
"a",
"message",
"to",
"be",
"used",
"in",
"the",
"next",
"commit",
"of",
"this",
"consumer"
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L263-L283
|
13,226
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.commit
|
def commit(list=nil, async=false)
if !list.nil? && !list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be nil or a TopicPartitionList")
end
tpl = if list
list.to_native_tpl
else
nil
end
response = Rdkafka::Bindings.rd_kafka_commit(@native_kafka, tpl, async)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
end
|
ruby
|
def commit(list=nil, async=false)
if !list.nil? && !list.is_a?(TopicPartitionList)
raise TypeError.new("list has to be nil or a TopicPartitionList")
end
tpl = if list
list.to_native_tpl
else
nil
end
response = Rdkafka::Bindings.rd_kafka_commit(@native_kafka, tpl, async)
if response != 0
raise Rdkafka::RdkafkaError.new(response)
end
end
|
[
"def",
"commit",
"(",
"list",
"=",
"nil",
",",
"async",
"=",
"false",
")",
"if",
"!",
"list",
".",
"nil?",
"&&",
"!",
"list",
".",
"is_a?",
"(",
"TopicPartitionList",
")",
"raise",
"TypeError",
".",
"new",
"(",
"\"list has to be nil or a TopicPartitionList\"",
")",
"end",
"tpl",
"=",
"if",
"list",
"list",
".",
"to_native_tpl",
"else",
"nil",
"end",
"response",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_commit",
"(",
"@native_kafka",
",",
"tpl",
",",
"async",
")",
"if",
"response",
"!=",
"0",
"raise",
"Rdkafka",
"::",
"RdkafkaError",
".",
"new",
"(",
"response",
")",
"end",
"end"
] |
Commit the current offsets of this consumer
@param list [TopicPartitionList,nil] The topic with partitions to commit
@param async [Boolean] Whether to commit async or wait for the commit to finish
@raise [RdkafkaError] When comitting fails
@return [nil]
|
[
"Commit",
"the",
"current",
"offsets",
"of",
"this",
"consumer"
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L293-L306
|
13,227
|
appsignal/rdkafka-ruby
|
lib/rdkafka/consumer.rb
|
Rdkafka.Consumer.poll
|
def poll(timeout_ms)
message_ptr = Rdkafka::Bindings.rd_kafka_consumer_poll(@native_kafka, timeout_ms)
if message_ptr.null?
nil
else
# Create struct wrapper
native_message = Rdkafka::Bindings::Message.new(message_ptr)
# Raise error if needed
if native_message[:err] != 0
raise Rdkafka::RdkafkaError.new(native_message[:err])
end
# Create a message to pass out
Rdkafka::Consumer::Message.new(native_message)
end
ensure
# Clean up rdkafka message if there is one
if !message_ptr.nil? && !message_ptr.null?
Rdkafka::Bindings.rd_kafka_message_destroy(message_ptr)
end
end
|
ruby
|
def poll(timeout_ms)
message_ptr = Rdkafka::Bindings.rd_kafka_consumer_poll(@native_kafka, timeout_ms)
if message_ptr.null?
nil
else
# Create struct wrapper
native_message = Rdkafka::Bindings::Message.new(message_ptr)
# Raise error if needed
if native_message[:err] != 0
raise Rdkafka::RdkafkaError.new(native_message[:err])
end
# Create a message to pass out
Rdkafka::Consumer::Message.new(native_message)
end
ensure
# Clean up rdkafka message if there is one
if !message_ptr.nil? && !message_ptr.null?
Rdkafka::Bindings.rd_kafka_message_destroy(message_ptr)
end
end
|
[
"def",
"poll",
"(",
"timeout_ms",
")",
"message_ptr",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_consumer_poll",
"(",
"@native_kafka",
",",
"timeout_ms",
")",
"if",
"message_ptr",
".",
"null?",
"nil",
"else",
"# Create struct wrapper",
"native_message",
"=",
"Rdkafka",
"::",
"Bindings",
"::",
"Message",
".",
"new",
"(",
"message_ptr",
")",
"# Raise error if needed",
"if",
"native_message",
"[",
":err",
"]",
"!=",
"0",
"raise",
"Rdkafka",
"::",
"RdkafkaError",
".",
"new",
"(",
"native_message",
"[",
":err",
"]",
")",
"end",
"# Create a message to pass out",
"Rdkafka",
"::",
"Consumer",
"::",
"Message",
".",
"new",
"(",
"native_message",
")",
"end",
"ensure",
"# Clean up rdkafka message if there is one",
"if",
"!",
"message_ptr",
".",
"nil?",
"&&",
"!",
"message_ptr",
".",
"null?",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_message_destroy",
"(",
"message_ptr",
")",
"end",
"end"
] |
Poll for the next message on one of the subscribed topics
@param timeout_ms [Integer] Timeout of this poll
@raise [RdkafkaError] When polling fails
@return [Message, nil] A message or nil if there was no new message within the timeout
|
[
"Poll",
"for",
"the",
"next",
"message",
"on",
"one",
"of",
"the",
"subscribed",
"topics"
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/consumer.rb#L315-L334
|
13,228
|
appsignal/rdkafka-ruby
|
lib/rdkafka/config.rb
|
Rdkafka.Config.consumer
|
def consumer
opaque = Opaque.new
config = native_config(opaque)
if @consumer_rebalance_listener
opaque.consumer_rebalance_listener = @consumer_rebalance_listener
Rdkafka::Bindings.rd_kafka_conf_set_rebalance_cb(config, Rdkafka::Bindings::RebalanceCallback)
end
kafka = native_kafka(config, :rd_kafka_consumer)
# Redirect the main queue to the consumer
Rdkafka::Bindings.rd_kafka_poll_set_consumer(kafka)
# Return consumer with Kafka client
Rdkafka::Consumer.new(kafka)
end
|
ruby
|
def consumer
opaque = Opaque.new
config = native_config(opaque)
if @consumer_rebalance_listener
opaque.consumer_rebalance_listener = @consumer_rebalance_listener
Rdkafka::Bindings.rd_kafka_conf_set_rebalance_cb(config, Rdkafka::Bindings::RebalanceCallback)
end
kafka = native_kafka(config, :rd_kafka_consumer)
# Redirect the main queue to the consumer
Rdkafka::Bindings.rd_kafka_poll_set_consumer(kafka)
# Return consumer with Kafka client
Rdkafka::Consumer.new(kafka)
end
|
[
"def",
"consumer",
"opaque",
"=",
"Opaque",
".",
"new",
"config",
"=",
"native_config",
"(",
"opaque",
")",
"if",
"@consumer_rebalance_listener",
"opaque",
".",
"consumer_rebalance_listener",
"=",
"@consumer_rebalance_listener",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_conf_set_rebalance_cb",
"(",
"config",
",",
"Rdkafka",
"::",
"Bindings",
"::",
"RebalanceCallback",
")",
"end",
"kafka",
"=",
"native_kafka",
"(",
"config",
",",
":rd_kafka_consumer",
")",
"# Redirect the main queue to the consumer",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_poll_set_consumer",
"(",
"kafka",
")",
"# Return consumer with Kafka client",
"Rdkafka",
"::",
"Consumer",
".",
"new",
"(",
"kafka",
")",
"end"
] |
Create a consumer with this configuration.
@raise [ConfigError] When the configuration contains invalid options
@raise [ClientCreationError] When the native client cannot be created
@return [Consumer] The created consumer
|
[
"Create",
"a",
"consumer",
"with",
"this",
"configuration",
"."
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/config.rb#L110-L126
|
13,229
|
appsignal/rdkafka-ruby
|
lib/rdkafka/config.rb
|
Rdkafka.Config.producer
|
def producer
# Create opaque
opaque = Opaque.new
# Create Kafka config
config = native_config(opaque)
# Set callback to receive delivery reports on config
Rdkafka::Bindings.rd_kafka_conf_set_dr_msg_cb(config, Rdkafka::Bindings::DeliveryCallback)
# Return producer with Kafka client
Rdkafka::Producer.new(native_kafka(config, :rd_kafka_producer)).tap do |producer|
opaque.producer = producer
end
end
|
ruby
|
def producer
# Create opaque
opaque = Opaque.new
# Create Kafka config
config = native_config(opaque)
# Set callback to receive delivery reports on config
Rdkafka::Bindings.rd_kafka_conf_set_dr_msg_cb(config, Rdkafka::Bindings::DeliveryCallback)
# Return producer with Kafka client
Rdkafka::Producer.new(native_kafka(config, :rd_kafka_producer)).tap do |producer|
opaque.producer = producer
end
end
|
[
"def",
"producer",
"# Create opaque",
"opaque",
"=",
"Opaque",
".",
"new",
"# Create Kafka config",
"config",
"=",
"native_config",
"(",
"opaque",
")",
"# Set callback to receive delivery reports on config",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_conf_set_dr_msg_cb",
"(",
"config",
",",
"Rdkafka",
"::",
"Bindings",
"::",
"DeliveryCallback",
")",
"# Return producer with Kafka client",
"Rdkafka",
"::",
"Producer",
".",
"new",
"(",
"native_kafka",
"(",
"config",
",",
":rd_kafka_producer",
")",
")",
".",
"tap",
"do",
"|",
"producer",
"|",
"opaque",
".",
"producer",
"=",
"producer",
"end",
"end"
] |
Create a producer with this configuration.
@raise [ConfigError] When the configuration contains invalid options
@raise [ClientCreationError] When the native client cannot be created
@return [Producer] The created producer
|
[
"Create",
"a",
"producer",
"with",
"this",
"configuration",
"."
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/config.rb#L134-L145
|
13,230
|
appsignal/rdkafka-ruby
|
lib/rdkafka/config.rb
|
Rdkafka.Config.native_config
|
def native_config(opaque=nil)
Rdkafka::Bindings.rd_kafka_conf_new.tap do |config|
# Create config
@config_hash.merge(REQUIRED_CONFIG).each do |key, value|
error_buffer = FFI::MemoryPointer.from_string(" " * 256)
result = Rdkafka::Bindings.rd_kafka_conf_set(
config,
key.to_s,
value.to_s,
error_buffer,
256
)
unless result == :config_ok
raise ConfigError.new(error_buffer.read_string)
end
end
# Set opaque pointer that's used as a proxy for callbacks
if opaque
pointer = ::FFI::Pointer.new(:pointer, opaque.object_id)
Rdkafka::Bindings.rd_kafka_conf_set_opaque(config, pointer)
# Store opaque with the pointer as key. We use this approach instead
# of trying to convert the pointer to a Ruby object because there is
# no risk of a segfault this way.
Rdkafka::Config.opaques[pointer.to_i] = opaque
end
# Set log callback
Rdkafka::Bindings.rd_kafka_conf_set_log_cb(config, Rdkafka::Bindings::LogCallback)
# Set stats callback
Rdkafka::Bindings.rd_kafka_conf_set_stats_cb(config, Rdkafka::Bindings::StatsCallback)
end
end
|
ruby
|
def native_config(opaque=nil)
Rdkafka::Bindings.rd_kafka_conf_new.tap do |config|
# Create config
@config_hash.merge(REQUIRED_CONFIG).each do |key, value|
error_buffer = FFI::MemoryPointer.from_string(" " * 256)
result = Rdkafka::Bindings.rd_kafka_conf_set(
config,
key.to_s,
value.to_s,
error_buffer,
256
)
unless result == :config_ok
raise ConfigError.new(error_buffer.read_string)
end
end
# Set opaque pointer that's used as a proxy for callbacks
if opaque
pointer = ::FFI::Pointer.new(:pointer, opaque.object_id)
Rdkafka::Bindings.rd_kafka_conf_set_opaque(config, pointer)
# Store opaque with the pointer as key. We use this approach instead
# of trying to convert the pointer to a Ruby object because there is
# no risk of a segfault this way.
Rdkafka::Config.opaques[pointer.to_i] = opaque
end
# Set log callback
Rdkafka::Bindings.rd_kafka_conf_set_log_cb(config, Rdkafka::Bindings::LogCallback)
# Set stats callback
Rdkafka::Bindings.rd_kafka_conf_set_stats_cb(config, Rdkafka::Bindings::StatsCallback)
end
end
|
[
"def",
"native_config",
"(",
"opaque",
"=",
"nil",
")",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_conf_new",
".",
"tap",
"do",
"|",
"config",
"|",
"# Create config",
"@config_hash",
".",
"merge",
"(",
"REQUIRED_CONFIG",
")",
".",
"each",
"do",
"|",
"key",
",",
"value",
"|",
"error_buffer",
"=",
"FFI",
"::",
"MemoryPointer",
".",
"from_string",
"(",
"\" \"",
"*",
"256",
")",
"result",
"=",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_conf_set",
"(",
"config",
",",
"key",
".",
"to_s",
",",
"value",
".",
"to_s",
",",
"error_buffer",
",",
"256",
")",
"unless",
"result",
"==",
":config_ok",
"raise",
"ConfigError",
".",
"new",
"(",
"error_buffer",
".",
"read_string",
")",
"end",
"end",
"# Set opaque pointer that's used as a proxy for callbacks",
"if",
"opaque",
"pointer",
"=",
"::",
"FFI",
"::",
"Pointer",
".",
"new",
"(",
":pointer",
",",
"opaque",
".",
"object_id",
")",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_conf_set_opaque",
"(",
"config",
",",
"pointer",
")",
"# Store opaque with the pointer as key. We use this approach instead",
"# of trying to convert the pointer to a Ruby object because there is",
"# no risk of a segfault this way.",
"Rdkafka",
"::",
"Config",
".",
"opaques",
"[",
"pointer",
".",
"to_i",
"]",
"=",
"opaque",
"end",
"# Set log callback",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_conf_set_log_cb",
"(",
"config",
",",
"Rdkafka",
"::",
"Bindings",
"::",
"LogCallback",
")",
"# Set stats callback",
"Rdkafka",
"::",
"Bindings",
".",
"rd_kafka_conf_set_stats_cb",
"(",
"config",
",",
"Rdkafka",
"::",
"Bindings",
"::",
"StatsCallback",
")",
"end",
"end"
] |
This method is only intented to be used to create a client,
using it in another way will leak memory.
|
[
"This",
"method",
"is",
"only",
"intented",
"to",
"be",
"used",
"to",
"create",
"a",
"client",
"using",
"it",
"in",
"another",
"way",
"will",
"leak",
"memory",
"."
] |
87b3e0ddae5ea576847cb67228fcea06ec2a24d6
|
https://github.com/appsignal/rdkafka-ruby/blob/87b3e0ddae5ea576847cb67228fcea06ec2a24d6/lib/rdkafka/config.rb#L160-L194
|
13,231
|
puppetlabs/pdk
|
lib/pdk/util.rb
|
PDK.Util.find_upwards
|
def find_upwards(target, start_dir = nil)
previous = nil
current = File.expand_path(start_dir || Dir.pwd)
until !File.directory?(current) || current == previous
filename = File.join(current, target)
return filename if File.file?(filename)
previous = current
current = File.expand_path('..', current)
end
end
|
ruby
|
def find_upwards(target, start_dir = nil)
previous = nil
current = File.expand_path(start_dir || Dir.pwd)
until !File.directory?(current) || current == previous
filename = File.join(current, target)
return filename if File.file?(filename)
previous = current
current = File.expand_path('..', current)
end
end
|
[
"def",
"find_upwards",
"(",
"target",
",",
"start_dir",
"=",
"nil",
")",
"previous",
"=",
"nil",
"current",
"=",
"File",
".",
"expand_path",
"(",
"start_dir",
"||",
"Dir",
".",
"pwd",
")",
"until",
"!",
"File",
".",
"directory?",
"(",
"current",
")",
"||",
"current",
"==",
"previous",
"filename",
"=",
"File",
".",
"join",
"(",
"current",
",",
"target",
")",
"return",
"filename",
"if",
"File",
".",
"file?",
"(",
"filename",
")",
"previous",
"=",
"current",
"current",
"=",
"File",
".",
"expand_path",
"(",
"'..'",
",",
"current",
")",
"end",
"end"
] |
Searches upwards from current working directory for the given target file.
@param target [String] Name of file to search for.
@param start_dir [String] Directory to start searching from, defaults to Dir.pwd
@return [String, nil] Fully qualified path to the given target file if found,
nil if the target file could not be found.
|
[
"Searches",
"upwards",
"from",
"current",
"working",
"directory",
"for",
"the",
"given",
"target",
"file",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/util.rb#L28-L38
|
13,232
|
puppetlabs/pdk
|
lib/pdk/util.rb
|
PDK.Util.make_tmpdir_name
|
def make_tmpdir_name(base)
t = Time.now.strftime('%Y%m%d')
name = "#{base}#{t}-#{Process.pid}-#{rand(0x100000000).to_s(36)}"
File.join(Dir.tmpdir, name)
end
|
ruby
|
def make_tmpdir_name(base)
t = Time.now.strftime('%Y%m%d')
name = "#{base}#{t}-#{Process.pid}-#{rand(0x100000000).to_s(36)}"
File.join(Dir.tmpdir, name)
end
|
[
"def",
"make_tmpdir_name",
"(",
"base",
")",
"t",
"=",
"Time",
".",
"now",
".",
"strftime",
"(",
"'%Y%m%d'",
")",
"name",
"=",
"\"#{base}#{t}-#{Process.pid}-#{rand(0x100000000).to_s(36)}\"",
"File",
".",
"join",
"(",
"Dir",
".",
"tmpdir",
",",
"name",
")",
"end"
] |
Generate a name for a temporary directory.
@param base [String] A string to base the name generation off.
@return [String] The temporary directory path.
|
[
"Generate",
"a",
"name",
"for",
"a",
"temporary",
"directory",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/util.rb#L46-L50
|
13,233
|
puppetlabs/pdk
|
lib/pdk/util.rb
|
PDK.Util.canonical_path
|
def canonical_path(path)
if Gem.win_platform?
unless File.exist?(path)
raise PDK::CLI::FatalError, _("Cannot resolve a full path to '%{path}', as it does not currently exist.") % { path: path }
end
PDK::Util::Windows::File.get_long_pathname(path)
else
File.expand_path(path)
end
end
|
ruby
|
def canonical_path(path)
if Gem.win_platform?
unless File.exist?(path)
raise PDK::CLI::FatalError, _("Cannot resolve a full path to '%{path}', as it does not currently exist.") % { path: path }
end
PDK::Util::Windows::File.get_long_pathname(path)
else
File.expand_path(path)
end
end
|
[
"def",
"canonical_path",
"(",
"path",
")",
"if",
"Gem",
".",
"win_platform?",
"unless",
"File",
".",
"exist?",
"(",
"path",
")",
"raise",
"PDK",
"::",
"CLI",
"::",
"FatalError",
",",
"_",
"(",
"\"Cannot resolve a full path to '%{path}', as it does not currently exist.\"",
")",
"%",
"{",
"path",
":",
"path",
"}",
"end",
"PDK",
"::",
"Util",
"::",
"Windows",
"::",
"File",
".",
"get_long_pathname",
"(",
"path",
")",
"else",
"File",
".",
"expand_path",
"(",
"path",
")",
"end",
"end"
] |
Return an expanded, absolute path
@param path [String] Existing path that may not be canonical
@return [String] Canonical path
|
[
"Return",
"an",
"expanded",
"absolute",
"path"
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/util.rb#L58-L67
|
13,234
|
puppetlabs/pdk
|
lib/pdk/util.rb
|
PDK.Util.cachedir
|
def cachedir
if Gem.win_platform?
File.join(ENV['LOCALAPPDATA'], 'PDK', 'cache')
else
File.join(Dir.home, '.pdk', 'cache')
end
end
|
ruby
|
def cachedir
if Gem.win_platform?
File.join(ENV['LOCALAPPDATA'], 'PDK', 'cache')
else
File.join(Dir.home, '.pdk', 'cache')
end
end
|
[
"def",
"cachedir",
"if",
"Gem",
".",
"win_platform?",
"File",
".",
"join",
"(",
"ENV",
"[",
"'LOCALAPPDATA'",
"]",
",",
"'PDK'",
",",
"'cache'",
")",
"else",
"File",
".",
"join",
"(",
"Dir",
".",
"home",
",",
"'.pdk'",
",",
"'cache'",
")",
"end",
"end"
] |
Returns the fully qualified path to a per-user PDK cachedir.
@return [String] Fully qualified path to per-user PDK cachedir.
|
[
"Returns",
"the",
"fully",
"qualified",
"path",
"to",
"a",
"per",
"-",
"user",
"PDK",
"cachedir",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/util.rb#L100-L106
|
13,235
|
puppetlabs/pdk
|
lib/pdk/util.rb
|
PDK.Util.module_root
|
def module_root
metadata_path = find_upwards('metadata.json')
if metadata_path
File.dirname(metadata_path)
elsif in_module_root?
Dir.pwd
else
nil
end
end
|
ruby
|
def module_root
metadata_path = find_upwards('metadata.json')
if metadata_path
File.dirname(metadata_path)
elsif in_module_root?
Dir.pwd
else
nil
end
end
|
[
"def",
"module_root",
"metadata_path",
"=",
"find_upwards",
"(",
"'metadata.json'",
")",
"if",
"metadata_path",
"File",
".",
"dirname",
"(",
"metadata_path",
")",
"elsif",
"in_module_root?",
"Dir",
".",
"pwd",
"else",
"nil",
"end",
"end"
] |
Returns path to the root of the module being worked on.
@return [String, nil] Fully qualified base path to module, or nil if
the current working dir does not appear to be within a module.
|
[
"Returns",
"path",
"to",
"the",
"root",
"of",
"the",
"module",
"being",
"worked",
"on",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/util.rb#L113-L122
|
13,236
|
puppetlabs/pdk
|
lib/pdk/util.rb
|
PDK.Util.find_valid_json_in
|
def find_valid_json_in(text, opts = {})
break_on_first = opts.key?(:break_on_first) ? opts[:break_on_first] : true
json_result = break_on_first ? nil : []
text.scan(%r{\{(?:[^{}]|(?:\g<0>))*\}}x) do |str|
begin
if break_on_first
json_result = JSON.parse(str)
break
else
json_result.push(JSON.parse(str))
end
rescue JSON::ParserError
next
end
end
json_result
end
|
ruby
|
def find_valid_json_in(text, opts = {})
break_on_first = opts.key?(:break_on_first) ? opts[:break_on_first] : true
json_result = break_on_first ? nil : []
text.scan(%r{\{(?:[^{}]|(?:\g<0>))*\}}x) do |str|
begin
if break_on_first
json_result = JSON.parse(str)
break
else
json_result.push(JSON.parse(str))
end
rescue JSON::ParserError
next
end
end
json_result
end
|
[
"def",
"find_valid_json_in",
"(",
"text",
",",
"opts",
"=",
"{",
"}",
")",
"break_on_first",
"=",
"opts",
".",
"key?",
"(",
":break_on_first",
")",
"?",
"opts",
"[",
":break_on_first",
"]",
":",
"true",
"json_result",
"=",
"break_on_first",
"?",
"nil",
":",
"[",
"]",
"text",
".",
"scan",
"(",
"%r{",
"\\{",
"\\g",
"\\}",
"}x",
")",
"do",
"|",
"str",
"|",
"begin",
"if",
"break_on_first",
"json_result",
"=",
"JSON",
".",
"parse",
"(",
"str",
")",
"break",
"else",
"json_result",
".",
"push",
"(",
"JSON",
".",
"parse",
"(",
"str",
")",
")",
"end",
"rescue",
"JSON",
"::",
"ParserError",
"next",
"end",
"end",
"json_result",
"end"
] |
Iterate through possible JSON documents until we find one that is valid.
@param [String] text the text in which to find a JSON document
@param [Hash] opts options
@option opts [Boolean] :break_on_first Whether or not to break after valid JSON is found, defaults to true
@return [Hash, Array<Hash>, nil] subset of text as Hash of first valid JSON found, array of all valid JSON found, or nil if no valid
JSON found in the text
@private
|
[
"Iterate",
"through",
"possible",
"JSON",
"documents",
"until",
"we",
"find",
"one",
"that",
"is",
"valid",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/util.rb#L165-L184
|
13,237
|
puppetlabs/pdk
|
lib/pdk/util.rb
|
PDK.Util.targets_relative_to_pwd
|
def targets_relative_to_pwd(targets)
targets.map do |t|
if Pathname.new(t).absolute?
Pathname.new(t).relative_path_from(Pathname.pwd)
else
t
end
end
end
|
ruby
|
def targets_relative_to_pwd(targets)
targets.map do |t|
if Pathname.new(t).absolute?
Pathname.new(t).relative_path_from(Pathname.pwd)
else
t
end
end
end
|
[
"def",
"targets_relative_to_pwd",
"(",
"targets",
")",
"targets",
".",
"map",
"do",
"|",
"t",
"|",
"if",
"Pathname",
".",
"new",
"(",
"t",
")",
".",
"absolute?",
"Pathname",
".",
"new",
"(",
"t",
")",
".",
"relative_path_from",
"(",
"Pathname",
".",
"pwd",
")",
"else",
"t",
"end",
"end",
"end"
] |
Returns the targets' paths relative to the working directory
@return [Array<String>] The absolute or path to the target
|
[
"Returns",
"the",
"targets",
"paths",
"relative",
"to",
"the",
"working",
"directory"
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/util.rb#L190-L198
|
13,238
|
puppetlabs/pdk
|
lib/pdk/report.rb
|
PDK.Report.write_junit
|
def write_junit(target = self.class.default_target)
# Open a File Object for IO if target is a string containing a filename or path
target = File.open(target, 'w') if target.is_a? String
document = REXML::Document.new
document << REXML::XMLDecl.new
testsuites = REXML::Element.new('testsuites')
id = 0
events.each do |testsuite_name, testcases|
testsuite = REXML::Element.new('testsuite')
testsuite.attributes['name'] = testsuite_name
testsuite.attributes['tests'] = testcases.length
testsuite.attributes['errors'] = testcases.select(&:error?).length
testsuite.attributes['failures'] = testcases.select(&:failure?).length
testsuite.attributes['skipped'] = testcases.select(&:skipped?).length
testsuite.attributes['time'] = 0
testsuite.attributes['timestamp'] = Time.now.strftime('%Y-%m-%dT%H:%M:%S')
testsuite.attributes['hostname'] = Socket.gethostname
testsuite.attributes['id'] = id
testsuite.attributes['package'] = testsuite_name
testsuite.add_element('properties')
testcases.each { |r| testsuite.elements << r.to_junit }
testsuite.add_element('system-out')
testsuite.add_element('system-err')
testsuites.elements << testsuite
id += 1
end
document.elements << testsuites
document.write(target, 2)
ensure
target.close if target.is_a? File
end
|
ruby
|
def write_junit(target = self.class.default_target)
# Open a File Object for IO if target is a string containing a filename or path
target = File.open(target, 'w') if target.is_a? String
document = REXML::Document.new
document << REXML::XMLDecl.new
testsuites = REXML::Element.new('testsuites')
id = 0
events.each do |testsuite_name, testcases|
testsuite = REXML::Element.new('testsuite')
testsuite.attributes['name'] = testsuite_name
testsuite.attributes['tests'] = testcases.length
testsuite.attributes['errors'] = testcases.select(&:error?).length
testsuite.attributes['failures'] = testcases.select(&:failure?).length
testsuite.attributes['skipped'] = testcases.select(&:skipped?).length
testsuite.attributes['time'] = 0
testsuite.attributes['timestamp'] = Time.now.strftime('%Y-%m-%dT%H:%M:%S')
testsuite.attributes['hostname'] = Socket.gethostname
testsuite.attributes['id'] = id
testsuite.attributes['package'] = testsuite_name
testsuite.add_element('properties')
testcases.each { |r| testsuite.elements << r.to_junit }
testsuite.add_element('system-out')
testsuite.add_element('system-err')
testsuites.elements << testsuite
id += 1
end
document.elements << testsuites
document.write(target, 2)
ensure
target.close if target.is_a? File
end
|
[
"def",
"write_junit",
"(",
"target",
"=",
"self",
".",
"class",
".",
"default_target",
")",
"# Open a File Object for IO if target is a string containing a filename or path",
"target",
"=",
"File",
".",
"open",
"(",
"target",
",",
"'w'",
")",
"if",
"target",
".",
"is_a?",
"String",
"document",
"=",
"REXML",
"::",
"Document",
".",
"new",
"document",
"<<",
"REXML",
"::",
"XMLDecl",
".",
"new",
"testsuites",
"=",
"REXML",
"::",
"Element",
".",
"new",
"(",
"'testsuites'",
")",
"id",
"=",
"0",
"events",
".",
"each",
"do",
"|",
"testsuite_name",
",",
"testcases",
"|",
"testsuite",
"=",
"REXML",
"::",
"Element",
".",
"new",
"(",
"'testsuite'",
")",
"testsuite",
".",
"attributes",
"[",
"'name'",
"]",
"=",
"testsuite_name",
"testsuite",
".",
"attributes",
"[",
"'tests'",
"]",
"=",
"testcases",
".",
"length",
"testsuite",
".",
"attributes",
"[",
"'errors'",
"]",
"=",
"testcases",
".",
"select",
"(",
":error?",
")",
".",
"length",
"testsuite",
".",
"attributes",
"[",
"'failures'",
"]",
"=",
"testcases",
".",
"select",
"(",
":failure?",
")",
".",
"length",
"testsuite",
".",
"attributes",
"[",
"'skipped'",
"]",
"=",
"testcases",
".",
"select",
"(",
":skipped?",
")",
".",
"length",
"testsuite",
".",
"attributes",
"[",
"'time'",
"]",
"=",
"0",
"testsuite",
".",
"attributes",
"[",
"'timestamp'",
"]",
"=",
"Time",
".",
"now",
".",
"strftime",
"(",
"'%Y-%m-%dT%H:%M:%S'",
")",
"testsuite",
".",
"attributes",
"[",
"'hostname'",
"]",
"=",
"Socket",
".",
"gethostname",
"testsuite",
".",
"attributes",
"[",
"'id'",
"]",
"=",
"id",
"testsuite",
".",
"attributes",
"[",
"'package'",
"]",
"=",
"testsuite_name",
"testsuite",
".",
"add_element",
"(",
"'properties'",
")",
"testcases",
".",
"each",
"{",
"|",
"r",
"|",
"testsuite",
".",
"elements",
"<<",
"r",
".",
"to_junit",
"}",
"testsuite",
".",
"add_element",
"(",
"'system-out'",
")",
"testsuite",
".",
"add_element",
"(",
"'system-err'",
")",
"testsuites",
".",
"elements",
"<<",
"testsuite",
"id",
"+=",
"1",
"end",
"document",
".",
"elements",
"<<",
"testsuites",
"document",
".",
"write",
"(",
"target",
",",
"2",
")",
"ensure",
"target",
".",
"close",
"if",
"target",
".",
"is_a?",
"File",
"end"
] |
Renders the report as a JUnit XML document.
@param target [#write] an IO object that the report will be written to.
Defaults to PDK::Report.default_target.
|
[
"Renders",
"the",
"report",
"as",
"a",
"JUnit",
"XML",
"document",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/report.rb#L50-L84
|
13,239
|
puppetlabs/pdk
|
lib/pdk/report.rb
|
PDK.Report.write_text
|
def write_text(target = self.class.default_target)
# Open a File Object for IO if target is a string containing a filename or path
target = File.open(target, 'w') if target.is_a? String
coverage_report = nil
events.each do |_tool, tool_events|
tool_events.each do |event|
if event.rspec_puppet_coverage?
coverage_report = event.to_text
else
target.puts(event.to_text) unless event.pass?
end
end
end
ensure
target.puts "\n#{coverage_report}" if coverage_report
target.close if target.is_a? File
end
|
ruby
|
def write_text(target = self.class.default_target)
# Open a File Object for IO if target is a string containing a filename or path
target = File.open(target, 'w') if target.is_a? String
coverage_report = nil
events.each do |_tool, tool_events|
tool_events.each do |event|
if event.rspec_puppet_coverage?
coverage_report = event.to_text
else
target.puts(event.to_text) unless event.pass?
end
end
end
ensure
target.puts "\n#{coverage_report}" if coverage_report
target.close if target.is_a? File
end
|
[
"def",
"write_text",
"(",
"target",
"=",
"self",
".",
"class",
".",
"default_target",
")",
"# Open a File Object for IO if target is a string containing a filename or path",
"target",
"=",
"File",
".",
"open",
"(",
"target",
",",
"'w'",
")",
"if",
"target",
".",
"is_a?",
"String",
"coverage_report",
"=",
"nil",
"events",
".",
"each",
"do",
"|",
"_tool",
",",
"tool_events",
"|",
"tool_events",
".",
"each",
"do",
"|",
"event",
"|",
"if",
"event",
".",
"rspec_puppet_coverage?",
"coverage_report",
"=",
"event",
".",
"to_text",
"else",
"target",
".",
"puts",
"(",
"event",
".",
"to_text",
")",
"unless",
"event",
".",
"pass?",
"end",
"end",
"end",
"ensure",
"target",
".",
"puts",
"\"\\n#{coverage_report}\"",
"if",
"coverage_report",
"target",
".",
"close",
"if",
"target",
".",
"is_a?",
"File",
"end"
] |
Renders the report as plain text.
This report is designed for interactive use by a human and so excludes
all passing events in order to be consise.
@param target [#write] an IO object that the report will be written to.
Defaults to PDK::Report.default_target.
|
[
"Renders",
"the",
"report",
"as",
"plain",
"text",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/report.rb#L93-L110
|
13,240
|
puppetlabs/pdk
|
lib/pdk/answer_file.rb
|
PDK.AnswerFile.update!
|
def update!(new_answers = {})
unless new_answers.is_a?(Hash)
raise PDK::CLI::FatalError, _('Answer file can be updated only with a Hash')
end
answers.merge!(new_answers)
save_to_disk
end
|
ruby
|
def update!(new_answers = {})
unless new_answers.is_a?(Hash)
raise PDK::CLI::FatalError, _('Answer file can be updated only with a Hash')
end
answers.merge!(new_answers)
save_to_disk
end
|
[
"def",
"update!",
"(",
"new_answers",
"=",
"{",
"}",
")",
"unless",
"new_answers",
".",
"is_a?",
"(",
"Hash",
")",
"raise",
"PDK",
"::",
"CLI",
"::",
"FatalError",
",",
"_",
"(",
"'Answer file can be updated only with a Hash'",
")",
"end",
"answers",
".",
"merge!",
"(",
"new_answers",
")",
"save_to_disk",
"end"
] |
Update the stored answers in memory and then save them to disk.
@param new_answers [Hash{String => Object}] The new questions and answers
to be merged into the existing answers.
@raise [PDK::CLI::FatalError] if the new answers are not provided as
a Hash.
@raise (see #save_to_disk)
|
[
"Update",
"the",
"stored",
"answers",
"in",
"memory",
"and",
"then",
"save",
"them",
"to",
"disk",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/answer_file.rb#L57-L65
|
13,241
|
puppetlabs/pdk
|
lib/pdk/answer_file.rb
|
PDK.AnswerFile.read_from_disk
|
def read_from_disk
return {} if !File.file?(answer_file_path) || File.zero?(answer_file_path)
unless File.readable?(answer_file_path)
raise PDK::CLI::FatalError, _("Unable to open '%{file}' for reading") % {
file: answer_file_path,
}
end
answers = JSON.parse(File.read(answer_file_path))
if answers.is_a?(Hash)
answers
else
PDK.logger.warn _("Answer file '%{path}' did not contain a valid set of answers, recreating it") % {
path: answer_file_path,
}
{}
end
rescue JSON::JSONError
PDK.logger.warn _("Answer file '%{path}' did not contain valid JSON, recreating it") % {
path: answer_file_path,
}
{}
end
|
ruby
|
def read_from_disk
return {} if !File.file?(answer_file_path) || File.zero?(answer_file_path)
unless File.readable?(answer_file_path)
raise PDK::CLI::FatalError, _("Unable to open '%{file}' for reading") % {
file: answer_file_path,
}
end
answers = JSON.parse(File.read(answer_file_path))
if answers.is_a?(Hash)
answers
else
PDK.logger.warn _("Answer file '%{path}' did not contain a valid set of answers, recreating it") % {
path: answer_file_path,
}
{}
end
rescue JSON::JSONError
PDK.logger.warn _("Answer file '%{path}' did not contain valid JSON, recreating it") % {
path: answer_file_path,
}
{}
end
|
[
"def",
"read_from_disk",
"return",
"{",
"}",
"if",
"!",
"File",
".",
"file?",
"(",
"answer_file_path",
")",
"||",
"File",
".",
"zero?",
"(",
"answer_file_path",
")",
"unless",
"File",
".",
"readable?",
"(",
"answer_file_path",
")",
"raise",
"PDK",
"::",
"CLI",
"::",
"FatalError",
",",
"_",
"(",
"\"Unable to open '%{file}' for reading\"",
")",
"%",
"{",
"file",
":",
"answer_file_path",
",",
"}",
"end",
"answers",
"=",
"JSON",
".",
"parse",
"(",
"File",
".",
"read",
"(",
"answer_file_path",
")",
")",
"if",
"answers",
".",
"is_a?",
"(",
"Hash",
")",
"answers",
"else",
"PDK",
".",
"logger",
".",
"warn",
"_",
"(",
"\"Answer file '%{path}' did not contain a valid set of answers, recreating it\"",
")",
"%",
"{",
"path",
":",
"answer_file_path",
",",
"}",
"{",
"}",
"end",
"rescue",
"JSON",
"::",
"JSONError",
"PDK",
".",
"logger",
".",
"warn",
"_",
"(",
"\"Answer file '%{path}' did not contain valid JSON, recreating it\"",
")",
"%",
"{",
"path",
":",
"answer_file_path",
",",
"}",
"{",
"}",
"end"
] |
Read existing answers into memory from the answer file on disk.
@raise [PDK::CLI::FatalError] If the answer file exists but can not be
read.
@return [Hash{String => Object}] The existing questions and answers.
|
[
"Read",
"existing",
"answers",
"into",
"memory",
"from",
"the",
"answer",
"file",
"on",
"disk",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/answer_file.rb#L82-L105
|
13,242
|
puppetlabs/pdk
|
lib/pdk/answer_file.rb
|
PDK.AnswerFile.save_to_disk
|
def save_to_disk
FileUtils.mkdir_p(File.dirname(answer_file_path))
write_file(answer_file_path, JSON.pretty_generate(answers))
rescue SystemCallError, IOError => e
raise PDK::CLI::FatalError, _("Unable to write '%{file}': %{msg}") % {
file: answer_file_path,
msg: e.message,
}
end
|
ruby
|
def save_to_disk
FileUtils.mkdir_p(File.dirname(answer_file_path))
write_file(answer_file_path, JSON.pretty_generate(answers))
rescue SystemCallError, IOError => e
raise PDK::CLI::FatalError, _("Unable to write '%{file}': %{msg}") % {
file: answer_file_path,
msg: e.message,
}
end
|
[
"def",
"save_to_disk",
"FileUtils",
".",
"mkdir_p",
"(",
"File",
".",
"dirname",
"(",
"answer_file_path",
")",
")",
"write_file",
"(",
"answer_file_path",
",",
"JSON",
".",
"pretty_generate",
"(",
"answers",
")",
")",
"rescue",
"SystemCallError",
",",
"IOError",
"=>",
"e",
"raise",
"PDK",
"::",
"CLI",
"::",
"FatalError",
",",
"_",
"(",
"\"Unable to write '%{file}': %{msg}\"",
")",
"%",
"{",
"file",
":",
"answer_file_path",
",",
"msg",
":",
"e",
".",
"message",
",",
"}",
"end"
] |
Save the in memory answer set to the answer file on disk.
@raise [PDK::CLI::FatalError] if the answer file can not be written to.
|
[
"Save",
"the",
"in",
"memory",
"answer",
"set",
"to",
"the",
"answer",
"file",
"on",
"disk",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/answer_file.rb#L110-L119
|
13,243
|
puppetlabs/pdk
|
lib/pdk/template_file.rb
|
PDK.TemplateFile.template_content
|
def template_content
if File.file?(@template_file) && File.readable?(@template_file)
return File.read(@template_file)
end
raise ArgumentError, _("'%{template}' is not a readable file") % { template: @template_file }
end
|
ruby
|
def template_content
if File.file?(@template_file) && File.readable?(@template_file)
return File.read(@template_file)
end
raise ArgumentError, _("'%{template}' is not a readable file") % { template: @template_file }
end
|
[
"def",
"template_content",
"if",
"File",
".",
"file?",
"(",
"@template_file",
")",
"&&",
"File",
".",
"readable?",
"(",
"@template_file",
")",
"return",
"File",
".",
"read",
"(",
"@template_file",
")",
"end",
"raise",
"ArgumentError",
",",
"_",
"(",
"\"'%{template}' is not a readable file\"",
")",
"%",
"{",
"template",
":",
"@template_file",
"}",
"end"
] |
Reads the content of the template file into memory.
@return [String] The content of the template file.
@raise [ArgumentError] If the template file does not exist or can not be
read.
@api private
|
[
"Reads",
"the",
"content",
"of",
"the",
"template",
"file",
"into",
"memory",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/template_file.rb#L63-L69
|
13,244
|
puppetlabs/pdk
|
lib/pdk/template_file.rb
|
PDK.TemplateFile.render_erb
|
def render_erb
renderer = ERB.new(template_content, nil, '-')
renderer.filename = @template_file
renderer.result(binding)
end
|
ruby
|
def render_erb
renderer = ERB.new(template_content, nil, '-')
renderer.filename = @template_file
renderer.result(binding)
end
|
[
"def",
"render_erb",
"renderer",
"=",
"ERB",
".",
"new",
"(",
"template_content",
",",
"nil",
",",
"'-'",
")",
"renderer",
".",
"filename",
"=",
"@template_file",
"renderer",
".",
"result",
"(",
"binding",
")",
"end"
] |
Renders the content of the template file as an ERB template.
@return [String] The rendered template.
@raise (see #template_content)
@api private
|
[
"Renders",
"the",
"content",
"of",
"the",
"template",
"file",
"as",
"an",
"ERB",
"template",
"."
] |
0d864aff62ffef04b5104addf399d0476afd71e7
|
https://github.com/puppetlabs/pdk/blob/0d864aff62ffef04b5104addf399d0476afd71e7/lib/pdk/template_file.rb#L78-L82
|
13,245
|
flavorjones/loofah
|
lib/loofah/scrubber.rb
|
Loofah.Scrubber.append_attribute
|
def append_attribute(node, attribute, value)
current_value = node.get_attribute(attribute) || ''
current_values = current_value.split(/\s+/)
updated_value = current_values | [value]
node.set_attribute(attribute, updated_value.join(' '))
end
|
ruby
|
def append_attribute(node, attribute, value)
current_value = node.get_attribute(attribute) || ''
current_values = current_value.split(/\s+/)
updated_value = current_values | [value]
node.set_attribute(attribute, updated_value.join(' '))
end
|
[
"def",
"append_attribute",
"(",
"node",
",",
"attribute",
",",
"value",
")",
"current_value",
"=",
"node",
".",
"get_attribute",
"(",
"attribute",
")",
"||",
"''",
"current_values",
"=",
"current_value",
".",
"split",
"(",
"/",
"\\s",
"/",
")",
"updated_value",
"=",
"current_values",
"|",
"[",
"value",
"]",
"node",
".",
"set_attribute",
"(",
"attribute",
",",
"updated_value",
".",
"join",
"(",
"' '",
")",
")",
"end"
] |
If the attribute is not set, add it
If the attribute is set, don't overwrite the existing value
|
[
"If",
"the",
"attribute",
"is",
"not",
"set",
"add",
"it",
"If",
"the",
"attribute",
"is",
"set",
"don",
"t",
"overwrite",
"the",
"existing",
"value"
] |
49f178941f10a97aa6441e71fae704a81cc3a731
|
https://github.com/flavorjones/loofah/blob/49f178941f10a97aa6441e71fae704a81cc3a731/lib/loofah/scrubber.rb#L93-L98
|
13,246
|
flavorjones/loofah
|
lib/loofah/instance_methods.rb
|
Loofah.TextBehavior.text
|
def text(options={})
result = serialize_root.children.inner_text rescue ""
if options[:encode_special_chars] == false
result # possibly dangerous if rendered in a browser
else
encode_special_chars result
end
end
|
ruby
|
def text(options={})
result = serialize_root.children.inner_text rescue ""
if options[:encode_special_chars] == false
result # possibly dangerous if rendered in a browser
else
encode_special_chars result
end
end
|
[
"def",
"text",
"(",
"options",
"=",
"{",
"}",
")",
"result",
"=",
"serialize_root",
".",
"children",
".",
"inner_text",
"rescue",
"\"\"",
"if",
"options",
"[",
":encode_special_chars",
"]",
"==",
"false",
"result",
"# possibly dangerous if rendered in a browser",
"else",
"encode_special_chars",
"result",
"end",
"end"
] |
Returns a plain-text version of the markup contained by the document,
with HTML entities encoded.
This method is significantly faster than #to_text, but isn't
clever about whitespace around block elements.
Loofah.document("<h1>Title</h1><div>Content</div>").text
# => "TitleContent"
By default, the returned text will have HTML entities
escaped. If you want unescaped entities, and you understand
that the result is unsafe to render in a browser, then you
can pass an argument as shown:
frag = Loofah.fragment("<script>alert('EVIL');</script>")
# ok for browser:
frag.text # => "<script>alert('EVIL');</script>"
# decidedly not ok for browser:
frag.text(:encode_special_chars => false) # => "<script>alert('EVIL');</script>"
|
[
"Returns",
"a",
"plain",
"-",
"text",
"version",
"of",
"the",
"markup",
"contained",
"by",
"the",
"document",
"with",
"HTML",
"entities",
"encoded",
"."
] |
49f178941f10a97aa6441e71fae704a81cc3a731
|
https://github.com/flavorjones/loofah/blob/49f178941f10a97aa6441e71fae704a81cc3a731/lib/loofah/instance_methods.rb#L94-L101
|
13,247
|
commander-rb/commander
|
lib/commander/command.rb
|
Commander.Command.option
|
def option(*args, &block)
switches, description = Runner.separate_switches_from_description(*args)
proc = block || option_proc(switches)
@options << {
args: args,
proc: proc,
switches: switches,
description: description,
}
end
|
ruby
|
def option(*args, &block)
switches, description = Runner.separate_switches_from_description(*args)
proc = block || option_proc(switches)
@options << {
args: args,
proc: proc,
switches: switches,
description: description,
}
end
|
[
"def",
"option",
"(",
"*",
"args",
",",
"&",
"block",
")",
"switches",
",",
"description",
"=",
"Runner",
".",
"separate_switches_from_description",
"(",
"args",
")",
"proc",
"=",
"block",
"||",
"option_proc",
"(",
"switches",
")",
"@options",
"<<",
"{",
"args",
":",
"args",
",",
"proc",
":",
"proc",
",",
"switches",
":",
"switches",
",",
"description",
":",
"description",
",",
"}",
"end"
] |
Add an option.
Options are parsed via OptionParser so view it
for additional usage documentation. A block may optionally be
passed to handle the option, otherwise the _options_ struct seen below
contains the results of this option. This handles common formats such as:
-h, --help options.help # => bool
--[no-]feature options.feature # => bool
--large-switch options.large_switch # => bool
--file FILE options.file # => file passed
--list WORDS options.list # => array
--date [DATE] options.date # => date or nil when optional argument not set
=== Examples
command :something do |c|
c.option '--recursive', 'Do something recursively'
c.option '--file FILE', 'Specify a file'
c.option('--info', 'Display info') { puts "handle with block" }
c.option '--[no-]feature', 'With or without feature'
c.option '--list FILES', Array, 'List the files specified'
c.when_called do |args, options|
do_something_recursively if options.recursive
do_something_with_file options.file if options.file
end
end
=== Help Formatters
This method also parses the arguments passed in order to determine
which were switches, and which were descriptions for the
option which can later be used within help formatters
using option[:switches] and option[:description].
=== Input Parsing
Since Commander utilizes OptionParser you can pre-parse and evaluate
option arguments. Simply require 'optparse/time', or 'optparse/date', as these
objects must respond to #parse.
c.option '--time TIME', Time
c.option '--date [DATE]', Date
|
[
"Add",
"an",
"option",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/command.rb#L107-L116
|
13,248
|
commander-rb/commander
|
lib/commander/command.rb
|
Commander.Command.call
|
def call(args = [])
object, meth = @when_called[0, 2]
meth ||= :call
options = proxy_option_struct
case object
when Proc then object.call(args, options)
when Class then meth != :call ? object.new.send(meth, args, options) : object.new(args, options)
else object.send(meth, args, options) if object
end
end
|
ruby
|
def call(args = [])
object, meth = @when_called[0, 2]
meth ||= :call
options = proxy_option_struct
case object
when Proc then object.call(args, options)
when Class then meth != :call ? object.new.send(meth, args, options) : object.new(args, options)
else object.send(meth, args, options) if object
end
end
|
[
"def",
"call",
"(",
"args",
"=",
"[",
"]",
")",
"object",
",",
"meth",
"=",
"@when_called",
"[",
"0",
",",
"2",
"]",
"meth",
"||=",
":call",
"options",
"=",
"proxy_option_struct",
"case",
"object",
"when",
"Proc",
"then",
"object",
".",
"call",
"(",
"args",
",",
"options",
")",
"when",
"Class",
"then",
"meth",
"!=",
":call",
"?",
"object",
".",
"new",
".",
"send",
"(",
"meth",
",",
"args",
",",
"options",
")",
":",
"object",
".",
"new",
"(",
"args",
",",
"options",
")",
"else",
"object",
".",
"send",
"(",
"meth",
",",
"args",
",",
"options",
")",
"if",
"object",
"end",
"end"
] |
Call the commands when_called block with _args_.
|
[
"Call",
"the",
"commands",
"when_called",
"block",
"with",
"_args_",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/command.rb#L176-L186
|
13,249
|
commander-rb/commander
|
lib/commander/runner.rb
|
Commander.Runner.run!
|
def run!
trace = @always_trace || false
require_program :version, :description
trap('INT') { abort program(:int_message) } if program(:int_message)
trap('INT') { program(:int_block).call } if program(:int_block)
global_option('-h', '--help', 'Display help documentation') do
args = @args - %w(-h --help)
command(:help).run(*args)
return
end
global_option('-v', '--version', 'Display version information') do
say version
return
end
global_option('-t', '--trace', 'Display backtrace when an error occurs') { trace = true } unless @never_trace || @always_trace
parse_global_options
remove_global_options options, @args
if trace
run_active_command
else
begin
run_active_command
rescue InvalidCommandError => e
abort "#{e}. Use --help for more information"
rescue \
OptionParser::InvalidOption,
OptionParser::InvalidArgument,
OptionParser::MissingArgument => e
abort e.to_s
rescue => e
if @never_trace
abort "error: #{e}."
else
abort "error: #{e}. Use --trace to view backtrace"
end
end
end
end
|
ruby
|
def run!
trace = @always_trace || false
require_program :version, :description
trap('INT') { abort program(:int_message) } if program(:int_message)
trap('INT') { program(:int_block).call } if program(:int_block)
global_option('-h', '--help', 'Display help documentation') do
args = @args - %w(-h --help)
command(:help).run(*args)
return
end
global_option('-v', '--version', 'Display version information') do
say version
return
end
global_option('-t', '--trace', 'Display backtrace when an error occurs') { trace = true } unless @never_trace || @always_trace
parse_global_options
remove_global_options options, @args
if trace
run_active_command
else
begin
run_active_command
rescue InvalidCommandError => e
abort "#{e}. Use --help for more information"
rescue \
OptionParser::InvalidOption,
OptionParser::InvalidArgument,
OptionParser::MissingArgument => e
abort e.to_s
rescue => e
if @never_trace
abort "error: #{e}."
else
abort "error: #{e}. Use --trace to view backtrace"
end
end
end
end
|
[
"def",
"run!",
"trace",
"=",
"@always_trace",
"||",
"false",
"require_program",
":version",
",",
":description",
"trap",
"(",
"'INT'",
")",
"{",
"abort",
"program",
"(",
":int_message",
")",
"}",
"if",
"program",
"(",
":int_message",
")",
"trap",
"(",
"'INT'",
")",
"{",
"program",
"(",
":int_block",
")",
".",
"call",
"}",
"if",
"program",
"(",
":int_block",
")",
"global_option",
"(",
"'-h'",
",",
"'--help'",
",",
"'Display help documentation'",
")",
"do",
"args",
"=",
"@args",
"-",
"%w(",
"-h",
"--help",
")",
"command",
"(",
":help",
")",
".",
"run",
"(",
"args",
")",
"return",
"end",
"global_option",
"(",
"'-v'",
",",
"'--version'",
",",
"'Display version information'",
")",
"do",
"say",
"version",
"return",
"end",
"global_option",
"(",
"'-t'",
",",
"'--trace'",
",",
"'Display backtrace when an error occurs'",
")",
"{",
"trace",
"=",
"true",
"}",
"unless",
"@never_trace",
"||",
"@always_trace",
"parse_global_options",
"remove_global_options",
"options",
",",
"@args",
"if",
"trace",
"run_active_command",
"else",
"begin",
"run_active_command",
"rescue",
"InvalidCommandError",
"=>",
"e",
"abort",
"\"#{e}. Use --help for more information\"",
"rescue",
"OptionParser",
"::",
"InvalidOption",
",",
"OptionParser",
"::",
"InvalidArgument",
",",
"OptionParser",
"::",
"MissingArgument",
"=>",
"e",
"abort",
"e",
".",
"to_s",
"rescue",
"=>",
"e",
"if",
"@never_trace",
"abort",
"\"error: #{e}.\"",
"else",
"abort",
"\"error: #{e}. Use --trace to view backtrace\"",
"end",
"end",
"end",
"end"
] |
Run command parsing and execution process.
|
[
"Run",
"command",
"parsing",
"and",
"execution",
"process",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/runner.rb#L50-L87
|
13,250
|
commander-rb/commander
|
lib/commander/runner.rb
|
Commander.Runner.program
|
def program(key, *args, &block)
if key == :help && !args.empty?
@program[:help] ||= {}
@program[:help][args.first] = args.at(1)
elsif key == :help_formatter && !args.empty?
@program[key] = (@help_formatter_aliases[args.first] || args.first)
elsif block
@program[key] = block
else
unless args.empty?
@program[key] = args.count == 1 ? args[0] : args
end
@program[key]
end
end
|
ruby
|
def program(key, *args, &block)
if key == :help && !args.empty?
@program[:help] ||= {}
@program[:help][args.first] = args.at(1)
elsif key == :help_formatter && !args.empty?
@program[key] = (@help_formatter_aliases[args.first] || args.first)
elsif block
@program[key] = block
else
unless args.empty?
@program[key] = args.count == 1 ? args[0] : args
end
@program[key]
end
end
|
[
"def",
"program",
"(",
"key",
",",
"*",
"args",
",",
"&",
"block",
")",
"if",
"key",
"==",
":help",
"&&",
"!",
"args",
".",
"empty?",
"@program",
"[",
":help",
"]",
"||=",
"{",
"}",
"@program",
"[",
":help",
"]",
"[",
"args",
".",
"first",
"]",
"=",
"args",
".",
"at",
"(",
"1",
")",
"elsif",
"key",
"==",
":help_formatter",
"&&",
"!",
"args",
".",
"empty?",
"@program",
"[",
"key",
"]",
"=",
"(",
"@help_formatter_aliases",
"[",
"args",
".",
"first",
"]",
"||",
"args",
".",
"first",
")",
"elsif",
"block",
"@program",
"[",
"key",
"]",
"=",
"block",
"else",
"unless",
"args",
".",
"empty?",
"@program",
"[",
"key",
"]",
"=",
"args",
".",
"count",
"==",
"1",
"?",
"args",
"[",
"0",
"]",
":",
"args",
"end",
"@program",
"[",
"key",
"]",
"end",
"end"
] |
Assign program information.
=== Examples
# Set data
program :name, 'Commander'
program :version, Commander::VERSION
program :description, 'Commander utility program.'
program :help, 'Copyright', '2008 TJ Holowaychuk'
program :help, 'Anything', 'You want'
program :int_message 'Bye bye!'
program :help_formatter, :compact
program :help_formatter, Commander::HelpFormatter::TerminalCompact
# Get data
program :name # => 'Commander'
=== Keys
:version (required) Program version triple, ex: '0.0.1'
:description (required) Program description
:name Program name, defaults to basename of executable
:help_formatter Defaults to Commander::HelpFormatter::Terminal
:help Allows addition of arbitrary global help blocks
:help_paging Flag for toggling help paging
:int_message Message to display when interrupted (CTRL + C)
|
[
"Assign",
"program",
"information",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/runner.rb#L141-L155
|
13,251
|
commander-rb/commander
|
lib/commander/runner.rb
|
Commander.Runner.alias_command
|
def alias_command(alias_name, name, *args)
@commands[alias_name.to_s] = command name
@aliases[alias_name.to_s] = args
end
|
ruby
|
def alias_command(alias_name, name, *args)
@commands[alias_name.to_s] = command name
@aliases[alias_name.to_s] = args
end
|
[
"def",
"alias_command",
"(",
"alias_name",
",",
"name",
",",
"*",
"args",
")",
"@commands",
"[",
"alias_name",
".",
"to_s",
"]",
"=",
"command",
"name",
"@aliases",
"[",
"alias_name",
".",
"to_s",
"]",
"=",
"args",
"end"
] |
Alias command _name_ with _alias_name_. Optionally _args_ may be passed
as if they were being passed straight to the original command via the command-line.
|
[
"Alias",
"command",
"_name_",
"with",
"_alias_name_",
".",
"Optionally",
"_args_",
"may",
"be",
"passed",
"as",
"if",
"they",
"were",
"being",
"passed",
"straight",
"to",
"the",
"original",
"command",
"via",
"the",
"command",
"-",
"line",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/runner.rb#L194-L197
|
13,252
|
commander-rb/commander
|
lib/commander/runner.rb
|
Commander.Runner.args_without_command_name
|
def args_without_command_name
removed = []
parts = command_name_from_args.split rescue []
@args.dup.delete_if do |arg|
removed << arg if parts.include?(arg) && !removed.include?(arg)
end
end
|
ruby
|
def args_without_command_name
removed = []
parts = command_name_from_args.split rescue []
@args.dup.delete_if do |arg|
removed << arg if parts.include?(arg) && !removed.include?(arg)
end
end
|
[
"def",
"args_without_command_name",
"removed",
"=",
"[",
"]",
"parts",
"=",
"command_name_from_args",
".",
"split",
"rescue",
"[",
"]",
"@args",
".",
"dup",
".",
"delete_if",
"do",
"|",
"arg",
"|",
"removed",
"<<",
"arg",
"if",
"parts",
".",
"include?",
"(",
"arg",
")",
"&&",
"!",
"removed",
".",
"include?",
"(",
"arg",
")",
"end",
"end"
] |
Return arguments without the command name.
|
[
"Return",
"arguments",
"without",
"the",
"command",
"name",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/runner.rb#L263-L269
|
13,253
|
commander-rb/commander
|
lib/commander/runner.rb
|
Commander.Runner.remove_global_options
|
def remove_global_options(options, args)
# TODO: refactor with flipflop, please TJ ! have time to refactor me !
options.each do |option|
switches = option[:switches].dup
next if switches.empty?
if (switch_has_arg = switches.any? { |s| s =~ /[ =]/ })
switches.map! { |s| s[0, s.index('=') || s.index(' ') || s.length] }
end
switches = expand_optionally_negative_switches(switches)
past_switch, arg_removed = false, false
args.delete_if do |arg|
if switches.any? { |s| s[0, arg.length] == arg }
arg_removed = !switch_has_arg
past_switch = true
elsif past_switch && !arg_removed && arg !~ /^-/
arg_removed = true
else
arg_removed = true
false
end
end
end
end
|
ruby
|
def remove_global_options(options, args)
# TODO: refactor with flipflop, please TJ ! have time to refactor me !
options.each do |option|
switches = option[:switches].dup
next if switches.empty?
if (switch_has_arg = switches.any? { |s| s =~ /[ =]/ })
switches.map! { |s| s[0, s.index('=') || s.index(' ') || s.length] }
end
switches = expand_optionally_negative_switches(switches)
past_switch, arg_removed = false, false
args.delete_if do |arg|
if switches.any? { |s| s[0, arg.length] == arg }
arg_removed = !switch_has_arg
past_switch = true
elsif past_switch && !arg_removed && arg !~ /^-/
arg_removed = true
else
arg_removed = true
false
end
end
end
end
|
[
"def",
"remove_global_options",
"(",
"options",
",",
"args",
")",
"# TODO: refactor with flipflop, please TJ ! have time to refactor me !",
"options",
".",
"each",
"do",
"|",
"option",
"|",
"switches",
"=",
"option",
"[",
":switches",
"]",
".",
"dup",
"next",
"if",
"switches",
".",
"empty?",
"if",
"(",
"switch_has_arg",
"=",
"switches",
".",
"any?",
"{",
"|",
"s",
"|",
"s",
"=~",
"/",
"/",
"}",
")",
"switches",
".",
"map!",
"{",
"|",
"s",
"|",
"s",
"[",
"0",
",",
"s",
".",
"index",
"(",
"'='",
")",
"||",
"s",
".",
"index",
"(",
"' '",
")",
"||",
"s",
".",
"length",
"]",
"}",
"end",
"switches",
"=",
"expand_optionally_negative_switches",
"(",
"switches",
")",
"past_switch",
",",
"arg_removed",
"=",
"false",
",",
"false",
"args",
".",
"delete_if",
"do",
"|",
"arg",
"|",
"if",
"switches",
".",
"any?",
"{",
"|",
"s",
"|",
"s",
"[",
"0",
",",
"arg",
".",
"length",
"]",
"==",
"arg",
"}",
"arg_removed",
"=",
"!",
"switch_has_arg",
"past_switch",
"=",
"true",
"elsif",
"past_switch",
"&&",
"!",
"arg_removed",
"&&",
"arg",
"!~",
"/",
"/",
"arg_removed",
"=",
"true",
"else",
"arg_removed",
"=",
"true",
"false",
"end",
"end",
"end",
"end"
] |
Removes global _options_ from _args_. This prevents an invalid
option error from occurring when options are parsed
again for the command.
|
[
"Removes",
"global",
"_options_",
"from",
"_args_",
".",
"This",
"prevents",
"an",
"invalid",
"option",
"error",
"from",
"occurring",
"when",
"options",
"are",
"parsed",
"again",
"for",
"the",
"command",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/runner.rb#L330-L355
|
13,254
|
commander-rb/commander
|
lib/commander/runner.rb
|
Commander.Runner.parse_global_options
|
def parse_global_options
parser = options.inject(OptionParser.new) do |options, option|
options.on(*option[:args], &global_option_proc(option[:switches], &option[:proc]))
end
options = @args.dup
begin
parser.parse!(options)
rescue OptionParser::InvalidOption => e
# Remove the offending args and retry.
options = options.reject { |o| e.args.include?(o) }
retry
end
end
|
ruby
|
def parse_global_options
parser = options.inject(OptionParser.new) do |options, option|
options.on(*option[:args], &global_option_proc(option[:switches], &option[:proc]))
end
options = @args.dup
begin
parser.parse!(options)
rescue OptionParser::InvalidOption => e
# Remove the offending args and retry.
options = options.reject { |o| e.args.include?(o) }
retry
end
end
|
[
"def",
"parse_global_options",
"parser",
"=",
"options",
".",
"inject",
"(",
"OptionParser",
".",
"new",
")",
"do",
"|",
"options",
",",
"option",
"|",
"options",
".",
"on",
"(",
"option",
"[",
":args",
"]",
",",
"global_option_proc",
"(",
"option",
"[",
":switches",
"]",
",",
"option",
"[",
":proc",
"]",
")",
")",
"end",
"options",
"=",
"@args",
".",
"dup",
"begin",
"parser",
".",
"parse!",
"(",
"options",
")",
"rescue",
"OptionParser",
"::",
"InvalidOption",
"=>",
"e",
"# Remove the offending args and retry.",
"options",
"=",
"options",
".",
"reject",
"{",
"|",
"o",
"|",
"e",
".",
"args",
".",
"include?",
"(",
"o",
")",
"}",
"retry",
"end",
"end"
] |
Parse global command options.
|
[
"Parse",
"global",
"command",
"options",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/runner.rb#L374-L387
|
13,255
|
commander-rb/commander
|
lib/commander/runner.rb
|
Commander.Runner.require_program
|
def require_program(*keys)
keys.each do |key|
fail CommandError, "program #{key} required" if program(key).nil? || program(key).empty?
end
end
|
ruby
|
def require_program(*keys)
keys.each do |key|
fail CommandError, "program #{key} required" if program(key).nil? || program(key).empty?
end
end
|
[
"def",
"require_program",
"(",
"*",
"keys",
")",
"keys",
".",
"each",
"do",
"|",
"key",
"|",
"fail",
"CommandError",
",",
"\"program #{key} required\"",
"if",
"program",
"(",
"key",
")",
".",
"nil?",
"||",
"program",
"(",
"key",
")",
".",
"empty?",
"end",
"end"
] |
Raises a CommandError when the program any of the _keys_ are not present, or empty.
|
[
"Raises",
"a",
"CommandError",
"when",
"the",
"program",
"any",
"of",
"the",
"_keys_",
"are",
"not",
"present",
"or",
"empty",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/runner.rb#L407-L411
|
13,256
|
commander-rb/commander
|
lib/commander/runner.rb
|
Commander.Runner.run_active_command
|
def run_active_command
require_valid_command
if alias? command_name_from_args
active_command.run(*(@aliases[command_name_from_args.to_s] + args_without_command_name))
else
active_command.run(*args_without_command_name)
end
end
|
ruby
|
def run_active_command
require_valid_command
if alias? command_name_from_args
active_command.run(*(@aliases[command_name_from_args.to_s] + args_without_command_name))
else
active_command.run(*args_without_command_name)
end
end
|
[
"def",
"run_active_command",
"require_valid_command",
"if",
"alias?",
"command_name_from_args",
"active_command",
".",
"run",
"(",
"(",
"@aliases",
"[",
"command_name_from_args",
".",
"to_s",
"]",
"+",
"args_without_command_name",
")",
")",
"else",
"active_command",
".",
"run",
"(",
"args_without_command_name",
")",
"end",
"end"
] |
Run the active command.
|
[
"Run",
"the",
"active",
"command",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/runner.rb#L441-L448
|
13,257
|
commander-rb/commander
|
lib/commander/user_interaction.rb
|
Commander.UI.ask_editor
|
def ask_editor(input = nil, preferred_editor = nil)
editor = available_editor preferred_editor
program = Commander::Runner.instance.program(:name).downcase rescue 'commander'
tmpfile = Tempfile.new program
begin
tmpfile.write input if input
tmpfile.close
system("#{editor} #{tmpfile.path.shellescape}") ? IO.read(tmpfile.path) : nil
ensure
tmpfile.unlink
end
end
|
ruby
|
def ask_editor(input = nil, preferred_editor = nil)
editor = available_editor preferred_editor
program = Commander::Runner.instance.program(:name).downcase rescue 'commander'
tmpfile = Tempfile.new program
begin
tmpfile.write input if input
tmpfile.close
system("#{editor} #{tmpfile.path.shellescape}") ? IO.read(tmpfile.path) : nil
ensure
tmpfile.unlink
end
end
|
[
"def",
"ask_editor",
"(",
"input",
"=",
"nil",
",",
"preferred_editor",
"=",
"nil",
")",
"editor",
"=",
"available_editor",
"preferred_editor",
"program",
"=",
"Commander",
"::",
"Runner",
".",
"instance",
".",
"program",
"(",
":name",
")",
".",
"downcase",
"rescue",
"'commander'",
"tmpfile",
"=",
"Tempfile",
".",
"new",
"program",
"begin",
"tmpfile",
".",
"write",
"input",
"if",
"input",
"tmpfile",
".",
"close",
"system",
"(",
"\"#{editor} #{tmpfile.path.shellescape}\"",
")",
"?",
"IO",
".",
"read",
"(",
"tmpfile",
".",
"path",
")",
":",
"nil",
"ensure",
"tmpfile",
".",
"unlink",
"end",
"end"
] |
Prompt an editor for input. Optionally supply initial
_input_ which is written to the editor.
_preferred_editor_ can be hinted.
=== Examples
ask_editor # => prompts EDITOR with no input
ask_editor('foo') # => prompts EDITOR with default text of 'foo'
ask_editor('foo', 'mate -w') # => prompts TextMate with default text of 'foo'
|
[
"Prompt",
"an",
"editor",
"for",
"input",
".",
"Optionally",
"supply",
"initial",
"_input_",
"which",
"is",
"written",
"to",
"the",
"editor",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/user_interaction.rb#L258-L269
|
13,258
|
commander-rb/commander
|
lib/commander/user_interaction.rb
|
Commander.UI.enable_paging
|
def enable_paging
return unless $stdout.tty?
return unless Process.respond_to? :fork
read, write = IO.pipe
# Kernel.fork is not supported on all platforms and configurations.
# As of Ruby 1.9, `Process.respond_to? :fork` should return false on
# configurations that don't support it, but versions before 1.9 don't
# seem to do this reliably and instead raise a NotImplementedError
# (which is rescued below).
if Kernel.fork
$stdin.reopen read
write.close
read.close
Kernel.select [$stdin]
ENV['LESS'] = 'FSRX' unless ENV.key? 'LESS'
pager = ENV['PAGER'] || 'less'
exec pager rescue exec '/bin/sh', '-c', pager
else
# subprocess
$stdout.reopen write
$stderr.reopen write if $stderr.tty?
write.close
read.close
end
rescue NotImplementedError
ensure
write.close if write && !write.closed?
read.close if read && !read.closed?
end
|
ruby
|
def enable_paging
return unless $stdout.tty?
return unless Process.respond_to? :fork
read, write = IO.pipe
# Kernel.fork is not supported on all platforms and configurations.
# As of Ruby 1.9, `Process.respond_to? :fork` should return false on
# configurations that don't support it, but versions before 1.9 don't
# seem to do this reliably and instead raise a NotImplementedError
# (which is rescued below).
if Kernel.fork
$stdin.reopen read
write.close
read.close
Kernel.select [$stdin]
ENV['LESS'] = 'FSRX' unless ENV.key? 'LESS'
pager = ENV['PAGER'] || 'less'
exec pager rescue exec '/bin/sh', '-c', pager
else
# subprocess
$stdout.reopen write
$stderr.reopen write if $stderr.tty?
write.close
read.close
end
rescue NotImplementedError
ensure
write.close if write && !write.closed?
read.close if read && !read.closed?
end
|
[
"def",
"enable_paging",
"return",
"unless",
"$stdout",
".",
"tty?",
"return",
"unless",
"Process",
".",
"respond_to?",
":fork",
"read",
",",
"write",
"=",
"IO",
".",
"pipe",
"# Kernel.fork is not supported on all platforms and configurations.",
"# As of Ruby 1.9, `Process.respond_to? :fork` should return false on",
"# configurations that don't support it, but versions before 1.9 don't",
"# seem to do this reliably and instead raise a NotImplementedError",
"# (which is rescued below).",
"if",
"Kernel",
".",
"fork",
"$stdin",
".",
"reopen",
"read",
"write",
".",
"close",
"read",
".",
"close",
"Kernel",
".",
"select",
"[",
"$stdin",
"]",
"ENV",
"[",
"'LESS'",
"]",
"=",
"'FSRX'",
"unless",
"ENV",
".",
"key?",
"'LESS'",
"pager",
"=",
"ENV",
"[",
"'PAGER'",
"]",
"||",
"'less'",
"exec",
"pager",
"rescue",
"exec",
"'/bin/sh'",
",",
"'-c'",
",",
"pager",
"else",
"# subprocess",
"$stdout",
".",
"reopen",
"write",
"$stderr",
".",
"reopen",
"write",
"if",
"$stderr",
".",
"tty?",
"write",
".",
"close",
"read",
".",
"close",
"end",
"rescue",
"NotImplementedError",
"ensure",
"write",
".",
"close",
"if",
"write",
"&&",
"!",
"write",
".",
"closed?",
"read",
".",
"close",
"if",
"read",
"&&",
"!",
"read",
".",
"closed?",
"end"
] |
Enable paging of output after called.
|
[
"Enable",
"paging",
"of",
"output",
"after",
"called",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/user_interaction.rb#L274-L304
|
13,259
|
commander-rb/commander
|
lib/commander/user_interaction.rb
|
Commander.UI.progress
|
def progress(arr, options = {})
bar = ProgressBar.new arr.length, options
bar.show
arr.each { |v| bar.increment yield(v) }
end
|
ruby
|
def progress(arr, options = {})
bar = ProgressBar.new arr.length, options
bar.show
arr.each { |v| bar.increment yield(v) }
end
|
[
"def",
"progress",
"(",
"arr",
",",
"options",
"=",
"{",
"}",
")",
"bar",
"=",
"ProgressBar",
".",
"new",
"arr",
".",
"length",
",",
"options",
"bar",
".",
"show",
"arr",
".",
"each",
"{",
"|",
"v",
"|",
"bar",
".",
"increment",
"yield",
"(",
"v",
")",
"}",
"end"
] |
Output progress while iterating _arr_.
=== Examples
uris = %w( http://vision-media.ca http://google.com )
progress uris, :format => "Remaining: :time_remaining" do |uri|
res = open uri
end
|
[
"Output",
"progress",
"while",
"iterating",
"_arr_",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/user_interaction.rb#L317-L321
|
13,260
|
commander-rb/commander
|
lib/commander/user_interaction.rb
|
Commander.UI.replace_tokens
|
def replace_tokens(str, hash) #:nodoc:
hash.inject(str) do |string, (key, value)|
string.gsub ":#{key}", value.to_s
end
end
|
ruby
|
def replace_tokens(str, hash) #:nodoc:
hash.inject(str) do |string, (key, value)|
string.gsub ":#{key}", value.to_s
end
end
|
[
"def",
"replace_tokens",
"(",
"str",
",",
"hash",
")",
"#:nodoc:",
"hash",
".",
"inject",
"(",
"str",
")",
"do",
"|",
"string",
",",
"(",
"key",
",",
"value",
")",
"|",
"string",
".",
"gsub",
"\":#{key}\"",
",",
"value",
".",
"to_s",
"end",
"end"
] |
Substitute _hash_'s keys with their associated values in _str_.
|
[
"Substitute",
"_hash_",
"s",
"keys",
"with",
"their",
"associated",
"values",
"in",
"_str_",
"."
] |
332047c14948225462fe60042eed23adfb996d68
|
https://github.com/commander-rb/commander/blob/332047c14948225462fe60042eed23adfb996d68/lib/commander/user_interaction.rb#L371-L375
|
13,261
|
tongueroo/ufo
|
lib/ufo/tasks/register.rb
|
Ufo.Tasks::Register.rubyize_format
|
def rubyize_format(original_data)
data = original_data.to_snake_keys.deep_symbolize_keys
definitions = data[:container_definitions]
definitions.each_with_index do |definition, i|
next unless definition[:log_configuration]
options = definition[:log_configuration][:options]
next unless options
# LogConfiguration options do not get transformed and keep their original
# structure:
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Types/ContainerDefinition.html
original_definition = original_data["containerDefinitions"][i]
definition[:log_configuration][:options] = original_definition["logConfiguration"]["options"]
end
data
end
|
ruby
|
def rubyize_format(original_data)
data = original_data.to_snake_keys.deep_symbolize_keys
definitions = data[:container_definitions]
definitions.each_with_index do |definition, i|
next unless definition[:log_configuration]
options = definition[:log_configuration][:options]
next unless options
# LogConfiguration options do not get transformed and keep their original
# structure:
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Types/ContainerDefinition.html
original_definition = original_data["containerDefinitions"][i]
definition[:log_configuration][:options] = original_definition["logConfiguration"]["options"]
end
data
end
|
[
"def",
"rubyize_format",
"(",
"original_data",
")",
"data",
"=",
"original_data",
".",
"to_snake_keys",
".",
"deep_symbolize_keys",
"definitions",
"=",
"data",
"[",
":container_definitions",
"]",
"definitions",
".",
"each_with_index",
"do",
"|",
"definition",
",",
"i",
"|",
"next",
"unless",
"definition",
"[",
":log_configuration",
"]",
"options",
"=",
"definition",
"[",
":log_configuration",
"]",
"[",
":options",
"]",
"next",
"unless",
"options",
"# LogConfiguration options do not get transformed and keep their original",
"# structure:",
"# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Types/ContainerDefinition.html",
"original_definition",
"=",
"original_data",
"[",
"\"containerDefinitions\"",
"]",
"[",
"i",
"]",
"definition",
"[",
":log_configuration",
"]",
"[",
":options",
"]",
"=",
"original_definition",
"[",
"\"logConfiguration\"",
"]",
"[",
"\"options\"",
"]",
"end",
"data",
"end"
] |
The ruby aws-sdk expects symbols for keys and AWS docs for the task
definition uses json camelCase for the keys. This method transforms
the keys to the expected ruby aws-sdk format.
One quirk is that the logConfiguration options casing should not be
transformed.
|
[
"The",
"ruby",
"aws",
"-",
"sdk",
"expects",
"symbols",
"for",
"keys",
"and",
"AWS",
"docs",
"for",
"the",
"task",
"definition",
"uses",
"json",
"camelCase",
"for",
"the",
"keys",
".",
"This",
"method",
"transforms",
"the",
"keys",
"to",
"the",
"expected",
"ruby",
"aws",
"-",
"sdk",
"format",
"."
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/tasks/register.rb#L68-L85
|
13,262
|
tongueroo/ufo
|
lib/ufo/ps.rb
|
Ufo.Ps.display_scale_help
|
def display_scale_help
return if service.running_count >= service.desired_count
events = service["events"][0..3] # only check most recent 4 messages
error_event = events.find do |e|
e.message =~ /was unable to place a task/
end
return unless error_event
puts "There is an issue scaling the #{@service.color(:green)} service to #{service.desired_count}. Here's the error:"
puts error_event.message.color(:red)
if service.launch_type == "EC2"
puts "If AutoScaling is set up for the container instances, it can take a little time to add additional instances. You'll see this message until the capacity is added."
end
end
|
ruby
|
def display_scale_help
return if service.running_count >= service.desired_count
events = service["events"][0..3] # only check most recent 4 messages
error_event = events.find do |e|
e.message =~ /was unable to place a task/
end
return unless error_event
puts "There is an issue scaling the #{@service.color(:green)} service to #{service.desired_count}. Here's the error:"
puts error_event.message.color(:red)
if service.launch_type == "EC2"
puts "If AutoScaling is set up for the container instances, it can take a little time to add additional instances. You'll see this message until the capacity is added."
end
end
|
[
"def",
"display_scale_help",
"return",
"if",
"service",
".",
"running_count",
">=",
"service",
".",
"desired_count",
"events",
"=",
"service",
"[",
"\"events\"",
"]",
"[",
"0",
"..",
"3",
"]",
"# only check most recent 4 messages",
"error_event",
"=",
"events",
".",
"find",
"do",
"|",
"e",
"|",
"e",
".",
"message",
"=~",
"/",
"/",
"end",
"return",
"unless",
"error_event",
"puts",
"\"There is an issue scaling the #{@service.color(:green)} service to #{service.desired_count}. Here's the error:\"",
"puts",
"error_event",
".",
"message",
".",
"color",
"(",
":red",
")",
"if",
"service",
".",
"launch_type",
"==",
"\"EC2\"",
"puts",
"\"If AutoScaling is set up for the container instances, it can take a little time to add additional instances. You'll see this message until the capacity is added.\"",
"end",
"end"
] |
If the running count less than the desired account yet, check the events
and show a message with helpful debugging information.
|
[
"If",
"the",
"running",
"count",
"less",
"than",
"the",
"desired",
"account",
"yet",
"check",
"the",
"events",
"and",
"show",
"a",
"message",
"with",
"helpful",
"debugging",
"information",
"."
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/ps.rb#L70-L84
|
13,263
|
tongueroo/ufo
|
lib/ufo/setting.rb
|
Ufo.Setting.ufo_env
|
def ufo_env
settings = YAML.load_file("#{Ufo.root}/.ufo/settings.yml")
env = settings.find do |_env, section|
section ||= {}
ENV['AWS_PROFILE'] && ENV['AWS_PROFILE'] == section['aws_profile']
end
ufo_env = env.first if env
ufo_env = ENV['UFO_ENV'] if ENV['UFO_ENV'] # highest precedence
ufo_env || 'development'
end
|
ruby
|
def ufo_env
settings = YAML.load_file("#{Ufo.root}/.ufo/settings.yml")
env = settings.find do |_env, section|
section ||= {}
ENV['AWS_PROFILE'] && ENV['AWS_PROFILE'] == section['aws_profile']
end
ufo_env = env.first if env
ufo_env = ENV['UFO_ENV'] if ENV['UFO_ENV'] # highest precedence
ufo_env || 'development'
end
|
[
"def",
"ufo_env",
"settings",
"=",
"YAML",
".",
"load_file",
"(",
"\"#{Ufo.root}/.ufo/settings.yml\"",
")",
"env",
"=",
"settings",
".",
"find",
"do",
"|",
"_env",
",",
"section",
"|",
"section",
"||=",
"{",
"}",
"ENV",
"[",
"'AWS_PROFILE'",
"]",
"&&",
"ENV",
"[",
"'AWS_PROFILE'",
"]",
"==",
"section",
"[",
"'aws_profile'",
"]",
"end",
"ufo_env",
"=",
"env",
".",
"first",
"if",
"env",
"ufo_env",
"=",
"ENV",
"[",
"'UFO_ENV'",
"]",
"if",
"ENV",
"[",
"'UFO_ENV'",
"]",
"# highest precedence",
"ufo_env",
"||",
"'development'",
"end"
] |
Resovles infinite problem since Ufo.env can be determined from UFO_ENV or settings.yml files.
When ufo is determined from settings it should not called Ufo.env since that in turn calls
Settings.new.data which can then cause an infinite loop.
|
[
"Resovles",
"infinite",
"problem",
"since",
"Ufo",
".",
"env",
"can",
"be",
"determined",
"from",
"UFO_ENV",
"or",
"settings",
".",
"yml",
"files",
".",
"When",
"ufo",
"is",
"determined",
"from",
"settings",
"it",
"should",
"not",
"called",
"Ufo",
".",
"env",
"since",
"that",
"in",
"turn",
"calls",
"Settings",
".",
"new",
".",
"data",
"which",
"can",
"then",
"cause",
"an",
"infinite",
"loop",
"."
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/setting.rb#L38-L48
|
13,264
|
tongueroo/ufo
|
lib/ufo/dsl.rb
|
Ufo.DSL.evaluate_template_definitions
|
def evaluate_template_definitions
source_code = IO.read(@template_definitions_path)
begin
instance_eval(source_code, @template_definitions_path)
rescue Exception => e
if e.class == SystemExit # allow exit to happen normally
raise
else
task_definition_error(e)
puts "\nFull error:"
raise
end
end
end
|
ruby
|
def evaluate_template_definitions
source_code = IO.read(@template_definitions_path)
begin
instance_eval(source_code, @template_definitions_path)
rescue Exception => e
if e.class == SystemExit # allow exit to happen normally
raise
else
task_definition_error(e)
puts "\nFull error:"
raise
end
end
end
|
[
"def",
"evaluate_template_definitions",
"source_code",
"=",
"IO",
".",
"read",
"(",
"@template_definitions_path",
")",
"begin",
"instance_eval",
"(",
"source_code",
",",
"@template_definitions_path",
")",
"rescue",
"Exception",
"=>",
"e",
"if",
"e",
".",
"class",
"==",
"SystemExit",
"# allow exit to happen normally",
"raise",
"else",
"task_definition_error",
"(",
"e",
")",
"puts",
"\"\\nFull error:\"",
"raise",
"end",
"end",
"end"
] |
All we're doing at this point is saving blocks of code into memory
The instance_eval provides the task_definition and helper methods as they are part
of this class.
|
[
"All",
"we",
"re",
"doing",
"at",
"this",
"point",
"is",
"saving",
"blocks",
"of",
"code",
"into",
"memory",
"The",
"instance_eval",
"provides",
"the",
"task_definition",
"and",
"helper",
"methods",
"as",
"they",
"are",
"part",
"of",
"this",
"class",
"."
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/dsl.rb#L25-L38
|
13,265
|
tongueroo/ufo
|
lib/ufo/dsl.rb
|
Ufo.DSL.task_definition_error
|
def task_definition_error(e)
error_info = e.backtrace.first
path, line_no, _ = error_info.split(':')
line_no = line_no.to_i
puts "Error evaluating #{path}:".color(:red)
puts e.message
puts "Here's the line in #{path} with the error:\n\n"
contents = IO.read(path)
content_lines = contents.split("\n")
context = 5 # lines of context
top, bottom = [line_no-context-1, 0].max, line_no+context-1
spacing = content_lines.size.to_s.size
content_lines[top..bottom].each_with_index do |line_content, index|
line_number = top+index+1
if line_number == line_no
printf("%#{spacing}d %s\n".color(:red), line_number, line_content)
else
printf("%#{spacing}d %s\n", line_number, line_content)
end
end
end
|
ruby
|
def task_definition_error(e)
error_info = e.backtrace.first
path, line_no, _ = error_info.split(':')
line_no = line_no.to_i
puts "Error evaluating #{path}:".color(:red)
puts e.message
puts "Here's the line in #{path} with the error:\n\n"
contents = IO.read(path)
content_lines = contents.split("\n")
context = 5 # lines of context
top, bottom = [line_no-context-1, 0].max, line_no+context-1
spacing = content_lines.size.to_s.size
content_lines[top..bottom].each_with_index do |line_content, index|
line_number = top+index+1
if line_number == line_no
printf("%#{spacing}d %s\n".color(:red), line_number, line_content)
else
printf("%#{spacing}d %s\n", line_number, line_content)
end
end
end
|
[
"def",
"task_definition_error",
"(",
"e",
")",
"error_info",
"=",
"e",
".",
"backtrace",
".",
"first",
"path",
",",
"line_no",
",",
"_",
"=",
"error_info",
".",
"split",
"(",
"':'",
")",
"line_no",
"=",
"line_no",
".",
"to_i",
"puts",
"\"Error evaluating #{path}:\"",
".",
"color",
"(",
":red",
")",
"puts",
"e",
".",
"message",
"puts",
"\"Here's the line in #{path} with the error:\\n\\n\"",
"contents",
"=",
"IO",
".",
"read",
"(",
"path",
")",
"content_lines",
"=",
"contents",
".",
"split",
"(",
"\"\\n\"",
")",
"context",
"=",
"5",
"# lines of context",
"top",
",",
"bottom",
"=",
"[",
"line_no",
"-",
"context",
"-",
"1",
",",
"0",
"]",
".",
"max",
",",
"line_no",
"+",
"context",
"-",
"1",
"spacing",
"=",
"content_lines",
".",
"size",
".",
"to_s",
".",
"size",
"content_lines",
"[",
"top",
"..",
"bottom",
"]",
".",
"each_with_index",
"do",
"|",
"line_content",
",",
"index",
"|",
"line_number",
"=",
"top",
"+",
"index",
"+",
"1",
"if",
"line_number",
"==",
"line_no",
"printf",
"(",
"\"%#{spacing}d %s\\n\"",
".",
"color",
"(",
":red",
")",
",",
"line_number",
",",
"line_content",
")",
"else",
"printf",
"(",
"\"%#{spacing}d %s\\n\"",
",",
"line_number",
",",
"line_content",
")",
"end",
"end",
"end"
] |
Prints out a user friendly task_definition error message
|
[
"Prints",
"out",
"a",
"user",
"friendly",
"task_definition",
"error",
"message"
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/dsl.rb#L41-L62
|
13,266
|
tongueroo/ufo
|
lib/ufo/stack.rb
|
Ufo.Stack.template_body
|
def template_body
custom_template = "#{Ufo.root}/.ufo/settings/cfn/stack.yml"
path = if File.exist?(custom_template)
custom_template
else
# built-in default
File.expand_path("../cfn/stack.yml", File.dirname(__FILE__))
end
RenderMePretty.result(path, context: context.scope)
end
|
ruby
|
def template_body
custom_template = "#{Ufo.root}/.ufo/settings/cfn/stack.yml"
path = if File.exist?(custom_template)
custom_template
else
# built-in default
File.expand_path("../cfn/stack.yml", File.dirname(__FILE__))
end
RenderMePretty.result(path, context: context.scope)
end
|
[
"def",
"template_body",
"custom_template",
"=",
"\"#{Ufo.root}/.ufo/settings/cfn/stack.yml\"",
"path",
"=",
"if",
"File",
".",
"exist?",
"(",
"custom_template",
")",
"custom_template",
"else",
"# built-in default",
"File",
".",
"expand_path",
"(",
"\"../cfn/stack.yml\"",
",",
"File",
".",
"dirname",
"(",
"__FILE__",
")",
")",
"end",
"RenderMePretty",
".",
"result",
"(",
"path",
",",
"context",
":",
"context",
".",
"scope",
")",
"end"
] |
do not memoize template_body it can change for a rename retry
|
[
"do",
"not",
"memoize",
"template_body",
"it",
"can",
"change",
"for",
"a",
"rename",
"retry"
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/stack.rb#L73-L82
|
13,267
|
tongueroo/ufo
|
lib/ufo/stack.rb
|
Ufo.Stack.save_template
|
def save_template
path = "/tmp/ufo/#{@stack_name}/stack.yml"
FileUtils.mkdir_p(File.dirname(path))
IO.write(path, template_body)
puts "Generated template saved at: #{path}"
path = "/tmp/ufo/#{@stack_name}/parameters.yml"
IO.write(path, JSON.pretty_generate(parameters))
puts "Generated parameters saved at: #{path}"
end
|
ruby
|
def save_template
path = "/tmp/ufo/#{@stack_name}/stack.yml"
FileUtils.mkdir_p(File.dirname(path))
IO.write(path, template_body)
puts "Generated template saved at: #{path}"
path = "/tmp/ufo/#{@stack_name}/parameters.yml"
IO.write(path, JSON.pretty_generate(parameters))
puts "Generated parameters saved at: #{path}"
end
|
[
"def",
"save_template",
"path",
"=",
"\"/tmp/ufo/#{@stack_name}/stack.yml\"",
"FileUtils",
".",
"mkdir_p",
"(",
"File",
".",
"dirname",
"(",
"path",
")",
")",
"IO",
".",
"write",
"(",
"path",
",",
"template_body",
")",
"puts",
"\"Generated template saved at: #{path}\"",
"path",
"=",
"\"/tmp/ufo/#{@stack_name}/parameters.yml\"",
"IO",
".",
"write",
"(",
"path",
",",
"JSON",
".",
"pretty_generate",
"(",
"parameters",
")",
")",
"puts",
"\"Generated parameters saved at: #{path}\"",
"end"
] |
Store template in tmp in case for debugging
|
[
"Store",
"template",
"in",
"tmp",
"in",
"case",
"for",
"debugging"
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/stack.rb#L167-L176
|
13,268
|
tongueroo/ufo
|
lib/ufo/ship.rb
|
Ufo.Ship.stop_old_tasks
|
def stop_old_tasks
# only works when deployment is blocking
return unless @options[:wait]
Thread.new do
stop = Ufo::Stop.new(@service, @options.merge(mute: true))
while true
stop.log "checking for old tasks and waiting for 10 seconds"
stop.run
sleep 10
end
end
end
|
ruby
|
def stop_old_tasks
# only works when deployment is blocking
return unless @options[:wait]
Thread.new do
stop = Ufo::Stop.new(@service, @options.merge(mute: true))
while true
stop.log "checking for old tasks and waiting for 10 seconds"
stop.run
sleep 10
end
end
end
|
[
"def",
"stop_old_tasks",
"# only works when deployment is blocking",
"return",
"unless",
"@options",
"[",
":wait",
"]",
"Thread",
".",
"new",
"do",
"stop",
"=",
"Ufo",
"::",
"Stop",
".",
"new",
"(",
"@service",
",",
"@options",
".",
"merge",
"(",
"mute",
":",
"true",
")",
")",
"while",
"true",
"stop",
".",
"log",
"\"checking for old tasks and waiting for 10 seconds\"",
"stop",
".",
"run",
"sleep",
"10",
"end",
"end",
"end"
] |
Start a thread that will poll for ecs deployments and kill of tasks
in old deployments.
This must be done in a thread because the stack update process is blocking.
|
[
"Start",
"a",
"thread",
"that",
"will",
"poll",
"for",
"ecs",
"deployments",
"and",
"kill",
"of",
"tasks",
"in",
"old",
"deployments",
".",
"This",
"must",
"be",
"done",
"in",
"a",
"thread",
"because",
"the",
"stack",
"update",
"process",
"is",
"blocking",
"."
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/ship.rb#L40-L52
|
13,269
|
tongueroo/ufo
|
lib/ufo/info.rb
|
Ufo.Info.load_balancer
|
def load_balancer(service)
load_balancer = service.load_balancers.first
return unless load_balancer
resp = elb.describe_target_groups(
target_group_arns: [load_balancer.target_group_arn]
)
target_group = resp.target_groups.first
load_balancer_arn = target_group.load_balancer_arns.first # assume first only
resp = elb.describe_load_balancers(load_balancer_arns: [load_balancer_arn])
resp.load_balancers.first
end
|
ruby
|
def load_balancer(service)
load_balancer = service.load_balancers.first
return unless load_balancer
resp = elb.describe_target_groups(
target_group_arns: [load_balancer.target_group_arn]
)
target_group = resp.target_groups.first
load_balancer_arn = target_group.load_balancer_arns.first # assume first only
resp = elb.describe_load_balancers(load_balancer_arns: [load_balancer_arn])
resp.load_balancers.first
end
|
[
"def",
"load_balancer",
"(",
"service",
")",
"load_balancer",
"=",
"service",
".",
"load_balancers",
".",
"first",
"return",
"unless",
"load_balancer",
"resp",
"=",
"elb",
".",
"describe_target_groups",
"(",
"target_group_arns",
":",
"[",
"load_balancer",
".",
"target_group_arn",
"]",
")",
"target_group",
"=",
"resp",
".",
"target_groups",
".",
"first",
"load_balancer_arn",
"=",
"target_group",
".",
"load_balancer_arns",
".",
"first",
"# assume first only",
"resp",
"=",
"elb",
".",
"describe_load_balancers",
"(",
"load_balancer_arns",
":",
"[",
"load_balancer_arn",
"]",
")",
"resp",
".",
"load_balancers",
".",
"first",
"end"
] |
Passing in service so method can be used else where.
|
[
"Passing",
"in",
"service",
"so",
"method",
"can",
"be",
"used",
"else",
"where",
"."
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/info.rb#L17-L29
|
13,270
|
tongueroo/ufo
|
lib/ufo/completer.rb
|
Ufo.Completer.all_commands
|
def all_commands
commands = @command_class.all_commands.reject do |k,v|
v.is_a?(Thor::HiddenCommand)
end
commands.keys
end
|
ruby
|
def all_commands
commands = @command_class.all_commands.reject do |k,v|
v.is_a?(Thor::HiddenCommand)
end
commands.keys
end
|
[
"def",
"all_commands",
"commands",
"=",
"@command_class",
".",
"all_commands",
".",
"reject",
"do",
"|",
"k",
",",
"v",
"|",
"v",
".",
"is_a?",
"(",
"Thor",
"::",
"HiddenCommand",
")",
"end",
"commands",
".",
"keys",
"end"
] |
all top-level commands
|
[
"all",
"top",
"-",
"level",
"commands"
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/completer.rb#L119-L124
|
13,271
|
tongueroo/ufo
|
lib/ufo/status.rb
|
Ufo.Status.run
|
def run
unless stack_exists?(@stack_name)
puts "The stack #{@stack_name.color(:green)} does not exist."
return
end
resp = cloudformation.describe_stacks(stack_name: @stack_name)
stack = resp.stacks.first
puts "The current status for the stack #{@stack_name.color(:green)} is #{stack.stack_status.color(:green)}"
status_poller = Stack::Status.new(@stack_name)
if stack.stack_status =~ /_IN_PROGRESS$/
puts "Stack events (tailing):"
# tail all events until done
status_poller.hide_time_took = true
status_poller.wait
else
puts "Stack events:"
# show the last events that was user initiated
status_poller.refresh_events
status_poller.show_events(true)
end
end
|
ruby
|
def run
unless stack_exists?(@stack_name)
puts "The stack #{@stack_name.color(:green)} does not exist."
return
end
resp = cloudformation.describe_stacks(stack_name: @stack_name)
stack = resp.stacks.first
puts "The current status for the stack #{@stack_name.color(:green)} is #{stack.stack_status.color(:green)}"
status_poller = Stack::Status.new(@stack_name)
if stack.stack_status =~ /_IN_PROGRESS$/
puts "Stack events (tailing):"
# tail all events until done
status_poller.hide_time_took = true
status_poller.wait
else
puts "Stack events:"
# show the last events that was user initiated
status_poller.refresh_events
status_poller.show_events(true)
end
end
|
[
"def",
"run",
"unless",
"stack_exists?",
"(",
"@stack_name",
")",
"puts",
"\"The stack #{@stack_name.color(:green)} does not exist.\"",
"return",
"end",
"resp",
"=",
"cloudformation",
".",
"describe_stacks",
"(",
"stack_name",
":",
"@stack_name",
")",
"stack",
"=",
"resp",
".",
"stacks",
".",
"first",
"puts",
"\"The current status for the stack #{@stack_name.color(:green)} is #{stack.stack_status.color(:green)}\"",
"status_poller",
"=",
"Stack",
"::",
"Status",
".",
"new",
"(",
"@stack_name",
")",
"if",
"stack",
".",
"stack_status",
"=~",
"/",
"/",
"puts",
"\"Stack events (tailing):\"",
"# tail all events until done",
"status_poller",
".",
"hide_time_took",
"=",
"true",
"status_poller",
".",
"wait",
"else",
"puts",
"\"Stack events:\"",
"# show the last events that was user initiated",
"status_poller",
".",
"refresh_events",
"status_poller",
".",
"show_events",
"(",
"true",
")",
"end",
"end"
] |
used for the ufo status command
|
[
"used",
"for",
"the",
"ufo",
"status",
"command"
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/status.rb#L4-L28
|
13,272
|
tongueroo/ufo
|
lib/ufo/task.rb
|
Ufo.Task.adjust_fargate_options
|
def adjust_fargate_options(options)
task_def = recent_task_definition
return options unless task_def[:network_mode] == "awsvpc"
awsvpc_conf = { subnets: network[:ecs_subnets] }
if task_def[:requires_compatibilities] == ["FARGATE"]
awsvpc_conf[:assign_public_ip] = "ENABLED"
options[:launch_type] = "FARGATE"
end
options[:network_configuration] = { awsvpc_configuration: awsvpc_conf }
options
end
|
ruby
|
def adjust_fargate_options(options)
task_def = recent_task_definition
return options unless task_def[:network_mode] == "awsvpc"
awsvpc_conf = { subnets: network[:ecs_subnets] }
if task_def[:requires_compatibilities] == ["FARGATE"]
awsvpc_conf[:assign_public_ip] = "ENABLED"
options[:launch_type] = "FARGATE"
end
options[:network_configuration] = { awsvpc_configuration: awsvpc_conf }
options
end
|
[
"def",
"adjust_fargate_options",
"(",
"options",
")",
"task_def",
"=",
"recent_task_definition",
"return",
"options",
"unless",
"task_def",
"[",
":network_mode",
"]",
"==",
"\"awsvpc\"",
"awsvpc_conf",
"=",
"{",
"subnets",
":",
"network",
"[",
":ecs_subnets",
"]",
"}",
"if",
"task_def",
"[",
":requires_compatibilities",
"]",
"==",
"[",
"\"FARGATE\"",
"]",
"awsvpc_conf",
"[",
":assign_public_ip",
"]",
"=",
"\"ENABLED\"",
"options",
"[",
":launch_type",
"]",
"=",
"\"FARGATE\"",
"end",
"options",
"[",
":network_configuration",
"]",
"=",
"{",
"awsvpc_configuration",
":",
"awsvpc_conf",
"}",
"options",
"end"
] |
adjust network_configuration based on fargate and network mode of awsvpc
|
[
"adjust",
"network_configuration",
"based",
"on",
"fargate",
"and",
"network",
"mode",
"of",
"awsvpc"
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/task.rb#L103-L115
|
13,273
|
tongueroo/ufo
|
lib/ufo/task.rb
|
Ufo.Task.adjust_security_groups
|
def adjust_security_groups(options)
return options unless options[:network_configuration] &&
options[:network_configuration][:awsvpc_configuration]
awsvpc_conf = options[:network_configuration][:awsvpc_configuration]
security_groups = awsvpc_conf[:security_groups]
if [nil, '', 'nil'].include?(security_groups)
security_groups = []
end
if security_groups.empty?
fetch = Network::Fetch.new(network[:vpc])
sg = fetch.security_group_id
security_groups << sg
security_groups.uniq!
end
# override security groups
options[:network_configuration][:awsvpc_configuration][:security_groups] = security_groups
options
end
|
ruby
|
def adjust_security_groups(options)
return options unless options[:network_configuration] &&
options[:network_configuration][:awsvpc_configuration]
awsvpc_conf = options[:network_configuration][:awsvpc_configuration]
security_groups = awsvpc_conf[:security_groups]
if [nil, '', 'nil'].include?(security_groups)
security_groups = []
end
if security_groups.empty?
fetch = Network::Fetch.new(network[:vpc])
sg = fetch.security_group_id
security_groups << sg
security_groups.uniq!
end
# override security groups
options[:network_configuration][:awsvpc_configuration][:security_groups] = security_groups
options
end
|
[
"def",
"adjust_security_groups",
"(",
"options",
")",
"return",
"options",
"unless",
"options",
"[",
":network_configuration",
"]",
"&&",
"options",
"[",
":network_configuration",
"]",
"[",
":awsvpc_configuration",
"]",
"awsvpc_conf",
"=",
"options",
"[",
":network_configuration",
"]",
"[",
":awsvpc_configuration",
"]",
"security_groups",
"=",
"awsvpc_conf",
"[",
":security_groups",
"]",
"if",
"[",
"nil",
",",
"''",
",",
"'nil'",
"]",
".",
"include?",
"(",
"security_groups",
")",
"security_groups",
"=",
"[",
"]",
"end",
"if",
"security_groups",
".",
"empty?",
"fetch",
"=",
"Network",
"::",
"Fetch",
".",
"new",
"(",
"network",
"[",
":vpc",
"]",
")",
"sg",
"=",
"fetch",
".",
"security_group_id",
"security_groups",
"<<",
"sg",
"security_groups",
".",
"uniq!",
"end",
"# override security groups",
"options",
"[",
":network_configuration",
"]",
"[",
":awsvpc_configuration",
"]",
"[",
":security_groups",
"]",
"=",
"security_groups",
"options",
"end"
] |
Ensures at least 1 security group is assigned if awsvpc_configuration
is provided.
|
[
"Ensures",
"at",
"least",
"1",
"security",
"group",
"is",
"assigned",
"if",
"awsvpc_configuration",
"is",
"provided",
"."
] |
16ac3dad28edcab2693c0e7d89a1971aca65b8f9
|
https://github.com/tongueroo/ufo/blob/16ac3dad28edcab2693c0e7d89a1971aca65b8f9/lib/ufo/task.rb#L119-L139
|
13,274
|
amatsuda/active_decorator
|
lib/active_decorator/decorator.rb
|
ActiveDecorator.Decorator.decorate_association
|
def decorate_association(owner, target)
owner.is_a?(ActiveDecorator::Decorated) ? decorate(target) : target
end
|
ruby
|
def decorate_association(owner, target)
owner.is_a?(ActiveDecorator::Decorated) ? decorate(target) : target
end
|
[
"def",
"decorate_association",
"(",
"owner",
",",
"target",
")",
"owner",
".",
"is_a?",
"(",
"ActiveDecorator",
"::",
"Decorated",
")",
"?",
"decorate",
"(",
"target",
")",
":",
"target",
"end"
] |
Decorates AR model object's association only when the object was decorated.
Returns the association instance.
|
[
"Decorates",
"AR",
"model",
"object",
"s",
"association",
"only",
"when",
"the",
"object",
"was",
"decorated",
".",
"Returns",
"the",
"association",
"instance",
"."
] |
e7cfa764e657ea8bbb4cbe92cb220ee67ebae58e
|
https://github.com/amatsuda/active_decorator/blob/e7cfa764e657ea8bbb4cbe92cb220ee67ebae58e/lib/active_decorator/decorator.rb#L61-L63
|
13,275
|
amatsuda/active_decorator
|
lib/active_decorator/decorator.rb
|
ActiveDecorator.Decorator.decorator_for
|
def decorator_for(model_class)
return @@decorators[model_class] if @@decorators.key? model_class
decorator_name = "#{model_class.name}#{ActiveDecorator.config.decorator_suffix}"
d = Object.const_get decorator_name, false
unless Class === d
d.send :include, ActiveDecorator::Helpers
@@decorators[model_class] = d
else
# Cache nil results
@@decorators[model_class] = nil
end
rescue NameError
if model_class.respond_to?(:base_class) && (model_class.base_class != model_class)
@@decorators[model_class] = decorator_for model_class.base_class
else
# Cache nil results
@@decorators[model_class] = nil
end
end
|
ruby
|
def decorator_for(model_class)
return @@decorators[model_class] if @@decorators.key? model_class
decorator_name = "#{model_class.name}#{ActiveDecorator.config.decorator_suffix}"
d = Object.const_get decorator_name, false
unless Class === d
d.send :include, ActiveDecorator::Helpers
@@decorators[model_class] = d
else
# Cache nil results
@@decorators[model_class] = nil
end
rescue NameError
if model_class.respond_to?(:base_class) && (model_class.base_class != model_class)
@@decorators[model_class] = decorator_for model_class.base_class
else
# Cache nil results
@@decorators[model_class] = nil
end
end
|
[
"def",
"decorator_for",
"(",
"model_class",
")",
"return",
"@@decorators",
"[",
"model_class",
"]",
"if",
"@@decorators",
".",
"key?",
"model_class",
"decorator_name",
"=",
"\"#{model_class.name}#{ActiveDecorator.config.decorator_suffix}\"",
"d",
"=",
"Object",
".",
"const_get",
"decorator_name",
",",
"false",
"unless",
"Class",
"===",
"d",
"d",
".",
"send",
":include",
",",
"ActiveDecorator",
"::",
"Helpers",
"@@decorators",
"[",
"model_class",
"]",
"=",
"d",
"else",
"# Cache nil results",
"@@decorators",
"[",
"model_class",
"]",
"=",
"nil",
"end",
"rescue",
"NameError",
"if",
"model_class",
".",
"respond_to?",
"(",
":base_class",
")",
"&&",
"(",
"model_class",
".",
"base_class",
"!=",
"model_class",
")",
"@@decorators",
"[",
"model_class",
"]",
"=",
"decorator_for",
"model_class",
".",
"base_class",
"else",
"# Cache nil results",
"@@decorators",
"[",
"model_class",
"]",
"=",
"nil",
"end",
"end"
] |
Returns a decorator module for the given class.
Returns `nil` if no decorator module was found.
|
[
"Returns",
"a",
"decorator",
"module",
"for",
"the",
"given",
"class",
".",
"Returns",
"nil",
"if",
"no",
"decorator",
"module",
"was",
"found",
"."
] |
e7cfa764e657ea8bbb4cbe92cb220ee67ebae58e
|
https://github.com/amatsuda/active_decorator/blob/e7cfa764e657ea8bbb4cbe92cb220ee67ebae58e/lib/active_decorator/decorator.rb#L68-L87
|
13,276
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb
|
Azure::Web::Mgmt::V2015_08_01.AppServiceCertificateOrders.delete
|
def delete(resource_group_name, certificate_order_name, custom_headers:nil)
response = delete_async(resource_group_name, certificate_order_name, custom_headers:custom_headers).value!
nil
end
|
ruby
|
def delete(resource_group_name, certificate_order_name, custom_headers:nil)
response = delete_async(resource_group_name, certificate_order_name, custom_headers:custom_headers).value!
nil
end
|
[
"def",
"delete",
"(",
"resource_group_name",
",",
"certificate_order_name",
",",
"custom_headers",
":",
"nil",
")",
"response",
"=",
"delete_async",
"(",
"resource_group_name",
",",
"certificate_order_name",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"nil",
"end"
] |
Delete an existing certificate order.
Delete an existing certificate order.
@param resource_group_name [String] Name of the resource group to which the
resource belongs.
@param certificate_order_name [String] Name of the certificate order.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
|
[
"Delete",
"an",
"existing",
"certificate",
"order",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb#L473-L476
|
13,277
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb
|
Azure::Web::Mgmt::V2015_08_01.AppServiceCertificateOrders.resend_email
|
def resend_email(resource_group_name, certificate_order_name, custom_headers:nil)
response = resend_email_async(resource_group_name, certificate_order_name, custom_headers:custom_headers).value!
nil
end
|
ruby
|
def resend_email(resource_group_name, certificate_order_name, custom_headers:nil)
response = resend_email_async(resource_group_name, certificate_order_name, custom_headers:custom_headers).value!
nil
end
|
[
"def",
"resend_email",
"(",
"resource_group_name",
",",
"certificate_order_name",
",",
"custom_headers",
":",
"nil",
")",
"response",
"=",
"resend_email_async",
"(",
"resource_group_name",
",",
"certificate_order_name",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"nil",
"end"
] |
Resend certificate email.
Resend certificate email.
@param resource_group_name [String] Name of the resource group to which the
resource belongs.
@param certificate_order_name [String] Name of the certificate order.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
|
[
"Resend",
"certificate",
"email",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb#L1404-L1407
|
13,278
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb
|
Azure::Web::Mgmt::V2015_08_01.AppServiceCertificateOrders.retrieve_certificate_actions
|
def retrieve_certificate_actions(resource_group_name, name, custom_headers:nil)
response = retrieve_certificate_actions_async(resource_group_name, name, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
ruby
|
def retrieve_certificate_actions(resource_group_name, name, custom_headers:nil)
response = retrieve_certificate_actions_async(resource_group_name, name, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
[
"def",
"retrieve_certificate_actions",
"(",
"resource_group_name",
",",
"name",
",",
"custom_headers",
":",
"nil",
")",
"response",
"=",
"retrieve_certificate_actions_async",
"(",
"resource_group_name",
",",
"name",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"response",
".",
"body",
"unless",
"response",
".",
"nil?",
"end"
] |
Retrieve the list of certificate actions.
Retrieve the list of certificate actions.
@param resource_group_name [String] Name of the resource group to which the
resource belongs.
@param name [String] Name of the certificate order.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [Array] operation results.
|
[
"Retrieve",
"the",
"list",
"of",
"certificate",
"actions",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb#L1810-L1813
|
13,279
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb
|
Azure::Web::Mgmt::V2015_08_01.AppServiceCertificateOrders.retrieve_certificate_email_history
|
def retrieve_certificate_email_history(resource_group_name, name, custom_headers:nil)
response = retrieve_certificate_email_history_async(resource_group_name, name, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
ruby
|
def retrieve_certificate_email_history(resource_group_name, name, custom_headers:nil)
response = retrieve_certificate_email_history_async(resource_group_name, name, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
[
"def",
"retrieve_certificate_email_history",
"(",
"resource_group_name",
",",
"name",
",",
"custom_headers",
":",
"nil",
")",
"response",
"=",
"retrieve_certificate_email_history_async",
"(",
"resource_group_name",
",",
"name",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"response",
".",
"body",
"unless",
"response",
".",
"nil?",
"end"
] |
Retrieve email history.
Retrieve email history.
@param resource_group_name [String] Name of the resource group to which the
resource belongs.
@param name [String] Name of the certificate order.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [Array] operation results.
|
[
"Retrieve",
"email",
"history",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb#L1930-L1933
|
13,280
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb
|
Azure::Web::Mgmt::V2015_08_01.AppServiceCertificateOrders.list_by_resource_group_next
|
def list_by_resource_group_next(next_page_link, custom_headers:nil)
response = list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
ruby
|
def list_by_resource_group_next(next_page_link, custom_headers:nil)
response = list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
[
"def",
"list_by_resource_group_next",
"(",
"next_page_link",
",",
"custom_headers",
":",
"nil",
")",
"response",
"=",
"list_by_resource_group_next_async",
"(",
"next_page_link",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"response",
".",
"body",
"unless",
"response",
".",
"nil?",
"end"
] |
Get certificate orders in a resource group.
Get certificate orders in a resource group.
@param next_page_link [String] The NextLink from the previous successful call
to List operation.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [AppServiceCertificateOrderCollection] operation results.
|
[
"Get",
"certificate",
"orders",
"in",
"a",
"resource",
"group",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_web/lib/2015-08-01/generated/azure_mgmt_web/app_service_certificate_orders.rb#L2403-L2406
|
13,281
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_network/lib/2018-12-01/generated/azure_mgmt_network/virtual_network_peerings.rb
|
Azure::Network::Mgmt::V2018_12_01.VirtualNetworkPeerings.get_with_http_info
|
def get_with_http_info(resource_group_name, virtual_network_name, virtual_network_peering_name, custom_headers:nil)
get_async(resource_group_name, virtual_network_name, virtual_network_peering_name, custom_headers:custom_headers).value!
end
|
ruby
|
def get_with_http_info(resource_group_name, virtual_network_name, virtual_network_peering_name, custom_headers:nil)
get_async(resource_group_name, virtual_network_name, virtual_network_peering_name, custom_headers:custom_headers).value!
end
|
[
"def",
"get_with_http_info",
"(",
"resource_group_name",
",",
"virtual_network_name",
",",
"virtual_network_peering_name",
",",
"custom_headers",
":",
"nil",
")",
"get_async",
"(",
"resource_group_name",
",",
"virtual_network_name",
",",
"virtual_network_peering_name",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"end"
] |
Gets the specified virtual network peering.
@param resource_group_name [String] The name of the resource group.
@param virtual_network_name [String] The name of the virtual network.
@param virtual_network_peering_name [String] The name of the virtual network
peering.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
|
[
"Gets",
"the",
"specified",
"virtual",
"network",
"peering",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_network/lib/2018-12-01/generated/azure_mgmt_network/virtual_network_peerings.rb#L95-L97
|
13,282
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_network/lib/2018-12-01/generated/azure_mgmt_network/virtual_network_peerings.rb
|
Azure::Network::Mgmt::V2018_12_01.VirtualNetworkPeerings.list
|
def list(resource_group_name, virtual_network_name, custom_headers:nil)
first_page = list_as_lazy(resource_group_name, virtual_network_name, custom_headers:custom_headers)
first_page.get_all_items
end
|
ruby
|
def list(resource_group_name, virtual_network_name, custom_headers:nil)
first_page = list_as_lazy(resource_group_name, virtual_network_name, custom_headers:custom_headers)
first_page.get_all_items
end
|
[
"def",
"list",
"(",
"resource_group_name",
",",
"virtual_network_name",
",",
"custom_headers",
":",
"nil",
")",
"first_page",
"=",
"list_as_lazy",
"(",
"resource_group_name",
",",
"virtual_network_name",
",",
"custom_headers",
":custom_headers",
")",
"first_page",
".",
"get_all_items",
"end"
] |
Gets all virtual network peerings in a virtual network.
@param resource_group_name [String] The name of the resource group.
@param virtual_network_name [String] The name of the virtual network.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [Array<VirtualNetworkPeering>] operation results.
|
[
"Gets",
"all",
"virtual",
"network",
"peerings",
"in",
"a",
"virtual",
"network",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_network/lib/2018-12-01/generated/azure_mgmt_network/virtual_network_peerings.rb#L223-L226
|
13,283
|
Azure/azure-sdk-for-ruby
|
runtime/ms_rest_azure/lib/ms_rest_azure/azure_service_client.rb
|
MsRestAzure.AzureServiceClient.check_for_status_code_failure
|
def check_for_status_code_failure(azure_response)
fail MsRest::ValidationError, 'Azure response cannot be nil' if azure_response.nil?
fail MsRest::ValidationError, 'Azure response cannot have empty response object' if azure_response.response.nil?
fail MsRest::ValidationError, 'Azure response cannot have empty request object' if azure_response.request.nil?
status_code = azure_response.response.status
http_method = azure_response.request.method
fail AzureOperationError, "Unexpected polling status code from long running operation #{status_code}" unless status_code === 200 || status_code === 202 ||
(status_code === 201 && http_method === :put) ||
(status_code === 204 && (http_method === :delete || http_method === :post))
end
|
ruby
|
def check_for_status_code_failure(azure_response)
fail MsRest::ValidationError, 'Azure response cannot be nil' if azure_response.nil?
fail MsRest::ValidationError, 'Azure response cannot have empty response object' if azure_response.response.nil?
fail MsRest::ValidationError, 'Azure response cannot have empty request object' if azure_response.request.nil?
status_code = azure_response.response.status
http_method = azure_response.request.method
fail AzureOperationError, "Unexpected polling status code from long running operation #{status_code}" unless status_code === 200 || status_code === 202 ||
(status_code === 201 && http_method === :put) ||
(status_code === 204 && (http_method === :delete || http_method === :post))
end
|
[
"def",
"check_for_status_code_failure",
"(",
"azure_response",
")",
"fail",
"MsRest",
"::",
"ValidationError",
",",
"'Azure response cannot be nil'",
"if",
"azure_response",
".",
"nil?",
"fail",
"MsRest",
"::",
"ValidationError",
",",
"'Azure response cannot have empty response object'",
"if",
"azure_response",
".",
"response",
".",
"nil?",
"fail",
"MsRest",
"::",
"ValidationError",
",",
"'Azure response cannot have empty request object'",
"if",
"azure_response",
".",
"request",
".",
"nil?",
"status_code",
"=",
"azure_response",
".",
"response",
".",
"status",
"http_method",
"=",
"azure_response",
".",
"request",
".",
"method",
"fail",
"AzureOperationError",
",",
"\"Unexpected polling status code from long running operation #{status_code}\"",
"unless",
"status_code",
"===",
"200",
"||",
"status_code",
"===",
"202",
"||",
"(",
"status_code",
"===",
"201",
"&&",
"http_method",
"===",
":put",
")",
"||",
"(",
"status_code",
"===",
"204",
"&&",
"(",
"http_method",
"===",
":delete",
"||",
"http_method",
"===",
":post",
")",
")",
"end"
] |
Verifies for unexpected polling status code
@param azure_response [MsRestAzure::AzureOperationResponse] response from Azure service.
|
[
"Verifies",
"for",
"unexpected",
"polling",
"status",
"code"
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/runtime/ms_rest_azure/lib/ms_rest_azure/azure_service_client.rb#L122-L133
|
13,284
|
Azure/azure-sdk-for-ruby
|
runtime/ms_rest_azure/lib/ms_rest_azure/azure_service_client.rb
|
MsRestAzure.AzureServiceClient.update_state_from_get_resource_operation
|
def update_state_from_get_resource_operation(request, polling_state, custom_deserialization_block)
result = get_async_with_custom_deserialization(request, custom_deserialization_block)
fail AzureOperationError, 'The response from long running operation does not contain a body' if result.response.body.nil? || result.response.body.empty?
# On non flattened resource, we should find provisioning_state inside 'properties'
if result.body.respond_to?(:properties) && result.body.properties.respond_to?(:provisioning_state) && !result.body.properties.provisioning_state.nil?
polling_state.status = result.body.properties.provisioning_state
# On flattened resource, we should find provisioning_state at the top level
elsif result.body.respond_to?(:provisioning_state) && !result.body.provisioning_state.nil?
polling_state.status = result.body.provisioning_state
else
polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
end
error_data = CloudErrorData.new
error_data.code = polling_state.status
error_data.message = "Long running operation failed with status #{polling_state.status}"
polling_state.error_data = error_data
polling_state.update_response(result.response)
polling_state.request = result.request
polling_state.resource = result.body
end
|
ruby
|
def update_state_from_get_resource_operation(request, polling_state, custom_deserialization_block)
result = get_async_with_custom_deserialization(request, custom_deserialization_block)
fail AzureOperationError, 'The response from long running operation does not contain a body' if result.response.body.nil? || result.response.body.empty?
# On non flattened resource, we should find provisioning_state inside 'properties'
if result.body.respond_to?(:properties) && result.body.properties.respond_to?(:provisioning_state) && !result.body.properties.provisioning_state.nil?
polling_state.status = result.body.properties.provisioning_state
# On flattened resource, we should find provisioning_state at the top level
elsif result.body.respond_to?(:provisioning_state) && !result.body.provisioning_state.nil?
polling_state.status = result.body.provisioning_state
else
polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
end
error_data = CloudErrorData.new
error_data.code = polling_state.status
error_data.message = "Long running operation failed with status #{polling_state.status}"
polling_state.error_data = error_data
polling_state.update_response(result.response)
polling_state.request = result.request
polling_state.resource = result.body
end
|
[
"def",
"update_state_from_get_resource_operation",
"(",
"request",
",",
"polling_state",
",",
"custom_deserialization_block",
")",
"result",
"=",
"get_async_with_custom_deserialization",
"(",
"request",
",",
"custom_deserialization_block",
")",
"fail",
"AzureOperationError",
",",
"'The response from long running operation does not contain a body'",
"if",
"result",
".",
"response",
".",
"body",
".",
"nil?",
"||",
"result",
".",
"response",
".",
"body",
".",
"empty?",
"# On non flattened resource, we should find provisioning_state inside 'properties'",
"if",
"result",
".",
"body",
".",
"respond_to?",
"(",
":properties",
")",
"&&",
"result",
".",
"body",
".",
"properties",
".",
"respond_to?",
"(",
":provisioning_state",
")",
"&&",
"!",
"result",
".",
"body",
".",
"properties",
".",
"provisioning_state",
".",
"nil?",
"polling_state",
".",
"status",
"=",
"result",
".",
"body",
".",
"properties",
".",
"provisioning_state",
"# On flattened resource, we should find provisioning_state at the top level",
"elsif",
"result",
".",
"body",
".",
"respond_to?",
"(",
":provisioning_state",
")",
"&&",
"!",
"result",
".",
"body",
".",
"provisioning_state",
".",
"nil?",
"polling_state",
".",
"status",
"=",
"result",
".",
"body",
".",
"provisioning_state",
"else",
"polling_state",
".",
"status",
"=",
"AsyncOperationStatus",
"::",
"SUCCESS_STATUS",
"end",
"error_data",
"=",
"CloudErrorData",
".",
"new",
"error_data",
".",
"code",
"=",
"polling_state",
".",
"status",
"error_data",
".",
"message",
"=",
"\"Long running operation failed with status #{polling_state.status}\"",
"polling_state",
".",
"error_data",
"=",
"error_data",
"polling_state",
".",
"update_response",
"(",
"result",
".",
"response",
")",
"polling_state",
".",
"request",
"=",
"result",
".",
"request",
"polling_state",
".",
"resource",
"=",
"result",
".",
"body",
"end"
] |
Updates polling state based on location header for PUT HTTP requests.
@param request [MsRest::HttpOperationRequest] The url retrieve data from.
@param polling_state [MsRestAzure::PollingState] polling state to update.
@param custom_deserialization_block [Proc] custom deserialization method for parsing response.
|
[
"Updates",
"polling",
"state",
"based",
"on",
"location",
"header",
"for",
"PUT",
"HTTP",
"requests",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/runtime/ms_rest_azure/lib/ms_rest_azure/azure_service_client.rb#L141-L164
|
13,285
|
Azure/azure-sdk-for-ruby
|
runtime/ms_rest_azure/lib/ms_rest_azure/azure_service_client.rb
|
MsRestAzure.AzureServiceClient.update_state_from_location_header
|
def update_state_from_location_header(request, polling_state, custom_deserialization_block, final_state_via = FinalStateVia::DEFAULT)
result = get_async_with_custom_deserialization(request, custom_deserialization_block)
polling_state.update_response(result.response)
polling_state.request = result.request
status_code = result.response.status
http_method = request.method
if status_code === 202
polling_state.status = AsyncOperationStatus::IN_PROGRESS_STATUS
elsif status_code === 200 || (status_code === 201 && http_method === :put) ||
(status_code === 204 && (http_method === :delete || http_method === :post || http_method === :get))
polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
error_data = CloudErrorData.new
error_data.code = polling_state.status
error_data.message = "Long running operation failed with status #{polling_state.status}"
polling_state.error_data = error_data
polling_state.resource = result.body
elsif final_state_via == FinalStateVia::LOCATION && status_code === 404 && http_method === :delete && !polling_state.azure_async_operation_header_link.nil? && !polling_state.location_header_link.nil?
polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
else
fail AzureOperationError, "The response from long running operation does not have a valid status code. Method: #{http_method}, Status Code: #{status_code}"
end
end
|
ruby
|
def update_state_from_location_header(request, polling_state, custom_deserialization_block, final_state_via = FinalStateVia::DEFAULT)
result = get_async_with_custom_deserialization(request, custom_deserialization_block)
polling_state.update_response(result.response)
polling_state.request = result.request
status_code = result.response.status
http_method = request.method
if status_code === 202
polling_state.status = AsyncOperationStatus::IN_PROGRESS_STATUS
elsif status_code === 200 || (status_code === 201 && http_method === :put) ||
(status_code === 204 && (http_method === :delete || http_method === :post || http_method === :get))
polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
error_data = CloudErrorData.new
error_data.code = polling_state.status
error_data.message = "Long running operation failed with status #{polling_state.status}"
polling_state.error_data = error_data
polling_state.resource = result.body
elsif final_state_via == FinalStateVia::LOCATION && status_code === 404 && http_method === :delete && !polling_state.azure_async_operation_header_link.nil? && !polling_state.location_header_link.nil?
polling_state.status = AsyncOperationStatus::SUCCESS_STATUS
else
fail AzureOperationError, "The response from long running operation does not have a valid status code. Method: #{http_method}, Status Code: #{status_code}"
end
end
|
[
"def",
"update_state_from_location_header",
"(",
"request",
",",
"polling_state",
",",
"custom_deserialization_block",
",",
"final_state_via",
"=",
"FinalStateVia",
"::",
"DEFAULT",
")",
"result",
"=",
"get_async_with_custom_deserialization",
"(",
"request",
",",
"custom_deserialization_block",
")",
"polling_state",
".",
"update_response",
"(",
"result",
".",
"response",
")",
"polling_state",
".",
"request",
"=",
"result",
".",
"request",
"status_code",
"=",
"result",
".",
"response",
".",
"status",
"http_method",
"=",
"request",
".",
"method",
"if",
"status_code",
"===",
"202",
"polling_state",
".",
"status",
"=",
"AsyncOperationStatus",
"::",
"IN_PROGRESS_STATUS",
"elsif",
"status_code",
"===",
"200",
"||",
"(",
"status_code",
"===",
"201",
"&&",
"http_method",
"===",
":put",
")",
"||",
"(",
"status_code",
"===",
"204",
"&&",
"(",
"http_method",
"===",
":delete",
"||",
"http_method",
"===",
":post",
"||",
"http_method",
"===",
":get",
")",
")",
"polling_state",
".",
"status",
"=",
"AsyncOperationStatus",
"::",
"SUCCESS_STATUS",
"error_data",
"=",
"CloudErrorData",
".",
"new",
"error_data",
".",
"code",
"=",
"polling_state",
".",
"status",
"error_data",
".",
"message",
"=",
"\"Long running operation failed with status #{polling_state.status}\"",
"polling_state",
".",
"error_data",
"=",
"error_data",
"polling_state",
".",
"resource",
"=",
"result",
".",
"body",
"elsif",
"final_state_via",
"==",
"FinalStateVia",
"::",
"LOCATION",
"&&",
"status_code",
"===",
"404",
"&&",
"http_method",
"===",
":delete",
"&&",
"!",
"polling_state",
".",
"azure_async_operation_header_link",
".",
"nil?",
"&&",
"!",
"polling_state",
".",
"location_header_link",
".",
"nil?",
"polling_state",
".",
"status",
"=",
"AsyncOperationStatus",
"::",
"SUCCESS_STATUS",
"else",
"fail",
"AzureOperationError",
",",
"\"The response from long running operation does not have a valid status code. Method: #{http_method}, Status Code: #{status_code}\"",
"end",
"end"
] |
Updates polling state based on location header for HTTP requests.
@param request [MsRest::HttpOperationRequest] The url retrieve data from.
@param polling_state [MsRestAzure::PollingState] polling state to update.
@param custom_deserialization_block [Proc] custom deserialization method for parsing response.
@param final_state_via [MsRestAzure::FinalStateVia] Final State via value
|
[
"Updates",
"polling",
"state",
"based",
"on",
"location",
"header",
"for",
"HTTP",
"requests",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/runtime/ms_rest_azure/lib/ms_rest_azure/azure_service_client.rb#L173-L198
|
13,286
|
Azure/azure-sdk-for-ruby
|
runtime/ms_rest_azure/lib/ms_rest_azure/azure_service_client.rb
|
MsRestAzure.AzureServiceClient.update_state_from_azure_async_operation_header
|
def update_state_from_azure_async_operation_header(request, polling_state)
result = get_async_with_async_operation_deserialization(request)
fail AzureOperationError, 'The response from long running operation does not contain a body' if result.body.nil? || result.body.status.nil?
polling_state.status = result.body.status
polling_state.error_data = result.body.error
polling_state.response = result.response
polling_state.request = result.request
polling_state.resource = nil
polling_state
end
|
ruby
|
def update_state_from_azure_async_operation_header(request, polling_state)
result = get_async_with_async_operation_deserialization(request)
fail AzureOperationError, 'The response from long running operation does not contain a body' if result.body.nil? || result.body.status.nil?
polling_state.status = result.body.status
polling_state.error_data = result.body.error
polling_state.response = result.response
polling_state.request = result.request
polling_state.resource = nil
polling_state
end
|
[
"def",
"update_state_from_azure_async_operation_header",
"(",
"request",
",",
"polling_state",
")",
"result",
"=",
"get_async_with_async_operation_deserialization",
"(",
"request",
")",
"fail",
"AzureOperationError",
",",
"'The response from long running operation does not contain a body'",
"if",
"result",
".",
"body",
".",
"nil?",
"||",
"result",
".",
"body",
".",
"status",
".",
"nil?",
"polling_state",
".",
"status",
"=",
"result",
".",
"body",
".",
"status",
"polling_state",
".",
"error_data",
"=",
"result",
".",
"body",
".",
"error",
"polling_state",
".",
"response",
"=",
"result",
".",
"response",
"polling_state",
".",
"request",
"=",
"result",
".",
"request",
"polling_state",
".",
"resource",
"=",
"nil",
"polling_state",
"end"
] |
Updates polling state from Azure async operation header.
@param polling_state [MsRestAzure::PollingState] polling state.
|
[
"Updates",
"polling",
"state",
"from",
"Azure",
"async",
"operation",
"header",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/runtime/ms_rest_azure/lib/ms_rest_azure/azure_service_client.rb#L204-L216
|
13,287
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_recovery_services_site_recovery/lib/2016-08-10/generated/azure_mgmt_recovery_services_site_recovery/replication_alert_settings.rb
|
Azure::RecoveryServicesSiteRecovery::Mgmt::V2016_08_10.ReplicationAlertSettings.create
|
def create(alert_setting_name, request, custom_headers:nil)
response = create_async(alert_setting_name, request, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
ruby
|
def create(alert_setting_name, request, custom_headers:nil)
response = create_async(alert_setting_name, request, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
[
"def",
"create",
"(",
"alert_setting_name",
",",
"request",
",",
"custom_headers",
":",
"nil",
")",
"response",
"=",
"create_async",
"(",
"alert_setting_name",
",",
"request",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"response",
".",
"body",
"unless",
"response",
".",
"nil?",
"end"
] |
Configures email notifications for this vault.
Create or update an email notification(alert) configuration.
@param alert_setting_name [String] The name of the email notification(alert)
configuration.
@param request [ConfigureAlertRequest] The input to configure the email
notification(alert).
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [Alert] operation results.
|
[
"Configures",
"email",
"notifications",
"for",
"this",
"vault",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_recovery_services_site_recovery/lib/2016-08-10/generated/azure_mgmt_recovery_services_site_recovery/replication_alert_settings.rb#L137-L140
|
13,288
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_privatedns/lib/2018-09-01/generated/azure_mgmt_privatedns/record_sets.rb
|
Azure::PrivateDns::Mgmt::V2018_09_01.RecordSets.create_or_update_with_http_info
|
def create_or_update_with_http_info(resource_group_name, private_zone_name, record_type, relative_record_set_name, parameters, if_match:nil, if_none_match:nil, custom_headers:nil)
create_or_update_async(resource_group_name, private_zone_name, record_type, relative_record_set_name, parameters, if_match:if_match, if_none_match:if_none_match, custom_headers:custom_headers).value!
end
|
ruby
|
def create_or_update_with_http_info(resource_group_name, private_zone_name, record_type, relative_record_set_name, parameters, if_match:nil, if_none_match:nil, custom_headers:nil)
create_or_update_async(resource_group_name, private_zone_name, record_type, relative_record_set_name, parameters, if_match:if_match, if_none_match:if_none_match, custom_headers:custom_headers).value!
end
|
[
"def",
"create_or_update_with_http_info",
"(",
"resource_group_name",
",",
"private_zone_name",
",",
"record_type",
",",
"relative_record_set_name",
",",
"parameters",
",",
"if_match",
":",
"nil",
",",
"if_none_match",
":",
"nil",
",",
"custom_headers",
":",
"nil",
")",
"create_or_update_async",
"(",
"resource_group_name",
",",
"private_zone_name",
",",
"record_type",
",",
"relative_record_set_name",
",",
"parameters",
",",
"if_match",
":if_match",
",",
"if_none_match",
":if_none_match",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"end"
] |
Creates or updates a record set within a Private DNS zone.
@param resource_group_name [String] The name of the resource group.
@param private_zone_name [String] The name of the Private DNS zone (without a
terminating dot).
@param record_type [RecordType] The type of DNS record in this record set.
Record sets of type SOA can be updated but not created (they are created when
the Private DNS zone is created). Possible values include: 'A', 'AAAA',
'CNAME', 'MX', 'PTR', 'SOA', 'SRV', 'TXT'
@param relative_record_set_name [String] The name of the record set, relative
to the name of the zone.
@param parameters [RecordSet] Parameters supplied to the CreateOrUpdate
operation.
@param if_match [String] The ETag of the record set. Omit this value to
always overwrite the current record set. Specify the last-seen ETag value to
prevent accidentally overwriting any concurrent changes.
@param if_none_match [String] Set to '*' to allow a new record set to be
created, but to prevent updating an existing record set. Other values will be
ignored.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
|
[
"Creates",
"or",
"updates",
"a",
"record",
"set",
"within",
"a",
"Private",
"DNS",
"zone",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_privatedns/lib/2018-09-01/generated/azure_mgmt_privatedns/record_sets.rb#L79-L81
|
13,289
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_privatedns/lib/2018-09-01/generated/azure_mgmt_privatedns/record_sets.rb
|
Azure::PrivateDns::Mgmt::V2018_09_01.RecordSets.list_with_http_info
|
def list_with_http_info(resource_group_name, private_zone_name, top:nil, recordsetnamesuffix:nil, custom_headers:nil)
list_async(resource_group_name, private_zone_name, top:top, recordsetnamesuffix:recordsetnamesuffix, custom_headers:custom_headers).value!
end
|
ruby
|
def list_with_http_info(resource_group_name, private_zone_name, top:nil, recordsetnamesuffix:nil, custom_headers:nil)
list_async(resource_group_name, private_zone_name, top:top, recordsetnamesuffix:recordsetnamesuffix, custom_headers:custom_headers).value!
end
|
[
"def",
"list_with_http_info",
"(",
"resource_group_name",
",",
"private_zone_name",
",",
"top",
":",
"nil",
",",
"recordsetnamesuffix",
":",
"nil",
",",
"custom_headers",
":",
"nil",
")",
"list_async",
"(",
"resource_group_name",
",",
"private_zone_name",
",",
"top",
":",
"top",
",",
"recordsetnamesuffix",
":",
"recordsetnamesuffix",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"end"
] |
Lists all record sets in a Private DNS zone.
@param resource_group_name [String] The name of the resource group.
@param private_zone_name [String] The name of the Private DNS zone (without a
terminating dot).
@param top [Integer] The maximum number of record sets to return. If not
specified, returns up to 100 record sets.
@param recordsetnamesuffix [String] The suffix label of the record set name
to be used to filter the record set enumeration. If this parameter is
specified, the returned enumeration will only contain records that end with
".<recordsetnamesuffix>".
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
|
[
"Lists",
"all",
"record",
"sets",
"in",
"a",
"Private",
"DNS",
"zone",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_privatedns/lib/2018-09-01/generated/azure_mgmt_privatedns/record_sets.rb#L711-L713
|
13,290
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_postgresql/lib/2017-12-01-preview/generated/azure_mgmt_postgresql/configurations.rb
|
Azure::Postgresql::Mgmt::V2017_12_01_preview.Configurations.get_with_http_info
|
def get_with_http_info(resource_group_name, server_name, configuration_name, custom_headers:nil)
get_async(resource_group_name, server_name, configuration_name, custom_headers:custom_headers).value!
end
|
ruby
|
def get_with_http_info(resource_group_name, server_name, configuration_name, custom_headers:nil)
get_async(resource_group_name, server_name, configuration_name, custom_headers:custom_headers).value!
end
|
[
"def",
"get_with_http_info",
"(",
"resource_group_name",
",",
"server_name",
",",
"configuration_name",
",",
"custom_headers",
":",
"nil",
")",
"get_async",
"(",
"resource_group_name",
",",
"server_name",
",",
"configuration_name",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"end"
] |
Gets information about a configuration of server.
@param resource_group_name [String] The name of the resource group that
contains the resource. You can obtain this value from the Azure Resource
Manager API or the portal.
@param server_name [String] The name of the server.
@param configuration_name [String] The name of the server configuration.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
|
[
"Gets",
"information",
"about",
"a",
"configuration",
"of",
"server",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_postgresql/lib/2017-12-01-preview/generated/azure_mgmt_postgresql/configurations.rb#L110-L112
|
13,291
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_storagesync/lib/2018-07-01/generated/azure_mgmt_storagesync/server_endpoints.rb
|
Azure::StorageSync::Mgmt::V2018_07_01.ServerEndpoints.get_with_http_info
|
def get_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers:nil)
get_async(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers:custom_headers).value!
end
|
ruby
|
def get_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers:nil)
get_async(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers:custom_headers).value!
end
|
[
"def",
"get_with_http_info",
"(",
"resource_group_name",
",",
"storage_sync_service_name",
",",
"sync_group_name",
",",
"server_endpoint_name",
",",
"custom_headers",
":",
"nil",
")",
"get_async",
"(",
"resource_group_name",
",",
"storage_sync_service_name",
",",
"sync_group_name",
",",
"server_endpoint_name",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"end"
] |
Get a ServerEndpoint.
@param resource_group_name [String] The name of the resource group. The name
is case insensitive.
@param storage_sync_service_name [String] Name of Storage Sync Service
resource.
@param sync_group_name [String] Name of Sync Group resource.
@param server_endpoint_name [String] Name of Server Endpoint object.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
|
[
"Get",
"a",
"ServerEndpoint",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_storagesync/lib/2018-07-01/generated/azure_mgmt_storagesync/server_endpoints.rb#L165-L167
|
13,292
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_storagesync/lib/2018-07-01/generated/azure_mgmt_storagesync/server_endpoints.rb
|
Azure::StorageSync::Mgmt::V2018_07_01.ServerEndpoints.begin_delete_with_http_info
|
def begin_delete_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers:nil)
begin_delete_async(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers:custom_headers).value!
end
|
ruby
|
def begin_delete_with_http_info(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers:nil)
begin_delete_async(resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, custom_headers:custom_headers).value!
end
|
[
"def",
"begin_delete_with_http_info",
"(",
"resource_group_name",
",",
"storage_sync_service_name",
",",
"sync_group_name",
",",
"server_endpoint_name",
",",
"custom_headers",
":",
"nil",
")",
"begin_delete_async",
"(",
"resource_group_name",
",",
"storage_sync_service_name",
",",
"sync_group_name",
",",
"server_endpoint_name",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"end"
] |
Delete a given ServerEndpoint.
@param resource_group_name [String] The name of the resource group. The name
is case insensitive.
@param storage_sync_service_name [String] Name of Storage Sync Service
resource.
@param sync_group_name [String] Name of Sync Group resource.
@param server_endpoint_name [String] Name of Server Endpoint object.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
|
[
"Delete",
"a",
"given",
"ServerEndpoint",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_storagesync/lib/2018-07-01/generated/azure_mgmt_storagesync/server_endpoints.rb#L725-L727
|
13,293
|
Azure/azure-sdk-for-ruby
|
data/azure_cognitiveservices_computervision/lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb
|
Azure::CognitiveServices::ComputerVision::V2_0.ComputerVisionClient.make_request_with_http_info
|
def make_request_with_http_info(method, path, options = {})
result = make_request_async(method, path, options).value!
result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
result
end
|
ruby
|
def make_request_with_http_info(method, path, options = {})
result = make_request_async(method, path, options).value!
result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
result
end
|
[
"def",
"make_request_with_http_info",
"(",
"method",
",",
"path",
",",
"options",
"=",
"{",
"}",
")",
"result",
"=",
"make_request_async",
"(",
"method",
",",
"path",
",",
"options",
")",
".",
"value!",
"result",
".",
"body",
"=",
"result",
".",
"response",
".",
"body",
".",
"to_s",
".",
"empty?",
"?",
"nil",
":",
"JSON",
".",
"load",
"(",
"result",
".",
"response",
".",
"body",
")",
"result",
"end"
] |
Makes a request and returns the operation response.
@param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
@param path [String] the path, relative to {base_url}.
@param options [Hash{String=>String}] specifying any request options like :body.
@return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.
|
[
"Makes",
"a",
"request",
"and",
"returns",
"the",
"operation",
"response",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/data/azure_cognitiveservices_computervision/lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb#L85-L89
|
13,294
|
Azure/azure-sdk-for-ruby
|
data/azure_cognitiveservices_computervision/lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb
|
Azure::CognitiveServices::ComputerVision::V2_0.ComputerVisionClient.make_request_async
|
def make_request_async(method, path, options = {})
fail ArgumentError, 'method is nil' if method.nil?
fail ArgumentError, 'path is nil' if path.nil?
request_url = options[:base_url] || @base_url
if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
@request_headers['Content-Type'] = options[:headers]['Content-Type']
end
request_headers = @request_headers
request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
options.merge!({headers: request_headers.merge(options[:headers] || {})})
options.merge!({credentials: @credentials}) unless @credentials.nil?
super(request_url, method, path, options)
end
|
ruby
|
def make_request_async(method, path, options = {})
fail ArgumentError, 'method is nil' if method.nil?
fail ArgumentError, 'path is nil' if path.nil?
request_url = options[:base_url] || @base_url
if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
@request_headers['Content-Type'] = options[:headers]['Content-Type']
end
request_headers = @request_headers
request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
options.merge!({headers: request_headers.merge(options[:headers] || {})})
options.merge!({credentials: @credentials}) unless @credentials.nil?
super(request_url, method, path, options)
end
|
[
"def",
"make_request_async",
"(",
"method",
",",
"path",
",",
"options",
"=",
"{",
"}",
")",
"fail",
"ArgumentError",
",",
"'method is nil'",
"if",
"method",
".",
"nil?",
"fail",
"ArgumentError",
",",
"'path is nil'",
"if",
"path",
".",
"nil?",
"request_url",
"=",
"options",
"[",
":base_url",
"]",
"||",
"@base_url",
"if",
"(",
"!",
"options",
"[",
":headers",
"]",
".",
"nil?",
"&&",
"!",
"options",
"[",
":headers",
"]",
"[",
"'Content-Type'",
"]",
".",
"nil?",
")",
"@request_headers",
"[",
"'Content-Type'",
"]",
"=",
"options",
"[",
":headers",
"]",
"[",
"'Content-Type'",
"]",
"end",
"request_headers",
"=",
"@request_headers",
"request_headers",
".",
"merge!",
"(",
"{",
"'accept-language'",
"=>",
"@accept_language",
"}",
")",
"unless",
"@accept_language",
".",
"nil?",
"options",
".",
"merge!",
"(",
"{",
"headers",
":",
"request_headers",
".",
"merge",
"(",
"options",
"[",
":headers",
"]",
"||",
"{",
"}",
")",
"}",
")",
"options",
".",
"merge!",
"(",
"{",
"credentials",
":",
"@credentials",
"}",
")",
"unless",
"@credentials",
".",
"nil?",
"super",
"(",
"request_url",
",",
"method",
",",
"path",
",",
"options",
")",
"end"
] |
Makes a request asynchronously.
@param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
@param path [String] the path, relative to {base_url}.
@param options [Hash{String=>String}] specifying any request options like :body.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
|
[
"Makes",
"a",
"request",
"asynchronously",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/data/azure_cognitiveservices_computervision/lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb#L98-L113
|
13,295
|
Azure/azure-sdk-for-ruby
|
data/azure_cognitiveservices_computervision/lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb
|
Azure::CognitiveServices::ComputerVision::V2_0.ComputerVisionClient.get_text_operation_result
|
def get_text_operation_result(operation_id, custom_headers:nil)
response = get_text_operation_result_async(operation_id, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
ruby
|
def get_text_operation_result(operation_id, custom_headers:nil)
response = get_text_operation_result_async(operation_id, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
[
"def",
"get_text_operation_result",
"(",
"operation_id",
",",
"custom_headers",
":",
"nil",
")",
"response",
"=",
"get_text_operation_result_async",
"(",
"operation_id",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"response",
".",
"body",
"unless",
"response",
".",
"nil?",
"end"
] |
This interface is used for getting text operation result. The URL to this
interface should be retrieved from 'Operation-Location' field returned from
Recognize Text interface.
@param operation_id [String] Id of the text operation returned in the
response of the 'Recognize Text'
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [TextOperationResult] operation results.
|
[
"This",
"interface",
"is",
"used",
"for",
"getting",
"text",
"operation",
"result",
".",
"The",
"URL",
"to",
"this",
"interface",
"should",
"be",
"retrieved",
"from",
"Operation",
"-",
"Location",
"field",
"returned",
"from",
"Recognize",
"Text",
"interface",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/data/azure_cognitiveservices_computervision/lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb#L1491-L1494
|
13,296
|
Azure/azure-sdk-for-ruby
|
data/azure_cognitiveservices_computervision/lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb
|
Azure::CognitiveServices::ComputerVision::V2_0.ComputerVisionClient.get_read_operation_result
|
def get_read_operation_result(operation_id, custom_headers:nil)
response = get_read_operation_result_async(operation_id, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
ruby
|
def get_read_operation_result(operation_id, custom_headers:nil)
response = get_read_operation_result_async(operation_id, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
[
"def",
"get_read_operation_result",
"(",
"operation_id",
",",
"custom_headers",
":",
"nil",
")",
"response",
"=",
"get_read_operation_result_async",
"(",
"operation_id",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"response",
".",
"body",
"unless",
"response",
".",
"nil?",
"end"
] |
This interface is used for getting OCR results of Read operation. The URL to
this interface should be retrieved from "Operation-Location" field returned
from Batch Read File interface.
@param operation_id [String] Id of read operation returned in the response of
the "Batch Read File" interface.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [ReadOperationResult] operation results.
|
[
"This",
"interface",
"is",
"used",
"for",
"getting",
"OCR",
"results",
"of",
"Read",
"operation",
".",
"The",
"URL",
"to",
"this",
"interface",
"should",
"be",
"retrieved",
"from",
"Operation",
"-",
"Location",
"field",
"returned",
"from",
"Batch",
"Read",
"File",
"interface",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/data/azure_cognitiveservices_computervision/lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb#L1696-L1699
|
13,297
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_redis/lib/2017-02-01/generated/azure_mgmt_redis/redis.rb
|
Azure::Redis::Mgmt::V2017_02_01.Redis.update_with_http_info
|
def update_with_http_info(resource_group_name, name, parameters, custom_headers:nil)
update_async(resource_group_name, name, parameters, custom_headers:custom_headers).value!
end
|
ruby
|
def update_with_http_info(resource_group_name, name, parameters, custom_headers:nil)
update_async(resource_group_name, name, parameters, custom_headers:custom_headers).value!
end
|
[
"def",
"update_with_http_info",
"(",
"resource_group_name",
",",
"name",
",",
"parameters",
",",
"custom_headers",
":",
"nil",
")",
"update_async",
"(",
"resource_group_name",
",",
"name",
",",
"parameters",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"end"
] |
Update an existing Redis cache.
@param resource_group_name [String] The name of the resource group.
@param name [String] The name of the Redis cache.
@param parameters [RedisUpdateParameters] Parameters supplied to the Update
Redis operation.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
|
[
"Update",
"an",
"existing",
"Redis",
"cache",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_redis/lib/2017-02-01/generated/azure_mgmt_redis/redis.rb#L100-L102
|
13,298
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_redis/lib/2017-02-01/generated/azure_mgmt_redis/redis.rb
|
Azure::Redis::Mgmt::V2017_02_01.Redis.list_keys
|
def list_keys(resource_group_name, name, custom_headers:nil)
response = list_keys_async(resource_group_name, name, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
ruby
|
def list_keys(resource_group_name, name, custom_headers:nil)
response = list_keys_async(resource_group_name, name, custom_headers:custom_headers).value!
response.body unless response.nil?
end
|
[
"def",
"list_keys",
"(",
"resource_group_name",
",",
"name",
",",
"custom_headers",
":",
"nil",
")",
"response",
"=",
"list_keys_async",
"(",
"resource_group_name",
",",
"name",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"response",
".",
"body",
"unless",
"response",
".",
"nil?",
"end"
] |
Retrieve a Redis cache's access keys. This operation requires write
permission to the cache resource.
@param resource_group_name [String] The name of the resource group.
@param name [String] The name of the Redis cache.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [RedisAccessKeys] operation results.
|
[
"Retrieve",
"a",
"Redis",
"cache",
"s",
"access",
"keys",
".",
"This",
"operation",
"requires",
"write",
"permission",
"to",
"the",
"cache",
"resource",
"."
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_redis/lib/2017-02-01/generated/azure_mgmt_redis/redis.rb#L490-L493
|
13,299
|
Azure/azure-sdk-for-ruby
|
management/azure_mgmt_redis/lib/2017-02-01/generated/azure_mgmt_redis/firewall_rules.rb
|
Azure::Redis::Mgmt::V2017_02_01.FirewallRules.create_or_update_with_http_info
|
def create_or_update_with_http_info(resource_group_name, cache_name, rule_name, parameters, custom_headers:nil)
create_or_update_async(resource_group_name, cache_name, rule_name, parameters, custom_headers:custom_headers).value!
end
|
ruby
|
def create_or_update_with_http_info(resource_group_name, cache_name, rule_name, parameters, custom_headers:nil)
create_or_update_async(resource_group_name, cache_name, rule_name, parameters, custom_headers:custom_headers).value!
end
|
[
"def",
"create_or_update_with_http_info",
"(",
"resource_group_name",
",",
"cache_name",
",",
"rule_name",
",",
"parameters",
",",
"custom_headers",
":",
"nil",
")",
"create_or_update_async",
"(",
"resource_group_name",
",",
"cache_name",
",",
"rule_name",
",",
"parameters",
",",
"custom_headers",
":custom_headers",
")",
".",
"value!",
"end"
] |
Create or update a redis cache firewall rule
@param resource_group_name [String] The name of the resource group.
@param cache_name [String] The name of the Redis cache.
@param rule_name [String] The name of the firewall rule.
@param parameters [RedisFirewallRule] Parameters supplied to the create or
update redis firewall rule operation.
@param custom_headers [Hash{String => String}] A hash of custom headers that
will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
|
[
"Create",
"or",
"update",
"a",
"redis",
"cache",
"firewall",
"rule"
] |
78eedacf8f8cbd65c2d8a2af421405eaa4373d8e
|
https://github.com/Azure/azure-sdk-for-ruby/blob/78eedacf8f8cbd65c2d8a2af421405eaa4373d8e/management/azure_mgmt_redis/lib/2017-02-01/generated/azure_mgmt_redis/firewall_rules.rb#L147-L149
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.