RubyGems - jekyll - Versions diffs - 4.0.1 → 4.2.1 - Mend

jekyll 4.0.1 → 4.2.1

Files changed (124) hide show

checksums.yaml +4 -4
data/.rubocop.yml +350 -163
data/LICENSE +21 -21
data/README.markdown +86 -90
data/exe/jekyll +57 -57
data/lib/blank_template/_config.yml +3 -3
data/lib/blank_template/_layouts/default.html +12 -12
data/lib/blank_template/_sass/main.scss +9 -9
data/lib/blank_template/assets/css/main.scss +4 -4
data/lib/blank_template/index.md +8 -8
data/lib/jekyll/cache.rb +190 -190
data/lib/jekyll/cleaner.rb +111 -111
data/lib/jekyll/collection.rb +309 -309
data/lib/jekyll/command.rb +105 -103
data/lib/jekyll/commands/build.rb +93 -93
data/lib/jekyll/commands/clean.rb +45 -45
data/lib/jekyll/commands/doctor.rb +177 -173
data/lib/jekyll/commands/help.rb +34 -34
data/lib/jekyll/commands/new.rb +169 -169
data/lib/jekyll/commands/new_theme.rb +40 -42
data/lib/jekyll/commands/serve/live_reload_reactor.rb +122 -122
data/lib/jekyll/commands/serve/livereload_assets/livereload.js +1183 -1183
data/lib/jekyll/commands/serve/servlet.rb +202 -202
data/lib/jekyll/commands/serve/websockets.rb +81 -81
data/lib/jekyll/commands/serve.rb +362 -354
data/lib/jekyll/configuration.rb +313 -316
data/lib/jekyll/converter.rb +54 -54
data/lib/jekyll/converters/identity.rb +41 -41
data/lib/jekyll/converters/markdown/kramdown_parser.rb +199 -130
data/lib/jekyll/converters/markdown.rb +113 -113
data/lib/jekyll/converters/smartypants.rb +70 -70
data/lib/jekyll/convertible.rb +257 -254
data/lib/jekyll/deprecator.rb +50 -50
data/lib/jekyll/document.rb +544 -522
data/lib/jekyll/drops/collection_drop.rb +20 -20
data/lib/jekyll/drops/document_drop.rb +70 -69
data/lib/jekyll/drops/drop.rb +293 -215
data/lib/jekyll/drops/excerpt_drop.rb +19 -19
data/lib/jekyll/drops/jekyll_drop.rb +32 -32
data/lib/jekyll/drops/site_drop.rb +66 -66
data/lib/jekyll/drops/static_file_drop.rb +14 -14
data/lib/jekyll/drops/unified_payload_drop.rb +26 -26
data/lib/jekyll/drops/url_drop.rb +140 -132
data/lib/jekyll/entry_filter.rb +121 -110
data/lib/jekyll/errors.rb +20 -20
data/lib/jekyll/excerpt.rb +201 -201
data/lib/jekyll/external.rb +79 -79
data/lib/jekyll/filters/date_filters.rb +110 -110
data/lib/jekyll/filters/grouping_filters.rb +64 -64
data/lib/jekyll/filters/url_filters.rb +98 -68
data/lib/jekyll/filters.rb +535 -454
data/lib/jekyll/frontmatter_defaults.rb +240 -245
data/lib/jekyll/generator.rb +5 -5
data/lib/jekyll/hooks.rb +107 -106
data/lib/jekyll/inclusion.rb +32 -0
data/lib/jekyll/layout.rb +67 -62
data/lib/jekyll/liquid_extensions.rb +22 -22
data/lib/jekyll/liquid_renderer/file.rb +77 -77
data/lib/jekyll/liquid_renderer/table.rb +55 -75
data/lib/jekyll/liquid_renderer.rb +80 -77
data/lib/jekyll/log_adapter.rb +151 -151
data/lib/jekyll/mime.types +866 -866
data/lib/jekyll/page.rb +217 -186
data/lib/jekyll/page_excerpt.rb +25 -0
data/lib/jekyll/page_without_a_file.rb +14 -14
data/lib/jekyll/path_manager.rb +74 -31
data/lib/jekyll/plugin.rb +92 -92
data/lib/jekyll/plugin_manager.rb +115 -115
data/lib/jekyll/profiler.rb +58 -0
data/lib/jekyll/publisher.rb +23 -23
data/lib/jekyll/reader.rb +192 -187
data/lib/jekyll/readers/collection_reader.rb +23 -22
data/lib/jekyll/readers/data_reader.rb +79 -75
data/lib/jekyll/readers/layout_reader.rb +62 -61
data/lib/jekyll/readers/page_reader.rb +25 -24
data/lib/jekyll/readers/post_reader.rb +85 -84
data/lib/jekyll/readers/static_file_reader.rb +25 -24
data/lib/jekyll/readers/theme_assets_reader.rb +52 -51
data/lib/jekyll/regenerator.rb +195 -195
data/lib/jekyll/related_posts.rb +52 -52
data/lib/jekyll/renderer.rb +265 -267
data/lib/jekyll/site.rb +551 -527
data/lib/jekyll/static_file.rb +208 -203
data/lib/jekyll/stevenson.rb +60 -60
data/lib/jekyll/tags/highlight.rb +110 -110
data/lib/jekyll/tags/include.rb +275 -221
data/lib/jekyll/tags/link.rb +42 -41
data/lib/jekyll/tags/post_url.rb +106 -107
data/lib/jekyll/theme.rb +86 -80
data/lib/jekyll/theme_builder.rb +121 -121
data/lib/jekyll/url.rb +167 -164
data/lib/jekyll/utils/ansi.rb +57 -57
data/lib/jekyll/utils/exec.rb +26 -26
data/lib/jekyll/utils/internet.rb +37 -37
data/lib/jekyll/utils/platforms.rb +67 -82
data/lib/jekyll/utils/thread_event.rb +31 -31
data/lib/jekyll/utils/win_tz.rb +75 -75
data/lib/jekyll/utils.rb +367 -367
data/lib/jekyll/version.rb +5 -5
data/lib/jekyll.rb +195 -206
data/lib/site_template/.gitignore +5 -5
data/lib/site_template/404.html +25 -25
data/lib/site_template/_config.yml +55 -55
data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +29 -29
data/lib/site_template/about.markdown +18 -18
data/lib/site_template/index.markdown +6 -6
data/lib/theme_template/CODE_OF_CONDUCT.md.erb +74 -74
data/lib/theme_template/Gemfile +4 -4
data/lib/theme_template/LICENSE.txt.erb +21 -21
data/lib/theme_template/README.md.erb +52 -52
data/lib/theme_template/_layouts/default.html +1 -1
data/lib/theme_template/_layouts/page.html +5 -5
data/lib/theme_template/_layouts/post.html +5 -5
data/lib/theme_template/example/_config.yml.erb +1 -1
data/lib/theme_template/example/_post.md +12 -12
data/lib/theme_template/example/index.html +14 -14
data/lib/theme_template/example/style.scss +7 -7
data/lib/theme_template/gitignore.erb +6 -6
data/lib/theme_template/theme.gemspec.erb +16 -19
data/rubocop/jekyll/assert_equal_literal_actual.rb +149 -149
data/rubocop/jekyll/no_p_allowed.rb +23 -23
data/rubocop/jekyll/no_puts_allowed.rb +23 -23
data/rubocop/jekyll.rb +5 -5
metadata +20 -38

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

