jekyll 3.1.6 → 3.2.0.pre.beta1

data/lib/jekyll/collection.rb

@@ -78,7 +78,7 @@ module Jekyll
     def entries
       return [] unless exists?
       @entries ||=
-        Utils.safe_glob(collection_dir, ["**", "*.*"]).map do |entry|
+        Utils.safe_glob(collection_dir, ["**", "*"]).map do |entry|
           entry["#{collection_dir}/"] = ''
           entry
         end
@@ -94,7 +94,7 @@ module Jekyll
         Dir.chdir(directory) do
           entry_filter.filter(entries).reject do |f|
             path = collection_dir(f)
-            File.directory?(path) || (File.symlink?(f) && site.safe)
+            File.directory?(path) || entry_filter.symlink?(f)
           end
         end
     end
@@ -135,7 +135,7 @@ module Jekyll
     # Returns false if the directory doesn't exist or if it's a symlink
     #   and we're in safe mode.
     def exists?
-      File.directory?(directory) && !(File.symlink?(directory) && site.safe)
+      File.directory?(directory) && !entry_filter.symlink?(directory)
     end
 
     # The entry filter for this collection.

data/lib/jekyll/commands/build.rb

@@ -5,8 +5,8 @@ module Jekyll
         # Create the Mercenary command for the Jekyll 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 Jekyll
           options = configuration_from_options(options)
           site = Jekyll::Site.new(options)
 
-          if options.fetch('skip_initial_build', false)
-            Jekyll.logger.warn "Build Warning:", "Skipping the initial build. This may result in an out-of-date site."
+          if options.fetch("skip_initial_build", false)
+            Jekyll.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)
-            Jekyll.logger.info "Auto-regeneration:", "disabled when running server detached."
-          elsif options.fetch('watch', false)
+          if options.fetch("detach", false)
+            Jekyll.logger.info "Auto-regeneration:",
+              "disabled when running server detached."
+          elsif options.fetch("watch", false)
             watch(site, options)
           else
             Jekyll.logger.info "Auto-regeneration:", "disabled. Use --watch to enable."
@@ -50,12 +52,13 @@ module Jekyll
         # 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"]
           Jekyll.logger.info "Source:", source
           Jekyll.logger.info "Destination:", destination
-          Jekyll.logger.info "Incremental build:", (incremental ? "enabled" : "disabled. Enable with --incremental")
+          Jekyll.logger.info "Incremental build:",
+            (incremental ? "enabled" : "disabled. Enable with --incremental")
           Jekyll.logger.info "Generating..."
           process_site(site)
           Jekyll.logger.info "", "done in #{(Time.now - t).round(3)} seconds."
@@ -68,7 +71,7 @@ module Jekyll
         #
         # Returns nothing.
         def watch(_site, options)
-          External.require_with_graceful_fail 'jekyll-watch'
+          External.require_with_graceful_fail "jekyll-watch"
           Jekyll::Watcher.watch(options)
         end
       end # end of class << self

data/lib/jekyll/commands/clean.rb

@@ -4,8 +4,9 @@ module Jekyll
       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,23 +18,21 @@ module Jekyll
 
         def process(options)
           options = configuration_from_options(options)
-          destination = options['destination']
-          metadata_file = File.join(options['source'], '.jekyll-metadata')
+          destination = options["destination"]
+          metadata_file = File.join(options["source"], ".jekyll-metadata")
+          sass_cache = File.join(options["source"], ".sass-cache")
 
-          if File.directory? destination
-            Jekyll.logger.info "Cleaning #{destination}..."
-            FileUtils.rm_rf(destination)
-            Jekyll.logger.info "", "done."
-          else
-            Jekyll.logger.info "Nothing to do for #{destination}."
-          end
+          remove(destination, :checker_func => :directory?)
+          remove(metadata_file, :checker_func => :file?)
+          remove(sass_cache, :checker_func => :directory?)
+        end
 
-          if File.file? metadata_file
-            Jekyll.logger.info "Removing #{metadata_file}..."
-            FileUtils.rm_rf(metadata_file)
-            Jekyll.logger.info "", "done."
+        def remove(filename, checker_func: :file?)
+          if File.public_send(checker_func, filename)
+            Jekyll.logger.info "Cleaner:", "Removing #{filename}..."
+            FileUtils.rm_rf(filename)
           else
-            Jekyll.logger.info "Nothing to do for #{metadata_file}."
+            Jekyll.logger.info "Cleaner:", "Nothing to do for #{filename}."
           end
         end
       end

data/lib/jekyll/commands/doctor.rb

@@ -4,11 +4,12 @@ module Jekyll
       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_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
+            c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array,
+                            "Custom configuration file"
 
             c.action do |_, options|
               Jekyll::Commands::Doctor.process(options)
@@ -37,7 +38,7 @@ module Jekyll
         end
 
         def deprecated_relative_permalinks(site)
