RubyGems - jekyll - Versions diffs - 3.6.3 → 3.7.0 - Mend

jekyll 3.6.3 → 3.7.0

Potentially problematic release.

This version of jekyll might be problematic. Click here for more details.

Files changed (42) hide show

checksums.yaml +4 -4
data/.rubocop.yml +0 -9
data/LICENSE +1 -1
data/README.markdown +1 -1
data/lib/jekyll.rb +3 -0
data/lib/jekyll/cleaner.rb +3 -1
data/lib/jekyll/collection.rb +7 -3
data/lib/jekyll/commands/clean.rb +1 -1
data/lib/jekyll/commands/doctor.rb +3 -1
data/lib/jekyll/commands/new.rb +5 -2
data/lib/jekyll/commands/serve.rb +183 -41
data/lib/jekyll/commands/serve/live_reload_reactor.rb +127 -0
data/lib/jekyll/commands/serve/livereload_assets/livereload.js +1183 -0
data/lib/jekyll/commands/serve/servlet.rb +142 -1
data/lib/jekyll/commands/serve/websockets.rb +80 -0
data/lib/jekyll/configuration.rb +9 -17
data/lib/jekyll/converters/markdown.rb +1 -1
data/lib/jekyll/converters/markdown/kramdown_parser.rb +8 -2
data/lib/jekyll/converters/smartypants.rb +14 -2
data/lib/jekyll/convertible.rb +10 -4
data/lib/jekyll/document.rb +2 -2
data/lib/jekyll/entry_filter.rb +3 -6
data/lib/jekyll/filters/url_filters.rb +6 -1
data/lib/jekyll/frontmatter_defaults.rb +18 -3
data/lib/jekyll/hooks.rb +3 -0
data/lib/jekyll/liquid_renderer.rb +8 -6
data/lib/jekyll/page.rb +1 -1
data/lib/jekyll/page_without_a_file.rb +18 -0
data/lib/jekyll/regenerator.rb +1 -1
data/lib/jekyll/renderer.rb +2 -2
data/lib/jekyll/site.rb +1 -3
data/lib/jekyll/tags/highlight.rb +2 -2
data/lib/jekyll/tags/include.rb +1 -1
data/lib/jekyll/tags/post_url.rb +1 -1
data/lib/jekyll/theme.rb +3 -2
data/lib/jekyll/theme_builder.rb +8 -8
data/lib/jekyll/utils.rb +41 -22
data/lib/jekyll/utils/ansi.rb +0 -2
data/lib/jekyll/utils/internet.rb +39 -0
data/lib/jekyll/utils/thread_event.rb +35 -0
data/lib/jekyll/version.rb +1 -1
metadata +41 -7

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

@@ -5,6 +5,128 @@ require "webrick"
 module Jekyll
   module Commands
     class Serve
