jekyll 3.2.0.pre.beta1 → 3.2.0.pre.beta2

data/lib/jekyll/readers/page_reader.rb

@@ -14,7 +14,9 @@ module Jekyll
     #
     # Returns an array of static pages.
     def read(files)
-      files.map { |page| @unfiltered_content << Page.new(@site, @site.source, @dir, page) }
+      files.map do |page|
+        @unfiltered_content << Page.new(@site, @site.source, @dir, page)
+      end
       @unfiltered_content.select { |page| site.publisher.publish?(page) }
     end
   end

data/lib/jekyll/readers/post_reader.rb

@@ -12,7 +12,7 @@ module Jekyll
     #
     # Returns nothing.
     def read_drafts(dir)
-      read_publishable(dir, '_drafts', Document::DATELESS_FILENAME_MATCHER)
+      read_publishable(dir, "_drafts", Document::DATELESS_FILENAME_MATCHER)
     end
 
     # Read all the files in <source>/<dir>/_posts and create a new Document
@@ -22,7 +22,7 @@ module Jekyll
     #
     # Returns nothing.
     def read_posts(dir)
-      read_publishable(dir, '_posts', Document::DATE_FILENAME_MATCHER)
+      read_publishable(dir, "_posts", Document::DATE_FILENAME_MATCHER)
     end
 
     # Read all the files in <source>/<dir>/<magic_dir> and create a new
@@ -32,15 +32,14 @@ module Jekyll
     #
     # Returns nothing.
     def read_publishable(dir, magic_dir, matcher)
-      read_content(dir, magic_dir, matcher).tap do |docs|
-        docs.each(&:read)
-      end.select do |doc|
-        site.publisher.publish?(doc).tap do |will_publish|
-          if !will_publish && site.publisher.hidden_in_the_future?(doc)
-            Jekyll.logger.debug "Skipping:", "#{doc.relative_path} has a future date"
+      read_content(dir, magic_dir, matcher).tap { |docs| docs.each(&:read) }
+        .select do |doc|
+          site.publisher.publish?(doc).tap do |will_publish|
+            if !will_publish && site.publisher.hidden_in_the_future?(doc)
+              Jekyll.logger.debug "Skipping:", "#{doc.relative_path} has a future date"
+            end
           end
         end
-      end
     end
 
     # Read all the content files from <source>/<dir>/magic_dir
@@ -57,7 +56,7 @@ module Jekyll
         next unless entry =~ matcher
         path = @site.in_source_dir(File.join(dir, magic_dir, entry))
         Document.new(path, {
-          :site => @site,
+          :site       => @site,
           :collection => @site.posts
         })
       end.reject(&:nil?)

data/lib/jekyll/readers/static_file_reader.rb

@@ -14,7 +14,9 @@ module Jekyll
     #
     # Returns an array of static files.
     def read(files)
-      files.map { |file| @unfiltered_content << StaticFile.new(@site, @site.source, @dir, file) }
+      files.map do |file|
+        @unfiltered_content << StaticFile.new(@site, @site.source, @dir, file)
+      end
       @unfiltered_content
     end
   end

data/lib/jekyll/regenerator.rb

@@ -20,18 +20,14 @@ module Jekyll
     def regenerate?(document)
       case document
       when Page
-        document.asset_file? || document.data['regenerate'] ||
-          source_modified_or_dest_missing?(
-            site.in_source_dir(document.relative_path), document.destination(@site.dest)
-          )
+        regenerate_page?(document)
       when Document
-        !document.write? || document.data['regenerate'] ||
-          source_modified_or_dest_missing?(
-            document.path, document.destination(@site.dest)
-          )
+        regenerate_document?(document)
       else
-        source_path = document.respond_to?(:path)        ? document.path                    : nil
-        dest_path   = document.respond_to?(:destination) ? document.destination(@site.dest) : nil
+        source_path = document.respond_to?(:path) ? document.path : nil
+        dest_path = if document.respond_to?(:destination)
+                      document.destination(@site.dest)
+                    end
         source_modified_or_dest_missing?(source_path, dest_path)
       end
     end
