jekyll 4.0.0.pre.alpha1 → 4.1.1

data/lib/jekyll/static_file.rb

@@ -4,7 +4,7 @@ module Jekyll
   class StaticFile
     extend Forwardable
 
-    attr_reader :relative_path, :extname, :name, :data
+    attr_reader :relative_path, :extname, :name
 
     def_delegator :to_liquid, :to_json, :to_json
 
@@ -25,7 +25,7 @@ module Jekyll
     # 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
+    # rubocop: disable Metrics/ParameterLists
     def initialize(site, base, dir, name, collection = nil)
       @site = site
       @base = base
@@ -34,17 +34,18 @@ module Jekyll
       @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
+    # rubocop: enable Metrics/ParameterLists
 
     # Returns source file path.
     def path
-      # Static file is from a collection inside custom collections directory
-      if !@collection.nil? && !@site.config["collections_dir"].empty?
-        File.join(*[@base, @site.config["collections_dir"], @dir, @name].compact)
-      else
-        File.join(*[@base, @dir, @name].compact)
+      @path ||= begin
+        # Static file is from a collection inside custom collections directory
+        if !@collection.nil? && !@site.config["collections_dir"].empty?
+          File.join(*[@base, @site.config["collections_dir"], @dir, @name].compact)
+        else
+          File.join(*[@base, @dir, @name].compact)
+        end
       end
     end
 
@@ -111,6 +112,10 @@ module Jekyll
       true
     end
 
+    def data
+      @data ||= @site.frontmatter_defaults.all(relative_path, type)
+    end
+
     def to_liquid
       @to_liquid ||= Drops::StaticFileDrop.new(self)
     end
@@ -126,7 +131,7 @@ module Jekyll
         :collection => @collection.label,
         :path       => cleaned_relative_path,
         :output_ext => "",
-        :name       => "",
+        :name       => basename,
         :title      => "",
       }
     end

data/lib/jekyll/tags/highlight.rb

@@ -2,7 +2,7 @@
 
 module Jekyll
   module Tags
-    class HighlightBlock < Liquid::Raw
+    class HighlightBlock < Liquid::Block
       include Liquid::StandardFilters
 
       # The regular expression syntax checker. Start with the language specifier.
@@ -33,7 +33,7 @@ module Jekyll
       def render(context)
         prefix = context["highlighter_prefix"] || ""
         suffix = context["highlighter_suffix"] || ""
-        code   = @body.gsub(LEADING_OR_TRAILING_LINE_TERMINATORS, "")
+        code = super.to_s.gsub(LEADING_OR_TRAILING_LINE_TERMINATORS, "")
 
         output =
           case context.registers[:site].highlighter
@@ -103,8 +103,6 @@ module Jekyll
         "<figure class=\"highlight\"><pre><code #{code_attributes}>"\
         "#{code.chomp}</code></pre></figure>"
       end
-
-      def ensure_valid_markup(tag_name, markup, parse_context); end
     end
   end
 end

data/lib/jekyll/tags/include.rb

@@ -5,25 +5,26 @@ module Jekyll
     class IncludeTag < Liquid::Tag
       VALID_SYNTAX = %r!
         ([\w-]+)\s*=\s*
-        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
+        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w.-]+))
       !x.freeze
       VARIABLE_SYNTAX = %r!
-        (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)
+        (?<variable>[^{]*(\{\{\s*[\w\-.]+\s*(\|.*)?\}\}[^\s{}]*)+)
         (?<params>.*)
       !mx.freeze
 
       FULL_VALID_SYNTAX = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!.freeze
-      VALID_FILENAME_CHARS = %r!^[\w/\.-]+$!.freeze
+      VALID_FILENAME_CHARS = %r!^[\w/.-]+$!.freeze
       INVALID_SEQUENCES = %r![./]{2,}!.freeze
 
       def initialize(tag_name, markup, tokens)
         super
-        matched = markup.strip.match(VARIABLE_SYNTAX)
+        markup  = markup.strip
+        matched = markup.match(VARIABLE_SYNTAX)
         if matched
           @file = matched["variable"].strip
           @params = matched["params"].strip
         else
-          @file, @params = markup.strip.split(%r!\s+!, 2)
+          @file, @params = markup.split(%r!\s+!, 2)
         end
         validate_params if @params
         @tag_name = tag_name
@@ -54,7 +55,7 @@ module Jekyll
       end
 
       def validate_file_name(file)
-        if file =~ INVALID_SEQUENCES || file !~ VALID_FILENAME_CHARS
+        if INVALID_SEQUENCES.match?(file) || !VALID_FILENAME_CHARS.match?(file)
           raise ArgumentError, <<~MSG
             Invalid syntax for include tag. File contains invalid characters or sequences:
 
@@ -69,7 +70,7 @@ module Jekyll
       end
 
       def validate_params
-        unless @params =~ FULL_VALID_SYNTAX
+        unless FULL_VALID_SYNTAX.match?(@params)
           raise ArgumentError, <<~MSG
             Invalid syntax for include tag:
 
@@ -90,7 +91,7 @@ module Jekyll
 
       # Render the variable if required
       def render_variable(context)
-        Liquid::Template.parse(@file).render(context) if @file =~ VARIABLE_SYNTAX
+        Liquid::Template.parse(@file).render(context) if VARIABLE_SYNTAX.match?(@file)
       end
 
       def tag_includes_dirs(context)
@@ -100,7 +101,7 @@ module Jekyll
       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)
