jekyll-docs 3.6.0 → 3.6.1

data/lib/jekyll/static_file.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class StaticFile
+    extend Forwardable
+
+    attr_reader :relative_path, :extname, :name, :data
+
+    def_delegator :to_liquid, :to_json, :to_json
+
+    class << self
+      # The cache of last modification times [path] -> mtime.
+      def mtimes
+        @mtimes ||= {}
+      end
+
+      def reset_cache
+        @mtimes = nil
+      end
+    end
+
+    # Initialize a new StaticFile.
+    #
+    # site - The Site.
+    # base - The String path to the <source>.
+    # dir  - The String path between <source> and the file.
+    # name - The String filename of the file.
+    # rubocop: disable ParameterLists
+    def initialize(site, base, dir, name, collection = nil)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = name
+      @collection = collection
+      @relative_path = File.join(*[@dir, @name].compact)
+      @extname = File.extname(@name)
+      @data = @site.frontmatter_defaults.all(relative_path, type)
+    end
+    # rubocop: enable ParameterLists
+
+    # Returns source file path.
+    def path
+      File.join(*[@base, @dir, @name].compact)
+    end
+
+    # Obtain destination path.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns destination file path.
+    def destination(dest)
+      @site.in_dest_dir(*[dest, destination_rel_dir, @name].compact)
+    end
+
+    def destination_rel_dir
+      if @collection
+        File.dirname(url)
+      else
+        @dir
+      end
+    end
+
+    def modified_time
+      @modified_time ||= File.stat(path).mtime
+    end
+
+    # Returns last modification time for this file.
+    def mtime
+      modified_time.to_i
+    end
+
+    # Is source path modified?
+    #
+    # Returns true if modified since last write.
+    def modified?
+      self.class.mtimes[path] != mtime
+    end
+
+    # Whether to write the file to the filesystem
+    #
+    # Returns true unless the defaults for the destination path from
+    # _config.yml contain `published: false`.
+    def write?
+      defaults.fetch("published", true)
+    end
+
+    # Write the static file to the destination directory (if modified).
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns false if the file was not modified since last time (no-op).
+    def write(dest)
+      dest_path = destination(dest)
+
+      return false if File.exist?(dest_path) && !modified?
+      self.class.mtimes[path] = mtime
+
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      FileUtils.rm(dest_path) if File.exist?(dest_path)
+      copy_file(dest_path)
+
+      true
+    end
+
+    def to_liquid
+      @to_liquid ||= Drops::StaticFileDrop.new(self)
+    end
+
+    def basename
+      File.basename(name, extname)
+    end
+
+    def placeholders
+      {
+        :collection => @collection.label,
+        :path       => relative_path[
+          @collection.relative_directory.size..relative_path.size],
+        :output_ext => "",
+        :name       => "",
+        :title      => "",
+      }
+    end
+
+    # Applies a similar URL-building technique as Jekyll::Document that takes
+    # the collection's URL template into account. The default URL template can
+    # be overriden in the collection's configuration in _config.yml.
+    def url
+      @url ||= if @collection.nil?
+                 relative_path
+               else
+                 ::Jekyll::URL.new({
+                   :template     => @collection.url_template,
+                   :placeholders => placeholders,
+                 })
+               end.to_s.gsub(%r!/$!, "")
+    end
+
+    # Returns the type of the collection if present, nil otherwise.
+    def type
+      @type ||= @collection.nil? ? nil : @collection.label.to_sym
+    end
+
+    # Returns the front matter defaults defined for the file's URL and/or type
+    # as defined in _config.yml.
+    def defaults
+      @defaults ||= @site.frontmatter_defaults.all url, type
+    end
+
+    private
+    def copy_file(dest_path)
+      if @site.safe || Jekyll.env == "production"
+        FileUtils.cp(path, dest_path)
+      else
+        FileUtils.copy_entry(path, dest_path)
+      end
+
+      unless File.symlink?(dest_path)
+        File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path)
+      end
+    end
+  end
+end

