jekyll 3.9.3 → 4.4.1

data/lib/jekyll/commands/build.rb

@@ -15,7 +15,7 @@ module Jekyll
 
             c.action do |_, options|
               options["serving"] = false
-              Jekyll::Commands::Build.process(options)
+              process_with_graceful_fail(c, options, self)
             end
           end
         end
@@ -30,15 +30,15 @@ module Jekyll
           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."
+            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."
+                               "disabled when running server detached."
           elsif options.fetch("watch", false)
             watch(site, options)
           else
@@ -54,13 +54,13 @@ module Jekyll
         # Returns nothing.
         def build(site, options)
           t = Time.now
-          source      = options["source"]
-          destination = options["destination"]
+          source      = File.expand_path(options["source"])
+          destination = File.expand_path(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")
+                             (incremental ? "enabled" : "disabled. Enable with --incremental")
           Jekyll.logger.info "Generating..."
           process_site(site)
           Jekyll.logger.info "", "done in #{(Time.now - t).round(3)} seconds."
@@ -73,28 +73,8 @@ module Jekyll
         #
         # Returns nothing.
         def watch(site, options)
-          # Warn Windows users that they might need to upgrade.
-          if Utils::Platforms.bash_on_windows?
-            Jekyll.logger.warn "",
-              "Auto-regeneration may not work on some Windows versions."
-            Jekyll.logger.warn "",
-              "Please see: https://github.com/Microsoft/BashOnWindows/issues/216"
-            Jekyll.logger.warn "",
-              "If it does not work, please upgrade Bash on Windows or "\
-                "run Jekyll with --no-watch."
-          end
-
           External.require_with_graceful_fail "jekyll-watch"
-          watch_method = Jekyll::Watcher.method(:watch)
-          if watch_method.parameters.size == 1
-            watch_method.call(
-              options
-            )
-          else
-            watch_method.call(
-              options, site
-            )
-          end
+          Jekyll::Watcher.watch(options, site)
         end
       end
     end

data/lib/jekyll/commands/clean.rb

@@ -7,8 +7,7 @@ module Jekyll
         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.description "Clean the site (removes site output and metadata file) without building."
 
             add_build_options(c)
 
@@ -22,10 +21,12 @@ module Jekyll
           options = configuration_from_options(options)
           destination = options["destination"]
           metadata_file = File.join(options["source"], ".jekyll-metadata")
+          cache_dir = File.join(options["source"], options["cache_dir"])
           sass_cache = ".sass-cache"
 
           remove(destination, :checker_func => :directory?)
           remove(metadata_file, :checker_func => :file?)
+          remove(cache_dir, :checker_func => :directory?)
           remove(sass_cache, :checker_func => :directory?)
         end
 

data/lib/jekyll/commands/doctor.rb

@@ -11,7 +11,7 @@ module Jekyll
             c.alias(:hyde)
 
             c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array,
-                            "Custom configuration file"
+                     "Custom configuration file"
 
             c.action do |_, options|
               Jekyll::Commands::Doctor.process(options)
@@ -45,46 +45,50 @@ module Jekyll
 
         def properly_gathered_posts?(site)
           return true if site.config["collections_dir"].empty?
+
           posts_at_root = site.in_source_dir("_posts")
           return true unless File.directory?(posts_at_root)
+
           Jekyll.logger.warn "Warning:",
-            "Detected '_posts' directory outside custom `collections_dir`!"
+                             "Detected '_posts' directory outside custom `collections_dir`!"
           Jekyll.logger.warn "",
-            "Please move '#{posts_at_root}' into the custom directory at " \
-            "'#{site.in_source_dir(site.config["collections_dir"])}'"
+                             "Please move '#{posts_at_root}' into the custom directory at " \
+                             "'#{site.in_source_dir(site.config["collections_dir"])}'"
           false
         end
 
         def deprecated_relative_permalinks(site)
           if site.config["relative_permalinks"]
-            Jekyll::Deprecator.deprecation_message "Your site still uses relative" \
-                                " permalinks, which was removed in" \
-                                " Jekyll v3.0.0."
-            return true
+            Jekyll::Deprecator.deprecation_message "Your site still uses relative permalinks, " \
+                                                   "which was removed in Jekyll v3.0.0."
+            true
           end
         end
 
         def conflicting_urls(site)
           conflicting_urls = false
-          urls = {}
-          urls = collect_urls(urls, site.pages, site.dest)
-          urls = collect_urls(urls, site.posts.docs, site.dest)
-          urls.each do |url, paths|
+          destination_map(site).each do |dest, paths|
             next unless paths.size > 1
+
             conflicting_urls = true
-            Jekyll.logger.warn "Conflict:", "The URL '#{url}' is the destination" \
-              " for the following pages: #{paths.join(", ")}"
+            Jekyll.logger.warn "Conflict:",
+                               "The following destination is shared by multiple files."
+            Jekyll.logger.warn "", "The written file may end up with unexpected contents."
+            Jekyll.logger.warn "", dest.to_s.cyan
+            paths.each { |path| Jekyll.logger.warn "", " - #{path}" }
+            Jekyll.logger.warn ""
           end
           conflicting_urls
         end
 
         def fsnotify_buggy?(_site)
           return true unless Utils::Platforms.osx?
+
           if Dir.pwd != `pwd`.strip
-            Jekyll.logger.error "  " + <<-STR.strip.gsub(%r!\n\s+!, "\n  ")
+            Jekyll.logger.error <<~STR
               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
+              for possible workarounds or you can work around it immediately
               with `--force-polling`.
             STR
 
@@ -99,10 +103,11 @@ module Jekyll
           urls = case_insensitive_urls(site.pages + site.docs_to_write, site.dest)
           urls.each_value do |real_urls|
             next unless real_urls.uniq.size > 1
+
             urls_only_differ_by_case = true
-            Jekyll.logger.warn "Warning:", "The following URLs only differ" \
-              " by case. On a case-insensitive file system one of the URLs" \
-              " will be overwritten by the other: #{real_urls.join(", ")}"
+            Jekyll.logger.warn "Warning:", "The following URLs only differ by case. On a " \
+                                           "case-insensitive file system one of the URLs will be " \
+                                           "overwritten by the other: #{real_urls.join(", ")}"
           end
           urls_only_differ_by_case
         end
@@ -117,16 +122,20 @@ module Jekyll
         end
 
         private
-        def collect_urls(urls, things, destination)
-          things.each do |thing|
-            dest = thing.destination(destination)
-            if urls[dest]
-              urls[dest] << thing.path
-            else
-              urls[dest] = [thing.path]
+
+        def destination_map(site)
+          {}.tap do |result|
+            site.each_site_file do |thing|
+              next if allow_used_permalink?(thing)
+
+              dest_path = thing.destination(site.dest)
+              (result[dest_path] ||= []) << thing.path
             end
           end
-          urls
+        end
+
+        def allow_used_permalink?(item)
+          defined?(JekyllRedirectFrom) && item.is_a?(JekyllRedirectFrom::RedirectPage)
         end
 
         def case_insensitive_urls(things, destination)
@@ -138,8 +147,9 @@ module Jekyll
 
         def url_exists?(url)
           return true unless url.nil? || url.empty?
-          Jekyll.logger.warn "Warning:", "You didn't set an URL in the config file, "\
-              "you may encounter problems with some plugins."
+
+          Jekyll.logger.warn "Warning:", "You didn't set an URL in the config file, you may " \
+                                         "encounter problems with some plugins."
           false
         end
 
@@ -147,17 +157,18 @@ module Jekyll
           Addressable::URI.parse(url)
           true
         # Addressable::URI#parse only raises a TypeError
-        # https://git.io/vFfbx
+        # https://github.com/sporkmonger/addressable/blob/0a0e96acb17225f9b1c9cab0bad332b448934c9a/lib/addressable/uri.rb#L103
         rescue TypeError
-          Jekyll.logger.warn "Warning:", "The site URL does not seem to be valid, "\
-              "check the value of `url` in your config file."
+          Jekyll.logger.warn "Warning:", "The site URL does not seem to be valid, " \
+                                         "check the value of `url` in your config file."
           false
         end
 
         def url_absolute(url)
-          return true if Addressable::URI.parse(url).absolute?
-          Jekyll.logger.warn "Warning:", "Your site URL does not seem to be absolute, "\
-              "check the value of `url` in your config file."
+          return true if url.is_a?(String) && Addressable::URI.parse(url).absolute?
+
+          Jekyll.logger.warn "Warning:", "Your site URL does not seem to be absolute, " \
+                                         "check the value of `url` in your config file."
           false
         end
       end

data/lib/jekyll/commands/help.rb

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

@@ -28,8 +28,8 @@ module Jekyll
           FileUtils.mkdir_p new_blog_path
           if preserve_source_location?(new_blog_path, options)
             Jekyll.logger.error "Conflict:", "#{new_blog_path} exists and is not empty."
-            Jekyll.logger.abort_with "", "Ensure #{new_blog_path} is empty or else " \
-                      "try again with `--force` to proceed and overwrite any files."
+            Jekyll.logger.abort_with "", "Ensure #{new_blog_path} is empty or else try again " \
+                                         "with `--force` to proceed and overwrite any files."
           end
 
           if options["blank"]
@@ -41,10 +41,16 @@ module Jekyll
           after_install(new_blog_path, options)
         end
 
+        def blank_template
+          File.expand_path("../../blank_template", __dir__)
+        end
+
         def create_blank_site(path)
+          FileUtils.cp_r blank_template + "/.", path
+          FileUtils.chmod_R "u+w", path
+
           Dir.chdir(path) do
-            FileUtils.mkdir(%w(_layouts _posts _drafts))
-            FileUtils.touch("index.html")
+            FileUtils.mkdir(%w(_data _drafts _includes _posts))
           end
         end
 
@@ -62,61 +68,49 @@ module Jekyll
         private
 
         def gemfile_contents
-          <<-RUBY
-source "https://rubygems.org"
-
-# 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}"
-
-# This is the default theme for new Jekyll sites. You may change this to anything you like.
-gem "minima", "~> 2.0"
-
-# 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-feed", "~> 0.6"
-end
-
-# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
-# and associated library.
-platforms :mingw, :x64_mingw, :mswin, :jruby do
-  gem "tzinfo", ">= 1", "< 3"
-  gem "tzinfo-data"
-end
+          <<~RUBY
+            source "https://rubygems.org"
+            # 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}"
+            # This is the default theme for new Jekyll sites. You may change this to anything you like.
+            gem "minima", "~> 2.5"
+            # 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-feed", "~> 0.12"
+            end
 
-# Performance-booster for watching directories on Windows
-gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
+            # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+            # and associated library.
+            platforms :mingw, :x64_mingw, :mswin, :jruby do
+              gem "tzinfo", ">= 1", "< 3"
+              gem "tzinfo-data"
+            end
 
-# kramdown v2 ships without the gfm parser by default. If you're using
-# kramdown v1, comment out this line.
-gem "kramdown-parser-gfm"
+            # Performance-booster for watching directories on Windows
+            gem "wdm", "~> 0.1", :platforms => [:mingw, :x64_mingw, :mswin]
 
-# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
-# do not have a Java counterpart.
-gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
-RUBY
+            # Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+            # do not have a Java counterpart.
+            gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+          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.write(File.expand_path(initialized_post_name, new_blog_path), scaffold_post_content)
 
-          File.open(File.expand_path("Gemfile", new_blog_path), "w") do |f|
-            f.write(gemfile_contents)
-          end
+          File.write(File.expand_path("Gemfile", new_blog_path), gemfile_contents)
         end
 
         def preserve_source_location?(path, options)

data/lib/jekyll/commands/new_theme.rb

@@ -2,39 +2,38 @@
 
 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.option "code_of_conduct", \
-          "-c", "--code-of-conduct", \
-          "Include a Code of Conduct. (defaults to false)"
+module Jekyll
+  module Commands
+    class 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.option "code_of_conduct", "-c", "--code-of-conduct",
+                     "Include a Code of Conduct. (defaults to false)"
 
-        c.action do |args, opts|
-          Jekyll::Commands::NewTheme.process(args, opts)
+            c.action do |args, opts|
+              Jekyll::Commands::NewTheme.process(args, opts)
+            end
+          end
         end
-      end
-    end
 
-    # rubocop:disable Metrics/AbcSize
-    def process(args, opts)
-      if !args || args.empty?
-        raise Jekyll::Errors::InvalidThemeName, "You must specify a theme name."
-      end
+        def process(args, opts)
+          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, opts)
-      if theme.path.exist?
-        Jekyll.logger.abort_with "Conflict:", "#{theme.path} already exists."
-      end
+          new_theme_name = args.join("_")
+          theme = Jekyll::ThemeBuilder.new(new_theme_name, opts)
+          Jekyll.logger.abort_with "Conflict:", "#{theme.path} already exists." if theme.path.exist?
 
