jekyll 3.0.5 → 3.1.0.pre.beta1

data/lib/jekyll/document.rb

@@ -12,11 +12,13 @@ module Jekyll
 
     # Create a new Document.
     #
-    # site - the Jekyll::Site instance to which this Document belongs
     # path - the path to the file
+    # relations - a hash with keys :site and :collection, the values of which
+    #             are the Jekyll::Site and Jekyll::Collection to which this
+    #             Document belong.
     #
     # Returns nothing.
-    def initialize(path, relations)
+    def initialize(path, relations = {})
       @site = relations[:site]
       @path = path
       @extname = File.extname(path)
@@ -38,12 +40,10 @@ module Jekyll
     end
 
     def output=(output)
-      @to_liquid = nil
       @output = output
     end
 
     def content=(content)
-      @to_liquid = nil
       @content = content
     end
 
@@ -58,7 +58,7 @@ module Jekyll
     # Merge some data in with this document's data.
     #
     # Returns the merged data.
-    def merge_data!(other, source: "YAML front matter")
+    def merge_data!(other)
       if other.key?('categories') && !other['categories'].nil?
         if other['categories'].is_a?(String)
           other['categories'] = other['categories'].split(" ").map(&:strip)
@@ -67,7 +67,7 @@ module Jekyll
       end
       Utils.deep_merge_hashes!(data, other)
       if data.key?('date') && !data['date'].is_a?(Time)
-        data['date'] = Utils.parse_date(data['date'].to_s, "Document '#{relative_path}' does not have a valid date in the #{source}.")
+         data['date'] = Utils.parse_date(data['date'].to_s, "Document '#{relative_path}' does not have a valid date in the YAML front matter.")
       end
       data
     end
@@ -181,27 +181,7 @@ module Jekyll
     #
     # Returns the Hash of key-value pairs for replacement in the URL.
     def url_placeholders
-      {
-        collection:  collection.label,
-        path:        cleaned_relative_path,
-        output_ext:  output_ext,
-        name:        Utils.slugify(basename_without_ext),
-        title:       Utils.slugify(data['slug'], mode: "pretty", cased: true) || Utils
-                       .slugify(basename_without_ext, mode: "pretty", cased: true),
-        slug:        Utils.slugify(data['slug']) || Utils.slugify(basename_without_ext),
-        year:        date.strftime("%Y"),
-        month:       date.strftime("%m"),
-        day:         date.strftime("%d"),
-        hour:        date.strftime("%H"),
-        minute:      date.strftime("%M"),
-        second:      date.strftime("%S"),
-        i_day:       date.strftime("%-d"),
-        i_month:     date.strftime("%-m"),
-        categories:  (data['categories'] || []).map { |c| c.to_s.downcase }.uniq.join('/'),
-        short_month: date.strftime("%b"),
-        short_year:  date.strftime("%y"),
-        y_day:       date.strftime("%j"),
-      }
+      @url_placeholders ||= Drops::UrlDrop.new(self)
     end
 
     # The permalink for this Document.
@@ -235,11 +215,8 @@ module Jekyll
     def destination(base_directory)
       dest = site.in_dest_dir(base_directory)
       path = site.in_dest_dir(dest, URL.unescape_path(url))
-      if url.end_with? "/"
-        path = File.join(path, "index.html")
-      else
-        path << output_ext unless path.end_with?(output_ext)
-      end
+      path = File.join(path, "index.html") if url.end_with?("/")
+      path << output_ext unless path.end_with?(output_ext)
       path
     end
 
@@ -281,32 +258,27 @@ module Jekyll
     #
     # Returns nothing.
     def read(opts = {})
-      @to_liquid = nil
-
       Jekyll.logger.debug "Reading:", relative_path
 
       if yaml_file?
         @data = SafeYAML.load_file(path)
       else
         begin
-          defaults = @site.frontmatter_defaults.all(relative_path, collection.label.to_sym)
-          merge_data!(defaults, source: "front matter defaults") unless defaults.empty?
+          defaults = @site.frontmatter_defaults.all(url, collection.label.to_sym)
+          merge_data!(defaults) unless defaults.empty?
 
           self.content = File.read(path, merged_file_read_opts(opts))
           if content =~ YAML_FRONT_MATTER_REGEXP
             self.content = $POSTMATCH
             data_file = SafeYAML.load($1)
-            merge_data!(data_file, source: "YAML front matter") if data_file
+            merge_data!(data_file) if data_file
           end
 
           post_read
         rescue SyntaxError => e
-          Jekyll.logger.error "Error:", "YAML Exception reading #{path}: #{e.message}"
+          puts "YAML Exception reading #{path}: #{e.message}"
         rescue Exception => e
-          if e.is_a? Jekyll::Errors::FatalException
-            raise e
-          end
-          Jekyll.logger.error "Error:", "could not read file #{path}: #{e.message}"
+          puts "Error reading file #{path}: #{e.message}"
         end
       end
     end
@@ -317,10 +289,8 @@ module Jekyll
         merge_data!({
           "slug" => slug,
           "ext"  => ext
-        }, source: "filename")
-        if data['date'].nil? || data['date'].to_i == site.time.to_i
-          merge_data!({"date" => date}, source: "filename")
-        end
+        })
+        merge_data!({"date" => date}) if data['date'].nil? || data['date'].to_i == site.time.to_i
         data['title'] ||= slug.split('-').select {|w| w.capitalize! || w }.join(' ')
       end
       populate_categories
