bunto 3.0.0 → 3.2.1

data/lib/bunto/cleaner.rb

@@ -1,9 +1,9 @@
-require 'set'
+require "set"
 
 module Bunto
   # Handles the cleanup of a site's destination before it is built.
   class Cleaner
-    HIDDEN_FILE_REGEX = /\/\.{1,2}$/
+    HIDDEN_FILE_REGEX = %r!\/\.{1,2}$!
     attr_reader :site
 
     def initialize(site)
@@ -32,7 +32,8 @@ module Bunto
       [site.regenerator.metadata_file]
     end
 
-    # Private: The list of existing files, apart from those included in keep_files and hidden files.
+    # Private: The list of existing files, apart from those included in
+    # keep_files and hidden files.
     #
     # Returns a Set with the file paths
     def existing_files
@@ -77,15 +78,16 @@ module Bunto
       end
     end
 
-    # Private: The list of existing files that will be replaced by a directory during build
+    # Private: The list of existing files that will be replaced by a directory
+    # during build
     #
     # Returns a Set with the file paths
     def replaced_files
       new_dirs.select { |dir| File.file?(dir) }.to_set
     end
 
-    # Private: The list of directories that need to be kept because they are parent directories
-    # of files specified in keep_files
+    # Private: The list of directories that need to be kept because they are
+    # parent directories of files specified in keep_files
     #
     # Returns a Set with the directory paths
     def keep_dirs
@@ -95,12 +97,12 @@ module Bunto
     # Private: Creates a regular expression from the config's keep_files array
     #
     # Examples
-    #   ['.git','.svn'] with site.dest "/myblog/_site" creates 
+    #   ['.git','.svn'] with site.dest "/myblog/_site" creates
     #   the following regex: /\A\/myblog\/_site\/(\.git|\/.svn)/
     #
     # Returns the regular expression
     def keep_file_regex
-      /\A#{Regexp.quote(site.dest)}\/(#{Regexp.union(site.keep_files).source})/
+      %r!\A#{Regexp.quote(site.dest)}\/(#{Regexp.union(site.keep_files).source})!
     end
   end
 end

data/lib/bunto/collection.rb

@@ -25,14 +25,15 @@ module Bunto
 
     # Override of normal respond_to? to match method_missing's logic for
     # looking in @data.
-    def respond_to?(method, include_private = false)
+    def respond_to_missing?(method, include_private = false)
       docs.respond_to?(method.to_sym, include_private) || super
     end
 
     # Override of method_missing to check in @data for the key.
     def method_missing(method, *args, &blck)
       if docs.respond_to?(method.to_sym)
-        Bunto.logger.warn "Deprecation:", "#{label}.#{method} should be changed to #{label}.docs.#{method}."
+        Bunto.logger.warn "Deprecation:", "#{label}.#{method} should be changed to" \
+          "#{label}.docs.#{method}."
         Bunto.logger.warn "", "Called by #{caller.first}."
         docs.public_send(method.to_sym, *args, &blck)
       else
@@ -56,16 +57,9 @@ module Bunto
         full_path = collection_dir(file_path)
         next if File.directory?(full_path)
         if Utils.has_yaml_header? full_path
-          doc = Bunto::Document.new(full_path, { :site => site, :collection => self })
-          doc.read
-          if site.publisher.publish?(doc) || !write?
-            docs << doc
-          else
-            Bunto.logger.debug "Skipped From Publishing:", doc.relative_path
-          end
+          read_document(full_path)
         else
-          relative_dir = Bunto.sanitized_path(relative_directory, File.dirname(file_path)).chomp("/.")
-          files << StaticFile.new(site, site.source, relative_dir, File.basename(full_path), self)
+          read_static_file(file_path, full_path)
         end
       end
       docs.sort!
@@ -79,7 +73,7 @@ module Bunto
       return [] unless exists?
       @entries ||=
         Utils.safe_glob(collection_dir, ["**", "*"]).map do |entry|
-          entry["#{collection_dir}/"] = ''
+          entry["#{collection_dir}/"] = ""
           entry
         end
     end
