Class: Jekyll::PluginManager

Inherits:
Object
  • Object
show all
Defined in:
lib/jekyll/plugin_manager.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(site) ⇒ PluginManager

Create an instance of this class.

site - the instance of Jekyll::Site we’re concerned with

Returns nothing



10
11
12
 
# File 'lib/jekyll/plugin_manager.rb', line 10

def initialize(site)
  @site = site
end

Instance Attribute Details

#site ⇒ Object (readonly)

Returns the value of attribute site.



3
4
5
 
# File 'lib/jekyll/plugin_manager.rb', line 3

def site
  @site
end

Class Method Details

.require_from_bundler ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/jekyll/plugin_manager.rb', line 30

def self.require_from_bundler
  if !ENV["JEKYLL_NO_BUNDLER_REQUIRE"] && File.file?("Gemfile")
    require "bundler"
    Bundler.setup # puts all groups on the load path
    required_gems = Bundler.require(:jekyll_plugins) # requires the gems in this group only
    Jekyll.logger.debug("PluginManager:", "Required #{required_gems.map(&:name).join(', ')}")
    ENV["JEKYLL_NO_BUNDLER_REQUIRE"] = "true"
    true
  else
    false
  end
rescue LoadError, Bundler::GemfileNotFound
  false
end

Instance Method Details

#conscientious_require ⇒ Object

Require all the plugins which are allowed.

Returns nothing



17
18
19
20
21
 
# File 'lib/jekyll/plugin_manager.rb', line 17

def conscientious_require
  require_plugin_files
  require_gems
  deprecation_checks
end

#deprecation_checks ⇒ Object 



86
87
88
89
90
91
92
93
 
# File 'lib/jekyll/plugin_manager.rb', line 86

def deprecation_checks
  pagination_included = (site.config['gems'] || []).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 `gems: [jekyll-paginate]` in your configuration file."
  end
end

#plugin_allowed?(gem_name) ⇒ Boolean

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.

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/jekyll/plugin_manager.rb', line 51

def plugin_allowed?(gem_name)
  !site.safe || whitelist.include?(gem_name)
end

#plugins_path ⇒ Object

Public: Setup the plugin search path

Returns an Array of plugin search paths



78
79
80
81
82
83
84
 
# File 'lib/jekyll/plugin_manager.rb', line 78

def plugins_path
  if site.config['plugins_dir'] == 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

#require_gems ⇒ Object

Require each of the gem plugins specified.

Returns nothing.



26
27
28
 
# File 'lib/jekyll/plugin_manager.rb', line 26

def require_gems
  Jekyll::External.require_with_graceful_fail(site.gems.select { |gem| plugin_allowed?(gem) })
end

#require_plugin_files ⇒ Object

Require all .rb files if safe mode is off

Returns nothing.



66
67
68
69
70
71
72
73
 
# File 'lib/jekyll/plugin_manager.rb', line 66

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

#whitelist ⇒ Object

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.



59
60
61
 
# File 'lib/jekyll/plugin_manager.rb', line 59

def whitelist
  @whitelist ||= Array[site.config['whitelist']].flatten
end