jekyll 4.2.1 → 4.3.0

data/lib/jekyll/url.rb

@@ -1,167 +1,167 @@
-# frozen_string_literal: true
-
-# Public: Methods that generate a URL for a resource such as a Post or a Page.
-#
-# Examples
-#
-#   URL.new({
-#     :template => /:categories/:title.html",
-#     :placeholders => {:categories => "ruby", :title => "something"}
-#   }).to_s
-#
-module Jekyll
-  class URL
-    # options - One of :permalink or :template must be supplied.
-    #           :template     - The String used as template for URL generation,
-    #                           for example "/:path/:basename:output_ext", where
-    #                           a placeholder is prefixed with a colon.
-    #           :placeholders - A hash containing the placeholders which will be
-    #                           replaced when used inside the template. E.g.
-    #                           { "year" => Time.now.strftime("%Y") } would replace
-    #                           the placeholder ":year" with the current year.
-    #           :permalink    - If supplied, no URL will be generated from the
-    #                           template. Instead, the given permalink will be
-    #                           used as URL.
-    def initialize(options)
-      @template     = options[:template]
-      @placeholders = options[:placeholders] || {}
-      @permalink    = options[:permalink]
-
-      if (@template || @permalink).nil?
-        raise ArgumentError, "One of :template or :permalink must be supplied."
-      end
-    end
-
-    # The generated relative URL of the resource
-    #
-    # Returns the String URL
-    def to_s
-      sanitize_url(generated_permalink || generated_url)
-    end
-
-    # Generates a URL from the permalink
-    #
-    # Returns the _unsanitized String URL
-    def generated_permalink
-      (@generated_permalink ||= generate_url(@permalink)) if @permalink
-    end
-
-    # Generates a URL from the template
-    #
-    # Returns the unsanitized String URL
-    def generated_url
-      @generated_url ||= generate_url(@template)
-    end
-
-    # Internal: Generate the URL by replacing all placeholders with their
-    # respective values in the given template
-    #
-    # Returns the unsanitized String URL
-    def generate_url(template)
-      if @placeholders.is_a? Drops::UrlDrop
-        generate_url_from_drop(template)
-      else
-        generate_url_from_hash(template)
-      end
-    end
-
-    def generate_url_from_hash(template)
-      @placeholders.inject(template) do |result, token|
-        break result if result.index(":").nil?
-
-        if token.last.nil?
-          # Remove leading "/" to avoid generating urls with `//`
-          result.gsub("/:#{token.first}", "")
-        else
-          result.gsub(":#{token.first}", self.class.escape_path(token.last))
-        end
-      end
-    end
-
-    # We include underscores in keys to allow for 'i_month' and so forth.
-    # This poses a problem for keys which are followed by an underscore
-    # but the underscore is not part of the key, e.g. '/:month_:day'.
-    # That should be :month and :day, but our key extraction regexp isn't
-    # smart enough to know that so we have to make it an explicit
-    # possibility.
-    def possible_keys(key)
-      if key.end_with?("_")
-        [key, key.chomp("_")]
-      else
-        [key]
-      end
-    end
-
-    def generate_url_from_drop(template)
-      template.gsub(%r!:([a-z_]+)!) do |match|
-        name = Regexp.last_match(1)
-        pool = name.end_with?("_") ? [name, name.chomp!("_")] : [name]
-
-        winner = pool.find { |key| @placeholders.key?(key) }
-        if winner.nil?
-          raise NoMethodError,
-                "The URL template doesn't have #{pool.join(" or ")} keys. "\
-                "Check your permalink template!"
-        end
-
-        value = @placeholders[winner]
-        value = "" if value.nil?
-        replacement = self.class.escape_path(value)
-
-        match.sub!(":#{winner}", replacement)
-      end
-    end
-
-    # Returns a sanitized String URL, stripping "../../" and multiples of "/",
-    # as well as the beginning "/" so we can enforce and ensure it.
-    def sanitize_url(str)
-      "/#{str}".gsub("..", "/").tap do |result|
-        result.gsub!("./", "")
-        result.squeeze!("/")
-      end
-    end
-
-    # Escapes a path to be a valid URL path segment
-    #
-    # path - The path to be escaped.
-    #
-    # Examples:
-    #
-    #   URL.escape_path("/a b")
-    #   # => "/a%20b"
-    #
-    # Returns the escaped path.
-    def self.escape_path(path)
-      return path if path.empty? || %r!^[a-zA-Z0-9./-]+$!.match?(path)
-
-      # Because URI.escape doesn't escape "?", "[" and "]" by default,
-      # specify unsafe string (except unreserved, sub-delims, ":", "@" and "/").
-      #
-      # URI path segment is defined in RFC 3986 as follows:
-      #   segment       = *pchar
-      #   pchar         = unreserved / pct-encoded / sub-delims / ":" / "@"
-      #   unreserved    = ALPHA / DIGIT / "-" / "." / "_" / "~"
-      #   pct-encoded   = "%" HEXDIG HEXDIG
-      #   sub-delims    = "!" / "$" / "&" / "'" / "(" / ")"
-      #                 / "*" / "+" / "," / ";" / "="
-      Addressable::URI.encode(path).encode("utf-8").sub("#", "%23")
-    end
-
-    # Unescapes a URL path segment
-    #
-    # path - The path to be unescaped.
-    #
-    # Examples:
-    #
-    #   URL.unescape_path("/a%20b")
-    #   # => "/a b"
-    #
-    # Returns the unescaped path.
-    def self.unescape_path(path)
-      path = path.encode("utf-8")
-      return path unless path.include?("%")
-
-      Addressable::URI.unencode(path)
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Public: Methods that generate a URL for a resource such as a Post or a Page.
+#
+# Examples
+#
+#   URL.new({
+#     :template => /:categories/:title.html",
+#     :placeholders => {:categories => "ruby", :title => "something"}
+#   }).to_s
+#
+module Jekyll
+  class URL
+    # options - One of :permalink or :template must be supplied.
+    #           :template     - The String used as template for URL generation,
+    #                           for example "/:path/:basename:output_ext", where
+    #                           a placeholder is prefixed with a colon.
+    #           :placeholders - A hash containing the placeholders which will be
+    #                           replaced when used inside the template. E.g.
+    #                           { "year" => Time.now.strftime("%Y") } would replace
+    #                           the placeholder ":year" with the current year.
+    #           :permalink    - If supplied, no URL will be generated from the
+    #                           template. Instead, the given permalink will be
+    #                           used as URL.
+    def initialize(options)
+      @template     = options[:template]
+      @placeholders = options[:placeholders] || {}
+      @permalink    = options[:permalink]
+
+      if (@template || @permalink).nil?
+        raise ArgumentError, "One of :template or :permalink must be supplied."
+      end
+    end
+
+    # The generated relative URL of the resource
+    #
+    # Returns the String URL
+    def to_s
+      sanitize_url(generated_permalink || generated_url)
+    end
+
+    # Generates a URL from the permalink
+    #
+    # Returns the _unsanitized String URL
+    def generated_permalink
+      (@generated_permalink ||= generate_url(@permalink)) if @permalink
+    end
+
+    # Generates a URL from the template
+    #
+    # Returns the unsanitized String URL
+    def generated_url
+      @generated_url ||= generate_url(@template)
+    end
+
+    # Internal: Generate the URL by replacing all placeholders with their
+    # respective values in the given template
+    #
+    # Returns the unsanitized String URL
+    def generate_url(template)
+      if @placeholders.is_a? Drops::UrlDrop
+        generate_url_from_drop(template)
+      else
+        generate_url_from_hash(template)
+      end
+    end
+
+    def generate_url_from_hash(template)
+      @placeholders.inject(template) do |result, token|
+        break result if result.index(":").nil?
+
+        if token.last.nil?
+          # Remove leading "/" to avoid generating urls with `//`
+          result.gsub("/:#{token.first}", "")
+        else
+          result.gsub(":#{token.first}", self.class.escape_path(token.last))
+        end
+      end
+    end
+
+    # We include underscores in keys to allow for 'i_month' and so forth.
+    # This poses a problem for keys which are followed by an underscore
+    # but the underscore is not part of the key, e.g. '/:month_:day'.
+    # That should be :month and :day, but our key extraction regexp isn't
+    # smart enough to know that so we have to make it an explicit
+    # possibility.
+    def possible_keys(key)
+      if key.end_with?("_")
+        [key, key.chomp("_")]
+      else
+        [key]
+      end
+    end
+
+    def generate_url_from_drop(template)
+      template.gsub(%r!:([a-z_]+)!) do |match|
+        name = Regexp.last_match(1)
+        pool = name.end_with?("_") ? [name, name.chomp!("_")] : [name]
+
+        winner = pool.find { |key| @placeholders.key?(key) }
+        if winner.nil?
+          raise NoMethodError,
+                "The URL template doesn't have #{pool.join(" or ")} keys. " \
+                "Check your permalink template!"
+        end
+
+        value = @placeholders[winner]
+        value = "" if value.nil?
+        replacement = self.class.escape_path(value)
+
+        match.sub!(":#{winner}", replacement)
+      end
+    end
+
+    # Returns a sanitized String URL, stripping "../../" and multiples of "/",
+    # as well as the beginning "/" so we can enforce and ensure it.
+    def sanitize_url(str)
+      "/#{str}".gsub("..", "/").tap do |result|
+        result.gsub!("./", "")
+        result.squeeze!("/")
+      end
+    end
+
+    # Escapes a path to be a valid URL path segment
+    #
+    # path - The path to be escaped.
+    #
+    # Examples:
+    #
+    #   URL.escape_path("/a b")
+    #   # => "/a%20b"
+    #
+    # Returns the escaped path.
+    def self.escape_path(path)
+      return path if path.empty? || %r!^[a-zA-Z0-9./-]+$!.match?(path)
+
+      # Because URI.escape doesn't escape "?", "[" and "]" by default,
+      # specify unsafe string (except unreserved, sub-delims, ":", "@" and "/").
+      #
+      # URI path segment is defined in RFC 3986 as follows:
+      #   segment       = *pchar
+      #   pchar         = unreserved / pct-encoded / sub-delims / ":" / "@"
+      #   unreserved    = ALPHA / DIGIT / "-" / "." / "_" / "~"
+      #   pct-encoded   = "%" HEXDIG HEXDIG
+      #   sub-delims    = "!" / "$" / "&" / "'" / "(" / ")"
+      #                 / "*" / "+" / "," / ";" / "="
+      Addressable::URI.encode(path).encode("utf-8").sub("#", "%23")
+    end
+
+    # Unescapes a URL path segment
+    #
+    # path - The path to be unescaped.
+    #
+    # Examples:
+    #
+    #   URL.unescape_path("/a%20b")
+    #   # => "/a b"
+    #
+    # Returns the unescaped path.
+    def self.unescape_path(path)
+      path = path.encode("utf-8")
+      return path unless path.include?("%")
+
+      Addressable::URI.unencode(path)
+    end
+  end
+end