@@ -161,7 +155,7 @@ module Bunto
     #
     # Returns a sanitized version of the label.
     def sanitize_label(label)
-      label.gsub(/[^a-z0-9_\-\.]/i, '')
+      label.gsub(%r![^a-z0-9_\-\.]!i, "")
     end
 
     # Produce a representation of this Collection for use in Liquid.
@@ -179,14 +173,14 @@ module Bunto
     #
     # Returns true if the 'write' metadata is true, false otherwise.
     def write?
-      !!metadata.fetch('output', false)
+      !!metadata.fetch("output", false)
     end
 
     # The URL template to render collection's documents at.
     #
     # Returns the URL template to render collection's documents at.
     def url_template
-      @url_template ||= metadata.fetch('permalink') do
+      @url_template ||= metadata.fetch("permalink") do
         Utils.add_permalink_suffix("/:collection/:path", site.permalink_style)
       end
     end
@@ -195,11 +189,33 @@ module Bunto
     #
     # Returns the metadata for this collection
     def extract_metadata
-      if site.config['collections'].is_a?(Hash)
-        site.config['collections'][label] || {}
+      if site.config["collections"].is_a?(Hash)
+        site.config["collections"][label] || {}
       else
         {}
       end
     end
+
+    private
+    def read_document(full_path)
+      doc = Bunto::Document.new(full_path, :site => site, :collection => self)
+      doc.read
+      if site.publisher.publish?(doc) || !write?
+        docs << doc
+      else
+        Bunto.logger.debug "Skipped From Publishing:", doc.relative_path
+      end
+    end
+
+    private
+    def read_static_file(file_path, full_path)
+      relative_dir = Bunto.sanitized_path(
+        relative_directory,
+        File.dirname(file_path)
+      ).chomp("/.")
+
+      files << StaticFile.new(site, site.source, relative_dir,
+        File.basename(full_path), self)
+    end
   end
 end

data/lib/bunto/command.rb

@@ -46,19 +46,25 @@ module Bunto
       #
       # Returns nothing
       def add_build_options(c)
-        c.option 'config',  '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
-        c.option 'destination', '-d', '--destination DESTINATION', 'The current folder will be generated into DESTINATION'
-        c.option 'source', '-s', '--source SOURCE', 'Custom source directory'
-        c.option 'future',  '--future', 'Publishes posts with a future date'
-        c.option 'limit_posts', '--limit_posts MAX_POSTS', Integer, 'Limits the number of posts to parse and publish'
-        c.option 'watch',   '-w', '--[no-]watch', 'Watch for changes and rebuild'
-        c.option 'force_polling', '--force_polling', 'Force watch to use polling'
-        c.option 'lsi',     '--lsi', 'Use LSI for improved related posts'
-        c.option 'show_drafts',  '-D', '--drafts', 'Render posts in the _drafts folder'
-        c.option 'unpublished', '--unpublished', 'Render posts that were marked as unpublished'
-        c.option 'quiet',   '-q', '--quiet', 'Silence output.'
-        c.option 'verbose', '-V', '--verbose', 'Print verbose output.'
-        c.option 'incremental', '-I', '--incremental', 'Enable incremental rebuild.'
+        c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]",
+          Array, "Custom configuration file"
+        c.option "destination", "-d", "--destination DESTINATION",
+          "The current folder will be generated into DESTINATION"
+        c.option "source", "-s", "--source SOURCE", "Custom source directory"
+        c.option "future", "--future", "Publishes posts with a future date"
+        c.option "limit_posts", "--limit_posts MAX_POSTS", Integer,
+          "Limits the number of posts to parse and publish"
+        c.option "watch", "-w", "--[no-]watch", "Watch for changes and rebuild"
+        c.option "baseurl", "-b", "--baseurl URL",
+          "Serve the website from the given base URL"
+        c.option "force_polling", "--force_polling", "Force watch to use polling"
+        c.option "lsi", "--lsi", "Use LSI for improved related posts"
+        c.option "show_drafts", "-D", "--drafts", "Render posts in the _drafts folder"
+        c.option "unpublished", "--unpublished",
+          "Render posts that were marked as unpublished"
+        c.option "quiet", "-q", "--quiet", "Silence output."
+        c.option "verbose", "-V", "--verbose", "Print verbose output."
+        c.option "incremental", "-I", "--incremental", "Enable incremental rebuild."
       end
     end
   end

