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,400
rails/rails
activestorage/lib/active_storage/attached/many.rb
ActiveStorage.Attached::Many.attach
def attach(*attachables) if record.persisted? && !record.changed? record.update(name => blobs + attachables.flatten) else record.public_send("#{name}=", blobs + attachables.flatten) end end
ruby
def attach(*attachables) if record.persisted? && !record.changed? record.update(name => blobs + attachables.flatten) else record.public_send("#{name}=", blobs + attachables.flatten) end end
[ "def", "attach", "(", "*", "attachables", ")", "if", "record", ".", "persisted?", "&&", "!", "record", ".", "changed?", "record", ".", "update", "(", "name", "=>", "blobs", "+", "attachables", ".", "flatten", ")", "else", "record", ".", "public_send", "(...
Attaches one or more +attachables+ to the record. If the record is persisted and unchanged, the attachments are saved to the database immediately. Otherwise, they'll be saved to the DB when the record is next saved. document.images.attach(params[:images]) # Array of ActionDispatch::Http::UploadedFile objects ...
[ "Attaches", "one", "or", "more", "+", "attachables", "+", "to", "the", "record", "." ]
85a8bc644be69908f05740a5886ec19cd3679df5
https://github.com/rails/rails/blob/85a8bc644be69908f05740a5886ec19cd3679df5/activestorage/lib/active_storage/attached/many.rb#L30-L36
10,401
rails/rails
actionpack/lib/action_dispatch/http/response.rb
ActionDispatch.Response.charset=
def charset=(charset) content_type = parsed_content_type_header.mime_type if false == charset set_content_type content_type, nil else set_content_type content_type, charset || self.class.default_charset end end
ruby
def charset=(charset) content_type = parsed_content_type_header.mime_type if false == charset set_content_type content_type, nil else set_content_type content_type, charset || self.class.default_charset end end
[ "def", "charset", "=", "(", "charset", ")", "content_type", "=", "parsed_content_type_header", ".", "mime_type", "if", "false", "==", "charset", "set_content_type", "content_type", ",", "nil", "else", "set_content_type", "content_type", ",", "charset", "||", "self",...
Sets the HTTP character set. In case of +nil+ parameter it sets the charset to +default_charset+. response.charset = 'utf-16' # => 'utf-16' response.charset = nil # => 'utf-8'
[ "Sets", "the", "HTTP", "character", "set", ".", "In", "case", "of", "+", "nil", "+", "parameter", "it", "sets", "the", "charset", "to", "+", "default_charset", "+", "." ]
85a8bc644be69908f05740a5886ec19cd3679df5
https://github.com/rails/rails/blob/85a8bc644be69908f05740a5886ec19cd3679df5/actionpack/lib/action_dispatch/http/response.rb#L262-L269
10,402
rails/rails
activesupport/lib/active_support/core_ext/date_and_time/calculations.rb
DateAndTime.Calculations.days_to_week_start
def days_to_week_start(start_day = Date.beginning_of_week) start_day_number = DAYS_INTO_WEEK.fetch(start_day) (wday - start_day_number) % 7 end
ruby
def days_to_week_start(start_day = Date.beginning_of_week) start_day_number = DAYS_INTO_WEEK.fetch(start_day) (wday - start_day_number) % 7 end
[ "def", "days_to_week_start", "(", "start_day", "=", "Date", ".", "beginning_of_week", ")", "start_day_number", "=", "DAYS_INTO_WEEK", ".", "fetch", "(", "start_day", ")", "(", "wday", "-", "start_day_number", ")", "%", "7", "end" ]
Returns the number of days to the start of the week on the given day. Week is assumed to start on +start_day+, default is +Date.beginning_of_week+ or +config.beginning_of_week+ when set.
[ "Returns", "the", "number", "of", "days", "to", "the", "start", "of", "the", "week", "on", "the", "given", "day", ".", "Week", "is", "assumed", "to", "start", "on", "+", "start_day", "+", "default", "is", "+", "Date", ".", "beginning_of_week", "+", "or...
85a8bc644be69908f05740a5886ec19cd3679df5
https://github.com/rails/rails/blob/85a8bc644be69908f05740a5886ec19cd3679df5/activesupport/lib/active_support/core_ext/date_and_time/calculations.rb#L265-L268
10,403
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.remote_send
def remote_send(req, marshalled = false) send_initial_metadata GRPC.logger.debug("sending #{req}, marshalled? #{marshalled}") payload = marshalled ? req : @marshal.call(req) @call.run_batch(SEND_MESSAGE => payload) end
ruby
def remote_send(req, marshalled = false) send_initial_metadata GRPC.logger.debug("sending #{req}, marshalled? #{marshalled}") payload = marshalled ? req : @marshal.call(req) @call.run_batch(SEND_MESSAGE => payload) end
[ "def", "remote_send", "(", "req", ",", "marshalled", "=", "false", ")", "send_initial_metadata", "GRPC", ".", "logger", ".", "debug", "(", "\"sending #{req}, marshalled? #{marshalled}\"", ")", "payload", "=", "marshalled", "?", "req", ":", "@marshal", ".", "call",...
remote_send sends a request to the remote endpoint. It blocks until the remote endpoint accepts the message. @param req [Object, String] the object to send or it's marshal form. @param marshalled [false, true] indicates if the object is already marshalled.
[ "remote_send", "sends", "a", "request", "to", "the", "remote", "endpoint", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L191-L196
10,404
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.send_status
def send_status(code = OK, details = '', assert_finished = false, metadata: {}) send_initial_metadata ops = { SEND_STATUS_FROM_SERVER => Struct::Status.new(code, details, metadata) } ops[RECV_CLOSE_ON_SERVER] = nil if assert_finished @call.run_batch(ops) s...
ruby
def send_status(code = OK, details = '', assert_finished = false, metadata: {}) send_initial_metadata ops = { SEND_STATUS_FROM_SERVER => Struct::Status.new(code, details, metadata) } ops[RECV_CLOSE_ON_SERVER] = nil if assert_finished @call.run_batch(ops) s...
[ "def", "send_status", "(", "code", "=", "OK", ",", "details", "=", "''", ",", "assert_finished", "=", "false", ",", "metadata", ":", "{", "}", ")", "send_initial_metadata", "ops", "=", "{", "SEND_STATUS_FROM_SERVER", "=>", "Struct", "::", "Status", ".", "n...
send_status sends a status to the remote endpoint. @param code [int] the status code to send @param details [String] details @param assert_finished [true, false] when true(default), waits for FINISHED. @param metadata [Hash] metadata to send to the server. If a value is a list, mulitple metadata for its key are ...
[ "send_status", "sends", "a", "status", "to", "the", "remote", "endpoint", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L206-L217
10,405
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.remote_read
def remote_read ops = { RECV_MESSAGE => nil } ops[RECV_INITIAL_METADATA] = nil unless @metadata_received batch_result = @call.run_batch(ops) unless @metadata_received @call.metadata = batch_result.metadata @metadata_received = true end get_message_from_batch_result(ba...
ruby
def remote_read ops = { RECV_MESSAGE => nil } ops[RECV_INITIAL_METADATA] = nil unless @metadata_received batch_result = @call.run_batch(ops) unless @metadata_received @call.metadata = batch_result.metadata @metadata_received = true end get_message_from_batch_result(ba...
[ "def", "remote_read", "ops", "=", "{", "RECV_MESSAGE", "=>", "nil", "}", "ops", "[", "RECV_INITIAL_METADATA", "]", "=", "nil", "unless", "@metadata_received", "batch_result", "=", "@call", ".", "run_batch", "(", "ops", ")", "unless", "@metadata_received", "@call...
remote_read reads a response from the remote endpoint. It blocks until the remote endpoint replies with a message or status. On receiving a message, it returns the response after unmarshalling it. On receiving a status, it returns nil if the status is OK, otherwise raising BadStatus
[ "remote_read", "reads", "a", "response", "from", "the", "remote", "endpoint", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L251-L260
10,406
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.each_remote_read
def each_remote_read return enum_for(:each_remote_read) unless block_given? begin loop do resp = remote_read break if resp.nil? # the last response was received yield resp end ensure set_input_stream_done end end
ruby
def each_remote_read return enum_for(:each_remote_read) unless block_given? begin loop do resp = remote_read break if resp.nil? # the last response was received yield resp end ensure set_input_stream_done end end
[ "def", "each_remote_read", "return", "enum_for", "(", ":each_remote_read", ")", "unless", "block_given?", "begin", "loop", "do", "resp", "=", "remote_read", "break", "if", "resp", ".", "nil?", "# the last response was received", "yield", "resp", "end", "ensure", "se...
each_remote_read passes each response to the given block or returns an enumerator the responses if no block is given. Used to generate the request enumerable for server-side client-streaming RPC's. == Enumerator == * #next blocks until the remote endpoint sends a READ or FINISHED * for each read, enumerator#nex...
[ "each_remote_read", "passes", "each", "response", "to", "the", "given", "block", "or", "returns", "an", "enumerator", "the", "responses", "if", "no", "block", "is", "given", ".", "Used", "to", "generate", "the", "request", "enumerable", "for", "server", "-", ...
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L290-L301
10,407
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.each_remote_read_then_finish
def each_remote_read_then_finish return enum_for(:each_remote_read_then_finish) unless block_given? loop do resp = begin remote_read rescue GRPC::Core::CallError => e GRPC.logger.warn("In each_remote_read_then_finish: #{e}") nil end ...
ruby
def each_remote_read_then_finish return enum_for(:each_remote_read_then_finish) unless block_given? loop do resp = begin remote_read rescue GRPC::Core::CallError => e GRPC.logger.warn("In each_remote_read_then_finish: #{e}") nil end ...
[ "def", "each_remote_read_then_finish", "return", "enum_for", "(", ":each_remote_read_then_finish", ")", "unless", "block_given?", "loop", "do", "resp", "=", "begin", "remote_read", "rescue", "GRPC", "::", "Core", "::", "CallError", "=>", "e", "GRPC", ".", "logger", ...
each_remote_read_then_finish passes each response to the given block or returns an enumerator of the responses if no block is given. It is like each_remote_read, but it blocks on finishing on detecting the final message. == Enumerator == * #next blocks until the remote endpoint sends a READ or FINISHED * for e...
[ "each_remote_read_then_finish", "passes", "each", "response", "to", "the", "given", "block", "or", "returns", "an", "enumerator", "of", "the", "responses", "if", "no", "block", "is", "given", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L323-L341
10,408
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.request_response
def request_response(req, metadata: {}) raise_error_if_already_executed ops = { SEND_MESSAGE => @marshal.call(req), SEND_CLOSE_FROM_CLIENT => nil, RECV_INITIAL_METADATA => nil, RECV_MESSAGE => nil, RECV_STATUS_ON_CLIENT => nil } @send_initial_md_mutex.sync...
ruby
def request_response(req, metadata: {}) raise_error_if_already_executed ops = { SEND_MESSAGE => @marshal.call(req), SEND_CLOSE_FROM_CLIENT => nil, RECV_INITIAL_METADATA => nil, RECV_MESSAGE => nil, RECV_STATUS_ON_CLIENT => nil } @send_initial_md_mutex.sync...
[ "def", "request_response", "(", "req", ",", "metadata", ":", "{", "}", ")", "raise_error_if_already_executed", "ops", "=", "{", "SEND_MESSAGE", "=>", "@marshal", ".", "call", "(", "req", ")", ",", "SEND_CLOSE_FROM_CLIENT", "=>", "nil", ",", "RECV_INITIAL_METADAT...
request_response sends a request to a GRPC server, and returns the response. @param req [Object] the request sent to the server @param metadata [Hash] metadata to be sent to the server. If a value is a list, multiple metadata for its key are sent @return [Object] the response received from the server
[ "request_response", "sends", "a", "request", "to", "a", "GRPC", "server", "and", "returns", "the", "response", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L350-L379
10,409
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.client_streamer
def client_streamer(requests, metadata: {}) raise_error_if_already_executed begin send_initial_metadata(metadata) requests.each { |r| @call.run_batch(SEND_MESSAGE => @marshal.call(r)) } rescue GRPC::Core::CallError => e receive_and_check_status # check for Cancelled rai...
ruby
def client_streamer(requests, metadata: {}) raise_error_if_already_executed begin send_initial_metadata(metadata) requests.each { |r| @call.run_batch(SEND_MESSAGE => @marshal.call(r)) } rescue GRPC::Core::CallError => e receive_and_check_status # check for Cancelled rai...
[ "def", "client_streamer", "(", "requests", ",", "metadata", ":", "{", "}", ")", "raise_error_if_already_executed", "begin", "send_initial_metadata", "(", "metadata", ")", "requests", ".", "each", "{", "|", "r", "|", "@call", ".", "run_batch", "(", "SEND_MESSAGE"...
client_streamer sends a stream of requests to a GRPC server, and returns a single response. requests provides an 'iterable' of Requests. I.e. it follows Ruby's #each enumeration protocol. In the simplest case, requests will be an array of marshallable objects; in typical case it will be an Enumerable that allows ...
[ "client_streamer", "sends", "a", "stream", "of", "requests", "to", "a", "GRPC", "server", "and", "returns", "a", "single", "response", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L393-L420
10,410
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.server_streamer
def server_streamer(req, metadata: {}) raise_error_if_already_executed ops = { SEND_MESSAGE => @marshal.call(req), SEND_CLOSE_FROM_CLIENT => nil } @send_initial_md_mutex.synchronize do # Metadata might have already been sent if this is an operation view unless @me...
ruby
def server_streamer(req, metadata: {}) raise_error_if_already_executed ops = { SEND_MESSAGE => @marshal.call(req), SEND_CLOSE_FROM_CLIENT => nil } @send_initial_md_mutex.synchronize do # Metadata might have already been sent if this is an operation view unless @me...
[ "def", "server_streamer", "(", "req", ",", "metadata", ":", "{", "}", ")", "raise_error_if_already_executed", "ops", "=", "{", "SEND_MESSAGE", "=>", "@marshal", ".", "call", "(", "req", ")", ",", "SEND_CLOSE_FROM_CLIENT", "=>", "nil", "}", "@send_initial_md_mute...
server_streamer sends one request to the GRPC server, which yields a stream of responses. responses provides an enumerator over the streamed responses, i.e. it follows Ruby's #each iteration protocol. The enumerator blocks while waiting for each response, stops when the server signals that no further responses w...
[ "server_streamer", "sends", "one", "request", "to", "the", "GRPC", "server", "which", "yields", "a", "stream", "of", "responses", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L436-L465
10,411
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.bidi_streamer
def bidi_streamer(requests, metadata: {}, &blk) raise_error_if_already_executed # Metadata might have already been sent if this is an operation view begin send_initial_metadata(metadata) rescue GRPC::Core::CallError => e batch_result = @call.run_batch(RECV_STATUS_ON_CLIENT => nil...
ruby
def bidi_streamer(requests, metadata: {}, &blk) raise_error_if_already_executed # Metadata might have already been sent if this is an operation view begin send_initial_metadata(metadata) rescue GRPC::Core::CallError => e batch_result = @call.run_batch(RECV_STATUS_ON_CLIENT => nil...
[ "def", "bidi_streamer", "(", "requests", ",", "metadata", ":", "{", "}", ",", "&", "blk", ")", "raise_error_if_already_executed", "# Metadata might have already been sent if this is an operation view", "begin", "send_initial_metadata", "(", "metadata", ")", "rescue", "GRPC"...
bidi_streamer sends a stream of requests to the GRPC server, and yields a stream of responses. This method takes an Enumerable of requests, and returns and enumerable of responses. == requests == requests provides an 'iterable' of Requests. I.e. it follows Ruby's #each enumeration protocol. In the simplest cas...
[ "bidi_streamer", "sends", "a", "stream", "of", "requests", "to", "the", "GRPC", "server", "and", "yields", "a", "stream", "of", "responses", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L494-L520
10,412
grpc/grpc
src/ruby/lib/grpc/generic/active_call.rb
GRPC.ActiveCall.run_server_bidi
def run_server_bidi(mth, interception_ctx) view = multi_req_view bidi_call = BidiCall.new( @call, @marshal, @unmarshal, metadata_received: @metadata_received, req_view: view ) requests = bidi_call.read_next_loop(proc { set_input_stream_done }, false) ...
ruby
def run_server_bidi(mth, interception_ctx) view = multi_req_view bidi_call = BidiCall.new( @call, @marshal, @unmarshal, metadata_received: @metadata_received, req_view: view ) requests = bidi_call.read_next_loop(proc { set_input_stream_done }, false) ...
[ "def", "run_server_bidi", "(", "mth", ",", "interception_ctx", ")", "view", "=", "multi_req_view", "bidi_call", "=", "BidiCall", ".", "new", "(", "@call", ",", "@marshal", ",", "@unmarshal", ",", "metadata_received", ":", "@metadata_received", ",", "req_view", "...
run_server_bidi orchestrates a BiDi stream processing on a server. N.B. gen_each_reply is a func(Enumerable<Requests>) It takes an enumerable of requests as an arg, in case there is a relationship between the stream of requests and the stream of replies. This does not mean that must necessarily be one. E.g, the...
[ "run_server_bidi", "orchestrates", "a", "BiDi", "stream", "processing", "on", "a", "server", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/active_call.rb#L535-L553
10,413
grpc/grpc
src/ruby/lib/grpc/generic/bidi_call.rb
GRPC.BidiCall.run_on_client
def run_on_client(requests, set_input_stream_done, set_output_stream_done, &blk) @enq_th = Thread.new do write_loop(requests, set_output_stream_done: set_output_stream_done) end read_loop(set_input_stream_done, &blk) end
ruby
def run_on_client(requests, set_input_stream_done, set_output_stream_done, &blk) @enq_th = Thread.new do write_loop(requests, set_output_stream_done: set_output_stream_done) end read_loop(set_input_stream_done, &blk) end
[ "def", "run_on_client", "(", "requests", ",", "set_input_stream_done", ",", "set_output_stream_done", ",", "&", "blk", ")", "@enq_th", "=", "Thread", ".", "new", "do", "write_loop", "(", "requests", ",", "set_output_stream_done", ":", "set_output_stream_done", ")", ...
Creates a BidiCall. BidiCall should only be created after a call is accepted. That means different things on a client and a server. On the client, the call is accepted after call.invoke. On the server, this is after call.accept. #initialize cannot determine if the call is accepted or not; so if a call that's n...
[ "Creates", "a", "BidiCall", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/bidi_call.rb#L70-L78
10,414
grpc/grpc
src/ruby/lib/grpc/generic/bidi_call.rb
GRPC.BidiCall.run_on_server
def run_on_server(gen_each_reply, requests) replies = nil # Pass in the optional call object parameter if possible if gen_each_reply.arity == 1 replies = gen_each_reply.call(requests) elsif gen_each_reply.arity == 2 replies = gen_each_reply.call(requests, @req_view) else ...
ruby
def run_on_server(gen_each_reply, requests) replies = nil # Pass in the optional call object parameter if possible if gen_each_reply.arity == 1 replies = gen_each_reply.call(requests) elsif gen_each_reply.arity == 2 replies = gen_each_reply.call(requests, @req_view) else ...
[ "def", "run_on_server", "(", "gen_each_reply", ",", "requests", ")", "replies", "=", "nil", "# Pass in the optional call object parameter if possible", "if", "gen_each_reply", ".", "arity", "==", "1", "replies", "=", "gen_each_reply", ".", "call", "(", "requests", ")"...
Begins orchestration of the Bidi stream for a server generating replies. N.B. gen_each_reply is a func(Enumerable<Requests>) It takes an enumerable of requests as an arg, in case there is a relationship between the stream of requests and the stream of replies. This does not mean that must necessarily be one. E....
[ "Begins", "orchestration", "of", "the", "Bidi", "stream", "for", "a", "server", "generating", "replies", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/bidi_call.rb#L92-L105
10,415
grpc/grpc
src/ruby/lib/grpc/generic/bidi_call.rb
GRPC.BidiCall.read_using_run_batch
def read_using_run_batch ops = { RECV_MESSAGE => nil } ops[RECV_INITIAL_METADATA] = nil unless @metadata_received begin batch_result = @call.run_batch(ops) unless @metadata_received @call.metadata = batch_result.metadata @metadata_received = true end ...
ruby
def read_using_run_batch ops = { RECV_MESSAGE => nil } ops[RECV_INITIAL_METADATA] = nil unless @metadata_received begin batch_result = @call.run_batch(ops) unless @metadata_received @call.metadata = batch_result.metadata @metadata_received = true end ...
[ "def", "read_using_run_batch", "ops", "=", "{", "RECV_MESSAGE", "=>", "nil", "}", "ops", "[", "RECV_INITIAL_METADATA", "]", "=", "nil", "unless", "@metadata_received", "begin", "batch_result", "=", "@call", ".", "run_batch", "(", "ops", ")", "unless", "@metadata...
performs a read using @call.run_batch, ensures metadata is set up
[ "performs", "a", "read", "using" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/bidi_call.rb#L124-L139
10,416
grpc/grpc
src/ruby/lib/grpc/generic/bidi_call.rb
GRPC.BidiCall.write_loop
def write_loop(requests, is_client: true, set_output_stream_done: nil) GRPC.logger.debug('bidi-write-loop: starting') count = 0 requests.each do |req| GRPC.logger.debug("bidi-write-loop: #{count}") count += 1 payload = @marshal.call(req) # Fails if status already receiv...
ruby
def write_loop(requests, is_client: true, set_output_stream_done: nil) GRPC.logger.debug('bidi-write-loop: starting') count = 0 requests.each do |req| GRPC.logger.debug("bidi-write-loop: #{count}") count += 1 payload = @marshal.call(req) # Fails if status already receiv...
[ "def", "write_loop", "(", "requests", ",", "is_client", ":", "true", ",", "set_output_stream_done", ":", "nil", ")", "GRPC", ".", "logger", ".", "debug", "(", "'bidi-write-loop: starting'", ")", "count", "=", "0", "requests", ".", "each", "do", "|", "req", ...
set_output_stream_done is relevant on client-side
[ "set_output_stream_done", "is", "relevant", "on", "client", "-", "side" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/bidi_call.rb#L142-L184
10,417
grpc/grpc
src/ruby/lib/grpc/generic/bidi_call.rb
GRPC.BidiCall.read_loop
def read_loop(set_input_stream_done, is_client: true) return enum_for(:read_loop, set_input_stream_done, is_client: is_client) unless block_given? GRPC.logger.debug('bidi-read-loop: starting') begin count = 0 # queue the initial read before b...
ruby
def read_loop(set_input_stream_done, is_client: true) return enum_for(:read_loop, set_input_stream_done, is_client: is_client) unless block_given? GRPC.logger.debug('bidi-read-loop: starting') begin count = 0 # queue the initial read before b...
[ "def", "read_loop", "(", "set_input_stream_done", ",", "is_client", ":", "true", ")", "return", "enum_for", "(", ":read_loop", ",", "set_input_stream_done", ",", "is_client", ":", "is_client", ")", "unless", "block_given?", "GRPC", ".", "logger", ".", "debug", "...
Provides an enumerator that yields results of remote reads
[ "Provides", "an", "enumerator", "that", "yields", "results", "of", "remote", "reads" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/bidi_call.rb#L187-L231
10,418
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.Pool.schedule
def schedule(*args, &blk) return if blk.nil? @stop_mutex.synchronize do if @stopped GRPC.logger.warn('did not schedule job, already stopped') return end GRPC.logger.info('schedule another job') fail 'No worker threads available' if @ready_workers.empty? ...
ruby
def schedule(*args, &blk) return if blk.nil? @stop_mutex.synchronize do if @stopped GRPC.logger.warn('did not schedule job, already stopped') return end GRPC.logger.info('schedule another job') fail 'No worker threads available' if @ready_workers.empty? ...
[ "def", "schedule", "(", "*", "args", ",", "&", "blk", ")", "return", "if", "blk", ".", "nil?", "@stop_mutex", ".", "synchronize", "do", "if", "@stopped", "GRPC", ".", "logger", ".", "warn", "(", "'did not schedule job, already stopped'", ")", "return", "end"...
Runs the given block on the queue with the provided args. @param args the args passed blk when it is called @param blk the block to call
[ "Runs", "the", "given", "block", "on", "the", "queue", "with", "the", "provided", "args", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L58-L72
10,419
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.Pool.start
def start @stop_mutex.synchronize do fail 'already stopped' if @stopped end until @workers.size == @size.to_i new_worker_queue = Queue.new @ready_workers << new_worker_queue next_thread = Thread.new(new_worker_queue) do |jobs| catch(:exit) do # allows { throw...
ruby
def start @stop_mutex.synchronize do fail 'already stopped' if @stopped end until @workers.size == @size.to_i new_worker_queue = Queue.new @ready_workers << new_worker_queue next_thread = Thread.new(new_worker_queue) do |jobs| catch(:exit) do # allows { throw...
[ "def", "start", "@stop_mutex", ".", "synchronize", "do", "fail", "'already stopped'", "if", "@stopped", "end", "until", "@workers", ".", "size", "==", "@size", ".", "to_i", "new_worker_queue", "=", "Queue", ".", "new", "@ready_workers", "<<", "new_worker_queue", ...
Starts running the jobs in the thread pool.
[ "Starts", "running", "the", "jobs", "in", "the", "thread", "pool", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L75-L90
10,420
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.Pool.stop
def stop GRPC.logger.info('stopping, will wait for all the workers to exit') @stop_mutex.synchronize do # wait @keep_alive seconds for workers to stop @stopped = true loop do break unless ready_for_work? worker_queue = @ready_workers.pop worker_queue << [proc {...
ruby
def stop GRPC.logger.info('stopping, will wait for all the workers to exit') @stop_mutex.synchronize do # wait @keep_alive seconds for workers to stop @stopped = true loop do break unless ready_for_work? worker_queue = @ready_workers.pop worker_queue << [proc {...
[ "def", "stop", "GRPC", ".", "logger", ".", "info", "(", "'stopping, will wait for all the workers to exit'", ")", "@stop_mutex", ".", "synchronize", "do", "# wait @keep_alive seconds for workers to stop", "@stopped", "=", "true", "loop", "do", "break", "unless", "ready_fo...
Stops the jobs in the pool
[ "Stops", "the", "jobs", "in", "the", "pool" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L93-L106
10,421
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.Pool.forcibly_stop_workers
def forcibly_stop_workers return unless @workers.size > 0 GRPC.logger.info("forcibly terminating #{@workers.size} worker(s)") @workers.each do |t| next unless t.alive? begin t.exit rescue StandardError => e GRPC.logger.warn('error while terminating a worker'...
ruby
def forcibly_stop_workers return unless @workers.size > 0 GRPC.logger.info("forcibly terminating #{@workers.size} worker(s)") @workers.each do |t| next unless t.alive? begin t.exit rescue StandardError => e GRPC.logger.warn('error while terminating a worker'...
[ "def", "forcibly_stop_workers", "return", "unless", "@workers", ".", "size", ">", "0", "GRPC", ".", "logger", ".", "info", "(", "\"forcibly terminating #{@workers.size} worker(s)\"", ")", "@workers", ".", "each", "do", "|", "t", "|", "next", "unless", "t", ".", ...
Forcibly shutdown any threads that are still alive.
[ "Forcibly", "shutdown", "any", "threads", "that", "are", "still", "alive", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L111-L123
10,422
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.RpcServer.stop
def stop # if called via run_till_terminated_or_interrupted, # signal stop_server_thread and dont do anything if @stop_server.nil? == false && @stop_server == false @stop_server = true @stop_server_cv.broadcast return end @run_mutex.synchronize do fail 'Ca...
ruby
def stop # if called via run_till_terminated_or_interrupted, # signal stop_server_thread and dont do anything if @stop_server.nil? == false && @stop_server == false @stop_server = true @stop_server_cv.broadcast return end @run_mutex.synchronize do fail 'Ca...
[ "def", "stop", "# if called via run_till_terminated_or_interrupted,", "# signal stop_server_thread and dont do anything", "if", "@stop_server", ".", "nil?", "==", "false", "&&", "@stop_server", "==", "false", "@stop_server", "=", "true", "@stop_server_cv", ".", "broadcast", ...
Creates a new RpcServer. The RPC server is configured using keyword arguments. There are some specific keyword args used to configure the RpcServer instance. * pool_size: the size of the thread pool the server uses to run its threads. No more concurrent requests can be made than the size of the thread pool *...
[ "Creates", "a", "new", "RpcServer", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L242-L258
10,423
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.RpcServer.transition_running_state
def transition_running_state(target_state) state_transitions = { not_started: :running, running: :stopping, stopping: :stopped } if state_transitions[@running_state] == target_state @running_state = target_state else fail "Bad server state transition: #{@r...
ruby
def transition_running_state(target_state) state_transitions = { not_started: :running, running: :stopping, stopping: :stopped } if state_transitions[@running_state] == target_state @running_state = target_state else fail "Bad server state transition: #{@r...
[ "def", "transition_running_state", "(", "target_state", ")", "state_transitions", "=", "{", "not_started", ":", ":running", ",", "running", ":", ":stopping", ",", "stopping", ":", ":stopped", "}", "if", "state_transitions", "[", "@running_state", "]", "==", "targe...
Can only be called while holding @run_mutex
[ "Can", "only", "be", "called", "while", "holding" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L267-L278
10,424
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.RpcServer.handle
def handle(service) @run_mutex.synchronize do unless @running_state == :not_started fail 'cannot add services if the server has been started' end cls = service.is_a?(Class) ? service : service.class assert_valid_service_class(cls) add_rpc_descs_for(service) ...
ruby
def handle(service) @run_mutex.synchronize do unless @running_state == :not_started fail 'cannot add services if the server has been started' end cls = service.is_a?(Class) ? service : service.class assert_valid_service_class(cls) add_rpc_descs_for(service) ...
[ "def", "handle", "(", "service", ")", "@run_mutex", ".", "synchronize", "do", "unless", "@running_state", "==", ":not_started", "fail", "'cannot add services if the server has been started'", "end", "cls", "=", "service", ".", "is_a?", "(", "Class", ")", "?", "servi...
handle registration of classes service is either a class that includes GRPC::GenericService and whose #new function can be called without argument or any instance of such a class. E.g, after class Divider include GRPC::GenericService rpc :div DivArgs, DivReply # single request, single response def i...
[ "handle", "registration", "of", "classes" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L333-L342
10,425
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.RpcServer.run
def run @run_mutex.synchronize do fail 'cannot run without registering services' if rpc_descs.size.zero? @pool.start @server.start transition_running_state(:running) @run_cond.broadcast end loop_handle_server_calls end
ruby
def run @run_mutex.synchronize do fail 'cannot run without registering services' if rpc_descs.size.zero? @pool.start @server.start transition_running_state(:running) @run_cond.broadcast end loop_handle_server_calls end
[ "def", "run", "@run_mutex", ".", "synchronize", "do", "fail", "'cannot run without registering services'", "if", "rpc_descs", ".", "size", ".", "zero?", "@pool", ".", "start", "@server", ".", "start", "transition_running_state", "(", ":running", ")", "@run_cond", "....
runs the server - if no rpc_descs are registered, this exits immediately, otherwise it continues running permanently and does not return until program exit. - #running? returns true after this is called, until #stop cause the the server to stop.
[ "runs", "the", "server" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L351-L360
10,426
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.RpcServer.run_till_terminated_or_interrupted
def run_till_terminated_or_interrupted(signals, wait_interval = 60) @stop_server = false @stop_server_mu = Mutex.new @stop_server_cv = ConditionVariable.new @stop_server_thread = Thread.new do loop do break if @stop_server @stop_server_mu.synchronize do @...
ruby
def run_till_terminated_or_interrupted(signals, wait_interval = 60) @stop_server = false @stop_server_mu = Mutex.new @stop_server_cv = ConditionVariable.new @stop_server_thread = Thread.new do loop do break if @stop_server @stop_server_mu.synchronize do @...
[ "def", "run_till_terminated_or_interrupted", "(", "signals", ",", "wait_interval", "=", "60", ")", "@stop_server", "=", "false", "@stop_server_mu", "=", "Mutex", ".", "new", "@stop_server_cv", "=", "ConditionVariable", ".", "new", "@stop_server_thread", "=", "Thread",...
runs the server with signal handlers @param signals List of String, Integer or both representing signals that the user would like to send to the server for graceful shutdown @param wait_interval (optional) Integer seconds that user would like stop_server_thread to poll stop_server
[ "runs", "the", "server", "with", "signal", "handlers" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L371-L416
10,427
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.RpcServer.available?
def available?(an_rpc) return an_rpc if @pool.ready_for_work? GRPC.logger.warn('no free worker threads currently') noop = proc { |x| x } # Create a new active call that knows that metadata hasn't been # sent yet c = ActiveCall.new(an_rpc.call, noop, noop, an_rpc.deadline, ...
ruby
def available?(an_rpc) return an_rpc if @pool.ready_for_work? GRPC.logger.warn('no free worker threads currently') noop = proc { |x| x } # Create a new active call that knows that metadata hasn't been # sent yet c = ActiveCall.new(an_rpc.call, noop, noop, an_rpc.deadline, ...
[ "def", "available?", "(", "an_rpc", ")", "return", "an_rpc", "if", "@pool", ".", "ready_for_work?", "GRPC", ".", "logger", ".", "warn", "(", "'no free worker threads currently'", ")", "noop", "=", "proc", "{", "|", "x", "|", "x", "}", "# Create a new active ca...
Sends RESOURCE_EXHAUSTED if there are too many unprocessed jobs
[ "Sends", "RESOURCE_EXHAUSTED", "if", "there", "are", "too", "many", "unprocessed", "jobs" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L419-L431
10,428
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.RpcServer.implemented?
def implemented?(an_rpc) mth = an_rpc.method.to_sym return an_rpc if rpc_descs.key?(mth) GRPC.logger.warn("UNIMPLEMENTED: #{an_rpc}") noop = proc { |x| x } # Create a new active call that knows that # metadata hasn't been sent yet c = ActiveCall.new(an_rpc.call, noop, noop, an...
ruby
def implemented?(an_rpc) mth = an_rpc.method.to_sym return an_rpc if rpc_descs.key?(mth) GRPC.logger.warn("UNIMPLEMENTED: #{an_rpc}") noop = proc { |x| x } # Create a new active call that knows that # metadata hasn't been sent yet c = ActiveCall.new(an_rpc.call, noop, noop, an...
[ "def", "implemented?", "(", "an_rpc", ")", "mth", "=", "an_rpc", ".", "method", ".", "to_sym", "return", "an_rpc", "if", "rpc_descs", ".", "key?", "(", "mth", ")", "GRPC", ".", "logger", ".", "warn", "(", "\"UNIMPLEMENTED: #{an_rpc}\"", ")", "noop", "=", ...
Sends UNIMPLEMENTED if the method is not implemented by this server
[ "Sends", "UNIMPLEMENTED", "if", "the", "method", "is", "not", "implemented", "by", "this", "server" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L434-L446
10,429
grpc/grpc
src/ruby/lib/grpc/generic/rpc_server.rb
GRPC.RpcServer.loop_handle_server_calls
def loop_handle_server_calls fail 'not started' if running_state == :not_started while running_state == :running begin an_rpc = @server.request_call break if (!an_rpc.nil?) && an_rpc.call.nil? active_call = new_active_server_call(an_rpc) unless active_call.nil...
ruby
def loop_handle_server_calls fail 'not started' if running_state == :not_started while running_state == :running begin an_rpc = @server.request_call break if (!an_rpc.nil?) && an_rpc.call.nil? active_call = new_active_server_call(an_rpc) unless active_call.nil...
[ "def", "loop_handle_server_calls", "fail", "'not started'", "if", "running_state", "==", ":not_started", "while", "running_state", "==", ":running", "begin", "an_rpc", "=", "@server", ".", "request_call", "break", "if", "(", "!", "an_rpc", ".", "nil?", ")", "&&", ...
handles calls to the server
[ "handles", "calls", "to", "the", "server" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/rpc_server.rb#L449-L486
10,430
grpc/grpc
src/ruby/lib/grpc/generic/client_stub.rb
GRPC.ClientStub.request_response
def request_response(method, req, marshal, unmarshal, deadline: nil, return_op: false, parent: nil, credentials: nil, metadata: {}) c = new_active_call(method, marshal, unmarshal, ...
ruby
def request_response(method, req, marshal, unmarshal, deadline: nil, return_op: false, parent: nil, credentials: nil, metadata: {}) c = new_active_call(method, marshal, unmarshal, ...
[ "def", "request_response", "(", "method", ",", "req", ",", "marshal", ",", "unmarshal", ",", "deadline", ":", "nil", ",", "return_op", ":", "false", ",", "parent", ":", "nil", ",", "credentials", ":", "nil", ",", "metadata", ":", "{", "}", ")", "c", ...
Creates a new ClientStub. Minimally, a stub is created with the just the host of the gRPC service it wishes to access, e.g., my_stub = ClientStub.new(example.host.com:50505, :this_channel_is_insecure) If a channel_override argument is passed, it will be used as the underlying chann...
[ "Creates", "a", "new", "ClientStub", "." ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/client_stub.rb#L148-L181
10,431
grpc/grpc
src/ruby/lib/grpc/generic/client_stub.rb
GRPC.ClientStub.new_active_call
def new_active_call(method, marshal, unmarshal, deadline: nil, parent: nil, credentials: nil) deadline = from_relative_time(@timeout) if deadline.nil? # Provide each new client call with its own completion queue call = @ch.create_...
ruby
def new_active_call(method, marshal, unmarshal, deadline: nil, parent: nil, credentials: nil) deadline = from_relative_time(@timeout) if deadline.nil? # Provide each new client call with its own completion queue call = @ch.create_...
[ "def", "new_active_call", "(", "method", ",", "marshal", ",", "unmarshal", ",", "deadline", ":", "nil", ",", "parent", ":", "nil", ",", "credentials", ":", "nil", ")", "deadline", "=", "from_relative_time", "(", "@timeout", ")", "if", "deadline", ".", "nil...
Creates a new active stub @param method [string] the method being called. @param marshal [Function] f(obj)->string that marshals requests @param unmarshal [Function] f(string)->obj that unmarshals responses @param parent [Grpc::Call] a parent call, available when calls are made from server @param credentials [...
[ "Creates", "a", "new", "active", "stub" ]
f3937f0e55227a4ef3a23f895d3b204a947610f8
https://github.com/grpc/grpc/blob/f3937f0e55227a4ef3a23f895d3b204a947610f8/src/ruby/lib/grpc/generic/client_stub.rb#L485-L499
10,432
jekyll/jekyll
lib/jekyll/liquid_extensions.rb
Jekyll.LiquidExtensions.lookup_variable
def lookup_variable(context, variable) lookup = context variable.split(".").each do |value| lookup = lookup[value] end lookup || variable end
ruby
def lookup_variable(context, variable) lookup = context variable.split(".").each do |value| lookup = lookup[value] end lookup || variable end
[ "def", "lookup_variable", "(", "context", ",", "variable", ")", "lookup", "=", "context", "variable", ".", "split", "(", "\".\"", ")", ".", "each", "do", "|", "value", "|", "lookup", "=", "lookup", "[", "value", "]", "end", "lookup", "||", "variable", ...
Lookup a Liquid variable in the given context. context - the Liquid context in question. variable - the variable name, as a string. Returns the value of the variable in the context or the variable name if not found.
[ "Lookup", "a", "Liquid", "variable", "in", "the", "given", "context", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/liquid_extensions.rb#L12-L20
10,433
jekyll/jekyll
lib/jekyll/renderer.rb
Jekyll.Renderer.converters
def converters @converters ||= site.converters.select { |c| c.matches(document.extname) }.sort end
ruby
def converters @converters ||= site.converters.select { |c| c.matches(document.extname) }.sort end
[ "def", "converters", "@converters", "||=", "site", ".", "converters", ".", "select", "{", "|", "c", "|", "c", ".", "matches", "(", "document", ".", "extname", ")", "}", ".", "sort", "end" ]
Determine which converters to use based on this document's extension. Returns Array of Converter instances.
[ "Determine", "which", "converters", "to", "use", "based", "on", "this", "document", "s", "extension", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/renderer.rb#L38-L40
10,434
jekyll/jekyll
lib/jekyll/renderer.rb
Jekyll.Renderer.run
def run Jekyll.logger.debug "Rendering:", document.relative_path assign_pages! assign_current_document! assign_highlighter_options! assign_layout_data! Jekyll.logger.debug "Pre-Render Hooks:", document.relative_path document.trigger_hooks(:pre_render, payload) render_d...
ruby
def run Jekyll.logger.debug "Rendering:", document.relative_path assign_pages! assign_current_document! assign_highlighter_options! assign_layout_data! Jekyll.logger.debug "Pre-Render Hooks:", document.relative_path document.trigger_hooks(:pre_render, payload) render_d...
[ "def", "run", "Jekyll", ".", "logger", ".", "debug", "\"Rendering:\"", ",", "document", ".", "relative_path", "assign_pages!", "assign_current_document!", "assign_highlighter_options!", "assign_layout_data!", "Jekyll", ".", "logger", ".", "debug", "\"Pre-Render Hooks:\"", ...
Prepare payload and render the document Returns String rendered document output
[ "Prepare", "payload", "and", "render", "the", "document" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/renderer.rb#L52-L64
10,435
jekyll/jekyll
lib/jekyll/renderer.rb
Jekyll.Renderer.render_document
def render_document info = { :registers => { :site => site, :page => payload["page"] }, :strict_filters => liquid_options["strict_filters"], :strict_variables => liquid_options["strict_variables"], } output = document.content if document.render_with_liquid? ...
ruby
def render_document info = { :registers => { :site => site, :page => payload["page"] }, :strict_filters => liquid_options["strict_filters"], :strict_variables => liquid_options["strict_variables"], } output = document.content if document.render_with_liquid? ...
[ "def", "render_document", "info", "=", "{", ":registers", "=>", "{", ":site", "=>", "site", ",", ":page", "=>", "payload", "[", "\"page\"", "]", "}", ",", ":strict_filters", "=>", "liquid_options", "[", "\"strict_filters\"", "]", ",", ":strict_variables", "=>"...
Render the document. Returns String rendered document output rubocop: disable AbcSize
[ "Render", "the", "document", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/renderer.rb#L70-L93
10,436
jekyll/jekyll
lib/jekyll/renderer.rb
Jekyll.Renderer.place_in_layouts
def place_in_layouts(content, payload, info) output = content.dup layout = layouts[document.data["layout"].to_s] validate_layout(layout) used = Set.new([layout]) # Reset the payload layout data to ensure it starts fresh for each page. payload["layout"] = nil while layout ...
ruby
def place_in_layouts(content, payload, info) output = content.dup layout = layouts[document.data["layout"].to_s] validate_layout(layout) used = Set.new([layout]) # Reset the payload layout data to ensure it starts fresh for each page. payload["layout"] = nil while layout ...
[ "def", "place_in_layouts", "(", "content", ",", "payload", ",", "info", ")", "output", "=", "content", ".", "dup", "layout", "=", "layouts", "[", "document", ".", "data", "[", "\"layout\"", "]", ".", "to_s", "]", "validate_layout", "(", "layout", ")", "u...
Render layouts and place document content inside. Returns String rendered content
[ "Render", "layouts", "and", "place", "document", "content", "inside", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/renderer.rb#L148-L168
10,437
jekyll/jekyll
lib/jekyll/renderer.rb
Jekyll.Renderer.validate_layout
def validate_layout(layout) if invalid_layout?(layout) Jekyll.logger.warn( "Build Warning:", "Layout '#{document.data["layout"]}' requested "\ "in #{document.relative_path} does not exist." ) elsif !layout.nil? layout_source = layout.path.start_with?(sit...
ruby
def validate_layout(layout) if invalid_layout?(layout) Jekyll.logger.warn( "Build Warning:", "Layout '#{document.data["layout"]}' requested "\ "in #{document.relative_path} does not exist." ) elsif !layout.nil? layout_source = layout.path.start_with?(sit...
[ "def", "validate_layout", "(", "layout", ")", "if", "invalid_layout?", "(", "layout", ")", "Jekyll", ".", "logger", ".", "warn", "(", "\"Build Warning:\"", ",", "\"Layout '#{document.data[\"layout\"]}' requested \"", "\"in #{document.relative_path} does not exist.\"", ")", ...
Checks if the layout specified in the document actually exists layout - the layout to check Returns nothing
[ "Checks", "if", "the", "layout", "specified", "in", "the", "document", "actually", "exists" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/renderer.rb#L176-L187
10,438
jekyll/jekyll
lib/jekyll/renderer.rb
Jekyll.Renderer.render_layout
def render_layout(output, layout, info) payload["content"] = output payload["layout"] = Utils.deep_merge_hashes(layout.data, payload["layout"] || {}) render_liquid( layout.content, payload, info, layout.relative_path ) end
ruby
def render_layout(output, layout, info) payload["content"] = output payload["layout"] = Utils.deep_merge_hashes(layout.data, payload["layout"] || {}) render_liquid( layout.content, payload, info, layout.relative_path ) end
[ "def", "render_layout", "(", "output", ",", "layout", ",", "info", ")", "payload", "[", "\"content\"", "]", "=", "output", "payload", "[", "\"layout\"", "]", "=", "Utils", ".", "deep_merge_hashes", "(", "layout", ".", "data", ",", "payload", "[", "\"layout...
Render layout content into document.output Returns String rendered content
[ "Render", "layout", "content", "into", "document", ".", "output" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/renderer.rb#L192-L202
10,439
jekyll/jekyll
lib/jekyll/renderer.rb
Jekyll.Renderer.assign_pages!
def assign_pages! payload["page"] = document.to_liquid payload["paginator"] = (document.pager.to_liquid if document.respond_to?(:pager)) end
ruby
def assign_pages! payload["page"] = document.to_liquid payload["paginator"] = (document.pager.to_liquid if document.respond_to?(:pager)) end
[ "def", "assign_pages!", "payload", "[", "\"page\"", "]", "=", "document", ".", "to_liquid", "payload", "[", "\"paginator\"", "]", "=", "(", "document", ".", "pager", ".", "to_liquid", "if", "document", ".", "respond_to?", "(", ":pager", ")", ")", "end" ]
Set page content to payload and assign pager if document has one. Returns nothing
[ "Set", "page", "content", "to", "payload", "and", "assign", "pager", "if", "document", "has", "one", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/renderer.rb#L216-L219
10,440
jekyll/jekyll
lib/jekyll/reader.rb
Jekyll.Reader.read
def read @site.layouts = LayoutReader.new(site).read read_directories read_included_excludes sort_files! @site.data = DataReader.new(site).read(site.config["data_dir"]) CollectionReader.new(site).read ThemeAssetsReader.new(site).read end
ruby
def read @site.layouts = LayoutReader.new(site).read read_directories read_included_excludes sort_files! @site.data = DataReader.new(site).read(site.config["data_dir"]) CollectionReader.new(site).read ThemeAssetsReader.new(site).read end
[ "def", "read", "@site", ".", "layouts", "=", "LayoutReader", ".", "new", "(", "site", ")", ".", "read", "read_directories", "read_included_excludes", "sort_files!", "@site", ".", "data", "=", "DataReader", ".", "new", "(", "site", ")", ".", "read", "(", "s...
Read Site data from disk and load it into internal data structures. Returns nothing.
[ "Read", "Site", "data", "from", "disk", "and", "load", "it", "into", "internal", "data", "structures", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/reader.rb#L14-L22
10,441
jekyll/jekyll
lib/jekyll/reader.rb
Jekyll.Reader.retrieve_dirs
def retrieve_dirs(_base, dir, dot_dirs) dot_dirs.each do |file| dir_path = site.in_source_dir(dir, file) rel_path = File.join(dir, file) @site.reader.read_directories(rel_path) unless @site.dest.chomp("/") == dir_path end end
ruby
def retrieve_dirs(_base, dir, dot_dirs) dot_dirs.each do |file| dir_path = site.in_source_dir(dir, file) rel_path = File.join(dir, file) @site.reader.read_directories(rel_path) unless @site.dest.chomp("/") == dir_path end end
[ "def", "retrieve_dirs", "(", "_base", ",", "dir", ",", "dot_dirs", ")", "dot_dirs", ".", "each", "do", "|", "file", "|", "dir_path", "=", "site", ".", "in_source_dir", "(", "dir", ",", "file", ")", "rel_path", "=", "File", ".", "join", "(", "dir", ",...
Recursively traverse directories with the read_directories function. base - The String representing the site's base directory. dir - The String representing the directory to traverse down. dot_dirs - The Array of subdirectories in the dir. Returns nothing.
[ "Recursively", "traverse", "directories", "with", "the", "read_directories", "function", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/reader.rb#L85-L91
10,442
jekyll/jekyll
lib/jekyll/reader.rb
Jekyll.Reader.get_entries
def get_entries(dir, subfolder) base = site.in_source_dir(dir, subfolder) return [] unless File.exist?(base) entries = Dir.chdir(base) { filter_entries(Dir["**/*"], base) } entries.delete_if { |e| File.directory?(site.in_source_dir(base, e)) } end
ruby
def get_entries(dir, subfolder) base = site.in_source_dir(dir, subfolder) return [] unless File.exist?(base) entries = Dir.chdir(base) { filter_entries(Dir["**/*"], base) } entries.delete_if { |e| File.directory?(site.in_source_dir(base, e)) } end
[ "def", "get_entries", "(", "dir", ",", "subfolder", ")", "base", "=", "site", ".", "in_source_dir", "(", "dir", ",", "subfolder", ")", "return", "[", "]", "unless", "File", ".", "exist?", "(", "base", ")", "entries", "=", "Dir", ".", "chdir", "(", "b...
Read the entries from a particular directory for processing dir - The String representing the relative path of the directory to read. subfolder - The String representing the directory to read. Returns the list of entries to process
[ "Read", "the", "entries", "from", "a", "particular", "directory", "for", "processing" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/reader.rb#L134-L140
10,443
jekyll/jekyll
lib/jekyll/site.rb
Jekyll.Site.write
def write each_site_file do |item| item.write(dest) if regenerator.regenerate?(item) end regenerator.write_metadata Jekyll::Hooks.trigger :site, :post_write, self end
ruby
def write each_site_file do |item| item.write(dest) if regenerator.regenerate?(item) end regenerator.write_metadata Jekyll::Hooks.trigger :site, :post_write, self end
[ "def", "write", "each_site_file", "do", "|", "item", "|", "item", ".", "write", "(", "dest", ")", "if", "regenerator", ".", "regenerate?", "(", "item", ")", "end", "regenerator", ".", "write_metadata", "Jekyll", "::", "Hooks", ".", "trigger", ":site", ",",...
Write static files, pages, and posts. Returns nothing.
[ "Write", "static", "files", "pages", "and", "posts", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/site.rb#L217-L223
10,444
jekyll/jekyll
lib/jekyll/site.rb
Jekyll.Site.post_attr_hash
def post_attr_hash(post_attr) # Build a hash map based on the specified post attribute ( post attr => # array of posts ) then sort each array in reverse order. @post_attr_hash[post_attr] ||= begin hash = Hash.new { |h, key| h[key] = [] } posts.docs.each do |p| p.data[post_att...
ruby
def post_attr_hash(post_attr) # Build a hash map based on the specified post attribute ( post attr => # array of posts ) then sort each array in reverse order. @post_attr_hash[post_attr] ||= begin hash = Hash.new { |h, key| h[key] = [] } posts.docs.each do |p| p.data[post_att...
[ "def", "post_attr_hash", "(", "post_attr", ")", "# Build a hash map based on the specified post attribute ( post attr =>", "# array of posts ) then sort each array in reverse order.", "@post_attr_hash", "[", "post_attr", "]", "||=", "begin", "hash", "=", "Hash", ".", "new", "{", ...
Construct a Hash of Posts indexed by the specified Post attribute. post_attr - The String name of the Post attribute. Examples post_attr_hash('categories') # => { 'tech' => [<Post A>, <Post B>], # 'ruby' => [<Post B>] } Returns the Hash: { attr => posts } where attr - One of the values for the ...
[ "Construct", "a", "Hash", "of", "Posts", "indexed", "by", "the", "specified", "Post", "attribute", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/site.rb#L242-L253
10,445
jekyll/jekyll
lib/jekyll/site.rb
Jekyll.Site.find_converter_instance
def find_converter_instance(klass) @find_converter_instance ||= {} @find_converter_instance[klass] ||= begin converters.find { |converter| converter.instance_of?(klass) } || \ raise("No Converters found for #{klass}") end end
ruby
def find_converter_instance(klass) @find_converter_instance ||= {} @find_converter_instance[klass] ||= begin converters.find { |converter| converter.instance_of?(klass) } || \ raise("No Converters found for #{klass}") end end
[ "def", "find_converter_instance", "(", "klass", ")", "@find_converter_instance", "||=", "{", "}", "@find_converter_instance", "[", "klass", "]", "||=", "begin", "converters", ".", "find", "{", "|", "converter", "|", "converter", ".", "instance_of?", "(", "klass", ...
Get the implementation class for the given Converter. Returns the Converter instance implementing the given Converter. klass - The Class of the Converter to fetch.
[ "Get", "the", "implementation", "class", "for", "the", "given", "Converter", ".", "Returns", "the", "Converter", "instance", "implementing", "the", "given", "Converter", ".", "klass", "-", "The", "Class", "of", "the", "Converter", "to", "fetch", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/site.rb#L292-L298
10,446
jekyll/jekyll
lib/jekyll/site.rb
Jekyll.Site.instantiate_subclasses
def instantiate_subclasses(klass) klass.descendants.select { |c| !safe || c.safe }.sort.map do |c| c.new(config) end end
ruby
def instantiate_subclasses(klass) klass.descendants.select { |c| !safe || c.safe }.sort.map do |c| c.new(config) end end
[ "def", "instantiate_subclasses", "(", "klass", ")", "klass", ".", "descendants", ".", "select", "{", "|", "c", "|", "!", "safe", "||", "c", ".", "safe", "}", ".", "sort", ".", "map", "do", "|", "c", "|", "c", ".", "new", "(", "config", ")", "end"...
klass - class or module containing the subclasses. Returns array of instances of subclasses of parameter. Create array of instances of the subclasses of the class or module passed in as argument.
[ "klass", "-", "class", "or", "module", "containing", "the", "subclasses", ".", "Returns", "array", "of", "instances", "of", "subclasses", "of", "parameter", ".", "Create", "array", "of", "instances", "of", "the", "subclasses", "of", "the", "class", "or", "mo...
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/site.rb#L305-L309
10,447
jekyll/jekyll
lib/jekyll/site.rb
Jekyll.Site.documents
def documents @documents ||= collections.reduce(Set.new) do |docs, (_, collection)| docs + collection.docs + collection.files end.to_a end
ruby
def documents @documents ||= collections.reduce(Set.new) do |docs, (_, collection)| docs + collection.docs + collection.files end.to_a end
[ "def", "documents", "@documents", "||=", "collections", ".", "reduce", "(", "Set", ".", "new", ")", "do", "|", "docs", ",", "(", "_", ",", "collection", ")", "|", "docs", "+", "collection", ".", "docs", "+", "collection", ".", "files", "end", ".", "t...
Get all the documents Returns an Array of all Documents
[ "Get", "all", "the", "documents" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/site.rb#L335-L339
10,448
jekyll/jekyll
lib/jekyll/site.rb
Jekyll.Site.configure_cache
def configure_cache Jekyll::Cache.cache_dir = in_source_dir(config["cache_dir"], "Jekyll/Cache") Jekyll::Cache.disable_disk_cache! if safe end
ruby
def configure_cache Jekyll::Cache.cache_dir = in_source_dir(config["cache_dir"], "Jekyll/Cache") Jekyll::Cache.disable_disk_cache! if safe end
[ "def", "configure_cache", "Jekyll", "::", "Cache", ".", "cache_dir", "=", "in_source_dir", "(", "config", "[", "\"cache_dir\"", "]", ",", "\"Jekyll/Cache\"", ")", "Jekyll", "::", "Cache", ".", "disable_disk_cache!", "if", "safe", "end" ]
Disable Marshaling cache to disk in Safe Mode
[ "Disable", "Marshaling", "cache", "to", "disk", "in", "Safe", "Mode" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/site.rb#L471-L474
10,449
jekyll/jekyll
lib/jekyll/frontmatter_defaults.rb
Jekyll.FrontmatterDefaults.find
def find(path, type, setting) value = nil old_scope = nil matching_sets(path, type).each do |set| if set["values"].key?(setting) && has_precedence?(old_scope, set["scope"]) value = set["values"][setting] old_scope = set["scope"] end end value end
ruby
def find(path, type, setting) value = nil old_scope = nil matching_sets(path, type).each do |set| if set["values"].key?(setting) && has_precedence?(old_scope, set["scope"]) value = set["values"][setting] old_scope = set["scope"] end end value end
[ "def", "find", "(", "path", ",", "type", ",", "setting", ")", "value", "=", "nil", "old_scope", "=", "nil", "matching_sets", "(", "path", ",", "type", ")", ".", "each", "do", "|", "set", "|", "if", "set", "[", "\"values\"", "]", ".", "key?", "(", ...
Finds a default value for a given setting, filtered by path and type path - the path (relative to the source) of the page, post or :draft the default is used in type - a symbol indicating whether a :page, a :post or a :draft calls this method Returns the default value or nil if none was found
[ "Finds", "a", "default", "value", "for", "a", "given", "setting", "filtered", "by", "path", "and", "type" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/frontmatter_defaults.rb#L60-L71
10,450
jekyll/jekyll
lib/jekyll/frontmatter_defaults.rb
Jekyll.FrontmatterDefaults.all
def all(path, type) defaults = {} old_scope = nil matching_sets(path, type).each do |set| if has_precedence?(old_scope, set["scope"]) defaults = Utils.deep_merge_hashes(defaults, set["values"]) old_scope = set["scope"] else defaults = Utils.deep_merge_hash...
ruby
def all(path, type) defaults = {} old_scope = nil matching_sets(path, type).each do |set| if has_precedence?(old_scope, set["scope"]) defaults = Utils.deep_merge_hashes(defaults, set["values"]) old_scope = set["scope"] else defaults = Utils.deep_merge_hash...
[ "def", "all", "(", "path", ",", "type", ")", "defaults", "=", "{", "}", "old_scope", "=", "nil", "matching_sets", "(", "path", ",", "type", ")", ".", "each", "do", "|", "set", "|", "if", "has_precedence?", "(", "old_scope", ",", "set", "[", "\"scope\...
Collects a hash with all default values for a page or post path - the relative path of the page or post type - a symbol indicating the type (:post, :page or :draft) Returns a hash with all default values (an empty hash if there are none)
[ "Collects", "a", "hash", "with", "all", "default", "values", "for", "a", "page", "or", "post" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/frontmatter_defaults.rb#L79-L91
10,451
jekyll/jekyll
lib/jekyll/frontmatter_defaults.rb
Jekyll.FrontmatterDefaults.valid_sets
def valid_sets sets = @site.config["defaults"] return [] unless sets.is_a?(Array) sets.map do |set| if valid?(set) ensure_time!(update_deprecated_types(set)) else Jekyll.logger.warn "Defaults:", "An invalid front-matter default set was found:" Jekyll.logg...
ruby
def valid_sets sets = @site.config["defaults"] return [] unless sets.is_a?(Array) sets.map do |set| if valid?(set) ensure_time!(update_deprecated_types(set)) else Jekyll.logger.warn "Defaults:", "An invalid front-matter default set was found:" Jekyll.logg...
[ "def", "valid_sets", "sets", "=", "@site", ".", "config", "[", "\"defaults\"", "]", "return", "[", "]", "unless", "sets", ".", "is_a?", "(", "Array", ")", "sets", ".", "map", "do", "|", "set", "|", "if", "valid?", "(", "set", ")", "ensure_time!", "("...
Returns a list of valid sets This is not cached to allow plugins to modify the configuration and have their changes take effect Returns an array of hashes
[ "Returns", "a", "list", "of", "valid", "sets" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/frontmatter_defaults.rb#L218-L231
10,452
jekyll/jekyll
lib/jekyll/cache.rb
Jekyll.Cache.[]
def [](key) return @cache[key] if @cache.key?(key) path = path_to(hash(key)) if disk_cache_enabled? && File.file?(path) && File.readable?(path) @cache[key] = load(path) else raise end end
ruby
def [](key) return @cache[key] if @cache.key?(key) path = path_to(hash(key)) if disk_cache_enabled? && File.file?(path) && File.readable?(path) @cache[key] = load(path) else raise end end
[ "def", "[]", "(", "key", ")", "return", "@cache", "[", "key", "]", "if", "@cache", ".", "key?", "(", "key", ")", "path", "=", "path_to", "(", "hash", "(", "key", ")", ")", "if", "disk_cache_enabled?", "&&", "File", ".", "file?", "(", "path", ")", ...
Retrieve a cached item Raises if key does not exist in cache Returns cached value
[ "Retrieve", "a", "cached", "item", "Raises", "if", "key", "does", "not", "exist", "in", "cache" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/cache.rb#L81-L90
10,453
jekyll/jekyll
lib/jekyll/cache.rb
Jekyll.Cache.[]=
def []=(key, value) @cache[key] = value return unless disk_cache_enabled? path = path_to(hash(key)) value = new Hash(value) if value.is_a?(Hash) && !value.default.nil? dump(path, value) rescue TypeError Jekyll.logger.debug "Cache:", "Cannot dump object #{key}" end
ruby
def []=(key, value) @cache[key] = value return unless disk_cache_enabled? path = path_to(hash(key)) value = new Hash(value) if value.is_a?(Hash) && !value.default.nil? dump(path, value) rescue TypeError Jekyll.logger.debug "Cache:", "Cannot dump object #{key}" end
[ "def", "[]=", "(", "key", ",", "value", ")", "@cache", "[", "key", "]", "=", "value", "return", "unless", "disk_cache_enabled?", "path", "=", "path_to", "(", "hash", "(", "key", ")", ")", "value", "=", "new", "Hash", "(", "value", ")", "if", "value",...
Add an item to cache Returns nothing.
[ "Add", "an", "item", "to", "cache" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/cache.rb#L95-L104
10,454
jekyll/jekyll
lib/jekyll/cache.rb
Jekyll.Cache.delete
def delete(key) @cache.delete(key) File.delete(path_to(hash(key))) if disk_cache_enabled? end
ruby
def delete(key) @cache.delete(key) File.delete(path_to(hash(key))) if disk_cache_enabled? end
[ "def", "delete", "(", "key", ")", "@cache", ".", "delete", "(", "key", ")", "File", ".", "delete", "(", "path_to", "(", "hash", "(", "key", ")", ")", ")", "if", "disk_cache_enabled?", "end" ]
Remove one particular item from the cache Returns nothing.
[ "Remove", "one", "particular", "item", "from", "the", "cache" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/cache.rb#L119-L122
10,455
jekyll/jekyll
lib/jekyll/cache.rb
Jekyll.Cache.key?
def key?(key) # First, check if item is already cached in memory return true if @cache.key?(key) # Otherwise, it might be cached on disk # but we should not consider the disk cache if it is disabled return false unless disk_cache_enabled? path = path_to(hash(key)) File.file?(p...
ruby
def key?(key) # First, check if item is already cached in memory return true if @cache.key?(key) # Otherwise, it might be cached on disk # but we should not consider the disk cache if it is disabled return false unless disk_cache_enabled? path = path_to(hash(key)) File.file?(p...
[ "def", "key?", "(", "key", ")", "# First, check if item is already cached in memory", "return", "true", "if", "@cache", ".", "key?", "(", "key", ")", "# Otherwise, it might be cached on disk", "# but we should not consider the disk cache if it is disabled", "return", "false", "...
Check if `key` already exists in this cache Returns true if key exists in the cache, false otherwise
[ "Check", "if", "key", "already", "exists", "in", "this", "cache" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/cache.rb#L127-L136
10,456
jekyll/jekyll
lib/jekyll/cache.rb
Jekyll.Cache.path_to
def path_to(hash = nil) @base_dir ||= File.join(Jekyll::Cache.cache_dir, @name) return @base_dir if hash.nil? File.join(@base_dir, hash[0..1], hash[2..-1]).freeze end
ruby
def path_to(hash = nil) @base_dir ||= File.join(Jekyll::Cache.cache_dir, @name) return @base_dir if hash.nil? File.join(@base_dir, hash[0..1], hash[2..-1]).freeze end
[ "def", "path_to", "(", "hash", "=", "nil", ")", "@base_dir", "||=", "File", ".", "join", "(", "Jekyll", "::", "Cache", ".", "cache_dir", ",", "@name", ")", "return", "@base_dir", "if", "hash", ".", "nil?", "File", ".", "join", "(", "@base_dir", ",", ...
Given a hashed key, return the path to where this item would be saved on disk.
[ "Given", "a", "hashed", "key", "return", "the", "path", "to", "where", "this", "item", "would", "be", "saved", "on", "disk", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/cache.rb#L145-L150
10,457
jekyll/jekyll
lib/jekyll/convertible.rb
Jekyll.Convertible.render_liquid
def render_liquid(content, payload, info, path) _renderer.render_liquid(content, payload, info, path) end
ruby
def render_liquid(content, payload, info, path) _renderer.render_liquid(content, payload, info, path) end
[ "def", "render_liquid", "(", "content", ",", "payload", ",", "info", ",", "path", ")", "_renderer", ".", "render_liquid", "(", "content", ",", "payload", ",", "info", ",", "path", ")", "end" ]
Render Liquid in the content content - the raw Liquid content to render payload - the payload for Liquid info - the info for Liquid Returns the converted content
[ "Render", "Liquid", "in", "the", "content" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/convertible.rb#L107-L109
10,458
jekyll/jekyll
lib/jekyll/convertible.rb
Jekyll.Convertible.to_liquid
def to_liquid(attrs = nil) further_data = Hash[(attrs || self.class::ATTRIBUTES_FOR_LIQUID).map do |attribute| [attribute, send(attribute)] end] defaults = site.frontmatter_defaults.all(relative_path, type) Utils.deep_merge_hashes defaults, Utils.deep_merge_hashes(data, further_data) ...
ruby
def to_liquid(attrs = nil) further_data = Hash[(attrs || self.class::ATTRIBUTES_FOR_LIQUID).map do |attribute| [attribute, send(attribute)] end] defaults = site.frontmatter_defaults.all(relative_path, type) Utils.deep_merge_hashes defaults, Utils.deep_merge_hashes(data, further_data) ...
[ "def", "to_liquid", "(", "attrs", "=", "nil", ")", "further_data", "=", "Hash", "[", "(", "attrs", "||", "self", ".", "class", "::", "ATTRIBUTES_FOR_LIQUID", ")", ".", "map", "do", "|", "attribute", "|", "[", "attribute", ",", "send", "(", "attribute", ...
Convert this Convertible's data to a Hash suitable for use by Liquid. Returns the Hash representation of this Convertible.
[ "Convert", "this", "Convertible", "s", "data", "to", "a", "Hash", "suitable", "for", "use", "by", "Liquid", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/convertible.rb#L114-L121
10,459
jekyll/jekyll
lib/jekyll/convertible.rb
Jekyll.Convertible.render_all_layouts
def render_all_layouts(layouts, payload, info) _renderer.layouts = layouts self.output = _renderer.place_in_layouts(output, payload, info) ensure @_renderer = nil # this will allow the modifications above to disappear end
ruby
def render_all_layouts(layouts, payload, info) _renderer.layouts = layouts self.output = _renderer.place_in_layouts(output, payload, info) ensure @_renderer = nil # this will allow the modifications above to disappear end
[ "def", "render_all_layouts", "(", "layouts", ",", "payload", ",", "info", ")", "_renderer", ".", "layouts", "=", "layouts", "self", ".", "output", "=", "_renderer", ".", "place_in_layouts", "(", "output", ",", "payload", ",", "info", ")", "ensure", "@_render...
Recursively render layouts layouts - a list of the layouts payload - the payload for Liquid info - the info for Liquid Returns nothing
[ "Recursively", "render", "layouts" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/convertible.rb#L192-L197
10,460
jekyll/jekyll
lib/jekyll/convertible.rb
Jekyll.Convertible.do_layout
def do_layout(payload, layouts) self.output = _renderer.tap do |renderer| renderer.layouts = layouts renderer.payload = payload end.run Jekyll.logger.debug "Post-Render Hooks:", relative_path Jekyll::Hooks.trigger hook_owner, :post_render, self ensure @_renderer = nil ...
ruby
def do_layout(payload, layouts) self.output = _renderer.tap do |renderer| renderer.layouts = layouts renderer.payload = payload end.run Jekyll.logger.debug "Post-Render Hooks:", relative_path Jekyll::Hooks.trigger hook_owner, :post_render, self ensure @_renderer = nil ...
[ "def", "do_layout", "(", "payload", ",", "layouts", ")", "self", ".", "output", "=", "_renderer", ".", "tap", "do", "|", "renderer", "|", "renderer", ".", "layouts", "=", "layouts", "renderer", ".", "payload", "=", "payload", "end", ".", "run", "Jekyll",...
Add any necessary layouts to this convertible document. payload - The site payload Drop or Hash. layouts - A Hash of {"name" => "layout"}. Returns nothing.
[ "Add", "any", "necessary", "layouts", "to", "this", "convertible", "document", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/convertible.rb#L205-L215
10,461
jekyll/jekyll
lib/jekyll/plugin_manager.rb
Jekyll.PluginManager.require_theme_deps
def require_theme_deps return false unless site.theme.runtime_dependencies site.theme.runtime_dependencies.each do |dep| next if dep.name == "jekyll" External.require_with_graceful_fail(dep.name) if plugin_allowed?(dep.name) end end
ruby
def require_theme_deps return false unless site.theme.runtime_dependencies site.theme.runtime_dependencies.each do |dep| next if dep.name == "jekyll" External.require_with_graceful_fail(dep.name) if plugin_allowed?(dep.name) end end
[ "def", "require_theme_deps", "return", "false", "unless", "site", ".", "theme", ".", "runtime_dependencies", "site", ".", "theme", ".", "runtime_dependencies", ".", "each", "do", "|", "dep", "|", "next", "if", "dep", ".", "name", "==", "\"jekyll\"", "External"...
Require each of the runtime_dependencies specified by the theme's gemspec. Returns false only if no dependencies have been specified, otherwise nothing.
[ "Require", "each", "of", "the", "runtime_dependencies", "specified", "by", "the", "theme", "s", "gemspec", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/plugin_manager.rb#L38-L46
10,462
jekyll/jekyll
lib/jekyll/plugin_manager.rb
Jekyll.PluginManager.require_plugin_files
def require_plugin_files unless site.safe plugins_path.each do |plugin_search_path| plugin_files = Utils.safe_glob(plugin_search_path, File.join("**", "*.rb")) Jekyll::External.require_with_graceful_fail(plugin_files) end end end
ruby
def require_plugin_files unless site.safe plugins_path.each do |plugin_search_path| plugin_files = Utils.safe_glob(plugin_search_path, File.join("**", "*.rb")) Jekyll::External.require_with_graceful_fail(plugin_files) end end end
[ "def", "require_plugin_files", "unless", "site", ".", "safe", "plugins_path", ".", "each", "do", "|", "plugin_search_path", "|", "plugin_files", "=", "Utils", ".", "safe_glob", "(", "plugin_search_path", ",", "File", ".", "join", "(", "\"**\"", ",", "\"*.rb\"", ...
Require all .rb files if safe mode is off Returns nothing.
[ "Require", "all", ".", "rb", "files", "if", "safe", "mode", "is", "off" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/plugin_manager.rb#L85-L92
10,463
jekyll/jekyll
lib/jekyll/static_file.rb
Jekyll.StaticFile.path
def path # Static file is from a collection inside custom collections directory if !@collection.nil? && !@site.config["collections_dir"].empty? File.join(*[@base, @site.config["collections_dir"], @dir, @name].compact) else File.join(*[@base, @dir, @name].compact) end end
ruby
def path # Static file is from a collection inside custom collections directory if !@collection.nil? && !@site.config["collections_dir"].empty? File.join(*[@base, @site.config["collections_dir"], @dir, @name].compact) else File.join(*[@base, @dir, @name].compact) end end
[ "def", "path", "# Static file is from a collection inside custom collections directory", "if", "!", "@collection", ".", "nil?", "&&", "!", "@site", ".", "config", "[", "\"collections_dir\"", "]", ".", "empty?", "File", ".", "join", "(", "[", "@base", ",", "@site", ...
Initialize a new StaticFile. site - The Site. base - The String path to the <source>. dir - The String path between <source> and the file. name - The String filename of the file. rubocop: disable ParameterLists rubocop: enable ParameterLists Returns source file path.
[ "Initialize", "a", "new", "StaticFile", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/static_file.rb#L42-L49
10,464
jekyll/jekyll
lib/jekyll/document.rb
Jekyll.Document.merge_data!
def merge_data!(other, source: "YAML front matter") merge_categories!(other) Utils.deep_merge_hashes!(data, other) merge_date!(source) data end
ruby
def merge_data!(other, source: "YAML front matter") merge_categories!(other) Utils.deep_merge_hashes!(data, other) merge_date!(source) data end
[ "def", "merge_data!", "(", "other", ",", "source", ":", "\"YAML front matter\"", ")", "merge_categories!", "(", "other", ")", "Utils", ".", "deep_merge_hashes!", "(", "data", ",", "other", ")", "merge_date!", "(", "source", ")", "data", "end" ]
Merge some data in with this document's data. Returns the merged data.
[ "Merge", "some", "data", "in", "with", "this", "document", "s", "data", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/document.rb#L59-L64
10,465
jekyll/jekyll
lib/jekyll/utils.rb
Jekyll.Utils.deep_merge_hashes!
def deep_merge_hashes!(target, overwrite) merge_values(target, overwrite) merge_default_proc(target, overwrite) duplicate_frozen_values(target) target end
ruby
def deep_merge_hashes!(target, overwrite) merge_values(target, overwrite) merge_default_proc(target, overwrite) duplicate_frozen_values(target) target end
[ "def", "deep_merge_hashes!", "(", "target", ",", "overwrite", ")", "merge_values", "(", "target", ",", "overwrite", ")", "merge_default_proc", "(", "target", ",", "overwrite", ")", "duplicate_frozen_values", "(", "target", ")", "target", "end" ]
Merges a master hash with another hash, recursively. master_hash - the "parent" hash whose values will be overridden other_hash - the other hash whose values will be persisted after the merge This code was lovingly stolen from some random gem: http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html Thanks to wh...
[ "Merges", "a", "master", "hash", "with", "another", "hash", "recursively", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/utils.rb#L41-L47
10,466
jekyll/jekyll
lib/jekyll/utils.rb
Jekyll.Utils.pluralized_array_from_hash
def pluralized_array_from_hash(hash, singular_key, plural_key) [].tap do |array| value = value_from_singular_key(hash, singular_key) value ||= value_from_plural_key(hash, plural_key) array << value end.flatten.compact end
ruby
def pluralized_array_from_hash(hash, singular_key, plural_key) [].tap do |array| value = value_from_singular_key(hash, singular_key) value ||= value_from_plural_key(hash, plural_key) array << value end.flatten.compact end
[ "def", "pluralized_array_from_hash", "(", "hash", ",", "singular_key", ",", "plural_key", ")", "[", "]", ".", "tap", "do", "|", "array", "|", "value", "=", "value_from_singular_key", "(", "hash", ",", "singular_key", ")", "value", "||=", "value_from_plural_key",...
Read array from the supplied hash favouring the singular key and then the plural key, and handling any nil entries. hash - the hash to read from singular_key - the singular key plural_key - the plural key Returns an array
[ "Read", "array", "from", "the", "supplied", "hash", "favouring", "the", "singular", "key", "and", "then", "the", "plural", "key", "and", "handling", "any", "nil", "entries", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/utils.rb#L70-L76
10,467
jekyll/jekyll
lib/jekyll/utils.rb
Jekyll.Utils.has_liquid_construct?
def has_liquid_construct?(content) return false if content.nil? || content.empty? content.include?("{%") || content.include?("{{") end
ruby
def has_liquid_construct?(content) return false if content.nil? || content.empty? content.include?("{%") || content.include?("{{") end
[ "def", "has_liquid_construct?", "(", "content", ")", "return", "false", "if", "content", ".", "nil?", "||", "content", ".", "empty?", "content", ".", "include?", "(", "\"{%\"", ")", "||", "content", ".", "include?", "(", "\"{{\"", ")", "end" ]
Determine whether the given content string contains Liquid Tags or Vaiables Returns true is the string contains sequences of `{%` or `{{`
[ "Determine", "whether", "the", "given", "content", "string", "contains", "Liquid", "Tags", "or", "Vaiables" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/utils.rb#L146-L150
10,468
jekyll/jekyll
lib/jekyll/utils.rb
Jekyll.Utils.add_permalink_suffix
def add_permalink_suffix(template, permalink_style) template = template.dup case permalink_style when :pretty template << "/" when :date, :ordinal, :none template << ":output_ext" else template << "/" if permalink_style.to_s.end_with?("/") template << ":out...
ruby
def add_permalink_suffix(template, permalink_style) template = template.dup case permalink_style when :pretty template << "/" when :date, :ordinal, :none template << ":output_ext" else template << "/" if permalink_style.to_s.end_with?("/") template << ":out...
[ "def", "add_permalink_suffix", "(", "template", ",", "permalink_style", ")", "template", "=", "template", ".", "dup", "case", "permalink_style", "when", ":pretty", "template", "<<", "\"/\"", "when", ":date", ",", ":ordinal", ",", ":none", "template", "<<", "\":o...
Add an appropriate suffix to template so that it matches the specified permalink style. template - permalink template without trailing slash or file extension permalink_style - permalink style, either built-in or custom The returned permalink template will use the same ending style as specified in permalink_styl...
[ "Add", "an", "appropriate", "suffix", "to", "template", "so", "that", "it", "matches", "the", "specified", "permalink", "style", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/utils.rb#L249-L263
10,469
jekyll/jekyll
lib/jekyll/utils.rb
Jekyll.Utils.replace_character_sequence_with_hyphen
def replace_character_sequence_with_hyphen(string, mode: "default") replaceable_char = case mode when "raw" SLUGIFY_RAW_REGEXP when "pretty" # "._~!$&'()+,;=@" is human readable (not URI-escaped) in URL # and is allowed in both extN and NTFS. SLUGIFY...
ruby
def replace_character_sequence_with_hyphen(string, mode: "default") replaceable_char = case mode when "raw" SLUGIFY_RAW_REGEXP when "pretty" # "._~!$&'()+,;=@" is human readable (not URI-escaped) in URL # and is allowed in both extN and NTFS. SLUGIFY...
[ "def", "replace_character_sequence_with_hyphen", "(", "string", ",", "mode", ":", "\"default\"", ")", "replaceable_char", "=", "case", "mode", "when", "\"raw\"", "SLUGIFY_RAW_REGEXP", "when", "\"pretty\"", "# \"._~!$&'()+,;=@\" is human readable (not URI-escaped) in URL", "# an...
Replace each character sequence with a hyphen. See Utils#slugify for a description of the character sequence specified by each mode.
[ "Replace", "each", "character", "sequence", "with", "a", "hyphen", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/utils.rb#L342-L362
10,470
jekyll/jekyll
lib/jekyll/page.rb
Jekyll.Page.process
def process(name) self.ext = File.extname(name) self.basename = name[0..-ext.length - 1].gsub(%r!\.*\z!, "") end
ruby
def process(name) self.ext = File.extname(name) self.basename = name[0..-ext.length - 1].gsub(%r!\.*\z!, "") end
[ "def", "process", "(", "name", ")", "self", ".", "ext", "=", "File", ".", "extname", "(", "name", ")", "self", ".", "basename", "=", "name", "[", "0", "..", "-", "ext", ".", "length", "-", "1", "]", ".", "gsub", "(", "%r!", "\\.", "\\z", "!", ...
Extract information from the page filename. name - The String filename of the page file. NOTE: `String#gsub` removes all trailing periods (in comparison to `String#chomp`) Returns nothing.
[ "Extract", "information", "from", "the", "page", "filename", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/page.rb#L121-L124
10,471
jekyll/jekyll
lib/jekyll/page.rb
Jekyll.Page.render
def render(layouts, site_payload) site_payload["page"] = to_liquid site_payload["paginator"] = pager.to_liquid do_layout(site_payload, layouts) end
ruby
def render(layouts, site_payload) site_payload["page"] = to_liquid site_payload["paginator"] = pager.to_liquid do_layout(site_payload, layouts) end
[ "def", "render", "(", "layouts", ",", "site_payload", ")", "site_payload", "[", "\"page\"", "]", "=", "to_liquid", "site_payload", "[", "\"paginator\"", "]", "=", "pager", ".", "to_liquid", "do_layout", "(", "site_payload", ",", "layouts", ")", "end" ]
Add any necessary layouts to this post layouts - The Hash of {"name" => "layout"}. site_payload - The site payload Hash. Returns String rendered page.
[ "Add", "any", "necessary", "layouts", "to", "this", "post" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/page.rb#L132-L137
10,472
jekyll/jekyll
lib/jekyll/filters.rb
Jekyll.Filters.where_exp
def where_exp(input, variable, expression) return input unless input.respond_to?(:select) input = input.values if input.is_a?(Hash) # FIXME condition = parse_condition(expression) @context.stack do input.select do |object| @context[variable] = object condition.evalu...
ruby
def where_exp(input, variable, expression) return input unless input.respond_to?(:select) input = input.values if input.is_a?(Hash) # FIXME condition = parse_condition(expression) @context.stack do input.select do |object| @context[variable] = object condition.evalu...
[ "def", "where_exp", "(", "input", ",", "variable", ",", "expression", ")", "return", "input", "unless", "input", ".", "respond_to?", "(", ":select", ")", "input", "=", "input", ".", "values", "if", "input", ".", "is_a?", "(", "Hash", ")", "# FIXME", "con...
Filters an array of objects against an expression input - the object array variable - the variable to assign each item to in the expression expression - a Liquid comparison expression passed in as a string Returns the filtered array of objects
[ "Filters", "an", "array", "of", "objects", "against", "an", "expression" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/filters.rb#L199-L211
10,473
jekyll/jekyll
lib/jekyll/filters.rb
Jekyll.Filters.sort
def sort(input, property = nil, nils = "first") raise ArgumentError, "Cannot sort a null object." if input.nil? if property.nil? input.sort else if nils == "first" order = - 1 elsif nils == "last" order = + 1 else raise ArgumentError, "Inv...
ruby
def sort(input, property = nil, nils = "first") raise ArgumentError, "Cannot sort a null object." if input.nil? if property.nil? input.sort else if nils == "first" order = - 1 elsif nils == "last" order = + 1 else raise ArgumentError, "Inv...
[ "def", "sort", "(", "input", ",", "property", "=", "nil", ",", "nils", "=", "\"first\"", ")", "raise", "ArgumentError", ",", "\"Cannot sort a null object.\"", "if", "input", ".", "nil?", "if", "property", ".", "nil?", "input", ".", "sort", "else", "if", "n...
Sort an array of objects input - the object array property - property within each object to filter by nils ('first' | 'last') - nils appear before or after non-nil values Returns the filtered array of objects
[ "Sort", "an", "array", "of", "objects" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/filters.rb#L232-L249
10,474
jekyll/jekyll
lib/jekyll/filters.rb
Jekyll.Filters.sort_input
def sort_input(input, property, order) input.map { |item| [item_property(item, property), item] } .sort! do |a_info, b_info| a_property = a_info.first b_property = b_info.first if !a_property.nil? && b_property.nil? - order elsif a_property.nil? && !b_p...
ruby
def sort_input(input, property, order) input.map { |item| [item_property(item, property), item] } .sort! do |a_info, b_info| a_property = a_info.first b_property = b_info.first if !a_property.nil? && b_property.nil? - order elsif a_property.nil? && !b_p...
[ "def", "sort_input", "(", "input", ",", "property", ",", "order", ")", "input", ".", "map", "{", "|", "item", "|", "[", "item_property", "(", "item", ",", "property", ")", ",", "item", "]", "}", ".", "sort!", "do", "|", "a_info", ",", "b_info", "|"...
Sort the input Enumerable by the given property. If the property doesn't exist, return the sort order respective of which item doesn't have the property. We also utilize the Schwartzian transform to make this more efficient.
[ "Sort", "the", "input", "Enumerable", "by", "the", "given", "property", ".", "If", "the", "property", "doesn", "t", "exist", "return", "the", "sort", "order", "respective", "of", "which", "item", "doesn", "t", "have", "the", "property", ".", "We", "also", ...
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/filters.rb#L311-L326
10,475
jekyll/jekyll
lib/jekyll/filters.rb
Jekyll.Filters.compare_property_vs_target
def compare_property_vs_target(property, target) case target when NilClass return true if property.nil? when Liquid::Expression::MethodLiteral # `empty` or `blank` return true if Array(property).join == target.to_s else Array(property).each do |prop| return true...
ruby
def compare_property_vs_target(property, target) case target when NilClass return true if property.nil? when Liquid::Expression::MethodLiteral # `empty` or `blank` return true if Array(property).join == target.to_s else Array(property).each do |prop| return true...
[ "def", "compare_property_vs_target", "(", "property", ",", "target", ")", "case", "target", "when", "NilClass", "return", "true", "if", "property", ".", "nil?", "when", "Liquid", "::", "Expression", "::", "MethodLiteral", "# `empty` or `blank`", "return", "true", ...
`where` filter helper
[ "where", "filter", "helper" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/filters.rb#L329-L342
10,476
jekyll/jekyll
lib/jekyll/collection.rb
Jekyll.Collection.entries
def entries return [] unless exists? @entries ||= Utils.safe_glob(collection_dir, ["**", "*"], File::FNM_DOTMATCH).map do |entry| entry["#{collection_dir}/"] = "" entry end end
ruby
def entries return [] unless exists? @entries ||= Utils.safe_glob(collection_dir, ["**", "*"], File::FNM_DOTMATCH).map do |entry| entry["#{collection_dir}/"] = "" entry end end
[ "def", "entries", "return", "[", "]", "unless", "exists?", "@entries", "||=", "Utils", ".", "safe_glob", "(", "collection_dir", ",", "[", "\"**\"", ",", "\"*\"", "]", ",", "File", "::", "FNM_DOTMATCH", ")", ".", "map", "do", "|", "entry", "|", "entry", ...
All the entries in this collection. Returns an Array of file paths to the documents in this collection relative to the collection's directory
[ "All", "the", "entries", "in", "this", "collection", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/collection.rb#L75-L83
10,477
jekyll/jekyll
lib/jekyll/collection.rb
Jekyll.Collection.collection_dir
def collection_dir(*files) return directory if files.empty? site.in_source_dir(container, relative_directory, *files) end
ruby
def collection_dir(*files) return directory if files.empty? site.in_source_dir(container, relative_directory, *files) end
[ "def", "collection_dir", "(", "*", "files", ")", "return", "directory", "if", "files", ".", "empty?", "site", ".", "in_source_dir", "(", "container", ",", "relative_directory", ",", "files", ")", "end" ]
The full path to the directory containing the collection, with optional subpaths. *files - (optional) any other path pieces relative to the directory to append to the path Returns a String containing th directory name where the collection is stored on the filesystem.
[ "The", "full", "path", "to", "the", "directory", "containing", "the", "collection", "with", "optional", "subpaths", "." ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/collection.rb#L128-L132
10,478
jekyll/jekyll
lib/jekyll/regenerator.rb
Jekyll.Regenerator.add
def add(path) return true unless File.exist?(path) metadata[path] = { "mtime" => File.mtime(path), "deps" => [], } cache[path] = true end
ruby
def add(path) return true unless File.exist?(path) metadata[path] = { "mtime" => File.mtime(path), "deps" => [], } cache[path] = true end
[ "def", "add", "(", "path", ")", "return", "true", "unless", "File", ".", "exist?", "(", "path", ")", "metadata", "[", "path", "]", "=", "{", "\"mtime\"", "=>", "File", ".", "mtime", "(", "path", ")", ",", "\"deps\"", "=>", "[", "]", ",", "}", "ca...
Add a path to the metadata Returns true, also on failure.
[ "Add", "a", "path", "to", "the", "metadata" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/regenerator.rb#L40-L48
10,479
jekyll/jekyll
lib/jekyll/regenerator.rb
Jekyll.Regenerator.add_dependency
def add_dependency(path, dependency) return if metadata[path].nil? || disabled unless metadata[path]["deps"].include? dependency metadata[path]["deps"] << dependency add(dependency) unless metadata.include?(dependency) end regenerate? dependency end
ruby
def add_dependency(path, dependency) return if metadata[path].nil? || disabled unless metadata[path]["deps"].include? dependency metadata[path]["deps"] << dependency add(dependency) unless metadata.include?(dependency) end regenerate? dependency end
[ "def", "add_dependency", "(", "path", ",", "dependency", ")", "return", "if", "metadata", "[", "path", "]", ".", "nil?", "||", "disabled", "unless", "metadata", "[", "path", "]", "[", "\"deps\"", "]", ".", "include?", "dependency", "metadata", "[", "path",...
Add a dependency of a path Returns nothing.
[ "Add", "a", "dependency", "of", "a", "path" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/regenerator.rb#L106-L114
10,480
jekyll/jekyll
lib/jekyll/regenerator.rb
Jekyll.Regenerator.write_metadata
def write_metadata unless disabled? Jekyll.logger.debug "Writing Metadata:", ".jekyll-metadata" File.binwrite(metadata_file, Marshal.dump(metadata)) end end
ruby
def write_metadata unless disabled? Jekyll.logger.debug "Writing Metadata:", ".jekyll-metadata" File.binwrite(metadata_file, Marshal.dump(metadata)) end end
[ "def", "write_metadata", "unless", "disabled?", "Jekyll", ".", "logger", ".", "debug", "\"Writing Metadata:\"", ",", "\".jekyll-metadata\"", "File", ".", "binwrite", "(", "metadata_file", ",", "Marshal", ".", "dump", "(", "metadata", ")", ")", "end", "end" ]
Write the metadata to disk Returns nothing.
[ "Write", "the", "metadata", "to", "disk" ]
fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b
https://github.com/jekyll/jekyll/blob/fd74fe3e93a1fb506fa6621a2e271d7b9c5c3e3b/lib/jekyll/regenerator.rb#L119-L124
10,481
fastlane/fastlane
frameit/lib/frameit/config_parser.rb
Frameit.ConfigParser.fetch_value
def fetch_value(path) specifics = @data['data'].select { |a| path.include?(a['filter']) } default = @data['default'] values = default.clone specifics.each do |specific| values = values.fastlane_deep_merge(specific) end change_paths_to_absolutes!(values) validate_valu...
ruby
def fetch_value(path) specifics = @data['data'].select { |a| path.include?(a['filter']) } default = @data['default'] values = default.clone specifics.each do |specific| values = values.fastlane_deep_merge(specific) end change_paths_to_absolutes!(values) validate_valu...
[ "def", "fetch_value", "(", "path", ")", "specifics", "=", "@data", "[", "'data'", "]", ".", "select", "{", "|", "a", "|", "path", ".", "include?", "(", "a", "[", "'filter'", "]", ")", "}", "default", "=", "@data", "[", "'default'", "]", "values", "...
Fetches the finished configuration for a given path. This will try to look for a specific value and fallback to a default value if nothing was found
[ "Fetches", "the", "finished", "configuration", "for", "a", "given", "path", ".", "This", "will", "try", "to", "look", "for", "a", "specific", "value", "and", "fallback", "to", "a", "default", "value", "if", "nothing", "was", "found" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/config_parser.rb#L28-L42
10,482
fastlane/fastlane
frameit/lib/frameit/config_parser.rb
Frameit.ConfigParser.change_paths_to_absolutes!
def change_paths_to_absolutes!(values) values.each do |key, value| if value.kind_of?(Hash) change_paths_to_absolutes!(value) # recursive call elsif value.kind_of?(Array) value.each do |current| change_paths_to_absolutes!(current) if current.kind_of?(Hash) # recursiv...
ruby
def change_paths_to_absolutes!(values) values.each do |key, value| if value.kind_of?(Hash) change_paths_to_absolutes!(value) # recursive call elsif value.kind_of?(Array) value.each do |current| change_paths_to_absolutes!(current) if current.kind_of?(Hash) # recursiv...
[ "def", "change_paths_to_absolutes!", "(", "values", ")", "values", ".", "each", "do", "|", "key", ",", "value", "|", "if", "value", ".", "kind_of?", "(", "Hash", ")", "change_paths_to_absolutes!", "(", "value", ")", "# recursive call", "elsif", "value", ".", ...
Use absolute paths instead of relative
[ "Use", "absolute", "paths", "instead", "of", "relative" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/config_parser.rb#L45-L64
10,483
fastlane/fastlane
spaceship/lib/spaceship/portal/portal_client.rb
Spaceship.PortalClient.provisioning_profiles_via_xcode_api
def provisioning_profiles_via_xcode_api(mac: false) req = request(:post) do |r| r.url("https://developerservices2.apple.com/services/#{PROTOCOL_VERSION}/#{platform_slug(mac)}/listProvisioningProfiles.action") r.params = { teamId: team_id, includeInactiveProfiles: true, ...
ruby
def provisioning_profiles_via_xcode_api(mac: false) req = request(:post) do |r| r.url("https://developerservices2.apple.com/services/#{PROTOCOL_VERSION}/#{platform_slug(mac)}/listProvisioningProfiles.action") r.params = { teamId: team_id, includeInactiveProfiles: true, ...
[ "def", "provisioning_profiles_via_xcode_api", "(", "mac", ":", "false", ")", "req", "=", "request", "(", ":post", ")", "do", "|", "r", "|", "r", ".", "url", "(", "\"https://developerservices2.apple.com/services/#{PROTOCOL_VERSION}/#{platform_slug(mac)}/listProvisioningProfi...
this endpoint is used by Xcode to fetch provisioning profiles. The response is an xml plist but has the added benefit of containing the appId of each provisioning profile. Use this method over `provisioning_profiles` if possible because no secondary API calls are necessary to populate the ProvisioningProfile data mo...
[ "this", "endpoint", "is", "used", "by", "Xcode", "to", "fetch", "provisioning", "profiles", ".", "The", "response", "is", "an", "xml", "plist", "but", "has", "the", "added", "benefit", "of", "containing", "the", "appId", "of", "each", "provisioning", "profil...
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/spaceship/lib/spaceship/portal/portal_client.rb#L645-L660
10,484
fastlane/fastlane
spaceship/lib/spaceship/portal/portal_client.rb
Spaceship.PortalClient.ensure_csrf
def ensure_csrf(klass) if csrf_cache[klass] self.csrf_tokens = csrf_cache[klass] return end self.csrf_tokens = nil # If we directly create a new resource (e.g. app) without querying anything before # we don't have a valid csrf token, that's why we have to do at least one ...
ruby
def ensure_csrf(klass) if csrf_cache[klass] self.csrf_tokens = csrf_cache[klass] return end self.csrf_tokens = nil # If we directly create a new resource (e.g. app) without querying anything before # we don't have a valid csrf token, that's why we have to do at least one ...
[ "def", "ensure_csrf", "(", "klass", ")", "if", "csrf_cache", "[", "klass", "]", "self", ".", "csrf_tokens", "=", "csrf_cache", "[", "klass", "]", "return", "end", "self", ".", "csrf_tokens", "=", "nil", "# If we directly create a new resource (e.g. app) without quer...
Ensures that there are csrf tokens for the appropriate entity type Relies on store_csrf_tokens to set csrf_tokens to the appropriate value then stores that in the correct place in cache This method also takes a block, if you want to send a custom request, instead of calling `.all` on the given klass. This is used f...
[ "Ensures", "that", "there", "are", "csrf", "tokens", "for", "the", "appropriate", "entity", "type", "Relies", "on", "store_csrf_tokens", "to", "set", "csrf_tokens", "to", "the", "appropriate", "value", "then", "stores", "that", "in", "the", "correct", "place", ...
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/spaceship/lib/spaceship/portal/portal_client.rb#L802-L815
10,485
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.put_into_frame
def put_into_frame # We have to rotate the screenshot, since the offset information is for portrait # only. Instead of doing the calculations ourselves, it's much easier to let # imagemagick do the hard lifting for landscape screenshots rotation = self.rotation_for_device_orientation frame...
ruby
def put_into_frame # We have to rotate the screenshot, since the offset information is for portrait # only. Instead of doing the calculations ourselves, it's much easier to let # imagemagick do the hard lifting for landscape screenshots rotation = self.rotation_for_device_orientation frame...
[ "def", "put_into_frame", "# We have to rotate the screenshot, since the offset information is for portrait", "# only. Instead of doing the calculations ourselves, it's much easier to let", "# imagemagick do the hard lifting for landscape screenshots", "rotation", "=", "self", ".", "rotation_for_de...
puts the screenshot into the frame
[ "puts", "the", "screenshot", "into", "the", "frame" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L83-L119
10,486
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.modify_offset
def modify_offset(multiplicator) # Format: "+133+50" hash = offset['offset'] x = hash.split("+")[1].to_f * multiplicator y = hash.split("+")[2].to_f * multiplicator new_offset = "+#{x.round}+#{y.round}" @offset_information['offset'] = new_offset end
ruby
def modify_offset(multiplicator) # Format: "+133+50" hash = offset['offset'] x = hash.split("+")[1].to_f * multiplicator y = hash.split("+")[2].to_f * multiplicator new_offset = "+#{x.round}+#{y.round}" @offset_information['offset'] = new_offset end
[ "def", "modify_offset", "(", "multiplicator", ")", "# Format: \"+133+50\"", "hash", "=", "offset", "[", "'offset'", "]", "x", "=", "hash", ".", "split", "(", "\"+\"", ")", "[", "1", "]", ".", "to_f", "*", "multiplicator", "y", "=", "hash", ".", "split", ...
Everything below is related to title, background, etc. and is not used in the easy mode this is used to correct the 1:1 offset information the offset information is stored to work for the template images since we resize the template images to have higher quality screenshots we need to modify the offset information...
[ "Everything", "below", "is", "related", "to", "title", "background", "etc", ".", "and", "is", "not", "used", "in", "the", "easy", "mode" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L140-L147
10,487
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.horizontal_frame_padding
def horizontal_frame_padding padding = fetch_config['padding'] if padding.kind_of?(String) && padding.split('x').length == 2 padding = padding.split('x')[0] padding = padding.to_i unless padding.end_with?('%') end return scale_padding(padding) end
ruby
def horizontal_frame_padding padding = fetch_config['padding'] if padding.kind_of?(String) && padding.split('x').length == 2 padding = padding.split('x')[0] padding = padding.to_i unless padding.end_with?('%') end return scale_padding(padding) end
[ "def", "horizontal_frame_padding", "padding", "=", "fetch_config", "[", "'padding'", "]", "if", "padding", ".", "kind_of?", "(", "String", ")", "&&", "padding", ".", "split", "(", "'x'", ")", ".", "length", "==", "2", "padding", "=", "padding", ".", "split...
Horizontal adding around the frames
[ "Horizontal", "adding", "around", "the", "frames" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L193-L200
10,488
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.title_min_height
def title_min_height @title_min_height ||= begin height = fetch_config['title_min_height'] || 0 if height.kind_of?(String) && height.end_with?('%') height = ([image.width, image.height].min * height.to_f * 0.01).ceil end height end end
ruby
def title_min_height @title_min_height ||= begin height = fetch_config['title_min_height'] || 0 if height.kind_of?(String) && height.end_with?('%') height = ([image.width, image.height].min * height.to_f * 0.01).ceil end height end end
[ "def", "title_min_height", "@title_min_height", "||=", "begin", "height", "=", "fetch_config", "[", "'title_min_height'", "]", "||", "0", "if", "height", ".", "kind_of?", "(", "String", ")", "&&", "height", ".", "end_with?", "(", "'%'", ")", "height", "=", "...
Minimum height for the title
[ "Minimum", "height", "for", "the", "title" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L213-L221
10,489
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.generate_background
def generate_background background = MiniMagick::Image.open(fetch_config['background']) if background.height != screenshot.size[1] background.resize("#{screenshot.size[0]}x#{screenshot.size[1]}^") # `^` says it should fill area background.merge!(["-gravity", "center", "-crop", "#{screenshot...
ruby
def generate_background background = MiniMagick::Image.open(fetch_config['background']) if background.height != screenshot.size[1] background.resize("#{screenshot.size[0]}x#{screenshot.size[1]}^") # `^` says it should fill area background.merge!(["-gravity", "center", "-crop", "#{screenshot...
[ "def", "generate_background", "background", "=", "MiniMagick", "::", "Image", ".", "open", "(", "fetch_config", "[", "'background'", "]", ")", "if", "background", ".", "height", "!=", "screenshot", ".", "size", "[", "1", "]", "background", ".", "resize", "("...
Returns a correctly sized background image
[ "Returns", "a", "correctly", "sized", "background", "image" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L251-L259
10,490
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.resize_frame!
def resize_frame! screenshot_width = self.screenshot.portrait? ? screenshot.size[0] : screenshot.size[1] multiplicator = (screenshot_width.to_f / offset['width'].to_f) # by how much do we have to change this? new_frame_width = multiplicator * frame.width # the new width for the frame frame.resi...
ruby
def resize_frame! screenshot_width = self.screenshot.portrait? ? screenshot.size[0] : screenshot.size[1] multiplicator = (screenshot_width.to_f / offset['width'].to_f) # by how much do we have to change this? new_frame_width = multiplicator * frame.width # the new width for the frame frame.resi...
[ "def", "resize_frame!", "screenshot_width", "=", "self", ".", "screenshot", ".", "portrait?", "?", "screenshot", ".", "size", "[", "0", "]", ":", "screenshot", ".", "size", "[", "1", "]", "multiplicator", "=", "(", "screenshot_width", ".", "to_f", "/", "of...
Resize the frame as it's too low quality by default
[ "Resize", "the", "frame", "as", "it", "s", "too", "low", "quality", "by", "default" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L273-L280
10,491
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.put_title_into_background_stacked
def put_title_into_background_stacked(background, title, keyword) resize_text(title) resize_text(keyword) vertical_padding = vertical_frame_padding # assign padding to variable spacing_between_title_and_keyword = (actual_font_size / 2) title_left_space = (background.width / 2.0 - title.wi...
ruby
def put_title_into_background_stacked(background, title, keyword) resize_text(title) resize_text(keyword) vertical_padding = vertical_frame_padding # assign padding to variable spacing_between_title_and_keyword = (actual_font_size / 2) title_left_space = (background.width / 2.0 - title.wi...
[ "def", "put_title_into_background_stacked", "(", "background", ",", "title", ",", "keyword", ")", "resize_text", "(", "title", ")", "resize_text", "(", "keyword", ")", "vertical_padding", "=", "vertical_frame_padding", "# assign padding to variable", "spacing_between_title_...
Add the title above or below the device
[ "Add", "the", "title", "above", "or", "below", "the", "device" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L292-L321
10,492
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.build_text_images
def build_text_images(max_width, max_height, stack_title) words = [:keyword, :title].keep_if { |a| fetch_text(a) } # optional keyword/title results = {} trim_boxes = {} top_vertical_trim_offset = Float::INFINITY # Init at a large value, as the code will search for a minimal value. bottom_v...
ruby
def build_text_images(max_width, max_height, stack_title) words = [:keyword, :title].keep_if { |a| fetch_text(a) } # optional keyword/title results = {} trim_boxes = {} top_vertical_trim_offset = Float::INFINITY # Init at a large value, as the code will search for a minimal value. bottom_v...
[ "def", "build_text_images", "(", "max_width", ",", "max_height", ",", "stack_title", ")", "words", "=", "[", ":keyword", ",", ":title", "]", ".", "keep_if", "{", "|", "a", "|", "fetch_text", "(", "a", ")", "}", "# optional keyword/title", "results", "=", "...
This will build up to 2 individual images with the title and optional keyword, which will then be added to the real image
[ "This", "will", "build", "up", "to", "2", "individual", "images", "with", "the", "title", "and", "optional", "keyword", "which", "will", "then", "be", "added", "to", "the", "real", "image" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L396-L489
10,493
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.fetch_text
def fetch_text(type) UI.user_error!("Valid parameters :keyword, :title") unless [:keyword, :title].include?(type) # Try to get it from a keyword.strings or title.strings file strings_path = File.join(File.expand_path("..", screenshot.path), "#{type}.strings") if File.exist?(strings_path) ...
ruby
def fetch_text(type) UI.user_error!("Valid parameters :keyword, :title") unless [:keyword, :title].include?(type) # Try to get it from a keyword.strings or title.strings file strings_path = File.join(File.expand_path("..", screenshot.path), "#{type}.strings") if File.exist?(strings_path) ...
[ "def", "fetch_text", "(", "type", ")", "UI", ".", "user_error!", "(", "\"Valid parameters :keyword, :title\"", ")", "unless", "[", ":keyword", ",", ":title", "]", ".", "include?", "(", "type", ")", "# Try to get it from a keyword.strings or title.strings file", "strings...
Fetches the title + keyword for this particular screenshot
[ "Fetches", "the", "title", "+", "keyword", "for", "this", "particular", "screenshot" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L504-L520
10,494
fastlane/fastlane
frameit/lib/frameit/editor.rb
Frameit.Editor.font
def font(key) single_font = fetch_config[key.to_s]['font'] return single_font if single_font fonts = fetch_config[key.to_s]['fonts'] if fonts fonts.each do |font| if font['supported'] font['supported'].each do |language| if screenshot.path.include?(la...
ruby
def font(key) single_font = fetch_config[key.to_s]['font'] return single_font if single_font fonts = fetch_config[key.to_s]['fonts'] if fonts fonts.each do |font| if font['supported'] font['supported'].each do |language| if screenshot.path.include?(la...
[ "def", "font", "(", "key", ")", "single_font", "=", "fetch_config", "[", "key", ".", "to_s", "]", "[", "'font'", "]", "return", "single_font", "if", "single_font", "fonts", "=", "fetch_config", "[", "key", ".", "to_s", "]", "[", "'fonts'", "]", "if", "...
The font we want to use
[ "The", "font", "we", "want", "to", "use" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/frameit/lib/frameit/editor.rb#L538-L561
10,495
fastlane/fastlane
pilot/lib/pilot/build_manager.rb
Pilot.BuildManager.transporter_for_selected_team
def transporter_for_selected_team(options) generic_transporter = FastlaneCore::ItunesTransporter.new(options[:username], nil, false, options[:itc_provider]) return generic_transporter unless options[:itc_provider].nil? && Spaceship::Tunes.client.teams.count > 1 begin team = Spaceship::Tunes.c...
ruby
def transporter_for_selected_team(options) generic_transporter = FastlaneCore::ItunesTransporter.new(options[:username], nil, false, options[:itc_provider]) return generic_transporter unless options[:itc_provider].nil? && Spaceship::Tunes.client.teams.count > 1 begin team = Spaceship::Tunes.c...
[ "def", "transporter_for_selected_team", "(", "options", ")", "generic_transporter", "=", "FastlaneCore", "::", "ItunesTransporter", ".", "new", "(", "options", "[", ":username", "]", ",", "nil", ",", "false", ",", "options", "[", ":itc_provider", "]", ")", "retu...
If itc_provider was explicitly specified, use it. If there are multiple teams, infer the provider from the selected team name. If there are fewer than two teams, don't infer the provider.
[ "If", "itc_provider", "was", "explicitly", "specified", "use", "it", ".", "If", "there", "are", "multiple", "teams", "infer", "the", "provider", "from", "the", "selected", "team", "name", ".", "If", "there", "are", "fewer", "than", "two", "teams", "don", "...
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/pilot/lib/pilot/build_manager.rb#L221-L235
10,496
fastlane/fastlane
spaceship/lib/spaceship/two_step_or_factor_client.rb
Spaceship.Client.update_request_headers
def update_request_headers(req) req.headers["X-Apple-Id-Session-Id"] = @x_apple_id_session_id req.headers["X-Apple-Widget-Key"] = self.itc_service_key req.headers["Accept"] = "application/json" req.headers["scnt"] = @scnt end
ruby
def update_request_headers(req) req.headers["X-Apple-Id-Session-Id"] = @x_apple_id_session_id req.headers["X-Apple-Widget-Key"] = self.itc_service_key req.headers["Accept"] = "application/json" req.headers["scnt"] = @scnt end
[ "def", "update_request_headers", "(", "req", ")", "req", ".", "headers", "[", "\"X-Apple-Id-Session-Id\"", "]", "=", "@x_apple_id_session_id", "req", ".", "headers", "[", "\"X-Apple-Widget-Key\"", "]", "=", "self", ".", "itc_service_key", "req", ".", "headers", "[...
Responsible for setting all required header attributes for the requests to succeed
[ "Responsible", "for", "setting", "all", "required", "header", "attributes", "for", "the", "requests", "to", "succeed" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/spaceship/lib/spaceship/two_step_or_factor_client.rb#L301-L306
10,497
fastlane/fastlane
fastlane_core/lib/fastlane_core/itunes_transporter.rb
FastlaneCore.ItunesTransporter.upload
def upload(app_id, dir) actual_dir = File.join(dir, "#{app_id}.itmsp") UI.message("Going to upload updated app to App Store Connect") UI.success("This might take a few minutes. Please don't interrupt the script.") command = @transporter_executor.build_upload_command(@user, @password, actual_di...
ruby
def upload(app_id, dir) actual_dir = File.join(dir, "#{app_id}.itmsp") UI.message("Going to upload updated app to App Store Connect") UI.success("This might take a few minutes. Please don't interrupt the script.") command = @transporter_executor.build_upload_command(@user, @password, actual_di...
[ "def", "upload", "(", "app_id", ",", "dir", ")", "actual_dir", "=", "File", ".", "join", "(", "dir", ",", "\"#{app_id}.itmsp\"", ")", "UI", ".", "message", "(", "\"Going to upload updated app to App Store Connect\"", ")", "UI", ".", "success", "(", "\"This might...
Uploads the modified package back to App Store Connect @param app_id [Integer] The unique App ID @param dir [String] the path in which the package file is located @return (Bool) True if everything worked fine @raise [Deliver::TransporterTransferError] when something went wrong when transferring
[ "Uploads", "the", "modified", "package", "back", "to", "App", "Store", "Connect" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/fastlane_core/lib/fastlane_core/itunes_transporter.rb#L410-L435
10,498
fastlane/fastlane
fastlane_core/lib/fastlane_core/itunes_transporter.rb
FastlaneCore.ItunesTransporter.load_password_for_transporter
def load_password_for_transporter # 3 different sources for the password # 1) ENV variable for application specific password if ENV[TWO_FACTOR_ENV_VARIABLE].to_s.length > 0 UI.message("Fetching password for transporter from environment variable named `#{TWO_FACTOR_ENV_VARIABLE}`") re...
ruby
def load_password_for_transporter # 3 different sources for the password # 1) ENV variable for application specific password if ENV[TWO_FACTOR_ENV_VARIABLE].to_s.length > 0 UI.message("Fetching password for transporter from environment variable named `#{TWO_FACTOR_ENV_VARIABLE}`") re...
[ "def", "load_password_for_transporter", "# 3 different sources for the password", "# 1) ENV variable for application specific password", "if", "ENV", "[", "TWO_FACTOR_ENV_VARIABLE", "]", ".", "to_s", ".", "length", ">", "0", "UI", ".", "message", "(", "\"Fetching password for...
Returns the password to be used with the transporter
[ "Returns", "the", "password", "to", "be", "used", "with", "the", "transporter" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/fastlane_core/lib/fastlane_core/itunes_transporter.rb#L457-L473
10,499
fastlane/fastlane
fastlane_core/lib/fastlane_core/itunes_transporter.rb
FastlaneCore.ItunesTransporter.handle_two_step_failure
def handle_two_step_failure(ex) if ENV[TWO_FACTOR_ENV_VARIABLE].to_s.length > 0 # Password provided, however we already used it UI.error("") UI.error("Application specific password you provided using") UI.error("environment variable #{TWO_FACTOR_ENV_VARIABLE}") UI.error("is...
ruby
def handle_two_step_failure(ex) if ENV[TWO_FACTOR_ENV_VARIABLE].to_s.length > 0 # Password provided, however we already used it UI.error("") UI.error("Application specific password you provided using") UI.error("environment variable #{TWO_FACTOR_ENV_VARIABLE}") UI.error("is...
[ "def", "handle_two_step_failure", "(", "ex", ")", "if", "ENV", "[", "TWO_FACTOR_ENV_VARIABLE", "]", ".", "to_s", ".", "length", ">", "0", "# Password provided, however we already used it", "UI", ".", "error", "(", "\"\"", ")", "UI", ".", "error", "(", "\"Applica...
Tells the user how to get an application specific password
[ "Tells", "the", "user", "how", "to", "get", "an", "application", "specific", "password" ]
457c5d647c77f0e078dafa5129da616914e002c5
https://github.com/fastlane/fastlane/blob/457c5d647c77f0e078dafa5129da616914e002c5/fastlane_core/lib/fastlane_core/itunes_transporter.rb#L476-L508