jekyll 4.0.1 → 4.2.1

data/lib/jekyll/drops/drop.rb

@@ -1,215 +1,293 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Drops
-    class Drop < Liquid::Drop
-      include Enumerable
-
-      NON_CONTENT_METHODS = [:fallback_data, :collapse_document].freeze
-
-      # 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
-      def self.mutable(is_mutable = nil)
-        @is_mutable = is_mutable || false
-      end
-
-      def self.mutable?
-        @is_mutable
-      end
-
-      # Create a new Drop
-      #
-      # obj - the Jekyll Site, Collection, or Document required by the
-      # drop.
-      #
-      # Returns nothing
-      def initialize(obj)
-        @obj = obj
-      end
-
-      # 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
-      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
-      alias_method :invoke_drop, :[]
-
-      # 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.
-      def []=(key, val)
-        setter = "#{key}="
-        if respond_to?(setter)
-          public_send(setter, 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.
-      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
-
-      # Check if key exists in Drop
-      #
-      # key - the string key whose value to fetch
-      #
-      # Returns true if the given key is present
-      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.
-      def keys
-        (content_methods |
-          mutations.keys |
-          fallback_data.keys).flatten
-      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 Drop#keys for more.
-      #
-      # Returns a Hash with all the keys and values resolved.
-      def to_h
-        keys.each_with_object({}) do |(key, _), result|
-          result[key] = self[key]
-        end
-      end
-      alias_method :to_hash, :to_h
-
-      # 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.
-      def inspect
-        JSON.pretty_generate to_h
-      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.
-      def hash_for_json(*)
-        to_h
-      end
-
-      # Generate a JSON representation of the Drop.
-      #
-      # state - the JSON::State object which determines the state of current processing.
-      #
-      # Returns a JSON representation of the Drop in a String.
-      def to_json(state = nil)
-        JSON.generate(hash_for_json(state), state)
-      end
-
-      # Collects all the keys and passes each to the block in turn.
-      #
-      # block - a block which accepts one argument, the key
-      #
-      # Returns nothing.
-      def each_key(&block)
-        keys.each(&block)
-      end
-
-      def each
-        each_key.each do |key|
-          yield key, self[key]
-        end
-      end
-
-      def merge(other, &block)
-        dup.tap do |me|
-          if block.nil?
-            me.merge!(other)
-          else
-            me.merge!(other, block)
-          end
-        end
-      end
-
-      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
-
-      # 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
-      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
-
-      private
-
-      def mutations
-        @mutations ||= {}
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module Drops
+    class Drop < Liquid::Drop
+      include Enumerable
+
+      NON_CONTENT_METHODS = [:fallback_data, :collapse_document].freeze
+      NON_CONTENT_METHOD_NAMES = NON_CONTENT_METHODS.map(&:to_s).freeze
+      private_constant :NON_CONTENT_METHOD_NAMES
+
+      # A private stash to avoid repeatedly generating the setter method name string for
+      # a call to `Drops::Drop#[]=`.
+      # The keys of the stash below have a very high probability of being called upon during
+      # the course of various `Jekyll::Renderer#run` calls.
+      SETTER_KEYS_STASH = {
+        "content"            => "content=",
+        "layout"             => "layout=",
+        "page"               => "page=",
+        "paginator"          => "paginator=",
+        "highlighter_prefix" => "highlighter_prefix=",
+        "highlighter_suffix" => "highlighter_suffix=",
+      }.freeze
+      private_constant :SETTER_KEYS_STASH
+
+      class << self
+        # 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
+        def mutable(is_mutable = nil)
+          @is_mutable = is_mutable || false
+        end
+
+        def mutable?
+          @is_mutable
+        end
+
+        # public delegation helper methods that calls onto Drop's instance
+        # variable `@obj`.
+
+        # Generate private Drop instance_methods for each symbol in the given list.
+        #
+        # Returns nothing.
+        def private_delegate_methods(*symbols)
+          symbols.each { |symbol| private delegate_method(symbol) }
+          nil
+        end
+
+        # Generate public Drop instance_methods for each symbol in the given list.
+        #
+        # Returns nothing.
+        def delegate_methods(*symbols)
+          symbols.each { |symbol| delegate_method(symbol) }
+          nil
+        end
+
+        # Generate public Drop instance_method for given symbol that calls `@obj.<sym>`.
+        #
+        # Returns delegated method symbol.
+        def delegate_method(symbol)
+          define_method(symbol) { @obj.send(symbol) }
+        end
+
+        # Generate public Drop instance_method named `delegate` that calls `@obj.<original>`.
+        #
+        # Returns delegated method symbol.
+        def delegate_method_as(original, delegate)
+          define_method(delegate) { @obj.send(original) }
+        end
+
+        # Generate public Drop instance_methods for each string entry in the given list.
+        # The generated method(s) access(es) `@obj`'s data hash.
+        #
+        # Returns nothing.
+        def data_delegators(*strings)
+          strings.each do |key|
+            data_delegator(key) if key.is_a?(String)
+          end
+          nil
+        end
+
+        # Generate public Drop instance_methods for given string `key`.
+        # The generated method access(es) `@obj`'s data hash.
+        #
+        # Returns method symbol.
+        def data_delegator(key)
+          define_method(key.to_sym) { @obj.data[key] }
+        end
+
+        # Array of stringified instance methods that do not end with the assignment operator.
+        #
+        # (<klass>.instance_methods always generates a new Array object so it can be mutated)
+        #
+        # Returns array of strings.
+        def getter_method_names
+          @getter_method_names ||= instance_methods.map!(&:to_s).tap do |list|
+            list.reject! { |item| item.end_with?("=") }
+          end
+        end
+      end
+
+      # Create a new Drop
+      #
+      # obj - the Jekyll Site, Collection, or Document required by the
+      # drop.
+      #
+      # Returns nothing
+      def initialize(obj)
+        @obj = obj
+      end
+
+      # 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
+      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
+      alias_method :invoke_drop, :[]
+
+      # 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.
+      def []=(key, val)
+        setter = SETTER_KEYS_STASH[key] || "#{key}="
+        if respond_to?(setter)
+          public_send(setter, 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.
+      def content_methods
+        @content_methods ||= \
+          self.class.getter_method_names \
+            - Jekyll::Drops::Drop.getter_method_names \
+            - NON_CONTENT_METHOD_NAMES
+      end
+
+      # Check if key exists in Drop
+      #
+      # key - the string key whose value to fetch
+      #
+      # Returns true if the given key is present
+      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.
+      def keys
+        (content_methods |
+          mutations.keys |
+          fallback_data.keys).flatten
+      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 Drop#keys for more.
+      #
+      # Returns a Hash with all the keys and values resolved.
+      def to_h
+        keys.each_with_object({}) do |(key, _), result|
+          result[key] = self[key]
+        end
+      end
+      alias_method :to_hash, :to_h
+
+      # 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.
+      def inspect
+        JSON.pretty_generate to_h
+      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.
+      def hash_for_json(*)
+        to_h
+      end
+
+      # Generate a JSON representation of the Drop.
+      #
+      # state - the JSON::State object which determines the state of current processing.
+      #
+      # Returns a JSON representation of the Drop in a String.
+      def to_json(state = nil)
+        JSON.generate(hash_for_json(state), state)
+      end
+
+      # Collects all the keys and passes each to the block in turn.
+      #
+      # block - a block which accepts one argument, the key
+      #
+      # Returns nothing.
+      def each_key(&block)
+        keys.each(&block)
+      end
+
+      def each
+        each_key.each do |key|
+          yield key, self[key]
+        end
+      end
+
+      def merge(other, &block)
+        dup.tap do |me|
+          if block.nil?
+            me.merge!(other)
+          else
+            me.merge!(other, block)
+          end
+        end
+      end
+
+      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
+
+      # 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
+      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
+
+      private
+
+      def mutations
+        @mutations ||= {}
+      end
+    end
+  end
+end

data/lib/jekyll/drops/excerpt_drop.rb

@@ -1,19 +1,19 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Drops
-    class ExcerptDrop < DocumentDrop
-      def layout
-        @obj.doc.data["layout"]
-      end
-
-      def date
-        @obj.doc.date
-      end
-
-      def excerpt
-        nil
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module Drops
+    class ExcerptDrop < DocumentDrop
+      def layout
+        @obj.doc.data["layout"]
+      end
+
+      def date
+        @obj.doc.date
+      end
+
+      def excerpt
+        nil
+      end
+    end
+  end
+end

data/lib/jekyll/drops/jekyll_drop.rb

@@ -1,32 +1,32 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Drops
-    class JekyllDrop < Liquid::Drop
-      class << self
-        def global
-          @global ||= JekyllDrop.new
-        end
-      end
-
-      def version
-        Jekyll::VERSION
-      end
-
-      def environment
-        Jekyll.env
-      end
-
-      def to_h
-        @to_h ||= {
-          "version"     => version,
-          "environment" => environment,
-        }
-      end
-
-      def to_json(state = nil)
-        JSON.generate(to_h, state)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module Drops
+    class JekyllDrop < Liquid::Drop
+      class << self
+        def global
+          @global ||= JekyllDrop.new
+        end
+      end
+
+      def version
+        Jekyll::VERSION
+      end
+
+      def environment
+        Jekyll.env
+      end
+
+      def to_h
+        @to_h ||= {
+          "version"     => version,
+          "environment" => environment,
+        }
+      end
+
+      def to_json(state = nil)
+        JSON.generate(to_h, state)
+      end
+    end
+  end
+end