jekyll 3.9.3 → 4.4.1

data/lib/jekyll/theme.rb

@@ -3,14 +3,14 @@
 module Jekyll
   class Theme
     extend Forwardable
-    attr_reader :name
+    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
@@ -18,30 +18,33 @@ module Jekyll
       # Otherwise, Jekyll.sanitized path with prepend the unresolved root
       @root ||= File.realpath(gemspec.full_gem_path)
     rescue Errno::ENOENT, Errno::EACCES, Errno::ELOOP
-      raise "Path #{gemspec.full_gem_path} does not exist, is not accessible "\
-        "or includes a symbolic link loop"
+      raise "Path #{gemspec.full_gem_path} does not exist, is not accessible 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".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
+    def data_path
+      @data_path ||= path_for "_data"
     end
 
     def runtime_dependencies
@@ -56,9 +59,9 @@ 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
@@ -73,8 +76,7 @@ module Jekyll
       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."
+        Jekyll.logger.error "Theme error:", "Directory '#{folder}' includes a symbolic link loop."
       end
     end
 
@@ -82,7 +84,7 @@ module Jekyll
       @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 _data _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}", "")
@@ -93,28 +94,31 @@ 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?
           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]
         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
@@ -128,6 +132,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 "/").
       #
@@ -138,8 +144,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
@@ -153,7 +158,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/ansi.rb

@@ -1,4 +1,4 @@
-# Frozen-string-literal: true
+# frozen_string_literal: true
 
 module Jekyll
   module Utils
@@ -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

@@ -5,77 +5,62 @@ 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?
+      def linux?
+        linux_os? && !microsoft_proc_version?
       end
 
-      #
+      def osx?
+        rbconfig_host.match?(%r!darwin|mac os!)
+      end
 
-      def linux?
-        RbConfig::CONFIG["host_os"] =~ %r!linux! && \
-          proc_version !~ %r!microsoft!i
+      def unix?
+        rbconfig_host.match?(%r!solaris|bsd!)
       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.
+      private
+
+      def proc_version
+        @proc_version ||= \
+          begin
+            File.read("/proc/version").downcase
+          rescue Errno::ENOENT, Errno::EACCES
+            ""
+          end
+      end
 
-      { :osx? => %r!darwin|mac os!, :unix? => %r!solaris|bsd! }.each do |k, v|
-        define_method k do
-          !!(
-            RbConfig::CONFIG["host_os"] =~ v
-          )
-        end
+      def rbconfig_host
+        @rbconfig_host ||= RbConfig::CONFIG["host_os"].downcase
       end
 
-      #
+      def linux_os?
+        rbconfig_host.include?("linux")
+      end
 
-      private
-      def proc_version
-        @proc_version ||= begin
-          File.read(
-            "/proc/version"
-          ).downcase
-        rescue Errno::ENOENT
-          nil
-        end
+      def microsoft_proc_version?
+        proc_version.include?("microsoft")
       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