-          if site.config['relative_permalinks']
+          if site.config["relative_permalinks"]
             Jekyll::Deprecator.deprecation_message "Your site still uses relative" \
                                 " permalinks, which was removed in" \
                                 " Jekyll v3.0.0."
@@ -78,7 +79,7 @@ module Jekyll
         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
             Jekyll.logger.warn "Warning:", "The following URLs only differ" \
@@ -102,10 +103,9 @@ module Jekyll
         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/jekyll/commands/help.rb

@@ -4,8 +4,8 @@ module Jekyll
       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 Jekyll
         end
 
         def invalid_command(prog, cmd)
-          Jekyll.logger.error "Error:", "Hmm... we don't know what the '#{cmd}' command is."
+          Jekyll.logger.error "Error:",
+                "Hmm... we don't know what the '#{cmd}' command is."
           Jekyll.logger.info  "Valid commands:", prog.commands.keys.join(", ")
         end
       end

data/lib/jekyll/commands/new.rb

@@ -1,4 +1,4 @@
-require 'erb'
+require "erb"
 
 module Jekyll
   module Commands
@@ -6,11 +6,11 @@ module Jekyll
       class << self
         def init_with_program(prog)
           prog.command(:new) do |c|
-            c.syntax 'new PATH'
-            c.description 'Creates a new Jekyll site scaffold in PATH'
+            c.syntax "new PATH"
+            c.description "Creates a new Jekyll 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|
               Jekyll::Commands::New.process(args, options)
@@ -19,22 +19,19 @@ module Jekyll
         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)
-            Jekyll.logger.abort_with "Conflict:", "#{new_blog_path} exists and is not empty."
+            Jekyll.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
+            create_site new_blog_path
           end
 
           Jekyll.logger.info "New jekyll site installed in #{new_blog_path}."
@@ -55,17 +52,55 @@ module Jekyll
         #
         # Returns the filename of the sample post, as a String
         def initialized_post_name
-          "_posts/#{Time.now.strftime('%Y-%m-%d')}-welcome-to-jekyll.markdown"
+          "_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-jekyll.markdown"
         end
 
         private
 
+        def gemfile_contents
+          <<-RUBY
+source "https://rubygems.org"
+ruby RUBY_VERSION
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "#{Jekyll::VERSION}"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+# group :jekyll_plugins do
+#   gem "jekyll-github-metadata", "~> 1.0"
+# end
+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
 

data/lib/jekyll/commands/new_theme.rb

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

data/lib/jekyll/commands/serve.rb

@@ -3,16 +3,18 @@ module Jekyll
     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"],
+          "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"],
+          "baseurl"            => ["-b", "--baseurl [URL]", "Base URL"],
+          "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
 
         #
 
@@ -91,6 +93,8 @@ module Jekyll
             )
           }
 
+          opts[:DirectoryIndex] = [] if opts[:JekyllOptions]["show_dir_listing"]
+
           enable_ssl(opts)
           enable_logging(opts)
           opts
@@ -103,7 +107,7 @@ module Jekyll
           WEBrick::Config::FileHandler.merge({
             :FancyIndexing     => true,
             :NondisclosureName => [
-              '.ht*', '~*'
+              ".ht*", "~*"
             ]
           })
         end
@@ -112,27 +116,24 @@ module Jekyll
 
         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
 
         #
 
         private
         def launch_browser(server, opts)
-          command =
-            if Utils::Platforms.windows?
-              "start"
-            elsif Utils::Platforms.osx?
-              "open"
-            else
-              "xdg-open"
-            end
-          system command, server_address(server, opts)
+          address = server_address(server, opts)
+          return system "start", address if Utils::Platforms.windows?
+          return system "xdg-open", address if Utils::Platforms.linux?
+          return system "open", address if Utils::Platforms.osx?
+          Jekyll.logger.error "Refusing to launch browser; " \
+            "Platform launcher unknown."
         end
 
         # Keep in our area with a thread or detach the server as requested
@@ -170,22 +171,27 @@ module Jekyll
         # forget to add one of the certificates.
 
         private
+        # rubocop:disable Metrics/AbcSize
         def enable_ssl(opts)
           return if !opts[:JekyllOptions]["ssl_cert"] && !opts[:JekyllOptions]["ssl_key"]
           if !opts[:JekyllOptions]["ssl_cert"] || !opts[:JekyllOptions]["ssl_key"]
+            # rubocop:disable Style/RedundantException
             raise RuntimeError, "--ssl-cert or --ssl-key missing."
           end
-
           require "openssl"
           require "webrick/https"
-          source_key = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_key" ])
-          source_certificate = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_cert"])
-          opts[:SSLCertificate] = OpenSSL::X509::Certificate.new(File.read(source_certificate))
+          source_key = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], \
+                    opts[:JekyllOptions]["ssl_key" ])
+          source_certificate = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], \
+                    opts[:JekyllOptions]["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
@@ -196,7 +202,7 @@ module Jekyll
 
         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