@@ -44,7 +40,7 @@ module Jekyll
 
       metadata[path] = {
         "mtime" => File.mtime(path),
-        "deps" => []
+        "deps"  => []
       }
       cache[path] = true
     end
@@ -94,23 +90,14 @@ module Jekyll
         return cache[path]
       end
 
-      # Check path that exists in metadata
-      data = metadata[path]
-      if data
-        data["deps"].each do |dependency|
-          if modified?(dependency)
-            return cache[dependency] = cache[path] = true
-          end
-        end
-        if File.exist?(path) && data["mtime"].eql?(File.mtime(path))
-          return cache[path] = false
-        else
-          return add(path)
-        end
+      if metadata[path]
+        # If we have seen this file before,
+        # check if it or one of its dependencies has been modified
+        existing_file_modified?(path)
+      else
+        # If we have not seen this file before, add it to the metadata and regenerate it
+        add(path)
       end
-
-      # Path does not exist in metadata, add it
-      return add(path)
     end
 
     # Add a dependency of a path
@@ -139,7 +126,7 @@ module Jekyll
     #
     # Returns the String path of the file.
     def metadata_file
-      site.in_source_dir('.jekyll-metadata')
+      site.in_source_dir(".jekyll-metadata")
     end
 
     # Check if metadata has been disabled
@@ -173,5 +160,40 @@ module Jekyll
           {}
         end
     end
+
+    private
+    def regenerate_page?(document)
+      document.asset_file? || document.data["regenerate"] ||
+        source_modified_or_dest_missing?(
+          site.in_source_dir(document.relative_path), document.destination(@site.dest)
+        )
+    end
+
+    private
+    def regenerate_document?(document)
+      !document.write? || document.data["regenerate"] ||
+        source_modified_or_dest_missing?(
+          document.path, document.destination(@site.dest)
+        )
+    end
+
+    private
+    def existing_file_modified?(path)
+      # If one of this file dependencies have been modified,
+      # set the regeneration bit for both the dependency and the file to true
+      metadata[path]["deps"].each do |dependency|
+        if modified?(dependency)
+          return cache[dependency] = cache[path] = true
+        end
+      end
+
+      if File.exist?(path) && metadata[path]["mtime"].eql?(File.mtime(path))
+        # If this file has not been modified, set the regeneration bit to false
+        cache[path] = false
+      else
+        # If it has been modified, set it to true
+        add(path)
+      end
+    end
   end
 end

data/lib/jekyll/related_posts.rb

@@ -9,7 +9,7 @@ module Jekyll
     def initialize(post)
       @post = post
       @site = post.site
-      Jekyll::External.require_with_graceful_fail('classifier-reborn') if site.lsi
+      Jekyll::External.require_with_graceful_fail("classifier-reborn") if site.lsi
     end
 
     def build

data/lib/jekyll/renderer.rb

@@ -38,21 +38,21 @@ module Jekyll
         payload["paginator"] = document.pager.to_liquid
       end
 
-      if document.is_a?(Document) && document.collection.label == 'posts'
-        payload['site']['related_posts'] = document.related_posts
+      if document.is_a?(Document) && document.collection.label == "posts"
+        payload["site"]["related_posts"] = document.related_posts
       else
-        payload['site']['related_posts'] = nil
+        payload["site"]["related_posts"] = nil
       end
 
       # render and transform content (this becomes the final content of the object)
-      payload['highlighter_prefix'] = converters.first.highlighter_prefix
-      payload['highlighter_suffix'] = converters.first.highlighter_suffix
+      payload["highlighter_prefix"] = converters.first.highlighter_prefix
+      payload["highlighter_suffix"] = converters.first.highlighter_suffix
 
       Jekyll.logger.debug "Pre-Render Hooks:", document.relative_path
       document.trigger_hooks(:pre_render, payload)
 
       info = {
-        :registers => { :site => site, :page => payload['page'] }
+        :registers => { :site => site, :page => payload["page"] }
       }
 
       output = document.content