data/lib/bunto/commands/build.rb

@@ -5,8 +5,8 @@ module Bunto
         # Create the Mercenary command for the Bunto CLI for this Command
         def init_with_program(prog)
           prog.command(:build) do |c|
-            c.syntax      'build [options]'
-            c.description 'Build your site'
+            c.syntax      "build [options]"
+            c.description "Build your site"
             c.alias :b
 
             add_build_options(c)
@@ -27,15 +27,17 @@ module Bunto
           options = configuration_from_options(options)
           site = Bunto::Site.new(options)
 
-          if options.fetch('skip_initial_build', false)
-            Bunto.logger.warn "Build Warning:", "Skipping the initial build. This may result in an out-of-date site."
+          if options.fetch("skip_initial_build", false)
+            Bunto.logger.warn "Build Warning:", "Skipping the initial build." \
+                        " This may result in an out-of-date site."
           else
             build(site, options)
           end
 
-          if options.fetch('detach', false)
-            Bunto.logger.info "Auto-regeneration:", "disabled when running server detached."
-          elsif options.fetch('watch', false)
+          if options.fetch("detach", false)
+            Bunto.logger.info "Auto-regeneration:",
+              "disabled when running server detached."
+          elsif options.fetch("watch", false)
             watch(site, options)
           else
             Bunto.logger.info "Auto-regeneration:", "disabled. Use --watch to enable."
@@ -50,12 +52,13 @@ module Bunto
         # Returns nothing.
         def build(site, options)
           t = Time.now
-          source      = options['source']
-          destination = options['destination']
-          incremental = options['incremental']
+          source      = options["source"]
+          destination = options["destination"]
+          incremental = options["incremental"]
           Bunto.logger.info "Source:", source
           Bunto.logger.info "Destination:", destination
-          Bunto.logger.info "Incremental build:", (incremental ? "enabled" : "disabled. Enable with --incremental")
+          Bunto.logger.info "Incremental build:",
+            (incremental ? "enabled" : "disabled. Enable with --incremental")
           Bunto.logger.info "Generating..."
           process_site(site)
           Bunto.logger.info "", "done in #{(Time.now - t).round(3)} seconds."
@@ -67,9 +70,14 @@ module Bunto
         # options - A Hash of options passed to the command
         #
         # Returns nothing.
-        def watch(_site, options)
-          External.require_with_graceful_fail 'bunto-watch'
-          Bunto::Watcher.watch(options)
+        def watch(site, options)
+          External.require_with_graceful_fail "bunto-watch"
+          watch_method = Bunto::Watcher.method(:watch)
+          if watch_method.parameters.size == 1
+            watch_method.call(options)
+          else
+            watch_method.call(options, site)
+          end
         end
       end # end of class << self
     end

data/lib/bunto/commands/clean.rb

@@ -4,8 +4,9 @@ module Bunto
       class << self
         def init_with_program(prog)
           prog.command(:clean) do |c|
-            c.syntax 'clean [subcommand]'
-            c.description 'Clean the site (removes site output and metadata file) without building.'
+            c.syntax "clean [subcommand]"
+            c.description "Clean the site " \
+                  "(removes site output and metadata file) without building."
 
             add_build_options(c)
 
@@ -17,13 +18,13 @@ module Bunto
 
         def process(options)
           options = configuration_from_options(options)
-          destination = options['destination']
-          metadata_file = File.join(options['source'], '.bunto-metadata')
-          sass_cache = File.join(options['source'], '.sass-cache')
+          destination = options["destination"]
+          metadata_file = File.join(options["source"], ".bunto-metadata")
+          sass_cache = File.join(options["source"], ".sass-cache")
 
