jekyll 4.0.0.pre.beta1 → 4.2.0

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
 
@@ -54,8 +55,8 @@ module Jekyll
     #
     # Returns destination file path.
     def destination(dest)
-      dest = @site.in_dest_dir(dest)
-      @site.in_dest_dir(dest, Jekyll::URL.unescape_path(url))
+      @destination ||= {}
+      @destination[dest] ||= @site.in_dest_dir(dest, Jekyll::URL.unescape_path(url))
     end
 
     def destination_rel_dir
@@ -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/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
@@ -35,20 +36,16 @@ module Jekyll
 
       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('\\"', '"')
-                  elsif match[3]
-                    match[3].gsub("\\'", "'")
-                  elsif match[4]
-                    context[match[4]]
+        @params.scan(VALID_SYNTAX) do |key, d_quoted, s_quoted, variable|
+          value = if d_quoted
+                    d_quoted.include?('\\"') ? d_quoted.gsub('\\"', '"') : d_quoted
+                  elsif s_quoted
+                    s_quoted.include?("\\'") ? s_quoted.gsub("\\'", "'") : s_quoted
+                  elsif variable
+                    context[variable]
                   end
 
-          params[match[1]] = value
+          params[key] = value
         end
         params
       end
@@ -176,7 +173,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,30 +189,82 @@ 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.config["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
       end
 
       def page_path(context)
-        if context.registers[:page].nil?
-          context.registers[:site].source
-        else
-          site = context.registers[:site]
-          page_payload  = context.registers[:page]
-          resource_path = \
-            if page_payload["collection"].nil?
-              page_payload["path"]
-            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
+        page, site = context.registers.values_at(:page, :site)
+        return site.source unless page
+
+        site.in_source_dir File.dirname(resource_path(page, site))
+      end
+
+      private
+
+      def resource_path(page, site)
+        path = page["path"]
+        path = File.join(site.config["collections_dir"], path) if page["collection"]
+        path.sub(%r!/#excerpt\z!, "")
       end
     end
   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/link.rb

@@ -21,11 +21,12 @@ module Jekyll
         @context = context
         site = context.registers[:site]
         relative_path = Liquid::Template.parse(@relative_path).render(context)
+        relative_path_with_leading_slash = PathManager.join("", relative_path)
 
         site.each_site_file do |item|
           return relative_url(item) if item.relative_path == relative_path
           # This takes care of the case for static files that have a leading /
-          return relative_url(item) if item.relative_path == "/#{relative_path}"
+          return relative_url(item) if item.relative_path == relative_path_with_leading_slash
         end
 
         raise ArgumentError, <<~MSG

data/lib/jekyll/tags/post_url.rb

@@ -16,9 +16,8 @@ module Jekyll
                 "'#{name}' does not contain valid date and/or title."
         end
 
-        escaped_slug = Regexp.escape(slug)
-        @name_regex = %r!^_posts/#{path}#{date}-#{escaped_slug}\.[^.]+|
-          ^#{path}_posts/?#{date}-#{escaped_slug}\.[^.]+!x
+        basename_pattern = "#{date}-#{Regexp.escape(slug)}\\.[^.]+"
+        @name_regex = %r!^_posts/#{path}#{basename_pattern}|^#{path}_posts/?#{basename_pattern}!
       end
 
       def post_date
@@ -51,7 +50,7 @@ module Jekyll
         if path.nil? || path == ""
           other.data["slug"]
         else
-          path + "/" + other.data["slug"]
+          "#{path}/#{other.data["slug"]}"
         end
       end
     end

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

data/lib/jekyll/url.rb

@@ -94,7 +94,8 @@ module Jekyll
 
     def generate_url_from_drop(template)
       template.gsub(%r!:([a-z_]+)!) do |match|
-        pool = possible_keys(match.sub(":", ""))
+        name = Regexp.last_match(1)
+        pool = name.end_with?("_") ? [name, name.chomp!("_")] : [name]
 
         winner = pool.find { |key| @placeholders.key?(key) }
         if winner.nil?
@@ -107,15 +108,17 @@ module Jekyll
         value = "" if value.nil?
         replacement = self.class.escape_path(value)
 
-        match.sub(":#{winner}", replacement)
-      end.squeeze("/")
+        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("..", "/").gsub("./", "").squeeze("/")
+      "/#{str}".gsub("..", "/").tap do |result|
+        result.gsub!("./", "")
+        result.squeeze!("/")
+      end
     end
 
     # Escapes a path to be a valid URL path segment

data/lib/jekyll/utils.rb

@@ -13,8 +13,8 @@ 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 a slug and turns it into a simple title.
@@ -136,7 +136,7 @@ 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).match? %r!\A---\s*\r?\n!
     rescue EOFError
@@ -151,7 +151,7 @@ module Jekyll
 
       content.include?("{%") || content.include?("{{")
     end
-    # rubocop: enable PredicateName
+    # rubocop: enable Naming/PredicateName
 
     # Slugify a filename or title.
     #
@@ -215,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

@@ -5,78 +5,63 @@ module Jekyll
     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.
+      def jruby?
+        RUBY_ENGINE == "jruby"
+      end
 
-      { :jruby? => "jruby", :mri? => "ruby" }.each do |k, v|
-        define_method k do
-          ::RUBY_ENGINE == v
-        end
+      def mri?
+        RUBY_ENGINE == "ruby"
       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 windows?
+        vanilla_windows? || bash_on_windows?
+      end
 
+      # Not a Windows Subsystem for Linux (WSL)
       def vanilla_windows?
-        RbConfig::CONFIG["host_os"] =~ %r!mswin|mingw|cygwin!i && \
-          !proc_version
+        rbconfig_host.match?(%r!mswin|mingw|cygwin!) && proc_version.empty?
       end
+      alias_method :really_windows?, :vanilla_windows?
 
-      # --
-      # XXX: Remove in 4.0
-      # --
-
-      alias_method :really_windows?, \
-                   :vanilla_windows?
-
-      #
-
+      # Determine if Windows Subsystem for Linux (WSL)
       def bash_on_windows?
-        RbConfig::CONFIG["host_os"] =~ %r!linux! && \
-          proc_version =~ %r!microsoft!i
+        linux_os? && microsoft_proc_version?
       end
 
-      #
-
-      def windows?
-        vanilla_windows? || bash_on_windows?
-      end
-
-      #
-
       def linux?
-        RbConfig::CONFIG["host_os"] =~ %r!linux! && \
-          proc_version !~ %r!microsoft!i
+        linux_os? && !microsoft_proc_version?
       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
+      def osx?
+        rbconfig_host.match?(%r!darwin|mac os!)
       end
 
-      #
+      def unix?
+        rbconfig_host.match?(%r!solaris|bsd!)
+      end
 
       private
 
       def proc_version
-        @proc_version ||=
+        @proc_version ||= \
           begin
-            File.read("/proc/version")
+            File.read("/proc/version").downcase
           rescue Errno::ENOENT, Errno::EACCES
-            nil
+            ""
           end
       end
+
+      def rbconfig_host
+        @rbconfig_host ||= RbConfig::CONFIG["host_os"].downcase
+      end
+
+      def linux_os?
+        rbconfig_host.include?("linux")
+      end
+
+      def microsoft_proc_version?
+        proc_version.include?("microsoft")
+      end
     end
   end
 end