-      theme.create!
-      Jekyll.logger.info "Your new Jekyll theme, #{theme.name.cyan}," \
-        " is ready for you in #{theme.path.to_s.cyan}!"
-      Jekyll.logger.info "For help getting started, read #{theme.path}/README.md."
+          theme.create!
+          Jekyll.logger.info "Your new Jekyll theme, #{theme.name.cyan}, " \
+                             "is ready for you in #{theme.path.to_s.cyan}!"
+          Jekyll.logger.info "For help getting started, read #{theme.path}/README.md."
+        end
+      end
     end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/jekyll/commands/serve/live_reload_reactor.rb

@@ -8,9 +8,7 @@ module Jekyll
   module Commands
     class Serve
       class LiveReloadReactor
-        attr_reader :started_event
-        attr_reader :stopped_event
-        attr_reader :thread
+        attr_reader :started_event, :stopped_event, :thread
 
         def initialize
           @websockets = []
@@ -58,7 +56,7 @@ module Jekyll
               EM.add_shutdown_hook { @stopped_event.set }
 
               Jekyll.logger.info "LiveReload address:",
-                "http://#{opts["host"]}:#{opts["livereload_port"]}"
+                                 "http://#{opts["host"]}:#{opts["livereload_port"]}"
             end
           end
           @thread.abort_on_exception = true
