class Jekyll::Drops::Drop

Constants

NON_CONTENT_METHODS

Public Class Methods

mutable(is_mutable = nil) click to toggle source

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 14
def self.mutable(is_mutable = nil)
  if is_mutable
    @is_mutable = is_mutable
  else
    @is_mutable = false
  end
end
mutable?() click to toggle source
# File lib/jekyll/drops/drop.rb, line 22
def self.mutable?
  @is_mutable
end
new(obj) click to toggle source

Create a new Drop

obj - the Jekyll Site, Collection, or Document required by the drop.

Returns nothing

# File lib/jekyll/drops/drop.rb, line 32
def initialize(obj)
  @obj = obj
  @mutations = {} # only if mutable: true
end

Public Instance Methods

[](key) click to toggle source

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 45
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
[]=(key, val) click to toggle source

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 68
def []=(key, val)
  if respond_to?("#{key}=")
    public_send("#{key}=", val)
  elsif respond_to? key
    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
content_methods() click to toggle source

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 86
def content_methods
  @content_methods ||= (
    self.class.instance_methods(false) - NON_CONTENT_METHODS
  ).map(&:to_s).reject do |method|
    method.end_with?("=")
  end
end
each_key(&block) click to toggle source

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 145
def each_key(&block)
  keys.each(&block)
end
inspect() click to toggle source

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 135
def inspect
  require 'json'
  JSON.pretty_generate to_h
end
key?(key) click to toggle source

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 99
def key?(key)
  if self.class.mutable && @mutations.key?(key)
    true
  else
    respond_to?(key) || fallback_data.key?(key)
  end
end
keys() click to toggle source

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 113
def keys
  (content_methods |
    @mutations.keys |
    fallback_data.keys).flatten
end
merge(other, &block) click to toggle source
# File lib/jekyll/drops/drop.rb, line 149
def merge(other, &block)
  self.dup.tap do |me|
    if block.nil?
      me.merge!(other)
    else
      me.merge!(other, block)
    end
  end
end
merge!(other) { |key, self, other| ... } click to toggle source
# File lib/jekyll/drops/drop.rb, line 159
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
to_h() click to toggle source

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 124
def to_h
  keys.each_with_object({}) do |(key, _), result|
    result[key] = self[key]
  end
end
Also aliased as: to_hash
to_hash()
Alias for: to_h