jekyll 3.10.0 → 4.0.0.pre.alpha1

data/lib/jekyll/tags/include.rb

@@ -2,28 +2,19 @@
 
 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
+      !x.freeze
       VARIABLE_SYNTAX = %r!
         (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)
         (?<params>.*)
-      !mx
+      !mx.freeze
 
-      FULL_VALID_SYNTAX = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!
-      VALID_FILENAME_CHARS = %r!^[\w/.\-()+~\#@]+$!
-      INVALID_SEQUENCES = %r![./]{2,}!
+      FULL_VALID_SYNTAX = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!.freeze
+      VALID_FILENAME_CHARS = %r!^[\w/\.-]+$!.freeze
+      INVALID_SEQUENCES = %r![./]{2,}!.freeze
 
       def initialize(tag_name, markup, tokens)
         super
@@ -50,9 +41,9 @@ module Jekyll
           markup = markup[match.end(0)..-1]
 
           value = if match[2]
-                    match[2].gsub(%r!\\"!, '"')
+                    match[2].gsub('\\"', '"')
                   elsif match[3]
-                    match[3].gsub(%r!\\'!, "'")
+                    match[3].gsub("\\'", "'")
                   elsif match[4]
                     context[match[4]]
                   end
@@ -64,31 +55,31 @@ module Jekyll
 
       def validate_file_name(file)
         if file =~ INVALID_SEQUENCES || file !~ VALID_FILENAME_CHARS
-          raise ArgumentError, <<-MSG
-Invalid syntax for include tag. File contains invalid characters or sequences:
+          raise ArgumentError, <<~MSG
+            Invalid syntax for include tag. File contains invalid characters or sequences:
 
-  #{file}
+              #{file}
 
-Valid syntax:
+            Valid syntax:
 
-  #{syntax_example}
+              #{syntax_example}
 
-MSG
+          MSG
         end
       end
 
       def validate_params
         unless @params =~ FULL_VALID_SYNTAX
-          raise ArgumentError, <<-MSG
-Invalid syntax for include tag:
+          raise ArgumentError, <<~MSG
+            Invalid syntax for include tag:
 
-  #{@params}
+            #{@params}
 
-Valid syntax:
+            Valid syntax:
 
-  #{syntax_example}
+            #{syntax_example}
 
-MSG
+          MSG
         end
       end
 
@@ -99,13 +90,7 @@ MSG
 
       # Render the variable if required
       def render_variable(context)
-        if @file =~ VARIABLE_SYNTAX
-          partial = context.registers[:site]
-            .liquid_renderer
-            .file("(variable)")
-            .parse(@file)
-          partial.render!(context)
-        end
+        Liquid::Template.parse(@file).render(context) if @file =~ VARIABLE_SYNTAX
       end
 
       def tag_includes_dirs(context)
@@ -147,17 +132,12 @@ MSG
       end
 
       def add_include_to_dependency(site, path, context)
-        page = context.registers[:page]
-        return unless page
-        return unless page.key?("path")
-
-        absolute_path = \
-          if page["collection"]
-            site.in_source_dir(site.config["collections_dir"], page["path"])
-          else
-            site.in_source_dir(page["path"])
-          end
-        site.regenerator.add_dependency(absolute_path, path)
+        if 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)
@@ -196,7 +176,7 @@ MSG
 
       # 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
@@ -229,7 +209,6 @@ MSG
             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

data/lib/jekyll/tags/link.rb

@@ -3,9 +3,11 @@
 module Jekyll
   module Tags
     class Link < Liquid::Tag
+      include Jekyll::Filters::URLFilters
+
       class << self
         def tag_name
-          self.name.split("::").last.downcase
+          name.split("::").last.downcase
         end
       end
 
@@ -16,19 +18,21 @@ module Jekyll
       end
 
       def render(context)
+        @context = context
         site = context.registers[:site]
+        relative_path = Liquid::Template.parse(@relative_path).render(context)
 
         site.each_site_file do |item|
-          return item.url if item.relative_path == @relative_path
+          return relative_url(item) if item.relative_path == relative_path
           # This takes care of the case for static files that have a leading /
-          return item.url if item.relative_path == "/#{@relative_path}"
+          return relative_url(item) if item.relative_path == "/#{relative_path}"
         end
 
-        raise ArgumentError, <<-MSG
-Could not find document '#{@relative_path}' in tag '#{self.class.tag_name}'.
+        raise ArgumentError, <<~MSG
+          Could not find document '#{relative_path}' in tag '#{self.class.tag_name}'.
 
-Make sure the document exists and the path is correct.
-MSG
+          Make sure the document exists and the path is correct.
+        MSG
       end
     end
   end

data/lib/jekyll/tags/post_url.rb

@@ -3,7 +3,7 @@
 module Jekyll
   module Tags
     class PostComparer
-      MATCHER = %r!^(.+/)*(\d+-\d+-\d+)-(.*)$!
+      MATCHER = %r!^(.+/)*(\d+-\d+-\d+)-(.*)$!.freeze
 
       attr_reader :path, :date, :slug, :name
 
@@ -13,7 +13,7 @@ module Jekyll
         all, @path, @date, @slug = *name.sub(%r!^/!, "").match(MATCHER)
         unless all
           raise Jekyll::Errors::InvalidPostNameError,
-            "'#{name}' does not contain valid date and/or title."
+                "'#{name}' does not contain valid date and/or title."
         end
 
         escaped_slug = Regexp.escape(slug)
@@ -22,8 +22,10 @@ module Jekyll
       end
 
       def post_date
-        @post_date ||= Utils.parse_date(date,
-          "\"#{date}\" does not contain valid date and/or title.")
+        @post_date ||= Utils.parse_date(
+          date,
+          "'#{date}' does not contain valid date and/or title."
+        )
       end
 
       def ==(other)
@@ -38,6 +40,7 @@ module Jekyll
       end
 
       private
+
       # Construct the directory-aware post slug for a Jekyll::Post
       #
       # other - the Jekyll::Post
@@ -60,13 +63,11 @@ module Jekyll
         begin
           @post = PostComparer.new(@orig_post)
         rescue StandardError => e
-          raise Jekyll::Errors::PostURLError, <<-MSG
-Could not parse name of post "#{@orig_post}" in tag 'post_url'.
-
-Make sure the post exists and the name is correct.
-
-#{e.class}: #{e.message}
-MSG
+          raise Jekyll::Errors::PostURLError, <<~MSG
+            Could not parse name of post "#{@orig_post}" in tag 'post_url'.
+             Make sure the post exists and the name is correct.
+             #{e.class}: #{e.message}
+          MSG
         end
       end
 
@@ -82,6 +83,7 @@ MSG
 
         site.posts.docs.each do |p|
           next unless @post.deprecated_equality p
+
           Jekyll::Deprecator.deprecation_message "A call to "\
             "'{% post_url #{@post.name} %}' did not match " \
             "a post using the new matching method of checking name " \
@@ -90,11 +92,10 @@ MSG
           return p.url
         end
 
-        raise Jekyll::Errors::PostURLError, <<-MSG
-Could not find post "#{@orig_post}" in tag 'post_url'.
-
-Make sure the post exists and the name is correct.
-MSG
+        raise Jekyll::Errors::PostURLError, <<~MSG
+          Could not find post "#{@orig_post}" in tag 'post_url'.
+          Make sure the post exists and the name is correct.
+        MSG
       end
     end
   end

data/lib/jekyll/theme.rb

@@ -3,7 +3,7 @@
 module Jekyll
   class Theme
     extend Forwardable
-    attr_reader :name
+    attr_reader   :name
     def_delegator :gemspec, :version, :version
 
     def initialize(name)
@@ -23,23 +23,24 @@ module Jekyll
     end
 
     def includes_path
-      @includes_path ||= path_for "_includes".freeze
+      @includes_path ||= path_for "_includes"
     end
 
     def layouts_path
-      @layouts_path ||= path_for "_layouts".freeze
+      @layouts_path ||= path_for "_layouts"
     end
 
     def sass_path
-      @sass_path ||= path_for "_sass".freeze
+      @sass_path ||= path_for "_sass"
     end
 
     def assets_path
-      @assets_path ||= path_for "assets".freeze
+      @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
@@ -56,33 +57,21 @@ module Jekyll
     end
 
     def realpath_for(folder)
-      # This resolves all symlinks for the theme subfolder and then ensures
-      # that the directory remains inside the theme root. This prevents the
-      # use of symlinks for theme subfolders to escape the theme root.
+      # This resolves all symlinks for the theme subfolder and then ensures that the directory
+      # remains inside the theme root. This prevents the use of symlinks for theme subfolders to
+      # 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 => e
-      log_realpath_exception(e, folder)
+    rescue Errno::ENOENT, Errno::EACCES, Errno::ELOOP
+      Jekyll.logger.warn "Invalid theme folder:", 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
       raise Jekyll::Errors::MissingDependencyException,
-        "The #{name} theme could not be found."
+            "The #{name} theme could not be found."
     end
   end
 end

data/lib/jekyll/theme_builder.rb

@@ -1,119 +1,121 @@
 # frozen_string_literal: true
 
-class Jekyll::ThemeBuilder
-  SCAFFOLD_DIRECTORIES = %w(
-    assets _layouts _includes _sass
-  ).freeze
-
-  attr_reader :name, :path, :code_of_conduct
+module Jekyll
+  class ThemeBuilder
+    SCAFFOLD_DIRECTORIES = %w(
+      assets _layouts _includes _sass
+    ).freeze
+
+    attr_reader :name, :path, :code_of_conduct
+
+    def initialize(theme_name, opts)
+      @name = theme_name.to_s.tr(" ", "_").squeeze("_")
+      @path = Pathname.new(File.expand_path(name, Dir.pwd))
+      @code_of_conduct = !!opts["code_of_conduct"]
+    end
 
-  def initialize(theme_name, opts)
-    @name = theme_name.to_s.tr(" ", "_").squeeze("_")
-    @path = Pathname.new(File.expand_path(name, Dir.pwd))
-    @code_of_conduct = !!opts["code_of_conduct"]
-  end
+    def create!
+      create_directories
+      create_starter_files
+      create_gemspec
+      create_accessories
+      initialize_git_repo
+    end
 
-  def create!
-    create_directories
-    create_starter_files
-    create_gemspec
-    create_accessories
-    initialize_git_repo
-  end
+    def user_name
+      @user_name ||= `git config user.name`.chomp
+    end
 
-  def user_name
-    @user_name ||= `git config user.name`.chomp
-  end
+    def user_email
+      @user_email ||= `git config user.email`.chomp
+    end
 
-  def user_email
-    @user_email ||= `git config user.email`.chomp
-  end
+    private
 
-  private
+    def root
+      @root ||= Pathname.new(File.expand_path("../", __dir__))
+    end
 
-  def root
-    @root ||= Pathname.new(File.expand_path("../", __dir__))
-  end
+    def template_file(filename)
+      [
+        root.join("theme_template", "#{filename}.erb"),
+        root.join("theme_template", filename.to_s),
+      ].find(&:exist?)
+    end
 
-  def template_file(filename)
-    [
-      root.join("theme_template", "#{filename}.erb"),
-      root.join("theme_template", filename.to_s),
-    ].find(&:exist?)
-  end
+    def template(filename)
+      erb.render(template_file(filename).read)
+    end
 
-  def template(filename)
-    erb.render(template_file(filename).read)
-  end
+    def erb
+      @erb ||= ERBRenderer.new(self)
+    end
 
-  def erb
-    @erb ||= ERBRenderer.new(self)
-  end
+    def mkdir_p(directories)
+      Array(directories).each do |directory|
+        full_path = path.join(directory)
+        Jekyll.logger.info "create", full_path.to_s
+        FileUtils.mkdir_p(full_path)
+      end
+    end
 
-  def mkdir_p(directories)
-    Array(directories).each do |directory|
-      full_path = path.join(directory)
+    def write_file(filename, contents)
+      full_path = path.join(filename)
       Jekyll.logger.info "create", full_path.to_s
-      FileUtils.mkdir_p(full_path)
+      File.write(full_path, contents)
     end
-  end
-
-  def write_file(filename, contents)
-    full_path = path.join(filename)
-    Jekyll.logger.info "create", full_path.to_s
-    File.write(full_path, contents)
-  end
 
-  def create_directories
-    mkdir_p(SCAFFOLD_DIRECTORIES)
-  end
+    def create_directories
+      mkdir_p(SCAFFOLD_DIRECTORIES)
+    end
 
-  def create_starter_files
-    %w(page post default).each do |layout|
-      write_file("_layouts/#{layout}.html", template("_layouts/#{layout}.html"))
+    def create_starter_files
+      %w(page post default).each do |layout|
+        write_file("_layouts/#{layout}.html", template("_layouts/#{layout}.html"))
+      end
     end
-  end
 
-  def create_gemspec
-    write_file("Gemfile", template("Gemfile"))
-    write_file("#{name}.gemspec", template("theme.gemspec"))
-  end
+    def create_gemspec
+      write_file("Gemfile", template("Gemfile"))
+      write_file("#{name}.gemspec", template("theme.gemspec"))
+    end
 
-  def create_accessories
-    accessories = %w(README.md LICENSE.txt)
-    accessories << "CODE_OF_CONDUCT.md" if code_of_conduct
-    accessories.each do |filename|
-      write_file(filename, template(filename))
+    def create_accessories
+      accessories = %w(README.md LICENSE.txt)
+      accessories << "CODE_OF_CONDUCT.md" if code_of_conduct
+      accessories.each do |filename|
+        write_file(filename, template(filename))
+      end
     end
-  end
 
-  def initialize_git_repo
-    Jekyll.logger.info "initialize", path.join(".git").to_s
-    Dir.chdir(path.to_s) { `git init` }
-    write_file(".gitignore", template("gitignore"))
-  end
+    def initialize_git_repo
+      Jekyll.logger.info "initialize", path.join(".git").to_s
+      Dir.chdir(path.to_s) { `git init` }
+      write_file(".gitignore", template("gitignore"))
+    end
 
-  class ERBRenderer
-    extend Forwardable
+    class ERBRenderer
+      extend Forwardable
 
-    def_delegator :@theme_builder, :name, :theme_name
-    def_delegator :@theme_builder, :user_name, :user_name
-    def_delegator :@theme_builder, :user_email, :user_email
+      def_delegator :@theme_builder, :name, :theme_name
+      def_delegator :@theme_builder, :user_name, :user_name
+      def_delegator :@theme_builder, :user_email, :user_email
 
-    def initialize(theme_builder)
-      @theme_builder = theme_builder
-    end
+      def initialize(theme_builder)
+        @theme_builder = theme_builder
+      end
 
-    def jekyll_version_with_minor
-      Jekyll::VERSION.split(".").take(2).join(".")
-    end
+      def jekyll_version_with_minor
+        Jekyll::VERSION.split(".").take(2).join(".")
+      end
 
-    def theme_directories
-      SCAFFOLD_DIRECTORIES
-    end
+      def theme_directories
+        SCAFFOLD_DIRECTORIES
+      end
 
-    def render(contents)
-      ERB.new(contents).result binding
+      def render(contents)
+        ERB.new(contents).result binding
+      end
     end
   end
 end

data/lib/jekyll/url.rb

@@ -68,6 +68,7 @@ module Jekyll
     def generate_url_from_hash(template)
       @placeholders.inject(template) do |result, token|
         break result if result.index(":").nil?
+
         if token.last.nil?
           # Remove leading "/" to avoid generating urls with `//`
           result.gsub("/:#{token.first}", "")
@@ -98,8 +99,8 @@ module Jekyll
         winner = pool.find { |key| @placeholders.key?(key) }
         if winner.nil?
           raise NoMethodError,
-            "The URL template doesn't have #{pool.join(" or ")} keys. "\
-              "Check your permalink template!"
+                "The URL template doesn't have #{pool.join(" or ")} keys. "\
+                "Check your permalink template!"
         end
 
         value = @placeholders[winner]

data/lib/jekyll/utils/ansi.rb

@@ -6,7 +6,7 @@ module Jekyll
       extend self
 
       ESCAPE = format("%c", 27)
-      MATCH = %r!#{ESCAPE}\[(?:\d+)(?:;\d+)*(j|k|m|s|u|A|B|G)|\e\(B\e\[m!ix
+      MATCH = %r!#{ESCAPE}\[(?:\d+)(?:;\d+)*(j|k|m|s|u|A|B|G)|\e\(B\e\[m!ix.freeze
       COLORS = {
         :red     => 31,
         :green   => 32,

data/lib/jekyll/utils/exec.rb

@@ -21,7 +21,6 @@ module Jekyll
         [stdin, stdout, stderr].each(&:close)
         [process.value, out + err]
       end
-
     end
   end
 end

data/lib/jekyll/utils/internet.rb

@@ -3,7 +3,6 @@
 module Jekyll
   module Utils
     module Internet
-
       # Public: Determine whether the present device has a connection to
       # the Internet. This allows plugin writers which require the outside
       # world to have a neat fallback mechanism for offline building.
@@ -18,13 +17,13 @@ module Jekyll
       #   end
       #
       # Returns true if a DNS call can successfully be made, or false if not.
+
       module_function
+
       def connected?
         !dns("example.com").nil?
       end
 
-      private
-      module_function
       def dns(domain)
         require "resolv"
         Resolv::DNS.open do |resolver|
@@ -33,7 +32,6 @@ module Jekyll
       rescue Resolv::ResolvError, Resolv::ResolvTimeout
         nil
       end
-
     end
   end
 end

data/lib/jekyll/utils/platforms.rb

@@ -31,7 +31,7 @@ module Jekyll
       # --
 
       alias_method :really_windows?, \
-        :vanilla_windows?
+                   :vanilla_windows?
 
       #
 
@@ -68,14 +68,14 @@ module Jekyll
       #
 
       private
+
       def proc_version
-        @proc_version ||= begin
-          File.read(
-            "/proc/version"
-          ).downcase
-        rescue Errno::ENOENT
-          nil
-        end
+        @proc_version ||=
+          begin
+            Pathutil.new("/proc/version").read
+          rescue Errno::ENOENT, Errno::EACCES
+            nil
+          end
       end
     end
   end

data/lib/jekyll/utils/thread_event.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "thread"
-
 module Jekyll
   module Utils
     # Based on the pattern and code from
@@ -25,9 +23,7 @@ module Jekyll
 
       def wait
         @lock.synchronize do
-          unless @flag
-            @cond.wait(@lock)
-          end
+          @cond.wait(@lock) unless @flag
         end
       end
     end