+          path = PathManager.join(dir, file)
           return path if valid_include_file?(path, dir.to_s, safe)
         end
         raise IOError, could_not_locate_message(file, includes_dirs, safe)
@@ -176,7 +177,7 @@ module Jekyll
 
       # 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))
+        File.read(file, **file_read_opts(context))
       end
 
       private
@@ -192,6 +193,60 @@ module Jekyll
       end
     end
 
+    # Do not inherit from this class.
+    # TODO: Merge into the `Jekyll::Tags::IncludeTag` in v5.0
+    class OptimizedIncludeTag < IncludeTag
+      def render(context)
+        @site ||= context.registers[:site]
+
+        file = render_variable(context) || @file
+        validate_file_name(file)
+
+        @site.inclusions[file] ||= locate_include_file(file)
+        inclusion = @site.inclusions[file]
+
+        add_include_to_dependency(inclusion, context) if @site.incremental?
+
+        context.stack do
+          context["include"] = parse_params(context) if @params
+          inclusion.render(context)
+        end
+      end
+
+      private
+
+      def locate_include_file(file)
+        @site.includes_load_paths.each do |dir|
+          path = PathManager.join(dir, file)
+          return Inclusion.new(@site, dir, file) if valid_include_file?(path, dir)
+        end
+        raise IOError, could_not_locate_message(file, @site.includes_load_paths, @site.safe)
+      end
+
+      def valid_include_file?(path, dir)
+        File.file?(path) && !outside_scope?(path, dir)
+      end
+
+      def outside_scope?(path, dir)
+        @site.safe && !realpath_prefixed_with?(path, dir)
+      end
+
+      def realpath_prefixed_with?(path, dir)
+        File.realpath(path).start_with?(dir)
+      rescue StandardError
+        false
+      end
+
+      def add_include_to_dependency(inclusion, context)
+        return unless context.registers[:page]&.key?("path")
+
+        @site.regenerator.add_dependency(
+          @site.in_source_dir(context.registers[:page]["path"]),
+          inclusion.path
+        )
+      end
+    end
+
     class IncludeRelativeTag < IncludeTag
       def tag_includes_dirs(context)
         Array(page_path(context)).freeze
@@ -209,6 +264,7 @@ module Jekyll
             else
               File.join(site.config["collections_dir"], page_payload["path"])
             end