@@ -68,19 +66,19 @@ module Jekyll
         # http://feedback.livereload.com/knowledgebase/articles/86174-livereload-protocol
         def reload(pages)
           pages.each do |p|
-            json_message = JSON.dump({
+            json_message = JSON.dump(
               :command => "reload",
               :path    => p.url,
-              :liveCSS => true,
-            })
+              :liveCSS => true
+            )
 
-            Jekyll.logger.debug "LiveReload:", "Reloading #{p.url}"
-            Jekyll.logger.debug "", json_message
+            Jekyll.logger.debug "LiveReload:", "Reloading URL #{p.url.inspect}"
             @websockets.each { |ws| ws.send(json_message) }
           end
         end
 
         private
+
         def connect(websocket, handshake)
           @connections_count += 1
           if @connections_count == 1
@@ -99,25 +97,20 @@ module Jekyll
           @websockets << websocket
         end
 
-        private
         def disconnect(websocket)
           @websockets.delete(websocket)
         end
 
-        private
         def print_message(json_message)
           msg = JSON.parse(json_message)
           # Not sure what the 'url' command even does in LiveReload.  The spec is silent
           # on its purpose.
-          if msg["command"] == "url"
-            Jekyll.logger.info "LiveReload:", "Browser URL: #{msg["url"]}"
-          end
+          Jekyll.logger.info "LiveReload:", "Browser URL: #{msg["url"]}" if msg["command"] == "url"
         end
 