-          remove(destination, checker_func: :directory?)
-          remove(metadata_file, checker_func: :file?)
-          remove(sass_cache, checker_func: :directory?)
+          remove(destination, :checker_func => :directory?)
+          remove(metadata_file, :checker_func => :file?)
+          remove(sass_cache, :checker_func => :directory?)
         end
 
         def remove(filename, checker_func: :file?)

data/lib/bunto/commands/doctor.rb

@@ -4,11 +4,12 @@ module Bunto
       class << self
         def init_with_program(prog)
           prog.command(:doctor) do |c|
-            c.syntax 'doctor'
-            c.description 'Search site and print specific deprecation warnings'
+            c.syntax "doctor"
+            c.description "Search site and print specific deprecation warnings"
             c.alias(:hyde)
 
-            c.option 'config', '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
+            c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array,
+                            "Custom configuration file"
 
             c.action do |_, options|
               Bunto::Commands::Doctor.process(options)
@@ -18,7 +19,9 @@ module Bunto
 
         def process(options)
           site = Bunto::Site.new(configuration_from_options(options))
+          site.reset
           site.read
+          site.generate
 
           if healthy?(site)
             Bunto.logger.info "Your test results", "are in. Everything looks fine."
@@ -37,7 +40,7 @@ module Bunto
         end
 
         def deprecated_relative_permalinks(site)
-          if site.config['relative_permalinks']
+          if site.config["relative_permalinks"]
             Bunto::Deprecator.deprecation_message "Your site still uses relative" \
                                 " permalinks, which was removed in" \
                                 " Bunto v3.0.0."
@@ -62,7 +65,7 @@ module Bunto
         def fsnotify_buggy?(_site)
           return true unless Utils::Platforms.osx?
           if Dir.pwd != `pwd`.strip
-            Bunto.logger.error "  " + <<-STR.strip.gsub(/\n\s+/, "\n  ")
+            Bunto.logger.error "  " + <<-STR.strip.gsub(%r!\n\s+!, "\n  ")
               We have detected that there might be trouble using fsevent on your
               operating system, you can read https://github.com/thibaudgg/rb-fsevent/wiki/no-fsevents-fired-(OSX-bug)
               for possible work arounds or you can work around it immediately
@@ -78,7 +81,7 @@ module Bunto
         def urls_only_differ_by_case(site)
           urls_only_differ_by_case = false
           urls = case_insensitive_urls(site.pages + site.docs_to_write, site.dest)
-          urls.each do |case_insensitive_url, real_urls|
+          urls.each do |_case_insensitive_url, real_urls|
             next unless real_urls.uniq.size > 1
             urls_only_differ_by_case = true
             Bunto.logger.warn "Warning:", "The following URLs only differ" \
@@ -102,10 +105,9 @@ module Bunto
         end
 
         def case_insensitive_urls(things, destination)
-          things.inject({}) do |memo, thing|
+          things.each_with_object({}) do |thing, memo|
             dest = thing.destination(destination)
             (memo[dest.downcase] ||= []) << dest
-            memo
           end
         end
       end

data/lib/bunto/commands/help.rb

@@ -4,8 +4,8 @@ module Bunto
       class << self
         def init_with_program(prog)
           prog.command(:help) do |c|
-            c.syntax 'help [subcommand]'
-            c.description 'Show the help message, optionally for a given subcommand.'
+            c.syntax "help [subcommand]"
+            c.description "Show the help message, optionally for a given subcommand."
 
             c.action do |args, _|
               cmd = (args.first || "").to_sym
@@ -22,7 +22,8 @@ module Bunto
         end
 
         def invalid_command(prog, cmd)
-          Bunto.logger.error "Error:", "Hmm... we don't know what the '#{cmd}' command is."
+          Bunto.logger.error "Error:",
+                "Hmm... we don't know what the '#{cmd}' command is."
           Bunto.logger.info  "Valid commands:", prog.commands.keys.join(", ")
         end
       end

data/lib/bunto/commands/new.rb