@@ -1,202 +1,202 @@
-# frozen_string_literal: true
-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"].to_s.start_with?("inline")
-        end
-        def bad_browser?
-          BAD_USER_AGENTS.any? { |pattern| pattern.match?(@request["User-Agent"]) }
-        end
-        def 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)][^<]*>!.freeze
-        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
-        # rubocop:enable Metrics/MethodLength
-        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 ||= ERB.new(<<~TEMPLATE)
-            <script>
-              document.write(
-                '<script src="http://' +
-                (location.host || 'localhost').split(':')[0] +
-                ':<%=@options["livereload_port"] %>/livereload.js?snipver=1<%= livereload_args %>"' +
-                '></' +
-                'script>');
-            </script>
-          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
-          src += "&amp;port=#{@options["livereload_port"]}" if @options["livereload_port"]
-          src
-        end
-      end
-      class Servlet < WEBrick::HTTPServlet::FileHandler
-        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.
-          @jekyll_opts = server.config[:JekyllOptions]
-          set_defaults
-          super
-        end
-        def search_index_file(req, res)
-          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
-        # 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, "#{basename}.html") ||
-            super(req, res, "#{basename}.xhtml")
-        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
-        end
-        # rubocop:enable Naming/MethodName
-        private
-        def validate_and_ensure_charset(_req, res)
-          key = res.header.keys.grep(%r!content-type!i).first
-          typ = res.header[key]
-          unless %r!;\s*charset=!.match?(typ)
-            res.header[key] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
-          end
-        end
-        def set_defaults
-          hash_ = @jekyll_opts.fetch("webrick", {}).fetch("headers", {})
-          DEFAULTS.each_with_object(@headers = hash_) do |(key, val), hash|
-            hash[key] = val unless hash.key?(key)
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+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"].to_s.start_with?("inline")
+        end
+        def bad_browser?
+          BAD_USER_AGENTS.any? { |pattern| pattern.match?(@request["User-Agent"]) }
+        end
+        def 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)][^<]*>!.freeze
+        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
+        # rubocop:enable Metrics/MethodLength
+        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 ||= ERB.new(<<~TEMPLATE)
+            <script>
+              document.write(
+                '<script src="http://' +
+                (location.host || 'localhost').split(':')[0] +
+                ':<%=@options["livereload_port"] %>/livereload.js?snipver=1<%= livereload_args %>"' +
+                '></' +
+                'script>');
+            </script>
+          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
+          src += "&amp;port=#{@options["livereload_port"]}" if @options["livereload_port"]
+          src
+        end
+      end
+      class Servlet < WEBrick::HTTPServlet::FileHandler
+        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.
+          @jekyll_opts = server.config[:JekyllOptions]
+          set_defaults
+          super
+        end
+        def search_index_file(req, res)
+          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
+        # 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, "#{basename}.html") ||
+            super(req, res, "#{basename}.xhtml")
+        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
+        end
+        # rubocop:enable Naming/MethodName
+        private
+        def validate_and_ensure_charset(_req, res)
+          key = res.header.keys.grep(%r!content-type!i).first
+          typ = res.header[key]
+          unless %r!;\s*charset=!.match?(typ)
+            res.header[key] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
+          end
+        end
+        def set_defaults
+          hash_ = @jekyll_opts.fetch("webrick", {}).fetch("headers", {})
+          DEFAULTS.each_with_object(@headers = hash_) do |(key, val), hash|
+            hash[key] = val unless hash.key?(key)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,81 +1,81 @@
-# 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.start_with?("/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
-        # rubocop:enable Metrics/MethodLength
-      end
-    end
-  end
-end
+# 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.start_with?("/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
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end