jekyll 4.2.1 → 4.3.0

data/lib/jekyll/plugin.rb

@@ -1,92 +1,92 @@
-# frozen_string_literal: true
-
-module Jekyll
-  class Plugin
-    PRIORITIES = {
-      :low     => -10,
-      :highest => 100,
-      :lowest  => -100,
-      :normal  => 0,
-      :high    => 10,
-    }.freeze
-
-    #
-
-    def self.inherited(const)
-      catch_inheritance(const) do |const_|
-        catch_inheritance(const_)
-      end
-    end
-
-    #
-
-    def self.catch_inheritance(const)
-      const.define_singleton_method :inherited do |const_|
-        (@children ||= Set.new).add const_
-        yield const_ if block_given?
-      end
-    end
-
-    #
-
-    def self.descendants
-      @children ||= Set.new
-      out = @children.map(&:descendants)
-      out << self unless superclass == Plugin
-      Set.new(out).flatten
-    end
-
-    # Get or set the priority of this plugin. When called without an
-    # argument it returns the priority. When an argument is given, it will
-    # set the priority.
-    #
-    # priority - The Symbol priority (default: nil). Valid options are:
-    #            :lowest, :low, :normal, :high, :highest
-    #
-    # Returns the Symbol priority.
-    def self.priority(priority = nil)
-      @priority ||= nil
-      @priority = priority if priority && PRIORITIES.key?(priority)
-      @priority || :normal
-    end
-
-    # Get or set the safety of this plugin. When called without an argument
-    # it returns the safety. When an argument is given, it will set the
-    # safety.
-    #
-    # safe - The Boolean safety (default: nil).
-    #
-    # Returns the safety Boolean.
-    def self.safe(safe = nil)
-      @safe = safe unless defined?(@safe) && safe.nil?
-      @safe || false
-    end
-
-    # Spaceship is priority [higher -> lower]
-    #
-    # other - The class to be compared.
-    #
-    # Returns -1, 0, 1.
-    def self.<=>(other)
-      PRIORITIES[other.priority] <=> PRIORITIES[priority]
-    end
-
-    # Spaceship is priority [higher -> lower]
-    #
-    # other - The class to be compared.
-    #
-    # Returns -1, 0, 1.
-    def <=>(other)
-      self.class <=> other.class
-    end
-
-    # Initialize a new plugin. This should be overridden by the subclass.
-    #
-    # config - The Hash of configuration options.
-    #
-    # Returns a new instance.
-    def initialize(config = {})
-      # no-op for default
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  class Plugin
+    PRIORITIES = {
+      :low     => -10,
+      :highest => 100,
+      :lowest  => -100,
+      :normal  => 0,
+      :high    => 10,
+    }.freeze
+
+    #
+
+    def self.inherited(const)
+      catch_inheritance(const) do |const_|
+        catch_inheritance(const_)
+      end
+    end
+
+    #
+
+    def self.catch_inheritance(const)
+      const.define_singleton_method :inherited do |const_|
+        (@children ||= Set.new).add const_
+        yield const_ if block_given?
+      end
+    end
+
+    #
+
+    def self.descendants
+      @children ||= Set.new
+      out = @children.map(&:descendants)
+      out << self unless superclass == Plugin
+      Set.new(out).flatten
+    end
+
+    # Get or set the priority of this plugin. When called without an
+    # argument it returns the priority. When an argument is given, it will
+    # set the priority.
+    #
+    # priority - The Symbol priority (default: nil). Valid options are:
+    #            :lowest, :low, :normal, :high, :highest
+    #
+    # Returns the Symbol priority.
+    def self.priority(priority = nil)
+      @priority ||= nil
+      @priority = priority if priority && PRIORITIES.key?(priority)
+      @priority || :normal
+    end
+
+    # Get or set the safety of this plugin. When called without an argument
+    # it returns the safety. When an argument is given, it will set the
+    # safety.
+    #
+    # safe - The Boolean safety (default: nil).
+    #
+    # Returns the safety Boolean.
+    def self.safe(safe = nil)
+      @safe = safe unless defined?(@safe) && safe.nil?
+      @safe || false
+    end
+
+    # Spaceship is priority [higher -> lower]
+    #
+    # other - The class to be compared.
+    #
+    # Returns -1, 0, 1.
+    def self.<=>(other)
+      PRIORITIES[other.priority] <=> PRIORITIES[priority]
+    end
+
+    # Spaceship is priority [higher -> lower]
+    #
+    # other - The class to be compared.
+    #
+    # Returns -1, 0, 1.
+    def <=>(other)
+      self.class <=> other.class
+    end
+
+    # Initialize a new plugin. This should be overridden by the subclass.
+    #
+    # config - The Hash of configuration options.
+    #
+    # Returns a new instance.
+    def initialize(config = {})
+      # no-op for default
+    end
+  end
+end