@@ -88,7 +88,9 @@ module Jekyll
         begin
           converter.convert output
         rescue => e
-          Jekyll.logger.error "Conversion error:", "#{converter.class} encountered an error while converting '#{document.relative_path}':"
+          Jekyll.logger.error "Conversion error:",
+            "#{converter.class} encountered an error while "\
+            "converting '#{document.relative_path}':"
           Jekyll.logger.error("", e.to_s)
           raise e
         end
@@ -106,12 +108,16 @@ module Jekyll
     def render_liquid(content, payload, info, path = nil)
       site.liquid_renderer.file(path).parse(content).render!(payload, info)
     rescue Tags::IncludeTagError => e
-      Jekyll.logger.error "Liquid Exception:", "#{e.message} in #{e.path}, included in #{path || document.relative_path}"
+      Jekyll.logger.error "Liquid Exception:",
+        "#{e.message} in #{e.path}, included in #{path || document.relative_path}"
       raise e
+    # rubocop: disable RescueException
     rescue Exception => e
-      Jekyll.logger.error "Liquid Exception:", "#{e.message} in #{path || document.relative_path}"
+      Jekyll.logger.error "Liquid Exception:",
+        "#{e.message} in #{path || document.relative_path}"
       raise e
     end
+    # rubocop: enable RescueException
 
     # Checks if the layout specified in the document actually exists
     #
@@ -132,14 +138,20 @@ module Jekyll
       output = content.dup
       layout = site.layouts[document.data["layout"]]
 
-      Jekyll.logger.warn("Build Warning:", "Layout '#{document.data["layout"]}' requested in #{document.relative_path} does not exist.") if invalid_layout? layout
+      Jekyll.logger.warn(
+        "Build Warning:",
+        "Layout '#{document.data["layout"]}' requested in "\
+        "#{document.relative_path} does not exist."
+      ) if invalid_layout? layout
 
-      used   = Set.new([layout])
+      used = Set.new([layout])
+
+      # Reset the payload layout data to ensure it starts fresh for each page.
+      payload["layout"] = nil
 
       while layout
-        payload['content'] = output
-        payload['page']    = document.to_liquid
-        payload['layout']  = Utils.deep_merge_hashes(payload['layout'] || {}, layout.data)
+        payload["content"] = output
+        payload["layout"]  = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})
 
         output = render_liquid(
           layout.content,
@@ -154,12 +166,9 @@ module Jekyll
           site.in_source_dir(layout.path)
         ) if document.write?
 
-        if layout = site.layouts[layout.data["layout"]]
-          if used.include?(layout)
-            layout = nil # avoid recursive chain
-          else
-            used << layout
-          end
+        if (layout = site.layouts[layout.data["layout"]])
+          break if used.include?(layout)
+          used << layout
         end
       end
 

data/lib/jekyll/site.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require 'csv'
+require "csv"
 
 module Jekyll
   class Site
@@ -18,8 +18,8 @@ module Jekyll
     # config - A Hash containing site configuration details.
     def initialize(config)
       # Source and destination may not be changed after the site has been created.
-      @source          = File.expand_path(config['source']).freeze
-      @dest            = File.expand_path(config['destination']).freeze
+      @source          = File.expand_path(config["source"]).freeze
+      @dest            = File.expand_path(config["destination"]).freeze
 
       self.config = config
 
@@ -29,10 +29,10 @@ module Jekyll
 
       Jekyll.sites << self
 
-      Jekyll::Hooks.trigger :site, :after_init, self
-
       reset
       setup
+
+      Jekyll::Hooks.trigger :site, :after_init, self
     end
 
     # Public: Set the site's configuration. This handles side-effects caused by
@@ -49,19 +49,12 @@ module Jekyll
         self.send("#{opt}=", config[opt])
       end
 
-      self.plugin_manager = Jekyll::PluginManager.new(self)
-      self.plugins        = plugin_manager.plugins_path
+      configure_plugins
+      configure_theme
+      configure_include_paths
+      configure_file_read_opts
 