+      # This class is used to determine if the Servlet should modify a served file
+      # to insert the LiveReload script tags
+      class SkipAnalyzer
+        BAD_USER_AGENTS = [%r!MSIE!].freeze
+        def self.skip_processing?(request, response, options)
+          new(request, response, options).skip_processing?
+        end
+        def initialize(request, response, options)
+          @options = options
+          @request = request
+          @response = response
+        end
+        def skip_processing?
+          !html? || chunked? || inline? || bad_browser?
+        end
+        def chunked?
+          @response["Transfer-Encoding"] == "chunked"
+        end
+        def inline?
+          @response["Content-Disposition"] =~ %r!^inline!
+        end
+        def bad_browser?
+          BAD_USER_AGENTS.any? { |pattern| @request["User-Agent"] =~ pattern }
+        end
+        def html?
+          @response["Content-Type"] =~ %r!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)][^<]*>!
+        attr_reader :content_length, :new_body, :livereload_added
+        def initialize(body, options)
+          @body = body
+          @options = options
+          @processed = false
+        end
+        def processed?
+          @processed
+        end
+        # rubocop:disable Metrics/MethodLength
+        def process!
+          @new_body = []
+          # @body will usually be a File object but Strings occur in rare cases
+          if @body.respond_to?(:each)
+            begin
+              @body.each { |line| @new_body << line.to_s }
+            ensure
+              @body.close
+            end
+          else
+            @new_body = @body.lines
+          end
+          @content_length = 0
+          @livereload_added = false
+          @new_body.each do |line|
+            if !@livereload_added && line["<head"]
+              line.gsub!(HEAD_TAG_REGEX) do |match|
+                %(#{match}#{template.result(binding)})
+              end
+              @livereload_added = true
+            end
+            @content_length += line.bytesize
+            @processed = true
+          end
+          @new_body = @new_body.join
+        end
+        def template
+          # Unclear what "snipver" does. Doc at
+          # https://github.com/livereload/livereload-js states that the recommended
+          # setting is 1.
+          # 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(Jekyll::Utils.strip_heredoc(template))
+        end
+        def livereload_args
+          # XHTML standard requires ampersands to be encoded as entities when in
+          # attributes. See http://stackoverflow.com/a/2190292
+          src = ""
+          if @options["livereload_min_delay"]
+            src += "&amp;mindelay=#{@options["livereload_min_delay"]}"
+          end
+          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
+        end
+      end
       class Servlet < WEBrick::HTTPServlet::FileHandler
         DEFAULTS = {
           "Cache-Control" => "private, max-age=0, proxy-revalidate, " \
@@ -18,18 +140,37 @@ module Jekyll
           super
         end
+        def search_index_file(req, res)
+          super || search_file(req, res, ".html")
+        end
         # Add the ability to tap file.html the same way that Nginx does on our
         # Docker images (or on GitHub Pages.) The difference is that we might end
         # up with a different preference on which comes first.
         def search_file(req, res, basename)
           # /file.* > /file/index.html > /file.html
-          super || super(req, res, ".html") || super(req, res, "#{basename}.html")
+          super || super(req, res, "#{basename}.html")
         end
         # rubocop:disable Naming/MethodName
         def do_GET(req, res)
           rtn = super
+          if @jekyll_opts["livereload"]
+            return rtn if SkipAnalyzer.skip_processing?(req, res, @jekyll_opts)
+            processor = BodyProcessor.new(res.body, @jekyll_opts)
+            processor.process!
+            res.body = processor.new_body
+            res.content_length = processor.content_length.to_s
+            if processor.livereload_added
+              # Add a header to indicate that the page content has been modified
+              res["X-Rack-LiveReload"] = "1"
+            end
+          end
           validate_and_ensure_charset(req, res)
           res.header.merge!(@headers)
           rtn

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+require "http/parser"
+module Jekyll
+  module Commands
+    class Serve
+      # The LiveReload protocol requires the server to serve livereload.js over HTTP
+      # despite the fact that the protocol itself uses WebSockets.  This custom connection
+      # class addresses the dual protocols that the server needs to understand.
+      class HttpAwareConnection < EventMachine::WebSocket::Connection
+        attr_reader :reload_body, :reload_size
+        def initialize(_opts)
+          # If EventMachine SSL support on Windows ever gets better, the code below will
+          # set up the reactor to handle SSL
+          #
+          # @ssl_enabled = opts["ssl_cert"] && opts["ssl_key"]
+          # if @ssl_enabled
+          #   em_opts[:tls_options] = {
+          #   :private_key_file => Jekyll.sanitized_path(opts["source"], opts["ssl_key"]),
+          #   :cert_chain_file  => Jekyll.sanitized_path(opts["source"], opts["ssl_cert"])
+          #   }
+          #   em_opts[:secure] = true
+          # end
+          # This is too noisy even for --verbose, but uncomment if you need it for
+          # a specific WebSockets issue.  Adding ?LR-verbose=true onto the URL will
+          # enable logging on the client side.
+          # em_opts[:debug] = true
+          em_opts = {}
+          super(em_opts)
+          reload_file = File.join(Serve.singleton_class::LIVERELOAD_DIR, "livereload.js")
+          @reload_body = File.read(reload_file)
+          @reload_size = @reload_body.bytesize
+        end
+        # rubocop:disable Metrics/MethodLength
+        def dispatch(data)
+          parser = Http::Parser.new
+          parser << data
+          # WebSockets requests will have a Connection: Upgrade header
+          if parser.http_method != "GET" || parser.upgrade?
+            super
+          elsif parser.request_url =~ %r!^\/livereload.js!
+            headers = [
+              "HTTP/1.1 200 OK",
+              "Content-Type: application/javascript",
+              "Content-Length: #{reload_size}",
+              "",
+              "",
+            ].join("\r\n")
+            send_data(headers)
+            # stream_file_data would free us from keeping livereload.js in memory
+            # but JRuby blocks on that call and never returns
+            send_data(reload_body)
+            close_connection_after_writing
+          else
+            body = "This port only serves livereload.js over HTTP.\n"
+            headers = [
+              "HTTP/1.1 400 Bad Request",
+              "Content-Type: text/plain",
+              "Content-Length: #{body.bytesize}",
+              "",
+              "",
+            ].join("\r\n")
+            send_data(headers)
+            send_data(body)
+            close_connection_after_writing
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/configuration.rb CHANGED

@@ -8,6 +8,7 @@ module Jekyll
       # Where things are
       "source"              => Dir.pwd,
       "destination"         => File.join(Dir.pwd, "_site"),
+      "collections_dir"     => "",
       "plugins_dir"         => "_plugins",
       "layouts_dir"         => "_layouts",
       "data_dir"            => "_data",
@@ -79,6 +80,7 @@ module Jekyll
         "input"         => "GFM",
         "hard_wrap"     => false,
         "footnote_nr"   => 1,
+        "show_warnings" => false,
       },
     }.map { |k, v| [k, v.freeze] }].freeze
