jekyll 4.0.1 → 4.2.1

data/lib/jekyll/tags/post_url.rb

@@ -1,107 +1,106 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Tags
-    class PostComparer
-      MATCHER = %r!^(.+/)*(\d+-\d+-\d+)-(.*)$!.freeze
-
-      attr_reader :path, :date, :slug, :name
-
-      def initialize(name)
-        @name = name
-
-        all, @path, @date, @slug = *name.sub(%r!^/!, "").match(MATCHER)
-        unless all
-          raise Jekyll::Errors::InvalidPostNameError,
-                "'#{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
-      end
-
-      def post_date
-        @post_date ||= Utils.parse_date(
-          date,
-          "'#{date}' does not contain valid date and/or title."
-        )
-      end
-
-      def ==(other)
-        other.relative_path.match(@name_regex)
-      end
-
-      def deprecated_equality(other)
-        slug == post_slug(other) &&
-          post_date.year  == other.date.year &&
-          post_date.month == other.date.month &&
-          post_date.day   == other.date.day
-      end
-
-      private
-
-      # Construct the directory-aware post slug for a Jekyll::Post
-      #
-      # other - the Jekyll::Post
-      #
-      # Returns the post slug with the subdirectory (relative to _posts)
-      def post_slug(other)
-        path = other.basename.split("/")[0...-1].join("/")
-        if path.nil? || path == ""
-          other.data["slug"]
-        else
-          path + "/" + other.data["slug"]
-        end
-      end
-    end
-
-    class PostUrl < Liquid::Tag
-      include Jekyll::Filters::URLFilters
-
-      def initialize(tag_name, post, tokens)
-        super
-        @orig_post = post.strip
-        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
-        end
-      end
-
-      def render(context)
-        @context = context
-        site = context.registers[:site]
-
-        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 |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 relative_url(document)
-        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
-      end
-    end
-  end
-end
-
-Liquid::Template.register_tag("post_url", Jekyll::Tags::PostUrl)
+# frozen_string_literal: true
+
+module Jekyll
+  module Tags
+    class PostComparer
+      MATCHER = %r!^(.+/)*(\d+-\d+-\d+)-(.*)$!.freeze
+
+      attr_reader :path, :date, :slug, :name
+
+      def initialize(name)
+        @name = name
+
+        all, @path, @date, @slug = *name.sub(%r!^/!, "").match(MATCHER)
+        unless all
+          raise Jekyll::Errors::InvalidPostNameError,
+                "'#{name}' does not contain valid date and/or title."
+        end
+
+        basename_pattern = "#{date}-#{Regexp.escape(slug)}\\.[^.]+"
+        @name_regex = %r!^_posts/#{path}#{basename_pattern}|^#{path}_posts/?#{basename_pattern}!
+      end
+
+      def post_date
+        @post_date ||= Utils.parse_date(
+          date,
+          "'#{date}' does not contain valid date and/or title."
+        )
+      end
+
+      def ==(other)
+        other.relative_path.match(@name_regex)
+      end
+
+      def deprecated_equality(other)
+        slug == post_slug(other) &&
+          post_date.year  == other.date.year &&
+          post_date.month == other.date.month &&
+          post_date.day   == other.date.day
+      end
+
+      private
+
+      # Construct the directory-aware post slug for a Jekyll::Post
+      #
+      # other - the Jekyll::Post
+      #
+      # Returns the post slug with the subdirectory (relative to _posts)
+      def post_slug(other)
+        path = other.basename.split("/")[0...-1].join("/")
+        if path.nil? || path == ""
+          other.data["slug"]
+        else
+          "#{path}/#{other.data["slug"]}"
+        end
+      end
+    end
+
+    class PostUrl < Liquid::Tag
+      include Jekyll::Filters::URLFilters
+
+      def initialize(tag_name, post, tokens)
+        super
+        @orig_post = post.strip
+        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
+        end
+      end
+
+      def render(context)
+        @context = context
+        site = context.registers[:site]
+
+        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 |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 relative_url(document)
+        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
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("post_url", Jekyll::Tags::PostUrl)

data/lib/jekyll/theme.rb

@@ -1,80 +1,86 @@
-# frozen_string_literal: true
-
-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
-    end
-
-    def root
-      # Must use File.realpath to resolve symlinks created by rbenv
-      # 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"
-    end
-
-    def includes_path
-      @includes_path ||= path_for "_includes"
-    end
-
-    def layouts_path
-      @layouts_path ||= path_for "_layouts"
-    end
-
-    def sass_path
-      @sass_path ||= path_for "_sass"
-    end
-
-    def assets_path
-      @assets_path ||= path_for "assets"
-    end
-
-    def runtime_dependencies
-      gemspec.runtime_dependencies
-    end
-
-    private
-
-    def path_for(folder)
-      path = realpath_for(folder)
-      path if path && File.directory?(path)
-    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.
-      # 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)
-      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."
-    end
-  end
-end
+# frozen_string_literal: true
+
+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
+    end
+
+    def root
+      # Must use File.realpath to resolve symlinks created by rbenv
+      # 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"
+    end
+
+    # The name of theme directory
+    def basename
+      @basename ||= File.basename(root)
+    end
+
+    def includes_path
+      @includes_path ||= path_for "_includes"
+    end
+
+    def layouts_path
+      @layouts_path ||= path_for "_layouts"
+    end
+
+    def sass_path
+      @sass_path ||= path_for "_sass"
+    end
+
+    def assets_path
+      @assets_path ||= path_for "assets"
+    end
+
+    def runtime_dependencies
+      gemspec.runtime_dependencies
+    end
+
+    private
+
+    def path_for(folder)
+      path = realpath_for(folder)
+      path if path && File.directory?(path)
+    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.
+      # 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)
+      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."
+    end
+  end
+end

data/lib/jekyll/theme_builder.rb

@@ -1,121 +1,121 @@
-# frozen_string_literal: true
-
-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 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_email
-      @user_email ||= `git config user.email`.chomp
-    end
-
-    private
-
-    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(filename)
-      erb.render(template_file(filename).read)
-    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 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_starter_files
-      %w(page post default).each do |layout|
-        write_file("_layouts/#{layout}.html", template("_layouts/#{layout}.html"))
-      end
-    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))
-      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
-
-    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 initialize(theme_builder)
-        @theme_builder = theme_builder
-      end
-
-      def jekyll_version_with_minor
-        Jekyll::VERSION.split(".").take(2).join(".")
-      end
-
-      def theme_directories
-        SCAFFOLD_DIRECTORIES
-      end
-
-      def render(contents)
-        ERB.new(contents).result binding
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+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 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_email
+      @user_email ||= `git config user.email`.chomp
+    end
+
+    private
+
+    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(filename)
+      erb.render(template_file(filename).read)
+    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 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_starter_files
+      %w(page post default).each do |layout|
+        write_file("_layouts/#{layout}.html", template("_layouts/#{layout}.html"))
+      end
+    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))
+      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
+
+    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 initialize(theme_builder)
+        @theme_builder = theme_builder
+      end
+
+      def jekyll_version_with_minor
+        Jekyll::VERSION.split(".").take(2).join(".")
+      end
+
+      def theme_directories
+        SCAFFOLD_DIRECTORIES
+      end
+
+      def render(contents)
+        ERB.new(contents).result binding
+      end
+    end
+  end
+end