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
|
|---|---|---|---|---|---|---|---|---|---|---|---|
21,000
|
ruby-x/rubyx
|
lib/ruby/ruby_compiler.rb
|
Ruby.RubyCompiler.on_array
|
def on_array expression
ArrayStatement.new expression.children.collect{ |elem| process(elem) }
end
|
ruby
|
def on_array expression
ArrayStatement.new expression.children.collect{ |elem| process(elem) }
end
|
[
"def",
"on_array",
"expression",
"ArrayStatement",
".",
"new",
"expression",
".",
"children",
".",
"collect",
"{",
"|",
"elem",
"|",
"process",
"(",
"elem",
")",
"}",
"end"
] |
Array + Hashes
|
[
"Array",
"+",
"Hashes"
] |
1391667f6cf16c8e132cbf85cc6a5171fb8c444e
|
https://github.com/ruby-x/rubyx/blob/1391667f6cf16c8e132cbf85cc6a5171fb8c444e/lib/ruby/ruby_compiler.rb#L143-L145
|
21,001
|
ruby-x/rubyx
|
lib/ruby/ruby_compiler.rb
|
Ruby.RubyCompiler.on_super
|
def on_super( statement )
arguments = process_all(statement.children)
SendStatement.new( nil , SuperExpression.new , arguments)
end
|
ruby
|
def on_super( statement )
arguments = process_all(statement.children)
SendStatement.new( nil , SuperExpression.new , arguments)
end
|
[
"def",
"on_super",
"(",
"statement",
")",
"arguments",
"=",
"process_all",
"(",
"statement",
".",
"children",
")",
"SendStatement",
".",
"new",
"(",
"nil",
",",
"SuperExpression",
".",
"new",
",",
"arguments",
")",
"end"
] |
this is a call to super with args and
same name as current method, which is set later
|
[
"this",
"is",
"a",
"call",
"to",
"super",
"with",
"args",
"and",
"same",
"name",
"as",
"current",
"method",
"which",
"is",
"set",
"later"
] |
1391667f6cf16c8e132cbf85cc6a5171fb8c444e
|
https://github.com/ruby-x/rubyx/blob/1391667f6cf16c8e132cbf85cc6a5171fb8c444e/lib/ruby/ruby_compiler.rb#L240-L243
|
21,002
|
ruby-x/rubyx
|
lib/parfait/behaviour.rb
|
Parfait.Behaviour.resolve_method
|
def resolve_method( m_name )
raise "resolve_method #{m_name}.#{m_name.class}" unless m_name.is_a?(Symbol)
method = get_instance_method(m_name)
return method if method
if( super_class_name && super_class_name != :Object )
method = self.super_class.resolve_method(m_name)
end
method
end
|
ruby
|
def resolve_method( m_name )
raise "resolve_method #{m_name}.#{m_name.class}" unless m_name.is_a?(Symbol)
method = get_instance_method(m_name)
return method if method
if( super_class_name && super_class_name != :Object )
method = self.super_class.resolve_method(m_name)
end
method
end
|
[
"def",
"resolve_method",
"(",
"m_name",
")",
"raise",
"\"resolve_method #{m_name}.#{m_name.class}\"",
"unless",
"m_name",
".",
"is_a?",
"(",
"Symbol",
")",
"method",
"=",
"get_instance_method",
"(",
"m_name",
")",
"return",
"method",
"if",
"method",
"if",
"(",
"super_class_name",
"&&",
"super_class_name",
"!=",
":Object",
")",
"method",
"=",
"self",
".",
"super_class",
".",
"resolve_method",
"(",
"m_name",
")",
"end",
"method",
"end"
] |
get the method and if not found, try superclasses. raise error if not found
|
[
"get",
"the",
"method",
"and",
"if",
"not",
"found",
"try",
"superclasses",
".",
"raise",
"error",
"if",
"not",
"found"
] |
1391667f6cf16c8e132cbf85cc6a5171fb8c444e
|
https://github.com/ruby-x/rubyx/blob/1391667f6cf16c8e132cbf85cc6a5171fb8c444e/lib/parfait/behaviour.rb#L44-L52
|
21,003
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_albums
|
def create_albums(data=nil,generate_objects=false)
uri = URI.parse(@uri + '/Albums')
post(uri,data,generate_objects)
end
|
ruby
|
def create_albums(data=nil,generate_objects=false)
uri = URI.parse(@uri + '/Albums')
post(uri,data,generate_objects)
end
|
[
"def",
"create_albums",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"'/Albums'",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create Albums.
@param data [Single Albums Object, Array of Albums Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns an Albums objects array if generate_objects flag is set
@example
rest_client.create_albums(albums_obj)
rest_client.create_albums(albums_obj_array)
rest_client.create_albums(albums_obj,true)
rest_client.create_albums(albums_obj_array,true)
|
[
"Create",
"Albums",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L283-L286
|
21,004
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_albums
|
def update_albums(data=nil,generate_objects=false)
uri = URI.parse(@uri + '/Albums')
put(uri,data,generate_objects)
end
|
ruby
|
def update_albums(data=nil,generate_objects=false)
uri = URI.parse(@uri + '/Albums')
put(uri,data,generate_objects)
end
|
[
"def",
"update_albums",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"'/Albums'",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify Albums.
@param data [Single Albums Object, Array of Albums Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns an Albums objects array if generate_objects flag is set
@example
rest_client.update_albums(albums_obj)
rest_client.update_albums(albums_obj,true)
rest_client.update_albums(albums_obj_array)
rest_client.update_albums(albums_obj_array,true)
|
[
"Modify",
"Albums",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L301-L304
|
21,005
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_categories
|
def update_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Categories")
put(uri,data,generate_objects)
end
|
ruby
|
def update_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Categories")
put(uri,data,generate_objects)
end
|
[
"def",
"update_categories",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Categories\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify system Categories.
@param data [Single Categories Object, Array of Categories Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns a Categories objects array if generate_objects flag is set
@example
rest_client.update_categories(categories_obj)
rest_client.update_categories(categories_obj,true)
rest_client.update_categories(categories_obj_array)
rest_client.update_categories(categories_obj_array,true)
|
[
"Modify",
"system",
"Categories",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L423-L426
|
21,006
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_copyright_holders
|
def create_copyright_holders(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/CopyrightHolders")
post(uri,data,generate_objects)
end
|
ruby
|
def create_copyright_holders(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/CopyrightHolders")
post(uri,data,generate_objects)
end
|
[
"def",
"create_copyright_holders",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/CopyrightHolders\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create CopyrightHoloders.
@param data [Single CopyrightPolicies Object, Array of CopyrightPolicies Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns a CopyrightHolders objects array if generate_objects flag is set
@example
rest_client.create_copyright_holders(copyright_holders_obj)
rest_client.create_copyright_holders(copyright_holders_obj_array)
rest_client.create_copyright_holders(copyright_holders_obj,true)
rest_client.create_copyright_holders(copyright_holders_obj_array,true)
|
[
"Create",
"CopyrightHoloders",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L465-L468
|
21,007
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_copyright_holders
|
def update_copyright_holders(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/CopyrightHolders")
put(uri,data,generate_objects)
end
|
ruby
|
def update_copyright_holders(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/CopyrightHolders")
put(uri,data,generate_objects)
end
|
[
"def",
"update_copyright_holders",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/CopyrightHolders\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify CopyrightHolders.
@param data [Single CopyrightHolders Object, Array of CopyrightHoloders Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns a CopyrightHolders objects array if generate_objects flag is set
@example
rest_client.update_copyright_holders(copyright_holders_obj)
rest_client.update_copyright_holders(copyright_holders_obj,true)
rest_client.update_copyright_holders(copyright_holders_obj_array)
rest_client.update_copyright_holders(copyright_holders_obj_array,true)
|
[
"Modify",
"CopyrightHolders",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L483-L486
|
21,008
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_copyright_policies
|
def create_copyright_policies(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/CopyrightPolicies")
post(uri,data,generate_objects)
end
|
ruby
|
def create_copyright_policies(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/CopyrightPolicies")
post(uri,data,generate_objects)
end
|
[
"def",
"create_copyright_policies",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/CopyrightPolicies\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create CopyrightPolicies.
@param data [Single CopyrightPolicies Object, Array of CopyrightPolicies Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns a CopyrightPolicies objects array if generate_objects flag is set
@example
rest_client.create_copyright_policies(copyright_policies_obj)
rest_client.create_copyright_policies(copyright_policies_obj_array)
rest_client.create_copyright_policies(copyright_policies_obj,true)
rest_client.create_copyright_policies(copyright_policies_obj_array,true)
|
[
"Create",
"CopyrightPolicies",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L539-L542
|
21,009
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_copyright_policies
|
def update_copyright_policies(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/CopyrightPolicies")
put(uri,data,generate_objects)
end
|
ruby
|
def update_copyright_policies(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/CopyrightPolicies")
put(uri,data,generate_objects)
end
|
[
"def",
"update_copyright_policies",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/CopyrightPolicies\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify CopyrightPolicies.
@param data [Single CopyrightPolicies Object, Array of CopyrightPolicies Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns a CopyrightPolicies objects array if generate_objects flag is set
@example
rest_client.update_copyright_policies(copyright_policies_obj)
rest_client.update_copyright_policies(copyright_policies_obj,true)
rest_client.update_copyright_policies(copyright_policies_obj_array)
rest_client.update_copyright_policies(copyright_policies_obj_array,true)
|
[
"Modify",
"CopyrightPolicies",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L557-L560
|
21,010
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_fields
|
def create_fields(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Fields")
post(uri,data,generate_objects)
end
|
ruby
|
def create_fields(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Fields")
post(uri,data,generate_objects)
end
|
[
"def",
"create_fields",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Fields\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create fields.
@param data [Single Fields Object, Array of Fields Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns a Fields objects array if generate_objects flag is set
@example
rest_client.create_fields(fields_obj)
rest_client.create_fields(fields_obj_array)
rest_client.create_fields(fields_obj,true)
rest_client.create_fields(fields_obj_array,true)
|
[
"Create",
"fields",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L656-L659
|
21,011
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_fields
|
def update_fields(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Fields")
put(uri,data,generate_objects)
end
|
ruby
|
def update_fields(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Fields")
put(uri,data,generate_objects)
end
|
[
"def",
"update_fields",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Fields\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify fields.
@param data [Single Fields Object, Array of Fields Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns a Fields objects array if generate_objects flag is set
@example
rest_client.update_fields(fields_obj)
rest_client.update_fields(fields_obj,true)
rest_client.update_fields(fields_obj_array)
rest_client.update_fields(fields_obj_array,true)
|
[
"Modify",
"fields",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L674-L677
|
21,012
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.get_field_lookup_strings
|
def get_field_lookup_strings(field=nil,query_obj=nil,with_nested_resources=false,use_http_query=false)
id = Validator.validate_field_lookup_string_arg(field)
uri = URI.parse(@uri + "/Fields" + "/#{id}" + "/FieldLookupStrings")
handle_get_request(uri,query_obj,with_nested_resources,use_http_query)
end
|
ruby
|
def get_field_lookup_strings(field=nil,query_obj=nil,with_nested_resources=false,use_http_query=false)
id = Validator.validate_field_lookup_string_arg(field)
uri = URI.parse(@uri + "/Fields" + "/#{id}" + "/FieldLookupStrings")
handle_get_request(uri,query_obj,with_nested_resources,use_http_query)
end
|
[
"def",
"get_field_lookup_strings",
"(",
"field",
"=",
"nil",
",",
"query_obj",
"=",
"nil",
",",
"with_nested_resources",
"=",
"false",
",",
"use_http_query",
"=",
"false",
")",
"id",
"=",
"Validator",
".",
"validate_field_lookup_string_arg",
"(",
"field",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Fields\"",
"+",
"\"/#{id}\"",
"+",
"\"/FieldLookupStrings\"",
")",
"handle_get_request",
"(",
"uri",
",",
"query_obj",
",",
"with_nested_resources",
",",
"use_http_query",
")",
"end"
] |
FIELD LOOKUP STRINGS
Retrieves options for Fixed Suggestion, Suggestion, and Option field types.
@param field [Fields Object, Hash, String, Integer] Argument must specify the field id (Required)
@param query_obj[RestOptions Object] Takes a RestOptions object or a SQL WHERE clause (Optional)
@param with_nested_resources [Boolean] Returns any nested objects if applicable (Optional)
@param use_http_query [Boolean] Filtering done on the server when set - faster but less granular -> "or" operator not supported (Optional)
@return [Array] Array of FieldLookupStrings.
@example
rest_client.get_field_lookup_strings(27)
rest_client.get_field_lookup_strings(27,rest_options_object)
rest_client.get_field_lookup_strings(27,"where value = 'my value'",false,false)
rest_client.get_field_lookup_strings(27,"where value = 'my value'",false,true)
|
[
"FIELD",
"LOOKUP",
"STRINGS"
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L717-L722
|
21,013
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_field_lookup_strings
|
def create_field_lookup_strings(field=nil,data=nil,generate_objects=false)
id = Validator.validate_field_lookup_string_arg(field)
uri = URI.parse(@uri + "/Fields" + "/#{id}" + "/FieldLookupStrings")
post(uri,data,generate_objects)
end
|
ruby
|
def create_field_lookup_strings(field=nil,data=nil,generate_objects=false)
id = Validator.validate_field_lookup_string_arg(field)
uri = URI.parse(@uri + "/Fields" + "/#{id}" + "/FieldLookupStrings")
post(uri,data,generate_objects)
end
|
[
"def",
"create_field_lookup_strings",
"(",
"field",
"=",
"nil",
",",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"id",
"=",
"Validator",
".",
"validate_field_lookup_string_arg",
"(",
"field",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Fields\"",
"+",
"\"/#{id}\"",
"+",
"\"/FieldLookupStrings\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
creates options for Fixed Suggestion, Suggestion, and Option field types.
@param field [Fields Object, Hash, String, Integer] Argument must specify the field id (Required)
@param data [Single FieldLookupString Object, Array of FieldLookupString Objects]
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Array of FieldLookupStrings objects if generate_objects flag is set
@example
rest_client.create_field_lookup_strings(field_obj,field_lookup_strings_obj)
rest_client.create_field_lookup_strings(field_obj,field_lookup_strings_obj,true)
rest_client.create_field_lookup_strings(field_obj,field_lookup_strings_obj_array)
rest_client.create_field_lookup_strings(field_obj,field_lookup_strings_obj_array,true)
|
[
"creates",
"options",
"for",
"Fixed",
"Suggestion",
"Suggestion",
"and",
"Option",
"field",
"types",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L738-L743
|
21,014
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_field_lookup_strings
|
def update_field_lookup_strings(field=nil,data=nil,generate_objects=false)
id = Validator.validate_field_lookup_string_arg(field)
uri = URI.parse(@uri + "/Fields" + "/#{id}" + "/FieldLookupStrings")
put(uri,data,generate_objects)
end
|
ruby
|
def update_field_lookup_strings(field=nil,data=nil,generate_objects=false)
id = Validator.validate_field_lookup_string_arg(field)
uri = URI.parse(@uri + "/Fields" + "/#{id}" + "/FieldLookupStrings")
put(uri,data,generate_objects)
end
|
[
"def",
"update_field_lookup_strings",
"(",
"field",
"=",
"nil",
",",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"id",
"=",
"Validator",
".",
"validate_field_lookup_string_arg",
"(",
"field",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Fields\"",
"+",
"\"/#{id}\"",
"+",
"\"/FieldLookupStrings\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modifies options for Fixed Suggestion, Suggestion, and Option field types.
@param field [Fields Object, Hash, String, Integer] Argument must specify the field id (Required)
@param data [Single FieldLookupString Object, Array of FieldLookupString Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns Array of FieldLookupStrings objects if generate_objects flag is set
@example
rest_client.update_field_lookup_strings(field_obj,field_lookup_strings_obj)
rest_client.update_field_lookup_strings(field_obj,field_lookup_strings_obj,true)
rest_client.update_field_lookup_strings(field_obj,field_lookup_strings_obj_array)
rest_client.update_field_lookup_strings(field_obj,field_lookup_strings_obj_array,true)
|
[
"Modifies",
"options",
"for",
"Fixed",
"Suggestion",
"Suggestion",
"and",
"Option",
"field",
"types",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L759-L764
|
21,015
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.upload_file
|
def upload_file(file=nil,
category=nil,
project=nil,
generate_objects=false,
read_timeout=600,
low_priority_processing=false)
__upload_file(file,
category,
project,
generate_objects,
read_timeout,
low_priority_processing)
end
|
ruby
|
def upload_file(file=nil,
category=nil,
project=nil,
generate_objects=false,
read_timeout=600,
low_priority_processing=false)
__upload_file(file,
category,
project,
generate_objects,
read_timeout,
low_priority_processing)
end
|
[
"def",
"upload_file",
"(",
"file",
"=",
"nil",
",",
"category",
"=",
"nil",
",",
"project",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
",",
"read_timeout",
"=",
"600",
",",
"low_priority_processing",
"=",
"false",
")",
"__upload_file",
"(",
"file",
",",
"category",
",",
"project",
",",
"generate_objects",
",",
"read_timeout",
",",
"low_priority_processing",
")",
"end"
] |
Uploads a file to OpenAsset.
@param file [String] the path to the file being uploaded
@param category [Categories Object,String,Integer] containing Target Category ID in OpenAsset (Required)
@param project [Projects Object, String, Integer] Project ID in OpenAsset (Specified only when Category is project based)
@return [JSON Object] HTTP response JSON object. Returns Files objects array if generate_objects flag is set
FOR PROJECT UPLOADS
@example
rest_client.upload_file('/path/to/file', category_obj, project_obj)
rest_client.upload_file('/path/to/file','2','10')
rest_client.upload_file('/path/to/file', 2, 10)
rest_client.upload_file('/path/to/file', category_obj, project_obj, true)
rest_client.upload_file('/path/to/file','2','10', true)
rest_client.upload_file('/path/to/file', 2, 10, true)
FOR REFERENCE UPLOADS
@example
rest_client.upload_file('/path/to/file', category_obj)
rest_client.upload_file('/path/to/file','2')
rest_client.upload_file('/path/to/file', 2,)
rest_client.upload_file('/path/to/file', category_obj, nil, true)
rest_client.upload_file('/path/to/file','2', nil, true)
rest_client.upload_file('/path/to/file', 2, nil, true)
|
[
"Uploads",
"a",
"file",
"to",
"OpenAsset",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L840-L852
|
21,016
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.replace_file
|
def replace_file(original_file_object=nil,
replacement_file_path='',
retain_original_filename_in_oa=false,
generate_objects=false)
__replace_file(original_file_object,
replacement_file_path,
retain_original_filename_in_oa,
generate_objects)
end
|
ruby
|
def replace_file(original_file_object=nil,
replacement_file_path='',
retain_original_filename_in_oa=false,
generate_objects=false)
__replace_file(original_file_object,
replacement_file_path,
retain_original_filename_in_oa,
generate_objects)
end
|
[
"def",
"replace_file",
"(",
"original_file_object",
"=",
"nil",
",",
"replacement_file_path",
"=",
"''",
",",
"retain_original_filename_in_oa",
"=",
"false",
",",
"generate_objects",
"=",
"false",
")",
"__replace_file",
"(",
"original_file_object",
",",
"replacement_file_path",
",",
"retain_original_filename_in_oa",
",",
"generate_objects",
")",
"end"
] |
Replace a file in OpenAsset.
@param original_file_object [Single Files Object] (Required) File Object in OA
@param replacement_file_path [String] (Required)
@param retain_original_filename_in_oa [Boolean] (Optional, Default => false)
@param generate_objects [Boolean] Return an array of Files or JSON objects in response body (Optional, Default => false)
@return [JSON object or Files Object Array ]. Returns Files objects array if generate_objects flag is set
@example
rest_client.replace_file(file_obj,'C:\Users\root\Pictures\new_img.jpg')
rest_client.replace_file(file_obj,'C:\Users\root\Pictures\new_img.jpg',true,true)
rest_client.replace_file(file_obj,'C:\Users\root\Pictures\new_img.jpg',false,false)
rest_client.replace_file(file_obj,'C:\Users\root\Pictures\new_img.jpg',false,true)
rest_client.replace_file(file_obj,'C:\Users\root\Pictures\new_img.jpg',true,false)
|
[
"Replace",
"a",
"file",
"in",
"OpenAsset",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L868-L877
|
21,017
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.download_files
|
def download_files(files=nil,image_size='1',download_location='./Rest_Downloads')
# Put single files objects in an array for easy downloading with
# the Array class' DownloadHelper module
files = [files] unless files.is_a?(Array)
files.download(image_size,download_location)
end
|
ruby
|
def download_files(files=nil,image_size='1',download_location='./Rest_Downloads')
# Put single files objects in an array for easy downloading with
# the Array class' DownloadHelper module
files = [files] unless files.is_a?(Array)
files.download(image_size,download_location)
end
|
[
"def",
"download_files",
"(",
"files",
"=",
"nil",
",",
"image_size",
"=",
"'1'",
",",
"download_location",
"=",
"'./Rest_Downloads'",
")",
"# Put single files objects in an array for easy downloading with",
"# the Array class' DownloadHelper module",
"files",
"=",
"[",
"files",
"]",
"unless",
"files",
".",
"is_a?",
"(",
"Array",
")",
"files",
".",
"download",
"(",
"image_size",
",",
"download_location",
")",
"end"
] |
Download Files.
@param files [Single Files Object, Array of Files Objects] (Required)
@param image_size [Integer, String] (Accepts image size id or postfix string:
Defaults to '1' => original image size id)
@param download_location [String] (Default: Creates folder called Rest_Downloads in the current directory.)
@return [nil].
@example
rest_client.download_files(File_object)
rest_client.download_files(File_objects_array)
rest_client.download_files(File_object,'C:\Folder\Path\Specified')
rest_client.download_files(File_objects_array,'C:\Folder\Path\Specified')
|
[
"Download",
"Files",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L928-L934
|
21,018
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_files
|
def update_files(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Files")
put(uri,data,generate_objects)
end
|
ruby
|
def update_files(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Files")
put(uri,data,generate_objects)
end
|
[
"def",
"update_files",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Files\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Update Files.
@param data [Single Files Object, Array of Files Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns Files objects array if generate_objects flag is set
@example
rest_client.update_files(files_obj)
rest_client.update_files(files_obj,true)
rest_client.update_files(files_obj_array)
rest_client.update_files(files_obj_array,true)
|
[
"Update",
"Files",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L949-L952
|
21,019
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_groups
|
def create_groups(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Groups")
post(uri,data,generate_objects)
end
|
ruby
|
def create_groups(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Groups")
post(uri,data,generate_objects)
end
|
[
"def",
"create_groups",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Groups\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create Groups.
@param data [Single Groups Object, Array of Groups Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Groups objects array if generate_objects flag is set
@example
rest_client.create_groups(groups_obj)
rest_client.create_groups(groups_obj,true)
rest_client.create_groups(groups_obj_array)
rest_client.create_groups(groups_obj_array,true)
|
[
"Create",
"Groups",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1009-L1012
|
21,020
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_groups
|
def update_groups(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Groups")
put(uri,data,generate_objects)
end
|
ruby
|
def update_groups(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Groups")
put(uri,data,generate_objects)
end
|
[
"def",
"update_groups",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Groups\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Update Groups.
@param data [Single Groups Object, Array of Groups Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Groups objects array if generate_objects flag is set
@example
rest_client.update_groups(groups_obj)
rest_client.update_groups(groups_obj,true)
rest_client.update_groups(groups_obj_array)
rest_client.update_groups(groups_obj_array,true)
|
[
"Update",
"Groups",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1027-L1030
|
21,021
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_keywords
|
def create_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Keywords")
post(uri,data,generate_objects)
end
|
ruby
|
def create_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Keywords")
post(uri,data,generate_objects)
end
|
[
"def",
"create_keywords",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Keywords\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create new file Keywords in OpenAsset.
@param data [Single Keywords Object, Array of Keywords Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Keywords objects array if generate_objects flag is set
@example
rest_client.create_keywords(keywords_obj)
rest_client.create_keywords(keywords_obj_array)
rest_client.create_keywords(keywords_obj,true)
rest_client.create_keywords(keywords_obj_array,true)
|
[
"Create",
"new",
"file",
"Keywords",
"in",
"OpenAsset",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1087-L1090
|
21,022
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_keywords
|
def update_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Keywords")
put(uri,data,generate_objects)
end
|
ruby
|
def update_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Keywords")
put(uri,data,generate_objects)
end
|
[
"def",
"update_keywords",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Keywords\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify file Keywords.
@param data [Single Keywords Object, Array of Keywords Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns Keywords objects array if generate_objects flag is set
@example
rest_client.update_keywords(keywords_obj)
rest_client.update_keywords(keywords_obj,true)
rest_client.update_keywords(keywords_obj_array)
rest_client.update_keywords(keywords_obj_array,true)
|
[
"Modify",
"file",
"Keywords",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1105-L1108
|
21,023
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.merge_keywords
|
def merge_keywords(target,source)
uri = URI.parse(@uri + "/Keywords")
merge(uri,target,source)
end
|
ruby
|
def merge_keywords(target,source)
uri = URI.parse(@uri + "/Keywords")
merge(uri,target,source)
end
|
[
"def",
"merge_keywords",
"(",
"target",
",",
"source",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Keywords\"",
")",
"merge",
"(",
"uri",
",",
"target",
",",
"source",
")",
"end"
] |
Merge Keywords.
@param target [ Keywords Object, id ](Required)
@param source [ Array of Keywords objects or ids ](Required)
@return [JSON object] HTTP response JSON object.
@example
rest_client.merge_keywords(keywords_obj,keywords_obj_array)
rest_client.merge_keywords('1',['1','2','3'])
|
[
"Merge",
"Keywords",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1138-L1141
|
21,024
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_keyword_categories
|
def create_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/KeywordCategories")
post(uri,data,generate_objects)
end
|
ruby
|
def create_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/KeywordCategories")
post(uri,data,generate_objects)
end
|
[
"def",
"create_keyword_categories",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/KeywordCategories\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create file keyword categories.
@param data [Single KeywordCategories Object, Array of KeywordCategories Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns KeywordCategories objects array if generate_objects flag is set
@example
rest_client.create_keyword_categories(keyword_categories_obj)
rest_client.create_keyword_categories(keyword_categories_obj_array)
rest_client.create_keyword_categories(keyword_categories_obj,true)
rest_client.create_keyword_categories(keyword_categories_obj_array,true)
|
[
"Create",
"file",
"keyword",
"categories",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1179-L1182
|
21,025
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_keyword_categories
|
def update_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/KeywordCategories")
put(uri,data,generate_objects)
end
|
ruby
|
def update_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/KeywordCategories")
put(uri,data,generate_objects)
end
|
[
"def",
"update_keyword_categories",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/KeywordCategories\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify file keyword categories.
@param data [Single KeywordCategories Object, Array of KeywordCategories Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object.. Returns KeywordCategories objects array if generate_objects flag is set
@example
rest_client.update_keyword_categories(keyword_categories_obj)
rest_client.update_keyword_categories(keyword_categories_obj,true)
rest_client.update_keyword_categories(keyword_categories_obj_array)
rest_client.update_keyword_categories(keyword_categories_obj_array,true)
|
[
"Modify",
"file",
"keyword",
"categories",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1197-L1200
|
21,026
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.merge_keyword_categories
|
def merge_keyword_categories(target,source)
uri = URI.parse(@uri + "/KeywordCategories")
merge(uri,target,source)
end
|
ruby
|
def merge_keyword_categories(target,source)
uri = URI.parse(@uri + "/KeywordCategories")
merge(uri,target,source)
end
|
[
"def",
"merge_keyword_categories",
"(",
"target",
",",
"source",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/KeywordCategories\"",
")",
"merge",
"(",
"uri",
",",
"target",
",",
"source",
")",
"end"
] |
Merge Keyword Categories.
@param target [ Keyword Categories Object, id ](Required)
@param source [ Array of Keyword Categories objects or ids ](Required)
@return [JSON object] HTTP response JSON object.
@example
rest_client.merge_keyword_categories(keywords_categories_obj,keyword_categories_obj_array)
rest_client.merge_keyword_categories('1',['1','2','3'])
|
[
"Merge",
"Keyword",
"Categories",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1230-L1233
|
21,027
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_photographers
|
def create_photographers(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Photographers")
post(uri,data,generate_objects)
end
|
ruby
|
def create_photographers(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Photographers")
post(uri,data,generate_objects)
end
|
[
"def",
"create_photographers",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Photographers\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create Photographers.
@param data [Single Photographers Object, Array of Photographers Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Photographers objects array if generate_objects flag is set
@example
rest_client.create_photographers(photographers_obj)
rest_client.create_photographers(photographers_obj,true)
rest_client.create_photographers(photographers_obj_array)
rest_client.create_photographers(photographers_obj_array,true)
|
[
"Create",
"Photographers",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1271-L1274
|
21,028
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_photographers
|
def update_photographers(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Photographers")
put(uri,data,generate_objects)
end
|
ruby
|
def update_photographers(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Photographers")
put(uri,data,generate_objects)
end
|
[
"def",
"update_photographers",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Photographers\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify Photographers.
@param data [Single Photographers Object, Array of Photographers Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns Photographers objects array if generate_objects flag is set
@example
rest_client.update_photographers(photographers_obj)
rest_client.update_photographers(photographers_obj,true)
rest_client.update_photographers(photographers_obj_array)
rest_client.update_photographers(photographers_obj_array,true)
|
[
"Modify",
"Photographers",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1289-L1292
|
21,029
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_projects
|
def create_projects(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Projects")
post(uri,data,generate_objects)
end
|
ruby
|
def create_projects(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Projects")
post(uri,data,generate_objects)
end
|
[
"def",
"create_projects",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Projects\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create Projects.
@param data [Single Projects Object, Array of Projects Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Projects objects array if generate_objects flag is set
@example
rest_client.create_projects(projects_obj)
rest_client.create_projects(projects_obj,true)
rest_client.create_projects(projects_obj_array)
rest_client.create_projects(projects_obj_array,true)
|
[
"Create",
"Projects",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1345-L1348
|
21,030
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_projects
|
def update_projects(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Projects")
put(uri,data,generate_objects)
end
|
ruby
|
def update_projects(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Projects")
put(uri,data,generate_objects)
end
|
[
"def",
"update_projects",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Projects\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify Projects.
@param data [Single Projects Object, Array of Projects Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns Projects objects array if generate_objects flag is set
@example
rest_client.update_projects(projects_obj)
rest_client.update_projects(projects_obj,true)
rest_client.update_projects(projects_obj_array)
rest_client.update_projects(projects_obj_array,true)
|
[
"Modify",
"Projects",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1364-L1367
|
21,031
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_project_keywords
|
def create_project_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/ProjectKeywords")
post(uri,data,generate_objects)
end
|
ruby
|
def create_project_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/ProjectKeywords")
post(uri,data,generate_objects)
end
|
[
"def",
"create_project_keywords",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/ProjectKeywords\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create Project Keywords.
@param data [Single ProjectKeywords Object, Array of ProjectKeywords Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns ProjectKeywords objects array if generate_objects flag is set
@example
rest_client.create_project_keywords(project_keywords_obj)
rest_client.create_project_keywords(project_keywords_obj,true)
rest_client.create_project_keywords(project_keywords_obj_array)
rest_client.create_project_keywords(project_keywords_obj_array,true)
|
[
"Create",
"Project",
"Keywords",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1424-L1427
|
21,032
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_project_keywords
|
def update_project_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/ProjectKeywords")
put(uri,data,generate_objects)
end
|
ruby
|
def update_project_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/ProjectKeywords")
put(uri,data,generate_objects)
end
|
[
"def",
"update_project_keywords",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/ProjectKeywords\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify Project Keywords.
@param data [Single ProjectKeywords Object, Array of ProjectKeywords Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns ProjectKeywords objects array if generate_objects flag is set
@example
rest_client.update_project_keywords(project_keywords_obj)
rest_client.update_project_keywords(project_keywords_obj,true)
rest_client.update_project_keywords(project_keywords_obj_array)
rest_client.update_project_keywords(project_keywords_obj_array,true)
|
[
"Modify",
"Project",
"Keywords",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1442-L1445
|
21,033
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.merge_project_keywords
|
def merge_project_keywords(target,source)
uri = URI.parse(@uri + "/ProjectKeywords")
merge(uri,target,source)
end
|
ruby
|
def merge_project_keywords(target,source)
uri = URI.parse(@uri + "/ProjectKeywords")
merge(uri,target,source)
end
|
[
"def",
"merge_project_keywords",
"(",
"target",
",",
"source",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/ProjectKeywords\"",
")",
"merge",
"(",
"uri",
",",
"target",
",",
"source",
")",
"end"
] |
Merge Project Keywords
@param target [ Project Keywords Object, id ](Required)
@param source [ Array of Project Keywords objects or ids ](Required)
@return [JSON object] HTTP response JSON object.
@example
rest_client.merge_project_keywords(project_keywords_obj,project_keywords_obj_array)
rest_client.merge_project_keywords('1',['1','2','3'])
|
[
"Merge",
"Project",
"Keywords"
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1475-L1478
|
21,034
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_project_keyword_categories
|
def create_project_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/ProjectKeywordCategories")
post(uri,data,generate_objects)
end
|
ruby
|
def create_project_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/ProjectKeywordCategories")
post(uri,data,generate_objects)
end
|
[
"def",
"create_project_keyword_categories",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/ProjectKeywordCategories\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create project keyword categories.
@param data [Single ProjectKeywordCategories Object, Array of ProjectKeywordCategories Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns ProjectKeywordCategories objects array if generate_objects flag is set
@example
rest_client.create_project_keyword_categories(project_keyword_categories_obj)
rest_client.create_project_keyword_categories(project_keyword_categories_obj,true)
rest_client.create_project_keyword_categories(project_keyword_categories_obj_array)
rest_client.create_project_keyword_categories(project_keyword_categories_obj_array,true)
|
[
"Create",
"project",
"keyword",
"categories",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1516-L1519
|
21,035
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_project_keyword_categories
|
def update_project_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/ProjectKeywordCategories")
put(uri,data,generate_objects)
end
|
ruby
|
def update_project_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/ProjectKeywordCategories")
put(uri,data,generate_objects)
end
|
[
"def",
"update_project_keyword_categories",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/ProjectKeywordCategories\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify project keyword categories.
@param data [Single ProjectKeywordCategories Object, Array of ProjectKeywordCategories Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns ProjectKeywordCategories objects array if generate_objects flag is set
@example
rest_client.update_project_keyword_categories(project_keyword_categories_obj)
rest_client.update_project_keyword_categories(project_keyword_categories_obj,true)
rest_client.update_project_keyword_categories(project_keyword_categories_obj_array)
rest_client.update_project_keyword_categories(project_keyword_categories_obj_array,true)
|
[
"Modify",
"project",
"keyword",
"categories",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1534-L1537
|
21,036
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.merge_project_keyword_categories
|
def merge_project_keyword_categories(target,source)
uri = URI.parse(@uri + "/ProjectKeywordCategories")
merge(uri,target,source)
end
|
ruby
|
def merge_project_keyword_categories(target,source)
uri = URI.parse(@uri + "/ProjectKeywordCategories")
merge(uri,target,source)
end
|
[
"def",
"merge_project_keyword_categories",
"(",
"target",
",",
"source",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/ProjectKeywordCategories\"",
")",
"merge",
"(",
"uri",
",",
"target",
",",
"source",
")",
"end"
] |
Merge Project Keyword Categories
@param target [ Project Keyword Categories Object, id ](Required)
@param source [ Array of Project Keyword Categories objects or ids ](Required)
@return [JSON object] HTTP response JSON object.
@example
rest_client.merge_project_keyword_categories(project_keywords_obj,project_keywords_obj_array)
rest_client.merge_project_keyword_categories('1',['1','2','3'])
|
[
"Merge",
"Project",
"Keyword",
"Categories"
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1567-L1570
|
21,037
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_employee_keywords
|
def create_employee_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/EmployeeKeywords")
post(uri,data,generate_objects)
end
|
ruby
|
def create_employee_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/EmployeeKeywords")
post(uri,data,generate_objects)
end
|
[
"def",
"create_employee_keywords",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/EmployeeKeywords\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create Employee Keywords.
@param data [Single EmployeeKeywords Object, Array of EmployeeKeywords Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns EmployeeKeywords objects array if generate_objects flag is set
@example
rest_client.create_employee_keywords(employee_keywords_obj)
rest_client.create_employee_keywords(employee_keywords_obj,true)
rest_client.create_employee_keywords(employee_keywords_obj_array)
rest_client.create_employee_keywords(employee_keywords_obj_array,true)
|
[
"Create",
"Employee",
"Keywords",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1608-L1611
|
21,038
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_employee_keywords
|
def update_employee_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/EmployeeKeywords")
put(uri,data,generate_objects)
end
|
ruby
|
def update_employee_keywords(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/EmployeeKeywords")
put(uri,data,generate_objects)
end
|
[
"def",
"update_employee_keywords",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/EmployeeKeywords\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify Employee Keywords.
@param data [Single EmployeeKeywords Object, Array of EmployeeKeywords Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns EmployeeKeywords objects array if generate_objects flag is set
@example
rest_client.update_employee_keywords(employee_keywords_obj)
rest_client.update_employee_keywords(employee_keywords_obj,true)
rest_client.update_employee_keywords(employee_keywords_obj_array)
rest_client.update_employee_keywords(employee_keywords_obj_array,true)
|
[
"Modify",
"Employee",
"Keywords",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1626-L1629
|
21,039
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.merge_employee_keywords
|
def merge_employee_keywords(target,source)
uri = URI.parse(@uri + "/EmployeeKeywords")
merge(uri,target,source)
end
|
ruby
|
def merge_employee_keywords(target,source)
uri = URI.parse(@uri + "/EmployeeKeywords")
merge(uri,target,source)
end
|
[
"def",
"merge_employee_keywords",
"(",
"target",
",",
"source",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/EmployeeKeywords\"",
")",
"merge",
"(",
"uri",
",",
"target",
",",
"source",
")",
"end"
] |
Merge Employee Keywords
@param target [ Employee Keywords Object, id ](Required)
@param source [ Array of Employee Keywords objects or ids ](Required)
@return [JSON object] HTTP response JSON object.
@example
rest_client.merge_employee_keywords(employee_keywords_obj,employee_keywords_obj_array)
rest_client.merge_employee_keywords('1',['1','2','3'])
|
[
"Merge",
"Employee",
"Keywords"
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1659-L1662
|
21,040
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_employee_keyword_categories
|
def create_employee_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/EmployeeKeywordCategories")
post(uri,data,generate_objects)
end
|
ruby
|
def create_employee_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/EmployeeKeywordCategories")
post(uri,data,generate_objects)
end
|
[
"def",
"create_employee_keyword_categories",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/EmployeeKeywordCategories\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create employee keyword categories.
@param data [Single EmployeeKeywordCategories Object, Array of EmployeeKeywordCategories Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns EmployeeKeywordCategories objects array if generate_objects flag is set
@example
rest_client.create_employee_keyword_categories(employee_keyword_categories_obj)
rest_client.create_employee_keyword_categories(employee_keyword_categories_obj,true)
rest_client.create_employee_keyword_categories(employee_keyword_categories_obj_array)
rest_client.create_employee_keyword_categories(employee_keyword_categories_obj_array,true)
|
[
"Create",
"employee",
"keyword",
"categories",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1700-L1703
|
21,041
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_employee_keyword_categories
|
def update_employee_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/EmployeeKeywordCategories")
put(uri,data,generate_objects)
end
|
ruby
|
def update_employee_keyword_categories(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/EmployeeKeywordCategories")
put(uri,data,generate_objects)
end
|
[
"def",
"update_employee_keyword_categories",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/EmployeeKeywordCategories\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify employee keyword categories.
@param data [Single EmployeeKeywordCategories Object, Array of EmployeeKeywordCategories Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns EmployeeKeywordCategories objects array if generate_objects flag is set
@example
rest_client.update_employee_keyword_categories(employee_keyword_categories_obj)
rest_client.update_employee_keyword_categories(employee_keyword_categories_obj,true)
rest_client.update_employee_keyword_categories(employee_keyword_categories_obj_array)
rest_client.update_employee_keyword_categories(employee_keyword_categories_obj_array,true)
|
[
"Modify",
"employee",
"keyword",
"categories",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1718-L1721
|
21,042
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.merge_employee_keyword_categories
|
def merge_employee_keyword_categories(target,source)
uri = URI.parse(@uri + "/EmployeeKeywordCategories")
merge(uri,target,source)
end
|
ruby
|
def merge_employee_keyword_categories(target,source)
uri = URI.parse(@uri + "/EmployeeKeywordCategories")
merge(uri,target,source)
end
|
[
"def",
"merge_employee_keyword_categories",
"(",
"target",
",",
"source",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/EmployeeKeywordCategories\"",
")",
"merge",
"(",
"uri",
",",
"target",
",",
"source",
")",
"end"
] |
Merge Employee Keyword Categories
@param target [ Employee Keyword Categories Object, id ](Required)
@param source [ Array of Employee Keyword Categories objects or ids ](Required)
@return [JSON object] HTTP response JSON object.
@example
rest_client.merge_employee_keyword_categories(employee_keywords_obj,employee_keywords_obj_array)
rest_client.merge_employee_keyword_categories('1',['1','2','3'])
|
[
"Merge",
"Employee",
"Keyword",
"Categories"
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1751-L1754
|
21,043
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_searches
|
def create_searches(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Searches")
post(uri,data,generate_objects)
end
|
ruby
|
def create_searches(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Searches")
post(uri,data,generate_objects)
end
|
[
"def",
"create_searches",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Searches\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create Searches.
@param data [Single Searches Object, Array of Searches Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Searches objects array if generate_objects flag is set
@example
rest_client.create_searches(searches_obj)
rest_client.create_searches(searches_obj,true)
rest_client.create_searches(searches_obj_array)
rest_client.create_searches(searches_obj_array,true)
|
[
"Create",
"Searches",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1792-L1795
|
21,044
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_searches
|
def update_searches(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Searches")
put(uri,data,generate_objects)
end
|
ruby
|
def update_searches(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Searches")
put(uri,data,generate_objects)
end
|
[
"def",
"update_searches",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Searches\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify Searches.
@param data [Single Searches Object, Array of Searches Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns Searches objects array if generate_objects flag is set
@example
rest_client.update_searches(searches_obj)
rest_client.update_searches(searches_obj,true)
rest_client.update_searches(searches_obj_array)
rest_client.update_searches(searches_obj_array,true)
|
[
"Modify",
"Searches",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1810-L1813
|
21,045
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_image_sizes
|
def create_image_sizes(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Sizes")
post(uri,data,generate_objects)
end
|
ruby
|
def create_image_sizes(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Sizes")
post(uri,data,generate_objects)
end
|
[
"def",
"create_image_sizes",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Sizes\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create image Sizes.
@param data [Single Sizes Object, Array of Sizes Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns ImageSizes objects array if generate_objects flag is set
@example
rest_client.create_image_sizes(image_sizes_obj)
rest_client.create_image_sizes(image_sizes_obj,true)
rest_client.create_image_sizes(image_sizes_obj_array)
rest_client.create_image_sizes(image_sizes_obj_array,true)
|
[
"Create",
"image",
"Sizes",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1852-L1855
|
21,046
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_image_sizes
|
def update_image_sizes(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Sizes")
put(uri,data,generate_objects)
end
|
ruby
|
def update_image_sizes(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Sizes")
put(uri,data,generate_objects)
end
|
[
"def",
"update_image_sizes",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Sizes\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Modify image Sizes.
@param data [Single Sizes Object, Array of Sizes Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after updating object
@return [JSON object] HTTP response JSON object. Returns ImageSizes objects array if generate_objects flag is set
@example
rest_client.update_image_sizes(image_sizes_obj)
rest_client.update_image_sizes(image_sizes_obj,true)
rest_client.update_image_sizes(image_sizes_obj_array)
rest_client.update_image_sizes(image_sizes_obj_array,true)
|
[
"Modify",
"image",
"Sizes",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1870-L1873
|
21,047
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_users
|
def create_users(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Users")
post(uri,data,generate_objects)
end
|
ruby
|
def create_users(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Users")
post(uri,data,generate_objects)
end
|
[
"def",
"create_users",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Users\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create Users.
@param data [Single Users Object, Array of Users Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Users objects array if generate_objects flag is set
@example
rest_client.create_users(users_obj)
rest_client.create_users(users_obj,true)
rest_client.create_users(users_obj_array)
rest_client.create_users(users_obj_array,true)
|
[
"Create",
"Users",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1954-L1957
|
21,048
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_users
|
def update_users(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Users")
put(uri,data,generate_objects)
end
|
ruby
|
def update_users(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Users")
put(uri,data,generate_objects)
end
|
[
"def",
"update_users",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Users\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Update Users.
@param data [Single Users Object, Array of Users Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Users objects array if generate_objects flag is set
@example
rest_client.update_users(users_obj)
rest_client.update_users(users_obj,true)
rest_client.update_users(users_obj_array)
rest_client.update_users(users_obj_array,true)
|
[
"Update",
"Users",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L1972-L1975
|
21,049
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.create_employees
|
def create_employees(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Employees")
post(uri,data,generate_objects)
end
|
ruby
|
def create_employees(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Employees")
post(uri,data,generate_objects)
end
|
[
"def",
"create_employees",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Employees\"",
")",
"post",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Create employees.
@param data [Single employees Object, Array of employees Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns employees objects array if generate_objects flag is set
@example
rest_client.create_employees(employees_obj)
rest_client.create_employees(employees_obj,true)
rest_client.create_employees(employees_obj_array)
rest_client.create_employees(employees_obj_array,true)
|
[
"Create",
"employees",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L2032-L2035
|
21,050
|
axomic/openasset-rest-ruby
|
lib/openasset-rest-client.rb
|
OpenAsset.RestClient.update_employees
|
def update_employees(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Employees")
put(uri,data,generate_objects)
end
|
ruby
|
def update_employees(data=nil,generate_objects=false)
uri = URI.parse(@uri + "/Employees")
put(uri,data,generate_objects)
end
|
[
"def",
"update_employees",
"(",
"data",
"=",
"nil",
",",
"generate_objects",
"=",
"false",
")",
"uri",
"=",
"URI",
".",
"parse",
"(",
"@uri",
"+",
"\"/Employees\"",
")",
"put",
"(",
"uri",
",",
"data",
",",
"generate_objects",
")",
"end"
] |
Update Employees.
@param data [Single Users Object, Array of Employees Objects] (Required)
@param generate_objects [Boolean] (Optional)
Caution: Hurts performance -> Only use if performing further edits after object creation
@return [JSON object] HTTP response JSON object. Returns Employees objects array if generate_objects flag is set
@example
rest_client.update_employees(employees_obj)
rest_client.update_employees(employees_obj,true)
rest_client.update_employees(employees_obj_array)
rest_client.update_employees(employees_obj_array,true)
|
[
"Update",
"Employees",
"."
] |
74215403c8b06343b02fcbfb09f0dd550ef96eb2
|
https://github.com/axomic/openasset-rest-ruby/blob/74215403c8b06343b02fcbfb09f0dd550ef96eb2/lib/openasset-rest-client.rb#L2050-L2053
|
21,051
|
DigitPaint/roger
|
lib/roger/server.rb
|
Roger.Server.set_options
|
def set_options(options)
self.port = options[:port].to_i if options.key?(:port)
self.handler = options[:handler] if options.key?(:handler)
self.host = options[:host] if options.key?(:host)
self.auto_port = options[:auto_port] if options.key?(:auto_port)
end
|
ruby
|
def set_options(options)
self.port = options[:port].to_i if options.key?(:port)
self.handler = options[:handler] if options.key?(:handler)
self.host = options[:host] if options.key?(:host)
self.auto_port = options[:auto_port] if options.key?(:auto_port)
end
|
[
"def",
"set_options",
"(",
"options",
")",
"self",
".",
"port",
"=",
"options",
"[",
":port",
"]",
".",
"to_i",
"if",
"options",
".",
"key?",
"(",
":port",
")",
"self",
".",
"handler",
"=",
"options",
"[",
":handler",
"]",
"if",
"options",
".",
"key?",
"(",
":handler",
")",
"self",
".",
"host",
"=",
"options",
"[",
":host",
"]",
"if",
"options",
".",
"key?",
"(",
":host",
")",
"self",
".",
"auto_port",
"=",
"options",
"[",
":auto_port",
"]",
"if",
"options",
".",
"key?",
"(",
":auto_port",
")",
"end"
] |
Sets the options, this is a separate method as we want to override certain
things set in the rogerfile from the commandline
|
[
"Sets",
"the",
"options",
"this",
"is",
"a",
"separate",
"method",
"as",
"we",
"want",
"to",
"override",
"certain",
"things",
"set",
"in",
"the",
"rogerfile",
"from",
"the",
"commandline"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/server.rb#L57-L62
|
21,052
|
DigitPaint/roger
|
lib/roger/server.rb
|
Roger.Server.free_port_for_host_above
|
def free_port_for_host_above(host, port)
test_port = port
test_port += 1 until port_free?(host, test_port) || port + 100 <= test_port
test_port
end
|
ruby
|
def free_port_for_host_above(host, port)
test_port = port
test_port += 1 until port_free?(host, test_port) || port + 100 <= test_port
test_port
end
|
[
"def",
"free_port_for_host_above",
"(",
"host",
",",
"port",
")",
"test_port",
"=",
"port",
"test_port",
"+=",
"1",
"until",
"port_free?",
"(",
"host",
",",
"test_port",
")",
"||",
"port",
"+",
"100",
"<=",
"test_port",
"test_port",
"end"
] |
Get the first free port for host above port
Will only ever test 100 ports.
|
[
"Get",
"the",
"first",
"free",
"port",
"for",
"host",
"above",
"port",
"Will",
"only",
"ever",
"test",
"100",
"ports",
"."
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/server.rb#L132-L136
|
21,053
|
DigitPaint/roger
|
lib/roger/server.rb
|
Roger.Server.port_free?
|
def port_free?(host, port)
Addrinfo.tcp(host, port).listen.close
true
rescue SocketError, Errno::EADDRINUSE, Errno::EACCES
false
end
|
ruby
|
def port_free?(host, port)
Addrinfo.tcp(host, port).listen.close
true
rescue SocketError, Errno::EADDRINUSE, Errno::EACCES
false
end
|
[
"def",
"port_free?",
"(",
"host",
",",
"port",
")",
"Addrinfo",
".",
"tcp",
"(",
"host",
",",
"port",
")",
".",
"listen",
".",
"close",
"true",
"rescue",
"SocketError",
",",
"Errno",
"::",
"EADDRINUSE",
",",
"Errno",
"::",
"EACCES",
"false",
"end"
] |
See if a certain port is free on a certain host
|
[
"See",
"if",
"a",
"certain",
"port",
"is",
"free",
"on",
"a",
"certain",
"host"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/server.rb#L139-L145
|
21,054
|
DigitPaint/roger
|
lib/roger/server.rb
|
Roger.Server.detect_valid_handler
|
def detect_valid_handler(servers)
handler = nil
while (server_name = servers.shift) && handler.nil?
begin
handler = ::Rack::Handler.get(server_name)
return [handler, server_name]
rescue LoadError
handler = nil
rescue NameError
handler = nil
end
end
end
|
ruby
|
def detect_valid_handler(servers)
handler = nil
while (server_name = servers.shift) && handler.nil?
begin
handler = ::Rack::Handler.get(server_name)
return [handler, server_name]
rescue LoadError
handler = nil
rescue NameError
handler = nil
end
end
end
|
[
"def",
"detect_valid_handler",
"(",
"servers",
")",
"handler",
"=",
"nil",
"while",
"(",
"server_name",
"=",
"servers",
".",
"shift",
")",
"&&",
"handler",
".",
"nil?",
"begin",
"handler",
"=",
"::",
"Rack",
"::",
"Handler",
".",
"get",
"(",
"server_name",
")",
"return",
"[",
"handler",
",",
"server_name",
"]",
"rescue",
"LoadError",
"handler",
"=",
"nil",
"rescue",
"NameError",
"handler",
"=",
"nil",
"end",
"end",
"end"
] |
See what handlers work
|
[
"See",
"what",
"handlers",
"work"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/server.rb#L202-L214
|
21,055
|
DigitPaint/roger
|
lib/roger/template.rb
|
Roger.Template.render_with_tilt_template
|
def render_with_tilt_template(template_class, src, locals, &_block)
@current_tilt_template = template_class
template = template_class.new(source_path) { src }
block_content = if block_given?
yield
else
""
end
template.render(@context, locals) do |name|
if name
@context._content_for_blocks[name]
else
block_content
end
end
end
|
ruby
|
def render_with_tilt_template(template_class, src, locals, &_block)
@current_tilt_template = template_class
template = template_class.new(source_path) { src }
block_content = if block_given?
yield
else
""
end
template.render(@context, locals) do |name|
if name
@context._content_for_blocks[name]
else
block_content
end
end
end
|
[
"def",
"render_with_tilt_template",
"(",
"template_class",
",",
"src",
",",
"locals",
",",
"&",
"_block",
")",
"@current_tilt_template",
"=",
"template_class",
"template",
"=",
"template_class",
".",
"new",
"(",
"source_path",
")",
"{",
"src",
"}",
"block_content",
"=",
"if",
"block_given?",
"yield",
"else",
"\"\"",
"end",
"template",
".",
"render",
"(",
"@context",
",",
"locals",
")",
"do",
"|",
"name",
"|",
"if",
"name",
"@context",
".",
"_content_for_blocks",
"[",
"name",
"]",
"else",
"block_content",
"end",
"end",
"end"
] |
Render source with a specific tilt template class
|
[
"Render",
"source",
"with",
"a",
"specific",
"tilt",
"template",
"class"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/template.rb#L70-L87
|
21,056
|
DigitPaint/roger
|
lib/roger/template.rb
|
Roger.Template.extract_front_matter
|
def extract_front_matter(source)
fm_regex = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
return [{}, source] unless match = source.match(fm_regex)
source = source.sub(fm_regex, "")
begin
data = (YAML.safe_load(match[1]) || {}).inject({}) do |memo, (k, v)|
memo[k.to_sym] = v
memo
end
rescue *YAML_ERRORS => e
puts "YAML Exception: #{e.message}"
return false
end
[data, source]
rescue
[{}, source]
end
|
ruby
|
def extract_front_matter(source)
fm_regex = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
return [{}, source] unless match = source.match(fm_regex)
source = source.sub(fm_regex, "")
begin
data = (YAML.safe_load(match[1]) || {}).inject({}) do |memo, (k, v)|
memo[k.to_sym] = v
memo
end
rescue *YAML_ERRORS => e
puts "YAML Exception: #{e.message}"
return false
end
[data, source]
rescue
[{}, source]
end
|
[
"def",
"extract_front_matter",
"(",
"source",
")",
"fm_regex",
"=",
"/",
"\\A",
"\\s",
"\\n",
"\\n",
"\\s",
"\\n",
"/m",
"return",
"[",
"{",
"}",
",",
"source",
"]",
"unless",
"match",
"=",
"source",
".",
"match",
"(",
"fm_regex",
")",
"source",
"=",
"source",
".",
"sub",
"(",
"fm_regex",
",",
"\"\"",
")",
"begin",
"data",
"=",
"(",
"YAML",
".",
"safe_load",
"(",
"match",
"[",
"1",
"]",
")",
"||",
"{",
"}",
")",
".",
"inject",
"(",
"{",
"}",
")",
"do",
"|",
"memo",
",",
"(",
"k",
",",
"v",
")",
"|",
"memo",
"[",
"k",
".",
"to_sym",
"]",
"=",
"v",
"memo",
"end",
"rescue",
"YAML_ERRORS",
"=>",
"e",
"puts",
"\"YAML Exception: #{e.message}\"",
"return",
"false",
"end",
"[",
"data",
",",
"source",
"]",
"rescue",
"[",
"{",
"}",
",",
"source",
"]",
"end"
] |
Get the front matter portion of the file and extract it.
|
[
"Get",
"the",
"front",
"matter",
"portion",
"of",
"the",
"file",
"and",
"extract",
"it",
"."
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/template.rb#L90-L110
|
21,057
|
DigitPaint/roger
|
lib/roger/release.rb
|
Roger.Release.use
|
def use(processor, options = {})
@stack << [self.class.get_callable(processor, Roger::Release::Processors.map), options]
end
|
ruby
|
def use(processor, options = {})
@stack << [self.class.get_callable(processor, Roger::Release::Processors.map), options]
end
|
[
"def",
"use",
"(",
"processor",
",",
"options",
"=",
"{",
"}",
")",
"@stack",
"<<",
"[",
"self",
".",
"class",
".",
"get_callable",
"(",
"processor",
",",
"Roger",
"::",
"Release",
"::",
"Processors",
".",
"map",
")",
",",
"options",
"]",
"end"
] |
Use a certain pre-processor
@examples
release.use :sprockets, sprockets_config
|
[
"Use",
"a",
"certain",
"pre",
"-",
"processor"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/release.rb#L112-L114
|
21,058
|
DigitPaint/roger
|
lib/roger/release.rb
|
Roger.Release.run!
|
def run!
project.mode = :release
# Validate paths
validate_paths!
# Extract mockup
copy_source_path_to_build_path!
validate_stack!
# Run stack
run_stack!
# Cleanup
cleanup! if config[:cleanup_build]
ensure
project.mode = nil
end
|
ruby
|
def run!
project.mode = :release
# Validate paths
validate_paths!
# Extract mockup
copy_source_path_to_build_path!
validate_stack!
# Run stack
run_stack!
# Cleanup
cleanup! if config[:cleanup_build]
ensure
project.mode = nil
end
|
[
"def",
"run!",
"project",
".",
"mode",
"=",
":release",
"# Validate paths",
"validate_paths!",
"# Extract mockup",
"copy_source_path_to_build_path!",
"validate_stack!",
"# Run stack",
"run_stack!",
"# Cleanup",
"cleanup!",
"if",
"config",
"[",
":cleanup_build",
"]",
"ensure",
"project",
".",
"mode",
"=",
"nil",
"end"
] |
Actually perform the release
|
[
"Actually",
"perform",
"the",
"release"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/release.rb#L171-L189
|
21,059
|
DigitPaint/roger
|
lib/roger/cli/serve.rb
|
Roger.Cli::Serve.serve
|
def serve
server_options = {}
options.each { |k, v| server_options[k.to_sym] = v }
server_options[:server] = {}
[:port, :handler, :host].each do |k|
server_options[:server][k] = server_options.delete(k) if server_options.key?(k)
end
@project.server.set_options(server_options[:server])
end
|
ruby
|
def serve
server_options = {}
options.each { |k, v| server_options[k.to_sym] = v }
server_options[:server] = {}
[:port, :handler, :host].each do |k|
server_options[:server][k] = server_options.delete(k) if server_options.key?(k)
end
@project.server.set_options(server_options[:server])
end
|
[
"def",
"serve",
"server_options",
"=",
"{",
"}",
"options",
".",
"each",
"{",
"|",
"k",
",",
"v",
"|",
"server_options",
"[",
"k",
".",
"to_sym",
"]",
"=",
"v",
"}",
"server_options",
"[",
":server",
"]",
"=",
"{",
"}",
"[",
":port",
",",
":handler",
",",
":host",
"]",
".",
"each",
"do",
"|",
"k",
"|",
"server_options",
"[",
":server",
"]",
"[",
"k",
"]",
"=",
"server_options",
".",
"delete",
"(",
"k",
")",
"if",
"server_options",
".",
"key?",
"(",
"k",
")",
"end",
"@project",
".",
"server",
".",
"set_options",
"(",
"server_options",
"[",
":server",
"]",
")",
"end"
] |
The handler to use
|
[
"The",
"handler",
"to",
"use"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/cli/serve.rb#L10-L19
|
21,060
|
DigitPaint/roger
|
lib/roger/rogerfile.rb
|
Roger.Rogerfile.load
|
def load
return unless File.exist?(@path) && !loaded?
@source = File.read(@path)
context = Context.new(self)
eval @source, context.binding, @path.to_s, 1 # rubocop:disable Lint/Eval
@loaded = true
end
|
ruby
|
def load
return unless File.exist?(@path) && !loaded?
@source = File.read(@path)
context = Context.new(self)
eval @source, context.binding, @path.to_s, 1 # rubocop:disable Lint/Eval
@loaded = true
end
|
[
"def",
"load",
"return",
"unless",
"File",
".",
"exist?",
"(",
"@path",
")",
"&&",
"!",
"loaded?",
"@source",
"=",
"File",
".",
"read",
"(",
"@path",
")",
"context",
"=",
"Context",
".",
"new",
"(",
"self",
")",
"eval",
"@source",
",",
"context",
".",
"binding",
",",
"@path",
".",
"to_s",
",",
"1",
"# rubocop:disable Lint/Eval",
"@loaded",
"=",
"true",
"end"
] |
Actually load the rogerfile
|
[
"Actually",
"load",
"the",
"rogerfile"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/rogerfile.rb#L36-L43
|
21,061
|
DigitPaint/roger
|
lib/roger/renderer.rb
|
Roger.Renderer.render
|
def render(path, options = {}, &block)
template, layout = template_and_layout_for_render(path, options)
# Set new current template
template_nesting.push(template)
# Copy data to our data store. A bit clunky; as this should be inherited
@data = {}.update(@data).update(template.data)
# Render the template first so we have access to
# it's data in the layout.
render_result = template.render(options[:locals] || {}, &block)
# Wrap it in a layout
layout.render do
render_result
end
ensure
# Only pop the template from the nesting if we actually
# put it on the nesting stack.
template_nesting.pop if template
end
|
ruby
|
def render(path, options = {}, &block)
template, layout = template_and_layout_for_render(path, options)
# Set new current template
template_nesting.push(template)
# Copy data to our data store. A bit clunky; as this should be inherited
@data = {}.update(@data).update(template.data)
# Render the template first so we have access to
# it's data in the layout.
render_result = template.render(options[:locals] || {}, &block)
# Wrap it in a layout
layout.render do
render_result
end
ensure
# Only pop the template from the nesting if we actually
# put it on the nesting stack.
template_nesting.pop if template
end
|
[
"def",
"render",
"(",
"path",
",",
"options",
"=",
"{",
"}",
",",
"&",
"block",
")",
"template",
",",
"layout",
"=",
"template_and_layout_for_render",
"(",
"path",
",",
"options",
")",
"# Set new current template",
"template_nesting",
".",
"push",
"(",
"template",
")",
"# Copy data to our data store. A bit clunky; as this should be inherited",
"@data",
"=",
"{",
"}",
".",
"update",
"(",
"@data",
")",
".",
"update",
"(",
"template",
".",
"data",
")",
"# Render the template first so we have access to",
"# it's data in the layout.",
"render_result",
"=",
"template",
".",
"render",
"(",
"options",
"[",
":locals",
"]",
"||",
"{",
"}",
",",
"block",
")",
"# Wrap it in a layout",
"layout",
".",
"render",
"do",
"render_result",
"end",
"ensure",
"# Only pop the template from the nesting if we actually",
"# put it on the nesting stack.",
"template_nesting",
".",
"pop",
"if",
"template",
"end"
] |
The render function
The render function will take care of rendering the right thing
in the right context. It will:
- Wrap templates with layouts if it's defined in the frontmatter and
load them from the right layout path.
- Render only partials if called from within an existing template
If you just want to render an arbitrary file, use #render_file instead
@option options [Hash] :locals Locals to use during rendering
@option options [String] :source The source for the template
@option options [String, nil] :layout The default layout to use
|
[
"The",
"render",
"function"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/renderer.rb#L122-L143
|
21,062
|
DigitPaint/roger
|
lib/roger/renderer.rb
|
Roger.Renderer.render_file
|
def render_file(path, options = {})
pn = absolute_path_from_current_template(path)
template = template(pn.to_s, nil)
# Track rendered file also on the rendered stack
template_nesting.push(template)
template.render(options[:locals] || {})
ensure
# Only pop the template from the nesting if we actually
# put it on the nesting stack.
template_nesting.pop if template
end
|
ruby
|
def render_file(path, options = {})
pn = absolute_path_from_current_template(path)
template = template(pn.to_s, nil)
# Track rendered file also on the rendered stack
template_nesting.push(template)
template.render(options[:locals] || {})
ensure
# Only pop the template from the nesting if we actually
# put it on the nesting stack.
template_nesting.pop if template
end
|
[
"def",
"render_file",
"(",
"path",
",",
"options",
"=",
"{",
"}",
")",
"pn",
"=",
"absolute_path_from_current_template",
"(",
"path",
")",
"template",
"=",
"template",
"(",
"pn",
".",
"to_s",
",",
"nil",
")",
"# Track rendered file also on the rendered stack",
"template_nesting",
".",
"push",
"(",
"template",
")",
"template",
".",
"render",
"(",
"options",
"[",
":locals",
"]",
"||",
"{",
"}",
")",
"ensure",
"# Only pop the template from the nesting if we actually",
"# put it on the nesting stack.",
"template_nesting",
".",
"pop",
"if",
"template",
"end"
] |
Render any file on disk. No magic. Just rendering.
A couple of things to keep in mind:
- The file will be rendered in this rendering context
- Does not have layouts or block style
- When you pass a relative path and we are within another template
it will be relative to that template.
@options options [Hash] :locals
|
[
"Render",
"any",
"file",
"on",
"disk",
".",
"No",
"magic",
".",
"Just",
"rendering",
"."
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/renderer.rb#L154-L167
|
21,063
|
DigitPaint/roger
|
lib/roger/renderer.rb
|
Roger.Renderer.layout_for_template
|
def layout_for_template(template, options)
layout_name = if template.data.key?(:layout)
template.data[:layout]
else
get_default_layout(template, options)
end
# Only attempt to load layout when:
# - Template is the toplevel template
# - A layout_name is available
return BlankTemplate.new if current_template || !layout_name
template(layout_name, nil, :layout)
end
|
ruby
|
def layout_for_template(template, options)
layout_name = if template.data.key?(:layout)
template.data[:layout]
else
get_default_layout(template, options)
end
# Only attempt to load layout when:
# - Template is the toplevel template
# - A layout_name is available
return BlankTemplate.new if current_template || !layout_name
template(layout_name, nil, :layout)
end
|
[
"def",
"layout_for_template",
"(",
"template",
",",
"options",
")",
"layout_name",
"=",
"if",
"template",
".",
"data",
".",
"key?",
"(",
":layout",
")",
"template",
".",
"data",
"[",
":layout",
"]",
"else",
"get_default_layout",
"(",
"template",
",",
"options",
")",
"end",
"# Only attempt to load layout when:",
"# - Template is the toplevel template",
"# - A layout_name is available",
"return",
"BlankTemplate",
".",
"new",
"if",
"current_template",
"||",
"!",
"layout_name",
"template",
"(",
"layout_name",
",",
"nil",
",",
":layout",
")",
"end"
] |
Gets the layout for a specific template
|
[
"Gets",
"the",
"layout",
"for",
"a",
"specific",
"template"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/renderer.rb#L211-L224
|
21,064
|
DigitPaint/roger
|
lib/roger/renderer.rb
|
Roger.Renderer.prevent_recursion!
|
def prevent_recursion!(template)
# If this template is not a real file it cannot ever conflict.
return unless template.real_source_path
caller_templates = template_nesting.select do |t|
t.real_source_path == template.real_source_path
end
# We're good, no deeper recursion then MAX_ALLOWED_TEMPLATE_NESTING
return if caller_templates.length <= MAX_ALLOWED_TEMPLATE_NESTING
err = "Recursive render detected for '#{template.source_path}'"
err += " in '#{current_template.source_path}'"
raise ArgumentError, err
end
|
ruby
|
def prevent_recursion!(template)
# If this template is not a real file it cannot ever conflict.
return unless template.real_source_path
caller_templates = template_nesting.select do |t|
t.real_source_path == template.real_source_path
end
# We're good, no deeper recursion then MAX_ALLOWED_TEMPLATE_NESTING
return if caller_templates.length <= MAX_ALLOWED_TEMPLATE_NESTING
err = "Recursive render detected for '#{template.source_path}'"
err += " in '#{current_template.source_path}'"
raise ArgumentError, err
end
|
[
"def",
"prevent_recursion!",
"(",
"template",
")",
"# If this template is not a real file it cannot ever conflict.",
"return",
"unless",
"template",
".",
"real_source_path",
"caller_templates",
"=",
"template_nesting",
".",
"select",
"do",
"|",
"t",
"|",
"t",
".",
"real_source_path",
"==",
"template",
".",
"real_source_path",
"end",
"# We're good, no deeper recursion then MAX_ALLOWED_TEMPLATE_NESTING",
"return",
"if",
"caller_templates",
".",
"length",
"<=",
"MAX_ALLOWED_TEMPLATE_NESTING",
"err",
"=",
"\"Recursive render detected for '#{template.source_path}'\"",
"err",
"+=",
"\" in '#{current_template.source_path}'\"",
"raise",
"ArgumentError",
",",
"err",
"end"
] |
Will check the template nesting if we haven't already
rendered this path before. If it has we'll throw an argumenteerror
|
[
"Will",
"check",
"the",
"template",
"nesting",
"if",
"we",
"haven",
"t",
"already",
"rendered",
"this",
"path",
"before",
".",
"If",
"it",
"has",
"we",
"ll",
"throw",
"an",
"argumenteerror"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/renderer.rb#L237-L252
|
21,065
|
DigitPaint/roger
|
lib/roger/renderer.rb
|
Roger.Renderer.template
|
def template(path, source, type = :template)
if source
template = Template.new(source, @context, source_path: path)
else
template_path = case type
when :partial
find_partial(path)
when :layout
find_layout(path)
else
path
end
if template_path && File.exist?(template_path)
template = Template.open(template_path, @context)
else
template_not_found!(type, path)
end
end
prevent_recursion!(template)
template
end
|
ruby
|
def template(path, source, type = :template)
if source
template = Template.new(source, @context, source_path: path)
else
template_path = case type
when :partial
find_partial(path)
when :layout
find_layout(path)
else
path
end
if template_path && File.exist?(template_path)
template = Template.open(template_path, @context)
else
template_not_found!(type, path)
end
end
prevent_recursion!(template)
template
end
|
[
"def",
"template",
"(",
"path",
",",
"source",
",",
"type",
"=",
":template",
")",
"if",
"source",
"template",
"=",
"Template",
".",
"new",
"(",
"source",
",",
"@context",
",",
"source_path",
":",
"path",
")",
"else",
"template_path",
"=",
"case",
"type",
"when",
":partial",
"find_partial",
"(",
"path",
")",
"when",
":layout",
"find_layout",
"(",
"path",
")",
"else",
"path",
"end",
"if",
"template_path",
"&&",
"File",
".",
"exist?",
"(",
"template_path",
")",
"template",
"=",
"Template",
".",
"open",
"(",
"template_path",
",",
"@context",
")",
"else",
"template_not_found!",
"(",
"type",
",",
"path",
")",
"end",
"end",
"prevent_recursion!",
"(",
"template",
")",
"template",
"end"
] |
Will instantiate a Template or throw an ArgumentError
if it could not find the template
|
[
"Will",
"instantiate",
"a",
"Template",
"or",
"throw",
"an",
"ArgumentError",
"if",
"it",
"could",
"not",
"find",
"the",
"template"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/renderer.rb#L256-L279
|
21,066
|
DigitPaint/roger
|
lib/roger/renderer.rb
|
Roger.Renderer.find_partial
|
def find_partial(name)
current_path, current_ext = current_template_path_and_extension
# Try to find _ named partials first.
# This will alaso search for partials relative to the current path
local_name = [File.dirname(name), "_" + File.basename(name)].join("/")
resolver = Resolver.new([File.dirname(current_path)] + @paths[:partials])
result = resolver.find_template(local_name, prefer: current_ext)
return result if result
# Try to look for templates the old way
resolver = Resolver.new(@paths[:partials])
resolver.find_template(name, prefer: current_ext)
end
|
ruby
|
def find_partial(name)
current_path, current_ext = current_template_path_and_extension
# Try to find _ named partials first.
# This will alaso search for partials relative to the current path
local_name = [File.dirname(name), "_" + File.basename(name)].join("/")
resolver = Resolver.new([File.dirname(current_path)] + @paths[:partials])
result = resolver.find_template(local_name, prefer: current_ext)
return result if result
# Try to look for templates the old way
resolver = Resolver.new(@paths[:partials])
resolver.find_template(name, prefer: current_ext)
end
|
[
"def",
"find_partial",
"(",
"name",
")",
"current_path",
",",
"current_ext",
"=",
"current_template_path_and_extension",
"# Try to find _ named partials first.",
"# This will alaso search for partials relative to the current path",
"local_name",
"=",
"[",
"File",
".",
"dirname",
"(",
"name",
")",
",",
"\"_\"",
"+",
"File",
".",
"basename",
"(",
"name",
")",
"]",
".",
"join",
"(",
"\"/\"",
")",
"resolver",
"=",
"Resolver",
".",
"new",
"(",
"[",
"File",
".",
"dirname",
"(",
"current_path",
")",
"]",
"+",
"@paths",
"[",
":partials",
"]",
")",
"result",
"=",
"resolver",
".",
"find_template",
"(",
"local_name",
",",
"prefer",
":",
"current_ext",
")",
"return",
"result",
"if",
"result",
"# Try to look for templates the old way",
"resolver",
"=",
"Resolver",
".",
"new",
"(",
"@paths",
"[",
":partials",
"]",
")",
"resolver",
".",
"find_template",
"(",
"name",
",",
"prefer",
":",
"current_ext",
")",
"end"
] |
Find a partial
|
[
"Find",
"a",
"partial"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/renderer.rb#L288-L302
|
21,067
|
DigitPaint/roger
|
lib/roger/renderer.rb
|
Roger.Renderer.prepare_context
|
def prepare_context(env)
context = Roger::Template::TemplateContext.new(self, env)
# Extend context with all helpers
self.class.helpers.each do |mod|
context.extend(mod)
end
context
end
|
ruby
|
def prepare_context(env)
context = Roger::Template::TemplateContext.new(self, env)
# Extend context with all helpers
self.class.helpers.each do |mod|
context.extend(mod)
end
context
end
|
[
"def",
"prepare_context",
"(",
"env",
")",
"context",
"=",
"Roger",
"::",
"Template",
"::",
"TemplateContext",
".",
"new",
"(",
"self",
",",
"env",
")",
"# Extend context with all helpers",
"self",
".",
"class",
".",
"helpers",
".",
"each",
"do",
"|",
"mod",
"|",
"context",
".",
"extend",
"(",
"mod",
")",
"end",
"context",
"end"
] |
Will set up a new template context for this renderer
|
[
"Will",
"set",
"up",
"a",
"new",
"template",
"context",
"for",
"this",
"renderer"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/renderer.rb#L325-L334
|
21,068
|
DigitPaint/roger
|
lib/roger/release/processors/mockup.rb
|
Roger::Release::Processors.Mockup.run_on_file
|
def run_on_file(file_path, env = {})
renderer = Roger::Renderer.new(
env.dup,
partials_path: project.partial_path,
layouts_path: project.layouts_path
)
renderer.render(file_path, project.options[:renderer] || {})
end
|
ruby
|
def run_on_file(file_path, env = {})
renderer = Roger::Renderer.new(
env.dup,
partials_path: project.partial_path,
layouts_path: project.layouts_path
)
renderer.render(file_path, project.options[:renderer] || {})
end
|
[
"def",
"run_on_file",
"(",
"file_path",
",",
"env",
"=",
"{",
"}",
")",
"renderer",
"=",
"Roger",
"::",
"Renderer",
".",
"new",
"(",
"env",
".",
"dup",
",",
"partials_path",
":",
"project",
".",
"partial_path",
",",
"layouts_path",
":",
"project",
".",
"layouts_path",
")",
"renderer",
".",
"render",
"(",
"file_path",
",",
"project",
".",
"options",
"[",
":renderer",
"]",
"||",
"{",
"}",
")",
"end"
] |
Runs the template on a single file and return processed source.
|
[
"Runs",
"the",
"template",
"on",
"a",
"single",
"file",
"and",
"return",
"processed",
"source",
"."
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/release/processors/mockup.rb#L59-L66
|
21,069
|
DigitPaint/roger
|
lib/roger/resolver.rb
|
Roger.Resolver.find_template_path
|
def find_template_path(name, options = {})
options = {
prefer: "html", # Prefer a template with extension
}.update(options)
path = sanitize_name(name, options[:prefer])
# Exact match
return Pathname.new(path) if File.exist?(path)
# Split extension and path
path_extension, path_without_extension = split_path(path)
# Get possible output extensions for path_extension
template_extensions = template_extensions_for_output(path_extension, options[:prefer])
# Let's look at the disk to see what files we've got
files = Dir.glob(path_without_extension + ".*")
results = filter_files(files, path, path_without_extension, template_extensions)
if !results[0]
# No results found, but maybe there is a directory
# with the same name and it contains an index.XYZ
find_template_path(File.join(name, "index")) if File.directory?(name)
else
Pathname.new(results[0])
end
end
|
ruby
|
def find_template_path(name, options = {})
options = {
prefer: "html", # Prefer a template with extension
}.update(options)
path = sanitize_name(name, options[:prefer])
# Exact match
return Pathname.new(path) if File.exist?(path)
# Split extension and path
path_extension, path_without_extension = split_path(path)
# Get possible output extensions for path_extension
template_extensions = template_extensions_for_output(path_extension, options[:prefer])
# Let's look at the disk to see what files we've got
files = Dir.glob(path_without_extension + ".*")
results = filter_files(files, path, path_without_extension, template_extensions)
if !results[0]
# No results found, but maybe there is a directory
# with the same name and it contains an index.XYZ
find_template_path(File.join(name, "index")) if File.directory?(name)
else
Pathname.new(results[0])
end
end
|
[
"def",
"find_template_path",
"(",
"name",
",",
"options",
"=",
"{",
"}",
")",
"options",
"=",
"{",
"prefer",
":",
"\"html\"",
",",
"# Prefer a template with extension",
"}",
".",
"update",
"(",
"options",
")",
"path",
"=",
"sanitize_name",
"(",
"name",
",",
"options",
"[",
":prefer",
"]",
")",
"# Exact match",
"return",
"Pathname",
".",
"new",
"(",
"path",
")",
"if",
"File",
".",
"exist?",
"(",
"path",
")",
"# Split extension and path",
"path_extension",
",",
"path_without_extension",
"=",
"split_path",
"(",
"path",
")",
"# Get possible output extensions for path_extension",
"template_extensions",
"=",
"template_extensions_for_output",
"(",
"path_extension",
",",
"options",
"[",
":prefer",
"]",
")",
"# Let's look at the disk to see what files we've got",
"files",
"=",
"Dir",
".",
"glob",
"(",
"path_without_extension",
"+",
"\".*\"",
")",
"results",
"=",
"filter_files",
"(",
"files",
",",
"path",
",",
"path_without_extension",
",",
"template_extensions",
")",
"if",
"!",
"results",
"[",
"0",
"]",
"# No results found, but maybe there is a directory",
"# with the same name and it contains an index.XYZ",
"find_template_path",
"(",
"File",
".",
"join",
"(",
"name",
",",
"\"index\"",
")",
")",
"if",
"File",
".",
"directory?",
"(",
"name",
")",
"else",
"Pathname",
".",
"new",
"(",
"results",
"[",
"0",
"]",
")",
"end",
"end"
] |
Finds the template path for "name"
|
[
"Finds",
"the",
"template",
"path",
"for",
"name"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/resolver.rb#L117-L145
|
21,070
|
DigitPaint/roger
|
lib/roger/resolver.rb
|
Roger.Resolver.filter_files
|
def filter_files(files, path, path_without_extension, template_extensions)
results = []
files.each do |file|
match = if file.start_with?(path)
path
else
path_without_extension
end
processable_extensions = file[(match.length + 1)..-1].split(".")
# All processable_extensions must be processable
# by a template_extension
next unless (processable_extensions - template_extensions).empty?
if file.start_with?(path)
# The whole path is found in the filename, not just
# the path without the extension.
# it must have priority over all else
results.unshift(file)
else
results.push(file)
end
end
results
end
|
ruby
|
def filter_files(files, path, path_without_extension, template_extensions)
results = []
files.each do |file|
match = if file.start_with?(path)
path
else
path_without_extension
end
processable_extensions = file[(match.length + 1)..-1].split(".")
# All processable_extensions must be processable
# by a template_extension
next unless (processable_extensions - template_extensions).empty?
if file.start_with?(path)
# The whole path is found in the filename, not just
# the path without the extension.
# it must have priority over all else
results.unshift(file)
else
results.push(file)
end
end
results
end
|
[
"def",
"filter_files",
"(",
"files",
",",
"path",
",",
"path_without_extension",
",",
"template_extensions",
")",
"results",
"=",
"[",
"]",
"files",
".",
"each",
"do",
"|",
"file",
"|",
"match",
"=",
"if",
"file",
".",
"start_with?",
"(",
"path",
")",
"path",
"else",
"path_without_extension",
"end",
"processable_extensions",
"=",
"file",
"[",
"(",
"match",
".",
"length",
"+",
"1",
")",
"..",
"-",
"1",
"]",
".",
"split",
"(",
"\".\"",
")",
"# All processable_extensions must be processable",
"# by a template_extension",
"next",
"unless",
"(",
"processable_extensions",
"-",
"template_extensions",
")",
".",
"empty?",
"if",
"file",
".",
"start_with?",
"(",
"path",
")",
"# The whole path is found in the filename, not just",
"# the path without the extension.",
"# it must have priority over all else",
"results",
".",
"unshift",
"(",
"file",
")",
"else",
"results",
".",
"push",
"(",
"file",
")",
"end",
"end",
"results",
"end"
] |
Filter a list of files to see wether or not we can process them.
Will take into account that the longest match with path will
be the first result.
|
[
"Filter",
"a",
"list",
"of",
"files",
"to",
"see",
"wether",
"or",
"not",
"we",
"can",
"process",
"them",
".",
"Will",
"take",
"into",
"account",
"that",
"the",
"longest",
"match",
"with",
"path",
"will",
"be",
"the",
"first",
"result",
"."
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/resolver.rb#L150-L176
|
21,071
|
DigitPaint/roger
|
lib/roger/resolver.rb
|
Roger.Resolver.sanitize_name
|
def sanitize_name(name, prefer = nil)
path = name.to_s
# Check if we haven't got an extension
# we'll assume you're looking for prefer or "html" otherwise
path += ".#{prefer || 'html'}" unless File.basename(path).include?(".")
path
end
|
ruby
|
def sanitize_name(name, prefer = nil)
path = name.to_s
# Check if we haven't got an extension
# we'll assume you're looking for prefer or "html" otherwise
path += ".#{prefer || 'html'}" unless File.basename(path).include?(".")
path
end
|
[
"def",
"sanitize_name",
"(",
"name",
",",
"prefer",
"=",
"nil",
")",
"path",
"=",
"name",
".",
"to_s",
"# Check if we haven't got an extension",
"# we'll assume you're looking for prefer or \"html\" otherwise",
"path",
"+=",
"\".#{prefer || 'html'}\"",
"unless",
"File",
".",
"basename",
"(",
"path",
")",
".",
"include?",
"(",
"\".\"",
")",
"path",
"end"
] |
Check if the name is a directory and append index
Append preferred extension or html if it doesn't have one yet
|
[
"Check",
"if",
"the",
"name",
"is",
"a",
"directory",
"and",
"append",
"index",
"Append",
"preferred",
"extension",
"or",
"html",
"if",
"it",
"doesn",
"t",
"have",
"one",
"yet"
] |
1153119f170d1b0289b659a52fcbf054df2d9633
|
https://github.com/DigitPaint/roger/blob/1153119f170d1b0289b659a52fcbf054df2d9633/lib/roger/resolver.rb#L180-L188
|
21,072
|
para-cms/para
|
lib/para/cloneable.rb
|
Para.Cloneable.build_clone_callback
|
def build_clone_callback(callback)
case callback
when Proc
callback
when Symbol
->(original, clone) {
original.send(callback, clone) if original.respond_to?(callback, true)
}
end
end
|
ruby
|
def build_clone_callback(callback)
case callback
when Proc
callback
when Symbol
->(original, clone) {
original.send(callback, clone) if original.respond_to?(callback, true)
}
end
end
|
[
"def",
"build_clone_callback",
"(",
"callback",
")",
"case",
"callback",
"when",
"Proc",
"callback",
"when",
"Symbol",
"->",
"(",
"original",
",",
"clone",
")",
"{",
"original",
".",
"send",
"(",
"callback",
",",
"clone",
")",
"if",
"original",
".",
"respond_to?",
"(",
"callback",
",",
"true",
")",
"}",
"end",
"end"
] |
We ensure that the passed callback is actually callable on the object
we're cloning. This is needed for associations because deep_cloneable
calls the callback for every associated object.
|
[
"We",
"ensure",
"that",
"the",
"passed",
"callback",
"is",
"actually",
"callable",
"on",
"the",
"object",
"we",
"re",
"cloning",
".",
"This",
"is",
"needed",
"for",
"associations",
"because",
"deep_cloneable",
"calls",
"the",
"callback",
"for",
"every",
"associated",
"object",
"."
] |
97364cf5ec91225d7f1a7665c47cd65514f2b072
|
https://github.com/para-cms/para/blob/97364cf5ec91225d7f1a7665c47cd65514f2b072/lib/para/cloneable.rb#L36-L45
|
21,073
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/benchmark/realtime_store.rb
|
MoreCoreExtensions.BenchmarkRealtimeStore.realtime_store
|
def realtime_store(hash, key)
ret = nil
r0 = Time.now
begin
ret = yield
ensure
r1 = Time.now
hash[key] = (hash[key] || 0) + (r1.to_f - r0.to_f)
end
ret
end
|
ruby
|
def realtime_store(hash, key)
ret = nil
r0 = Time.now
begin
ret = yield
ensure
r1 = Time.now
hash[key] = (hash[key] || 0) + (r1.to_f - r0.to_f)
end
ret
end
|
[
"def",
"realtime_store",
"(",
"hash",
",",
"key",
")",
"ret",
"=",
"nil",
"r0",
"=",
"Time",
".",
"now",
"begin",
"ret",
"=",
"yield",
"ensure",
"r1",
"=",
"Time",
".",
"now",
"hash",
"[",
"key",
"]",
"=",
"(",
"hash",
"[",
"key",
"]",
"||",
"0",
")",
"+",
"(",
"r1",
".",
"to_f",
"-",
"r0",
".",
"to_f",
")",
"end",
"ret",
"end"
] |
Stores the elapsed real time used to execute the given block in the given
hash for the given key and returns the result from the block. If the hash
already has a value for that key, the time is accumulated.
timings = {}
Benchmark.realtime_store(timings, :sleep) { sleep 2; "foo" } # => "foo"
timings # => {:sleep => 2.00}
Benchmark.realtime_store(timings, :sleep) { sleep 2; "bar" } # => "bar"
timings # => {:sleep => 4.00}
|
[
"Stores",
"the",
"elapsed",
"real",
"time",
"used",
"to",
"execute",
"the",
"given",
"block",
"in",
"the",
"given",
"hash",
"for",
"the",
"given",
"key",
"and",
"returns",
"the",
"result",
"from",
"the",
"block",
".",
"If",
"the",
"hash",
"already",
"has",
"a",
"value",
"for",
"that",
"key",
"the",
"time",
"is",
"accumulated",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/benchmark/realtime_store.rb#L16-L26
|
21,074
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/benchmark/realtime_store.rb
|
MoreCoreExtensions.BenchmarkRealtimeStore.realtime_block
|
def realtime_block(key, &block)
hash = current_realtime
if in_realtime_block?
ret = realtime_store(hash, key, &block)
return ret, hash
else
begin
self.current_realtime = hash
begin
ret = realtime_store(hash, key, &block)
return ret, hash
rescue Exception => err # rubocop:disable Lint/RescueException
err.define_singleton_method(:timings) { hash } unless err.respond_to?(:timings)
raise
ensure
delete_current_realtime
end
ensure
# A second layer of protection in case Timeout::Error struck right after
# setting self.current_realtime, or right before `delete_current_realtime`.
# In those cases, current_realtime might (wrongly) still exist.
delete_current_realtime if in_realtime_block?
end
end
end
|
ruby
|
def realtime_block(key, &block)
hash = current_realtime
if in_realtime_block?
ret = realtime_store(hash, key, &block)
return ret, hash
else
begin
self.current_realtime = hash
begin
ret = realtime_store(hash, key, &block)
return ret, hash
rescue Exception => err # rubocop:disable Lint/RescueException
err.define_singleton_method(:timings) { hash } unless err.respond_to?(:timings)
raise
ensure
delete_current_realtime
end
ensure
# A second layer of protection in case Timeout::Error struck right after
# setting self.current_realtime, or right before `delete_current_realtime`.
# In those cases, current_realtime might (wrongly) still exist.
delete_current_realtime if in_realtime_block?
end
end
end
|
[
"def",
"realtime_block",
"(",
"key",
",",
"&",
"block",
")",
"hash",
"=",
"current_realtime",
"if",
"in_realtime_block?",
"ret",
"=",
"realtime_store",
"(",
"hash",
",",
"key",
",",
"block",
")",
"return",
"ret",
",",
"hash",
"else",
"begin",
"self",
".",
"current_realtime",
"=",
"hash",
"begin",
"ret",
"=",
"realtime_store",
"(",
"hash",
",",
"key",
",",
"block",
")",
"return",
"ret",
",",
"hash",
"rescue",
"Exception",
"=>",
"err",
"# rubocop:disable Lint/RescueException",
"err",
".",
"define_singleton_method",
"(",
":timings",
")",
"{",
"hash",
"}",
"unless",
"err",
".",
"respond_to?",
"(",
":timings",
")",
"raise",
"ensure",
"delete_current_realtime",
"end",
"ensure",
"# A second layer of protection in case Timeout::Error struck right after",
"# setting self.current_realtime, or right before `delete_current_realtime`.",
"# In those cases, current_realtime might (wrongly) still exist.",
"delete_current_realtime",
"if",
"in_realtime_block?",
"end",
"end",
"end"
] |
Stores the elapsed real time used to execute the given block for the given
key and returns the hash as well as the result from the block. The hash is
stored globally, keyed on thread id, and is cleared once the topmost nested
call completes. If the hash already has a value for that key, the time is
accumulated.
Benchmark.realtime_block(:sleep) do
sleep 2
"foo"
end # => ["foo", {:sleep => 2.00}]
Benchmark.realtime_block(:outer_sleep) do
sleep 2
Benchmark.realtime_block(:inner_sleep) { sleep 2 }
"bar"
end # => ["bar", {:inner_sleep => 2.00, :outer_sleep => 4.00}]
Benchmark.realtime_block(:outer_sleep) do
sleep 2
2.times do
Benchmark.realtime_block(:inner_sleep) { sleep 2 }
end
"baz"
end # => ["baz", {:inner_sleep => 4.00, :outer_sleep => 6.00}]
|
[
"Stores",
"the",
"elapsed",
"real",
"time",
"used",
"to",
"execute",
"the",
"given",
"block",
"for",
"the",
"given",
"key",
"and",
"returns",
"the",
"hash",
"as",
"well",
"as",
"the",
"result",
"from",
"the",
"block",
".",
"The",
"hash",
"is",
"stored",
"globally",
"keyed",
"on",
"thread",
"id",
"and",
"is",
"cleared",
"once",
"the",
"topmost",
"nested",
"call",
"completes",
".",
"If",
"the",
"hash",
"already",
"has",
"a",
"value",
"for",
"that",
"key",
"the",
"time",
"is",
"accumulated",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/benchmark/realtime_store.rb#L52-L77
|
21,075
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/object/namespace.rb
|
MoreCoreExtensions.ObjectNamespace.in_namespace?
|
def in_namespace?(val)
val_ns = val.to_s.split("::")
val_ns == (kind_of?(Module) ? namespace : self.class.namespace)[0, val_ns.length]
end
|
ruby
|
def in_namespace?(val)
val_ns = val.to_s.split("::")
val_ns == (kind_of?(Module) ? namespace : self.class.namespace)[0, val_ns.length]
end
|
[
"def",
"in_namespace?",
"(",
"val",
")",
"val_ns",
"=",
"val",
".",
"to_s",
".",
"split",
"(",
"\"::\"",
")",
"val_ns",
"==",
"(",
"kind_of?",
"(",
"Module",
")",
"?",
"namespace",
":",
"self",
".",
"class",
".",
"namespace",
")",
"[",
"0",
",",
"val_ns",
".",
"length",
"]",
"end"
] |
Returns whether or not the object is in the given namespace.
Aaa::Bbb::Ccc::Ddd.in_namespace?(Aaa::Bbb) #=> true
Aaa::Bbb::Ccc::Ddd.new.in_namespace?(Aaa::Bbb) #=> true
Aaa::Bbb::Ccc::Eee.in_namespace?("Aaa::Bbb") #=> true
Aaa::Bbb::Ccc::Eee.in_namespace?(Aaa::Bbb::Ccc::Ddd) #=> false
|
[
"Returns",
"whether",
"or",
"not",
"the",
"object",
"is",
"in",
"the",
"given",
"namespace",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/object/namespace.rb#L12-L15
|
21,076
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/array/element_counts.rb
|
MoreCoreExtensions.ArrayElementCounts.element_counts
|
def element_counts
each_with_object(Hash.new(0)) do |i, h|
key = block_given? ? yield(i) : i
h[key] += 1
end
end
|
ruby
|
def element_counts
each_with_object(Hash.new(0)) do |i, h|
key = block_given? ? yield(i) : i
h[key] += 1
end
end
|
[
"def",
"element_counts",
"each_with_object",
"(",
"Hash",
".",
"new",
"(",
"0",
")",
")",
"do",
"|",
"i",
",",
"h",
"|",
"key",
"=",
"block_given?",
"?",
"yield",
"(",
"i",
")",
":",
"i",
"h",
"[",
"key",
"]",
"+=",
"1",
"end",
"end"
] |
Returns a Hash of each element to the count of those elements. Optionally
pass a block to count by a different criteria.
[1, 2, 3, 1, 3, 1].counts # => {1 => 3, 2 => 1, 3 => 2}
%w(a aa aaa a aaa a).counts { |i| i.length } # => {1 => 3, 2 => 1, 3 => 2}
|
[
"Returns",
"a",
"Hash",
"of",
"each",
"element",
"to",
"the",
"count",
"of",
"those",
"elements",
".",
"Optionally",
"pass",
"a",
"block",
"to",
"count",
"by",
"a",
"different",
"criteria",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/array/element_counts.rb#L9-L14
|
21,077
|
coub/raml_ruby
|
lib/raml/node/resource_type.rb
|
Raml.ResourceType.instantiate
|
def instantiate(params)
instance = Instance.new( *interpolate(params), @parent )
instance.apply_resource_type
instance
end
|
ruby
|
def instantiate(params)
instance = Instance.new( *interpolate(params), @parent )
instance.apply_resource_type
instance
end
|
[
"def",
"instantiate",
"(",
"params",
")",
"instance",
"=",
"Instance",
".",
"new",
"(",
"interpolate",
"(",
"params",
")",
",",
"@parent",
")",
"instance",
".",
"apply_resource_type",
"instance",
"end"
] |
Instantiate a new resource type with the given parameters.
@param params [Hash] the parameters to interpolate in the resource type.
@return [Raml::ResourceType::Instance] the instantiated resouce type.
|
[
"Instantiate",
"a",
"new",
"resource",
"type",
"with",
"the",
"given",
"parameters",
"."
] |
4f1ea4c4827693c37e4464f9809509dbdc1c0795
|
https://github.com/coub/raml_ruby/blob/4f1ea4c4827693c37e4464f9809509dbdc1c0795/lib/raml/node/resource_type.rb#L14-L18
|
21,078
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/range/step_value.rb
|
MoreCoreExtensions.RangeStepValue.step_value
|
def step_value(value)
if block_given?
return if self.begin > self.end
iter = self.begin
loop do
yield iter unless iter == self.end && exclude_end?
break if iter == self.end
iter += value
iter = self.end if iter > self.end
end
self
else
ret = []
step_value(value) { |v| ret << v }
ret
end
end
|
ruby
|
def step_value(value)
if block_given?
return if self.begin > self.end
iter = self.begin
loop do
yield iter unless iter == self.end && exclude_end?
break if iter == self.end
iter += value
iter = self.end if iter > self.end
end
self
else
ret = []
step_value(value) { |v| ret << v }
ret
end
end
|
[
"def",
"step_value",
"(",
"value",
")",
"if",
"block_given?",
"return",
"if",
"self",
".",
"begin",
">",
"self",
".",
"end",
"iter",
"=",
"self",
".",
"begin",
"loop",
"do",
"yield",
"iter",
"unless",
"iter",
"==",
"self",
".",
"end",
"&&",
"exclude_end?",
"break",
"if",
"iter",
"==",
"self",
".",
"end",
"iter",
"+=",
"value",
"iter",
"=",
"self",
".",
"end",
"if",
"iter",
">",
"self",
".",
"end",
"end",
"self",
"else",
"ret",
"=",
"[",
"]",
"step_value",
"(",
"value",
")",
"{",
"|",
"v",
"|",
"ret",
"<<",
"v",
"}",
"ret",
"end",
"end"
] |
Iterates over rng, starting with the beginning of rng, incrementing by the
value, and passing that element to the block. Unlike +step+, +step_value+
invokes the + operator to iterate over the range elements. Unless the end is
excluded from the range, the final value of the iteration will always be the
end value, even if the increment value goes past the end of the range.
This method has performance benefits over +step+ when working with ranges of
Time objects, for example, where step calling succ may be called an
inordinate number of times.
t = Time.now.midnight
range = (t - 3.days)..t
range.step_value(1.day) {|x| puts x}
produces:
Tue Dec 14 00:00:00 -0500 2010
Wed Dec 15 00:00:00 -0500 2010
Thu Dec 16 00:00:00 -0500 2010
Fri Dec 17 00:00:00 -0500 2010
|
[
"Iterates",
"over",
"rng",
"starting",
"with",
"the",
"beginning",
"of",
"rng",
"incrementing",
"by",
"the",
"value",
"and",
"passing",
"that",
"element",
"to",
"the",
"block",
".",
"Unlike",
"+",
"step",
"+",
"+",
"step_value",
"+",
"invokes",
"the",
"+",
"operator",
"to",
"iterate",
"over",
"the",
"range",
"elements",
".",
"Unless",
"the",
"end",
"is",
"excluded",
"from",
"the",
"range",
"the",
"final",
"value",
"of",
"the",
"iteration",
"will",
"always",
"be",
"the",
"end",
"value",
"even",
"if",
"the",
"increment",
"value",
"goes",
"past",
"the",
"end",
"of",
"the",
"range",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/range/step_value.rb#L23-L41
|
21,079
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/array/inclusions.rb
|
MoreCoreExtensions.ArrayInclusions.include_any?
|
def include_any?(*items)
items = items.first if items.length == 1 && items.first.kind_of?(Array)
!(self & items).empty?
end
|
ruby
|
def include_any?(*items)
items = items.first if items.length == 1 && items.first.kind_of?(Array)
!(self & items).empty?
end
|
[
"def",
"include_any?",
"(",
"*",
"items",
")",
"items",
"=",
"items",
".",
"first",
"if",
"items",
".",
"length",
"==",
"1",
"&&",
"items",
".",
"first",
".",
"kind_of?",
"(",
"Array",
")",
"!",
"(",
"self",
"&",
"items",
")",
".",
"empty?",
"end"
] |
Returns whether the Array contains any of the items.
[1, 2, 3].include_any?(1, 2) #=> true
[1, 2, 3].include_any?(1, 4) #=> true
[1, 2, 3].include_any?(4, 5) #=> false
|
[
"Returns",
"whether",
"the",
"Array",
"contains",
"any",
"of",
"the",
"items",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/array/inclusions.rb#L9-L12
|
21,080
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/array/inclusions.rb
|
MoreCoreExtensions.ArrayInclusions.include_none?
|
def include_none?(*items)
items = items.first if items.length == 1 && items.first.kind_of?(Array)
(self & items).empty?
end
|
ruby
|
def include_none?(*items)
items = items.first if items.length == 1 && items.first.kind_of?(Array)
(self & items).empty?
end
|
[
"def",
"include_none?",
"(",
"*",
"items",
")",
"items",
"=",
"items",
".",
"first",
"if",
"items",
".",
"length",
"==",
"1",
"&&",
"items",
".",
"first",
".",
"kind_of?",
"(",
"Array",
")",
"(",
"self",
"&",
"items",
")",
".",
"empty?",
"end"
] |
Returns whether the Array contains none of the items.
[1, 2, 3].include_none?(1, 2) #=> false
[1, 2, 3].include_none?(1, 4) #=> false
[1, 2, 3].include_none?(4, 5) #=> true
|
[
"Returns",
"whether",
"the",
"Array",
"contains",
"none",
"of",
"the",
"items",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/array/inclusions.rb#L20-L23
|
21,081
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/array/inclusions.rb
|
MoreCoreExtensions.ArrayInclusions.include_all?
|
def include_all?(*items)
items = items.first if items.length == 1 && items.first.kind_of?(Array)
(items - self).empty?
end
|
ruby
|
def include_all?(*items)
items = items.first if items.length == 1 && items.first.kind_of?(Array)
(items - self).empty?
end
|
[
"def",
"include_all?",
"(",
"*",
"items",
")",
"items",
"=",
"items",
".",
"first",
"if",
"items",
".",
"length",
"==",
"1",
"&&",
"items",
".",
"first",
".",
"kind_of?",
"(",
"Array",
")",
"(",
"items",
"-",
"self",
")",
".",
"empty?",
"end"
] |
Returns whether the Array contains all of the items.
[1, 2, 3].include_all?(1, 2) #=> true
[1, 2, 3].include_all?(1, 4) #=> false
[1, 2, 3].include_all?(4, 5) #=> false
|
[
"Returns",
"whether",
"the",
"Array",
"contains",
"all",
"of",
"the",
"items",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/array/inclusions.rb#L31-L34
|
21,082
|
thoughtbot/hoptoad_notifier
|
lib/airbrake/sender.rb
|
Airbrake.Sender.send_to_airbrake
|
def send_to_airbrake(data)
logger.debug { "Sending request to #{url.to_s}:\n#{data}" } if logger
http =
Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass).
new(url.host, url.port)
http.read_timeout = http_read_timeout
http.open_timeout = http_open_timeout
if secure
http.use_ssl = true
http.ca_file = OpenSSL::X509::DEFAULT_CERT_FILE if File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
else
http.use_ssl = false
end
response = begin
http.post(url.path, data, HEADERS)
rescue *HTTP_ERRORS => e
log :error, "Timeout while contacting the Airbrake server."
nil
end
case response
when Net::HTTPSuccess then
log :info, "Success: #{response.class}", response
else
log :error, "Failure: #{response.class}", response
end
if response && response.respond_to?(:body)
error_id = response.body.match(%r{<error-id[^>]*>(.*?)</error-id>})
error_id[1] if error_id
end
end
|
ruby
|
def send_to_airbrake(data)
logger.debug { "Sending request to #{url.to_s}:\n#{data}" } if logger
http =
Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass).
new(url.host, url.port)
http.read_timeout = http_read_timeout
http.open_timeout = http_open_timeout
if secure
http.use_ssl = true
http.ca_file = OpenSSL::X509::DEFAULT_CERT_FILE if File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
else
http.use_ssl = false
end
response = begin
http.post(url.path, data, HEADERS)
rescue *HTTP_ERRORS => e
log :error, "Timeout while contacting the Airbrake server."
nil
end
case response
when Net::HTTPSuccess then
log :info, "Success: #{response.class}", response
else
log :error, "Failure: #{response.class}", response
end
if response && response.respond_to?(:body)
error_id = response.body.match(%r{<error-id[^>]*>(.*?)</error-id>})
error_id[1] if error_id
end
end
|
[
"def",
"send_to_airbrake",
"(",
"data",
")",
"logger",
".",
"debug",
"{",
"\"Sending request to #{url.to_s}:\\n#{data}\"",
"}",
"if",
"logger",
"http",
"=",
"Net",
"::",
"HTTP",
"::",
"Proxy",
"(",
"proxy_host",
",",
"proxy_port",
",",
"proxy_user",
",",
"proxy_pass",
")",
".",
"new",
"(",
"url",
".",
"host",
",",
"url",
".",
"port",
")",
"http",
".",
"read_timeout",
"=",
"http_read_timeout",
"http",
".",
"open_timeout",
"=",
"http_open_timeout",
"if",
"secure",
"http",
".",
"use_ssl",
"=",
"true",
"http",
".",
"ca_file",
"=",
"OpenSSL",
"::",
"X509",
"::",
"DEFAULT_CERT_FILE",
"if",
"File",
".",
"exist?",
"(",
"OpenSSL",
"::",
"X509",
"::",
"DEFAULT_CERT_FILE",
")",
"http",
".",
"verify_mode",
"=",
"OpenSSL",
"::",
"SSL",
"::",
"VERIFY_PEER",
"else",
"http",
".",
"use_ssl",
"=",
"false",
"end",
"response",
"=",
"begin",
"http",
".",
"post",
"(",
"url",
".",
"path",
",",
"data",
",",
"HEADERS",
")",
"rescue",
"HTTP_ERRORS",
"=>",
"e",
"log",
":error",
",",
"\"Timeout while contacting the Airbrake server.\"",
"nil",
"end",
"case",
"response",
"when",
"Net",
"::",
"HTTPSuccess",
"then",
"log",
":info",
",",
"\"Success: #{response.class}\"",
",",
"response",
"else",
"log",
":error",
",",
"\"Failure: #{response.class}\"",
",",
"response",
"end",
"if",
"response",
"&&",
"response",
".",
"respond_to?",
"(",
":body",
")",
"error_id",
"=",
"response",
".",
"body",
".",
"match",
"(",
"%r{",
"}",
")",
"error_id",
"[",
"1",
"]",
"if",
"error_id",
"end",
"end"
] |
Sends the notice data off to Airbrake for processing.
@param [String] data The XML notice to be sent off
|
[
"Sends",
"the",
"notice",
"data",
"off",
"to",
"Airbrake",
"for",
"processing",
"."
] |
50c5ca4e87b9086a064053fc6f95d4d097296f77
|
https://github.com/thoughtbot/hoptoad_notifier/blob/50c5ca4e87b9086a064053fc6f95d4d097296f77/lib/airbrake/sender.rb#L25-L61
|
21,083
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/object/descendants.rb
|
MoreCoreExtensions.Descendants.descendant_get
|
def descendant_get(desc_name)
return self if desc_name == name || desc_name.nil?
klass = descendants.find { |desc| desc.name == desc_name }
raise ArgumentError, "#{desc_name} is not a descendant of #{name}" unless klass
klass
end
|
ruby
|
def descendant_get(desc_name)
return self if desc_name == name || desc_name.nil?
klass = descendants.find { |desc| desc.name == desc_name }
raise ArgumentError, "#{desc_name} is not a descendant of #{name}" unless klass
klass
end
|
[
"def",
"descendant_get",
"(",
"desc_name",
")",
"return",
"self",
"if",
"desc_name",
"==",
"name",
"||",
"desc_name",
".",
"nil?",
"klass",
"=",
"descendants",
".",
"find",
"{",
"|",
"desc",
"|",
"desc",
".",
"name",
"==",
"desc_name",
"}",
"raise",
"ArgumentError",
",",
"\"#{desc_name} is not a descendant of #{name}\"",
"unless",
"klass",
"klass",
"end"
] |
Retrieve a descendant by its name
|
[
"Retrieve",
"a",
"descendant",
"by",
"its",
"name"
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/object/descendants.rb#L8-L13
|
21,084
|
coub/raml_ruby
|
lib/raml/node/root.rb
|
Raml.Root.expand
|
def expand
unless @expanded
resources.values.each(&:apply_resource_type)
resources.values.each(&:apply_traits)
inline_reference SchemaReference, schemas, @children
@expanded = true
end
end
|
ruby
|
def expand
unless @expanded
resources.values.each(&:apply_resource_type)
resources.values.each(&:apply_traits)
inline_reference SchemaReference, schemas, @children
@expanded = true
end
end
|
[
"def",
"expand",
"unless",
"@expanded",
"resources",
".",
"values",
".",
"each",
"(",
":apply_resource_type",
")",
"resources",
".",
"values",
".",
"each",
"(",
":apply_traits",
")",
"inline_reference",
"SchemaReference",
",",
"schemas",
",",
"@children",
"@expanded",
"=",
"true",
"end",
"end"
] |
Applies resource types and traits, and inlines schemas. It should be called
before documentation is generated.
|
[
"Applies",
"resource",
"types",
"and",
"traits",
"and",
"inlines",
"schemas",
".",
"It",
"should",
"be",
"called",
"before",
"documentation",
"is",
"generated",
"."
] |
4f1ea4c4827693c37e4464f9809509dbdc1c0795
|
https://github.com/coub/raml_ruby/blob/4f1ea4c4827693c37e4464f9809509dbdc1c0795/lib/raml/node/root.rb#L82-L89
|
21,085
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/array/stretch.rb
|
MoreCoreExtensions.ArrayStretch.stretch!
|
def stretch!(*arys)
max_size = (arys + [self]).collect { |a| a.length }.max
self[max_size - 1] = nil unless self.length == max_size
return self
end
|
ruby
|
def stretch!(*arys)
max_size = (arys + [self]).collect { |a| a.length }.max
self[max_size - 1] = nil unless self.length == max_size
return self
end
|
[
"def",
"stretch!",
"(",
"*",
"arys",
")",
"max_size",
"=",
"(",
"arys",
"+",
"[",
"self",
"]",
")",
".",
"collect",
"{",
"|",
"a",
"|",
"a",
".",
"length",
"}",
".",
"max",
"self",
"[",
"max_size",
"-",
"1",
"]",
"=",
"nil",
"unless",
"self",
".",
"length",
"==",
"max_size",
"return",
"self",
"end"
] |
Stretch receiver to be the same size as the longest argument Array. Modifies the receiver in place.
[1, 2].stretch!([3, 4], [5, 6, 7]) #=> [1, 2, nil]
|
[
"Stretch",
"receiver",
"to",
"be",
"the",
"same",
"size",
"as",
"the",
"longest",
"argument",
"Array",
".",
"Modifies",
"the",
"receiver",
"in",
"place",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/array/stretch.rb#L31-L35
|
21,086
|
thoughtbot/hoptoad_notifier
|
lib/airbrake/notice.rb
|
Airbrake.Notice.to_xml
|
def to_xml
builder = Builder::XmlMarkup.new
builder.instruct!
xml = builder.notice(:version => Airbrake::API_VERSION) do |notice|
notice.tag!("api-key", api_key)
notice.notifier do |notifier|
notifier.name(notifier_name)
notifier.version(notifier_version)
notifier.url(notifier_url)
end
notice.error do |error|
error.tag!('class', error_class)
error.message(error_message)
error.backtrace do |backtrace|
self.backtrace.lines.each do |line|
backtrace.line(:number => line.number,
:file => line.file,
:method => line.method)
end
end
end
if url ||
controller ||
action ||
!parameters.blank? ||
!cgi_data.blank? ||
!session_data.blank?
notice.request do |request|
request.url(url)
request.component(controller)
request.action(action)
unless parameters.nil? || parameters.empty?
request.params do |params|
xml_vars_for(params, parameters)
end
end
unless session_data.nil? || session_data.empty?
request.session do |session|
xml_vars_for(session, session_data)
end
end
unless cgi_data.nil? || cgi_data.empty?
request.tag!("cgi-data") do |cgi_datum|
xml_vars_for(cgi_datum, cgi_data)
end
end
end
end
notice.tag!("server-environment") do |env|
env.tag!("project-root", project_root)
env.tag!("environment-name", environment_name)
env.tag!("hostname", hostname)
end
end
xml.to_s
end
|
ruby
|
def to_xml
builder = Builder::XmlMarkup.new
builder.instruct!
xml = builder.notice(:version => Airbrake::API_VERSION) do |notice|
notice.tag!("api-key", api_key)
notice.notifier do |notifier|
notifier.name(notifier_name)
notifier.version(notifier_version)
notifier.url(notifier_url)
end
notice.error do |error|
error.tag!('class', error_class)
error.message(error_message)
error.backtrace do |backtrace|
self.backtrace.lines.each do |line|
backtrace.line(:number => line.number,
:file => line.file,
:method => line.method)
end
end
end
if url ||
controller ||
action ||
!parameters.blank? ||
!cgi_data.blank? ||
!session_data.blank?
notice.request do |request|
request.url(url)
request.component(controller)
request.action(action)
unless parameters.nil? || parameters.empty?
request.params do |params|
xml_vars_for(params, parameters)
end
end
unless session_data.nil? || session_data.empty?
request.session do |session|
xml_vars_for(session, session_data)
end
end
unless cgi_data.nil? || cgi_data.empty?
request.tag!("cgi-data") do |cgi_datum|
xml_vars_for(cgi_datum, cgi_data)
end
end
end
end
notice.tag!("server-environment") do |env|
env.tag!("project-root", project_root)
env.tag!("environment-name", environment_name)
env.tag!("hostname", hostname)
end
end
xml.to_s
end
|
[
"def",
"to_xml",
"builder",
"=",
"Builder",
"::",
"XmlMarkup",
".",
"new",
"builder",
".",
"instruct!",
"xml",
"=",
"builder",
".",
"notice",
"(",
":version",
"=>",
"Airbrake",
"::",
"API_VERSION",
")",
"do",
"|",
"notice",
"|",
"notice",
".",
"tag!",
"(",
"\"api-key\"",
",",
"api_key",
")",
"notice",
".",
"notifier",
"do",
"|",
"notifier",
"|",
"notifier",
".",
"name",
"(",
"notifier_name",
")",
"notifier",
".",
"version",
"(",
"notifier_version",
")",
"notifier",
".",
"url",
"(",
"notifier_url",
")",
"end",
"notice",
".",
"error",
"do",
"|",
"error",
"|",
"error",
".",
"tag!",
"(",
"'class'",
",",
"error_class",
")",
"error",
".",
"message",
"(",
"error_message",
")",
"error",
".",
"backtrace",
"do",
"|",
"backtrace",
"|",
"self",
".",
"backtrace",
".",
"lines",
".",
"each",
"do",
"|",
"line",
"|",
"backtrace",
".",
"line",
"(",
":number",
"=>",
"line",
".",
"number",
",",
":file",
"=>",
"line",
".",
"file",
",",
":method",
"=>",
"line",
".",
"method",
")",
"end",
"end",
"end",
"if",
"url",
"||",
"controller",
"||",
"action",
"||",
"!",
"parameters",
".",
"blank?",
"||",
"!",
"cgi_data",
".",
"blank?",
"||",
"!",
"session_data",
".",
"blank?",
"notice",
".",
"request",
"do",
"|",
"request",
"|",
"request",
".",
"url",
"(",
"url",
")",
"request",
".",
"component",
"(",
"controller",
")",
"request",
".",
"action",
"(",
"action",
")",
"unless",
"parameters",
".",
"nil?",
"||",
"parameters",
".",
"empty?",
"request",
".",
"params",
"do",
"|",
"params",
"|",
"xml_vars_for",
"(",
"params",
",",
"parameters",
")",
"end",
"end",
"unless",
"session_data",
".",
"nil?",
"||",
"session_data",
".",
"empty?",
"request",
".",
"session",
"do",
"|",
"session",
"|",
"xml_vars_for",
"(",
"session",
",",
"session_data",
")",
"end",
"end",
"unless",
"cgi_data",
".",
"nil?",
"||",
"cgi_data",
".",
"empty?",
"request",
".",
"tag!",
"(",
"\"cgi-data\"",
")",
"do",
"|",
"cgi_datum",
"|",
"xml_vars_for",
"(",
"cgi_datum",
",",
"cgi_data",
")",
"end",
"end",
"end",
"end",
"notice",
".",
"tag!",
"(",
"\"server-environment\"",
")",
"do",
"|",
"env",
"|",
"env",
".",
"tag!",
"(",
"\"project-root\"",
",",
"project_root",
")",
"env",
".",
"tag!",
"(",
"\"environment-name\"",
",",
"environment_name",
")",
"env",
".",
"tag!",
"(",
"\"hostname\"",
",",
"hostname",
")",
"end",
"end",
"xml",
".",
"to_s",
"end"
] |
Converts the given notice to XML
|
[
"Converts",
"the",
"given",
"notice",
"to",
"XML"
] |
50c5ca4e87b9086a064053fc6f95d4d097296f77
|
https://github.com/thoughtbot/hoptoad_notifier/blob/50c5ca4e87b9086a064053fc6f95d4d097296f77/lib/airbrake/notice.rb#L111-L166
|
21,087
|
thoughtbot/hoptoad_notifier
|
lib/airbrake/notice.rb
|
Airbrake.Notice.exception_attribute
|
def exception_attribute(attribute, default = nil, &block)
(exception && from_exception(attribute, &block)) || args[attribute] || default
end
|
ruby
|
def exception_attribute(attribute, default = nil, &block)
(exception && from_exception(attribute, &block)) || args[attribute] || default
end
|
[
"def",
"exception_attribute",
"(",
"attribute",
",",
"default",
"=",
"nil",
",",
"&",
"block",
")",
"(",
"exception",
"&&",
"from_exception",
"(",
"attribute",
",",
"block",
")",
")",
"||",
"args",
"[",
"attribute",
"]",
"||",
"default",
"end"
] |
Gets a property named +attribute+ of an exception, either from an actual
exception or a hash.
If an exception is available, #from_exception will be used. Otherwise,
a key named +attribute+ will be used from the #args.
If no exception or hash key is available, +default+ will be used.
|
[
"Gets",
"a",
"property",
"named",
"+",
"attribute",
"+",
"of",
"an",
"exception",
"either",
"from",
"an",
"actual",
"exception",
"or",
"a",
"hash",
"."
] |
50c5ca4e87b9086a064053fc6f95d4d097296f77
|
https://github.com/thoughtbot/hoptoad_notifier/blob/50c5ca4e87b9086a064053fc6f95d4d097296f77/lib/airbrake/notice.rb#L207-L209
|
21,088
|
para-cms/para
|
app/helpers/para/model_helper.rb
|
Para.ModelHelper.model_field_mappings
|
def model_field_mappings(model, options = {})
if Array == options
whitelist_attributes = options
else
whitelist_attributes = options.fetch(:whitelist_attributes, nil)
mappings = options.fetch(:mappings, {})
end
Para::AttributeFieldMappings.new(
model, whitelist_attributes: whitelist_attributes, mappings: mappings
)
end
|
ruby
|
def model_field_mappings(model, options = {})
if Array == options
whitelist_attributes = options
else
whitelist_attributes = options.fetch(:whitelist_attributes, nil)
mappings = options.fetch(:mappings, {})
end
Para::AttributeFieldMappings.new(
model, whitelist_attributes: whitelist_attributes, mappings: mappings
)
end
|
[
"def",
"model_field_mappings",
"(",
"model",
",",
"options",
"=",
"{",
"}",
")",
"if",
"Array",
"==",
"options",
"whitelist_attributes",
"=",
"options",
"else",
"whitelist_attributes",
"=",
"options",
".",
"fetch",
"(",
":whitelist_attributes",
",",
"nil",
")",
"mappings",
"=",
"options",
".",
"fetch",
"(",
":mappings",
",",
"{",
"}",
")",
"end",
"Para",
"::",
"AttributeFieldMappings",
".",
"new",
"(",
"model",
",",
"whitelist_attributes",
":",
"whitelist_attributes",
",",
"mappings",
":",
"mappings",
")",
"end"
] |
Second argument can be the whitelist_attributes array or keyword
arguments. This is to ensure backwards compatibility with old plugins.
|
[
"Second",
"argument",
"can",
"be",
"the",
"whitelist_attributes",
"array",
"or",
"keyword",
"arguments",
".",
"This",
"is",
"to",
"ensure",
"backwards",
"compatibility",
"with",
"old",
"plugins",
"."
] |
97364cf5ec91225d7f1a7665c47cd65514f2b072
|
https://github.com/para-cms/para/blob/97364cf5ec91225d7f1a7665c47cd65514f2b072/app/helpers/para/model_helper.rb#L11-L22
|
21,089
|
ManageIQ/more_core_extensions
|
lib/more_core_extensions/core_ext/module/cache_with_timeout.rb
|
MoreCoreExtensions.CacheWithTimeout.cache_with_timeout
|
def cache_with_timeout(method, timeout = nil, &block)
raise "no block given" if block.nil?
raise ArgumentError, "method must be a Symbol" unless method.respond_to?(:to_sym)
key = "#{name}.#{method}".to_sym
$cache_with_timeout_lock.synchronize(:EX) do
$cache_with_timeout[key] = {}
end
define_singleton_method(method) do |*args|
force_reload = args.first
return $cache_with_timeout_lock.synchronize(:EX) do
cache = $cache_with_timeout[key]
old_timeout = cache[:timeout]
cache.clear if force_reload || (old_timeout && Time.now.utc > old_timeout)
break cache[:value] if cache.key?(:value)
new_timeout = timeout || 300 # 5 minutes
new_timeout = new_timeout.call if new_timeout.kind_of?(Proc)
new_timeout = Time.now.utc + new_timeout
new_value = block.call
cache[:timeout] = new_timeout
cache[:value] = new_value
end
end
define_singleton_method("#{method}_clear_cache") do |*_args|
$cache_with_timeout_lock.synchronize(:EX) do
$cache_with_timeout[key].clear
end
end
define_singleton_method("#{method}_cached?") do |*_args|
$cache_with_timeout_lock.synchronize(:EX) do
!$cache_with_timeout[key].empty?
end
end
method.to_sym
end
|
ruby
|
def cache_with_timeout(method, timeout = nil, &block)
raise "no block given" if block.nil?
raise ArgumentError, "method must be a Symbol" unless method.respond_to?(:to_sym)
key = "#{name}.#{method}".to_sym
$cache_with_timeout_lock.synchronize(:EX) do
$cache_with_timeout[key] = {}
end
define_singleton_method(method) do |*args|
force_reload = args.first
return $cache_with_timeout_lock.synchronize(:EX) do
cache = $cache_with_timeout[key]
old_timeout = cache[:timeout]
cache.clear if force_reload || (old_timeout && Time.now.utc > old_timeout)
break cache[:value] if cache.key?(:value)
new_timeout = timeout || 300 # 5 minutes
new_timeout = new_timeout.call if new_timeout.kind_of?(Proc)
new_timeout = Time.now.utc + new_timeout
new_value = block.call
cache[:timeout] = new_timeout
cache[:value] = new_value
end
end
define_singleton_method("#{method}_clear_cache") do |*_args|
$cache_with_timeout_lock.synchronize(:EX) do
$cache_with_timeout[key].clear
end
end
define_singleton_method("#{method}_cached?") do |*_args|
$cache_with_timeout_lock.synchronize(:EX) do
!$cache_with_timeout[key].empty?
end
end
method.to_sym
end
|
[
"def",
"cache_with_timeout",
"(",
"method",
",",
"timeout",
"=",
"nil",
",",
"&",
"block",
")",
"raise",
"\"no block given\"",
"if",
"block",
".",
"nil?",
"raise",
"ArgumentError",
",",
"\"method must be a Symbol\"",
"unless",
"method",
".",
"respond_to?",
"(",
":to_sym",
")",
"key",
"=",
"\"#{name}.#{method}\"",
".",
"to_sym",
"$cache_with_timeout_lock",
".",
"synchronize",
"(",
":EX",
")",
"do",
"$cache_with_timeout",
"[",
"key",
"]",
"=",
"{",
"}",
"end",
"define_singleton_method",
"(",
"method",
")",
"do",
"|",
"*",
"args",
"|",
"force_reload",
"=",
"args",
".",
"first",
"return",
"$cache_with_timeout_lock",
".",
"synchronize",
"(",
":EX",
")",
"do",
"cache",
"=",
"$cache_with_timeout",
"[",
"key",
"]",
"old_timeout",
"=",
"cache",
"[",
":timeout",
"]",
"cache",
".",
"clear",
"if",
"force_reload",
"||",
"(",
"old_timeout",
"&&",
"Time",
".",
"now",
".",
"utc",
">",
"old_timeout",
")",
"break",
"cache",
"[",
":value",
"]",
"if",
"cache",
".",
"key?",
"(",
":value",
")",
"new_timeout",
"=",
"timeout",
"||",
"300",
"# 5 minutes",
"new_timeout",
"=",
"new_timeout",
".",
"call",
"if",
"new_timeout",
".",
"kind_of?",
"(",
"Proc",
")",
"new_timeout",
"=",
"Time",
".",
"now",
".",
"utc",
"+",
"new_timeout",
"new_value",
"=",
"block",
".",
"call",
"cache",
"[",
":timeout",
"]",
"=",
"new_timeout",
"cache",
"[",
":value",
"]",
"=",
"new_value",
"end",
"end",
"define_singleton_method",
"(",
"\"#{method}_clear_cache\"",
")",
"do",
"|",
"*",
"_args",
"|",
"$cache_with_timeout_lock",
".",
"synchronize",
"(",
":EX",
")",
"do",
"$cache_with_timeout",
"[",
"key",
"]",
".",
"clear",
"end",
"end",
"define_singleton_method",
"(",
"\"#{method}_cached?\"",
")",
"do",
"|",
"*",
"_args",
"|",
"$cache_with_timeout_lock",
".",
"synchronize",
"(",
":EX",
")",
"do",
"!",
"$cache_with_timeout",
"[",
"key",
"]",
".",
"empty?",
"end",
"end",
"method",
".",
"to_sym",
"end"
] |
cache_with_timeout creates singleton methods that cache the
results of the given block, but only for a short amount of time.
If the method is called again after time has passed, then the
cache is cleared and the block is reevaluated. Note that the
cache is only cleared on the next invocation after the time has
passed, so if the block retains references to large objects,
they will never be garbage collected if the method is never
called again.
The methods created are
- `method`
- `#{method}_clear_cache` - Will clear the cached value on demand
- `#{method}_cached?` - Says whether or not there is a value cached
Example:
class Foo
cache_with_timeout(:expensive_operation) do
sleep 100
rand(100)
end
end
Foo.expensive_operation # => 42
Foo.expensive_operation # => 42
# ... wait 5+ minutes ...
Foo.expensive_operation # => 18
@param [String|Symbol] method The name of the method to create.
@param [Integer] timeout The number of seconds after which the cache is
cleared (defaults to: 300 (5 minutes))
@returns [Symbol] The name of the method created.
|
[
"cache_with_timeout",
"creates",
"singleton",
"methods",
"that",
"cache",
"the",
"results",
"of",
"the",
"given",
"block",
"but",
"only",
"for",
"a",
"short",
"amount",
"of",
"time",
".",
"If",
"the",
"method",
"is",
"called",
"again",
"after",
"time",
"has",
"passed",
"then",
"the",
"cache",
"is",
"cleared",
"and",
"the",
"block",
"is",
"reevaluated",
".",
"Note",
"that",
"the",
"cache",
"is",
"only",
"cleared",
"on",
"the",
"next",
"invocation",
"after",
"the",
"time",
"has",
"passed",
"so",
"if",
"the",
"block",
"retains",
"references",
"to",
"large",
"objects",
"they",
"will",
"never",
"be",
"garbage",
"collected",
"if",
"the",
"method",
"is",
"never",
"called",
"again",
"."
] |
13f97a2a07155354117ea638eb0892fad09d5e44
|
https://github.com/ManageIQ/more_core_extensions/blob/13f97a2a07155354117ea638eb0892fad09d5e44/lib/more_core_extensions/core_ext/module/cache_with_timeout.rb#L39-L81
|
21,090
|
OTL/rosruby
|
lib/ros/name.rb
|
ROS.Name.resolve_name_with_call_id
|
def resolve_name_with_call_id(caller_id, ns, name, remappings)
name = canonicalize_name(expand_local_name(caller_id, name))
if remappings
remappings.each_pair do |key, value|
if name == canonicalize_name(key)
name = value
end
end
end
if ns
name = ns + SEP + name
end
return canonicalize_name(name)
end
|
ruby
|
def resolve_name_with_call_id(caller_id, ns, name, remappings)
name = canonicalize_name(expand_local_name(caller_id, name))
if remappings
remappings.each_pair do |key, value|
if name == canonicalize_name(key)
name = value
end
end
end
if ns
name = ns + SEP + name
end
return canonicalize_name(name)
end
|
[
"def",
"resolve_name_with_call_id",
"(",
"caller_id",
",",
"ns",
",",
"name",
",",
"remappings",
")",
"name",
"=",
"canonicalize_name",
"(",
"expand_local_name",
"(",
"caller_id",
",",
"name",
")",
")",
"if",
"remappings",
"remappings",
".",
"each_pair",
"do",
"|",
"key",
",",
"value",
"|",
"if",
"name",
"==",
"canonicalize_name",
"(",
"key",
")",
"name",
"=",
"value",
"end",
"end",
"end",
"if",
"ns",
"name",
"=",
"ns",
"+",
"SEP",
"+",
"name",
"end",
"return",
"canonicalize_name",
"(",
"name",
")",
"end"
] |
expand local, canonicalize, remappings
@param [String] caller_id caller_id
@param [String] ns namespace
@param [String] name target name
@param [Array] remappings name remappings
@return [String] resolved name
|
[
"expand",
"local",
"canonicalize",
"remappings"
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/name.rb#L73-L86
|
21,091
|
OTL/rosruby
|
lib/ros/tcpros/service_server.rb
|
ROS::TCPROS.ServiceServer.read_and_callback
|
def read_and_callback(socket)
request = @service_type.request_class.new
response = @service_type.response_class.new
data = read_all(socket)
@byte_received += data.length
request.deserialize(data)
result = @callback.call(request, response)
if result
send_ok_byte(socket)
data = write_msg(socket, response)
@byte_sent += data.length
else
send_ng_byte(socket)
write_header(socket, build_header)
# write some message
end
result
end
|
ruby
|
def read_and_callback(socket)
request = @service_type.request_class.new
response = @service_type.response_class.new
data = read_all(socket)
@byte_received += data.length
request.deserialize(data)
result = @callback.call(request, response)
if result
send_ok_byte(socket)
data = write_msg(socket, response)
@byte_sent += data.length
else
send_ng_byte(socket)
write_header(socket, build_header)
# write some message
end
result
end
|
[
"def",
"read_and_callback",
"(",
"socket",
")",
"request",
"=",
"@service_type",
".",
"request_class",
".",
"new",
"response",
"=",
"@service_type",
".",
"response_class",
".",
"new",
"data",
"=",
"read_all",
"(",
"socket",
")",
"@byte_received",
"+=",
"data",
".",
"length",
"request",
".",
"deserialize",
"(",
"data",
")",
"result",
"=",
"@callback",
".",
"call",
"(",
"request",
",",
"response",
")",
"if",
"result",
"send_ok_byte",
"(",
"socket",
")",
"data",
"=",
"write_msg",
"(",
"socket",
",",
"response",
")",
"@byte_sent",
"+=",
"data",
".",
"length",
"else",
"send_ng_byte",
"(",
"socket",
")",
"write_header",
"(",
"socket",
",",
"build_header",
")",
"# write some message",
"end",
"result",
"end"
] |
main loop of this connection.
read data and do callback.
@param [IO] socket
@return [Boolean] result of callback
|
[
"main",
"loop",
"of",
"this",
"connection",
".",
"read",
"data",
"and",
"do",
"callback",
"."
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/tcpros/service_server.rb#L73-L90
|
21,092
|
OTL/rosruby
|
lib/ros/tcpros/service_server.rb
|
ROS::TCPROS.ServiceServer.serve
|
def serve(socket)
header = read_header(socket)
# not documented protocol?
if header['probe'] == '1'
write_header(socket, build_header)
elsif check_header(header)
write_header(socket, build_header)
read_and_callback(socket)
if header['persistent'] == '1'
loop do
read_and_callback(socket)
end
end
else
socket.close
raise 'header check error'
end
end
|
ruby
|
def serve(socket)
header = read_header(socket)
# not documented protocol?
if header['probe'] == '1'
write_header(socket, build_header)
elsif check_header(header)
write_header(socket, build_header)
read_and_callback(socket)
if header['persistent'] == '1'
loop do
read_and_callback(socket)
end
end
else
socket.close
raise 'header check error'
end
end
|
[
"def",
"serve",
"(",
"socket",
")",
"header",
"=",
"read_header",
"(",
"socket",
")",
"# not documented protocol?",
"if",
"header",
"[",
"'probe'",
"]",
"==",
"'1'",
"write_header",
"(",
"socket",
",",
"build_header",
")",
"elsif",
"check_header",
"(",
"header",
")",
"write_header",
"(",
"socket",
",",
"build_header",
")",
"read_and_callback",
"(",
"socket",
")",
"if",
"header",
"[",
"'persistent'",
"]",
"==",
"'1'",
"loop",
"do",
"read_and_callback",
"(",
"socket",
")",
"end",
"end",
"else",
"socket",
".",
"close",
"raise",
"'header check error'",
"end",
"end"
] |
this is called by socket accept
@param [IO] socket given socket
|
[
"this",
"is",
"called",
"by",
"socket",
"accept"
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/tcpros/service_server.rb#L95-L112
|
21,093
|
OTL/rosruby
|
lib/ros/publisher.rb
|
ROS.Publisher.add_connection
|
def add_connection(caller_id) #:nodoc:
connection = TCPROS::Server.new(@caller_id, @topic_name, @topic_type,
:host=>@host,
:latched=>@is_latched,
:last_published_msg=>@last_published_msg)
connection.start
connection.id = "#{@topic_name}_out_#{@connection_id_number}"
@connection_id_number += 1
@connections.push(connection)
return connection
end
|
ruby
|
def add_connection(caller_id) #:nodoc:
connection = TCPROS::Server.new(@caller_id, @topic_name, @topic_type,
:host=>@host,
:latched=>@is_latched,
:last_published_msg=>@last_published_msg)
connection.start
connection.id = "#{@topic_name}_out_#{@connection_id_number}"
@connection_id_number += 1
@connections.push(connection)
return connection
end
|
[
"def",
"add_connection",
"(",
"caller_id",
")",
"#:nodoc:",
"connection",
"=",
"TCPROS",
"::",
"Server",
".",
"new",
"(",
"@caller_id",
",",
"@topic_name",
",",
"@topic_type",
",",
":host",
"=>",
"@host",
",",
":latched",
"=>",
"@is_latched",
",",
":last_published_msg",
"=>",
"@last_published_msg",
")",
"connection",
".",
"start",
"connection",
".",
"id",
"=",
"\"#{@topic_name}_out_#{@connection_id_number}\"",
"@connection_id_number",
"+=",
"1",
"@connections",
".",
"push",
"(",
"connection",
")",
"return",
"connection",
"end"
] |
add tcpros connection as server
@param [String] caller_id caller_id of subscriber
@return [TCPROS::Server] connection object
|
[
"add",
"tcpros",
"connection",
"as",
"server"
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/publisher.rb#L61-L71
|
21,094
|
OTL/rosruby
|
lib/ros/tcpros/server.rb
|
ROS::TCPROS.Server.publish_msg
|
def publish_msg(socket, msg)
data = write_msg(socket, msg)
@last_published_msg = msg
# for getBusStats
@byte_sent += data.length
@num_sent += 1
end
|
ruby
|
def publish_msg(socket, msg)
data = write_msg(socket, msg)
@last_published_msg = msg
# for getBusStats
@byte_sent += data.length
@num_sent += 1
end
|
[
"def",
"publish_msg",
"(",
"socket",
",",
"msg",
")",
"data",
"=",
"write_msg",
"(",
"socket",
",",
"msg",
")",
"@last_published_msg",
"=",
"msg",
"# for getBusStats",
"@byte_sent",
"+=",
"data",
".",
"length",
"@num_sent",
"+=",
"1",
"end"
] |
send a message to reciever
@param [IO] socket socket for writing
@param [Class] msg msg class instance
|
[
"send",
"a",
"message",
"to",
"reciever"
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/tcpros/server.rb#L65-L71
|
21,095
|
OTL/rosruby
|
lib/ros/tcpros/server.rb
|
ROS::TCPROS.Server.serve
|
def serve(socket) #:nodoc:
header = read_header(socket)
if check_header(header)
if header['tcp_nodelay'] == '1'
socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
end
begin
write_header(socket, build_header)
if latching?
if @last_published_msg
publish_msg(socket, @last_published_msg)
end
end
loop do
@last_published_msg = @msg_queue.pop
publish_msg(socket, @last_published_msg)
end
rescue
socket.shutdown
end
else
socket.shutdown
p "header check error: #{header}"
raise 'header check error'
end
end
|
ruby
|
def serve(socket) #:nodoc:
header = read_header(socket)
if check_header(header)
if header['tcp_nodelay'] == '1'
socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
end
begin
write_header(socket, build_header)
if latching?
if @last_published_msg
publish_msg(socket, @last_published_msg)
end
end
loop do
@last_published_msg = @msg_queue.pop
publish_msg(socket, @last_published_msg)
end
rescue
socket.shutdown
end
else
socket.shutdown
p "header check error: #{header}"
raise 'header check error'
end
end
|
[
"def",
"serve",
"(",
"socket",
")",
"#:nodoc:",
"header",
"=",
"read_header",
"(",
"socket",
")",
"if",
"check_header",
"(",
"header",
")",
"if",
"header",
"[",
"'tcp_nodelay'",
"]",
"==",
"'1'",
"socket",
".",
"setsockopt",
"(",
"Socket",
"::",
"IPPROTO_TCP",
",",
"Socket",
"::",
"TCP_NODELAY",
",",
"1",
")",
"end",
"begin",
"write_header",
"(",
"socket",
",",
"build_header",
")",
"if",
"latching?",
"if",
"@last_published_msg",
"publish_msg",
"(",
"socket",
",",
"@last_published_msg",
")",
"end",
"end",
"loop",
"do",
"@last_published_msg",
"=",
"@msg_queue",
".",
"pop",
"publish_msg",
"(",
"socket",
",",
"@last_published_msg",
")",
"end",
"rescue",
"socket",
".",
"shutdown",
"end",
"else",
"socket",
".",
"shutdown",
"p",
"\"header check error: #{header}\"",
"raise",
"'header check error'",
"end",
"end"
] |
this is called if a socket accept a connection.
This is GServer's function
@param [IO] socket given socket
|
[
"this",
"is",
"called",
"if",
"a",
"socket",
"accept",
"a",
"connection",
".",
"This",
"is",
"GServer",
"s",
"function"
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/tcpros/server.rb#L77-L102
|
21,096
|
OTL/rosruby
|
lib/ros/parameter_manager.rb
|
ROS.ParameterManager.set_param
|
def set_param(key, value)
code, message, value = @server.call("setParam", @caller_id, key, value)
case code
when 1
return true
when -1
raise message
else
return false
end
end
|
ruby
|
def set_param(key, value)
code, message, value = @server.call("setParam", @caller_id, key, value)
case code
when 1
return true
when -1
raise message
else
return false
end
end
|
[
"def",
"set_param",
"(",
"key",
",",
"value",
")",
"code",
",",
"message",
",",
"value",
"=",
"@server",
".",
"call",
"(",
"\"setParam\"",
",",
"@caller_id",
",",
"key",
",",
"value",
")",
"case",
"code",
"when",
"1",
"return",
"true",
"when",
"-",
"1",
"raise",
"message",
"else",
"return",
"false",
"end",
"end"
] |
set parameter for 'key'
@param [String] key key of parameter
@param [String, Integer, Float, Boolean] value value of parameter
@return [Boolean] true if succeed
@raise
|
[
"set",
"parameter",
"for",
"key"
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/parameter_manager.rb#L53-L63
|
21,097
|
OTL/rosruby
|
lib/ros/parameter_manager.rb
|
ROS.ParameterManager.delete_param
|
def delete_param(key)
code, message, value = @server.call("deleteParam", @caller_id, key)
case code
when 1
return true
else
return false
end
end
|
ruby
|
def delete_param(key)
code, message, value = @server.call("deleteParam", @caller_id, key)
case code
when 1
return true
else
return false
end
end
|
[
"def",
"delete_param",
"(",
"key",
")",
"code",
",",
"message",
",",
"value",
"=",
"@server",
".",
"call",
"(",
"\"deleteParam\"",
",",
"@caller_id",
",",
"key",
")",
"case",
"code",
"when",
"1",
"return",
"true",
"else",
"return",
"false",
"end",
"end"
] |
delete parameter 'key'
@param [String] key key for remove
@return [Boolean] return true if success, false if it is not exist
|
[
"delete",
"parameter",
"key"
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/parameter_manager.rb#L69-L77
|
21,098
|
OTL/rosruby
|
lib/ros/parameter_manager.rb
|
ROS.ParameterManager.search_param
|
def search_param(key)
code, message, value = @server.call("searchParam", @caller_id, key)
case code
when 1
return value
when -1
raise message
else
return false
end
end
|
ruby
|
def search_param(key)
code, message, value = @server.call("searchParam", @caller_id, key)
case code
when 1
return value
when -1
raise message
else
return false
end
end
|
[
"def",
"search_param",
"(",
"key",
")",
"code",
",",
"message",
",",
"value",
"=",
"@server",
".",
"call",
"(",
"\"searchParam\"",
",",
"@caller_id",
",",
"key",
")",
"case",
"code",
"when",
"1",
"return",
"value",
"when",
"-",
"1",
"raise",
"message",
"else",
"return",
"false",
"end",
"end"
] |
search the all namespace for key
@param [String] key key for search
@return [Array] values
|
[
"search",
"the",
"all",
"namespace",
"for",
"key"
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/parameter_manager.rb#L83-L93
|
21,099
|
OTL/rosruby
|
lib/ros/parameter_manager.rb
|
ROS.ParameterManager.has_param
|
def has_param(key)
code, message, value = @server.call("hasParam", @caller_id, key)
case code
when 1
return value
when -1
raise message
else
return false
end
end
|
ruby
|
def has_param(key)
code, message, value = @server.call("hasParam", @caller_id, key)
case code
when 1
return value
when -1
raise message
else
return false
end
end
|
[
"def",
"has_param",
"(",
"key",
")",
"code",
",",
"message",
",",
"value",
"=",
"@server",
".",
"call",
"(",
"\"hasParam\"",
",",
"@caller_id",
",",
"key",
")",
"case",
"code",
"when",
"1",
"return",
"value",
"when",
"-",
"1",
"raise",
"message",
"else",
"return",
"false",
"end",
"end"
] |
check if the master has the key
@param [String] key key for check
@return [String, Integer, Float, Boolean] value of key
|
[
"check",
"if",
"the",
"master",
"has",
"the",
"key"
] |
dc29af423241167ab9060b40366b4616a62c5f11
|
https://github.com/OTL/rosruby/blob/dc29af423241167ab9060b40366b4616a62c5f11/lib/ros/parameter_manager.rb#L99-L109
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.