Contents

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_plugin_files
      require_gems
    end

    # Require each of the gem plugins specified.
    #
    # Returns nothing.
    def require_gems
      site.gems.each do |gem|
        if plugin_allowed?(gem)
          require gem
        end
      end
    end

    # Check whether a gem plugin is allowed to be used during this build.
    #
    # gem_name - the name of the gem
    #
    # Returns true if the gem name is in the whitelist or if the site is not
    #   in safe mode.
    def plugin_allowed?(gem_name)
      !site.safe || whitelist.include?(gem_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 |plugins|
          Dir[File.join(plugins, "**", "*.rb")].sort.each do |f|
            require f
          end
        end
      end
    end

    # Public: Setup the plugin search path
    #
    # Returns an Array of plugin search paths
    def plugins_path
      if (site.config['plugins'] == Jekyll::Configuration::DEFAULTS['plugins'])
        [Jekyll.sanitized_path(site.source, site.config['plugins'])]
      else
        Array(site.config['plugins']).map { |d| File.expand_path(d) }
      end
    end

  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version	Path
jekyll-2.4.0	lib/jekyll/plugin_manager.rb
jekyll-2.3.0	lib/jekyll/plugin_manager.rb
jekyll-2.2.0	lib/jekyll/plugin_manager.rb
jekyll-2.1.1	lib/jekyll/plugin_manager.rb
jekyll-2.1.0	lib/jekyll/plugin_manager.rb
jekyll-2.0.3	lib/jekyll/plugin_manager.rb
jekyll-2.0.2	lib/jekyll/plugin_manager.rb
jekyll-2.0.1	lib/jekyll/plugin_manager.rb
jekyll-2.0.0	lib/jekyll/plugin_manager.rb
jekyll-2.0.0.rc1	lib/jekyll/plugin_manager.rb
jekyll-2.0.0.alpha.3	lib/jekyll/plugin_manager.rb