bunto 3.0.0 → 3.2.1

data/lib/bunto/commands/new_theme.rb

@@ -0,0 +1,36 @@
+require "erb"
+
+class Bunto::Commands::NewTheme < Bunto::Command
+  class << self
+    def init_with_program(prog)
+      prog.command(:"new-theme") do |c|
+        c.syntax "new-theme NAME"
+        c.description "Creates a new Bunto theme scaffold"
+        c.option "code_of_conduct", \
+          "-c", "--code-of-conduct", \
+          "Include a Code of Conduct. (defaults to false)"
+
+        c.action do |args, opts|
+          Bunto::Commands::NewTheme.process(args, opts)
+        end
+      end
+    end
+
+    def process(args, opts)
+      if !args || args.empty?
+        raise Bunto::Errors::InvalidThemeName, "You must specify a theme name."
+      end
+
+      new_theme_name = args.join("_")
+      theme = Bunto::ThemeBuilder.new(new_theme_name, opts)
+      if theme.path.exist?
+        Bunto.logger.abort_with "Conflict:", "#{theme.path} already exists."
+      end
+
+      theme.create!
+      Bunto.logger.info "Your new Bunto theme, #{theme.name}," \
+        " is ready for you in #{theme.path}!"
+      Bunto.logger.info "For help getting started, read #{theme.path}/README.md."
+    end
+  end
+end

data/lib/bunto/commands/serve.rb

@@ -3,18 +3,17 @@ module Bunto
     class Serve < Command
       class << self
         COMMAND_OPTIONS = {
-          "ssl_cert" => ["--ssl-cert [CERT]", "X.509 (SSL) certificate."],
-          "host"     => ["host", "-H", "--host [HOST]", "Host to bind to"],
-          "open_url" => ["-o", "--open-url", "Launch your browser with your site."],
-          "detach"   => ["-B", "--detach", "Run the server in the background (detach)"],
-          "ssl_key"  => ["--ssl-key [KEY]", "X.509 (SSL) Private Key."],
-          "port"     => ["-P", "--port [PORT]", "Port to listen on"],
-          "baseurl"  => ["-b", "--baseurl [URL]", "Base URL"],
-          "show_dir_listing" => ["--show-dir-listing",
+          "ssl_cert"           => ["--ssl-cert [CERT]", "X.509 (SSL) certificate."],
+          "host"               => ["host", "-H", "--host [HOST]", "Host to bind to"],
+          "open_url"           => ["-o", "--open-url", "Launch your site in a browser"],
+          "detach"             => ["-B", "--detach", "Run the server in the background"],
+          "ssl_key"            => ["--ssl-key [KEY]", "X.509 (SSL) Private Key."],
+          "port"               => ["-P", "--port [PORT]", "Port to listen on"],
+          "show_dir_listing"   => ["--show-dir-listing",
             "Show a directory listing instead of loading your index file."],
           "skip_initial_build" => ["skip_initial_build", "--skip-initial-build",
             "Skips the initial site build which occurs before the server is started."]
-        }
+        }.freeze
 
         #
 
@@ -33,7 +32,9 @@ module Bunto
             cmd.action do |_, opts|
               opts["serving"] = true
               opts["watch"  ] = true unless opts.key?("watch")
+              config = opts["config"]
               Build.process(opts)
+              opts["config"] = config
               Serve.process(opts)
             end
           end
@@ -93,7 +94,7 @@ module Bunto
             )
           }
 
-          opts[:DirectoryIndex] = [] if opts[:BuntoOptions]['show_dir_listing']
+          opts[:DirectoryIndex] = [] if opts[:BuntoOptions]["show_dir_listing"]
 
           enable_ssl(opts)
           enable_logging(opts)
@@ -107,7 +108,7 @@ module Bunto
           WEBrick::Config::FileHandler.merge({
             :FancyIndexing     => true,
             :NondisclosureName => [
-              '.ht*', '~*'
+              ".ht*", "~*"
             ]
           })
         end
