jekyll 3.2.0.pre.beta1 → 3.2.0.pre.beta2

data/lib/jekyll/static_file.rb

@@ -1,16 +1,25 @@
 module Jekyll
   class StaticFile
-    # The cache of last modification times [path] -> mtime.
-    @@mtimes = {}
-
     attr_reader :relative_path, :extname
 
+    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
@@ -20,6 +29,7 @@ module Jekyll
       @relative_path = File.join(*[@dir, @name].compact)
       @extname = File.extname(@name)
     end
+    # rubocop: enable ParameterLists
 
     # Returns source file path.
     def path
@@ -56,7 +66,7 @@ module Jekyll
     #
     # Returns true if modified since last write.
     def modified?
-      @@mtimes[path] != mtime
+      self.class.mtimes[path] != mtime
     end
 
     # Whether to write the file to the filesystem
@@ -64,7 +74,7 @@ module Jekyll
     # Returns true unless the defaults for the destination path from
     # _config.yml contain `published: false`.
     def write?
-      defaults.fetch('published', true)
+      defaults.fetch("published", true)
     end
 
     # Write the static file to the destination directory (if modified).
@@ -76,28 +86,15 @@ module Jekyll
       dest_path = destination(dest)
 
       return false if File.exist?(dest_path) && !modified?
-      @@mtimes[path] = mtime
+      self.class.mtimes[path] = mtime
 
       FileUtils.mkdir_p(File.dirname(dest_path))
       FileUtils.rm(dest_path) if File.exist?(dest_path)
-      if @site.safe || Jekyll.env == "production"
-        FileUtils.cp(path, dest_path)
-      else
-        FileUtils.copy_entry(path, dest_path)
-      end
-      File.utime(@@mtimes[path], @@mtimes[path], dest_path)
+      copy_file(dest_path)
 
       true
     end
 
-    # Reset the mtimes cache (for testing purposes).
-    #
-    # Returns nothing.
-    def self.reset_cache
-      @@mtimes = {}
-      nil
-    end
-
     def to_liquid
       {
         "extname"       => extname,
@@ -109,11 +106,11 @@ module Jekyll
     def placeholders
       {
         :collection => @collection.label,
-        :path => relative_path[
+        :path       => relative_path[
           @collection.relative_directory.size..relative_path.size],
-        :output_ext => '',
-        :name => '',
-        :title => ''
+        :output_ext => "",
+        :name       => "",
+        :title      => ""
       }
     end
 
@@ -125,10 +122,10 @@ module Jekyll
                  relative_path
                else
                  ::Jekyll::URL.new({
-                   :template => @collection.url_template,
+                   :template     => @collection.url_template,
                    :placeholders => placeholders
                  })
-               end.to_s.gsub(/\/$/, '')
+               end.to_s.gsub(%r!/$!, "")
     end
 
     # Returns the type of the collection if present, nil otherwise.
@@ -141,5 +138,15 @@ module Jekyll
     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
+      File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path)
+    end
   end
 end

data/lib/jekyll/stevenson.rb

@@ -6,13 +6,13 @@ module Jekyll
       @default_formatter = Formatter.new
       @logdev = $stdout
       @formatter = proc do |_, _, _, msg|
-        "#{msg}"
+        msg.to_s
       end
     end
 
-    def add(severity, message = nil, progname = nil, &block)
+    def add(severity, message = nil, progname = nil)
       severity ||= UNKNOWN
-      @logdev = set_logdevice(severity)
+      @logdev = logdevice(severity)
 
       if @logdev.nil? || severity < @level
         return true
@@ -27,7 +27,8 @@ module Jekyll
         end
       end
       @logdev.puts(
-        format_message(format_severity(severity), Time.now, progname, message))
+        format_message(format_severity(severity), Time.now, progname, message)
+      )
       true
     end
 
@@ -47,7 +48,7 @@ module Jekyll
 
     private
 
-    def set_logdevice(severity)
+    def logdevice(severity)
       if severity > INFO
         $stderr
       else

data/lib/jekyll/tags/highlight.rb

@@ -8,28 +8,15 @@ module Jekyll
       # forms: name, name=value, or name="<quoted list>"
       #
       # <quoted list> is a space-separated list of numbers
