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
10,700
fluent/fluentd
lib/fluent/plugin/out_forward.rb
Fluent::Plugin.ForwardOutput.read_ack_from_sock
def read_ack_from_sock(sock, unpacker) begin raw_data = sock.instance_of?(Fluent::PluginHelper::Socket::WrappedSocket::TLS) ? sock.readpartial(@read_length) : sock.recv(@read_length) rescue Errno::ECONNRESET, EOFError # ECONNRESET for #recv, #EOFError for #readpartial raw_data = "" end info = @sock_ack_waiting_mutex.synchronize{ @sock_ack_waiting.find{|i| i.sock == sock } } # When connection is closed by remote host, socket is ready to read and #recv returns an empty string that means EOF. # If this happens we assume the data wasn't delivered and retry it. if raw_data.empty? log.warn "destination node closed the connection. regard it as unavailable.", host: info.node.host, port: info.node.port info.node.disable! rollback_write(info.chunk_id, update_retry: false) return nil else unpacker.feed(raw_data) res = unpacker.read log.trace "getting response from destination", host: info.node.host, port: info.node.port, chunk_id: dump_unique_id_hex(info.chunk_id), response: res if res['ack'] != info.chunk_id_base64 # Some errors may have occurred when ack and chunk id is different, so send the chunk again. log.warn "ack in response and chunk id in sent data are different", chunk_id: dump_unique_id_hex(info.chunk_id), ack: res['ack'] rollback_write(info.chunk_id, update_retry: false) return nil else log.trace "got a correct ack response", chunk_id: dump_unique_id_hex(info.chunk_id) end return info.chunk_id end rescue => e log.error "unexpected error while receiving ack message", error: e log.error_backtrace ensure info.sock.close_write rescue nil info.sock.close rescue nil @sock_ack_waiting_mutex.synchronize do @sock_ack_waiting.delete(info) end end
ruby
def read_ack_from_sock(sock, unpacker) begin raw_data = sock.instance_of?(Fluent::PluginHelper::Socket::WrappedSocket::TLS) ? sock.readpartial(@read_length) : sock.recv(@read_length) rescue Errno::ECONNRESET, EOFError # ECONNRESET for #recv, #EOFError for #readpartial raw_data = "" end info = @sock_ack_waiting_mutex.synchronize{ @sock_ack_waiting.find{|i| i.sock == sock } } # When connection is closed by remote host, socket is ready to read and #recv returns an empty string that means EOF. # If this happens we assume the data wasn't delivered and retry it. if raw_data.empty? log.warn "destination node closed the connection. regard it as unavailable.", host: info.node.host, port: info.node.port info.node.disable! rollback_write(info.chunk_id, update_retry: false) return nil else unpacker.feed(raw_data) res = unpacker.read log.trace "getting response from destination", host: info.node.host, port: info.node.port, chunk_id: dump_unique_id_hex(info.chunk_id), response: res if res['ack'] != info.chunk_id_base64 # Some errors may have occurred when ack and chunk id is different, so send the chunk again. log.warn "ack in response and chunk id in sent data are different", chunk_id: dump_unique_id_hex(info.chunk_id), ack: res['ack'] rollback_write(info.chunk_id, update_retry: false) return nil else log.trace "got a correct ack response", chunk_id: dump_unique_id_hex(info.chunk_id) end return info.chunk_id end rescue => e log.error "unexpected error while receiving ack message", error: e log.error_backtrace ensure info.sock.close_write rescue nil info.sock.close rescue nil @sock_ack_waiting_mutex.synchronize do @sock_ack_waiting.delete(info) end end
[ "def", "read_ack_from_sock", "(", "sock", ",", "unpacker", ")", "begin", "raw_data", "=", "sock", ".", "instance_of?", "(", "Fluent", "::", "PluginHelper", "::", "Socket", "::", "WrappedSocket", "::", "TLS", ")", "?", "sock", ".", "readpartial", "(", "@read_length", ")", ":", "sock", ".", "recv", "(", "@read_length", ")", "rescue", "Errno", "::", "ECONNRESET", ",", "EOFError", "# ECONNRESET for #recv, #EOFError for #readpartial", "raw_data", "=", "\"\"", "end", "info", "=", "@sock_ack_waiting_mutex", ".", "synchronize", "{", "@sock_ack_waiting", ".", "find", "{", "|", "i", "|", "i", ".", "sock", "==", "sock", "}", "}", "# When connection is closed by remote host, socket is ready to read and #recv returns an empty string that means EOF.", "# If this happens we assume the data wasn't delivered and retry it.", "if", "raw_data", ".", "empty?", "log", ".", "warn", "\"destination node closed the connection. regard it as unavailable.\"", ",", "host", ":", "info", ".", "node", ".", "host", ",", "port", ":", "info", ".", "node", ".", "port", "info", ".", "node", ".", "disable!", "rollback_write", "(", "info", ".", "chunk_id", ",", "update_retry", ":", "false", ")", "return", "nil", "else", "unpacker", ".", "feed", "(", "raw_data", ")", "res", "=", "unpacker", ".", "read", "log", ".", "trace", "\"getting response from destination\"", ",", "host", ":", "info", ".", "node", ".", "host", ",", "port", ":", "info", ".", "node", ".", "port", ",", "chunk_id", ":", "dump_unique_id_hex", "(", "info", ".", "chunk_id", ")", ",", "response", ":", "res", "if", "res", "[", "'ack'", "]", "!=", "info", ".", "chunk_id_base64", "# Some errors may have occurred when ack and chunk id is different, so send the chunk again.", "log", ".", "warn", "\"ack in response and chunk id in sent data are different\"", ",", "chunk_id", ":", "dump_unique_id_hex", "(", "info", ".", "chunk_id", ")", ",", "ack", ":", "res", "[", "'ack'", "]", "rollback_write", "(", "info", ".", "chunk_id", ",", "update_retry", ":", "false", ")", "return", "nil", "else", "log", ".", "trace", "\"got a correct ack response\"", ",", "chunk_id", ":", "dump_unique_id_hex", "(", "info", ".", "chunk_id", ")", "end", "return", "info", ".", "chunk_id", "end", "rescue", "=>", "e", "log", ".", "error", "\"unexpected error while receiving ack message\"", ",", "error", ":", "e", "log", ".", "error_backtrace", "ensure", "info", ".", "sock", ".", "close_write", "rescue", "nil", "info", ".", "sock", ".", "close", "rescue", "nil", "@sock_ack_waiting_mutex", ".", "synchronize", "do", "@sock_ack_waiting", ".", "delete", "(", "info", ")", "end", "end" ]
return chunk id to be committed
[ "return", "chunk", "id", "to", "be", "committed" ]
add2af9a5b7f74fc36957b8e6138b3c5a2871a92
https://github.com/fluent/fluentd/blob/add2af9a5b7f74fc36957b8e6138b3c5a2871a92/lib/fluent/plugin/out_forward.rb#L457-L495
10,701
fluent/fluentd
lib/fluent/time.rb
Fluent.NumericTimeParser.parse_unixtime
def parse_unixtime(value) unless value.is_a?(String) || value.is_a?(Numeric) raise TimeParseError, "value must be a string or a number: #{value}(value.class)" end if @cache1_key == value return @cache1_time elsif @cache2_key == value return @cache2_time end begin time = Fluent::EventTime.new(value.to_i) rescue => e raise TimeParseError, "invalid time format: value = #{value}, error_class = #{e.class.name}, error = #{e.message}" end @cache1_key = @cache2_key @cache1_time = @cache2_time @cache2_key = value @cache2_time = time time end
ruby
def parse_unixtime(value) unless value.is_a?(String) || value.is_a?(Numeric) raise TimeParseError, "value must be a string or a number: #{value}(value.class)" end if @cache1_key == value return @cache1_time elsif @cache2_key == value return @cache2_time end begin time = Fluent::EventTime.new(value.to_i) rescue => e raise TimeParseError, "invalid time format: value = #{value}, error_class = #{e.class.name}, error = #{e.message}" end @cache1_key = @cache2_key @cache1_time = @cache2_time @cache2_key = value @cache2_time = time time end
[ "def", "parse_unixtime", "(", "value", ")", "unless", "value", ".", "is_a?", "(", "String", ")", "||", "value", ".", "is_a?", "(", "Numeric", ")", "raise", "TimeParseError", ",", "\"value must be a string or a number: #{value}(value.class)\"", "end", "if", "@cache1_key", "==", "value", "return", "@cache1_time", "elsif", "@cache2_key", "==", "value", "return", "@cache2_time", "end", "begin", "time", "=", "Fluent", "::", "EventTime", ".", "new", "(", "value", ".", "to_i", ")", "rescue", "=>", "e", "raise", "TimeParseError", ",", "\"invalid time format: value = #{value}, error_class = #{e.class.name}, error = #{e.message}\"", "end", "@cache1_key", "=", "@cache2_key", "@cache1_time", "=", "@cache2_time", "@cache2_key", "=", "value", "@cache2_time", "=", "time", "time", "end" ]
to include TimeParseError
[ "to", "include", "TimeParseError" ]
add2af9a5b7f74fc36957b8e6138b3c5a2871a92
https://github.com/fluent/fluentd/blob/add2af9a5b7f74fc36957b8e6138b3c5a2871a92/lib/fluent/time.rb#L262-L283
10,702
fluent/fluentd
lib/fluent/plugin/in_monitor_agent.rb
Fluent::Plugin.MonitorAgentInput.plugin_info_by_id
def plugin_info_by_id(plugin_id, opts={}) found = all_plugins.find {|pe| pe.respond_to?(:plugin_id) && pe.plugin_id.to_s == plugin_id } if found get_monitor_info(found, opts) else nil end end
ruby
def plugin_info_by_id(plugin_id, opts={}) found = all_plugins.find {|pe| pe.respond_to?(:plugin_id) && pe.plugin_id.to_s == plugin_id } if found get_monitor_info(found, opts) else nil end end
[ "def", "plugin_info_by_id", "(", "plugin_id", ",", "opts", "=", "{", "}", ")", "found", "=", "all_plugins", ".", "find", "{", "|", "pe", "|", "pe", ".", "respond_to?", "(", ":plugin_id", ")", "&&", "pe", ".", "plugin_id", ".", "to_s", "==", "plugin_id", "}", "if", "found", "get_monitor_info", "(", "found", ",", "opts", ")", "else", "nil", "end", "end" ]
search a plugin by plugin_id
[ "search", "a", "plugin", "by", "plugin_id" ]
add2af9a5b7f74fc36957b8e6138b3c5a2871a92
https://github.com/fluent/fluentd/blob/add2af9a5b7f74fc36957b8e6138b3c5a2871a92/lib/fluent/plugin/in_monitor_agent.rb#L329-L338
10,703
fluent/fluentd
lib/fluent/plugin/in_monitor_agent.rb
Fluent::Plugin.MonitorAgentInput.plugins_info_by_type
def plugins_info_by_type(type, opts={}) array = all_plugins.select {|pe| (pe.config['@type'] == type) rescue nil } array.map {|pe| get_monitor_info(pe, opts) } end
ruby
def plugins_info_by_type(type, opts={}) array = all_plugins.select {|pe| (pe.config['@type'] == type) rescue nil } array.map {|pe| get_monitor_info(pe, opts) } end
[ "def", "plugins_info_by_type", "(", "type", ",", "opts", "=", "{", "}", ")", "array", "=", "all_plugins", ".", "select", "{", "|", "pe", "|", "(", "pe", ".", "config", "[", "'@type'", "]", "==", "type", ")", "rescue", "nil", "}", "array", ".", "map", "{", "|", "pe", "|", "get_monitor_info", "(", "pe", ",", "opts", ")", "}", "end" ]
This method returns an array because multiple plugins could have the same type
[ "This", "method", "returns", "an", "array", "because", "multiple", "plugins", "could", "have", "the", "same", "type" ]
add2af9a5b7f74fc36957b8e6138b3c5a2871a92
https://github.com/fluent/fluentd/blob/add2af9a5b7f74fc36957b8e6138b3c5a2871a92/lib/fluent/plugin/in_monitor_agent.rb#L342-L349
10,704
fluent/fluentd
lib/fluent/plugin/in_monitor_agent.rb
Fluent::Plugin.MonitorAgentInput.get_monitor_info
def get_monitor_info(pe, opts={}) obj = {} # Common plugin information obj['plugin_id'] = pe.plugin_id obj['plugin_category'] = plugin_category(pe) obj['type'] = pe.config['@type'] obj['config'] = pe.config if opts[:with_config] # run MONITOR_INFO in plugins' instance context and store the info to obj MONITOR_INFO.each_pair {|key,code| begin catch(:skip) do obj[key] = pe.instance_exec(&code) end rescue NoMethodError => e unless @first_warn log.error "NoMethodError in monitoring plugins", key: key, plugin: pe.class, error: e log.error_backtrace @first_warn = true end rescue => e log.warn "unexpected error in monitoring plugins", key: key, plugin: pe.class, error: e end } obj['retry'] = get_retry_info(pe.retry) if opts[:with_retry] and pe.instance_variable_defined?(:@retry) # include all instance variables if :with_debug_info is set if opts[:with_debug_info] iv = {} pe.instance_eval do instance_variables.each {|sym| next if IGNORE_ATTRIBUTES.include?(sym) key = sym.to_s[1..-1] # removes first '@' iv[key] = instance_variable_get(sym) } end obj['instance_variables'] = iv elsif ivars = opts[:ivars] iv = {} ivars.each {|name| iname = "@#{name}" iv[name] = pe.instance_variable_get(iname) if pe.instance_variable_defined?(iname) } obj['instance_variables'] = iv end obj end
ruby
def get_monitor_info(pe, opts={}) obj = {} # Common plugin information obj['plugin_id'] = pe.plugin_id obj['plugin_category'] = plugin_category(pe) obj['type'] = pe.config['@type'] obj['config'] = pe.config if opts[:with_config] # run MONITOR_INFO in plugins' instance context and store the info to obj MONITOR_INFO.each_pair {|key,code| begin catch(:skip) do obj[key] = pe.instance_exec(&code) end rescue NoMethodError => e unless @first_warn log.error "NoMethodError in monitoring plugins", key: key, plugin: pe.class, error: e log.error_backtrace @first_warn = true end rescue => e log.warn "unexpected error in monitoring plugins", key: key, plugin: pe.class, error: e end } obj['retry'] = get_retry_info(pe.retry) if opts[:with_retry] and pe.instance_variable_defined?(:@retry) # include all instance variables if :with_debug_info is set if opts[:with_debug_info] iv = {} pe.instance_eval do instance_variables.each {|sym| next if IGNORE_ATTRIBUTES.include?(sym) key = sym.to_s[1..-1] # removes first '@' iv[key] = instance_variable_get(sym) } end obj['instance_variables'] = iv elsif ivars = opts[:ivars] iv = {} ivars.each {|name| iname = "@#{name}" iv[name] = pe.instance_variable_get(iname) if pe.instance_variable_defined?(iname) } obj['instance_variables'] = iv end obj end
[ "def", "get_monitor_info", "(", "pe", ",", "opts", "=", "{", "}", ")", "obj", "=", "{", "}", "# Common plugin information", "obj", "[", "'plugin_id'", "]", "=", "pe", ".", "plugin_id", "obj", "[", "'plugin_category'", "]", "=", "plugin_category", "(", "pe", ")", "obj", "[", "'type'", "]", "=", "pe", ".", "config", "[", "'@type'", "]", "obj", "[", "'config'", "]", "=", "pe", ".", "config", "if", "opts", "[", ":with_config", "]", "# run MONITOR_INFO in plugins' instance context and store the info to obj", "MONITOR_INFO", ".", "each_pair", "{", "|", "key", ",", "code", "|", "begin", "catch", "(", ":skip", ")", "do", "obj", "[", "key", "]", "=", "pe", ".", "instance_exec", "(", "code", ")", "end", "rescue", "NoMethodError", "=>", "e", "unless", "@first_warn", "log", ".", "error", "\"NoMethodError in monitoring plugins\"", ",", "key", ":", "key", ",", "plugin", ":", "pe", ".", "class", ",", "error", ":", "e", "log", ".", "error_backtrace", "@first_warn", "=", "true", "end", "rescue", "=>", "e", "log", ".", "warn", "\"unexpected error in monitoring plugins\"", ",", "key", ":", "key", ",", "plugin", ":", "pe", ".", "class", ",", "error", ":", "e", "end", "}", "obj", "[", "'retry'", "]", "=", "get_retry_info", "(", "pe", ".", "retry", ")", "if", "opts", "[", ":with_retry", "]", "and", "pe", ".", "instance_variable_defined?", "(", ":@retry", ")", "# include all instance variables if :with_debug_info is set", "if", "opts", "[", ":with_debug_info", "]", "iv", "=", "{", "}", "pe", ".", "instance_eval", "do", "instance_variables", ".", "each", "{", "|", "sym", "|", "next", "if", "IGNORE_ATTRIBUTES", ".", "include?", "(", "sym", ")", "key", "=", "sym", ".", "to_s", "[", "1", "..", "-", "1", "]", "# removes first '@'", "iv", "[", "key", "]", "=", "instance_variable_get", "(", "sym", ")", "}", "end", "obj", "[", "'instance_variables'", "]", "=", "iv", "elsif", "ivars", "=", "opts", "[", ":ivars", "]", "iv", "=", "{", "}", "ivars", ".", "each", "{", "|", "name", "|", "iname", "=", "\"@#{name}\"", "iv", "[", "name", "]", "=", "pe", ".", "instance_variable_get", "(", "iname", ")", "if", "pe", ".", "instance_variable_defined?", "(", "iname", ")", "}", "obj", "[", "'instance_variables'", "]", "=", "iv", "end", "obj", "end" ]
get monitor info from the plugin `pe` and return a hash object
[ "get", "monitor", "info", "from", "the", "plugin", "pe", "and", "return", "a", "hash", "object" ]
add2af9a5b7f74fc36957b8e6138b3c5a2871a92
https://github.com/fluent/fluentd/blob/add2af9a5b7f74fc36957b8e6138b3c5a2871a92/lib/fluent/plugin/in_monitor_agent.rb#L360-L409
10,705
plataformatec/devise
lib/devise/parameter_sanitizer.rb
Devise.ParameterSanitizer.sanitize
def sanitize(action) permissions = @permitted[action] if permissions.respond_to?(:call) cast_to_hash permissions.call(default_params) elsif permissions.present? cast_to_hash permit_keys(default_params, permissions) else unknown_action!(action) end end
ruby
def sanitize(action) permissions = @permitted[action] if permissions.respond_to?(:call) cast_to_hash permissions.call(default_params) elsif permissions.present? cast_to_hash permit_keys(default_params, permissions) else unknown_action!(action) end end
[ "def", "sanitize", "(", "action", ")", "permissions", "=", "@permitted", "[", "action", "]", "if", "permissions", ".", "respond_to?", "(", ":call", ")", "cast_to_hash", "permissions", ".", "call", "(", "default_params", ")", "elsif", "permissions", ".", "present?", "cast_to_hash", "permit_keys", "(", "default_params", ",", "permissions", ")", "else", "unknown_action!", "(", "action", ")", "end", "end" ]
Sanitize the parameters for a specific +action+. === Arguments * +action+ - A +Symbol+ with the action that the controller is performing, like +sign_up+, +sign_in+, etc. === Examples # Inside the `RegistrationsController#create` action. resource = build_resource(devise_parameter_sanitizer.sanitize(:sign_up)) resource.save Returns an +ActiveSupport::HashWithIndifferentAccess+ with the permitted attributes.
[ "Sanitize", "the", "parameters", "for", "a", "specific", "+", "action", "+", "." ]
07f2712a22aa05b8da61c85307b80a3bd2ed6c4c
https://github.com/plataformatec/devise/blob/07f2712a22aa05b8da61c85307b80a3bd2ed6c4c/lib/devise/parameter_sanitizer.rb#L70-L80
10,706
plataformatec/devise
lib/devise/parameter_sanitizer.rb
Devise.ParameterSanitizer.permit
def permit(action, keys: nil, except: nil, &block) if block_given? @permitted[action] = block end if keys.present? @permitted[action] ||= @auth_keys.dup @permitted[action].concat(keys) end if except.present? @permitted[action] ||= @auth_keys.dup @permitted[action] = @permitted[action] - except end end
ruby
def permit(action, keys: nil, except: nil, &block) if block_given? @permitted[action] = block end if keys.present? @permitted[action] ||= @auth_keys.dup @permitted[action].concat(keys) end if except.present? @permitted[action] ||= @auth_keys.dup @permitted[action] = @permitted[action] - except end end
[ "def", "permit", "(", "action", ",", "keys", ":", "nil", ",", "except", ":", "nil", ",", "&", "block", ")", "if", "block_given?", "@permitted", "[", "action", "]", "=", "block", "end", "if", "keys", ".", "present?", "@permitted", "[", "action", "]", "||=", "@auth_keys", ".", "dup", "@permitted", "[", "action", "]", ".", "concat", "(", "keys", ")", "end", "if", "except", ".", "present?", "@permitted", "[", "action", "]", "||=", "@auth_keys", ".", "dup", "@permitted", "[", "action", "]", "=", "@permitted", "[", "action", "]", "-", "except", "end", "end" ]
Add or remove new parameters to the permitted list of an +action+. === Arguments * +action+ - A +Symbol+ with the action that the controller is performing, like +sign_up+, +sign_in+, etc. * +keys:+ - An +Array+ of keys that also should be permitted. * +except:+ - An +Array+ of keys that shouldn't be permitted. * +block+ - A block that should be used to permit the action parameters instead of the +Array+ based approach. The block will be called with an +ActionController::Parameters+ instance. === Examples # Adding new parameters to be permitted in the `sign_up` action. devise_parameter_sanitizer.permit(:sign_up, keys: [:subscribe_newsletter]) # Removing the `password` parameter from the `account_update` action. devise_parameter_sanitizer.permit(:account_update, except: [:password]) # Using the block form to completely override how we permit the # parameters for the `sign_up` action. devise_parameter_sanitizer.permit(:sign_up) do |user| user.permit(:email, :password, :password_confirmation) end Returns nothing.
[ "Add", "or", "remove", "new", "parameters", "to", "the", "permitted", "list", "of", "an", "+", "action", "+", "." ]
07f2712a22aa05b8da61c85307b80a3bd2ed6c4c
https://github.com/plataformatec/devise/blob/07f2712a22aa05b8da61c85307b80a3bd2ed6c4c/lib/devise/parameter_sanitizer.rb#L110-L124
10,707
plataformatec/devise
lib/devise/parameter_filter.rb
Devise.ParameterFilter.stringify_params
def stringify_params(conditions) return conditions unless conditions.is_a?(Hash) conditions.each do |k, v| conditions[k] = v.to_s if param_requires_string_conversion?(v) end end
ruby
def stringify_params(conditions) return conditions unless conditions.is_a?(Hash) conditions.each do |k, v| conditions[k] = v.to_s if param_requires_string_conversion?(v) end end
[ "def", "stringify_params", "(", "conditions", ")", "return", "conditions", "unless", "conditions", ".", "is_a?", "(", "Hash", ")", "conditions", ".", "each", "do", "|", "k", ",", "v", "|", "conditions", "[", "k", "]", "=", "v", ".", "to_s", "if", "param_requires_string_conversion?", "(", "v", ")", "end", "end" ]
Force keys to be string to avoid injection on mongoid related database.
[ "Force", "keys", "to", "be", "string", "to", "avoid", "injection", "on", "mongoid", "related", "database", "." ]
07f2712a22aa05b8da61c85307b80a3bd2ed6c4c
https://github.com/plataformatec/devise/blob/07f2712a22aa05b8da61c85307b80a3bd2ed6c4c/lib/devise/parameter_filter.rb#L31-L36
10,708
Shopify/liquid
lib/liquid/template.rb
Liquid.Template.parse
def parse(source, options = {}) @options = options @profiling = options[:profile] @line_numbers = options[:line_numbers] || @profiling parse_context = options.is_a?(ParseContext) ? options : ParseContext.new(options) @root = Document.parse(tokenize(source), parse_context) @warnings = parse_context.warnings self end
ruby
def parse(source, options = {}) @options = options @profiling = options[:profile] @line_numbers = options[:line_numbers] || @profiling parse_context = options.is_a?(ParseContext) ? options : ParseContext.new(options) @root = Document.parse(tokenize(source), parse_context) @warnings = parse_context.warnings self end
[ "def", "parse", "(", "source", ",", "options", "=", "{", "}", ")", "@options", "=", "options", "@profiling", "=", "options", "[", ":profile", "]", "@line_numbers", "=", "options", "[", ":line_numbers", "]", "||", "@profiling", "parse_context", "=", "options", ".", "is_a?", "(", "ParseContext", ")", "?", "options", ":", "ParseContext", ".", "new", "(", "options", ")", "@root", "=", "Document", ".", "parse", "(", "tokenize", "(", "source", ")", ",", "parse_context", ")", "@warnings", "=", "parse_context", ".", "warnings", "self", "end" ]
Parse source code. Returns self for easy chaining
[ "Parse", "source", "code", ".", "Returns", "self", "for", "easy", "chaining" ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/template.rb#L127-L135
10,709
Shopify/liquid
lib/liquid/template.rb
Liquid.Template.render
def render(*args) return ''.freeze if @root.nil? context = case args.first when Liquid::Context c = args.shift if @rethrow_errors c.exception_renderer = ->(e) { raise } end c when Liquid::Drop drop = args.shift drop.context = Context.new([drop, assigns], instance_assigns, registers, @rethrow_errors, @resource_limits) when Hash Context.new([args.shift, assigns], instance_assigns, registers, @rethrow_errors, @resource_limits) when nil Context.new(assigns, instance_assigns, registers, @rethrow_errors, @resource_limits) else raise ArgumentError, "Expected Hash or Liquid::Context as parameter" end case args.last when Hash options = args.pop registers.merge!(options[:registers]) if options[:registers].is_a?(Hash) apply_options_to_context(context, options) when Module, Array context.add_filters(args.pop) end # Retrying a render resets resource usage context.resource_limits.reset begin # render the nodelist. # for performance reasons we get an array back here. join will make a string out of it. result = with_profiling(context) do @root.render(context) end result.respond_to?(:join) ? result.join : result rescue Liquid::MemoryError => e context.handle_error(e) ensure @errors = context.errors end end
ruby
def render(*args) return ''.freeze if @root.nil? context = case args.first when Liquid::Context c = args.shift if @rethrow_errors c.exception_renderer = ->(e) { raise } end c when Liquid::Drop drop = args.shift drop.context = Context.new([drop, assigns], instance_assigns, registers, @rethrow_errors, @resource_limits) when Hash Context.new([args.shift, assigns], instance_assigns, registers, @rethrow_errors, @resource_limits) when nil Context.new(assigns, instance_assigns, registers, @rethrow_errors, @resource_limits) else raise ArgumentError, "Expected Hash or Liquid::Context as parameter" end case args.last when Hash options = args.pop registers.merge!(options[:registers]) if options[:registers].is_a?(Hash) apply_options_to_context(context, options) when Module, Array context.add_filters(args.pop) end # Retrying a render resets resource usage context.resource_limits.reset begin # render the nodelist. # for performance reasons we get an array back here. join will make a string out of it. result = with_profiling(context) do @root.render(context) end result.respond_to?(:join) ? result.join : result rescue Liquid::MemoryError => e context.handle_error(e) ensure @errors = context.errors end end
[ "def", "render", "(", "*", "args", ")", "return", "''", ".", "freeze", "if", "@root", ".", "nil?", "context", "=", "case", "args", ".", "first", "when", "Liquid", "::", "Context", "c", "=", "args", ".", "shift", "if", "@rethrow_errors", "c", ".", "exception_renderer", "=", "->", "(", "e", ")", "{", "raise", "}", "end", "c", "when", "Liquid", "::", "Drop", "drop", "=", "args", ".", "shift", "drop", ".", "context", "=", "Context", ".", "new", "(", "[", "drop", ",", "assigns", "]", ",", "instance_assigns", ",", "registers", ",", "@rethrow_errors", ",", "@resource_limits", ")", "when", "Hash", "Context", ".", "new", "(", "[", "args", ".", "shift", ",", "assigns", "]", ",", "instance_assigns", ",", "registers", ",", "@rethrow_errors", ",", "@resource_limits", ")", "when", "nil", "Context", ".", "new", "(", "assigns", ",", "instance_assigns", ",", "registers", ",", "@rethrow_errors", ",", "@resource_limits", ")", "else", "raise", "ArgumentError", ",", "\"Expected Hash or Liquid::Context as parameter\"", "end", "case", "args", ".", "last", "when", "Hash", "options", "=", "args", ".", "pop", "registers", ".", "merge!", "(", "options", "[", ":registers", "]", ")", "if", "options", "[", ":registers", "]", ".", "is_a?", "(", "Hash", ")", "apply_options_to_context", "(", "context", ",", "options", ")", "when", "Module", ",", "Array", "context", ".", "add_filters", "(", "args", ".", "pop", ")", "end", "# Retrying a render resets resource usage", "context", ".", "resource_limits", ".", "reset", "begin", "# render the nodelist.", "# for performance reasons we get an array back here. join will make a string out of it.", "result", "=", "with_profiling", "(", "context", ")", "do", "@root", ".", "render", "(", "context", ")", "end", "result", ".", "respond_to?", "(", ":join", ")", "?", "result", ".", "join", ":", "result", "rescue", "Liquid", "::", "MemoryError", "=>", "e", "context", ".", "handle_error", "(", "e", ")", "ensure", "@errors", "=", "context", ".", "errors", "end", "end" ]
Render takes a hash with local variables. if you use the same filters over and over again consider registering them globally with <tt>Template.register_filter</tt> if profiling was enabled in <tt>Template#parse</tt> then the resulting profiling information will be available via <tt>Template#profiler</tt> Following options can be passed: * <tt>filters</tt> : array with local filters * <tt>registers</tt> : hash with register variables. Those can be accessed from filters and tags and might be useful to integrate liquid more with its host application
[ "Render", "takes", "a", "hash", "with", "local", "variables", "." ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/template.rb#L167-L216
10,710
Shopify/liquid
lib/liquid/standardfilters.rb
Liquid.StandardFilters.truncate
def truncate(input, length = 50, truncate_string = "...".freeze) return if input.nil? input_str = input.to_s length = Utils.to_integer(length) truncate_string_str = truncate_string.to_s l = length - truncate_string_str.length l = 0 if l < 0 input_str.length > length ? input_str[0...l] + truncate_string_str : input_str end
ruby
def truncate(input, length = 50, truncate_string = "...".freeze) return if input.nil? input_str = input.to_s length = Utils.to_integer(length) truncate_string_str = truncate_string.to_s l = length - truncate_string_str.length l = 0 if l < 0 input_str.length > length ? input_str[0...l] + truncate_string_str : input_str end
[ "def", "truncate", "(", "input", ",", "length", "=", "50", ",", "truncate_string", "=", "\"...\"", ".", "freeze", ")", "return", "if", "input", ".", "nil?", "input_str", "=", "input", ".", "to_s", "length", "=", "Utils", ".", "to_integer", "(", "length", ")", "truncate_string_str", "=", "truncate_string", ".", "to_s", "l", "=", "length", "-", "truncate_string_str", ".", "length", "l", "=", "0", "if", "l", "<", "0", "input_str", ".", "length", ">", "length", "?", "input_str", "[", "0", "...", "l", "]", "+", "truncate_string_str", ":", "input_str", "end" ]
Truncate a string down to x characters
[ "Truncate", "a", "string", "down", "to", "x", "characters" ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/standardfilters.rb#L75-L83
10,711
Shopify/liquid
lib/liquid/standardfilters.rb
Liquid.StandardFilters.sort
def sort(input, property = nil) ary = InputIterator.new(input) return [] if ary.empty? if property.nil? ary.sort do |a, b| nil_safe_compare(a, b) end elsif ary.all? { |el| el.respond_to?(:[]) } begin ary.sort { |a, b| nil_safe_compare(a[property], b[property]) } rescue TypeError raise_property_error(property) end end end
ruby
def sort(input, property = nil) ary = InputIterator.new(input) return [] if ary.empty? if property.nil? ary.sort do |a, b| nil_safe_compare(a, b) end elsif ary.all? { |el| el.respond_to?(:[]) } begin ary.sort { |a, b| nil_safe_compare(a[property], b[property]) } rescue TypeError raise_property_error(property) end end end
[ "def", "sort", "(", "input", ",", "property", "=", "nil", ")", "ary", "=", "InputIterator", ".", "new", "(", "input", ")", "return", "[", "]", "if", "ary", ".", "empty?", "if", "property", ".", "nil?", "ary", ".", "sort", "do", "|", "a", ",", "b", "|", "nil_safe_compare", "(", "a", ",", "b", ")", "end", "elsif", "ary", ".", "all?", "{", "|", "el", "|", "el", ".", "respond_to?", "(", ":[]", ")", "}", "begin", "ary", ".", "sort", "{", "|", "a", ",", "b", "|", "nil_safe_compare", "(", "a", "[", "property", "]", ",", "b", "[", "property", "]", ")", "}", "rescue", "TypeError", "raise_property_error", "(", "property", ")", "end", "end", "end" ]
Sort elements of the array provide optional property with which to sort an array of hashes or drops
[ "Sort", "elements", "of", "the", "array", "provide", "optional", "property", "with", "which", "to", "sort", "an", "array", "of", "hashes", "or", "drops" ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/standardfilters.rb#L134-L150
10,712
Shopify/liquid
lib/liquid/standardfilters.rb
Liquid.StandardFilters.where
def where(input, property, target_value = nil) ary = InputIterator.new(input) if ary.empty? [] elsif ary.first.respond_to?(:[]) && target_value.nil? begin ary.select { |item| item[property] } rescue TypeError raise_property_error(property) end elsif ary.first.respond_to?(:[]) begin ary.select { |item| item[property] == target_value } rescue TypeError raise_property_error(property) end end end
ruby
def where(input, property, target_value = nil) ary = InputIterator.new(input) if ary.empty? [] elsif ary.first.respond_to?(:[]) && target_value.nil? begin ary.select { |item| item[property] } rescue TypeError raise_property_error(property) end elsif ary.first.respond_to?(:[]) begin ary.select { |item| item[property] == target_value } rescue TypeError raise_property_error(property) end end end
[ "def", "where", "(", "input", ",", "property", ",", "target_value", "=", "nil", ")", "ary", "=", "InputIterator", ".", "new", "(", "input", ")", "if", "ary", ".", "empty?", "[", "]", "elsif", "ary", ".", "first", ".", "respond_to?", "(", ":[]", ")", "&&", "target_value", ".", "nil?", "begin", "ary", ".", "select", "{", "|", "item", "|", "item", "[", "property", "]", "}", "rescue", "TypeError", "raise_property_error", "(", "property", ")", "end", "elsif", "ary", ".", "first", ".", "respond_to?", "(", ":[]", ")", "begin", "ary", ".", "select", "{", "|", "item", "|", "item", "[", "property", "]", "==", "target_value", "}", "rescue", "TypeError", "raise_property_error", "(", "property", ")", "end", "end", "end" ]
Filter the elements of an array to those with a certain property value. By default the target is any truthy value.
[ "Filter", "the", "elements", "of", "an", "array", "to", "those", "with", "a", "certain", "property", "value", ".", "By", "default", "the", "target", "is", "any", "truthy", "value", "." ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/standardfilters.rb#L174-L192
10,713
Shopify/liquid
lib/liquid/standardfilters.rb
Liquid.StandardFilters.uniq
def uniq(input, property = nil) ary = InputIterator.new(input) if property.nil? ary.uniq elsif ary.empty? # The next two cases assume a non-empty array. [] elsif ary.first.respond_to?(:[]) begin ary.uniq { |a| a[property] } rescue TypeError raise_property_error(property) end end end
ruby
def uniq(input, property = nil) ary = InputIterator.new(input) if property.nil? ary.uniq elsif ary.empty? # The next two cases assume a non-empty array. [] elsif ary.first.respond_to?(:[]) begin ary.uniq { |a| a[property] } rescue TypeError raise_property_error(property) end end end
[ "def", "uniq", "(", "input", ",", "property", "=", "nil", ")", "ary", "=", "InputIterator", ".", "new", "(", "input", ")", "if", "property", ".", "nil?", "ary", ".", "uniq", "elsif", "ary", ".", "empty?", "# The next two cases assume a non-empty array.", "[", "]", "elsif", "ary", ".", "first", ".", "respond_to?", "(", ":[]", ")", "begin", "ary", ".", "uniq", "{", "|", "a", "|", "a", "[", "property", "]", "}", "rescue", "TypeError", "raise_property_error", "(", "property", ")", "end", "end", "end" ]
Remove duplicate elements from an array provide optional property with which to determine uniqueness
[ "Remove", "duplicate", "elements", "from", "an", "array", "provide", "optional", "property", "with", "which", "to", "determine", "uniqueness" ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/standardfilters.rb#L196-L210
10,714
Shopify/liquid
lib/liquid/standardfilters.rb
Liquid.StandardFilters.replace
def replace(input, string, replacement = ''.freeze) input.to_s.gsub(string.to_s, replacement.to_s) end
ruby
def replace(input, string, replacement = ''.freeze) input.to_s.gsub(string.to_s, replacement.to_s) end
[ "def", "replace", "(", "input", ",", "string", ",", "replacement", "=", "''", ".", "freeze", ")", "input", ".", "to_s", ".", "gsub", "(", "string", ".", "to_s", ",", "replacement", ".", "to_s", ")", "end" ]
Replace occurrences of a string with another
[ "Replace", "occurrences", "of", "a", "string", "with", "another" ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/standardfilters.rb#L253-L255
10,715
Shopify/liquid
lib/liquid/standardfilters.rb
Liquid.StandardFilters.replace_first
def replace_first(input, string, replacement = ''.freeze) input.to_s.sub(string.to_s, replacement.to_s) end
ruby
def replace_first(input, string, replacement = ''.freeze) input.to_s.sub(string.to_s, replacement.to_s) end
[ "def", "replace_first", "(", "input", ",", "string", ",", "replacement", "=", "''", ".", "freeze", ")", "input", ".", "to_s", ".", "sub", "(", "string", ".", "to_s", ",", "replacement", ".", "to_s", ")", "end" ]
Replace the first occurrences of a string with another
[ "Replace", "the", "first", "occurrences", "of", "a", "string", "with", "another" ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/standardfilters.rb#L258-L260
10,716
Shopify/liquid
lib/liquid/context.rb
Liquid.Context.stack
def stack(new_scope = nil) old_stack_used = @this_stack_used if new_scope push(new_scope) @this_stack_used = true else @this_stack_used = false end yield ensure pop if @this_stack_used @this_stack_used = old_stack_used end
ruby
def stack(new_scope = nil) old_stack_used = @this_stack_used if new_scope push(new_scope) @this_stack_used = true else @this_stack_used = false end yield ensure pop if @this_stack_used @this_stack_used = old_stack_used end
[ "def", "stack", "(", "new_scope", "=", "nil", ")", "old_stack_used", "=", "@this_stack_used", "if", "new_scope", "push", "(", "new_scope", ")", "@this_stack_used", "=", "true", "else", "@this_stack_used", "=", "false", "end", "yield", "ensure", "pop", "if", "@this_stack_used", "@this_stack_used", "=", "old_stack_used", "end" ]
Pushes a new local scope on the stack, pops it at the end of the block Example: context.stack do context['var'] = 'hi' end context['var] #=> nil
[ "Pushes", "a", "new", "local", "scope", "on", "the", "stack", "pops", "it", "at", "the", "end", "of", "the", "block" ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/context.rb#L114-L127
10,717
Shopify/liquid
lib/liquid/context.rb
Liquid.Context.find_variable
def find_variable(key, raise_on_not_found: true) # This was changed from find() to find_index() because this is a very hot # path and find_index() is optimized in MRI to reduce object allocation index = @scopes.find_index { |s| s.key?(key) } scope = @scopes[index] if index variable = nil if scope.nil? @environments.each do |e| variable = lookup_and_evaluate(e, key, raise_on_not_found: raise_on_not_found) # When lookup returned a value OR there is no value but the lookup also did not raise # then it is the value we are looking for. if !variable.nil? || @strict_variables && raise_on_not_found scope = e break end end end scope ||= @environments.last || @scopes.last variable ||= lookup_and_evaluate(scope, key, raise_on_not_found: raise_on_not_found) variable = variable.to_liquid variable.context = self if variable.respond_to?(:context=) variable end
ruby
def find_variable(key, raise_on_not_found: true) # This was changed from find() to find_index() because this is a very hot # path and find_index() is optimized in MRI to reduce object allocation index = @scopes.find_index { |s| s.key?(key) } scope = @scopes[index] if index variable = nil if scope.nil? @environments.each do |e| variable = lookup_and_evaluate(e, key, raise_on_not_found: raise_on_not_found) # When lookup returned a value OR there is no value but the lookup also did not raise # then it is the value we are looking for. if !variable.nil? || @strict_variables && raise_on_not_found scope = e break end end end scope ||= @environments.last || @scopes.last variable ||= lookup_and_evaluate(scope, key, raise_on_not_found: raise_on_not_found) variable = variable.to_liquid variable.context = self if variable.respond_to?(:context=) variable end
[ "def", "find_variable", "(", "key", ",", "raise_on_not_found", ":", "true", ")", "# This was changed from find() to find_index() because this is a very hot", "# path and find_index() is optimized in MRI to reduce object allocation", "index", "=", "@scopes", ".", "find_index", "{", "|", "s", "|", "s", ".", "key?", "(", "key", ")", "}", "scope", "=", "@scopes", "[", "index", "]", "if", "index", "variable", "=", "nil", "if", "scope", ".", "nil?", "@environments", ".", "each", "do", "|", "e", "|", "variable", "=", "lookup_and_evaluate", "(", "e", ",", "key", ",", "raise_on_not_found", ":", "raise_on_not_found", ")", "# When lookup returned a value OR there is no value but the lookup also did not raise", "# then it is the value we are looking for.", "if", "!", "variable", ".", "nil?", "||", "@strict_variables", "&&", "raise_on_not_found", "scope", "=", "e", "break", "end", "end", "end", "scope", "||=", "@environments", ".", "last", "||", "@scopes", ".", "last", "variable", "||=", "lookup_and_evaluate", "(", "scope", ",", "key", ",", "raise_on_not_found", ":", "raise_on_not_found", ")", "variable", "=", "variable", ".", "to_liquid", "variable", ".", "context", "=", "self", "if", "variable", ".", "respond_to?", "(", ":context=", ")", "variable", "end" ]
Fetches an object starting at the local scope and then moving up the hierachy
[ "Fetches", "an", "object", "starting", "at", "the", "local", "scope", "and", "then", "moving", "up", "the", "hierachy" ]
b3b63a683f6daaea7e70f1602ee829abdf970ef3
https://github.com/Shopify/liquid/blob/b3b63a683f6daaea7e70f1602ee829abdf970ef3/lib/liquid/context.rb#L163-L190
10,718
rubocop-hq/rubocop
lib/rubocop/cached_data.rb
RuboCop.CachedData.deserialize_offenses
def deserialize_offenses(offenses) source_buffer = Parser::Source::Buffer.new(@filename) source_buffer.source = File.read(@filename, encoding: Encoding::UTF_8) offenses.map! do |o| location = Parser::Source::Range.new(source_buffer, o['location']['begin_pos'], o['location']['end_pos']) Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym) end end
ruby
def deserialize_offenses(offenses) source_buffer = Parser::Source::Buffer.new(@filename) source_buffer.source = File.read(@filename, encoding: Encoding::UTF_8) offenses.map! do |o| location = Parser::Source::Range.new(source_buffer, o['location']['begin_pos'], o['location']['end_pos']) Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym) end end
[ "def", "deserialize_offenses", "(", "offenses", ")", "source_buffer", "=", "Parser", "::", "Source", "::", "Buffer", ".", "new", "(", "@filename", ")", "source_buffer", ".", "source", "=", "File", ".", "read", "(", "@filename", ",", "encoding", ":", "Encoding", "::", "UTF_8", ")", "offenses", ".", "map!", "do", "|", "o", "|", "location", "=", "Parser", "::", "Source", "::", "Range", ".", "new", "(", "source_buffer", ",", "o", "[", "'location'", "]", "[", "'begin_pos'", "]", ",", "o", "[", "'location'", "]", "[", "'end_pos'", "]", ")", "Cop", "::", "Offense", ".", "new", "(", "o", "[", "'severity'", "]", ",", "location", ",", "o", "[", "'message'", "]", ",", "o", "[", "'cop_name'", "]", ",", "o", "[", "'status'", "]", ".", "to_sym", ")", "end", "end" ]
Restore an offense object loaded from a JSON file.
[ "Restore", "an", "offense", "object", "loaded", "from", "a", "JSON", "file", "." ]
2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0
https://github.com/rubocop-hq/rubocop/blob/2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0/lib/rubocop/cached_data.rb#L45-L56
10,719
rubocop-hq/rubocop
lib/rubocop/token.rb
RuboCop.Token.space_before?
def space_before? position = begin_pos.zero? ? begin_pos : begin_pos - 1 pos.source_buffer.source.match(/\G\s/, position) end
ruby
def space_before? position = begin_pos.zero? ? begin_pos : begin_pos - 1 pos.source_buffer.source.match(/\G\s/, position) end
[ "def", "space_before?", "position", "=", "begin_pos", ".", "zero?", "?", "begin_pos", ":", "begin_pos", "-", "1", "pos", ".", "source_buffer", ".", "source", ".", "match", "(", "/", "\\G", "\\s", "/", ",", "position", ")", "end" ]
Checks if there is whitespace before token
[ "Checks", "if", "there", "is", "whitespace", "before", "token" ]
2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0
https://github.com/rubocop-hq/rubocop/blob/2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0/lib/rubocop/token.rb#L47-L50
10,720
rubocop-hq/rubocop
lib/rubocop/options.rb
RuboCop.Options.option
def option(opts, *args) long_opt_symbol = long_opt_symbol(args) args += Array(OptionsHelp::TEXT[long_opt_symbol]) opts.on(*args) do |arg| @options[long_opt_symbol] = arg yield arg if block_given? end end
ruby
def option(opts, *args) long_opt_symbol = long_opt_symbol(args) args += Array(OptionsHelp::TEXT[long_opt_symbol]) opts.on(*args) do |arg| @options[long_opt_symbol] = arg yield arg if block_given? end end
[ "def", "option", "(", "opts", ",", "*", "args", ")", "long_opt_symbol", "=", "long_opt_symbol", "(", "args", ")", "args", "+=", "Array", "(", "OptionsHelp", "::", "TEXT", "[", "long_opt_symbol", "]", ")", "opts", ".", "on", "(", "args", ")", "do", "|", "arg", "|", "@options", "[", "long_opt_symbol", "]", "=", "arg", "yield", "arg", "if", "block_given?", "end", "end" ]
Sets a value in the @options hash, based on the given long option and its value, in addition to calling the block if a block is given.
[ "Sets", "a", "value", "in", "the" ]
2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0
https://github.com/rubocop-hq/rubocop/blob/2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0/lib/rubocop/options.rb#L196-L203
10,721
rubocop-hq/rubocop
lib/rubocop/config.rb
RuboCop.Config.possibly_include_hidden?
def possibly_include_hidden? return @possibly_include_hidden if defined?(@possibly_include_hidden) @possibly_include_hidden = patterns_to_include.any? do |s| s.is_a?(Regexp) || s.start_with?('.') || s.include?('/.') end end
ruby
def possibly_include_hidden? return @possibly_include_hidden if defined?(@possibly_include_hidden) @possibly_include_hidden = patterns_to_include.any? do |s| s.is_a?(Regexp) || s.start_with?('.') || s.include?('/.') end end
[ "def", "possibly_include_hidden?", "return", "@possibly_include_hidden", "if", "defined?", "(", "@possibly_include_hidden", ")", "@possibly_include_hidden", "=", "patterns_to_include", ".", "any?", "do", "|", "s", "|", "s", ".", "is_a?", "(", "Regexp", ")", "||", "s", ".", "start_with?", "(", "'.'", ")", "||", "s", ".", "include?", "(", "'/.'", ")", "end", "end" ]
Returns true if there's a chance that an Include pattern matches hidden files, false if that's definitely not possible.
[ "Returns", "true", "if", "there", "s", "a", "chance", "that", "an", "Include", "pattern", "matches", "hidden", "files", "false", "if", "that", "s", "definitely", "not", "possible", "." ]
2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0
https://github.com/rubocop-hq/rubocop/blob/2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0/lib/rubocop/config.rb#L410-L416
10,722
rubocop-hq/rubocop
lib/rubocop/runner.rb
RuboCop.Runner.check_for_infinite_loop
def check_for_infinite_loop(processed_source, offenses) checksum = processed_source.checksum if @processed_sources.include?(checksum) raise InfiniteCorrectionLoop.new(processed_source.path, offenses) end @processed_sources << checksum end
ruby
def check_for_infinite_loop(processed_source, offenses) checksum = processed_source.checksum if @processed_sources.include?(checksum) raise InfiniteCorrectionLoop.new(processed_source.path, offenses) end @processed_sources << checksum end
[ "def", "check_for_infinite_loop", "(", "processed_source", ",", "offenses", ")", "checksum", "=", "processed_source", ".", "checksum", "if", "@processed_sources", ".", "include?", "(", "checksum", ")", "raise", "InfiniteCorrectionLoop", ".", "new", "(", "processed_source", ".", "path", ",", "offenses", ")", "end", "@processed_sources", "<<", "checksum", "end" ]
Check whether a run created source identical to a previous run, which means that we definitely have an infinite loop.
[ "Check", "whether", "a", "run", "created", "source", "identical", "to", "a", "previous", "run", "which", "means", "that", "we", "definitely", "have", "an", "infinite", "loop", "." ]
2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0
https://github.com/rubocop-hq/rubocop/blob/2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0/lib/rubocop/runner.rb#L259-L267
10,723
rubocop-hq/rubocop
lib/rubocop/target_finder.rb
RuboCop.TargetFinder.target_files_in_dir
def target_files_in_dir(base_dir = Dir.pwd) # Support Windows: Backslashes from command-line -> forward slashes if File::ALT_SEPARATOR base_dir = base_dir.gsub(File::ALT_SEPARATOR, File::SEPARATOR) end all_files = find_files(base_dir, File::FNM_DOTMATCH) hidden_files = Set.new(all_files - find_files(base_dir, 0)) base_dir_config = @config_store.for(base_dir) target_files = all_files.select do |file| to_inspect?(file, hidden_files, base_dir_config) end # Most recently modified file first. target_files.sort_by! { |path| -Integer(File.mtime(path)) } if fail_fast? target_files end
ruby
def target_files_in_dir(base_dir = Dir.pwd) # Support Windows: Backslashes from command-line -> forward slashes if File::ALT_SEPARATOR base_dir = base_dir.gsub(File::ALT_SEPARATOR, File::SEPARATOR) end all_files = find_files(base_dir, File::FNM_DOTMATCH) hidden_files = Set.new(all_files - find_files(base_dir, 0)) base_dir_config = @config_store.for(base_dir) target_files = all_files.select do |file| to_inspect?(file, hidden_files, base_dir_config) end # Most recently modified file first. target_files.sort_by! { |path| -Integer(File.mtime(path)) } if fail_fast? target_files end
[ "def", "target_files_in_dir", "(", "base_dir", "=", "Dir", ".", "pwd", ")", "# Support Windows: Backslashes from command-line -> forward slashes", "if", "File", "::", "ALT_SEPARATOR", "base_dir", "=", "base_dir", ".", "gsub", "(", "File", "::", "ALT_SEPARATOR", ",", "File", "::", "SEPARATOR", ")", "end", "all_files", "=", "find_files", "(", "base_dir", ",", "File", "::", "FNM_DOTMATCH", ")", "hidden_files", "=", "Set", ".", "new", "(", "all_files", "-", "find_files", "(", "base_dir", ",", "0", ")", ")", "base_dir_config", "=", "@config_store", ".", "for", "(", "base_dir", ")", "target_files", "=", "all_files", ".", "select", "do", "|", "file", "|", "to_inspect?", "(", "file", ",", "hidden_files", ",", "base_dir_config", ")", "end", "# Most recently modified file first.", "target_files", ".", "sort_by!", "{", "|", "path", "|", "-", "Integer", "(", "File", ".", "mtime", "(", "path", ")", ")", "}", "if", "fail_fast?", "target_files", "end" ]
Finds all Ruby source files under the current or other supplied directory. A Ruby source file is defined as a file with the `.rb` extension or a file with no extension that has a ruby shebang line as its first line. It is possible to specify includes and excludes using the config file, so you can include other Ruby files like Rakefiles and gemspecs. @param base_dir Root directory under which to search for ruby source files @return [Array] Array of filenames
[ "Finds", "all", "Ruby", "source", "files", "under", "the", "current", "or", "other", "supplied", "directory", ".", "A", "Ruby", "source", "file", "is", "defined", "as", "a", "file", "with", "the", ".", "rb", "extension", "or", "a", "file", "with", "no", "extension", "that", "has", "a", "ruby", "shebang", "line", "as", "its", "first", "line", ".", "It", "is", "possible", "to", "specify", "includes", "and", "excludes", "using", "the", "config", "file", "so", "you", "can", "include", "other", "Ruby", "files", "like", "Rakefiles", "and", "gemspecs", "." ]
2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0
https://github.com/rubocop-hq/rubocop/blob/2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0/lib/rubocop/target_finder.rb#L55-L72
10,724
rubocop-hq/rubocop
lib/rubocop/result_cache.rb
RuboCop.ResultCache.rubocop_checksum
def rubocop_checksum ResultCache.source_checksum ||= begin lib_root = File.join(File.dirname(__FILE__), '..') exe_root = File.join(lib_root, '..', 'exe') # These are all the files we have `require`d plus everything in the # exe directory. A change to any of them could affect the cop output # so we include them in the cache hash. source_files = $LOADED_FEATURES + Find.find(exe_root).to_a sources = source_files .select { |path| File.file?(path) } .sort .map { |path| IO.read(path, encoding: Encoding::UTF_8) } Digest::SHA1.hexdigest(sources.join) end end
ruby
def rubocop_checksum ResultCache.source_checksum ||= begin lib_root = File.join(File.dirname(__FILE__), '..') exe_root = File.join(lib_root, '..', 'exe') # These are all the files we have `require`d plus everything in the # exe directory. A change to any of them could affect the cop output # so we include them in the cache hash. source_files = $LOADED_FEATURES + Find.find(exe_root).to_a sources = source_files .select { |path| File.file?(path) } .sort .map { |path| IO.read(path, encoding: Encoding::UTF_8) } Digest::SHA1.hexdigest(sources.join) end end
[ "def", "rubocop_checksum", "ResultCache", ".", "source_checksum", "||=", "begin", "lib_root", "=", "File", ".", "join", "(", "File", ".", "dirname", "(", "__FILE__", ")", ",", "'..'", ")", "exe_root", "=", "File", ".", "join", "(", "lib_root", ",", "'..'", ",", "'exe'", ")", "# These are all the files we have `require`d plus everything in the", "# exe directory. A change to any of them could affect the cop output", "# so we include them in the cache hash.", "source_files", "=", "$LOADED_FEATURES", "+", "Find", ".", "find", "(", "exe_root", ")", ".", "to_a", "sources", "=", "source_files", ".", "select", "{", "|", "path", "|", "File", ".", "file?", "(", "path", ")", "}", ".", "sort", ".", "map", "{", "|", "path", "|", "IO", ".", "read", "(", "path", ",", "encoding", ":", "Encoding", "::", "UTF_8", ")", "}", "Digest", "::", "SHA1", ".", "hexdigest", "(", "sources", ".", "join", ")", "end", "end" ]
The checksum of the rubocop program running the inspection.
[ "The", "checksum", "of", "the", "rubocop", "program", "running", "the", "inspection", "." ]
2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0
https://github.com/rubocop-hq/rubocop/blob/2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0/lib/rubocop/result_cache.rb#L162-L178
10,725
rubocop-hq/rubocop
lib/rubocop/result_cache.rb
RuboCop.ResultCache.relevant_options_digest
def relevant_options_digest(options) options = options.reject { |key, _| NON_CHANGING.include?(key) } options = options.to_s.gsub(/[^a-z]+/i, '_') # We must avoid making file names too long for some filesystems to handle # If they are short, we can leave them human-readable options.length <= 32 ? options : Digest::SHA1.hexdigest(options) end
ruby
def relevant_options_digest(options) options = options.reject { |key, _| NON_CHANGING.include?(key) } options = options.to_s.gsub(/[^a-z]+/i, '_') # We must avoid making file names too long for some filesystems to handle # If they are short, we can leave them human-readable options.length <= 32 ? options : Digest::SHA1.hexdigest(options) end
[ "def", "relevant_options_digest", "(", "options", ")", "options", "=", "options", ".", "reject", "{", "|", "key", ",", "_", "|", "NON_CHANGING", ".", "include?", "(", "key", ")", "}", "options", "=", "options", ".", "to_s", ".", "gsub", "(", "/", "/i", ",", "'_'", ")", "# We must avoid making file names too long for some filesystems to handle", "# If they are short, we can leave them human-readable", "options", ".", "length", "<=", "32", "?", "options", ":", "Digest", "::", "SHA1", ".", "hexdigest", "(", "options", ")", "end" ]
Return a hash of the options given at invocation, minus the ones that have no effect on which offenses and disabled line ranges are found, and thus don't affect caching.
[ "Return", "a", "hash", "of", "the", "options", "given", "at", "invocation", "minus", "the", "ones", "that", "have", "no", "effect", "on", "which", "offenses", "and", "disabled", "line", "ranges", "are", "found", "and", "thus", "don", "t", "affect", "caching", "." ]
2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0
https://github.com/rubocop-hq/rubocop/blob/2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0/lib/rubocop/result_cache.rb#L183-L189
10,726
rubocop-hq/rubocop
lib/rubocop/config_loader_resolver.rb
RuboCop.ConfigLoaderResolver.merge
def merge(base_hash, derived_hash, **opts) result = base_hash.merge(derived_hash) keys_appearing_in_both = base_hash.keys & derived_hash.keys keys_appearing_in_both.each do |key| if opts[:unset_nil] && derived_hash[key].nil? result.delete(key) elsif base_hash[key].is_a?(Hash) result[key] = merge(base_hash[key], derived_hash[key], **opts) elsif should_union?(base_hash, key, opts[:inherit_mode]) result[key] = base_hash[key] | derived_hash[key] elsif opts[:debug] warn_on_duplicate_setting(base_hash, derived_hash, key, opts) end end result end
ruby
def merge(base_hash, derived_hash, **opts) result = base_hash.merge(derived_hash) keys_appearing_in_both = base_hash.keys & derived_hash.keys keys_appearing_in_both.each do |key| if opts[:unset_nil] && derived_hash[key].nil? result.delete(key) elsif base_hash[key].is_a?(Hash) result[key] = merge(base_hash[key], derived_hash[key], **opts) elsif should_union?(base_hash, key, opts[:inherit_mode]) result[key] = base_hash[key] | derived_hash[key] elsif opts[:debug] warn_on_duplicate_setting(base_hash, derived_hash, key, opts) end end result end
[ "def", "merge", "(", "base_hash", ",", "derived_hash", ",", "**", "opts", ")", "result", "=", "base_hash", ".", "merge", "(", "derived_hash", ")", "keys_appearing_in_both", "=", "base_hash", ".", "keys", "&", "derived_hash", ".", "keys", "keys_appearing_in_both", ".", "each", "do", "|", "key", "|", "if", "opts", "[", ":unset_nil", "]", "&&", "derived_hash", "[", "key", "]", ".", "nil?", "result", ".", "delete", "(", "key", ")", "elsif", "base_hash", "[", "key", "]", ".", "is_a?", "(", "Hash", ")", "result", "[", "key", "]", "=", "merge", "(", "base_hash", "[", "key", "]", ",", "derived_hash", "[", "key", "]", ",", "**", "opts", ")", "elsif", "should_union?", "(", "base_hash", ",", "key", ",", "opts", "[", ":inherit_mode", "]", ")", "result", "[", "key", "]", "=", "base_hash", "[", "key", "]", "|", "derived_hash", "[", "key", "]", "elsif", "opts", "[", ":debug", "]", "warn_on_duplicate_setting", "(", "base_hash", ",", "derived_hash", ",", "key", ",", "opts", ")", "end", "end", "result", "end" ]
Return a recursive merge of two hashes. That is, a normal hash merge, with the addition that any value that is a hash, and occurs in both arguments, will also be merged. And so on. rubocop:disable Metrics/AbcSize
[ "Return", "a", "recursive", "merge", "of", "two", "hashes", ".", "That", "is", "a", "normal", "hash", "merge", "with", "the", "addition", "that", "any", "value", "that", "is", "a", "hash", "and", "occurs", "in", "both", "arguments", "will", "also", "be", "merged", ".", "And", "so", "on", "." ]
2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0
https://github.com/rubocop-hq/rubocop/blob/2a4f4f0fdac4e1bb25891fc312af2ea60c6aa2f0/lib/rubocop/config_loader_resolver.rb#L83-L98
10,727
chef/chef
lib/chef/shell/shell_session.rb
Shell.DoppelGangerClient.build_node
def build_node Chef::Log.trace("Building node object for #{@node_name}") @node = Chef::Node.find_or_create(node_name) ohai_data = @ohai.data.merge(@node.automatic_attrs) @node.consume_external_attrs(ohai_data, nil) @run_list_expansion = @node.expand!("server") @expanded_run_list_with_versions = @run_list_expansion.recipes.with_version_constraints_strings Chef::Log.info("Run List is [#{@node.run_list}]") Chef::Log.info("Run List expands to [#{@expanded_run_list_with_versions.join(', ')}]") @node end
ruby
def build_node Chef::Log.trace("Building node object for #{@node_name}") @node = Chef::Node.find_or_create(node_name) ohai_data = @ohai.data.merge(@node.automatic_attrs) @node.consume_external_attrs(ohai_data, nil) @run_list_expansion = @node.expand!("server") @expanded_run_list_with_versions = @run_list_expansion.recipes.with_version_constraints_strings Chef::Log.info("Run List is [#{@node.run_list}]") Chef::Log.info("Run List expands to [#{@expanded_run_list_with_versions.join(', ')}]") @node end
[ "def", "build_node", "Chef", "::", "Log", ".", "trace", "(", "\"Building node object for #{@node_name}\"", ")", "@node", "=", "Chef", "::", "Node", ".", "find_or_create", "(", "node_name", ")", "ohai_data", "=", "@ohai", ".", "data", ".", "merge", "(", "@node", ".", "automatic_attrs", ")", "@node", ".", "consume_external_attrs", "(", "ohai_data", ",", "nil", ")", "@run_list_expansion", "=", "@node", ".", "expand!", "(", "\"server\"", ")", "@expanded_run_list_with_versions", "=", "@run_list_expansion", ".", "recipes", ".", "with_version_constraints_strings", "Chef", "::", "Log", ".", "info", "(", "\"Run List is [#{@node.run_list}]\"", ")", "Chef", "::", "Log", ".", "info", "(", "\"Run List expands to [#{@expanded_run_list_with_versions.join(', ')}]\"", ")", "@node", "end" ]
DoppelGanger implementation of build_node. preserves as many of the node's attributes, and does not save updates to the server
[ "DoppelGanger", "implementation", "of", "build_node", ".", "preserves", "as", "many", "of", "the", "node", "s", "attributes", "and", "does", "not", "save", "updates", "to", "the", "server" ]
61f69e18e69e0dca6e8cffdcd7451181d874cdb3
https://github.com/chef/chef/blob/61f69e18e69e0dca6e8cffdcd7451181d874cdb3/lib/chef/shell/shell_session.rb#L254-L264
10,728
chef/chef
lib/chef/shell/model_wrapper.rb
Shell.ModelWrapper.list_objects
def list_objects objects = @model_class.method(:list).arity == 0 ? @model_class.list : @model_class.list(true) objects.map { |obj| Array(obj).find { |o| o.kind_of?(@model_class) } } end
ruby
def list_objects objects = @model_class.method(:list).arity == 0 ? @model_class.list : @model_class.list(true) objects.map { |obj| Array(obj).find { |o| o.kind_of?(@model_class) } } end
[ "def", "list_objects", "objects", "=", "@model_class", ".", "method", "(", ":list", ")", ".", "arity", "==", "0", "?", "@model_class", ".", "list", ":", "@model_class", ".", "list", "(", "true", ")", "objects", ".", "map", "{", "|", "obj", "|", "Array", "(", "obj", ")", ".", "find", "{", "|", "o", "|", "o", ".", "kind_of?", "(", "@model_class", ")", "}", "}", "end" ]
paper over inconsistencies in the model classes APIs, and return the objects the user wanted instead of the URI=>object stuff
[ "paper", "over", "inconsistencies", "in", "the", "model", "classes", "APIs", "and", "return", "the", "objects", "the", "user", "wanted", "instead", "of", "the", "URI", "=", ">", "object", "stuff" ]
61f69e18e69e0dca6e8cffdcd7451181d874cdb3
https://github.com/chef/chef/blob/61f69e18e69e0dca6e8cffdcd7451181d874cdb3/lib/chef/shell/model_wrapper.rb#L82-L85
10,729
chef/chef
chef-config/lib/chef-config/workstation_config_loader.rb
ChefConfig.WorkstationConfigLoader.apply_defaults
def apply_defaults # If we don't have a better guess use the username. Config[:node_name] ||= Etc.getlogin # If we don't have a key (path or inline) check user.pem and $node_name.pem. unless Config.key?(:client_key) || Config.key?(:client_key_contents) key_path = find_default_key(["#{Config[:node_name]}.pem", "user.pem"]) Config[:client_key] = key_path if key_path end # Similarly look for a validation key file, though this should be less # common these days. unless Config.key?(:validation_key) || Config.key?(:validation_key_contents) key_path = find_default_key(["#{Config[:validation_client_name]}.pem", "validator.pem", "validation.pem"]) Config[:validation_key] = key_path if key_path end end
ruby
def apply_defaults # If we don't have a better guess use the username. Config[:node_name] ||= Etc.getlogin # If we don't have a key (path or inline) check user.pem and $node_name.pem. unless Config.key?(:client_key) || Config.key?(:client_key_contents) key_path = find_default_key(["#{Config[:node_name]}.pem", "user.pem"]) Config[:client_key] = key_path if key_path end # Similarly look for a validation key file, though this should be less # common these days. unless Config.key?(:validation_key) || Config.key?(:validation_key_contents) key_path = find_default_key(["#{Config[:validation_client_name]}.pem", "validator.pem", "validation.pem"]) Config[:validation_key] = key_path if key_path end end
[ "def", "apply_defaults", "# If we don't have a better guess use the username.", "Config", "[", ":node_name", "]", "||=", "Etc", ".", "getlogin", "# If we don't have a key (path or inline) check user.pem and $node_name.pem.", "unless", "Config", ".", "key?", "(", ":client_key", ")", "||", "Config", ".", "key?", "(", ":client_key_contents", ")", "key_path", "=", "find_default_key", "(", "[", "\"#{Config[:node_name]}.pem\"", ",", "\"user.pem\"", "]", ")", "Config", "[", ":client_key", "]", "=", "key_path", "if", "key_path", "end", "# Similarly look for a validation key file, though this should be less", "# common these days.", "unless", "Config", ".", "key?", "(", ":validation_key", ")", "||", "Config", ".", "key?", "(", ":validation_key_contents", ")", "key_path", "=", "find_default_key", "(", "[", "\"#{Config[:validation_client_name]}.pem\"", ",", "\"validator.pem\"", ",", "\"validation.pem\"", "]", ")", "Config", "[", ":validation_key", "]", "=", "key_path", "if", "key_path", "end", "end" ]
Apply default configuration values for workstation-style tools. Global defaults should go in {ChefConfig::Config} instead, this is only for things like `knife` and `chef`. @api private @since 14.3 @return [void]
[ "Apply", "default", "configuration", "values", "for", "workstation", "-", "style", "tools", "." ]
61f69e18e69e0dca6e8cffdcd7451181d874cdb3
https://github.com/chef/chef/blob/61f69e18e69e0dca6e8cffdcd7451181d874cdb3/chef-config/lib/chef-config/workstation_config_loader.rb#L223-L237
10,730
chef/chef
chef-config/lib/chef-config/workstation_config_loader.rb
ChefConfig.WorkstationConfigLoader.find_default_key
def find_default_key(key_names) key_names.each do |filename| path = Pathname.new(filename) # If we have a config location (like ./.chef/), look there first. if config_location local_path = path.expand_path(File.dirname(config_location)) return local_path.to_s if local_path.exist? end # Then check ~/.chef. home_path = path.expand_path(home_chef_dir) return home_path.to_s if home_path.exist? end nil end
ruby
def find_default_key(key_names) key_names.each do |filename| path = Pathname.new(filename) # If we have a config location (like ./.chef/), look there first. if config_location local_path = path.expand_path(File.dirname(config_location)) return local_path.to_s if local_path.exist? end # Then check ~/.chef. home_path = path.expand_path(home_chef_dir) return home_path.to_s if home_path.exist? end nil end
[ "def", "find_default_key", "(", "key_names", ")", "key_names", ".", "each", "do", "|", "filename", "|", "path", "=", "Pathname", ".", "new", "(", "filename", ")", "# If we have a config location (like ./.chef/), look there first.", "if", "config_location", "local_path", "=", "path", ".", "expand_path", "(", "File", ".", "dirname", "(", "config_location", ")", ")", "return", "local_path", ".", "to_s", "if", "local_path", ".", "exist?", "end", "# Then check ~/.chef.", "home_path", "=", "path", ".", "expand_path", "(", "home_chef_dir", ")", "return", "home_path", ".", "to_s", "if", "home_path", ".", "exist?", "end", "nil", "end" ]
Look for a default key file. This searches for any of a list of possible default keys, checking both the local `.chef/` folder and the home directory `~/.chef/`. Returns `nil` if no matching file is found. @api private @since 14.3 @param key_names [Array<String>] A list of possible filenames to check for. The first one found will be returned. @return [String, nil]
[ "Look", "for", "a", "default", "key", "file", "." ]
61f69e18e69e0dca6e8cffdcd7451181d874cdb3
https://github.com/chef/chef/blob/61f69e18e69e0dca6e8cffdcd7451181d874cdb3/chef-config/lib/chef-config/workstation_config_loader.rb#L250-L263
10,731
sinatra/sinatra
lib/sinatra/base.rb
Sinatra.Helpers.status
def status(value = nil) response.status = Rack::Utils.status_code(value) if value response.status end
ruby
def status(value = nil) response.status = Rack::Utils.status_code(value) if value response.status end
[ "def", "status", "(", "value", "=", "nil", ")", "response", ".", "status", "=", "Rack", "::", "Utils", ".", "status_code", "(", "value", ")", "if", "value", "response", ".", "status", "end" ]
Set or retrieve the response status code.
[ "Set", "or", "retrieve", "the", "response", "status", "code", "." ]
1aa64f9858edc3f93cc8d46e26f724c1ae103b1c
https://github.com/sinatra/sinatra/blob/1aa64f9858edc3f93cc8d46e26f724c1ae103b1c/lib/sinatra/base.rb#L247-L250
10,732
sinatra/sinatra
sinatra-contrib/lib/sinatra/config_file.rb
Sinatra.ConfigFile.config_file
def config_file(*paths) Dir.chdir(root || '.') do paths.each do |pattern| Dir.glob(pattern) do |file| raise UnsupportedConfigType unless ['.yml', '.erb'].include?(File.extname(file)) logger.info "loading config file '#{file}'" if logging? && respond_to?(:logger) document = ERB.new(IO.read(file)).result yaml = YAML.load(document) config = config_for_env(yaml) config.each_pair { |key, value| set(key, value) } end end end end
ruby
def config_file(*paths) Dir.chdir(root || '.') do paths.each do |pattern| Dir.glob(pattern) do |file| raise UnsupportedConfigType unless ['.yml', '.erb'].include?(File.extname(file)) logger.info "loading config file '#{file}'" if logging? && respond_to?(:logger) document = ERB.new(IO.read(file)).result yaml = YAML.load(document) config = config_for_env(yaml) config.each_pair { |key, value| set(key, value) } end end end end
[ "def", "config_file", "(", "*", "paths", ")", "Dir", ".", "chdir", "(", "root", "||", "'.'", ")", "do", "paths", ".", "each", "do", "|", "pattern", "|", "Dir", ".", "glob", "(", "pattern", ")", "do", "|", "file", "|", "raise", "UnsupportedConfigType", "unless", "[", "'.yml'", ",", "'.erb'", "]", ".", "include?", "(", "File", ".", "extname", "(", "file", ")", ")", "logger", ".", "info", "\"loading config file '#{file}'\"", "if", "logging?", "&&", "respond_to?", "(", ":logger", ")", "document", "=", "ERB", ".", "new", "(", "IO", ".", "read", "(", "file", ")", ")", ".", "result", "yaml", "=", "YAML", ".", "load", "(", "document", ")", "config", "=", "config_for_env", "(", "yaml", ")", "config", ".", "each_pair", "{", "|", "key", ",", "value", "|", "set", "(", "key", ",", "value", ")", "}", "end", "end", "end", "end" ]
Loads the configuration from the YAML files whose +paths+ are passed as arguments, filtering the settings for the current environment. Note that these +paths+ can actually be globs.
[ "Loads", "the", "configuration", "from", "the", "YAML", "files", "whose", "+", "paths", "+", "are", "passed", "as", "arguments", "filtering", "the", "settings", "for", "the", "current", "environment", ".", "Note", "that", "these", "+", "paths", "+", "can", "actually", "be", "globs", "." ]
1aa64f9858edc3f93cc8d46e26f724c1ae103b1c
https://github.com/sinatra/sinatra/blob/1aa64f9858edc3f93cc8d46e26f724c1ae103b1c/sinatra-contrib/lib/sinatra/config_file.rb#L120-L133
10,733
sinatra/sinatra
sinatra-contrib/lib/sinatra/config_file.rb
Sinatra.ConfigFile.environment_keys?
def environment_keys?(hash) hash.is_a?(Hash) && hash.any? { |k, _| environments.include?(k.to_s) } end
ruby
def environment_keys?(hash) hash.is_a?(Hash) && hash.any? { |k, _| environments.include?(k.to_s) } end
[ "def", "environment_keys?", "(", "hash", ")", "hash", ".", "is_a?", "(", "Hash", ")", "&&", "hash", ".", "any?", "{", "|", "k", ",", "_", "|", "environments", ".", "include?", "(", "k", ".", "to_s", ")", "}", "end" ]
Returns true if supplied with a hash that has any recognized +environments+ in its root keys.
[ "Returns", "true", "if", "supplied", "with", "a", "hash", "that", "has", "any", "recognized", "+", "environments", "+", "in", "its", "root", "keys", "." ]
1aa64f9858edc3f93cc8d46e26f724c1ae103b1c
https://github.com/sinatra/sinatra/blob/1aa64f9858edc3f93cc8d46e26f724c1ae103b1c/sinatra-contrib/lib/sinatra/config_file.rb#L166-L168
10,734
sinatra/sinatra
sinatra-contrib/lib/sinatra/link_header.rb
Sinatra.LinkHeader.stylesheet
def stylesheet(*urls) urls << {} unless urls.last.respond_to? :to_hash urls.last[:type] ||= mime_type(:css) link(:stylesheet, *urls) end
ruby
def stylesheet(*urls) urls << {} unless urls.last.respond_to? :to_hash urls.last[:type] ||= mime_type(:css) link(:stylesheet, *urls) end
[ "def", "stylesheet", "(", "*", "urls", ")", "urls", "<<", "{", "}", "unless", "urls", ".", "last", ".", "respond_to?", ":to_hash", "urls", ".", "last", "[", ":type", "]", "||=", "mime_type", "(", ":css", ")", "link", "(", ":stylesheet", ",", "urls", ")", "end" ]
Sets Link HTTP header and returns HTML tags for using stylesheets.
[ "Sets", "Link", "HTTP", "header", "and", "returns", "HTML", "tags", "for", "using", "stylesheets", "." ]
1aa64f9858edc3f93cc8d46e26f724c1ae103b1c
https://github.com/sinatra/sinatra/blob/1aa64f9858edc3f93cc8d46e26f724c1ae103b1c/sinatra-contrib/lib/sinatra/link_header.rb#L65-L69
10,735
sinatra/sinatra
sinatra-contrib/lib/sinatra/link_header.rb
Sinatra.LinkHeader.link
def link(*urls) opts = urls.last.respond_to?(:to_hash) ? urls.pop : {} opts[:rel] = urls.shift unless urls.first.respond_to? :to_str options = opts.map { |k, v| " #{k}=#{v.to_s.inspect}" } html_pattern = "<link href=\"%s\"#{options.join} />" http_pattern = ["<%s>", *options].join ";" link = (response["Link"] ||= "") urls.map do |url| link << ",\n" unless link.empty? link << (http_pattern % url) html_pattern % url end.join "\n" end
ruby
def link(*urls) opts = urls.last.respond_to?(:to_hash) ? urls.pop : {} opts[:rel] = urls.shift unless urls.first.respond_to? :to_str options = opts.map { |k, v| " #{k}=#{v.to_s.inspect}" } html_pattern = "<link href=\"%s\"#{options.join} />" http_pattern = ["<%s>", *options].join ";" link = (response["Link"] ||= "") urls.map do |url| link << ",\n" unless link.empty? link << (http_pattern % url) html_pattern % url end.join "\n" end
[ "def", "link", "(", "*", "urls", ")", "opts", "=", "urls", ".", "last", ".", "respond_to?", "(", ":to_hash", ")", "?", "urls", ".", "pop", ":", "{", "}", "opts", "[", ":rel", "]", "=", "urls", ".", "shift", "unless", "urls", ".", "first", ".", "respond_to?", ":to_str", "options", "=", "opts", ".", "map", "{", "|", "k", ",", "v", "|", "\" #{k}=#{v.to_s.inspect}\"", "}", "html_pattern", "=", "\"<link href=\\\"%s\\\"#{options.join} />\"", "http_pattern", "=", "[", "\"<%s>\"", ",", "options", "]", ".", "join", "\";\"", "link", "=", "(", "response", "[", "\"Link\"", "]", "||=", "\"\"", ")", "urls", ".", "map", "do", "|", "url", "|", "link", "<<", "\",\\n\"", "unless", "link", ".", "empty?", "link", "<<", "(", "http_pattern", "%", "url", ")", "html_pattern", "%", "url", "end", ".", "join", "\"\\n\"", "end" ]
Sets Link HTTP header and returns corresponding HTML tags. Example: # Sets header: # Link: </foo>; rel="next" # Returns String: # '<link href="/foo" rel="next" />' link '/foo', :rel => :next # Multiple URLs link :stylesheet, '/a.css', '/b.css'
[ "Sets", "Link", "HTTP", "header", "and", "returns", "corresponding", "HTML", "tags", "." ]
1aa64f9858edc3f93cc8d46e26f724c1ae103b1c
https://github.com/sinatra/sinatra/blob/1aa64f9858edc3f93cc8d46e26f724c1ae103b1c/sinatra-contrib/lib/sinatra/link_header.rb#L84-L97
10,736
elastic/elasticsearch-ruby
profile/benchmarking.rb
Elasticsearch.Benchmarking.each_run
def each_run(file) if file file = File.new(file) matrix = YAML.load(ERB.new(file.read).result) file.close matrix.each_with_index do |run, i| DEFAULT_RUN.merge(run) yield(run, i) end else yield(DEFAULT_RUN) end end
ruby
def each_run(file) if file file = File.new(file) matrix = YAML.load(ERB.new(file.read).result) file.close matrix.each_with_index do |run, i| DEFAULT_RUN.merge(run) yield(run, i) end else yield(DEFAULT_RUN) end end
[ "def", "each_run", "(", "file", ")", "if", "file", "file", "=", "File", ".", "new", "(", "file", ")", "matrix", "=", "YAML", ".", "load", "(", "ERB", ".", "new", "(", "file", ".", "read", ")", ".", "result", ")", "file", ".", "close", "matrix", ".", "each_with_index", "do", "|", "run", ",", "i", "|", "DEFAULT_RUN", ".", "merge", "(", "run", ")", "yield", "(", "run", ",", "i", ")", "end", "else", "yield", "(", "DEFAULT_RUN", ")", "end", "end" ]
Parse a file of run definitions and yield each run. @params [ String ] file The YAML file containing the matrix of test run definitions. @yieldparam [ Hash ] A test run definition. @since 7.0.0
[ "Parse", "a", "file", "of", "run", "definitions", "and", "yield", "each", "run", "." ]
c0dd04834e5c7cf13792b4ced8e894c44d1f6f35
https://github.com/elastic/elasticsearch-ruby/blob/c0dd04834e5c7cf13792b4ced8e894c44d1f6f35/profile/benchmarking.rb#L70-L83
10,737
thoughtbot/factory_bot
lib/factory_bot/definition_proxy.rb
FactoryBot.DefinitionProxy.add_attribute
def add_attribute(name, &block) declaration = Declaration::Dynamic.new(name, @ignore, block) @definition.declare_attribute(declaration) end
ruby
def add_attribute(name, &block) declaration = Declaration::Dynamic.new(name, @ignore, block) @definition.declare_attribute(declaration) end
[ "def", "add_attribute", "(", "name", ",", "&", "block", ")", "declaration", "=", "Declaration", "::", "Dynamic", ".", "new", "(", "name", ",", "@ignore", ",", "block", ")", "@definition", ".", "declare_attribute", "(", "declaration", ")", "end" ]
Adds an attribute to the factory. The attribute value will be generated "lazily" by calling the block whenever an instance is generated. The block will not be called if the attribute is overridden for a specific instance. Arguments: * name: +Symbol+ or +String+ The name of this attribute. This will be assigned using "name=" for generated instances.
[ "Adds", "an", "attribute", "to", "the", "factory", ".", "The", "attribute", "value", "will", "be", "generated", "lazily", "by", "calling", "the", "block", "whenever", "an", "instance", "is", "generated", ".", "The", "block", "will", "not", "be", "called", "if", "the", "attribute", "is", "overridden", "for", "a", "specific", "instance", "." ]
99ac02400fd56bd1872fc3ed84f81ea5e8f27737
https://github.com/thoughtbot/factory_bot/blob/99ac02400fd56bd1872fc3ed84f81ea5e8f27737/lib/factory_bot/definition_proxy.rb#L47-L50
10,738
thoughtbot/factory_bot
lib/factory_bot/definition_proxy.rb
FactoryBot.DefinitionProxy.sequence
def sequence(name, *args, &block) sequence = Sequence.new(name, *args, &block) FactoryBot::Internal.register_inline_sequence(sequence) add_attribute(name) { increment_sequence(sequence) } end
ruby
def sequence(name, *args, &block) sequence = Sequence.new(name, *args, &block) FactoryBot::Internal.register_inline_sequence(sequence) add_attribute(name) { increment_sequence(sequence) } end
[ "def", "sequence", "(", "name", ",", "*", "args", ",", "&", "block", ")", "sequence", "=", "Sequence", ".", "new", "(", "name", ",", "args", ",", "block", ")", "FactoryBot", "::", "Internal", ".", "register_inline_sequence", "(", "sequence", ")", "add_attribute", "(", "name", ")", "{", "increment_sequence", "(", "sequence", ")", "}", "end" ]
Adds an attribute that will have unique values generated by a sequence with a specified format. The result of: factory :user do sequence(:email) { |n| "person#{n}@example.com" } end Is equal to: sequence(:email) { |n| "person#{n}@example.com" } factory :user do email { FactoryBot.generate(:email) } end Except that no globally available sequence will be defined.
[ "Adds", "an", "attribute", "that", "will", "have", "unique", "values", "generated", "by", "a", "sequence", "with", "a", "specified", "format", "." ]
99ac02400fd56bd1872fc3ed84f81ea5e8f27737
https://github.com/thoughtbot/factory_bot/blob/99ac02400fd56bd1872fc3ed84f81ea5e8f27737/lib/factory_bot/definition_proxy.rb#L122-L126
10,739
thoughtbot/factory_bot
lib/factory_bot/definition_proxy.rb
FactoryBot.DefinitionProxy.association
def association(name, *options) if block_given? raise AssociationDefinitionError.new( "Unexpected block passed to '#{name}' association "\ "in '#{@definition.name}' factory", ) else declaration = Declaration::Association.new(name, *options) @definition.declare_attribute(declaration) end end
ruby
def association(name, *options) if block_given? raise AssociationDefinitionError.new( "Unexpected block passed to '#{name}' association "\ "in '#{@definition.name}' factory", ) else declaration = Declaration::Association.new(name, *options) @definition.declare_attribute(declaration) end end
[ "def", "association", "(", "name", ",", "*", "options", ")", "if", "block_given?", "raise", "AssociationDefinitionError", ".", "new", "(", "\"Unexpected block passed to '#{name}' association \"", "\"in '#{@definition.name}' factory\"", ",", ")", "else", "declaration", "=", "Declaration", "::", "Association", ".", "new", "(", "name", ",", "options", ")", "@definition", ".", "declare_attribute", "(", "declaration", ")", "end", "end" ]
Adds an attribute that builds an association. The associated instance will be built using the same build strategy as the parent instance. Example: factory :user do name 'Joey' end factory :post do association :author, factory: :user end Arguments: * name: +Symbol+ The name of this attribute. * options: +Hash+ Options: * factory: +Symbol+ or +String+ The name of the factory to use when building the associated instance. If no name is given, the name of the attribute is assumed to be the name of the factory. For example, a "user" association will by default use the "user" factory.
[ "Adds", "an", "attribute", "that", "builds", "an", "association", ".", "The", "associated", "instance", "will", "be", "built", "using", "the", "same", "build", "strategy", "as", "the", "parent", "instance", "." ]
99ac02400fd56bd1872fc3ed84f81ea5e8f27737
https://github.com/thoughtbot/factory_bot/blob/99ac02400fd56bd1872fc3ed84f81ea5e8f27737/lib/factory_bot/definition_proxy.rb#L151-L161
10,740
rmosolgo/graphql-ruby
lib/graphql/query.rb
GraphQL.Query.lookahead
def lookahead @lookahead ||= begin ast_node = selected_operation root_type = warden.root_type_for_operation(ast_node.operation_type || "query") root_type = root_type.metadata[:type_class] || raise("Invariant: `lookahead` only works with class-based types") GraphQL::Execution::Lookahead.new(query: self, root_type: root_type, ast_nodes: [ast_node]) end end
ruby
def lookahead @lookahead ||= begin ast_node = selected_operation root_type = warden.root_type_for_operation(ast_node.operation_type || "query") root_type = root_type.metadata[:type_class] || raise("Invariant: `lookahead` only works with class-based types") GraphQL::Execution::Lookahead.new(query: self, root_type: root_type, ast_nodes: [ast_node]) end end
[ "def", "lookahead", "@lookahead", "||=", "begin", "ast_node", "=", "selected_operation", "root_type", "=", "warden", ".", "root_type_for_operation", "(", "ast_node", ".", "operation_type", "||", "\"query\"", ")", "root_type", "=", "root_type", ".", "metadata", "[", ":type_class", "]", "||", "raise", "(", "\"Invariant: `lookahead` only works with class-based types\"", ")", "GraphQL", "::", "Execution", "::", "Lookahead", ".", "new", "(", "query", ":", "self", ",", "root_type", ":", "root_type", ",", "ast_nodes", ":", "[", "ast_node", "]", ")", "end", "end" ]
A lookahead for the root selections of this query @return [GraphQL::Execution::Lookahead]
[ "A", "lookahead", "for", "the", "root", "selections", "of", "this", "query" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/query.rb#L151-L158
10,741
rmosolgo/graphql-ruby
lib/graphql/query.rb
GraphQL.Query.result
def result if !@executed with_prepared_ast { Execution::Multiplex.run_queries(@schema, [self], context: @context) } end @result ||= Query::Result.new(query: self, values: @result_values) end
ruby
def result if !@executed with_prepared_ast { Execution::Multiplex.run_queries(@schema, [self], context: @context) } end @result ||= Query::Result.new(query: self, values: @result_values) end
[ "def", "result", "if", "!", "@executed", "with_prepared_ast", "{", "Execution", "::", "Multiplex", ".", "run_queries", "(", "@schema", ",", "[", "self", "]", ",", "context", ":", "@context", ")", "}", "end", "@result", "||=", "Query", "::", "Result", ".", "new", "(", "query", ":", "self", ",", "values", ":", "@result_values", ")", "end" ]
Get the result for this query, executing it once @return [Hash] A GraphQL response, with `"data"` and/or `"errors"` keys
[ "Get", "the", "result", "for", "this", "query", "executing", "it", "once" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/query.rb#L183-L190
10,742
rmosolgo/graphql-ruby
lib/graphql/object_type.rb
GraphQL.ObjectType.implements
def implements(interfaces, inherit: false) if !interfaces.is_a?(Array) raise ArgumentError, "`implements(interfaces)` must be an array, not #{interfaces.class} (#{interfaces})" end @clean_interfaces = nil @clean_inherited_fields = nil dirty_ifaces = inherit ? @dirty_inherited_interfaces : @dirty_interfaces dirty_ifaces.concat(interfaces) end
ruby
def implements(interfaces, inherit: false) if !interfaces.is_a?(Array) raise ArgumentError, "`implements(interfaces)` must be an array, not #{interfaces.class} (#{interfaces})" end @clean_interfaces = nil @clean_inherited_fields = nil dirty_ifaces = inherit ? @dirty_inherited_interfaces : @dirty_interfaces dirty_ifaces.concat(interfaces) end
[ "def", "implements", "(", "interfaces", ",", "inherit", ":", "false", ")", "if", "!", "interfaces", ".", "is_a?", "(", "Array", ")", "raise", "ArgumentError", ",", "\"`implements(interfaces)` must be an array, not #{interfaces.class} (#{interfaces})\"", "end", "@clean_interfaces", "=", "nil", "@clean_inherited_fields", "=", "nil", "dirty_ifaces", "=", "inherit", "?", "@dirty_inherited_interfaces", ":", "@dirty_interfaces", "dirty_ifaces", ".", "concat", "(", "interfaces", ")", "end" ]
Declare that this object implements this interface. This declaration will be validated when the schema is defined. @param interfaces [Array<GraphQL::Interface>] add a new interface that this type implements @param inherits [Boolean] If true, copy the interfaces' field definitions to this type
[ "Declare", "that", "this", "object", "implements", "this", "interface", ".", "This", "declaration", "will", "be", "validated", "when", "the", "schema", "is", "defined", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/object_type.rb#L94-L103
10,743
rmosolgo/graphql-ruby
lib/graphql/backwards_compatibility.rb
GraphQL.BackwardsCompatibility.wrap_arity
def wrap_arity(callable, from:, to:, name:, last: false) arity = get_arity(callable) if arity == to || arity < 0 # It already matches, return it as is callable elsif arity == from # It has the old arity, so wrap it with an arity converter message ="#{name} with #{from} arguments is deprecated, it now accepts #{to} arguments, see:" backtrace = caller(0, 20) # Find the first line in the trace that isn't library internals: user_line = backtrace.find {|l| l !~ /lib\/graphql/ } warn(message + "\n" + user_line + "\n") wrapper = last ? LastArgumentsWrapper : FirstArgumentsWrapper wrapper.new(callable, from) else raise "Can't wrap #{callable} (arity: #{arity}) to have arity #{to}" end end
ruby
def wrap_arity(callable, from:, to:, name:, last: false) arity = get_arity(callable) if arity == to || arity < 0 # It already matches, return it as is callable elsif arity == from # It has the old arity, so wrap it with an arity converter message ="#{name} with #{from} arguments is deprecated, it now accepts #{to} arguments, see:" backtrace = caller(0, 20) # Find the first line in the trace that isn't library internals: user_line = backtrace.find {|l| l !~ /lib\/graphql/ } warn(message + "\n" + user_line + "\n") wrapper = last ? LastArgumentsWrapper : FirstArgumentsWrapper wrapper.new(callable, from) else raise "Can't wrap #{callable} (arity: #{arity}) to have arity #{to}" end end
[ "def", "wrap_arity", "(", "callable", ",", "from", ":", ",", "to", ":", ",", "name", ":", ",", "last", ":", "false", ")", "arity", "=", "get_arity", "(", "callable", ")", "if", "arity", "==", "to", "||", "arity", "<", "0", "# It already matches, return it as is", "callable", "elsif", "arity", "==", "from", "# It has the old arity, so wrap it with an arity converter", "message", "=", "\"#{name} with #{from} arguments is deprecated, it now accepts #{to} arguments, see:\"", "backtrace", "=", "caller", "(", "0", ",", "20", ")", "# Find the first line in the trace that isn't library internals:", "user_line", "=", "backtrace", ".", "find", "{", "|", "l", "|", "l", "!~", "/", "\\/", "/", "}", "warn", "(", "message", "+", "\"\\n\"", "+", "user_line", "+", "\"\\n\"", ")", "wrapper", "=", "last", "?", "LastArgumentsWrapper", ":", "FirstArgumentsWrapper", "wrapper", ".", "new", "(", "callable", ",", "from", ")", "else", "raise", "\"Can't wrap #{callable} (arity: #{arity}) to have arity #{to}\"", "end", "end" ]
Given a callable whose API used to take `from` arguments, check its arity, and if needed, apply a wrapper so that it can be called with `to` arguments. If a wrapper is applied, warn the application with `name`. If `last`, then use the last arguments to call the function.
[ "Given", "a", "callable", "whose", "API", "used", "to", "take", "from", "arguments", "check", "its", "arity", "and", "if", "needed", "apply", "a", "wrapper", "so", "that", "it", "can", "be", "called", "with", "to", "arguments", ".", "If", "a", "wrapper", "is", "applied", "warn", "the", "application", "with", "name", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/backwards_compatibility.rb#L13-L30
10,744
rmosolgo/graphql-ruby
lib/graphql/subscriptions.rb
GraphQL.Subscriptions.execute
def execute(subscription_id, event, object) # Lookup the saved data for this subscription query_data = read_subscription(subscription_id) # Fetch the required keys from the saved data query_string = query_data.fetch(:query_string) variables = query_data.fetch(:variables) context = query_data.fetch(:context) operation_name = query_data.fetch(:operation_name) # Re-evaluate the saved query result = @schema.execute( { query: query_string, context: context, subscription_topic: event.topic, operation_name: operation_name, variables: variables, root_value: object, } ) deliver(subscription_id, result) rescue GraphQL::Schema::Subscription::NoUpdateError # This update was skipped in user code; do nothing. rescue GraphQL::Schema::Subscription::UnsubscribedError # `unsubscribe` was called, clean up on our side # TODO also send `{more: false}` to client? delete_subscription(subscription_id) end
ruby
def execute(subscription_id, event, object) # Lookup the saved data for this subscription query_data = read_subscription(subscription_id) # Fetch the required keys from the saved data query_string = query_data.fetch(:query_string) variables = query_data.fetch(:variables) context = query_data.fetch(:context) operation_name = query_data.fetch(:operation_name) # Re-evaluate the saved query result = @schema.execute( { query: query_string, context: context, subscription_topic: event.topic, operation_name: operation_name, variables: variables, root_value: object, } ) deliver(subscription_id, result) rescue GraphQL::Schema::Subscription::NoUpdateError # This update was skipped in user code; do nothing. rescue GraphQL::Schema::Subscription::UnsubscribedError # `unsubscribe` was called, clean up on our side # TODO also send `{more: false}` to client? delete_subscription(subscription_id) end
[ "def", "execute", "(", "subscription_id", ",", "event", ",", "object", ")", "# Lookup the saved data for this subscription", "query_data", "=", "read_subscription", "(", "subscription_id", ")", "# Fetch the required keys from the saved data", "query_string", "=", "query_data", ".", "fetch", "(", ":query_string", ")", "variables", "=", "query_data", ".", "fetch", "(", ":variables", ")", "context", "=", "query_data", ".", "fetch", "(", ":context", ")", "operation_name", "=", "query_data", ".", "fetch", "(", ":operation_name", ")", "# Re-evaluate the saved query", "result", "=", "@schema", ".", "execute", "(", "{", "query", ":", "query_string", ",", "context", ":", "context", ",", "subscription_topic", ":", "event", ".", "topic", ",", "operation_name", ":", "operation_name", ",", "variables", ":", "variables", ",", "root_value", ":", "object", ",", "}", ")", "deliver", "(", "subscription_id", ",", "result", ")", "rescue", "GraphQL", "::", "Schema", "::", "Subscription", "::", "NoUpdateError", "# This update was skipped in user code; do nothing.", "rescue", "GraphQL", "::", "Schema", "::", "Subscription", "::", "UnsubscribedError", "# `unsubscribe` was called, clean up on our side", "# TODO also send `{more: false}` to client?", "delete_subscription", "(", "subscription_id", ")", "end" ]
`event` was triggered on `object`, and `subscription_id` was subscribed, so it should be updated. Load `subscription_id`'s GraphQL data, re-evaluate the query, and deliver the result. This is where a queue may be inserted to push updates in the background. @param subscription_id [String] @param event [GraphQL::Subscriptions::Event] The event which was triggered @param object [Object] The value for the subscription field @return [void]
[ "event", "was", "triggered", "on", "object", "and", "subscription_id", "was", "subscribed", "so", "it", "should", "be", "updated", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/subscriptions.rb#L83-L109
10,745
rmosolgo/graphql-ruby
lib/graphql/subscriptions.rb
GraphQL.Subscriptions.execute_all
def execute_all(event, object) each_subscription_id(event) do |subscription_id| execute(subscription_id, event, object) end end
ruby
def execute_all(event, object) each_subscription_id(event) do |subscription_id| execute(subscription_id, event, object) end end
[ "def", "execute_all", "(", "event", ",", "object", ")", "each_subscription_id", "(", "event", ")", "do", "|", "subscription_id", "|", "execute", "(", "subscription_id", ",", "event", ",", "object", ")", "end", "end" ]
Event `event` occurred on `object`, Update all subscribers. @param event [Subscriptions::Event] @param object [Object] @return [void]
[ "Event", "event", "occurred", "on", "object", "Update", "all", "subscribers", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/subscriptions.rb#L116-L120
10,746
rmosolgo/graphql-ruby
lib/graphql/base_type.rb
GraphQL.BaseType.to_definition
def to_definition(schema, printer: nil, **args) printer ||= GraphQL::Schema::Printer.new(schema, **args) printer.print_type(self) end
ruby
def to_definition(schema, printer: nil, **args) printer ||= GraphQL::Schema::Printer.new(schema, **args) printer.print_type(self) end
[ "def", "to_definition", "(", "schema", ",", "printer", ":", "nil", ",", "**", "args", ")", "printer", "||=", "GraphQL", "::", "Schema", "::", "Printer", ".", "new", "(", "schema", ",", "**", "args", ")", "printer", ".", "print_type", "(", "self", ")", "end" ]
Return a GraphQL string for the type definition @param schema [GraphQL::Schema] @param printer [GraphQL::Schema::Printer] @see {GraphQL::Schema::Printer#initialize for additional options} @return [String] type definition
[ "Return", "a", "GraphQL", "string", "for", "the", "type", "definition" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/base_type.rb#L205-L208
10,747
rmosolgo/graphql-ruby
lib/graphql/rake_task.rb
GraphQL.RakeTask.write_outfile
def write_outfile(method_name, file) schema = @load_schema.call(self) context = @load_context.call(self) result = schema.public_send(method_name, only: @only, except: @except, context: context) dir = File.dirname(file) FileUtils.mkdir_p(dir) File.write(file, result) end
ruby
def write_outfile(method_name, file) schema = @load_schema.call(self) context = @load_context.call(self) result = schema.public_send(method_name, only: @only, except: @except, context: context) dir = File.dirname(file) FileUtils.mkdir_p(dir) File.write(file, result) end
[ "def", "write_outfile", "(", "method_name", ",", "file", ")", "schema", "=", "@load_schema", ".", "call", "(", "self", ")", "context", "=", "@load_context", ".", "call", "(", "self", ")", "result", "=", "schema", ".", "public_send", "(", "method_name", ",", "only", ":", "@only", ",", "except", ":", "@except", ",", "context", ":", "context", ")", "dir", "=", "File", ".", "dirname", "(", "file", ")", "FileUtils", ".", "mkdir_p", "(", "dir", ")", "File", ".", "write", "(", "file", ",", "result", ")", "end" ]
Use the provided `method_name` to generate a string from the specified schema then write it to `file`.
[ "Use", "the", "provided", "method_name", "to", "generate", "a", "string", "from", "the", "specified", "schema", "then", "write", "it", "to", "file", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/rake_task.rb#L103-L110
10,748
rmosolgo/graphql-ruby
lib/graphql/rake_task.rb
GraphQL.RakeTask.define_task
def define_task namespace(@namespace) do namespace("schema") do desc("Dump the schema to IDL in #{idl_path}") task :idl => @dependencies do write_outfile(:to_definition, idl_path) puts "Schema IDL dumped into #{idl_path}" end desc("Dump the schema to JSON in #{json_path}") task :json => @dependencies do write_outfile(:to_json, json_path) puts "Schema JSON dumped into #{json_path}" end desc("Dump the schema to JSON and IDL") task :dump => [:idl, :json] end end end
ruby
def define_task namespace(@namespace) do namespace("schema") do desc("Dump the schema to IDL in #{idl_path}") task :idl => @dependencies do write_outfile(:to_definition, idl_path) puts "Schema IDL dumped into #{idl_path}" end desc("Dump the schema to JSON in #{json_path}") task :json => @dependencies do write_outfile(:to_json, json_path) puts "Schema JSON dumped into #{json_path}" end desc("Dump the schema to JSON and IDL") task :dump => [:idl, :json] end end end
[ "def", "define_task", "namespace", "(", "@namespace", ")", "do", "namespace", "(", "\"schema\"", ")", "do", "desc", "(", "\"Dump the schema to IDL in #{idl_path}\"", ")", "task", ":idl", "=>", "@dependencies", "do", "write_outfile", "(", ":to_definition", ",", "idl_path", ")", "puts", "\"Schema IDL dumped into #{idl_path}\"", "end", "desc", "(", "\"Dump the schema to JSON in #{json_path}\"", ")", "task", ":json", "=>", "@dependencies", "do", "write_outfile", "(", ":to_json", ",", "json_path", ")", "puts", "\"Schema JSON dumped into #{json_path}\"", "end", "desc", "(", "\"Dump the schema to JSON and IDL\"", ")", "task", ":dump", "=>", "[", ":idl", ",", ":json", "]", "end", "end", "end" ]
Use the Rake DSL to add tasks
[ "Use", "the", "Rake", "DSL", "to", "add", "tasks" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/rake_task.rb#L121-L140
10,749
rmosolgo/graphql-ruby
lib/graphql/field.rb
GraphQL.Field.prepare_lazy
def prepare_lazy(obj, args, ctx) GraphQL::Execution::Lazy.new { lazy_resolve(obj, args, ctx) } end
ruby
def prepare_lazy(obj, args, ctx) GraphQL::Execution::Lazy.new { lazy_resolve(obj, args, ctx) } end
[ "def", "prepare_lazy", "(", "obj", ",", "args", ",", "ctx", ")", "GraphQL", "::", "Execution", "::", "Lazy", ".", "new", "{", "lazy_resolve", "(", "obj", ",", "args", ",", "ctx", ")", "}", "end" ]
Prepare a lazy value for this field. It may be `then`-ed and resolved later. @return [GraphQL::Execution::Lazy] A lazy wrapper around `obj` and its registered method name
[ "Prepare", "a", "lazy", "value", "for", "this", "field", ".", "It", "may", "be", "then", "-", "ed", "and", "resolved", "later", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/field.rb#L312-L316
10,750
rmosolgo/graphql-ruby
lib/graphql/filter.rb
GraphQL.Filter.call
def call(member, ctx) (@only ? @only.call(member, ctx) : true) && (@except ? !@except.call(member, ctx) : true) end
ruby
def call(member, ctx) (@only ? @only.call(member, ctx) : true) && (@except ? !@except.call(member, ctx) : true) end
[ "def", "call", "(", "member", ",", "ctx", ")", "(", "@only", "?", "@only", ".", "call", "(", "member", ",", "ctx", ")", ":", "true", ")", "&&", "(", "@except", "?", "!", "@except", ".", "call", "(", "member", ",", "ctx", ")", ":", "true", ")", "end" ]
Returns true if `member, ctx` passes this filter
[ "Returns", "true", "if", "member", "ctx", "passes", "this", "filter" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/filter.rb#L11-L14
10,751
rmosolgo/graphql-ruby
lib/graphql/analysis/analyze_query.rb
GraphQL.Analysis.analyze_query
def analyze_query(query, analyzers, multiplex_states: []) query.trace("analyze_query", { query: query }) do analyzers_to_run = analyzers.select do |analyzer| if analyzer.respond_to?(:analyze?) analyzer.analyze?(query) else true end end reducer_states = analyzers_to_run.map { |r| ReducerState.new(r, query) } + multiplex_states irep = query.internal_representation irep.operation_definitions.each do |name, op_node| reduce_node(op_node, reducer_states) end reducer_states.map(&:finalize_reducer) end end
ruby
def analyze_query(query, analyzers, multiplex_states: []) query.trace("analyze_query", { query: query }) do analyzers_to_run = analyzers.select do |analyzer| if analyzer.respond_to?(:analyze?) analyzer.analyze?(query) else true end end reducer_states = analyzers_to_run.map { |r| ReducerState.new(r, query) } + multiplex_states irep = query.internal_representation irep.operation_definitions.each do |name, op_node| reduce_node(op_node, reducer_states) end reducer_states.map(&:finalize_reducer) end end
[ "def", "analyze_query", "(", "query", ",", "analyzers", ",", "multiplex_states", ":", "[", "]", ")", "query", ".", "trace", "(", "\"analyze_query\"", ",", "{", "query", ":", "query", "}", ")", "do", "analyzers_to_run", "=", "analyzers", ".", "select", "do", "|", "analyzer", "|", "if", "analyzer", ".", "respond_to?", "(", ":analyze?", ")", "analyzer", ".", "analyze?", "(", "query", ")", "else", "true", "end", "end", "reducer_states", "=", "analyzers_to_run", ".", "map", "{", "|", "r", "|", "ReducerState", ".", "new", "(", "r", ",", "query", ")", "}", "+", "multiplex_states", "irep", "=", "query", ".", "internal_representation", "irep", ".", "operation_definitions", ".", "each", "do", "|", "name", ",", "op_node", "|", "reduce_node", "(", "op_node", ",", "reducer_states", ")", "end", "reducer_states", ".", "map", "(", ":finalize_reducer", ")", "end", "end" ]
Visit `query`'s internal representation, calling `analyzers` along the way. - First, query analyzers are filtered down by calling `.analyze?(query)`, if they respond to that method - Then, query analyzers are initialized by calling `.initial_value(query)`, if they respond to that method. - Then, they receive `.call(memo, visit_type, irep_node)`, where visit type is `:enter` or `:leave`. - Last, they receive `.final_value(memo)`, if they respond to that method. It returns an array of final `memo` values in the order that `analyzers` were passed in. @param query [GraphQL::Query] @param analyzers [Array<#call>] Objects that respond to `#call(memo, visit_type, irep_node)` @return [Array<Any>] Results from those analyzers
[ "Visit", "query", "s", "internal", "representation", "calling", "analyzers", "along", "the", "way", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/analysis/analyze_query.rb#L40-L60
10,752
rmosolgo/graphql-ruby
lib/graphql/analysis/analyze_query.rb
GraphQL.Analysis.reduce_node
def reduce_node(irep_node, reducer_states) visit_analyzers(:enter, irep_node, reducer_states) irep_node.typed_children.each do |type_defn, children| children.each do |name, child_irep_node| reduce_node(child_irep_node, reducer_states) end end visit_analyzers(:leave, irep_node, reducer_states) end
ruby
def reduce_node(irep_node, reducer_states) visit_analyzers(:enter, irep_node, reducer_states) irep_node.typed_children.each do |type_defn, children| children.each do |name, child_irep_node| reduce_node(child_irep_node, reducer_states) end end visit_analyzers(:leave, irep_node, reducer_states) end
[ "def", "reduce_node", "(", "irep_node", ",", "reducer_states", ")", "visit_analyzers", "(", ":enter", ",", "irep_node", ",", "reducer_states", ")", "irep_node", ".", "typed_children", ".", "each", "do", "|", "type_defn", ",", "children", "|", "children", ".", "each", "do", "|", "name", ",", "child_irep_node", "|", "reduce_node", "(", "child_irep_node", ",", "reducer_states", ")", "end", "end", "visit_analyzers", "(", ":leave", ",", "irep_node", ",", "reducer_states", ")", "end" ]
Enter the node, visit its children, then leave the node.
[ "Enter", "the", "node", "visit", "its", "children", "then", "leave", "the", "node", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/analysis/analyze_query.rb#L67-L77
10,753
rmosolgo/graphql-ruby
lib/graphql/schema.rb
GraphQL.Schema.validate
def validate(string_or_document, rules: nil, context: nil) doc = if string_or_document.is_a?(String) GraphQL.parse(string_or_document) else string_or_document end query = GraphQL::Query.new(self, document: doc, context: context) validator_opts = { schema: self } rules && (validator_opts[:rules] = rules) validator = GraphQL::StaticValidation::Validator.new(validator_opts) res = validator.validate(query) res[:errors] end
ruby
def validate(string_or_document, rules: nil, context: nil) doc = if string_or_document.is_a?(String) GraphQL.parse(string_or_document) else string_or_document end query = GraphQL::Query.new(self, document: doc, context: context) validator_opts = { schema: self } rules && (validator_opts[:rules] = rules) validator = GraphQL::StaticValidation::Validator.new(validator_opts) res = validator.validate(query) res[:errors] end
[ "def", "validate", "(", "string_or_document", ",", "rules", ":", "nil", ",", "context", ":", "nil", ")", "doc", "=", "if", "string_or_document", ".", "is_a?", "(", "String", ")", "GraphQL", ".", "parse", "(", "string_or_document", ")", "else", "string_or_document", "end", "query", "=", "GraphQL", "::", "Query", ".", "new", "(", "self", ",", "document", ":", "doc", ",", "context", ":", "context", ")", "validator_opts", "=", "{", "schema", ":", "self", "}", "rules", "&&", "(", "validator_opts", "[", ":rules", "]", "=", "rules", ")", "validator", "=", "GraphQL", "::", "StaticValidation", "::", "Validator", ".", "new", "(", "validator_opts", ")", "res", "=", "validator", ".", "validate", "(", "query", ")", "res", "[", ":errors", "]", "end" ]
Validate a query string according to this schema. @param string_or_document [String, GraphQL::Language::Nodes::Document] @return [Array<GraphQL::StaticValidation::Error >]
[ "Validate", "a", "query", "string", "according", "to", "this", "schema", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/schema.rb#L249-L261
10,754
rmosolgo/graphql-ruby
lib/graphql/schema.rb
GraphQL.Schema.execute
def execute(query_str = nil, **kwargs) if query_str kwargs[:query] = query_str end # Some of the query context _should_ be passed to the multiplex, too multiplex_context = if (ctx = kwargs[:context]) { backtrace: ctx[:backtrace], tracers: ctx[:tracers], } else {} end # Since we're running one query, don't run a multiplex-level complexity analyzer all_results = multiplex([kwargs], max_complexity: nil, context: multiplex_context) all_results[0] end
ruby
def execute(query_str = nil, **kwargs) if query_str kwargs[:query] = query_str end # Some of the query context _should_ be passed to the multiplex, too multiplex_context = if (ctx = kwargs[:context]) { backtrace: ctx[:backtrace], tracers: ctx[:tracers], } else {} end # Since we're running one query, don't run a multiplex-level complexity analyzer all_results = multiplex([kwargs], max_complexity: nil, context: multiplex_context) all_results[0] end
[ "def", "execute", "(", "query_str", "=", "nil", ",", "**", "kwargs", ")", "if", "query_str", "kwargs", "[", ":query", "]", "=", "query_str", "end", "# Some of the query context _should_ be passed to the multiplex, too", "multiplex_context", "=", "if", "(", "ctx", "=", "kwargs", "[", ":context", "]", ")", "{", "backtrace", ":", "ctx", "[", ":backtrace", "]", ",", "tracers", ":", "ctx", "[", ":tracers", "]", ",", "}", "else", "{", "}", "end", "# Since we're running one query, don't run a multiplex-level complexity analyzer", "all_results", "=", "multiplex", "(", "[", "kwargs", "]", ",", "max_complexity", ":", "nil", ",", "context", ":", "multiplex_context", ")", "all_results", "[", "0", "]", "end" ]
Execute a query on itself. Raises an error if the schema definition is invalid. @see {Query#initialize} for arguments. @return [Hash] query result, ready to be serialized as JSON
[ "Execute", "a", "query", "on", "itself", ".", "Raises", "an", "error", "if", "the", "schema", "definition", "is", "invalid", "." ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/schema.rb#L338-L354
10,755
rmosolgo/graphql-ruby
lib/graphql/schema.rb
GraphQL.Schema.check_resolved_type
def check_resolved_type(type, object, ctx = :__undefined__) if ctx == :__undefined__ # Old method signature ctx = object object = type type = nil end if object.is_a?(GraphQL::Schema::Object) object = object.object end if type.respond_to?(:graphql_definition) type = type.graphql_definition end # Prefer a type-local function; fall back to the schema-level function type_proc = type && type.resolve_type_proc type_result = if type_proc type_proc.call(object, ctx) else yield(type, object, ctx) end if type_result.nil? nil else after_lazy(type_result) do |resolved_type_result| if resolved_type_result.respond_to?(:graphql_definition) resolved_type_result = resolved_type_result.graphql_definition end if !resolved_type_result.is_a?(GraphQL::BaseType) type_str = "#{resolved_type_result} (#{resolved_type_result.class.name})" raise "resolve_type(#{object}) returned #{type_str}, but it should return a GraphQL type" else resolved_type_result end end end end
ruby
def check_resolved_type(type, object, ctx = :__undefined__) if ctx == :__undefined__ # Old method signature ctx = object object = type type = nil end if object.is_a?(GraphQL::Schema::Object) object = object.object end if type.respond_to?(:graphql_definition) type = type.graphql_definition end # Prefer a type-local function; fall back to the schema-level function type_proc = type && type.resolve_type_proc type_result = if type_proc type_proc.call(object, ctx) else yield(type, object, ctx) end if type_result.nil? nil else after_lazy(type_result) do |resolved_type_result| if resolved_type_result.respond_to?(:graphql_definition) resolved_type_result = resolved_type_result.graphql_definition end if !resolved_type_result.is_a?(GraphQL::BaseType) type_str = "#{resolved_type_result} (#{resolved_type_result.class.name})" raise "resolve_type(#{object}) returned #{type_str}, but it should return a GraphQL type" else resolved_type_result end end end end
[ "def", "check_resolved_type", "(", "type", ",", "object", ",", "ctx", "=", ":__undefined__", ")", "if", "ctx", "==", ":__undefined__", "# Old method signature", "ctx", "=", "object", "object", "=", "type", "type", "=", "nil", "end", "if", "object", ".", "is_a?", "(", "GraphQL", "::", "Schema", "::", "Object", ")", "object", "=", "object", ".", "object", "end", "if", "type", ".", "respond_to?", "(", ":graphql_definition", ")", "type", "=", "type", ".", "graphql_definition", "end", "# Prefer a type-local function; fall back to the schema-level function", "type_proc", "=", "type", "&&", "type", ".", "resolve_type_proc", "type_result", "=", "if", "type_proc", "type_proc", ".", "call", "(", "object", ",", "ctx", ")", "else", "yield", "(", "type", ",", "object", ",", "ctx", ")", "end", "if", "type_result", ".", "nil?", "nil", "else", "after_lazy", "(", "type_result", ")", "do", "|", "resolved_type_result", "|", "if", "resolved_type_result", ".", "respond_to?", "(", ":graphql_definition", ")", "resolved_type_result", "=", "resolved_type_result", ".", "graphql_definition", "end", "if", "!", "resolved_type_result", ".", "is_a?", "(", "GraphQL", "::", "BaseType", ")", "type_str", "=", "\"#{resolved_type_result} (#{resolved_type_result.class.name})\"", "raise", "\"resolve_type(#{object}) returned #{type_str}, but it should return a GraphQL type\"", "else", "resolved_type_result", "end", "end", "end", "end" ]
This is a compatibility hack so that instance-level and class-level methods can get correctness checks without calling one another @api private
[ "This", "is", "a", "compatibility", "hack", "so", "that", "instance", "-", "level", "and", "class", "-", "level", "methods", "can", "get", "correctness", "checks", "without", "calling", "one", "another" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/schema.rb#L488-L527
10,756
rmosolgo/graphql-ruby
lib/graphql/schema.rb
GraphQL.Schema.id_from_object
def id_from_object(object, type, ctx) if @id_from_object_proc.nil? raise(NotImplementedError, "Can't generate an ID for #{object.inspect} of type #{type}, schema's `id_from_object` must be defined") else @id_from_object_proc.call(object, type, ctx) end end
ruby
def id_from_object(object, type, ctx) if @id_from_object_proc.nil? raise(NotImplementedError, "Can't generate an ID for #{object.inspect} of type #{type}, schema's `id_from_object` must be defined") else @id_from_object_proc.call(object, type, ctx) end end
[ "def", "id_from_object", "(", "object", ",", "type", ",", "ctx", ")", "if", "@id_from_object_proc", ".", "nil?", "raise", "(", "NotImplementedError", ",", "\"Can't generate an ID for #{object.inspect} of type #{type}, schema's `id_from_object` must be defined\"", ")", "else", "@id_from_object_proc", ".", "call", "(", "object", ",", "type", ",", "ctx", ")", "end", "end" ]
Get a unique identifier from this object @param object [Any] An application object @param type [GraphQL::BaseType] The current type definition @param ctx [GraphQL::Query::Context] the context for the current query @return [String] a unique identifier for `object` which clients can use to refetch it
[ "Get", "a", "unique", "identifier", "from", "this", "object" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/schema.rb#L605-L611
10,757
rmosolgo/graphql-ruby
lib/graphql/schema.rb
GraphQL.Schema.to_definition
def to_definition(only: nil, except: nil, context: {}) GraphQL::Schema::Printer.print_schema(self, only: only, except: except, context: context) end
ruby
def to_definition(only: nil, except: nil, context: {}) GraphQL::Schema::Printer.print_schema(self, only: only, except: except, context: context) end
[ "def", "to_definition", "(", "only", ":", "nil", ",", "except", ":", "nil", ",", "context", ":", "{", "}", ")", "GraphQL", "::", "Schema", "::", "Printer", ".", "print_schema", "(", "self", ",", "only", ":", "only", ",", "except", ":", "except", ",", "context", ":", "context", ")", "end" ]
Return the GraphQL IDL for the schema @param context [Hash] @param only [<#call(member, ctx)>] @param except [<#call(member, ctx)>] @return [String]
[ "Return", "the", "GraphQL", "IDL", "for", "the", "schema" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/schema.rb#L658-L660
10,758
rmosolgo/graphql-ruby
lib/graphql/enum_type.rb
GraphQL.EnumType.coerce_non_null_input
def coerce_non_null_input(value_name, ctx) if @values_by_name.key?(value_name) @values_by_name.fetch(value_name).value elsif match_by_value = @values_by_name.find { |k, v| v.value == value_name } # this is for matching default values, which are "inputs", but they're # the Ruby value, not the GraphQL string. match_by_value[1].value else nil end end
ruby
def coerce_non_null_input(value_name, ctx) if @values_by_name.key?(value_name) @values_by_name.fetch(value_name).value elsif match_by_value = @values_by_name.find { |k, v| v.value == value_name } # this is for matching default values, which are "inputs", but they're # the Ruby value, not the GraphQL string. match_by_value[1].value else nil end end
[ "def", "coerce_non_null_input", "(", "value_name", ",", "ctx", ")", "if", "@values_by_name", ".", "key?", "(", "value_name", ")", "@values_by_name", ".", "fetch", "(", "value_name", ")", ".", "value", "elsif", "match_by_value", "=", "@values_by_name", ".", "find", "{", "|", "k", ",", "v", "|", "v", ".", "value", "==", "value_name", "}", "# this is for matching default values, which are \"inputs\", but they're", "# the Ruby value, not the GraphQL string.", "match_by_value", "[", "1", "]", ".", "value", "else", "nil", "end", "end" ]
Get the underlying value for this enum value @example get episode value from Enum episode = EpisodeEnum.coerce("NEWHOPE") episode # => 6 @param value_name [String] the string representation of this enum value @return [Object] the underlying value for this enum value
[ "Get", "the", "underlying", "value", "for", "this", "enum", "value" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/lib/graphql/enum_type.rb#L169-L179
10,759
rmosolgo/graphql-ruby
spec/support/jazz.rb
Jazz.Query.inspect_input
def inspect_input(input:) [ input.class.name, input.helper_method, # Access by method input.string_value, # Access by key: input[:string_value], input.key?(:string_value).to_s, # ~~Access by legacy key~~ # not anymore input[:string_value], input.ensemble, input.key?(:ensemble).to_s, ] end
ruby
def inspect_input(input:) [ input.class.name, input.helper_method, # Access by method input.string_value, # Access by key: input[:string_value], input.key?(:string_value).to_s, # ~~Access by legacy key~~ # not anymore input[:string_value], input.ensemble, input.key?(:ensemble).to_s, ] end
[ "def", "inspect_input", "(", "input", ":", ")", "[", "input", ".", "class", ".", "name", ",", "input", ".", "helper_method", ",", "# Access by method", "input", ".", "string_value", ",", "# Access by key:", "input", "[", ":string_value", "]", ",", "input", ".", "key?", "(", ":string_value", ")", ".", "to_s", ",", "# ~~Access by legacy key~~ # not anymore", "input", "[", ":string_value", "]", ",", "input", ".", "ensemble", ",", "input", ".", "key?", "(", ":ensemble", ")", ".", "to_s", ",", "]", "end" ]
This is for testing input object behavior
[ "This", "is", "for", "testing", "input", "object", "behavior" ]
d5be13a816f220b9efbabeaa69a3e56fedf311f5
https://github.com/rmosolgo/graphql-ruby/blob/d5be13a816f220b9efbabeaa69a3e56fedf311f5/spec/support/jazz.rb#L390-L404
10,760
elastic/elasticsearch-rails
elasticsearch-model/examples/activerecord_associations.rb
Searchable.Indexing.as_indexed_json
def as_indexed_json(options={}) self.as_json( include: { categories: { only: :title}, authors: { methods: [:full_name, :department], only: [:full_name, :department] }, comments: { only: :text } }) end
ruby
def as_indexed_json(options={}) self.as_json( include: { categories: { only: :title}, authors: { methods: [:full_name, :department], only: [:full_name, :department] }, comments: { only: :text } }) end
[ "def", "as_indexed_json", "(", "options", "=", "{", "}", ")", "self", ".", "as_json", "(", "include", ":", "{", "categories", ":", "{", "only", ":", ":title", "}", ",", "authors", ":", "{", "methods", ":", "[", ":full_name", ",", ":department", "]", ",", "only", ":", "[", ":full_name", ",", ":department", "]", "}", ",", "comments", ":", "{", "only", ":", ":text", "}", "}", ")", "end" ]
Customize the JSON serialization for Elasticsearch
[ "Customize", "the", "JSON", "serialization", "for", "Elasticsearch" ]
a67ecc1afc3a0615efa7ca6daecbb9132f61c318
https://github.com/elastic/elasticsearch-rails/blob/a67ecc1afc3a0615efa7ca6daecbb9132f61c318/elasticsearch-model/examples/activerecord_associations.rb#L102-L108
10,761
octokit/octokit.rb
lib/octokit/client.rb
Octokit.Client.inspect
def inspect inspected = super # mask password inspected.gsub! @password, '*******' if @password inspected.gsub! @management_console_password, '*******' if @management_console_password inspected.gsub! @bearer_token, '********' if @bearer_token # Only show last 4 of token, secret inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}" if @access_token inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}" if @client_secret inspected end
ruby
def inspect inspected = super # mask password inspected.gsub! @password, '*******' if @password inspected.gsub! @management_console_password, '*******' if @management_console_password inspected.gsub! @bearer_token, '********' if @bearer_token # Only show last 4 of token, secret inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}" if @access_token inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}" if @client_secret inspected end
[ "def", "inspect", "inspected", "=", "super", "# mask password", "inspected", ".", "gsub!", "@password", ",", "'*******'", "if", "@password", "inspected", ".", "gsub!", "@management_console_password", ",", "'*******'", "if", "@management_console_password", "inspected", ".", "gsub!", "@bearer_token", ",", "'********'", "if", "@bearer_token", "# Only show last 4 of token, secret", "inspected", ".", "gsub!", "@access_token", ",", "\"#{'*'*36}#{@access_token[36..-1]}\"", "if", "@access_token", "inspected", ".", "gsub!", "@client_secret", ",", "\"#{'*'*36}#{@client_secret[36..-1]}\"", "if", "@client_secret", "inspected", "end" ]
Text representation of the client, masking tokens and passwords @return [String]
[ "Text", "representation", "of", "the", "client", "masking", "tokens", "and", "passwords" ]
ddf750601529a6a7da5fe5293d10031709b8605d
https://github.com/octokit/octokit.rb/blob/ddf750601529a6a7da5fe5293d10031709b8605d/lib/octokit/client.rb#L134-L146
10,762
octokit/octokit.rb
lib/octokit/connection.rb
Octokit.Connection.agent
def agent @agent ||= Sawyer::Agent.new(endpoint, sawyer_options) do |http| http.headers[:accept] = default_media_type http.headers[:content_type] = "application/json" http.headers[:user_agent] = user_agent if basic_authenticated? http.basic_auth(@login, @password) elsif token_authenticated? http.authorization 'token', @access_token elsif bearer_authenticated? http.authorization 'Bearer', @bearer_token elsif application_authenticated? http.params = http.params.merge application_authentication end end end
ruby
def agent @agent ||= Sawyer::Agent.new(endpoint, sawyer_options) do |http| http.headers[:accept] = default_media_type http.headers[:content_type] = "application/json" http.headers[:user_agent] = user_agent if basic_authenticated? http.basic_auth(@login, @password) elsif token_authenticated? http.authorization 'token', @access_token elsif bearer_authenticated? http.authorization 'Bearer', @bearer_token elsif application_authenticated? http.params = http.params.merge application_authentication end end end
[ "def", "agent", "@agent", "||=", "Sawyer", "::", "Agent", ".", "new", "(", "endpoint", ",", "sawyer_options", ")", "do", "|", "http", "|", "http", ".", "headers", "[", ":accept", "]", "=", "default_media_type", "http", ".", "headers", "[", ":content_type", "]", "=", "\"application/json\"", "http", ".", "headers", "[", ":user_agent", "]", "=", "user_agent", "if", "basic_authenticated?", "http", ".", "basic_auth", "(", "@login", ",", "@password", ")", "elsif", "token_authenticated?", "http", ".", "authorization", "'token'", ",", "@access_token", "elsif", "bearer_authenticated?", "http", ".", "authorization", "'Bearer'", ",", "@bearer_token", "elsif", "application_authenticated?", "http", ".", "params", "=", "http", ".", "params", ".", "merge", "application_authentication", "end", "end", "end" ]
Hypermedia agent for the GitHub API @return [Sawyer::Agent]
[ "Hypermedia", "agent", "for", "the", "GitHub", "API" ]
ddf750601529a6a7da5fe5293d10031709b8605d
https://github.com/octokit/octokit.rb/blob/ddf750601529a6a7da5fe5293d10031709b8605d/lib/octokit/connection.rb#L104-L119
10,763
octokit/octokit.rb
lib/octokit/connection.rb
Octokit.Connection.boolean_from_response
def boolean_from_response(method, path, options = {}) request(method, path, options) @last_response.status == 204 rescue Octokit::NotFound false end
ruby
def boolean_from_response(method, path, options = {}) request(method, path, options) @last_response.status == 204 rescue Octokit::NotFound false end
[ "def", "boolean_from_response", "(", "method", ",", "path", ",", "options", "=", "{", "}", ")", "request", "(", "method", ",", "path", ",", "options", ")", "@last_response", ".", "status", "==", "204", "rescue", "Octokit", "::", "NotFound", "false", "end" ]
Executes the request, checking if it was successful @return [Boolean] True on success, false otherwise
[ "Executes", "the", "request", "checking", "if", "it", "was", "successful" ]
ddf750601529a6a7da5fe5293d10031709b8605d
https://github.com/octokit/octokit.rb/blob/ddf750601529a6a7da5fe5293d10031709b8605d/lib/octokit/connection.rb#L163-L168
10,764
decidim/decidim
decidim-core/app/helpers/decidim/aria_selected_link_to_helper.rb
Decidim.AriaSelectedLinkToHelper.aria_selected_link_to
def aria_selected_link_to(text, link, options = {}) link_to( text, link, options.merge( "aria-selected": is_active_link?(link, options[:aria_link_type] || :inclusive) ) ) end
ruby
def aria_selected_link_to(text, link, options = {}) link_to( text, link, options.merge( "aria-selected": is_active_link?(link, options[:aria_link_type] || :inclusive) ) ) end
[ "def", "aria_selected_link_to", "(", "text", ",", "link", ",", "options", "=", "{", "}", ")", "link_to", "(", "text", ",", "link", ",", "options", ".", "merge", "(", "\"aria-selected\"", ":", "is_active_link?", "(", "link", ",", "options", "[", ":aria_link_type", "]", "||", ":inclusive", ")", ")", ")", "end" ]
Adds the `aria-selected` attribute to a link when it's pointing to the current path. The API is the same than the `link_to` one, and uses this helper internally. text - a String with the link text link - Where the link should point to. Accepts the same value than `link_to` helper. options - An options Hash that will be passed to `link_to`.
[ "Adds", "the", "aria", "-", "selected", "attribute", "to", "a", "link", "when", "it", "s", "pointing", "to", "the", "current", "path", ".", "The", "API", "is", "the", "same", "than", "the", "link_to", "one", "and", "uses", "this", "helper", "internally", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/aria_selected_link_to_helper.rb#L17-L25
10,765
decidim/decidim
decidim-core/lib/decidim/authorization_form_builder.rb
Decidim.AuthorizationFormBuilder.all_fields
def all_fields fields = public_attributes.map do |name, type| @template.content_tag(:div, input_field(name, type), class: "field") end safe_join(fields) end
ruby
def all_fields fields = public_attributes.map do |name, type| @template.content_tag(:div, input_field(name, type), class: "field") end safe_join(fields) end
[ "def", "all_fields", "fields", "=", "public_attributes", ".", "map", "do", "|", "name", ",", "type", "|", "@template", ".", "content_tag", "(", ":div", ",", "input_field", "(", "name", ",", "type", ")", ",", "class", ":", "\"field\"", ")", "end", "safe_join", "(", "fields", ")", "end" ]
Renders all form attributes defined by the handler. Returns a String.
[ "Renders", "all", "form", "attributes", "defined", "by", "the", "handler", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/lib/decidim/authorization_form_builder.rb#L11-L17
10,766
decidim/decidim
decidim-core/lib/decidim/authorization_form_builder.rb
Decidim.AuthorizationFormBuilder.input
def input(name, options = {}) if options[:as] send(options[:as].to_s, name, options[:input] || {}) else type = find_input_type(name.to_s) input_field(name, type) end end
ruby
def input(name, options = {}) if options[:as] send(options[:as].to_s, name, options[:input] || {}) else type = find_input_type(name.to_s) input_field(name, type) end end
[ "def", "input", "(", "name", ",", "options", "=", "{", "}", ")", "if", "options", "[", ":as", "]", "send", "(", "options", "[", ":as", "]", ".", "to_s", ",", "name", ",", "options", "[", ":input", "]", "||", "{", "}", ")", "else", "type", "=", "find_input_type", "(", "name", ".", "to_s", ")", "input_field", "(", "name", ",", "type", ")", "end", "end" ]
Renders a single attribute from the form handlers. name - The String name of the attribute. options - An optional Hash, accepted options are: :as - A String name with the type the field to render :input - An optional Hash to pass to the field method. Returns a String.
[ "Renders", "a", "single", "attribute", "from", "the", "form", "handlers", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/lib/decidim/authorization_form_builder.rb#L27-L34
10,767
decidim/decidim
decidim-core/app/services/decidim/home_activity_search.rb
Decidim.HomeActivitySearch.resource_types
def resource_types @resource_types ||= %w( Decidim::Accountability::Result Decidim::Blogs::Post Decidim::Comments::Comment Decidim::Consultations::Question Decidim::Debates::Debate Decidim::Meetings::Meeting Decidim::Proposals::Proposal Decidim::Surveys::Survey Decidim::Assembly Decidim::Consultation Decidim::Initiative Decidim::ParticipatoryProcess ).select do |klass| klass.safe_constantize.present? end end
ruby
def resource_types @resource_types ||= %w( Decidim::Accountability::Result Decidim::Blogs::Post Decidim::Comments::Comment Decidim::Consultations::Question Decidim::Debates::Debate Decidim::Meetings::Meeting Decidim::Proposals::Proposal Decidim::Surveys::Survey Decidim::Assembly Decidim::Consultation Decidim::Initiative Decidim::ParticipatoryProcess ).select do |klass| klass.safe_constantize.present? end end
[ "def", "resource_types", "@resource_types", "||=", "%w(", "Decidim::Accountability::Result", "Decidim::Blogs::Post", "Decidim::Comments::Comment", "Decidim::Consultations::Question", "Decidim::Debates::Debate", "Decidim::Meetings::Meeting", "Decidim::Proposals::Proposal", "Decidim::Surveys::Survey", "Decidim::Assembly", "Decidim::Consultation", "Decidim::Initiative", "Decidim::ParticipatoryProcess", ")", ".", "select", "do", "|", "klass", "|", "klass", ".", "safe_constantize", ".", "present?", "end", "end" ]
All the resource types that are eligible to be included as an activity.
[ "All", "the", "resource", "types", "that", "are", "eligible", "to", "be", "included", "as", "an", "activity", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/services/decidim/home_activity_search.rb#L34-L51
10,768
decidim/decidim
decidim-core/app/helpers/decidim/authorization_form_helper.rb
Decidim.AuthorizationFormHelper.authorization_form_for
def authorization_form_for(record, options = {}, &block) default_options = { builder: AuthorizationFormBuilder, as: "authorization_handler", url: decidim_verifications.authorizations_path } options = default_options.merge(options) decidim_form_for(record, options, &block) end
ruby
def authorization_form_for(record, options = {}, &block) default_options = { builder: AuthorizationFormBuilder, as: "authorization_handler", url: decidim_verifications.authorizations_path } options = default_options.merge(options) decidim_form_for(record, options, &block) end
[ "def", "authorization_form_for", "(", "record", ",", "options", "=", "{", "}", ",", "&", "block", ")", "default_options", "=", "{", "builder", ":", "AuthorizationFormBuilder", ",", "as", ":", "\"authorization_handler\"", ",", "url", ":", "decidim_verifications", ".", "authorizations_path", "}", "options", "=", "default_options", ".", "merge", "(", "options", ")", "decidim_form_for", "(", "record", ",", "options", ",", "block", ")", "end" ]
Creates a ew authorization form in a view, accepts the same arguments as `form_for`. record - The record to use in the form, it shoulde be a descendant of AuthorizationHandler. options - An optional hash with options to pass wo the form builder. block - A block with the content of the form. Returns a String.
[ "Creates", "a", "ew", "authorization", "form", "in", "a", "view", "accepts", "the", "same", "arguments", "as", "form_for", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/authorization_form_helper.rb#L15-L24
10,769
decidim/decidim
decidim-core/app/controllers/decidim/application_controller.rb
Decidim.ApplicationController.store_current_location
def store_current_location return if (devise_controller? && params[:redirect_url].blank?) || !request.format.html? value = params[:redirect_url] || request.url store_location_for(:user, value) end
ruby
def store_current_location return if (devise_controller? && params[:redirect_url].blank?) || !request.format.html? value = params[:redirect_url] || request.url store_location_for(:user, value) end
[ "def", "store_current_location", "return", "if", "(", "devise_controller?", "&&", "params", "[", ":redirect_url", "]", ".", "blank?", ")", "||", "!", "request", ".", "format", ".", "html?", "value", "=", "params", "[", ":redirect_url", "]", "||", "request", ".", "url", "store_location_for", "(", ":user", ",", "value", ")", "end" ]
Stores the url where the user will be redirected after login. Uses the `redirect_url` param or the current url if there's no param. In Devise controllers we only store the URL if it's from the params, we don't want to overwrite the stored URL for a Devise one.
[ "Stores", "the", "url", "where", "the", "user", "will", "be", "redirected", "after", "login", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/controllers/decidim/application_controller.rb#L48-L53
10,770
decidim/decidim
decidim-core/app/helpers/decidim/scopes_helper.rb
Decidim.ScopesHelper.has_visible_scopes?
def has_visible_scopes?(resource) resource.participatory_space.scopes_enabled? && resource.scope.present? && resource.participatory_space.scope != resource.scope end
ruby
def has_visible_scopes?(resource) resource.participatory_space.scopes_enabled? && resource.scope.present? && resource.participatory_space.scope != resource.scope end
[ "def", "has_visible_scopes?", "(", "resource", ")", "resource", ".", "participatory_space", ".", "scopes_enabled?", "&&", "resource", ".", "scope", ".", "present?", "&&", "resource", ".", "participatory_space", ".", "scope", "!=", "resource", ".", "scope", "end" ]
Checks if the resource should show its scope or not. resource - the resource to analize Returns boolean.
[ "Checks", "if", "the", "resource", "should", "show", "its", "scope", "or", "not", ".", "resource", "-", "the", "resource", "to", "analize" ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/scopes_helper.rb#L15-L19
10,771
decidim/decidim
decidim-core/app/helpers/decidim/scopes_helper.rb
Decidim.ScopesHelper.scopes_picker_tag
def scopes_picker_tag(name, value, options = {}) root = try(:current_participatory_space)&.scope field = options[:field] || name scopes_picker_field_tag name, value, id: options[:id] do |scope| { url: decidim.scopes_picker_path(root: root, current: scope&.id, field: field), text: scope_name_for_picker(scope, I18n.t("decidim.scopes.global")) } end end
ruby
def scopes_picker_tag(name, value, options = {}) root = try(:current_participatory_space)&.scope field = options[:field] || name scopes_picker_field_tag name, value, id: options[:id] do |scope| { url: decidim.scopes_picker_path(root: root, current: scope&.id, field: field), text: scope_name_for_picker(scope, I18n.t("decidim.scopes.global")) } end end
[ "def", "scopes_picker_tag", "(", "name", ",", "value", ",", "options", "=", "{", "}", ")", "root", "=", "try", "(", ":current_participatory_space", ")", "&.", "scope", "field", "=", "options", "[", ":field", "]", "||", "name", "scopes_picker_field_tag", "name", ",", "value", ",", "id", ":", "options", "[", ":id", "]", "do", "|", "scope", "|", "{", "url", ":", "decidim", ".", "scopes_picker_path", "(", "root", ":", "root", ",", "current", ":", "scope", "&.", "id", ",", "field", ":", "field", ")", ",", "text", ":", "scope_name_for_picker", "(", "scope", ",", "I18n", ".", "t", "(", "\"decidim.scopes.global\"", ")", ")", "}", "end", "end" ]
Renders a scopes picker field in a form, not linked to a specific model. name - name for the input value - value for the input Returns nothing.
[ "Renders", "a", "scopes", "picker", "field", "in", "a", "form", "not", "linked", "to", "a", "specific", "model", ".", "name", "-", "name", "for", "the", "input", "value", "-", "value", "for", "the", "input" ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/scopes_helper.rb#L54-L62
10,772
decidim/decidim
decidim-core/app/helpers/decidim/amendments_helper.rb
Decidim.AmendmentsHelper.amendments_for
def amendments_for(amendable) return unless amendable.amendable? && amendable.emendations.count.positive? content = content_tag(:h2, class: "section-heading", id: "amendments") do t("section_heading", scope: "decidim.amendments.amendable", count: amendable.emendations.count) end content << cell("decidim/collapsible_list", amendable.emendations, cell_options: { context: { current_user: current_user } }, list_class: "row small-up-1 medium-up-2 card-grid", size: 4).to_s content_tag :div, content.html_safe, class: "section" end
ruby
def amendments_for(amendable) return unless amendable.amendable? && amendable.emendations.count.positive? content = content_tag(:h2, class: "section-heading", id: "amendments") do t("section_heading", scope: "decidim.amendments.amendable", count: amendable.emendations.count) end content << cell("decidim/collapsible_list", amendable.emendations, cell_options: { context: { current_user: current_user } }, list_class: "row small-up-1 medium-up-2 card-grid", size: 4).to_s content_tag :div, content.html_safe, class: "section" end
[ "def", "amendments_for", "(", "amendable", ")", "return", "unless", "amendable", ".", "amendable?", "&&", "amendable", ".", "emendations", ".", "count", ".", "positive?", "content", "=", "content_tag", "(", ":h2", ",", "class", ":", "\"section-heading\"", ",", "id", ":", "\"amendments\"", ")", "do", "t", "(", "\"section_heading\"", ",", "scope", ":", "\"decidim.amendments.amendable\"", ",", "count", ":", "amendable", ".", "emendations", ".", "count", ")", "end", "content", "<<", "cell", "(", "\"decidim/collapsible_list\"", ",", "amendable", ".", "emendations", ",", "cell_options", ":", "{", "context", ":", "{", "current_user", ":", "current_user", "}", "}", ",", "list_class", ":", "\"row small-up-1 medium-up-2 card-grid\"", ",", "size", ":", "4", ")", ".", "to_s", "content_tag", ":div", ",", "content", ".", "html_safe", ",", "class", ":", "\"section\"", "end" ]
Renders the emendations of an amendable resource Returns Html grid of CardM.
[ "Renders", "the", "emendations", "of", "an", "amendable", "resource" ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/amendments_helper.rb#L9-L23
10,773
decidim/decidim
decidim-core/app/helpers/decidim/amendments_helper.rb
Decidim.AmendmentsHelper.allowed_to_accept_and_reject?
def allowed_to_accept_and_reject?(emendation) return unless emendation.amendment.evaluating? emendation.amendable.created_by?(current_user) || current_user.admin? end
ruby
def allowed_to_accept_and_reject?(emendation) return unless emendation.amendment.evaluating? emendation.amendable.created_by?(current_user) || current_user.admin? end
[ "def", "allowed_to_accept_and_reject?", "(", "emendation", ")", "return", "unless", "emendation", ".", "amendment", ".", "evaluating?", "emendation", ".", "amendable", ".", "created_by?", "(", "current_user", ")", "||", "current_user", ".", "admin?", "end" ]
Checks if the user can accept and reject the emendation
[ "Checks", "if", "the", "user", "can", "accept", "and", "reject", "the", "emendation" ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/amendments_helper.rb#L83-L87
10,774
decidim/decidim
decidim-core/app/helpers/decidim/amendments_helper.rb
Decidim.AmendmentsHelper.allowed_to_promote?
def allowed_to_promote?(emendation) return unless emendation.amendment.rejected? && emendation.created_by?(current_user) return if promoted?(emendation) true end
ruby
def allowed_to_promote?(emendation) return unless emendation.amendment.rejected? && emendation.created_by?(current_user) return if promoted?(emendation) true end
[ "def", "allowed_to_promote?", "(", "emendation", ")", "return", "unless", "emendation", ".", "amendment", ".", "rejected?", "&&", "emendation", ".", "created_by?", "(", "current_user", ")", "return", "if", "promoted?", "(", "emendation", ")", "true", "end" ]
Checks if the user can promote the emendation
[ "Checks", "if", "the", "user", "can", "promote", "the", "emendation" ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/amendments_helper.rb#L90-L95
10,775
decidim/decidim
decidim-core/app/helpers/decidim/amendments_helper.rb
Decidim.AmendmentsHelper.promoted?
def promoted?(emendation) logs = Decidim::ActionLog.where(decidim_component_id: emendation.component) .where(decidim_user_id: emendation.creator_author) .where(action: "promote") logs.select { |log| log.extra["promoted_from"] == emendation.id }.present? end
ruby
def promoted?(emendation) logs = Decidim::ActionLog.where(decidim_component_id: emendation.component) .where(decidim_user_id: emendation.creator_author) .where(action: "promote") logs.select { |log| log.extra["promoted_from"] == emendation.id }.present? end
[ "def", "promoted?", "(", "emendation", ")", "logs", "=", "Decidim", "::", "ActionLog", ".", "where", "(", "decidim_component_id", ":", "emendation", ".", "component", ")", ".", "where", "(", "decidim_user_id", ":", "emendation", ".", "creator_author", ")", ".", "where", "(", "action", ":", "\"promote\"", ")", "logs", ".", "select", "{", "|", "log", "|", "log", ".", "extra", "[", "\"promoted_from\"", "]", "==", "emendation", ".", "id", "}", ".", "present?", "end" ]
Checks if the unique ActionLog created in the promote command exists.
[ "Checks", "if", "the", "unique", "ActionLog", "created", "in", "the", "promote", "command", "exists", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/amendments_helper.rb#L98-L104
10,776
decidim/decidim
decidim-core/app/helpers/decidim/amendments_helper.rb
Decidim.AmendmentsHelper.user_group_select_field
def user_group_select_field(form, name) form.select(name, current_user.user_groups.verified.map { |g| [g.name, g.id] }, selected: form.object.user_group_id.presence, include_blank: current_user.name, label: t("new.amendment_author", scope: "decidim.amendments")) end
ruby
def user_group_select_field(form, name) form.select(name, current_user.user_groups.verified.map { |g| [g.name, g.id] }, selected: form.object.user_group_id.presence, include_blank: current_user.name, label: t("new.amendment_author", scope: "decidim.amendments")) end
[ "def", "user_group_select_field", "(", "form", ",", "name", ")", "form", ".", "select", "(", "name", ",", "current_user", ".", "user_groups", ".", "verified", ".", "map", "{", "|", "g", "|", "[", "g", ".", "name", ",", "g", ".", "id", "]", "}", ",", "selected", ":", "form", ".", "object", ".", "user_group_id", ".", "presence", ",", "include_blank", ":", "current_user", ".", "name", ",", "label", ":", "t", "(", "\"new.amendment_author\"", ",", "scope", ":", "\"decidim.amendments\"", ")", ")", "end" ]
Renders a UserGroup select field in a form.
[ "Renders", "a", "UserGroup", "select", "field", "in", "a", "form", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/amendments_helper.rb#L107-L113
10,777
decidim/decidim
decidim-core/app/helpers/decidim/amendments_helper.rb
Decidim.AmendmentsHelper.emendation_field_value
def emendation_field_value(form, original, key) return params[:amendment][:emendation_params][key] if params[:amendment].present? present(form.object.send(original)).send(key) end
ruby
def emendation_field_value(form, original, key) return params[:amendment][:emendation_params][key] if params[:amendment].present? present(form.object.send(original)).send(key) end
[ "def", "emendation_field_value", "(", "form", ",", "original", ",", "key", ")", "return", "params", "[", ":amendment", "]", "[", ":emendation_params", "]", "[", "key", "]", "if", "params", "[", ":amendment", "]", ".", "present?", "present", "(", "form", ".", "object", ".", "send", "(", "original", ")", ")", ".", "send", "(", "key", ")", "end" ]
Return the edited field value or presents the original attribute value in a form.
[ "Return", "the", "edited", "field", "value", "or", "presents", "the", "original", "attribute", "value", "in", "a", "form", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/amendments_helper.rb#L116-L120
10,778
decidim/decidim
decidim-core/app/helpers/decidim/map_helper.rb
Decidim.MapHelper.static_map_link
def static_map_link(resource, options = {}) return unless resource.geocoded? zoom = options[:zoom] || 17 latitude = resource.latitude longitude = resource.longitude map_url = "https://www.openstreetmap.org/?mlat=#{latitude}&mlon=#{longitude}#map=#{zoom}/#{latitude}/#{longitude}" link_to map_url, target: "_blank" do image_tag decidim.static_map_path(sgid: resource.to_sgid.to_s) end end
ruby
def static_map_link(resource, options = {}) return unless resource.geocoded? zoom = options[:zoom] || 17 latitude = resource.latitude longitude = resource.longitude map_url = "https://www.openstreetmap.org/?mlat=#{latitude}&mlon=#{longitude}#map=#{zoom}/#{latitude}/#{longitude}" link_to map_url, target: "_blank" do image_tag decidim.static_map_path(sgid: resource.to_sgid.to_s) end end
[ "def", "static_map_link", "(", "resource", ",", "options", "=", "{", "}", ")", "return", "unless", "resource", ".", "geocoded?", "zoom", "=", "options", "[", ":zoom", "]", "||", "17", "latitude", "=", "resource", ".", "latitude", "longitude", "=", "resource", ".", "longitude", "map_url", "=", "\"https://www.openstreetmap.org/?mlat=#{latitude}&mlon=#{longitude}#map=#{zoom}/#{latitude}/#{longitude}\"", "link_to", "map_url", ",", "target", ":", "\"_blank\"", "do", "image_tag", "decidim", ".", "static_map_path", "(", "sgid", ":", "resource", ".", "to_sgid", ".", "to_s", ")", "end", "end" ]
Renders a link to openstreetmaps with the resource latitude and longitude. The link's content is a static map image. resource - A geolocalizable resource options - An optional hash of options (default: { zoom: 17 }) * zoom: A number to represent the zoom value of the map
[ "Renders", "a", "link", "to", "openstreetmaps", "with", "the", "resource", "latitude", "and", "longitude", ".", "The", "link", "s", "content", "is", "a", "static", "map", "image", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/map_helper.rb#L12-L24
10,779
decidim/decidim
decidim-core/app/helpers/decidim/attachments_helper.rb
Decidim.AttachmentsHelper.attachment_title
def attachment_title(attachment) attachment.title.is_a?(Hash) ? translated_attribute(attachment.title) : attachment.title end
ruby
def attachment_title(attachment) attachment.title.is_a?(Hash) ? translated_attribute(attachment.title) : attachment.title end
[ "def", "attachment_title", "(", "attachment", ")", "attachment", ".", "title", ".", "is_a?", "(", "Hash", ")", "?", "translated_attribute", "(", "attachment", ".", "title", ")", ":", "attachment", ".", "title", "end" ]
Renders the attachment's title. Checks if the attachment's title is translated or not and use the correct render method. attachment - An Attachment object Returns String.
[ "Renders", "the", "attachment", "s", "title", ".", "Checks", "if", "the", "attachment", "s", "title", "is", "translated", "or", "not", "and", "use", "the", "correct", "render", "method", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/attachments_helper.rb#L23-L25
10,780
decidim/decidim
decidim-core/app/helpers/decidim/replace_buttons_helper.rb
Decidim.ReplaceButtonsHelper.submit_tag
def submit_tag(text = "Save changes", options = {}) options = options.stringify_keys content_tag :button, text, { "type" => "submit", "name" => "commit" }.update(options) end
ruby
def submit_tag(text = "Save changes", options = {}) options = options.stringify_keys content_tag :button, text, { "type" => "submit", "name" => "commit" }.update(options) end
[ "def", "submit_tag", "(", "text", "=", "\"Save changes\"", ",", "options", "=", "{", "}", ")", "options", "=", "options", ".", "stringify_keys", "content_tag", ":button", ",", "text", ",", "{", "\"type\"", "=>", "\"submit\"", ",", "\"name\"", "=>", "\"commit\"", "}", ".", "update", "(", "options", ")", "end" ]
Overrides the submit tags to always be buttons instead of inputs. Buttons are much more stylable and less prone to bugs. value - The text of the button options - Options to provide to the actual tag. Returns a SafeString with the tag.
[ "Overrides", "the", "submit", "tags", "to", "always", "be", "buttons", "instead", "of", "inputs", ".", "Buttons", "are", "much", "more", "stylable", "and", "less", "prone", "to", "bugs", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/replace_buttons_helper.rb#L12-L16
10,781
decidim/decidim
decidim-core/app/services/decidim/traceability.rb
Decidim.Traceability.create
def create(klass, author, params, extra_log_info = {}) perform_action!(:create, klass, author, extra_log_info) do klass.create(params) end end
ruby
def create(klass, author, params, extra_log_info = {}) perform_action!(:create, klass, author, extra_log_info) do klass.create(params) end end
[ "def", "create", "(", "klass", ",", "author", ",", "params", ",", "extra_log_info", "=", "{", "}", ")", "perform_action!", "(", ":create", ",", "klass", ",", "author", ",", "extra_log_info", ")", "do", "klass", ".", "create", "(", "params", ")", "end", "end" ]
Calls the `create` method to the given class and sets the author of the version. klass - An ActiveRecord class that implements `Decidim::Traceable` author - An object that implements `to_gid` or a String params - a Hash with the attributes of the new resource extra_log_info - a Hash with extra info that will be saved to the log Returns an instance of `klass`.
[ "Calls", "the", "create", "method", "to", "the", "given", "class", "and", "sets", "the", "author", "of", "the", "version", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/services/decidim/traceability.rb#L31-L35
10,782
decidim/decidim
decidim-core/app/services/decidim/traceability.rb
Decidim.Traceability.create!
def create!(klass, author, params, extra_log_info = {}) perform_action!(:create, klass, author, extra_log_info) do klass.create!(params) end end
ruby
def create!(klass, author, params, extra_log_info = {}) perform_action!(:create, klass, author, extra_log_info) do klass.create!(params) end end
[ "def", "create!", "(", "klass", ",", "author", ",", "params", ",", "extra_log_info", "=", "{", "}", ")", "perform_action!", "(", ":create", ",", "klass", ",", "author", ",", "extra_log_info", ")", "do", "klass", ".", "create!", "(", "params", ")", "end", "end" ]
Calls the `create!` method to the given class and sets the author of the version. klass - An ActiveRecord class that implements `Decidim::Traceable` author - An object that implements `to_gid` or a String params - a Hash with the attributes of the new resource extra_log_info - a Hash with extra info that will be saved to the log Returns an instance of `klass`.
[ "Calls", "the", "create!", "method", "to", "the", "given", "class", "and", "sets", "the", "author", "of", "the", "version", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/services/decidim/traceability.rb#L45-L49
10,783
decidim/decidim
decidim-core/app/services/decidim/traceability.rb
Decidim.Traceability.perform_action!
def perform_action!(action, resource, author, extra_log_info = {}) PaperTrail.request(whodunnit: gid(author)) do Decidim::ApplicationRecord.transaction do result = block_given? ? yield : nil loggable_resource = resource.is_a?(Class) ? result : resource log(action, author, loggable_resource, extra_log_info) return result end end end
ruby
def perform_action!(action, resource, author, extra_log_info = {}) PaperTrail.request(whodunnit: gid(author)) do Decidim::ApplicationRecord.transaction do result = block_given? ? yield : nil loggable_resource = resource.is_a?(Class) ? result : resource log(action, author, loggable_resource, extra_log_info) return result end end end
[ "def", "perform_action!", "(", "action", ",", "resource", ",", "author", ",", "extra_log_info", "=", "{", "}", ")", "PaperTrail", ".", "request", "(", "whodunnit", ":", "gid", "(", "author", ")", ")", "do", "Decidim", "::", "ApplicationRecord", ".", "transaction", "do", "result", "=", "block_given?", "?", "yield", ":", "nil", "loggable_resource", "=", "resource", ".", "is_a?", "(", "Class", ")", "?", "result", ":", "resource", "log", "(", "action", ",", "author", ",", "loggable_resource", ",", "extra_log_info", ")", "return", "result", "end", "end", "end" ]
Performs the given block and sets the author of the action. It also logs the action with the given `action` parameter. The action and the logging are run inside a transaction. action - a String or Symbol representing the action performed resource - An ActiveRecord instance that implements `Decidim::Traceable` author - An object that implements `to_gid` or a String extra_log_info - a Hash with extra info that will be saved to the log Returns whatever the given block returns.
[ "Performs", "the", "given", "block", "and", "sets", "the", "author", "of", "the", "action", ".", "It", "also", "logs", "the", "action", "with", "the", "given", "action", "parameter", ".", "The", "action", "and", "the", "logging", "are", "run", "inside", "a", "transaction", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/services/decidim/traceability.rb#L61-L70
10,784
decidim/decidim
decidim-core/app/services/decidim/traceability.rb
Decidim.Traceability.update!
def update!(resource, author, params, extra_log_info = {}) perform_action!(:update, resource, author, extra_log_info) do resource.update!(params) resource end end
ruby
def update!(resource, author, params, extra_log_info = {}) perform_action!(:update, resource, author, extra_log_info) do resource.update!(params) resource end end
[ "def", "update!", "(", "resource", ",", "author", ",", "params", ",", "extra_log_info", "=", "{", "}", ")", "perform_action!", "(", ":update", ",", "resource", ",", "author", ",", "extra_log_info", ")", "do", "resource", ".", "update!", "(", "params", ")", "resource", "end", "end" ]
Updates the `resource` with `update!` and sets the author of the version. resource - An ActiveRecord instance that implements `Decidim::Traceable` author - An object that implements `to_gid` or a String params - a Hash with the attributes to update to the resource extra_log_info - a Hash with extra info that will be saved to the log Returns the updated `resource`.
[ "Updates", "the", "resource", "with", "update!", "and", "sets", "the", "author", "of", "the", "version", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/services/decidim/traceability.rb#L80-L85
10,785
decidim/decidim
decidim-core/app/helpers/decidim/application_helper.rb
Decidim.ApplicationHelper.html_truncate
def html_truncate(text, options = {}) options[:max_length] = options.delete(:length) || options[:max_length] options[:tail] = options.delete(:separator) || options[:tail] || "..." options[:count_tags] ||= false options[:count_tail] ||= false options[:tail_before_final_tag] ||= true Truncato.truncate(text, options) end
ruby
def html_truncate(text, options = {}) options[:max_length] = options.delete(:length) || options[:max_length] options[:tail] = options.delete(:separator) || options[:tail] || "..." options[:count_tags] ||= false options[:count_tail] ||= false options[:tail_before_final_tag] ||= true Truncato.truncate(text, options) end
[ "def", "html_truncate", "(", "text", ",", "options", "=", "{", "}", ")", "options", "[", ":max_length", "]", "=", "options", ".", "delete", "(", ":length", ")", "||", "options", "[", ":max_length", "]", "options", "[", ":tail", "]", "=", "options", ".", "delete", "(", ":separator", ")", "||", "options", "[", ":tail", "]", "||", "\"...\"", "options", "[", ":count_tags", "]", "||=", "false", "options", "[", ":count_tail", "]", "||=", "false", "options", "[", ":tail_before_final_tag", "]", "||=", "true", "Truncato", ".", "truncate", "(", "text", ",", "options", ")", "end" ]
Truncates a given text respecting its HTML tags. text - The String text to be truncated. options - A Hash with the options to truncate the text (default: {}): :length - An Integer number with the max length of the text. :separator - A String to append to the text when it's being truncated. See `truncato` gem for more options. Returns a String.
[ "Truncates", "a", "given", "text", "respecting", "its", "HTML", "tags", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/application_helper.rb#L20-L28
10,786
decidim/decidim
decidim-core/app/helpers/decidim/application_helper.rb
Decidim.ApplicationHelper.edit_link
def edit_link(link, action, subject, extra_context = {}) return unless current_user return unless admin_allowed_to?(action, subject, extra_context) return if content_for?(:edit_link) content_for(:edit_link, link) end
ruby
def edit_link(link, action, subject, extra_context = {}) return unless current_user return unless admin_allowed_to?(action, subject, extra_context) return if content_for?(:edit_link) content_for(:edit_link, link) end
[ "def", "edit_link", "(", "link", ",", "action", ",", "subject", ",", "extra_context", "=", "{", "}", ")", "return", "unless", "current_user", "return", "unless", "admin_allowed_to?", "(", "action", ",", "subject", ",", "extra_context", ")", "return", "if", "content_for?", "(", ":edit_link", ")", "content_for", "(", ":edit_link", ",", "link", ")", "end" ]
Generates a link to be added to the global Edit link so admins can easily manage data without having to look for it at the admin panel when they're at a public page. link - The String with the URL. action - The Symbol action to check the permissions for. subject - The Symbol subject to perform the action to. extra_context - An optional Hash to check the permissions. Returns nothing.
[ "Generates", "a", "link", "to", "be", "added", "to", "the", "global", "Edit", "link", "so", "admins", "can", "easily", "manage", "data", "without", "having", "to", "look", "for", "it", "at", "the", "admin", "panel", "when", "they", "re", "at", "a", "public", "page", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/application_helper.rb#L49-L55
10,787
decidim/decidim
decidim-core/lib/decidim/participatory_space_manifest.rb
Decidim.ParticipatorySpaceManifest.context
def context(name = :public, &block) name = name.to_sym @contexts ||= {} if block context = ParticipatorySpaceContextManifest.new context.instance_eval(&block) @contexts[name] = context end @contexts.fetch(name) end
ruby
def context(name = :public, &block) name = name.to_sym @contexts ||= {} if block context = ParticipatorySpaceContextManifest.new context.instance_eval(&block) @contexts[name] = context end @contexts.fetch(name) end
[ "def", "context", "(", "name", "=", ":public", ",", "&", "block", ")", "name", "=", "name", ".", "to_sym", "@contexts", "||=", "{", "}", "if", "block", "context", "=", "ParticipatorySpaceContextManifest", ".", "new", "context", ".", "instance_eval", "(", "block", ")", "@contexts", "[", "name", "]", "=", "context", "end", "@contexts", ".", "fetch", "(", "name", ")", "end" ]
A context used to set the layout and behavior of a participatory space. Full documentation can be found looking at the `ParticipatorySpaceContextManifest` class. Example: context(:public) do |context| context.layout "layouts/decidim/some_layout" end context(:public).layout # => "layouts/decidim/some_layout" Returns Nothing.
[ "A", "context", "used", "to", "set", "the", "layout", "and", "behavior", "of", "a", "participatory", "space", ".", "Full", "documentation", "can", "be", "found", "looking", "at", "the", "ParticipatorySpaceContextManifest", "class", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/lib/decidim/participatory_space_manifest.rb#L62-L73
10,788
decidim/decidim
decidim-core/lib/decidim/friendly_dates.rb
Decidim.FriendlyDates.friendly_created_at
def friendly_created_at current_datetime = Time.current if created_at > current_datetime.beginning_of_day I18n.l(created_at, format: :time_of_day) elsif created_at > current_datetime.beginning_of_week I18n.l(created_at, format: :day_of_week) elsif created_at > current_datetime.beginning_of_year I18n.l(created_at, format: :day_of_month) else I18n.l(created_at, format: :day_of_year) end end
ruby
def friendly_created_at current_datetime = Time.current if created_at > current_datetime.beginning_of_day I18n.l(created_at, format: :time_of_day) elsif created_at > current_datetime.beginning_of_week I18n.l(created_at, format: :day_of_week) elsif created_at > current_datetime.beginning_of_year I18n.l(created_at, format: :day_of_month) else I18n.l(created_at, format: :day_of_year) end end
[ "def", "friendly_created_at", "current_datetime", "=", "Time", ".", "current", "if", "created_at", ">", "current_datetime", ".", "beginning_of_day", "I18n", ".", "l", "(", "created_at", ",", "format", ":", ":time_of_day", ")", "elsif", "created_at", ">", "current_datetime", ".", "beginning_of_week", "I18n", ".", "l", "(", "created_at", ",", "format", ":", ":day_of_week", ")", "elsif", "created_at", ">", "current_datetime", ".", "beginning_of_year", "I18n", ".", "l", "(", "created_at", ",", "format", ":", ":day_of_month", ")", "else", "I18n", ".", "l", "(", "created_at", ",", "format", ":", ":day_of_year", ")", "end", "end" ]
Returns the creation date in a friendly relative format.
[ "Returns", "the", "creation", "date", "in", "a", "friendly", "relative", "format", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/lib/decidim/friendly_dates.rb#L12-L24
10,789
decidim/decidim
decidim-core/app/queries/decidim/metric_manage.rb
Decidim.MetricManage.retrieve_participatory_spaces
def retrieve_participatory_spaces Decidim.participatory_space_manifests.map do |space_manifest| next unless space_manifest.name == :participatory_processes # Temporal limitation space_manifest.participatory_spaces.call(@organization) end.flatten.compact end
ruby
def retrieve_participatory_spaces Decidim.participatory_space_manifests.map do |space_manifest| next unless space_manifest.name == :participatory_processes # Temporal limitation space_manifest.participatory_spaces.call(@organization) end.flatten.compact end
[ "def", "retrieve_participatory_spaces", "Decidim", ".", "participatory_space_manifests", ".", "map", "do", "|", "space_manifest", "|", "next", "unless", "space_manifest", ".", "name", "==", ":participatory_processes", "# Temporal limitation", "space_manifest", ".", "participatory_spaces", ".", "call", "(", "@organization", ")", "end", ".", "flatten", ".", "compact", "end" ]
Search for all Participatory Space manifests and then all records available Limited to ParticipatoryProcesses only
[ "Search", "for", "all", "Participatory", "Space", "manifests", "and", "then", "all", "records", "available", "Limited", "to", "ParticipatoryProcesses", "only" ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/queries/decidim/metric_manage.rb#L61-L66
10,790
decidim/decidim
decidim-core/app/helpers/decidim/localized_locales_helper.rb
Decidim.LocalizedLocalesHelper.localized_locales
def localized_locales(collection = Decidim.available_locales) klass = Class.new do def initialize(locale) @locale = locale end def id @locale.to_s end def name I18n.with_locale(@locale) { I18n.t("name", scope: "locale") } end end collection.map { |locale| klass.new(locale) } end
ruby
def localized_locales(collection = Decidim.available_locales) klass = Class.new do def initialize(locale) @locale = locale end def id @locale.to_s end def name I18n.with_locale(@locale) { I18n.t("name", scope: "locale") } end end collection.map { |locale| klass.new(locale) } end
[ "def", "localized_locales", "(", "collection", "=", "Decidim", ".", "available_locales", ")", "klass", "=", "Class", ".", "new", "do", "def", "initialize", "(", "locale", ")", "@locale", "=", "locale", "end", "def", "id", "@locale", ".", "to_s", "end", "def", "name", "I18n", ".", "with_locale", "(", "@locale", ")", "{", "I18n", ".", "t", "(", "\"name\"", ",", "scope", ":", "\"locale\"", ")", "}", "end", "end", "collection", ".", "map", "{", "|", "locale", "|", "klass", ".", "new", "(", "locale", ")", "}", "end" ]
Converts a given array of strings to an array of Objects representing locales. collection - an Array of Strings. By default it uses all the available locales in Decidim, but you can passa nother collection of locales (for example, the available locales for an organization)
[ "Converts", "a", "given", "array", "of", "strings", "to", "an", "array", "of", "Objects", "representing", "locales", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/localized_locales_helper.rb#L26-L42
10,791
decidim/decidim
decidim-core/app/middleware/decidim/current_organization.rb
Decidim.CurrentOrganization.call
def call(env) organization = detect_current_organization(env) if organization env["decidim.current_organization"] = organization @app.call(env) else organization = find_secondary_host_org(env) return @app.call(env) unless organization location = new_location_for(env, organization.host) [301, { "Location" => location, "Content-Type" => "text/html", "Content-Length" => "0" }, []] end end
ruby
def call(env) organization = detect_current_organization(env) if organization env["decidim.current_organization"] = organization @app.call(env) else organization = find_secondary_host_org(env) return @app.call(env) unless organization location = new_location_for(env, organization.host) [301, { "Location" => location, "Content-Type" => "text/html", "Content-Length" => "0" }, []] end end
[ "def", "call", "(", "env", ")", "organization", "=", "detect_current_organization", "(", "env", ")", "if", "organization", "env", "[", "\"decidim.current_organization\"", "]", "=", "organization", "@app", ".", "call", "(", "env", ")", "else", "organization", "=", "find_secondary_host_org", "(", "env", ")", "return", "@app", ".", "call", "(", "env", ")", "unless", "organization", "location", "=", "new_location_for", "(", "env", ",", "organization", ".", "host", ")", "[", "301", ",", "{", "\"Location\"", "=>", "location", ",", "\"Content-Type\"", "=>", "\"text/html\"", ",", "\"Content-Length\"", "=>", "\"0\"", "}", ",", "[", "]", "]", "end", "end" ]
Initializes the Rack Middleware. app - The Rack application Main entry point for a Rack Middleware. env - A Hash.
[ "Initializes", "the", "Rack", "Middleware", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/middleware/decidim/current_organization.rb#L17-L30
10,792
decidim/decidim
decidim-core/app/commands/decidim/destroy_account.rb
Decidim.DestroyAccount.call
def call return broadcast(:invalid) unless @form.valid? Decidim::User.transaction do destroy_user_account! destroy_user_identities destroy_user_group_memberships destroy_follows end broadcast(:ok) end
ruby
def call return broadcast(:invalid) unless @form.valid? Decidim::User.transaction do destroy_user_account! destroy_user_identities destroy_user_group_memberships destroy_follows end broadcast(:ok) end
[ "def", "call", "return", "broadcast", "(", ":invalid", ")", "unless", "@form", ".", "valid?", "Decidim", "::", "User", ".", "transaction", "do", "destroy_user_account!", "destroy_user_identities", "destroy_user_group_memberships", "destroy_follows", "end", "broadcast", "(", ":ok", ")", "end" ]
Destroy a user's account. user - The user to be updated. form - The form with the data.
[ "Destroy", "a", "user", "s", "account", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/commands/decidim/destroy_account.rb#L15-L26
10,793
decidim/decidim
decidim-core/app/services/decidim/action_authorizer.rb
Decidim.ActionAuthorizer.authorize
def authorize raise AuthorizationError, "Missing data" unless component && action AuthorizationStatusCollection.new(authorization_handlers, user, component, resource) end
ruby
def authorize raise AuthorizationError, "Missing data" unless component && action AuthorizationStatusCollection.new(authorization_handlers, user, component, resource) end
[ "def", "authorize", "raise", "AuthorizationError", ",", "\"Missing data\"", "unless", "component", "&&", "action", "AuthorizationStatusCollection", ".", "new", "(", "authorization_handlers", ",", "user", ",", "component", ",", "resource", ")", "end" ]
Initializes the ActionAuthorizer. user - The user to authorize against. action - The action to authenticate. component - The component to authenticate against. resource - The resource to authenticate against. Can be nil. Authorize user to perform an action in the context of a component. Returns: :ok an empty hash - When there is no authorization handler related to the action. result of authorization handler check - When there is an authorization handler related to the action. Check Decidim::Verifications::DefaultActionAuthorizer class docs.
[ "Initializes", "the", "ActionAuthorizer", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/services/decidim/action_authorizer.rb#L29-L33
10,794
decidim/decidim
decidim-core/app/commands/decidim/update_account.rb
Decidim.UpdateAccount.call
def call return broadcast(:invalid) unless @form.valid? update_personal_data update_avatar update_password if @user.valid? @user.save! notify_followers broadcast(:ok, @user.unconfirmed_email.present?) else @form.errors.add :avatar, @user.errors[:avatar] if @user.errors.has_key? :avatar broadcast(:invalid) end end
ruby
def call return broadcast(:invalid) unless @form.valid? update_personal_data update_avatar update_password if @user.valid? @user.save! notify_followers broadcast(:ok, @user.unconfirmed_email.present?) else @form.errors.add :avatar, @user.errors[:avatar] if @user.errors.has_key? :avatar broadcast(:invalid) end end
[ "def", "call", "return", "broadcast", "(", ":invalid", ")", "unless", "@form", ".", "valid?", "update_personal_data", "update_avatar", "update_password", "if", "@user", ".", "valid?", "@user", ".", "save!", "notify_followers", "broadcast", "(", ":ok", ",", "@user", ".", "unconfirmed_email", ".", "present?", ")", "else", "@form", ".", "errors", ".", "add", ":avatar", ",", "@user", ".", "errors", "[", ":avatar", "]", "if", "@user", ".", "errors", ".", "has_key?", ":avatar", "broadcast", "(", ":invalid", ")", "end", "end" ]
Updates a user's account. user - The user to be updated. form - The form with the data.
[ "Updates", "a", "user", "s", "account", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/commands/decidim/update_account.rb#L15-L30
10,795
decidim/decidim
decidim-core/app/helpers/decidim/resource_helper.rb
Decidim.ResourceHelper.linked_resources_for
def linked_resources_for(resource, type, link_name) linked_resources = resource.linked_resources(type, link_name).group_by { |linked_resource| linked_resource.class.name } safe_join(linked_resources.map do |klass, resources| resource_manifest = klass.constantize.resource_manifest content_tag(:div, class: "section") do i18n_name = "#{resource.class.name.demodulize.underscore}_#{resource_manifest.name}" content_tag(:h3, I18n.t(i18n_name, scope: "decidim.resource_links.#{link_name}"), class: "section-heading") + render(partial: resource_manifest.template, locals: { resources: resources }) end end) end
ruby
def linked_resources_for(resource, type, link_name) linked_resources = resource.linked_resources(type, link_name).group_by { |linked_resource| linked_resource.class.name } safe_join(linked_resources.map do |klass, resources| resource_manifest = klass.constantize.resource_manifest content_tag(:div, class: "section") do i18n_name = "#{resource.class.name.demodulize.underscore}_#{resource_manifest.name}" content_tag(:h3, I18n.t(i18n_name, scope: "decidim.resource_links.#{link_name}"), class: "section-heading") + render(partial: resource_manifest.template, locals: { resources: resources }) end end) end
[ "def", "linked_resources_for", "(", "resource", ",", "type", ",", "link_name", ")", "linked_resources", "=", "resource", ".", "linked_resources", "(", "type", ",", "link_name", ")", ".", "group_by", "{", "|", "linked_resource", "|", "linked_resource", ".", "class", ".", "name", "}", "safe_join", "(", "linked_resources", ".", "map", "do", "|", "klass", ",", "resources", "|", "resource_manifest", "=", "klass", ".", "constantize", ".", "resource_manifest", "content_tag", "(", ":div", ",", "class", ":", "\"section\"", ")", "do", "i18n_name", "=", "\"#{resource.class.name.demodulize.underscore}_#{resource_manifest.name}\"", "content_tag", "(", ":h3", ",", "I18n", ".", "t", "(", "i18n_name", ",", "scope", ":", "\"decidim.resource_links.#{link_name}\"", ")", ",", "class", ":", "\"section-heading\"", ")", "+", "render", "(", "partial", ":", "resource_manifest", ".", "template", ",", "locals", ":", "{", "resources", ":", "resources", "}", ")", "end", "end", ")", "end" ]
Renders a collection of linked resources for a resource. resource - The resource to get the links from. type - The String type fo the resources we want to render. link_name - The String name of the link between the resources. Example to render the proposals in a meeting view: linked_resources_for(:meeting, :proposals, "proposals_from_meeting") Returns nothing.
[ "Renders", "a", "collection", "of", "linked", "resources", "for", "a", "resource", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/resource_helper.rb#L17-L28
10,796
decidim/decidim
decidim-core/app/helpers/decidim/resource_helper.rb
Decidim.ResourceHelper.resource_title
def resource_title(resource) title = resource.try(:title) || resource.try(:name) || resource.try(:subject) || "#{resource.model_name.human} ##{resource.id}" title = translated_attribute(title) if title.is_a?(Hash) title end
ruby
def resource_title(resource) title = resource.try(:title) || resource.try(:name) || resource.try(:subject) || "#{resource.model_name.human} ##{resource.id}" title = translated_attribute(title) if title.is_a?(Hash) title end
[ "def", "resource_title", "(", "resource", ")", "title", "=", "resource", ".", "try", "(", ":title", ")", "||", "resource", ".", "try", "(", ":name", ")", "||", "resource", ".", "try", "(", ":subject", ")", "||", "\"#{resource.model_name.human} ##{resource.id}\"", "title", "=", "translated_attribute", "(", "title", ")", "if", "title", ".", "is_a?", "(", "Hash", ")", "title", "end" ]
Returns a descriptive title for the resource
[ "Returns", "a", "descriptive", "title", "for", "the", "resource" ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/resource_helper.rb#L74-L78
10,797
decidim/decidim
decidim-core/app/helpers/decidim/paginate_helper.rb
Decidim.PaginateHelper.decidim_paginate
def decidim_paginate(collection, paginate_params = {}) # Kaminari uses url_for to generate the url, but this doesn't play nice with our engine system # and unless we remove these params they are added again as query string :( default_params = { participatory_process_id: nil, component_id: nil } paginate collection, theme: "decidim", params: paginate_params.merge(default_params) end
ruby
def decidim_paginate(collection, paginate_params = {}) # Kaminari uses url_for to generate the url, but this doesn't play nice with our engine system # and unless we remove these params they are added again as query string :( default_params = { participatory_process_id: nil, component_id: nil } paginate collection, theme: "decidim", params: paginate_params.merge(default_params) end
[ "def", "decidim_paginate", "(", "collection", ",", "paginate_params", "=", "{", "}", ")", "# Kaminari uses url_for to generate the url, but this doesn't play nice with our engine system", "# and unless we remove these params they are added again as query string :(", "default_params", "=", "{", "participatory_process_id", ":", "nil", ",", "component_id", ":", "nil", "}", "paginate", "collection", ",", "theme", ":", "\"decidim\"", ",", "params", ":", "paginate_params", ".", "merge", "(", "default_params", ")", "end" ]
Displays pagination links for the given collection, setting the correct theme. This mostly acts as a proxy for the underlying pagination engine. collection - a collection of elements that need to be paginated paginate_params - a Hash with options to delegate to the pagination helper.
[ "Displays", "pagination", "links", "for", "the", "given", "collection", "setting", "the", "correct", "theme", ".", "This", "mostly", "acts", "as", "a", "proxy", "for", "the", "underlying", "pagination", "engine", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/helpers/decidim/paginate_helper.rb#L11-L20
10,798
decidim/decidim
decidim-core/app/models/decidim/action_log.rb
Decidim.ActionLog.participatory_space_lazy
def participatory_space_lazy(cache: true) return if participatory_space_id.blank? || participatory_space_type.blank? return resouce_lazy if participatory_space_id == resource_id && participatory_space_type == resource_type self.class.lazy_relation(participatory_space_id, participatory_space_type, cache) end
ruby
def participatory_space_lazy(cache: true) return if participatory_space_id.blank? || participatory_space_type.blank? return resouce_lazy if participatory_space_id == resource_id && participatory_space_type == resource_type self.class.lazy_relation(participatory_space_id, participatory_space_type, cache) end
[ "def", "participatory_space_lazy", "(", "cache", ":", "true", ")", "return", "if", "participatory_space_id", ".", "blank?", "||", "participatory_space_type", ".", "blank?", "return", "resouce_lazy", "if", "participatory_space_id", "==", "resource_id", "&&", "participatory_space_type", "==", "resource_type", "self", ".", "class", ".", "lazy_relation", "(", "participatory_space_id", ",", "participatory_space_type", ",", "cache", ")", "end" ]
Lazy loads the `participatory_space` association through BatchLoader, can be used as a regular object.
[ "Lazy", "loads", "the", "participatory_space", "association", "through", "BatchLoader", "can", "be", "used", "as", "a", "regular", "object", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/models/decidim/action_log.rb#L79-L84
10,799
decidim/decidim
decidim-core/app/services/decidim/resource_search.rb
Decidim.ResourceSearch.search_scope_id
def search_scope_id clean_scope_ids = if scope_id.is_a?(Hash) scope_id.values else [scope_id].flatten end conditions = [] conditions << "decidim_scope_id IS NULL" if clean_scope_ids.delete("global") conditions.concat(["? = ANY(decidim_scopes.part_of)"] * clean_scope_ids.count) if clean_scope_ids.any? query.includes(:scope).references(:decidim_scopes).where(conditions.join(" OR "), *clean_scope_ids.map(&:to_i)) end
ruby
def search_scope_id clean_scope_ids = if scope_id.is_a?(Hash) scope_id.values else [scope_id].flatten end conditions = [] conditions << "decidim_scope_id IS NULL" if clean_scope_ids.delete("global") conditions.concat(["? = ANY(decidim_scopes.part_of)"] * clean_scope_ids.count) if clean_scope_ids.any? query.includes(:scope).references(:decidim_scopes).where(conditions.join(" OR "), *clean_scope_ids.map(&:to_i)) end
[ "def", "search_scope_id", "clean_scope_ids", "=", "if", "scope_id", ".", "is_a?", "(", "Hash", ")", "scope_id", ".", "values", "else", "[", "scope_id", "]", ".", "flatten", "end", "conditions", "=", "[", "]", "conditions", "<<", "\"decidim_scope_id IS NULL\"", "if", "clean_scope_ids", ".", "delete", "(", "\"global\"", ")", "conditions", ".", "concat", "(", "[", "\"? = ANY(decidim_scopes.part_of)\"", "]", "*", "clean_scope_ids", ".", "count", ")", "if", "clean_scope_ids", ".", "any?", "query", ".", "includes", "(", ":scope", ")", ".", "references", "(", ":decidim_scopes", ")", ".", "where", "(", "conditions", ".", "join", "(", "\" OR \"", ")", ",", "clean_scope_ids", ".", "map", "(", ":to_i", ")", ")", "end" ]
Handles the scope_id filter. When we want to show only those that do not have a scope_id set, we cannot pass an empty String or nil because Searchlight will automatically filter out these params, so the method will not be used. Instead, we need to pass a fake ID and then convert it inside. In this case, in order to select those elements that do not have a scope_id set we use `"global"` as parameter, and in the method we do the needed changes to search properly.
[ "Handles", "the", "scope_id", "filter", ".", "When", "we", "want", "to", "show", "only", "those", "that", "do", "not", "have", "a", "scope_id", "set", "we", "cannot", "pass", "an", "empty", "String", "or", "nil", "because", "Searchlight", "will", "automatically", "filter", "out", "these", "params", "so", "the", "method", "will", "not", "be", "used", ".", "Instead", "we", "need", "to", "pass", "a", "fake", "ID", "and", "then", "convert", "it", "inside", ".", "In", "this", "case", "in", "order", "to", "select", "those", "elements", "that", "do", "not", "have", "a", "scope_id", "set", "we", "use", "global", "as", "parameter", "and", "in", "the", "method", "we", "do", "the", "needed", "changes", "to", "search", "properly", "." ]
6e2b14e559a63088669904e3c5c49a5180700cf7
https://github.com/decidim/decidim/blob/6e2b14e559a63088669904e3c5c49a5180700cf7/decidim-core/app/services/decidim/resource_search.rb#L40-L52