bunto 3.0.0 → 3.2.1

data/lib/bunto/plugin.rb

@@ -1,12 +1,12 @@
 module Bunto
   class Plugin
     PRIORITIES = {
-      :low => -10,
+      :low     => -10,
       :highest => 100,
-      :lowest => -100,
-      :normal => 0,
-      :high => 10
-    }
+      :lowest  => -100,
+      :normal  => 0,
+      :high    => 10
+    }.freeze
 
     #
 

data/lib/bunto/plugin_manager.rb

@@ -24,7 +24,9 @@ module Bunto
     #
     # Returns nothing.
     def require_gems
-      Bunto::External.require_with_graceful_fail(site.gems.select { |gem| plugin_allowed?(gem) })
+      Bunto::External.require_with_graceful_fail(
+        site.gems.select { |gem| plugin_allowed?(gem) }
+      )
     end
 
     def self.require_from_bundler
@@ -33,7 +35,8 @@ module Bunto
 
         Bundler.setup
         required_gems = Bundler.require(:bunto_plugins)
-        Bunto.logger.debug("PluginManager:", "Required #{required_gems.map(&:name).join(', ')}")
+        message = "Required #{required_gems.map(&:name).join(", ")}"
+        Bunto.logger.debug("PluginManager:", message)
         ENV["BUNTO_NO_BUNDLER_REQUIRE"] = "true"
 
         true
@@ -57,7 +60,7 @@ module Bunto
     # Returns an array of strings, each string being the name of a gem name
     #   that is allowed to be used.
     def whitelist
-      @whitelist ||= Array[site.config['whitelist']].flatten
+      @whitelist ||= Array[site.config["whitelist"]].flatten
     end
 
     # Require all .rb files if safe mode is off
@@ -76,16 +79,17 @@ module Bunto
     #
     # Returns an Array of plugin search paths
     def plugins_path
-      if site.config['plugins_dir'] == Bunto::Configuration::DEFAULTS['plugins_dir']
-        [site.in_source_dir(site.config['plugins_dir'])]
+      if site.config["plugins_dir"].eql? Bunto::Configuration::DEFAULTS["plugins_dir"]
+        [site.in_source_dir(site.config["plugins_dir"])]
       else
-        Array(site.config['plugins_dir']).map { |d| File.expand_path(d) }
+        Array(site.config["plugins_dir"]).map { |d| File.expand_path(d) }
       end
     end
 
     def deprecation_checks
-      pagination_included = (site.config['gems'] || []).include?('bunto-paginate') || defined?(Bunto::Paginate)
-      if site.config['paginate'] && !pagination_included
+      pagination_included = (site.config["gems"] || []).include?("bunto-paginate") ||
+        defined?(Bunto::Paginate)
+      if site.config["paginate"] && !pagination_included
         Bunto::Deprecator.deprecation_message "You appear to have pagination " \
           "turned on, but you haven't included the `bunto-paginate` gem. " \
           "Ensure you have `gems: [bunto-paginate]` in your configuration file."

data/lib/bunto/publisher.rb

@@ -15,7 +15,7 @@ module Bunto
     private
 
     def can_be_published?(thing)
-      thing.data.fetch('published', true) || @site.unpublished
+      thing.data.fetch("published", true) || @site.unpublished
     end
   end
 end

data/lib/bunto/reader.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require 'csv'
+require "csv"
 
 module Bunto
   class Reader
@@ -16,7 +16,7 @@ module Bunto
       @site.layouts = LayoutReader.new(site).read
       read_directories
       sort_files!
-      @site.data = DataReader.new(site).read(site.config['data_dir'])
+      @site.data = DataReader.new(site).read(site.config["data_dir"])
       CollectionReader.new(site).read
     end
 
@@ -34,13 +34,15 @@ module Bunto
     # dir - The String relative path of the directory to read. Default: ''.
     #
     # Returns nothing.
-    def read_directories(dir = '')
+    def read_directories(dir = "")
       base = site.in_source_dir(dir)
 