-      SYNTAX = /^([a-zA-Z0-9.+#-]+)((\s+\w+(=(\w+|"([0-9]+\s)*[0-9]+"))?)*)$/
+      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 = {}
-          if defined?(Regexp.last_match(2)) && Regexp.last_match(2) != ''
-            # Split along 3 possible forms -- key="<quoted list>", key=value, or key
-            Regexp.last_match(2).scan(/(?:\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
-              @highlight_options[key.to_sym] = value || true
-            end
-          end
-          @highlight_options[:linenos] = "inline" if @highlight_options.key?(:linenos) && @highlight_options[:linenos] == true
+          @highlight_options = parse_options(Regexp.last_match(2))
         else
-          raise SyntaxError.new <<-eos
+          raise SyntaxError, <<-eos
 Syntax Error in tag 'highlight' while parsing the following markup:
 
   #{markup}
@@ -42,15 +29,15 @@ eos
       def render(context)
         prefix = context["highlighter_prefix"] || ""
         suffix = context["highlighter_suffix"] || ""
-        code = super.to_s.gsub(/\A(\n|\r)+|(\n|\r)+\z/, '')
+        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'
+          when "pygments"
             render_pygments(code, is_safe)
-          when 'rouge'
+          when "rouge"
             render_rouge(code)
           else
             render_codehighlighter(code)
@@ -66,7 +53,7 @@ eos
             [:startinline, opts.fetch(:startinline, nil)],
             [:hl_lines,    opts.fetch(:hl_lines, nil)],
             [:linenos,     opts.fetch(:linenos, nil)],
-            [:encoding,    opts.fetch(:encoding, 'utf-8')],
+            [:encoding,    opts.fetch(:encoding, "utf-8")],
             [:cssclass,    opts.fetch(:cssclass, nil)]
           ].reject { |f| f.last.nil? }]
         else
@@ -74,8 +61,30 @@ eos
         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')
+        Jekyll::External.require_with_graceful_fail("pygments")
 
         highlighted_code = Pygments.highlight(
           code,
@@ -84,22 +93,27 @@ eos
         )
 
         if highlighted_code.nil?
-          Jekyll.logger.error "There was an error highlighting your code:"
-          puts
-          Jekyll.logger.error code
-          puts
-          Jekyll.logger.error "While attempting to convert the above code, Pygments.rb" \
-            " returned an unacceptable value."
-          Jekyll.logger.error "This is usually a timeout problem solved by running `jekyll build` again."
-          raise ArgumentError.new("Pygments.rb returned an unacceptable value when attempting to highlight some code.")
+          Jekyll.logger.error <<eos
+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.
+eos
+          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>', '')
+        highlighted_code.sub('<div class="highlight"><pre>', "").sub("</pre></div>", "")
       end
 
       def render_rouge(code)
-        Jekyll::External.require_with_graceful_fail('rouge')
-        formatter = Rouge::Formatters::HTML.new(:line_numbers => @highlight_options[:linenos], :wrap => false)
+        Jekyll::External.require_with_graceful_fail("rouge")
+        formatter = Rouge::Formatters::HTML.new(
+          :line_numbers => @highlight_options[:linenos],
+          :wrap         => false
+        )
         lexer = Rouge::Lexer.find_fancy(@lang, code) || Rouge::Lexers::PlainText
         formatter.format(lexer.lex(code))
       end
@@ -110,13 +124,14 @@ eos
 
       def add_code_tag(code)
         code_attributes = [
-          "class=\"language-#{@lang.to_s.tr('+', '-')}\"",
+          "class=\"language-#{@lang.to_s.tr("+", "-")}\"",
           "data-lang=\"#{@lang}\""
         ].join(" ")
-        "<figure class=\"highlight\"><pre><code #{code_attributes}>#{code.chomp}</code></pre></figure>"
+        "<figure class=\"highlight\"><pre><code #{code_attributes}>"\
+        "#{code.chomp}</code></pre></figure>"
       end
     end
   end
 end
 
-Liquid::Template.register_tag('highlight', Jekyll::Tags::HighlightBlock)
+Liquid::Template.register_tag("highlight", Jekyll::Tags::HighlightBlock)

data/lib/jekyll/tags/include.rb

@@ -12,17 +12,23 @@ module Jekyll
     end
 
     class IncludeTag < Liquid::Tag
-      VALID_SYNTAX = /([\w-]+)\s*=\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))/
-      VARIABLE_SYNTAX = /(?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)(?<params>.*)/
+      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
+          @file = matched["variable"].strip
+          @params = matched["params"].strip
         else
