bunto 3.0.0 → 3.2.1

data/lib/bunto/site.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require 'csv'
+require "csv"
 
 module Bunto
   class Site
@@ -18,8 +18,8 @@ module Bunto
     # 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 Bunto
 
       Bunto.sites << self
 
-      Bunto::Hooks.trigger :site, :after_init, self
-
       reset
       setup
+
+      Bunto::Hooks.trigger :site, :after_init, self
     end
 
     # Public: Set the site's configuration. This handles side-effects caused by
@@ -49,19 +49,12 @@ module Bunto
         self.send("#{opt}=", config[opt])
       end
 
-      self.plugin_manager = Bunto::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 = Bunto::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 Bunto
     end
 
     def print_stats
-      if @config['profile']
+      if @config["profile"]
         puts @liquid_renderer.stats_table
       end
     end
@@ -89,7 +82,11 @@ module Bunto
     #
     # 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 Bunto
       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 Bunto::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, Bunto::Collection.new(self, coll)] } ]
+      @collections ||= Hash[collection_names.map do |coll|
+        [coll, Bunto::Collection.new(self, coll)]
+      end]
     end
 
     # The list of collection names.
@@ -142,11 +144,11 @@ module Bunto
     # 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,10 @@ module Bunto
     # Returns nothing.
     def generate
       generators.each do |generator|
+        start = Time.now
         generator.generate(self)
+        Bunto.logger.debug "Generating:",
+          "#{generator.class} finished in #{Time.now - start} seconds."
       end
     end
 
@@ -182,26 +187,15 @@ module Bunto
 
       Bunto::Hooks.trigger :site, :pre_render, self, payload
 
-      collections.each do |_, collection|
-        collection.docs.each do |document|
-          if regenerator.regenerate?(document)
-            document.output = Bunto::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 = Bunto::Renderer.new(self, page, payload).run
-          page.trigger_hooks(:post_render)
-        end
-      end
+      render_docs(payload)
+      render_pages(payload)
 
       Bunto::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 +216,7 @@ module Bunto
     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 +236,19 @@ module Bunto
       # 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 +256,7 @@ module Bunto
     #
     # 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 +275,7 @@ module Bunto
     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,11 +302,11 @@ module Bunto
     #
     # Returns
     def relative_permalinks_are_deprecated
-      if config['relative_permalinks']
+      if config["relative_permalinks"]
         Bunto.logger.abort_with "Since v3.0, permalinks for pages" \
                                 " in subfolders must be relative to the" \
                                 " site source directory, not the parent" \
-                                " directory. Check http://bunto.github.io/docs/upgrading/"\
+                                " directory. Check http://bunto.github.io/docs/upgrading"\
                                 " for more info."
       end
     end
@@ -350,7 +347,7 @@ module Bunto
     #
     # 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 +395,10 @@ module Bunto
       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 +410,55 @@ module Bunto
     # already exist.
     #
     # Returns The Cleaner
+    private
     def site_cleaner
       @site_cleaner ||= Cleaner.new(self)
     end
+
+    private
+    def configure_plugins
+      self.plugin_manager = Bunto::PluginManager.new(self)
+      self.plugins        = plugin_manager.plugins_path
+    end
+
+    private
+    def configure_theme
+      self.theme = nil
+      self.theme = Bunto::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 = Bunto::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 = Bunto::Renderer.new(self, page, payload).run
+          page.trigger_hooks(:post_render)
+        end
+      end
+    end
   end
 end

data/lib/bunto/static_file.rb

@@ -1,16 +1,25 @@
 module Bunto
   class StaticFile
-    # The cache of last modification times [path] -> mtime.
-    @@mtimes = {}
-
     attr_reader :relative_path, :extname
 
+    class << self
+      # The cache of last modification times [path] -> mtime.
+      def mtimes
+        @mtimes ||= {}
+      end
+
+      def reset_cache
+        @mtimes = nil
+      end
+    end
+
     # Initialize a new StaticFile.
     #
     # site - The Site.
     # base - The String path to the <source>.
     # dir  - The String path between <source> and the file.
     # name - The String filename of the file.