data/lib/jekyll/utils/ansi.rb

@@ -1,57 +1,57 @@
-# Frozen-string-literal: true
-
-module Jekyll
-  module Utils
-    module Ansi
-      extend self
-
-      ESCAPE = format("%c", 27)
-      MATCH = %r!#{ESCAPE}\[(?:\d+)(?:;\d+)*(j|k|m|s|u|A|B|G)|\e\(B\e\[m!ix.freeze
-      COLORS = {
-        :red     => 31,
-        :green   => 32,
-        :black   => 30,
-        :magenta => 35,
-        :yellow  => 33,
-        :white   => 37,
-        :blue    => 34,
-        :cyan    => 36,
-      }.freeze
-
-      # Strip ANSI from the current string.  It also strips cursor stuff,
-      # well some of it, and it also strips some other stuff that a lot of
-      # the other ANSI strippers don't.
-
-      def strip(str)
-        str.gsub MATCH, ""
-      end
-
-      #
-
-      def has?(str)
-        !!(str =~ MATCH)
-      end
-
-      # Reset the color back to the default color so that you do not leak any
-      # colors when you move onto the next line. This is probably normally
-      # used as part of a wrapper so that we don't leak colors.
-
-      def reset(str = "")
-        @ansi_reset ||= format("%c[0m", 27)
-        "#{@ansi_reset}#{str}"
-      end
-
-      # SEE: `self::COLORS` for a list of methods.  They are mostly
-      # standard base colors supported by pretty much any xterm-color, we do
-      # not need more than the base colors so we do not include them.
-      # Actually... if I'm honest we don't even need most of the
-      # base colors.
-
-      COLORS.each do |color, num|
-        define_method color do |str|
-          "#{format("%c", 27)}[#{num}m#{str}#{reset}"
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module Utils
+    module Ansi
+      extend self
+
+      ESCAPE = format("%c", 27)
+      MATCH = %r!#{ESCAPE}\[(?:\d+)(?:;\d+)*(j|k|m|s|u|A|B|G)|\e\(B\e\[m!ix.freeze
+      COLORS = {
+        :red     => 31,
+        :green   => 32,
+        :black   => 30,
+        :magenta => 35,
+        :yellow  => 33,
+        :white   => 37,
+        :blue    => 34,
+        :cyan    => 36,
+      }.freeze
+
+      # Strip ANSI from the current string.  It also strips cursor stuff,
+      # well some of it, and it also strips some other stuff that a lot of
+      # the other ANSI strippers don't.
+
+      def strip(str)
+        str.gsub MATCH, ""
+      end
+
+      #
+
+      def has?(str)
+        !!(str =~ MATCH)
+      end
+
+      # Reset the color back to the default color so that you do not leak any
+      # colors when you move onto the next line. This is probably normally
+      # used as part of a wrapper so that we don't leak colors.
+
+      def reset(str = "")
+        @ansi_reset ||= format("%c[0m", 27)
+        "#{@ansi_reset}#{str}"
+      end
+
+      # SEE: `self::COLORS` for a list of methods.  They are mostly
+      # standard base colors supported by pretty much any xterm-color, we do
+      # not need more than the base colors so we do not include them.
+      # Actually... if I'm honest we don't even need most of the
+      # base colors.
+
+      COLORS.each do |color, num|
+        define_method color do |str|
+          "#{format("%c", 27)}[#{num}m#{str}#{reset}"
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/utils/exec.rb