data/lib/jekyll/plugin_manager.rb

@@ -1,115 +1,123 @@
-# frozen_string_literal: true
-
-module Jekyll
-  class PluginManager
-    attr_reader :site
-
-    # Create an instance of this class.
-    #
-    # site - the instance of Jekyll::Site we're concerned with
-    #
-    # Returns nothing
-    def initialize(site)
-      @site = site
-    end
-
-    # Require all the plugins which are allowed.
-    #
-    # Returns nothing
-    def conscientious_require
-      require_theme_deps if site.theme
-      require_plugin_files
-      require_gems
-      deprecation_checks
-    end
-
-    # Require each of the gem plugins specified.
-    #
-    # Returns nothing.
-    def require_gems
-      Jekyll::External.require_with_graceful_fail(
-        site.gems.select { |plugin| plugin_allowed?(plugin) }
-      )
-    end
-
-    # Require each of the runtime_dependencies specified by the theme's gemspec.
-    #
-    # Returns false only if no dependencies have been specified, otherwise nothing.
-    def require_theme_deps
-      return false unless site.theme.runtime_dependencies
-
-      site.theme.runtime_dependencies.each do |dep|
-        next if dep.name == "jekyll"
-
-        External.require_with_graceful_fail(dep.name) if plugin_allowed?(dep.name)
-      end
-    end
-
-    def self.require_from_bundler
-      if !ENV["JEKYLL_NO_BUNDLER_REQUIRE"] && File.file?("Gemfile")
-        require "bundler"
-
-        Bundler.setup
-        required_gems = Bundler.require(:jekyll_plugins)
-        message = "Required #{required_gems.map(&:name).join(", ")}"
-        Jekyll.logger.debug("PluginManager:", message)
-        ENV["JEKYLL_NO_BUNDLER_REQUIRE"] = "true"
-
-        true
-      else
-        false
-      end
-    end
-
-    # Check whether a gem plugin is allowed to be used during this build.
-    #
-    # plugin_name - the name of the plugin
-    #
-    # Returns true if the plugin name is in the whitelist or if the site is not
-    #   in safe mode.
-    def plugin_allowed?(plugin_name)
-      !site.safe || whitelist.include?(plugin_name)
-    end
-
-    # Build an array of allowed plugin gem names.
-    #
-    # Returns an array of strings, each string being the name of a gem name
-    #   that is allowed to be used.
-    def whitelist
-      @whitelist ||= Array[site.config["whitelist"]].flatten
-    end
-
-    # Require all .rb files if safe mode is off
-    #
-    # Returns nothing.
-    def require_plugin_files
-      unless site.safe
-        plugins_path.each do |plugin_search_path|
-          plugin_files = Utils.safe_glob(plugin_search_path, File.join("**", "*.rb"))
-          Jekyll::External.require_with_graceful_fail(plugin_files)
-        end
-      end
-    end
-
-    # Public: Setup the plugin search path
-    #
-    # Returns an Array of plugin search paths
-    def plugins_path
-      if site.config["plugins_dir"].eql? Jekyll::Configuration::DEFAULTS["plugins_dir"]
-        [site.in_source_dir(site.config["plugins_dir"])]
-      else
-        Array(site.config["plugins_dir"]).map { |d| File.expand_path(d) }
-      end
-    end
-
-    def deprecation_checks
-      pagination_included = (site.config["plugins"] || []).include?("jekyll-paginate") ||
-        defined?(Jekyll::Paginate)
-      if site.config["paginate"] && !pagination_included
-        Jekyll::Deprecator.deprecation_message "You appear to have pagination " \
-          "turned on, but you haven't included the `jekyll-paginate` gem. " \
-          "Ensure you have `plugins: [jekyll-paginate]` in your configuration file."
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  class PluginManager
+    attr_reader :site
+
+    # Create an instance of this class.
+    #
+    # site - the instance of Jekyll::Site we're concerned with
+    #
+    # Returns nothing
+    def initialize(site)
+      @site = site
+    end
+
+    # Require all the plugins which are allowed.
+    #
+    # Returns nothing
+    def conscientious_require
+      require_theme_deps if site.theme
+      require_plugin_files
+      require_gems
+      deprecation_checks
+    end
+
+    # Require each of the gem plugins specified.
+    #
+    # Returns nothing.
+    def require_gems
+      Jekyll::External.require_with_graceful_fail(
+        site.gems.select { |plugin| plugin_allowed?(plugin) }
+      )
+    end
+
+    # Require each of the runtime_dependencies specified by the theme's gemspec.
+    #
+    # Returns false only if no dependencies have been specified, otherwise nothing.
+    def require_theme_deps
+      return false unless site.theme.runtime_dependencies
+
+      site.theme.runtime_dependencies.each do |dep|
+        next if dep.name == "jekyll"
+
+        External.require_with_graceful_fail(dep.name) if plugin_allowed?(dep.name)
+      end
+    end
+
+    def self.require_from_bundler
+      if !ENV["JEKYLL_NO_BUNDLER_REQUIRE"] && gemfile_exists?
+        require "bundler"
+
+        Bundler.setup
+        required_gems = Bundler.require(:jekyll_plugins)
+        message = "Required #{required_gems.map(&:name).join(", ")}"
+        Jekyll.logger.debug("PluginManager:", message)
+        ENV["JEKYLL_NO_BUNDLER_REQUIRE"] = "true"
+
+        true
+      else
+        false
+      end
+    end
+
+    # Check for the existence of a Gemfile.
+    #
+    # Returns true if a Gemfile exists in the places bundler will look
+    def self.gemfile_exists?
+      File.file?("Gemfile") || (ENV["BUNDLE_GEMFILE"] && File.file?(ENV["BUNDLE_GEMFILE"]))
+    end
+
+    # Check whether a gem plugin is allowed to be used during this build.
+    #
+    # plugin_name - the name of the plugin
+    #
+    # Returns true if the plugin name is in the whitelist or if the site is not
+    #   in safe mode.
+    def plugin_allowed?(plugin_name)
+      !site.safe || whitelist.include?(plugin_name)
+    end
+
+    # Build an array of allowed plugin gem names.
+    #
+    # Returns an array of strings, each string being the name of a gem name
+    #   that is allowed to be used.
+    def whitelist
+      @whitelist ||= Array[site.config["whitelist"]].flatten
+    end
+
+    # Require all .rb files if safe mode is off
+    #
+    # Returns nothing.
+    def require_plugin_files
+      unless site.safe
+        plugins_path.each do |plugin_search_path|
+          plugin_files = Utils.safe_glob(plugin_search_path, File.join("**", "*.rb"))
+          Jekyll::External.require_with_graceful_fail(plugin_files)
+        end
+      end
+    end
+
+    # Public: Setup the plugin search path
+    #
+    # Returns an Array of plugin search paths
+    def plugins_path
+      if site.config["plugins_dir"].eql? Jekyll::Configuration::DEFAULTS["plugins_dir"]
+        [site.in_source_dir(site.config["plugins_dir"])]
+      else
+        Array(site.config["plugins_dir"]).map { |d| File.expand_path(d) }
+      end
+    end
+
+    def deprecation_checks
+      pagination_included = (site.config["plugins"] || []).include?("jekyll-paginate") ||
+        defined?(Jekyll::Paginate)
+      if site.config["paginate"] && !pagination_included
+        Jekyll::Deprecator.deprecation_message <<~MSG
+          You appear to have pagination turned on, but you haven't included the `jekyll-paginate`
+          gem. Ensure you have `plugins: [jekyll-paginate]` in your configuration file.
+        MSG
+      end
+    end
+  end
+end