-      self.theme = nil
-      self.theme = Jekyll::Theme.new(config["theme"]) if config["theme"]
-
-      @includes_load_paths = Array(in_source_dir(config["includes_dir"].to_s))
-      @includes_load_paths << theme.includes_path if self.theme
-
-      self.file_read_opts = {}
-      self.file_read_opts[:encoding] = config['encoding'] if config['encoding']
-
-      self.permalink_style = config['permalink'].to_sym
+      self.permalink_style = config["permalink"].to_sym
 
       @config
     end
@@ -80,7 +73,7 @@ module Jekyll
     end
 
     def print_stats
-      if @config['profile']
+      if @config["profile"]
         puts @liquid_renderer.stats_table
       end
     end
@@ -89,7 +82,11 @@ module Jekyll
     #
     # Returns nothing
     def reset
-      self.time = (config['time'] ? Utils.parse_date(config['time'].to_s, "Invalid time in _config.yml.") : Time.now)
+      if config["time"]
+        self.time = Utils.parse_date(config["time"].to_s, "Invalid time in _config.yml.")
+      else
+        self.time = Time.now
+      end
       self.layouts = {}
       self.pages = []
       self.static_files = []
@@ -123,18 +120,23 @@ module Jekyll
       dest_pathname = Pathname.new(dest)
       Pathname.new(source).ascend do |path|
         if path == dest_pathname
-          raise Errors::FatalException.new "Destination directory cannot be or contain the Source directory."
+          raise(
+            Errors::FatalException,
+            "Destination directory cannot be or contain the Source directory."
+          )
         end
       end
     end
 
     # The list of collections and their corresponding Jekyll::Collection instances.
-    # If config['collections'] is set, a new instance is created for each item in the collection.
-    # If config['collections'] is not set, a new hash is returned.
+    # If config['collections'] is set, a new instance is created
+    # for each item in the collection, a new hash is returned otherwise.
     #
     # Returns a Hash containing collection name-to-instance pairs.
     def collections
-      @collections ||= Hash[collection_names.map { |coll| [coll, Jekyll::Collection.new(self, coll)] } ]
+      @collections ||= Hash[collection_names.map do |coll|
+        [coll, Jekyll::Collection.new(self, coll)]
+      end]
     end
 
     # The list of collection names.
@@ -142,11 +144,11 @@ module Jekyll
     # Returns an array of collection names from the configuration,
     #   or an empty array if the `collections` key is not set.
     def collection_names
-      case config['collections']
+      case config["collections"]
       when Hash
-        config['collections'].keys
+        config["collections"].keys
       when Array
-        config['collections']
+        config["collections"]
       when nil
         []
       else
@@ -168,7 +170,9 @@ module Jekyll
     # Returns nothing.
     def generate
       generators.each do |generator|
+        start = Time.now
         generator.generate(self)
+        Jekyll.logger.debug "Generating:", "#{generator.class} finished in #{Time.now - start} seconds."
       end
     end
 
@@ -182,26 +186,15 @@ module Jekyll
 
       Jekyll::Hooks.trigger :site, :pre_render, self, payload
 
-      collections.each do |_, collection|
-        collection.docs.each do |document|
-          if regenerator.regenerate?(document)
-            document.output = Jekyll::Renderer.new(self, document, payload).run
-            document.trigger_hooks(:post_render)
-          end
-        end
-      end
-
-      pages.flatten.each do |page|
-        if regenerator.regenerate?(page)
-          page.output = Jekyll::Renderer.new(self, page, payload).run
-          page.trigger_hooks(:post_render)
-        end
-      end
+      render_docs(payload)
+      render_pages(payload)
 
       Jekyll::Hooks.trigger :site, :post_render, self, payload
+    # rubocop: disable HandleExceptions
     rescue Errno::ENOENT
       # ignore missing layout dir
     end
+    # rubocop: enable HandleExceptions
 
     # Remove orphaned files and empty directories in destination.
     #
@@ -222,7 +215,7 @@ module Jekyll
     end
 
     def posts