@@ -95,7 +97,7 @@ module Jekyll
       # problems and backwards-compatibility.
       def from(user_config)
         Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
-          .fix_common_issues.add_default_collections
+          .add_default_collections
       end
     end
@@ -132,8 +134,8 @@ module Jekyll
     def safe_load_file(filename)
       case File.extname(filename)
       when %r!\.toml!i
-        Jekyll::External.require_with_graceful_fail("toml") unless defined?(TOML)
-        TOML.load_file(filename)
+        Jekyll::External.require_with_graceful_fail("tomlrb") unless defined?(Tomlrb)
+        Tomlrb.load_file(filename)
       when %r!\.ya?ml!i
         SafeYAML.load_file(filename) || {}
       else
@@ -163,8 +165,7 @@ module Jekyll
         config_files = Jekyll.sanitized_path(source(override), "_config.#{default}")
         @default_config_file = true
       end
-      config_files = [config_files] unless config_files.is_a? Array
-      config_files
+      Array(config_files)
     end
     # Public: Read configuration and return merged Hash
@@ -209,7 +210,7 @@ module Jekyll
         warn err
       end
-      configuration.fix_common_issues.backwards_compatibilize.add_default_collections
+      configuration.backwards_compatibilize.add_default_collections
     end
     # Public: Split a CSV string into an array containing its values
@@ -245,18 +246,9 @@ module Jekyll
       config
     end
+    # DEPRECATED.
     def fix_common_issues
-      config = clone
-      if config.key?("paginate") && (!config["paginate"].is_a?(Integer) ||
-             config["paginate"] < 1)
-        Jekyll.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
+      self
     end
     def add_default_collections

data/lib/jekyll/converters/markdown.rb CHANGED

@@ -44,7 +44,7 @@ module Jekyll
       # are not in safe mode.)
       def valid_processors
-        %W(rdiscount kramdown redcarpet) + third_party_processors
+        %w(rdiscount kramdown redcarpet) + third_party_processors
       end
       # Public: A list of processors that you provide via plugins.

data/lib/jekyll/converters/markdown/kramdown_parser.rb CHANGED

@@ -1,5 +1,4 @@
 # Frozen-string-literal: true
