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

#siteObject (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_bundlerObject


34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/jekyll/plugin_manager.rb', line 34

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_requireObject

Require all the plugins which are allowed.

Returns nothing


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

def conscientious_require
  require_plugin_files
  require_gems
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)

55
56
57
# File 'lib/jekyll/plugin_manager.rb', line 55

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

#plugins_pathObject

Public: Setup the plugin search path

Returns an Array of plugin search paths


83
84
85
86
87
88
89
# File 'lib/jekyll/plugin_manager.rb', line 83

def plugins_path
  if (site.config['plugins'] == Jekyll::Configuration::DEFAULTS['plugins'])
    [site.in_source_dir(site.config['plugins'])]
  else
    Array(site.config['plugins']).map { |d| File.expand_path(d) }
  end
end

#require_gemsObject

Require each of the gem plugins specified.

Returns nothing.


25
26
27
28
29
30
31
32
# File 'lib/jekyll/plugin_manager.rb', line 25

def require_gems
  site.gems.each do |gem|
    if plugin_allowed?(gem)
      Jekyll.logger.debug("PluginManager:", "Requiring #{gem}")
      require gem
    end
  end
end

#require_plugin_filesObject

Require all .rb files if safe mode is off

Returns nothing.


70
71
72
73
74
75
76
77
78
# File 'lib/jekyll/plugin_manager.rb', line 70

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

#whitelistObject

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.

63
64
65
# File 'lib/jekyll/plugin_manager.rb', line 63

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