-        private
         def log_error(error)
           Jekyll.logger.error "LiveReload experienced an error. " \
-            "Run with --trace for more information."
+                              "Run with --trace for more information."
           raise error
         end
       end

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

@@ -29,21 +29,21 @@ module Jekyll
         end
 
         def inline?
-          @response["Content-Disposition"] =~ %r!^inline!
+          @response["Content-Disposition"].to_s.start_with?("inline")
         end
 
         def bad_browser?
-          BAD_USER_AGENTS.any? { |pattern| @request["User-Agent"] =~ pattern }
+          BAD_USER_AGENTS.any? { |pattern| pattern.match?(@request["User-Agent"]) }
         end
 
         def html?
-          @response["Content-Type"] =~ %r!text/html!
+          @response["Content-Type"].to_s.include?("text/html")
         end
       end
 
       # This class inserts the LiveReload script tags into HTML as it is served
       class BodyProcessor
-        HEAD_TAG_REGEX = %r!<head>|<head[^(er)][^<]*>!
+        HEAD_TAG_REGEX = %r!<head>|<head[^(er)][^<]*>!.freeze
 
         attr_reader :content_length, :new_body, :livereload_added
 
@@ -98,17 +98,16 @@ module Jekyll
           # Complicated JavaScript to ensure that livereload.js is loaded from the
           # same origin as the page.  Mostly useful for dealing with the browser's
           # distinction between 'localhost' and 127.0.0.1