@@ -1,4 +1,4 @@
-require 'erb'
+require "erb"
 
 module Bunto
   module Commands
@@ -6,11 +6,11 @@ module Bunto
       class << self
         def init_with_program(prog)
           prog.command(:new) do |c|
-            c.syntax 'new PATH'
-            c.description 'Creates a new Bunto site scaffold in PATH'
+            c.syntax "new PATH"
+            c.description "Creates a new Bunto site scaffold in PATH"
 
-            c.option 'force', '--force', 'Force creation even if PATH already exists'
-            c.option 'blank', '--blank', 'Creates scaffolding but with empty files'
+            c.option "force", "--force", "Force creation even if PATH already exists"
+            c.option "blank", "--blank", "Creates scaffolding but with empty files"
 
             c.action do |args, options|
               Bunto::Commands::New.process(args, options)
@@ -19,26 +19,19 @@ module Bunto
         end
 
         def process(args, options = {})
-          raise ArgumentError.new('You must specify a path.') if args.empty?
+          raise ArgumentError, "You must specify a path." if args.empty?
 
           new_blog_path = File.expand_path(args.join(" "), Dir.pwd)
           FileUtils.mkdir_p new_blog_path
           if preserve_source_location?(new_blog_path, options)
-            Bunto.logger.abort_with "Conflict:", "#{new_blog_path} exists and is not empty."
+            Bunto.logger.abort_with "Conflict:",
+                      "#{new_blog_path} exists and is not empty."
           end
 
           if options["blank"]
             create_blank_site new_blog_path
           else
-            create_sample_files new_blog_path
-
-            File.open(File.expand_path(initialized_post_name, new_blog_path), "w") do |f|
-              f.write(scaffold_post_content)
-            end
-            
-            File.open(File.expand_path("Gemfile", new_blog_path), "w") do |f|
-              f.write(gemfile_contents)
-            end
+            create_site new_blog_path
           end
 
           Bunto.logger.info "New bunto site installed in #{new_blog_path}."
@@ -59,15 +52,16 @@ module Bunto
         #
         # Returns the filename of the sample post, as a String
         def initialized_post_name
-          "_posts/#{Time.now.strftime('%Y-%m-%d')}-welcome-to-bunto.markdown"
+          "_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-bunto.markdown"
         end
 
         private
-        
+
         def gemfile_contents
           <<-RUBY
 source "https://rubygems.org"
-  
+ruby RUBY_VERSION
+
 # Hello! This is where you manage which Bunto version is used to run.
 # When you want to use a different version, change it below, save the
 # file and run `bundle install`. Run Bunto with `bundle exec`, like so:
@@ -78,10 +72,13 @@ source "https://rubygems.org"
 # Happy Buntoing!
 gem "bunto", "#{Bunto::VERSION}"
 
+# This is the default theme for new Bunto sites. You may change this to anything you like.
+gem "minima"
+
 # If you want to use GitHub Pages, remove the "gem "bunto"" above and
 # uncomment the line below. To upgrade, run `bundle update github-pages`.
 # gem "github-pages", group: :bunto_plugins
-  
+
 # If you have any plugins, put them here!
 # group :bunto_plugins do
 #   gem "bunto-github-metadata", "~> 1.0"
@@ -89,12 +86,24 @@ gem "bunto", "#{Bunto::VERSION}"
 RUBY
         end
 
+        def create_site(new_blog_path)
+          create_sample_files new_blog_path
+
+          File.open(File.expand_path(initialized_post_name, new_blog_path), "w") do |f|
+            f.write(scaffold_post_content)
+          end
+
+          File.open(File.expand_path("Gemfile", new_blog_path), "w") do |f|
+            f.write(gemfile_contents)
+          end
+        end
+
         def preserve_source_location?(path, options)
           !options["force"] && !Dir["#{path}/**/*"].empty?
         end
 
         def create_sample_files(path)
-          FileUtils.cp_r site_template + '/.', path
+          FileUtils.cp_r site_template + "/.", path
           FileUtils.rm File.expand_path(scaffold_path, path)
         end