data/lib/jekyll/profiler.rb

@@ -1,58 +1,55 @@
-# frozen_string_literal: true
-
-module Jekyll
-  class Profiler
-    TERMINAL_TABLE_STYLES = {
-      :alignment     => :right,
-      :border_top    => false,
-      :border_bottom => false,
-    }.freeze
-    private_constant :TERMINAL_TABLE_STYLES
-
-    def self.tabulate(table_rows)
-      require "terminal-table"
-
-      rows   = table_rows.dup
-      header = rows.shift
-      footer = rows.pop
-      output = +"\n"
-
-      table = Terminal::Table.new do |t|
-        t << header
-        t << :separator
-        rows.each { |row| t << row }
-        t << :separator
-        t << footer
-        t.style = TERMINAL_TABLE_STYLES
-        t.align_column(0, :left)
-      end
-
-      output << table.to_s << "\n"
-    end
-
-    def initialize(site)
-      @site = site
-    end
-
-    def profile_process
-      profile_data = { "PHASE" => "TIME" }
-      total_time = 0
-
-      [:reset, :read, :generate, :render, :cleanup, :write].each do |method|
-        start_time = Time.now
-        @site.send(method)
-        end_time = (Time.now - start_time).round(4)
-        profile_data[method.to_s.upcase] = format("%.4f", end_time)
-        total_time += end_time
-      end
-
-      profile_data["TOTAL TIME"] = format("%.4f", total_time)
-
-      Jekyll.logger.info "\nBuild Process Summary:"
-      Jekyll.logger.info Profiler.tabulate(Array(profile_data))
-
-      Jekyll.logger.info "\nSite Render Stats:"
-      @site.print_stats
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  class Profiler
+    TERMINAL_TABLE_STYLES = {
+      :alignment     => :right,
+      :border_top    => false,
+      :border_bottom => false,
+    }.freeze
+    private_constant :TERMINAL_TABLE_STYLES
+
+    def self.tabulate(table_rows)
+      require "terminal-table"
+
+      rows   = table_rows.dup
+      header = rows.shift
+      output = +"\n"
+
+      table = Terminal::Table.new do |t|
+        t << header
+        t << :separator
+        rows.each { |row| t << row }
+        t.style = TERMINAL_TABLE_STYLES
+        t.align_column(0, :left)
+      end
+
+      output << table.to_s << "\n"
+    end
+
+    def initialize(site)
+      @site = site
+    end
+
+    def profile_process
+      profile_data = { "PHASE" => "TIME" }
+      total_time = 0
+
+      [:reset, :read, :generate, :render, :cleanup, :write].each do |method|
+        start_time = Time.now
+        @site.send(method)
+        end_time = (Time.now - start_time).round(4)
+        profile_data[method.to_s.upcase] = format("%.4f", end_time)
+        total_time += end_time
+      end
+
+      profile_data["TOTAL TIME"] = format("%.4f", total_time)
+
+      Jekyll.logger.info "\nBuild Process Summary:"
+      Jekyll.logger.info Profiler.tabulate(Array(profile_data))
+
+      Jekyll.logger.info "\nSite Render Stats:"
+      @site.print_stats
+    end
+  end
+end

data/lib/jekyll/publisher.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-module Jekyll
-  class Publisher
-    def initialize(site)
-      @site = site
-    end
-
-    def publish?(thing)
-      can_be_published?(thing) && !hidden_in_the_future?(thing)
-    end
-
-    def hidden_in_the_future?(thing)
-      thing.respond_to?(:date) && !@site.future && thing.date.to_i > @site.time.to_i
-    end
-
-    private
-
-    def can_be_published?(thing)
-      thing.data.fetch("published", true) || @site.unpublished
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  class Publisher
+    def initialize(site)
+      @site = site
+    end
+
+    def publish?(thing)
+      can_be_published?(thing) && !hidden_in_the_future?(thing)
+    end
+
+    def hidden_in_the_future?(thing)
+      thing.respond_to?(:date) && !@site.future && thing.date.to_i > @site.time.to_i
+    end
+
+    private
+
+    def can_be_published?(thing)
+      thing.data.fetch("published", true) || @site.unpublished
+    end
+  end
+end