-          @file, @params = markup.strip.split(' ', 2)
+          @file, @params = markup.strip.split(%r!\s+!, 2)
         end
         validate_params if @params
         @tag_name = tag_name
@@ -36,13 +42,13 @@ module Jekyll
         params = {}
         markup = @params
 
-        while match = VALID_SYNTAX.match(markup) do
+        while (match = VALID_SYNTAX.match(markup))
           markup = markup[match.end(0)..-1]
 
           value = if match[2]
-                    match[2].gsub(/\\"/, '"')
+                    match[2].gsub(%r!\\"!, '"')
                   elsif match[3]
-                    match[3].gsub(/\\'/, "'")
+                    match[3].gsub(%r!\\'!, "'")
                   elsif match[4]
                     context[match[4]]
                   end
@@ -53,8 +59,8 @@ module Jekyll
       end
 
       def validate_file_name(file)
-        if file !~ /^[a-zA-Z0-9_\/\.-]+$/ || file =~ /\.\// || file =~ /\/\./
-          raise ArgumentError.new <<-eos
+        if file !~ %r!^[a-zA-Z0-9_/\.-]+$! || file =~ %r!\./! || file =~ %r!/\.!
+          raise ArgumentError, <<-eos
 Invalid syntax for include tag. File contains invalid characters or sequences:
 
   #{file}
@@ -68,9 +74,9 @@ eos
       end
 
       def validate_params
-        full_valid_syntax = Regexp.compile('\A\s*(?:' + VALID_SYNTAX.to_s + '(?=\s|\z)\s*)*\z')
+        full_valid_syntax = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!
         unless @params =~ full_valid_syntax
-          raise ArgumentError.new <<-eos
+          raise ArgumentError, <<-eos
 Invalid syntax for include tag:
 
   #{@params}
@@ -91,7 +97,10 @@ eos
       # 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 = context.registers[:site]
+            .liquid_renderer
+            .file("(variable)")
+            .parse(@file)
           partial.render!(context)
         end
       end
@@ -106,9 +115,9 @@ eos
           path = File.join(dir, file)
           return path if valid_include_file?(path, dir, 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."
+        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)
@@ -120,24 +129,23 @@ eos
         path = locate_include_file(context, file, site.safe)
         return unless path
 
-        # Add include to dependency tree
+        add_include_to_dependency(site, path, context)
+
+        partial = load_cached_partial(path, context)
+
+        context.stack do
+          context["include"] = parse_params(context) if @params
+          partial.render!(context)
+        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
-
-        #begin
-          partial = load_cached_partial(path, context)
-
-          context.stack do
-            context['include'] = parse_params(context) if @params
-            partial.render!(context)
-          end
-          #rescue => e
-          #raise IncludeTagError.new e.message, path
-          #end
       end
 
       def load_cached_partial(path, context)
@@ -147,7 +155,10 @@ eos
         if cached_partial.key?(path)
           cached_partial[path]
         else
-          cached_partial[path] = context.registers[:site].liquid_renderer.file(path).parse(read_file(path, context))
+          cached_partial[path] = context.registers[:site]
+            .liquid_renderer
+            .file(path)
+            .parse(read_file(path, context))
         end
       end
 
@@ -188,5 +199,5 @@ eos
   end
 end
 
-Liquid::Template.register_tag('include', Jekyll::Tags::IncludeTag)
-Liquid::Template.register_tag('include_relative', Jekyll::Tags::IncludeRelativeTag)
+Liquid::Template.register_tag("include", Jekyll::Tags::IncludeTag)
+Liquid::Template.register_tag("include_relative", Jekyll::Tags::IncludeRelativeTag)