@@ -1,26 +1,26 @@
-# frozen_string_literal: true
-
-require "open3"
-
-module Jekyll
-  module Utils
-    module Exec
-      extend self
-
-      # Runs a program in a sub-shell.
-      #
-      # *args - a list of strings containing the program name and arguments
-      #
-      # Returns a Process::Status and a String of output in an array in
-      # that order.
-      def run(*args)
-        stdin, stdout, stderr, process = Open3.popen3(*args)
-        out = stdout.read.strip
-        err = stderr.read.strip
-
-        [stdin, stdout, stderr].each(&:close)
-        [process.value, out + err]
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "open3"
+
+module Jekyll
+  module Utils
+    module Exec
+      extend self
+
+      # Runs a program in a sub-shell.
+      #
+      # *args - a list of strings containing the program name and arguments
+      #
+      # Returns a Process::Status and a String of output in an array in
+      # that order.
+      def run(*args)
+        stdin, stdout, stderr, process = Open3.popen3(*args)
+        out = stdout.read.strip
+        err = stderr.read.strip
+
+        [stdin, stdout, stderr].each(&:close)
+        [process.value, out + err]
+      end
+    end
+  end
+end

data/lib/jekyll/utils/internet.rb

@@ -1,37 +1,37 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Utils
-    module Internet
-      # Public: Determine whether the present device has a connection to
-      # the Internet. This allows plugin writers which require the outside
-      # world to have a neat fallback mechanism for offline building.
-      #
-      # Example:
-      #   if Internet.connected?
-      #     Typhoeus.get("https://pages.github.com/versions.json")
-      #   else
-      #     Jekyll.logger.warn "Warning:", "Version check has been disabled."
-      #     Jekyll.logger.warn "", "Connect to the Internet to enable it."
-      #     nil
-      #   end
-      #
-      # Returns true if a DNS call can successfully be made, or false if not.
-
-      module_function
-
-      def connected?
-        !dns("example.com").nil?
-      end
-
-      def dns(domain)
-        require "resolv"
-        Resolv::DNS.open do |resolver|
-          resolver.getaddress(domain)
-        end
-      rescue Resolv::ResolvError, Resolv::ResolvTimeout
-        nil
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module Utils
+    module Internet
+      # Public: Determine whether the present device has a connection to
+      # the Internet. This allows plugin writers which require the outside
+      # world to have a neat fallback mechanism for offline building.
+      #
+      # Example:
+      #   if Internet.connected?
+      #     Typhoeus.get("https://pages.github.com/versions.json")
+      #   else
+      #     Jekyll.logger.warn "Warning:", "Version check has been disabled."
+      #     Jekyll.logger.warn "", "Connect to the Internet to enable it."
+      #     nil
+      #   end
+      #
+      # Returns true if a DNS call can successfully be made, or false if not.
+
+      module_function
+
+      def connected?
+        !dns("example.com").nil?
+      end
+
+      def dns(domain)
+        require "resolv"
+        Resolv::DNS.open do |resolver|
+          resolver.getaddress(domain)
+        end
+      rescue Resolv::ResolvError, Resolv::ResolvTimeout
+        nil
+      end
+    end
+  end
+end