-          template = <<-TEMPLATE
-          <script>
-            document.write(
-              '<script src="http://' +
-              (location.host || 'localhost').split(':')[0] +
-              ':<%=@options["livereload_port"] %>/livereload.js?snipver=1<%= livereload_args %>"' +
-              '></' +
-              'script>');
-          </script>
+          @template ||= ERB.new(<<~TEMPLATE)
+            <script>
+              document.write(
+                '<script src="' + location.protocol + '//' +
+                (location.host || 'localhost').split(':')[0] +
+                ':<%=@options["livereload_port"] %>/livereload.js?snipver=1<%= livereload_args %>"' +
+                '></' +
+                'script>');
+            </script>
           TEMPLATE
-          ERB.new(Jekyll::Utils.strip_heredoc(template))
         end
 
         def livereload_args
@@ -121,9 +120,7 @@ module Jekyll
           if @options["livereload_max_delay"]
             src += "&amp;maxdelay=#{@options["livereload_max_delay"]}"
           end
-          if @options["livereload_port"]
-            src += "&amp;port=#{@options["livereload_port"]}"
-          end
+          src += "&amp;port=#{@options["livereload_port"]}" if @options["livereload_port"]
           src
         end
       end
@@ -131,7 +128,7 @@ module Jekyll
       class Servlet < WEBrick::HTTPServlet::FileHandler
         DEFAULTS = {
           "Cache-Control" => "private, max-age=0, proxy-revalidate, " \
-            "no-store, no-cache, must-revalidate",
+                             "no-store, no-cache, must-revalidate",
         }.freeze
 
         def initialize(server, root, callbacks)
@@ -143,7 +140,9 @@ module Jekyll
         end
 
         def search_index_file(req, res)
-          super || search_file(req, res, ".html")
+          super ||
+            search_file(req, res, ".html") ||
+            search_file(req, res, ".xhtml")
         end
 
         # Add the ability to tap file.html the same way that Nginx does on our
@@ -152,7 +151,9 @@ module Jekyll
 
         def search_file(req, res, basename)
           # /file.* > /file/index.html > /file.html
-          super || super(req, res, "#{basename}.html")
+          super ||
+            super(req, res, "#{basename}.html") ||
+            super(req, res, "#{basename}.xhtml")
         end
 
         # rubocop:disable Naming/MethodName
@@ -181,7 +182,6 @@ module Jekyll
 
         private
 
-        #
         # Inject charset based on Jekyll config only if our mime-types database contains
         # the charset metadata.
         #
@@ -194,7 +194,6 @@ module Jekyll
           res.header["content-type"] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
         end
 
-        #
         def set_defaults
           hash_ = @jekyll_opts.fetch("webrick", {}).fetch("headers", {})
           DEFAULTS.each_with_object(@headers = hash_) do |(key, val), hash|

data/lib/jekyll/commands/serve/websockets.rb

@@ -46,7 +46,7 @@ module Jekyll
           # WebSockets requests will have a Connection: Upgrade header
           if parser.http_method != "GET" || parser.upgrade?
             super
-          elsif parser.request_url =~ %r!^\/livereload.js!
+          elsif parser.request_url.start_with?("/livereload.js")
             headers = [
               "HTTP/1.1 200 OK",
               "Content-Type: application/javascript",