@@ -340,7 +310,7 @@ module Jekyll
       superdirs = relative_path.sub(/#{special_dir}(.*)/, '').split(File::SEPARATOR).reject do |c|
         c.empty? || c.eql?(special_dir) || c.eql?(basename)
       end
-      merge_data!({ 'categories' => superdirs }, source: "file path")
+      merge_data!({ 'categories' => superdirs })
     end
 
     def populate_categories
@@ -361,21 +331,7 @@ module Jekyll
     #
     # Returns a Hash representing this Document's data.
     def to_liquid
-      @to_liquid ||= if data.is_a?(Hash)
-        Utils.deep_merge_hashes Utils.deep_merge_hashes({
-          "output"        => output,
-          "content"       => content,
-          "relative_path" => relative_path,
-          "path"          => relative_path,
-          "url"           => url,
-          "collection"    => collection.label,
-          "next"          => next_doc,
-          "previous"      => previous_doc,
-          "id"            => id,
-        }, data), { 'excerpt' => data['excerpt'].to_s }
-      else
-        data
-      end
+      @to_liquid ||= Drops::DocumentDrop.new(self)
     end
 
     # The inspect string for this document.
@@ -399,7 +355,7 @@ module Jekyll
     # Returns -1, 0, +1 or nil depending on whether this doc's path is less than,
     #   equal or greater than the other doc's path. See String#<=> for more details.
     def <=>(other)
-      return nil if !other.respond_to?(:data)
+      return nil unless other.respond_to?(:data)
       cmp = data['date'] <=> other.data['date']
       cmp = path <=> other.path if cmp.nil? || cmp == 0
       cmp

data/lib/jekyll/drops/collection_drop.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+require "jekyll/drops/drop"
+
+module Jekyll
+  module Drops
+    class CollectionDrop < Drop
+      extend Forwardable
+
+      mutable false
+
+      def_delegator :@obj, :write?, :output
+      def_delegators :@obj, :label, :docs, :files, :directory,
+                            :relative_directory
+
+      def to_s
+        docs.to_s
+      end
+
+      private
+      def_delegator :@obj, :metadata, :fallback_data
+
+    end
+  end
+end

data/lib/jekyll/drops/document_drop.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+module Jekyll
+  module Drops
+    class DocumentDrop < Drop
+      extend Forwardable
+
+      mutable false
+
+      def_delegator :@obj, :next_doc, :next
+      def_delegator :@obj, :previous_doc, :previous
+      def_delegator :@obj, :relative_path, :path
+      def_delegators :@obj, :id, :output, :content, :to_s, :relative_path, :url
+
+      def collection
+        @obj.collection.label
+      end
+
+      def excerpt
+        fallback_data['excerpt'].to_s
+      end
+
+      private
+      def_delegator :@obj, :data, :fallback_data
+
+    end
+  end
+end

data/lib/jekyll/drops/drop.rb

@@ -0,0 +1,128 @@
+# encoding: UTF-8
+
+module Jekyll
+  module Drops
+    class Drop < Liquid::Drop
+      NON_CONTENT_METHODS = [:[], :[]=, :inspect, :to_h, :fallback_data].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)
+        if is_mutable
+          @is_mutable = is_mutable
+        end
+        @is_mutable || false
+      end
+
+      # Create a new Drop
+      #
+      # obj - the Jekyll Site, Collection, or Document required by the
+      # drop.
+      #
+      # Returns nothing
+      def initialize(obj)
+        @obj = obj
+        @mutations = {} # only if mutable: true
+      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 respond_to? 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.
+      def []=(key, val)
+        if self.class.mutable
+          @mutations[key] = val
+        elsif respond_to? key
+          raise Errors::DropMutationException, "Key #{key} cannot be set in the drop."
+        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(false) - NON_CONTENT_METHODS
+        ).map(&:to_s).reject do |method|
+          method.end_with?("=")
+        end
+      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, val), result|
+          result[key] = self[key]
+        end
+      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.
+      def inspect
+        JSON.pretty_generate to_h
+      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
+
+    end
+  end
+end

data/lib/jekyll/drops/jekyll_drop.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+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
+    end
+  end
+end

data/lib/jekyll/drops/site_drop.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+
+module Jekyll
+  module Drops
+    class SiteDrop < Drop
+      extend Forwardable
+
+      mutable false
+
+      def_delegator  :@obj, :site_data, :data
+      def_delegators :@obj, :time, :pages, :static_files, :documents,
+                            :tags, :categories
+
+      def [](key)
+        if @obj.collections.key?(key) && key != "posts"
+          @obj.collections[key].docs
+        else
+          super(key)
+        end
+      end
+
+      def posts
+        @site_posts ||= @obj.posts.docs.sort { |a, b| b <=> a }
+      end
+
+      def html_pages
+        @site_html_pages ||= @obj.pages.select { |page| page.html? || page.url.end_with?("/") }
+      end
+
+      def collections
+        @site_collections ||= @obj.collections.values.map(&:to_liquid)
+      end
+
+      private
+      def_delegator :@obj, :config, :fallback_data
+
+    end
+  end
+end

data/lib/jekyll/drops/unified_payload_drop.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+module Jekyll
+  module Drops
+    class UnifiedPayloadDrop < Drop
+      mutable true
+
+      attr_accessor :page, :layout, :content, :paginator
+      attr_accessor :highlighter_prefix, :highlighter_suffix
+
+      def jekyll
+        JekyllDrop.global
+      end
+
+      def site
+        @site_drop ||= SiteDrop.new(@obj)
+      end
+
+      private
+      def fallback_data
+        @fallback_data ||= {}
+      end
+
+    end
+  end
+end