-# Encoding: utf-8
 module Jekyll
   module Converters
@@ -38,7 +37,14 @@ module Jekyll
         end
         def convert(content)
-          Kramdown::Document.new(content, @config).to_html
+          document = Kramdown::Document.new(content, @config)
+          html_output = document.to_html
+          if @config["show_warnings"]
+            document.warnings.each do |warning|
+              Jekyll.logger.warn "Kramdown warning:", warning
+            end
+          end
+          html_output
         end
         private

data/lib/jekyll/converters/smartypants.rb CHANGED

@@ -3,9 +3,14 @@
 class Kramdown::Parser::SmartyPants < Kramdown::Parser::Kramdown
   def initialize(source, options)
     super
-    @block_parsers = [:block_html]
+    @block_parsers = [:block_html, :content]
     @span_parsers =  [:smart_quotes, :html_entity, :typographic_syms, :span_html]
   end
+  def parse_content
+    add_text @src.scan(%r!\A.*\n!)
+  end
+  define_parser(:content, %r!\A!)
 end
 module Jekyll
@@ -29,7 +34,14 @@ module Jekyll
       end
       def convert(content)
-        Kramdown::Document.new(content, @config).to_html.chomp
+        document = Kramdown::Document.new(content, @config)
+        html_output = document.to_html.chomp
+        if @config["show_warnings"]
+          document.warnings.each do |warning|
+            Jekyll.logger.warn "Kramdown warning:", warning.sub(%r!^Warning:\s+!, "")
+          end
+        end
+        html_output
       end
     end
   end

data/lib/jekyll/convertible.rb CHANGED

@@ -46,10 +46,10 @@ module Jekyll
           self.content = $POSTMATCH
           self.data = SafeYAML.load(Regexp.last_match(1))
         end
-      rescue SyntaxError => e
+      rescue Psych::SyntaxError => e
         Jekyll.logger.warn "YAML Exception reading #{filename}: #{e.message}"
         raise e if self.site.config["strict_front_matter"]
-      rescue => e
+      rescue StandardError => e
         Jekyll.logger.warn "Error reading file #{filename}: #{e.message}"
         raise e if self.site.config["strict_front_matter"]
       end
@@ -172,9 +172,10 @@ module Jekyll
     # Determine whether the file should be placed into layouts.
     #
-    # Returns false if the document is an asset file.
+    # Returns false if the document is an asset file or if the front matter
+    #   specifies `layout: none`
     def place_in_layout?
-      !asset_file?
+      !(asset_file? || no_layout?)
     end
     # Checks if the layout specified in the document actually exists
@@ -244,8 +245,13 @@ module Jekyll
     end
     private
     def _renderer
       @_renderer ||= Jekyll::Renderer.new(site, self)
     end
+    def no_layout?
+      data["layout"] == "none"
+    end
   end
 end

data/lib/jekyll/document.rb CHANGED

@@ -266,7 +266,7 @@ module Jekyll
           merge_defaults
           read_content(opts)
           read_post_data
-        rescue => e
+        rescue StandardError => e
           handle_read_error(e)
         end
       end
@@ -463,7 +463,7 @@ module Jekyll
     private
     def handle_read_error(error)
-      if error.is_a? SyntaxError
+      if error.is_a? Psych::SyntaxError
         Jekyll.logger.error "Error:", "YAML Exception reading #{path}: #{error.message}"
       else
         Jekyll.logger.error "Error:", "could not read file #{path}: #{error.message}"

data/lib/jekyll/entry_filter.rb CHANGED

@@ -31,12 +31,9 @@ module Jekyll
     def filter(entries)
       entries.reject do |e|
-        # Reject this entry if it is a symlink.
-        next true if symlink?(e)
-        # Do not reject this entry if it is included.
-        next false if included?(e)
-        # Reject this entry if it is special, a backup file, or excluded.
-        special?(e) || backup?(e) || excluded?(e)
+        unless included?(e)
+          special?(e) || backup?(e) || excluded?(e) || symlink?(e)
+        end
       end
     end