-      dot = Dir.chdir(base) { filter_entries(Dir.entries('.'), base) }
+      dot = Dir.chdir(base) { filter_entries(Dir.entries("."), base) }
       dot_dirs = dot.select { |file| File.directory?(@site.in_source_dir(base, file)) }
       dot_files = (dot - dot_dirs)
-      dot_pages = dot_files.select { |file| Utils.has_yaml_header?(@site.in_source_dir(base, file)) }
+      dot_pages = dot_files.select do |file|
+        Utils.has_yaml_header?(@site.in_source_dir(base, file))
+      end
       dot_static_files = dot_files - dot_pages
 
       retrieve_posts(dir)
@@ -71,7 +73,9 @@ module Bunto
       dot_dirs.map do |file|
         dir_path = site.in_source_dir(dir, file)
         rel_path = File.join(dir, file)
-        @site.reader.read_directories(rel_path) unless @site.dest.sub(/\/$/, '') == dir_path
+        unless @site.dest.sub(%r!/$!, "") == dir_path
+          @site.reader.read_directories(rel_path)
+        end
       end
     end
 
@@ -119,7 +123,7 @@ module Bunto
     def get_entries(dir, subfolder)
       base = site.in_source_dir(dir, subfolder)
       return [] unless File.exist?(base)
-      entries = Dir.chdir(base) { filter_entries(Dir['**/*'], base) }
+      entries = Dir.chdir(base) { filter_entries(Dir["**/*"], base) }
       entries.delete_if { |e| File.directory?(site.in_source_dir(base, e)) }
     end
   end

data/lib/bunto/readers/data_reader.rb

@@ -30,14 +30,14 @@ module Bunto
       return unless File.directory?(dir) && !@entry_filter.symlink?(dir)
 
       entries = Dir.chdir(dir) do
-        Dir['*.{yaml,yml,json,csv}'] + Dir['*'].select { |fn| File.directory?(fn) }
+        Dir["*.{yaml,yml,json,csv}"] + Dir["*"].select { |fn| File.directory?(fn) }
       end
 
       entries.each do |entry|
         path = @site.in_source_dir(dir, entry)
         next if @entry_filter.symlink?(path)
 
-        key = sanitize_filename(File.basename(entry, '.*'))
+        key = sanitize_filename(File.basename(entry, ".*"))
         if File.directory?(path)
           read_data_to(path, data[key] = {})
         else
@@ -51,20 +51,20 @@ module Bunto
     # Returns the contents of the data file.
     def read_data_file(path)
       case File.extname(path).downcase
-      when '.csv'
+      when ".csv"
         CSV.read(path, {
-                         :headers => true,
-                         :encoding => site.config['encoding']
-                     }).map(&:to_hash)
+          :headers  => true,
+          :encoding => site.config["encoding"]
+        }).map(&:to_hash)
       else
         SafeYAML.load_file(path)
       end
     end
 
     def sanitize_filename(name)
-      name.gsub!(/[^\w\s-]+/, '')
-      name.gsub!(/(^|\b\s)\s+($|\s?\b)/, '\\1\\2')
-      name.gsub(/\s+/, '_')
+      name.gsub!(%r![^\w\s-]+!, "")
+      name.gsub!(%r!(^|\b\s)\s+($|\s?\b)!, '\\1\\2')
+      name.gsub(%r!\s+!, "_")
     end
   end
 end

data/lib/bunto/readers/layout_reader.rb

@@ -8,11 +8,13 @@ module Bunto
 
     def read
       layout_entries.each do |layout_file|
-        @layouts[layout_name(layout_file)] = Layout.new(site, layout_directory, layout_file)
+        @layouts[layout_name(layout_file)] = \
+          Layout.new(site, layout_directory, layout_file)
       end
 
       theme_layout_entries.each do |layout_file|
-        @layouts[layout_name(layout_file)] ||= Layout.new(site, theme_layout_directory, layout_file)
+        @layouts[layout_name(layout_file)] ||= \
+          Layout.new(site, theme_layout_directory, layout_file)
       end
 
       @layouts