data/lib/jekyll/stevenson.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class Stevenson < ::Logger
+    def initialize
+      @progname = nil
+      @level = DEBUG
+      @default_formatter = Formatter.new
+      @logdev = $stdout
+      @formatter = proc do |_, _, _, msg|
+        msg.to_s
+      end
+    end
+
+    def add(severity, message = nil, progname = nil)
+      severity ||= UNKNOWN
+      @logdev = logdevice(severity)
+
+      if @logdev.nil? || severity < @level
+        return true
+      end
+      progname ||= @progname
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = progname
+          progname = @progname
+        end
+      end
+      @logdev.puts(
+        format_message(format_severity(severity), Time.now, progname, message)
+      )
+      true
+    end
+
+    # Log a +WARN+ message
+    def warn(progname = nil, &block)
+      add(WARN, nil, progname.yellow, &block)
+    end
+
+    # Log an +ERROR+ message
+    def error(progname = nil, &block)
+      add(ERROR, nil, progname.red, &block)
+    end
+
+    def close
+      # No LogDevice in use
+    end
+
+    private
+
+    def logdevice(severity)
+      if severity > INFO
+        $stderr
+      else
+        $stdout
+      end
+    end
+  end
+end

data/lib/jekyll/tags/highlight.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Tags
+    class HighlightBlock < Liquid::Block
+      include Liquid::StandardFilters
+
+      # The regular expression syntax checker. Start with the language specifier.
+      # Follow that by zero or more space separated options that take one of three
+      # forms: name, name=value, or name="<quoted list>"
+      #
+      # <quoted list> is a space-separated list of numbers
+      SYNTAX = %r!^([a-zA-Z0-9.+#_-]+)((\s+\w+(=(\w+|"([0-9]+\s)*[0-9]+"))?)*)$!
+
+      def initialize(tag_name, markup, tokens)
+        super
+        if markup.strip =~ SYNTAX
+          @lang = Regexp.last_match(1).downcase
+          @highlight_options = parse_options(Regexp.last_match(2))
+        else
+          raise SyntaxError, <<-MSG
+Syntax Error in tag 'highlight' while parsing the following markup:
+
+  #{markup}
+
+Valid syntax: highlight <lang> [linenos]
+MSG
+        end
+      end
+
+      def render(context)
+        prefix = context["highlighter_prefix"] || ""
+        suffix = context["highlighter_suffix"] || ""
+        code = super.to_s.gsub(%r!\A(\n|\r)+|(\n|\r)+\z!, "")
+
+        is_safe = !!context.registers[:site].safe
+
+        output =
+          case context.registers[:site].highlighter
+          when "pygments"
+            render_pygments(code, is_safe)
+          when "rouge"
+            render_rouge(code)
+          else
+            render_codehighlighter(code)
+          end
+
+        rendered_output = add_code_tag(output)
+        prefix + rendered_output + suffix
+      end
+
+      def sanitized_opts(opts, is_safe)
+        if is_safe
+          Hash[[
+            [:startinline, opts.fetch(:startinline, nil)],
+            [:hl_lines,    opts.fetch(:hl_lines, nil)],
+            [:linenos,     opts.fetch(:linenos, nil)],
+            [:encoding,    opts.fetch(:encoding, "utf-8")],
+            [:cssclass,    opts.fetch(:cssclass, nil)],
+          ].reject { |f| f.last.nil? }]
+        else
+          opts
+        end
+      end
+
+      private
+
+      def parse_options(input)
+        options = {}
+        unless input.empty?
+          # Split along 3 possible forms -- key="<quoted list>", key=value, or key
+          input.scan(%r!(?:\w="[^"]*"|\w=\w|\w)+!) do |opt|
+            key, value = opt.split("=")
+            # If a quoted list, convert to array
+            if value && value.include?("\"")
+              value.delete!('"')
+              value = value.split
+            end
+            options[key.to_sym] = value || true
+          end
+        end
+        if options.key?(:linenos) && options[:linenos] == true
+          options[:linenos] = "inline"
+        end
+        options
+      end
+
+      def render_pygments(code, is_safe)
+        Jekyll::External.require_with_graceful_fail("pygments")
+
+        highlighted_code = Pygments.highlight(
+          code,
+          :lexer   => @lang,
+          :options => sanitized_opts(@highlight_options, is_safe)
+        )
+
+        if highlighted_code.nil?
+          Jekyll.logger.error <<-MSG
+There was an error highlighting your code:
+
+#{code}
+
+While attempting to convert the above code, Pygments.rb returned an unacceptable value.
+This is usually a timeout problem solved by running `jekyll build` again.
+MSG
+          raise ArgumentError, "Pygments.rb returned an unacceptable value "\
+          "when attempting to highlight some code."
+        end
+
+        highlighted_code.sub('<div class="highlight"><pre>', "").sub("</pre></div>", "")
+      end
+
+      def render_rouge(code)
+        formatter = Jekyll::Utils::Rouge.html_formatter(
+          :line_numbers => @highlight_options[:linenos],
+          :wrap         => false,
+          :css_class    => "highlight",
+          :gutter_class => "gutter",
+          :code_class   => "code"
+        )
+        lexer = Rouge::Lexer.find_fancy(@lang, code) || Rouge::Lexers::PlainText
+        formatter.format(lexer.lex(code))
+      end
+
+      def render_codehighlighter(code)
+        h(code).strip
+      end
+
+      def add_code_tag(code)
+        code_attributes = [
+          "class=\"language-#{@lang.to_s.tr("+", "-")}\"",
+          "data-lang=\"#{@lang}\"",
+        ].join(" ")
+        "<figure class=\"highlight\"><pre><code #{code_attributes}>"\
+        "#{code.chomp}</code></pre></figure>"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("highlight", Jekyll::Tags::HighlightBlock)

data/lib/jekyll/tags/include.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Tags
+    class IncludeTagError < StandardError
+      attr_accessor :path
+
+      def initialize(msg, path)
+        super(msg)
+        @path = path
+      end
+    end
+
+    class IncludeTag < Liquid::Tag
+      VALID_SYNTAX = %r!
+        ([\w-]+)\s*=\s*
+        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
+      !x
+      VARIABLE_SYNTAX = %r!
+        (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)
+        (?<params>.*)
+      !x
+
+      def initialize(tag_name, markup, tokens)
+        super
+        matched = markup.strip.match(VARIABLE_SYNTAX)
+        if matched
+          @file = matched["variable"].strip
+          @params = matched["params"].strip
+        else
+          @file, @params = markup.strip.split(%r!\s+!, 2)
+        end
+        validate_params if @params
+        @tag_name = tag_name
+      end
+
+      def syntax_example
+        "{% #{@tag_name} file.ext param='value' param2='value' %}"
+      end
+
+      def parse_params(context)
+        params = {}
+        markup = @params
+
+        while (match = VALID_SYNTAX.match(markup))
+          markup = markup[match.end(0)..-1]
+
+          value = if match[2]
+                    match[2].gsub(%r!\\"!, '"')
+                  elsif match[3]
+                    match[3].gsub(%r!\\'!, "'")
+                  elsif match[4]
+                    context[match[4]]
+                  end
+
+          params[match[1]] = value
+        end
+        params
+      end
+
+      def validate_file_name(file)
+        if file !~ %r!^[a-zA-Z0-9_/\.-]+$! || file =~ %r!\./! || file =~ %r!/\.!
+          raise ArgumentError, <<-MSG
+Invalid syntax for include tag. File contains invalid characters or sequences:
+
+  #{file}
+
+Valid syntax:
+
+  #{syntax_example}
+
+MSG
+        end
+      end
+
+      def validate_params
+        full_valid_syntax = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!
+        unless @params =~ full_valid_syntax
+          raise ArgumentError, <<-MSG
+Invalid syntax for include tag:
+
+  #{@params}
+
+Valid syntax:
+
+  #{syntax_example}
+
+MSG
+        end
+      end
+
+      # Grab file read opts in the context
+      def file_read_opts(context)
+        context.registers[:site].file_read_opts
+      end
+
+      # Render the variable if required
+      def render_variable(context)
+        if @file.match(VARIABLE_SYNTAX)
+          partial = context.registers[:site]
+            .liquid_renderer
+            .file("(variable)")
+            .parse(@file)
+          partial.render!(context)
+        end
+      end
+
+      def tag_includes_dirs(context)
+        context.registers[:site].includes_load_paths.freeze
+      end
+
+      def locate_include_file(context, file, safe)
+        includes_dirs = tag_includes_dirs(context)
+        includes_dirs.each do |dir|
+          path = File.join(dir.to_s, file.to_s)
+          return path if valid_include_file?(path, dir.to_s, safe)
+        end
+        raise IOError, "Could not locate the included file '#{file}' in any of "\
+          "#{includes_dirs}. Ensure it exists in one of those directories and, "\
+          "if it is a symlink, does not point outside your site source."
+      end
+
+      def render(context)
+        site = context.registers[:site]
+
+        file = render_variable(context) || @file
+        validate_file_name(file)
+
+        path = locate_include_file(context, file, site.safe)
+        return unless path
+
+        add_include_to_dependency(site, path, context)
+
+        partial = load_cached_partial(path, context)
+
+        context.stack do
+          context["include"] = parse_params(context) if @params
+          begin
+            partial.render!(context)
+          rescue Liquid::Error => e
+            e.template_name = path
+            e.markup_context = "included " if e.markup_context.nil?
+            raise e
+          end
+        end
+      end
+
+      def add_include_to_dependency(site, path, context)
+        if context.registers[:page] && context.registers[:page].key?("path")
+          site.regenerator.add_dependency(
+            site.in_source_dir(context.registers[:page]["path"]),
+            path
+          )
+        end
+      end
+
+      def load_cached_partial(path, context)
+        context.registers[:cached_partials] ||= {}
+        cached_partial = context.registers[:cached_partials]
+
+        if cached_partial.key?(path)
+          cached_partial[path]
+        else
+          unparsed_file = context.registers[:site]
+            .liquid_renderer
+            .file(path)
+          begin
+            cached_partial[path] = unparsed_file.parse(read_file(path, context))
+          rescue Liquid::Error => e
+            e.template_name = path
+            e.markup_context = "included " if e.markup_context.nil?
+            raise e
+          end
+        end
+      end
+
+      def valid_include_file?(path, dir, safe)
+        !outside_site_source?(path, dir, safe) && File.file?(path)
+      end
+
+      def outside_site_source?(path, dir, safe)
+        safe && !realpath_prefixed_with?(path, dir)
+      end
+
+      def realpath_prefixed_with?(path, dir)
+        File.exist?(path) && File.realpath(path).start_with?(dir)
+      rescue
+        false
+      end
+
+      # This method allows to modify the file content by inheriting from the class.
+      def read_file(file, context)
+        File.read(file, file_read_opts(context))
+      end
+    end
+
+    class IncludeRelativeTag < IncludeTag
+      def tag_includes_dirs(context)
+        Array(page_path(context)).freeze
+      end
+
+      def page_path(context)
+        if context.registers[:page].nil?
+          context.registers[:site].source
+        else
+          current_doc_dir = File.dirname(context.registers[:page]["path"])
+          context.registers[:site].in_source_dir current_doc_dir
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("include", Jekyll::Tags::IncludeTag)
+Liquid::Template.register_tag("include_relative", Jekyll::Tags::IncludeRelativeTag)