-      collections['posts'] ||= Collection.new(self, 'posts')
+      collections["posts"] ||= Collection.new(self, "posts")
     end
 
     # Construct a Hash of Posts indexed by the specified Post attribute.
@@ -242,17 +235,19 @@ module Jekyll
       # Build a hash map based on the specified post attribute ( post attr =>
       # array of posts ) then sort each array in reverse order.
       hash = Hash.new { |h, key| h[key] = [] }
-      posts.docs.each { |p| p.data[post_attr].each { |t| hash[t] << p } if p.data[post_attr] }
+      posts.docs.each do |p|
+        p.data[post_attr].each { |t| hash[t] << p } if p.data[post_attr]
+      end
       hash.values.each { |posts| posts.sort!.reverse! }
       hash
     end
 
     def tags
-      post_attr_hash('tags')
+      post_attr_hash("tags")
     end
 
     def categories
-      post_attr_hash('categories')
+      post_attr_hash("categories")
     end
 
     # Prepare site data for site payload. The method maintains backward compatibility
@@ -260,7 +255,7 @@ module Jekyll
     #
     # Returns the Hash to be hooked to site.data.
     def site_data
-      config['data'] || data
+      config["data"] || data
     end
 
     # The Hash payload containing site-wide data.
@@ -279,6 +274,7 @@ module Jekyll
     def site_payload
       Drops::UnifiedPayloadDrop.new self
     end
+    alias_method :to_liquid, :site_payload
 
     # Get the implementation class for the given Converter.
     # Returns the Converter instance implementing the given Converter.
@@ -305,7 +301,7 @@ module Jekyll
     #
     # Returns
     def relative_permalinks_are_deprecated
-      if config['relative_permalinks']
+      if config["relative_permalinks"]
         Jekyll.logger.abort_with "Since v3.0, permalinks for pages" \
                                 " in subfolders must be relative to the" \
                                 " site source directory, not the parent" \
@@ -350,7 +346,7 @@ module Jekyll
     #
     # Returns a Boolean: true for a full rebuild, false for normal build
     def incremental?(override = {})
-      override['incremental'] || config['incremental']
+      override["incremental"] || config["incremental"]
     end
 
     # Returns the publisher or creates a new publisher if it doesn't
@@ -398,11 +394,10 @@ module Jekyll
       end
     end
 
-    private
-
     # Limits the current posts; removes the posts which exceed the limit_posts
     #
     # Returns nothing
+    private
     def limit_posts!
       if limit_posts > 0
         limit = posts.docs.length < limit_posts ? posts.docs.length : limit_posts
@@ -414,8 +409,55 @@ module Jekyll
     # already exist.
     #
     # Returns The Cleaner
+    private
     def site_cleaner
       @site_cleaner ||= Cleaner.new(self)
     end
+
+    private
+    def configure_plugins
+      self.plugin_manager = Jekyll::PluginManager.new(self)
+      self.plugins        = plugin_manager.plugins_path
+    end
+
+    private
+    def configure_theme
+      self.theme = nil
+      self.theme = Jekyll::Theme.new(config["theme"]) if config["theme"]
+    end
+
+    private
+    def configure_include_paths
+      @includes_load_paths = Array(in_source_dir(config["includes_dir"].to_s))
+      @includes_load_paths << theme.includes_path if self.theme
+    end
+
+    private
+    def configure_file_read_opts
+      self.file_read_opts = {}
+      self.file_read_opts[:encoding] = config["encoding"] if config["encoding"]
+    end
+
+    private
+    def render_docs(payload)
+      collections.each do |_, collection|
+        collection.docs.each do |document|
+          if regenerator.regenerate?(document)
+            document.output = Jekyll::Renderer.new(self, document, payload).run
+            document.trigger_hooks(:post_render)
+          end
+        end
+      end
+    end
+
+    private
+    def render_pages(payload)
+      pages.flatten.each do |page|
+        if regenerator.regenerate?(page)
+          page.output = Jekyll::Renderer.new(self, page, payload).run
+          page.trigger_hooks(:post_render)
+        end
+      end
+    end
   end
 end