@@ -39,7 +41,7 @@ module Bunto
     def entries_in(dir)
       entries = []
       within(dir) do
-        entries = EntryFilter.new(site).filter(Dir['**/*.*'])
+        entries = EntryFilter.new(site).filter(Dir["**/*.*"])
       end
       entries
     end
@@ -54,15 +56,13 @@ module Bunto
     end
 
     def layout_directory_inside_source
-      site.in_source_dir(site.config['layouts_dir'])
+      site.in_source_dir(site.config["layouts_dir"])
     end
 
     def layout_directory_in_cwd
-      dir = Bunto.sanitized_path(Dir.pwd, site.config['layouts_dir'])
+      dir = Bunto.sanitized_path(Dir.pwd, site.config["layouts_dir"])
       if File.directory?(dir) && !site.safe
         dir
-      else
-        nil
       end
     end
   end

data/lib/bunto/readers/page_reader.rb

@@ -14,7 +14,9 @@ module Bunto
     #
     # 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/bunto/readers/post_reader.rb

@@ -12,7 +12,7 @@ module Bunto
     #
     # 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 Bunto
     #
     # 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 Bunto
     #
     # 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)
-            Bunto.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)
+              Bunto.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 Bunto
         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/bunto/readers/static_file_reader.rb

@@ -14,7 +14,9 @@ module Bunto
     #
     # 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/bunto/regenerator.rb

@@ -20,18 +20,14 @@ module Bunto
     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 Bunto
 
       metadata[path] = {
         "mtime" => File.mtime(path),
-        "deps" => []
+        "deps"  => []
       }
       cache[path] = true
     end
@@ -94,23 +90,14 @@ module Bunto
         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 Bunto
     #
     # Returns the String path of the file.
     def metadata_file
-      site.in_source_dir('.bunto-metadata')
+      site.in_source_dir(".bunto-metadata")
     end
 
     # Check if metadata has been disabled
@@ -173,5 +160,40 @@ module Bunto
           {}
         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/bunto/related_posts.rb

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

data/lib/bunto/renderer.rb

@@ -38,21 +38,21 @@ module Bunto
         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
 
       Bunto.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 Bunto
         begin
           converter.convert output
         rescue => e
-          Bunto.logger.error "Conversion error:", "#{converter.class} encountered an error while converting '#{document.relative_path}':"
+          Bunto.logger.error "Conversion error:",
+            "#{converter.class} encountered an error while "\
+            "converting '#{document.relative_path}':"
           Bunto.logger.error("", e.to_s)
           raise e
         end
@@ -104,14 +106,19 @@ module Bunto
     #
     # Returns the content, rendered by Liquid.
     def render_liquid(content, payload, info, path = nil)
-      site.liquid_renderer.file(path).parse(content).render!(payload, info)
-    rescue Tags::IncludeTagError => e
-      Bunto.logger.error "Liquid Exception:", "#{e.message} in #{e.path}, included in #{path || document.relative_path}"
-      raise e
+      template = site.liquid_renderer.file(path).parse(content)
+      template.warnings.each do |e|
+        Bunto.logger.warn "Liquid Warning:",
+          LiquidRenderer.format_error(e, path || document.relative_path)
+      end
+      template.render!(payload, info)
+    # rubocop: disable RescueException
     rescue Exception => e
-      Bunto.logger.error "Liquid Exception:", "#{e.message} in #{path || document.relative_path}"
+      Bunto.logger.error "Liquid Exception:",
+        LiquidRenderer.format_error(e, path || document.relative_path)
       raise e
     end
+    # rubocop: enable RescueException
 
     # Checks if the layout specified in the document actually exists
     #
@@ -132,14 +139,20 @@ module Bunto
       output = content.dup
       layout = site.layouts[document.data["layout"]]
 
-      Bunto.logger.warn("Build Warning:", "Layout '#{document.data["layout"]}' requested in #{document.relative_path} does not exist.") if invalid_layout? layout
+      Bunto.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 +167,9 @@ module Bunto
           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