@@ -116,12 +117,12 @@ module Bunto
 
         private
         def server_address(server, opts)
-          "%{prefix}://%{address}:%{port}%{baseurl}" % {
-            :prefix => server.config[:SSLEnable] ? "https" : "http",
+          format("%{prefix}://%{address}:%{port}%{baseurl}", {
+            :prefix  => server.config[:SSLEnable] ? "https" : "http",
             :baseurl => opts["baseurl"] ? "#{opts["baseurl"]}/" : "",
             :address => server.config[:BindAddress],
-            :port => server.config[:Port]
-          }
+            :port    => server.config[:Port]
+          })
         end
 
         #
@@ -171,22 +172,27 @@ module Bunto
         # forget to add one of the certificates.
 
         private
+        # rubocop:disable Metrics/AbcSize
         def enable_ssl(opts)
           return if !opts[:BuntoOptions]["ssl_cert"] && !opts[:BuntoOptions]["ssl_key"]
           if !opts[:BuntoOptions]["ssl_cert"] || !opts[:BuntoOptions]["ssl_key"]
+            # rubocop:disable Style/RedundantException
             raise RuntimeError, "--ssl-cert or --ssl-key missing."
           end
-
           require "openssl"
           require "webrick/https"
-          source_key = Bunto.sanitized_path(opts[:BuntoOptions]["source"], opts[:BuntoOptions]["ssl_key" ])
-          source_certificate = Bunto.sanitized_path(opts[:BuntoOptions]["source"], opts[:BuntoOptions]["ssl_cert"])
-          opts[:SSLCertificate] = OpenSSL::X509::Certificate.new(File.read(source_certificate))
+          source_key = Bunto.sanitized_path(opts[:BuntoOptions]["source"], \
+                    opts[:BuntoOptions]["ssl_key" ])
+          source_certificate = Bunto.sanitized_path(opts[:BuntoOptions]["source"], \
+                    opts[:BuntoOptions]["ssl_cert"])
+          opts[:SSLCertificate] =
+            OpenSSL::X509::Certificate.new(File.read(source_certificate))
           opts[:SSLPrivateKey ] = OpenSSL::PKey::RSA.new(File.read(source_key))
           opts[:SSLEnable] = true
         end
 
         private
+
         def start_callback(detached)
           unless detached
             proc do
@@ -197,7 +203,7 @@ module Bunto
 
         private
         def mime_types
-          file = File.expand_path('../mime.types', File.dirname(__FILE__))
+          file = File.expand_path("../mime.types", File.dirname(__FILE__))
           WEBrick::HTTPUtils.load_mime_types(file)
         end
       end

data/lib/bunto/commands/serve/servlet.rb

@@ -7,7 +7,7 @@ module Bunto
         DEFAULTS = {
           "Cache-Control" => "private, max-age=0, proxy-revalidate, " \
             "no-store, no-cache, must-revalidate"
-        }
+        }.freeze
 
         def initialize(server, root, callbacks)
           # So we can access them easily.
@@ -25,8 +25,7 @@ module Bunto
           super || super(req, res, "#{basename}.html")
         end
 
-        #
-
+        # rubocop:disable Style/MethodName
         def do_GET(req, res)
           rtn = super
           validate_and_ensure_charset(req, res)
@@ -38,10 +37,10 @@ module Bunto
 
         private
         def validate_and_ensure_charset(_req, res)
-          key = res.header.keys.grep(/content-type/i).first
+          key = res.header.keys.grep(%r!content-type!i).first
           typ = res.header[key]
 
-          unless typ =~ /;\s*charset=/
+          unless typ =~ %r!;\s*charset=!
             res.header[key] = "#{typ}; charset=#{@bunto_opts["encoding"]}"
           end
         end

data/lib/bunto/configuration.rb

