jekyll-docs 3.6.0 → 3.6.1

data/lib/jekyll/utils.rb

@@ -0,0 +1,337 @@
+
+# frozen_string_literal: true
+
+module Jekyll
+  module Utils
+    extend self
+    autoload :Ansi, "jekyll/utils/ansi"
+    autoload :Exec, "jekyll/utils/exec"
+    autoload :Platforms, "jekyll/utils/platforms"
+    autoload :Rouge, "jekyll/utils/rouge"
+    autoload :WinTZ, "jekyll/utils/win_tz"
+
+    # Constants for use in #slugify
+    SLUGIFY_MODES = %w(raw default pretty ascii).freeze
+    SLUGIFY_RAW_REGEXP = Regexp.new('\\s+').freeze
+    SLUGIFY_DEFAULT_REGEXP = Regexp.new("[^[:alnum:]]+").freeze
+    SLUGIFY_PRETTY_REGEXP = Regexp.new("[^[:alnum:]._~!$&'()+,;=@]+").freeze
+    SLUGIFY_ASCII_REGEXP = Regexp.new("[^[A-Za-z0-9]]+").freeze
+
+    # Takes an indented string and removes the preceding spaces on each line
+
+    def strip_heredoc(str)
+      str.gsub(%r!^[ \t]{#{(str.scan(%r!^[ \t]*(?=\S)!).min || "").size}}!, "")
+    end
+
+    # Takes a slug and turns it into a simple title.
+
+    def titleize_slug(slug)
+      slug.split("-").map!(&:capitalize).join(" ")
+    end
+
+    # Non-destructive version of deep_merge_hashes! See that method.
+    #
+    # Returns the merged hashes.
+    def deep_merge_hashes(master_hash, other_hash)
+      deep_merge_hashes!(master_hash.dup, other_hash)
+    end
+
+    # Merges a master hash with another hash, recursively.
+    #
+    # master_hash - the "parent" hash whose values will be overridden
+    # other_hash  - the other hash whose values will be persisted after the merge
+    #
+    # This code was lovingly stolen from some random gem:
+    # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+    #
+    # Thanks to whoever made it.
+    def deep_merge_hashes!(target, overwrite)
+      merge_values(target, overwrite)
+      merge_default_proc(target, overwrite)
+      duplicate_frozen_values(target)
+
+      target
+    end
+
+    def mergable?(value)
+      value.is_a?(Hash) || value.is_a?(Drops::Drop)
+    end
+
+    def duplicable?(obj)
+      case obj
+      when nil, false, true, Symbol, Numeric
+        false
+      else
+        true
+      end
+    end
+
+    # Read array from the supplied hash favouring the singular key
+    # and then the plural key, and handling any nil entries.
+    #
+    # hash - the hash to read from
+    # singular_key - the singular key
+    # plural_key - the plural key
+    #
+    # Returns an array
+    def pluralized_array_from_hash(hash, singular_key, plural_key)
+      [].tap do |array|
+        value = value_from_singular_key(hash, singular_key)
+        value ||= value_from_plural_key(hash, plural_key)
+        array << value
+      end.flatten.compact
+    end
+
+    def value_from_singular_key(hash, key)
+      hash[key] if hash.key?(key) || (hash.default_proc && hash[key])
+    end
+
+    def value_from_plural_key(hash, key)
+      if hash.key?(key) || (hash.default_proc && hash[key])
+        val = hash[key]
+        case val
+        when String
+          val.split
+        when Array
+          val.compact
+        end
+      end
+    end
+
+    def transform_keys(hash)
+      result = {}
+      hash.each_key do |key|
+        result[yield(key)] = hash[key]
+      end
+      result
+    end
+
+    # Apply #to_sym to all keys in the hash
+    #
+    # hash - the hash to which to apply this transformation
+    #
+    # Returns a new hash with symbolized keys
+    def symbolize_hash_keys(hash)
+      transform_keys(hash) { |key| key.to_sym rescue key }
+    end
+
+    # Apply #to_s to all keys in the Hash
+    #
+    # hash - the hash to which to apply this transformation
+    #
+    # Returns a new hash with stringified keys
+    def stringify_hash_keys(hash)
+      transform_keys(hash) { |key| key.to_s rescue key }
+    end
+
+    # Parse a date/time and throw an error if invalid
+    #
+    # input - the date/time to parse
+    # msg - (optional) the error message to show the user
+    #
+    # Returns the parsed date if successful, throws a FatalException
+    # if not
+    def parse_date(input, msg = "Input could not be parsed.")
+      Time.parse(input).localtime
+    rescue ArgumentError
+      raise Errors::InvalidDateError, "Invalid date '#{input}': #{msg}"
+    end
+
+    # Determines whether a given file has
+    #
+    # Returns true if the YAML front matter is present.
+    # rubocop: disable PredicateName
+    def has_yaml_header?(file)
+      !!(File.open(file, "rb", &:readline) =~ %r!\A---\s*\r?\n!)
+    rescue EOFError
+      false
+    end
+    # rubocop: enable PredicateName
+
+    # Slugify a filename or title.
+    #
+    # string - the filename or title to slugify
+    # mode - how string is slugified
+    # cased - whether to replace all uppercase letters with their
+    # lowercase counterparts
+    #
+    # When mode is "none", return the given string.
+    #
+    # When mode is "raw", return the given string,
+    # with every sequence of spaces characters replaced with a hyphen.
+    #
+    # When mode is "default" or nil, non-alphabetic characters are
+    # replaced with a hyphen too.
+    #
+    # When mode is "pretty", some non-alphabetic characters (._~!$&'()+,;=@)
+    # are not replaced with hyphen.
+    #
+    # When mode is "ascii", some everything else except ASCII characters
+    # a-z (lowercase), A-Z (uppercase) and 0-9 (numbers) are not replaced with hyphen.
+    #
+    # If cased is true, all uppercase letters in the result string are
+    # replaced with their lowercase counterparts.
+    #
+    # Examples:
+    #   slugify("The _config.yml file")
+    #   # => "the-config-yml-file"
+    #
+    #   slugify("The _config.yml file", "pretty")
+    #   # => "the-_config.yml-file"
+    #
+    #   slugify("The _config.yml file", "pretty", true)
+    #   # => "The-_config.yml file"
+    #
+    #   slugify("The _config.yml file", "ascii")
+    #   # => "the-config.yml-file"
+    #
+    # Returns the slugified string.
+    def slugify(string, mode: nil, cased: false)
+      mode ||= "default"
+      return nil if string.nil?
+
+      unless SLUGIFY_MODES.include?(mode)
+        return cased ? string : string.downcase
+      end
+
+      # Replace each character sequence with a hyphen
+      re =
+        case mode
+        when "raw"
+          SLUGIFY_RAW_REGEXP
+        when "default"
+          SLUGIFY_DEFAULT_REGEXP
+        when "pretty"
+          # "._~!$&'()+,;=@" is human readable (not URI-escaped) in URL
+          # and is allowed in both extN and NTFS.
+          SLUGIFY_PRETTY_REGEXP
+        when "ascii"
+          # For web servers not being able to handle Unicode, the safe
+          # method is to ditch anything else but latin letters and numeric
+          # digits.
+          SLUGIFY_ASCII_REGEXP
+        end
+
+      # Strip according to the mode
+      slug = string.gsub(re, "-")
+
+      # Remove leading/trailing hyphen
+      slug.gsub!(%r!^\-|\-$!i, "")
+
+      slug.downcase! unless cased
+      slug
+    end
+
+    # Add an appropriate suffix to template so that it matches the specified
+    # permalink style.
+    #
+    # template - permalink template without trailing slash or file extension
+    # permalink_style - permalink style, either built-in or custom
+    #
+    # The returned permalink template will use the same ending style as
+    # specified in permalink_style.  For example, if permalink_style contains a
+    # trailing slash (or is :pretty, which indirectly has a trailing slash),
+    # then so will the returned template.  If permalink_style has a trailing
+    # ":output_ext" (or is :none, :date, or :ordinal) then so will the returned
+    # template.  Otherwise, template will be returned without modification.
+    #
+    # Examples:
+    #   add_permalink_suffix("/:basename", :pretty)
+    #   # => "/:basename/"
+    #
+    #   add_permalink_suffix("/:basename", :date)
+    #   # => "/:basename:output_ext"
+    #
+    #   add_permalink_suffix("/:basename", "/:year/:month/:title/")
+    #   # => "/:basename/"
+    #
+    #   add_permalink_suffix("/:basename", "/:year/:month/:title")
+    #   # => "/:basename"
+    #
+    # Returns the updated permalink template
+    def add_permalink_suffix(template, permalink_style)
+      template = template.dup
+
+      case permalink_style
+      when :pretty
+        template << "/"
+      when :date, :ordinal, :none
+        template << ":output_ext"
+      else
+        template << "/" if permalink_style.to_s.end_with?("/")
+        template << ":output_ext" if permalink_style.to_s.end_with?(":output_ext")
+      end
+
+      template
+    end
+
+    # Work the same way as Dir.glob but seperating the input into two parts
+    # ('dir' + '/' + 'pattern') to make sure the first part('dir') does not act
+    # as a pattern.
+    #
+    # For example, Dir.glob("path[/*") always returns an empty array,
+    # because the method fails to find the closing pattern to '[' which is ']'
+    #
+    # Examples:
+    #   safe_glob("path[", "*")
+    #   # => ["path[/file1", "path[/file2"]
+    #
+    #   safe_glob("path", "*", File::FNM_DOTMATCH)
+    #   # => ["path/.", "path/..", "path/file1"]
+    #
+    #   safe_glob("path", ["**", "*"])
+    #   # => ["path[/file1", "path[/folder/file2"]
+    #
+    # dir      - the dir where glob will be executed under
+    #           (the dir will be included to each result)
+    # patterns - the patterns (or the pattern) which will be applied under the dir
+    # flags    - the flags which will be applied to the pattern
+    #
+    # Returns matched pathes
+    def safe_glob(dir, patterns, flags = 0)
+      return [] unless Dir.exist?(dir)
+      pattern = File.join(Array(patterns))
+      return [dir] if pattern.empty?
+      Dir.chdir(dir) do
+        Dir.glob(pattern, flags).map { |f| File.join(dir, f) }
+      end
+    end
+
+    # Returns merged option hash for File.read of self.site (if exists)
+    # and a given param
+    def merged_file_read_opts(site, opts)
+      merged = (site ? site.file_read_opts : {}).merge(opts)
+      if merged["encoding"] && !merged["encoding"].start_with?("bom|")
+        merged["encoding"] = "bom|#{merged["encoding"]}"
+      end
+      merged
+    end
+
+    private
+    def merge_values(target, overwrite)
+      target.merge!(overwrite) do |_key, old_val, new_val|
+        if new_val.nil?
+          old_val
+        elsif mergable?(old_val) && mergable?(new_val)
+          deep_merge_hashes(old_val, new_val)
+        else
+          new_val
+        end
+      end
+    end
+
+    private
+    def merge_default_proc(target, overwrite)
+      if target.is_a?(Hash) && overwrite.is_a?(Hash) && target.default_proc.nil?
+        target.default_proc = overwrite.default_proc
+      end
+    end
+
+    private
+    def duplicate_frozen_values(target)
+      target.each do |key, val|
+        target[key] = val.dup if val.frozen? && duplicable?(val)
+      end
+    end
+  end
+end

data/lib/jekyll/utils/ansi.rb

@@ -0,0 +1,59 @@
+# Frozen-string-literal: true
+# Copyright: 2015 Jekyll - MIT License
+# Encoding: utf-8
+
+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
+      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

@@ -0,0 +1,27 @@
+# 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/platforms.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Utils
+    module Platforms
+      extend self
+
+      # Provides jruby? and mri? which respectively detect these two types of
+      # tested Engines we support, in the future we might probably support the
+      # other one that everyone used to talk about.
+
+      { :jruby? => "jruby", :mri? => "ruby" }.each do |k, v|
+        define_method k do
+          ::RUBY_ENGINE == v
+        end
+      end
+
+      # --
+      # Allows you to detect "real" Windows, or what we would consider
+      # "real" Windows.  That is, that we can pass the basic test and the
+      # /proc/version returns nothing to us.
+      # --
+
+      def vanilla_windows?
+        RbConfig::CONFIG["host_os"] =~ %r!mswin|mingw|cygwin!i && \
+          !proc_version
+      end
+
+      # --
+      # XXX: Remove in 4.0
+      # --
+
+      alias_method :really_windows?, \
+        :vanilla_windows?
+
+      #
+
+      def bash_on_windows?
+        RbConfig::CONFIG["host_os"] =~ %r!linux! && \
+          proc_version =~ %r!microsoft!i
+      end
+
+      #
+
+      def windows?
+        vanilla_windows? || bash_on_windows?
+      end
+
+      #
+
+      def linux?
+        RbConfig::CONFIG["host_os"] =~ %r!linux! && \
+          proc_version !~ %r!microsoft!i
+      end
+
+      # Provides windows?, linux?, osx?, unix? so that we can detect
+      # platforms. This is mostly useful for `jekyll doctor` and for testing
+      # where we kick off certain tests based on the platform.
+
+      { :osx? => %r!darwin|mac os!, :unix? => %r!solaris|bsd! }.each do |k, v|
+        define_method k do
+          !!(
+            RbConfig::CONFIG["host_os"] =~ v
+          )
+        end
+      end
+
+      #
+
+      private
+      def proc_version
+        @cached_proc_version ||= begin
+          Pathutil.new(
+            "/proc/version"
+          ).read
+        rescue Errno::ENOENT
+          nil
+        end
+      end
+    end
+  end
+end