class Jekyll::Drops::Drop
Constants
- NON_CONTENT_METHODS
Public Class Methods
Get or set whether the drop class is mutable. Mutability determines whether or not pre-defined fields may be overwritten.
is_mutable - Boolean set mutability of the class (default: nil)
Returns the mutability of the class
# File lib/jekyll/drops/drop.rb, line 17 def self.mutable(is_mutable = nil) @is_mutable = if is_mutable is_mutable else false end end
# File lib/jekyll/drops/drop.rb, line 25 def self.mutable? @is_mutable end
Create a new Drop
obj - the Jekyll Site, Collection, or Document required by the drop.
Returns nothing
# File lib/jekyll/drops/drop.rb, line 35 def initialize(obj) @obj = obj @mutations = {} # only if mutable: true end
Public Instance Methods
Access a method in the Drop or a field in the underlying hash data. If mutable, checks the mutations first. Then checks the methods, and finally check the underlying hash (e.g. document front matter) if all the previous places didn't match.
key - the string key whose value to fetch
Returns the value for the given key, or nil if none exists
# File lib/jekyll/drops/drop.rb, line 48 def [](key) if self.class.mutable? && @mutations.key?(key) @mutations[key] elsif self.class.invokable? key public_send key else fallback_data[key] end end
Set a field in the Drop. If mutable, sets in the mutations and returns. If not mutable, checks first if it's trying to override a Drop method and raises a DropMutationException if so. If not mutable and the key is not a method on the Drop, then it sets the key to the value in the underlying hash (e.g. document front matter)
key - the String key whose value to set val - the Object to set the key's value to
Returns the value the key was set to unless the Drop is not mutable and the key matches a method in which case it raises a DropMutationException.
# File lib/jekyll/drops/drop.rb, line 72 def []=(key, val) if respond_to?("#{key}=") public_send("#{key}=", val) elsif respond_to?(key.to_s) if self.class.mutable? @mutations[key] = val else raise Errors::DropMutationException, "Key #{key} cannot be set in the drop." end else fallback_data[key] = val end end
Generates a list of strings which correspond to content getter methods.
Returns an Array of strings which represent method-specific keys.
# File lib/jekyll/drops/drop.rb, line 90 def content_methods @content_methods ||= ( self.class.instance_methods \ - Jekyll::Drops::Drop.instance_methods \ - NON_CONTENT_METHODS ).map(&:to_s).reject do |method| method.end_with?("=") end end
# File lib/jekyll/drops/drop.rb, line 169 def each each_key.each do |key| yield key, self[key] end end
Collects all the keys and passes each to the block in turn.
block - a block which accepts one argument, the key
Returns nothing.
# File lib/jekyll/drops/drop.rb, line 165 def each_key(&block) keys.each(&block) end
Imitate Hash.fetch method in Drop
Returns value if key is present in Drop, otherwise returns default value KeyError is raised if key is not present and no default value given
# File lib/jekyll/drops/drop.rb, line 204 def fetch(key, default = nil, &block) return self[key] if key?(key) raise KeyError, %(key not found: "#{key}") if default.nil? && block.nil? return yield(key) unless block.nil? return default unless default.nil? end
Generate a Hash for use in generating JSON. This is useful if fields need to be cleared before the JSON can generate.
Returns a Hash ready for JSON generation.
# File lib/jekyll/drops/drop.rb, line 147 def hash_for_json(*) to_h end
Inspect the drop's keys and values through a JSON representation of its keys and values.
Returns a pretty generation of the hash representation of the Drop.
# File lib/jekyll/drops/drop.rb, line 139 def inspect JSON.pretty_generate to_h end
Check if key exists in Drop
key - the string key whose value to fetch
Returns true if the given key is present
# File lib/jekyll/drops/drop.rb, line 105 def key?(key) return false if key.nil? return true if self.class.mutable? && @mutations.key?(key) respond_to?(key) || fallback_data.key?(key) end
Generates a list of keys with user content as their values. This gathers up the Drop methods and keys of the mutations and underlying data hashes and performs a set union to ensure a list of unique keys for the Drop.
Returns an Array of unique keys for content for the Drop.
# File lib/jekyll/drops/drop.rb, line 117 def keys (content_methods | @mutations.keys | fallback_data.keys).flatten end
# File lib/jekyll/drops/drop.rb, line 175 def merge(other, &block) self.dup.tap do |me| if block.nil? me.merge!(other) else me.merge!(other, block) end end end
# File lib/jekyll/drops/drop.rb, line 185 def merge!(other) other.each_key do |key| if block_given? self[key] = yield key, self[key], other[key] else if Utils.mergable?(self[key]) && Utils.mergable?(other[key]) self[key] = Utils.deep_merge_hashes(self[key], other[key]) next end self[key] = other[key] unless other[key].nil? end end end
Generate a Hash representation of the Drop by resolving each key's value. It includes Drop methods, mutations, and the underlying object's data. See the documentation for #keys for more.
Returns a Hash with all the keys and values resolved.
# File lib/jekyll/drops/drop.rb, line 128 def to_h keys.each_with_object({}) do |(key, _), result| result[key] = self[key] end end