@@ -6,73 +6,94 @@ module Bunto
     # Strings rather than symbols are used for compatibility with YAML.
     DEFAULTS = Configuration[{
       # Where things are
-      'source'        => Dir.pwd,
-      'destination'   => File.join(Dir.pwd, '_site'),
-      'plugins_dir'   => '_plugins',
-      'layouts_dir'   => '_layouts',
-      'data_dir'      => '_data',
-      'includes_dir'  => '_includes',
-      'collections'   => {},
+      "source"            => Dir.pwd,
+      "destination"       => File.join(Dir.pwd, "_site"),
+      "plugins_dir"       => "_plugins",
+      "layouts_dir"       => "_layouts",
+      "data_dir"          => "_data",
+      "includes_dir"      => "_includes",
+      "collections"       => {},
 
       # Handling Reading
-      'safe'          => false,
-      'include'       => ['.htaccess'],
-      'exclude'       => [],
-      'keep_files'    => ['.git', '.svn'],
-      'encoding'      => 'utf-8',
-      'markdown_ext'  => 'markdown,mkdown,mkdn,mkd,md',
+      "safe"              => false,
+      "include"           => [".htaccess"],
+      "exclude"           => [],
+      "keep_files"        => [".git", ".svn"],
+      "encoding"          => "utf-8",
+      "markdown_ext"      => "markdown,mkdown,mkdn,mkd,md",
 
       # Filtering Content
-      'show_drafts'   => nil,
-      'limit_posts'   => 0,
-      'future'        => false,
-      'unpublished'   => false,
+      "show_drafts"       => nil,
+      "limit_posts"       => 0,
+      "future"            => false,
+      "unpublished"       => false,
 
       # Plugins
-      'whitelist'     => [],
-      'gems'          => [],
+      "whitelist"         => [],
+      "gems"              => [],
 
       # Conversion
-      'markdown'      => 'kramdown',
-      'highlighter'   => 'rouge',
-      'lsi'           => false,
-      'excerpt_separator' => "\n\n",
-      'incremental'   => false,
+      "markdown"          => "kramdown",
+      "highlighter"       => "rouge",
+      "lsi"               => false,
+      "excerpt_separator" => "\n\n",
+      "incremental"       => false,
 
       # Serving
-      'detach'        => false,          # default to not detaching the server
-      'port'          => '4000',
-      'host'          => '127.0.0.1',
-      'baseurl'       => '',
-      'show_dir_listing' => false,
+      "detach"            => false, # default to not detaching the server
+      "port"              => "4000",
+      "host"              => "127.0.0.1",
+      "baseurl"           => "",
+      "show_dir_listing"  => false,
 
       # Output Configuration
-      'permalink'     => 'date',
-      'paginate_path' => '/page:num',
-      'timezone'      => nil,           # use the local timezone
+      "permalink"         => "date",
+      "paginate_path"     => "/page:num",
+      "timezone"          => nil, # use the local timezone
 
-      'quiet'         => false,
-      'verbose'       => false,
-      'defaults'      => [],
+      "quiet"             => false,
+      "verbose"           => false,
+      "defaults"          => [],
 
-      'rdiscount' => {
-        'extensions' => []
+      "liquid"            => {
+        "error_mode" => "warn"
       },
 
-      'redcarpet' => {
-        'extensions' => []
+      "rdiscount"         => {
+        "extensions" => []
       },
 
-      'kramdown' => {
-        'auto_ids'       => true,
-        'toc_levels'     => '1..6',
-        'entity_output'  => 'as_char',
-        'smart_quotes'   => 'lsquo,rsquo,ldquo,rdquo',
-        'input'          => "GFM",
-        'hard_wrap'      => false,
-        'footnote_nr'    => 1
+      "redcarpet"         => {
+        "extensions" => []
+      },
+
+      "kramdown"          => {
+        "auto_ids"      => true,
+        "toc_levels"    => "1..6",
+        "entity_output" => "as_char",
+        "smart_quotes"  => "lsquo,rsquo,ldquo,rdquo",
+        "input"         => "GFM",
+        "hard_wrap"     => false,
+        "footnote_nr"   => 1
       }
-    }]
+    }.map { |k, v| [k, v.freeze] }].freeze
+
+    class << self
+      # Static: Produce a Configuration ready for use in a Site.
+      # It takes the input, fills in the defaults where values do not
+      # exist, and patches common issues including migrating options for
+      # backwards compatiblity. Except where a key or value is being fixed,
+      # the user configuration will override the defaults.
+      #
+      # user_config - a Hash or Configuration of overrides.
+      #
+      # Returns a Configuration filled with defaults and fixed for common
+      # problems and backwards-compatibility.
+      def from(user_config)
+        Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
+          .fix_common_issues.add_default_collections
+      end
+    end
 
     # Public: Turn all keys into string
     #
@@ -91,28 +112,29 @@ module Bunto
     #
     # Returns the path to the Bunto source directory
     def source(override)
-      get_config_value_with_override('source', override)
+      get_config_value_with_override("source", override)
     end
 
     def quiet(override = {})
-      get_config_value_with_override('quiet', override)
+      get_config_value_with_override("quiet", override)
     end
     alias_method :quiet?, :quiet
 
     def verbose(override = {})
-      get_config_value_with_override('verbose', override)
+      get_config_value_with_override("verbose", override)
     end
     alias_method :verbose?, :verbose
 
     def safe_load_file(filename)
       case File.extname(filename)
-      when /\.toml/i
-        Bunto::External.require_with_graceful_fail('toml') unless defined?(TOML)
+      when %r!\.toml!i
+        Bunto::External.require_with_graceful_fail("toml") unless defined?(TOML)
         TOML.load_file(filename)
-      when /\.ya?ml/i
+      when %r!\.ya?ml!i
         SafeYAML.load_file(filename) || {}
       else
-        raise ArgumentError, "No parser for '#{filename}' is available. Use a .toml or .y(a)ml file instead."
+        raise ArgumentError, "No parser for '#{filename}' is available.
+          Use a .toml or .y(a)ml file instead."
       end
     end
 
@@ -123,12 +145,15 @@ module Bunto
     # Returns an Array of config files
     def config_files(override)
       # Adjust verbosity quickly
-      Bunto.logger.adjust_verbosity(:quiet => quiet?(override), :verbose => verbose?(override))
+      Bunto.logger.adjust_verbosity(
+        :quiet   => quiet?(override),
+        :verbose => verbose?(override)
+      )
 
       # Get configuration from <source>/_config.yml or <source>/<config_file>
-      config_files = override.delete('config')
+      config_files = override.delete("config")
       if config_files.to_s.empty?
-        default = %w(yml yaml).find(-> { 'yml' }) do |ext|
+        default = %w(yml yaml).find(-> { "yml" }) do |ext|
           File.exist?(Bunto.sanitized_path(source(override), "_config.#{ext}"))
         end
         config_files = Bunto.sanitized_path(source(override), "_config.#{default}")
@@ -153,7 +178,8 @@ module Bunto
         Bunto.logger.warn "Configuration file:", "none"
         {}
       else
-        Bunto.logger.error "Fatal:", "The configuration file '#{file}' could not be found."
+        Bunto.logger.error "Fatal:", "The configuration file '#{file}'
+          could not be found."
         raise LoadError, "The Configuration file '#{file}' could not be found."
       end
     end
@@ -169,13 +195,14 @@ module Bunto
 
       begin
         files.each do |config_file|
+          next if config_file.nil? || config_file.empty?
           new_config = read_config_file(config_file)
           configuration = Utils.deep_merge_hashes(configuration, new_config)
         end
       rescue ArgumentError => err
         Bunto.logger.warn "WARNING:", "Error reading configuration. " \
                      "Using defaults (and options)."
-        $stderr.puts "#{err}"
+        $stderr.puts err
       end
 
       configuration.fix_common_issues.backwards_compatibilize.add_default_collections
@@ -197,61 +224,18 @@ module Bunto
     def backwards_compatibilize
       config = clone
       # Provide backwards-compatibility
-      if config.key?('auto') || config.key?('watch')
-        Bunto::Deprecator.deprecation_message "Auto-regeneration can no longer" \
-                            " be set from your configuration file(s). Use the"\
-                            " --[no-]watch/-w command-line option instead."
-        config.delete('auto')
-        config.delete('watch')
-      end
-
-      if config.key? 'server'
-        Bunto::Deprecator.deprecation_message "The 'server' configuration option" \
-                            " is no longer accepted. Use the 'bunto serve'" \
-                            " subcommand to serve your site with WEBrick."
-        config.delete('server')
-      end
+      check_auto(config)
+      check_server(config)
 
-      renamed_key 'server_port', 'port', config
-      renamed_key 'plugins', 'plugins_dir', config
-      renamed_key 'layouts', 'layouts_dir', config
-      renamed_key 'data_source', 'data_dir', config
+      renamed_key "server_port", "port", config
+      renamed_key "plugins", "plugins_dir", config
+      renamed_key "layouts", "layouts_dir", config
+      renamed_key "data_source", "data_dir", config
 
-      if config.key? 'pygments'
-        Bunto::Deprecator.deprecation_message "The 'pygments' configuration option" \
-                            " has been renamed to 'highlighter'. Please update your" \
-                            " config file accordingly. The allowed values are 'rouge', " \
-                            "'pygments' or null."
-
-        config['highlighter'] = 'pygments' if config['pygments']
-        config.delete('pygments')
-      end
-
-      %w(include exclude).each do |option|
-        config[option] ||= []
-        if config[option].is_a?(String)
-          Bunto::Deprecator.deprecation_message "The '#{option}' configuration option" \
-            " must now be specified as an array, but you specified" \
-            " a string. For now, we've treated the string you provided" \
-            " as a list of comma-separated values."
-          config[option] = csv_to_array(config[option])
-        end
-        config[option].map!(&:to_s)
-      end
-
-      if (config['kramdown'] || {}).key?('use_coderay')
-        Bunto::Deprecator.deprecation_message "Please change 'use_coderay'" \
-          " to 'enable_coderay' in your configuration file."
-        config['kramdown']['use_coderay'] = config['kramdown'].delete('enable_coderay')
-      end
-
-      if config.fetch('markdown', 'kramdown').to_s.downcase.eql?("maruku")
-        Bunto.logger.abort_with "Error:", "You're using the 'maruku' " \
-          "Markdown processor, which has been removed as of 3.0.0. " \
-          "We recommend you switch to Kramdown. To do this, replace " \
-          "`markdown: maruku` with `markdown: kramdown` in your " \
-          "`_config.yml` file."
-      end
+      check_pygments(config)
+      check_include_exclude(config)
+      check_coderay(config)
+      check_maruku(config)
 
       config
     end
@@ -259,10 +243,12 @@ module Bunto
     def fix_common_issues
       config = clone
 
-      if config.key?('paginate') && (!config['paginate'].is_a?(Integer) || config['paginate'] < 1)
-        Bunto.logger.warn "Config Warning:", "The `paginate` key must be a" \
-          " positive integer or nil. It's currently set to '#{config['paginate'].inspect}'."
-        config['paginate'] = nil
+      if config.key?("paginate") && (!config["paginate"].is_a?(Integer) ||
+             config["paginate"] < 1)
+
+        Bunto.logger.warn "Config Warning:", "The `paginate` key must be a positive" \
+          " integer or nil. It's currently set to '#{config["paginate"].inspect}'."
+        config["paginate"] = nil
       end
 
       config
@@ -271,14 +257,22 @@ module Bunto
     def add_default_collections
       config = clone
 
-      return config if config['collections'].nil?
+      # It defaults to `{}`, so this is only if someone sets it to null manually.
+      return config if config["collections"].nil?
 
-      if config['collections'].is_a?(Array)
-        config['collections'] = Hash[config['collections'].map { |c| [c, {}] }]
+      # Ensure we have a hash.
+      if config["collections"].is_a?(Array)
+        config["collections"] = Hash[config["collections"].map { |c| [c, {}] }]
+      end
+
+      config["collections"] = Utils.deep_merge_hashes(
+        { "posts" => {} }, config["collections"]
+      ).tap do |collections|
+        collections["posts"]["output"] = true
+        if config["permalink"]
+          collections["posts"]["permalink"] ||= style_to_permalink(config["permalink"])
+        end
       end
-      config['collections']['posts'] ||= {}
-      config['collections']['posts']['output'] = true
-      config['collections']['posts']['permalink'] = style_to_permalink(config['permalink'])
 
       config
     end
@@ -293,7 +287,6 @@ module Bunto
     end
 
     private
-
     def style_to_permalink(permalink_style)
       case permalink_style.to_sym
       when :pretty
@@ -315,9 +308,78 @@ module Bunto
     # file - the file from which the config was extracted
     #
     # Raises an ArgumentError if given config is not a hash
+    private
     def check_config_is_hash!(extracted_config, file)
       unless extracted_config.is_a?(Hash)
-        raise ArgumentError.new("Configuration file: (INVALID) #{file}".yellow)
+        raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
+      end
+    end
+
+    private
+    def check_auto(config)
+      if config.key?("auto") || config.key?("watch")
+        Bunto::Deprecator.deprecation_message "Auto-regeneration can no longer" \
+                            " be set from your configuration file(s). Use the" \
+                            " --[no-]watch/-w command-line option instead."
+        config.delete("auto")
+        config.delete("watch")
+      end
+    end
+
+    private
+    def check_server(config)
+      if config.key?("server")
+        Bunto::Deprecator.deprecation_message "The 'server' configuration option" \
+                            " is no longer accepted. Use the 'bunto serve'" \
+                            " subcommand to serve your site with WEBrick."
+        config.delete("server")
+      end
+    end
+
+    private
+    def check_pygments(config)
+      if config.key?("pygments")
+        Bunto::Deprecator.deprecation_message "The 'pygments' configuration option" \
+                            " has been renamed to 'highlighter'. Please update your" \
+                            " config file accordingly. The allowed values are 'rouge', " \
+                            "'pygments' or null."
+
+        config["highlighter"] = "pygments" if config["pygments"]
+        config.delete("pygments")
+      end
+    end
+
+    private
+    def check_include_exclude(config)
+      %w(include exclude).each do |option|
+        if config[option].is_a?(String)
+          Bunto::Deprecator.deprecation_message "The '#{option}' configuration option" \
+            " must now be specified as an array, but you specified" \
+            " a string. For now, we've treated the string you provided" \
+            " as a list of comma-separated values."
+          config[option] = csv_to_array(config[option])
+        end
+        config[option].map!(&:to_s) if config[option]
+      end
+    end
+
+    private
+    def check_coderay(config)
+      if (config["kramdown"] || {}).key?("use_coderay")
+        Bunto::Deprecator.deprecation_message "Please change 'use_coderay'" \
+          " to 'enable_coderay' in your configuration file."
+        config["kramdown"]["use_coderay"] = config["kramdown"].delete("enable_coderay")
+      end
+    end
+
+    private
+    def check_maruku(config)
+      if config.fetch("markdown", "kramdown").to_s.casecmp("maruku").zero?
+        Bunto.logger.abort_with "Error:", "You're using the 'maruku' " \
+          "Markdown processor, which has been removed as of 3.0.0. " \
+          "We recommend you switch to Kramdown. To do this, replace " \
+          "`markdown: maruku` with `markdown: kramdown` in your " \
+          "`_config.yml` file."
       end
     end
   end