+          resource_path.sub!(%r!/#excerpt\z!, "")
           site.in_source_dir File.dirname(resource_path)
         end
       end
@@ -216,5 +272,5 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag("include", Jekyll::Tags::IncludeTag)
+Liquid::Template.register_tag("include", Jekyll::Tags::OptimizedIncludeTag)
 Liquid::Template.register_tag("include_relative", Jekyll::Tags::IncludeRelativeTag)

data/lib/jekyll/tags/post_url.rb

@@ -57,6 +57,8 @@ module Jekyll
     end
 
     class PostUrl < Liquid::Tag
+      include Jekyll::Filters::URLFilters
+
       def initialize(tag_name, post, tokens)
         super
         @orig_post = post.strip
@@ -72,24 +74,25 @@ module Jekyll
       end
 
       def render(context)
+        @context = context
         site = context.registers[:site]
 
-        site.posts.docs.each do |p|
-          return p.url if @post == p
+        site.posts.docs.each do |document|
+          return relative_url(document) if @post == document
         end
 
         # New matching method did not match, fall back to old method
         # with deprecation warning if this matches
 
-        site.posts.docs.each do |p|
-          next unless @post.deprecated_equality p
+        site.posts.docs.each do |document|
+          next unless @post.deprecated_equality document
 
           Jekyll::Deprecator.deprecation_message "A call to "\
             "'{% post_url #{@post.name} %}' did not match " \
             "a post using the new matching method of checking name " \
             "(path-date-slug) equality. Please make sure that you " \
             "change this tag to match the post's name exactly."
-          return p.url
+          return relative_url(document)
         end
 
         raise Jekyll::Errors::PostURLError, <<~MSG

data/lib/jekyll/theme.rb

@@ -4,13 +4,13 @@ module Jekyll
   class Theme
     extend Forwardable
     attr_reader   :name
+
     def_delegator :gemspec, :version, :version
 
     def initialize(name)
       @name = name.downcase.strip
       Jekyll.logger.debug "Theme:", name
       Jekyll.logger.debug "Theme source:", root
-      configure_sass
     end
 
     def root
@@ -22,6 +22,11 @@ module Jekyll
         "or includes a symbolic link loop"
     end
 
+    # The name of theme directory
+    def basename
+      @basename ||= File.basename(root)
+    end
+
     def includes_path
       @includes_path ||= path_for "_includes"
     end
@@ -38,13 +43,6 @@ module Jekyll
       @assets_path ||= path_for "assets"
     end
 
-    def configure_sass
-      return unless sass_path
-
-      External.require_with_graceful_fail("sass") unless defined?(Sass)
-      Sass.load_paths << sass_path
-    end
-
     def runtime_dependencies
       gemspec.runtime_dependencies
     end
@@ -62,11 +60,22 @@ module Jekyll
       # escape the theme root.
       # However, symlinks are allowed to point to other directories within the theme.
       Jekyll.sanitized_path(root, File.realpath(Jekyll.sanitized_path(root, folder.to_s)))
-    rescue Errno::ENOENT, Errno::EACCES, Errno::ELOOP
-      Jekyll.logger.warn "Invalid theme folder:", folder
+    rescue Errno::ENOENT, Errno::EACCES, Errno::ELOOP => e
+      log_realpath_exception(e, folder)
       nil
     end
 
+    def log_realpath_exception(err, folder)
+      return if err.is_a?(Errno::ENOENT)
+
+      case err
+      when Errno::EACCES
+        Jekyll.logger.error "Theme error:", "Directory '#{folder}' is not accessible."
+      when Errno::ELOOP
+        Jekyll.logger.error "Theme error:", "Directory '#{folder}' includes a symbolic link loop."
+      end
+    end
+
     def gemspec
       @gemspec ||= Gem::Specification.find_by_name(name)
     rescue Gem::LoadError

data/lib/jekyll/url.rb

@@ -129,6 +129,8 @@ module Jekyll
     #
     # 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 "/").
       #
@@ -139,8 +141,7 @@ module Jekyll
       #   pct-encoded   = "%" HEXDIG HEXDIG
       #   sub-delims    = "!" / "$" / "&" / "'" / "(" / ")"
       #                 / "*" / "+" / "," / ";" / "="
-      path = Addressable::URI.encode(path)
-      path.encode("utf-8").sub("#", "%23")
+      Addressable::URI.encode(path).encode("utf-8").sub("#", "%23")
     end
 
     # Unescapes a URL path segment
@@ -154,7 +155,10 @@ module Jekyll
     #
     # Returns the unescaped path.
     def self.unescape_path(path)
-      Addressable::URI.unencode(path.encode("utf-8"))
+      path = path.encode("utf-8")
+      return path unless path.include?("%")
+
+      Addressable::URI.unencode(path)
     end
   end
 end

data/lib/jekyll/utils.rb

@@ -13,18 +13,11 @@ module Jekyll
     # Constants for use in #slugify
     SLUGIFY_MODES = %w(raw default pretty ascii latin).freeze
     SLUGIFY_RAW_REGEXP = Regexp.new('\\s+').freeze
-    SLUGIFY_DEFAULT_REGEXP = Regexp.new("[^[:alnum:]]+").freeze
-    SLUGIFY_PRETTY_REGEXP = Regexp.new("[^[:alnum:]._~!$&'()+,;=@]+").freeze
+    SLUGIFY_DEFAULT_REGEXP = Regexp.new("[^\\p{M}\\p{L}\\p{Nd}]+").freeze
+    SLUGIFY_PRETTY_REGEXP = Regexp.new("[^\\p{M}\\p{L}\\p{Nd}._~!$&'()+,;=@]+").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
@@ -75,11 +68,14 @@ module Jekyll
     #
     # 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
+      array = []
+      value = value_from_singular_key(hash, singular_key)
+      value ||= value_from_plural_key(hash, plural_key)
+
+      array << value
+      array.flatten!
+      array.compact!
+      array
     end
 
     def value_from_singular_key(hash, key)
@@ -140,9 +136,9 @@ module Jekyll
     # Determines whether a given file has
     #
     # Returns true if the YAML front matter is present.
-    # rubocop: disable PredicateName
+    # rubocop: disable Naming/PredicateName
     def has_yaml_header?(file)
-      !!(File.open(file, "rb", &:readline) =~ %r!\A---\s*\r?\n!)
+      File.open(file, "rb", &:readline).match? %r!\A---\s*\r?\n!
     rescue EOFError
       false
     end
@@ -155,7 +151,7 @@ module Jekyll
 
       content.include?("{%") || content.include?("{{")
     end
-    # rubocop: enable PredicateName
+    # rubocop: enable Naming/PredicateName
 
     # Slugify a filename or title.
     #
@@ -219,7 +215,7 @@ module Jekyll
       slug = replace_character_sequence_with_hyphen(string, :mode => mode)
 
       # Remove leading/trailing hyphen
-      slug.gsub!(%r!^\-|\-$!i, "")
+      slug.gsub!(%r!^-|-$!i, "")
 
       slug.downcase! unless cased
       Jekyll.logger.warn("Warning:", "Empty `slug` generated for '#{string}'.") if slug.empty?

data/lib/jekyll/utils/platforms.rb

@@ -72,7 +72,7 @@ module Jekyll
       def proc_version
         @proc_version ||=
           begin
-            Pathutil.new("/proc/version").read
+            File.read("/proc/version")
           rescue Errno::ENOENT, Errno::EACCES
             nil
           end