+    # rubocop: disable ParameterLists
     def initialize(site, base, dir, name, collection = nil)
       @site = site
       @base = base
@@ -20,6 +29,7 @@ module Bunto
       @relative_path = File.join(*[@dir, @name].compact)
       @extname = File.extname(@name)
     end
+    # rubocop: enable ParameterLists
 
     # Returns source file path.
     def path
@@ -56,7 +66,7 @@ module Bunto
     #
     # Returns true if modified since last write.
     def modified?
-      @@mtimes[path] != mtime
+      self.class.mtimes[path] != mtime
     end
 
     # Whether to write the file to the filesystem
@@ -64,7 +74,7 @@ module Bunto
     # Returns true unless the defaults for the destination path from
     # _config.yml contain `published: false`.
     def write?
-      defaults.fetch('published', true)
+      defaults.fetch("published", true)
     end
 
     # Write the static file to the destination directory (if modified).
@@ -76,28 +86,15 @@ module Bunto
       dest_path = destination(dest)
 
       return false if File.exist?(dest_path) && !modified?
-      @@mtimes[path] = mtime
+      self.class.mtimes[path] = mtime
 
       FileUtils.mkdir_p(File.dirname(dest_path))
       FileUtils.rm(dest_path) if File.exist?(dest_path)
-      if @site.safe || Bunto.env == "production"
-        FileUtils.cp(path, dest_path)
-      else
-        FileUtils.copy_entry(path, dest_path)
-      end
-      File.utime(@@mtimes[path], @@mtimes[path], dest_path)
+      copy_file(dest_path)
 
       true
     end
 
-    # Reset the mtimes cache (for testing purposes).
-    #
-    # Returns nothing.
-    def self.reset_cache
-      @@mtimes = {}
-      nil
-    end
-
     def to_liquid
       {
         "extname"       => extname,
@@ -109,11 +106,11 @@ module Bunto
     def placeholders
       {
         :collection => @collection.label,
-        :path => relative_path[
+        :path       => relative_path[
           @collection.relative_directory.size..relative_path.size],
-        :output_ext => '',
-        :name => '',
-        :title => ''
+        :output_ext => "",
+        :name       => "",
+        :title      => ""
       }
     end
 
@@ -125,10 +122,10 @@ module Bunto
                  relative_path
                else
                  ::Bunto::URL.new({
-                   :template => @collection.url_template,
+                   :template     => @collection.url_template,
                    :placeholders => placeholders
                  })
-               end.to_s.gsub(/\/$/, '')
+               end.to_s.gsub(%r!/$!, "")
     end
 
     # Returns the type of the collection if present, nil otherwise.
@@ -141,5 +138,15 @@ module Bunto
     def defaults
       @defaults ||= @site.frontmatter_defaults.all url, type
     end
+
+    private
+    def copy_file(dest_path)
+      if @site.safe || Bunto.env == "production"
+        FileUtils.cp(path, dest_path)
+      else
+        FileUtils.copy_entry(path, dest_path)
+      end
+      File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path)
+    end
   end
 end

data/lib/bunto/stevenson.rb

@@ -6,13 +6,13 @@ module Bunto
       @default_formatter = Formatter.new
       @logdev = $stdout
       @formatter = proc do |_, _, _, msg|
-        "#{msg}"
+        msg.to_s
       end
     end
 
-    def add(severity, message = nil, progname = nil, &block)
+    def add(severity, message = nil, progname = nil)
       severity ||= UNKNOWN
-      @logdev = set_logdevice(severity)
+      @logdev = logdevice(severity)
 
       if @logdev.nil? || severity < @level
         return true
@@ -27,7 +27,8 @@ module Bunto
         end
       end
       @logdev.puts(
-        format_message(format_severity(severity), Time.now, progname, message))
+        format_message(format_severity(severity), Time.now, progname, message)
+      )
       true
     end
 
@@ -47,7 +48,7 @@ module Bunto
 
     private
 
-    def set_logdevice(severity)
+    def logdevice(severity)
       if severity > INFO
         $stderr
       else