Class: Bridgetown::PluginManager

Inherits:
Object
  • Object
show all
Defined in:
bridgetown-core/lib/bridgetown-core/plugin_manager.rb

Constant Summary collapse

YARN_DEPENDENCY_REGEXP = 
%r!(.+)@([^@]*)$!

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(site) ⇒ PluginManager

Provides a plugin manager for the site

Parameters:



149
150
151
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 149

def initialize(site)
  @site = site
end

Class Attribute Details

.registered_plugins ⇒ Object (readonly)

Returns the value of attribute registered_plugins.



16
17
18
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 16

def registered_plugins
  @registered_plugins
end

Instance Attribute Details

#loaders_manager ⇒ Object (readonly)

Returns the value of attribute loaders_manager.



7
8
9
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 7

def loaders_manager
  @loaders_manager
end

#site ⇒ Object (readonly)

Returns the value of attribute site.



7
8
9
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 7

def site
  @site
end

Class Method Details

.add_registered_plugin(gem_or_plugin_file) ⇒ Object 



11
12
13
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 11

def self.add_registered_plugin(gem_or_plugin_file)
  @registered_plugins << gem_or_plugin_file
end

.add_yarn_dependency?(yarn_dependency, package_json) ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
133
134
135
136
137
138
139
140
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 130

def self.add_yarn_dependency?(yarn_dependency, package_json)
  return false if yarn_dependency.nil?

  # check matching version number is see if it's already installed
  if package_json["dependencies"]
    current_version = package_json["dependencies"][yarn_dependency.first]
    package_requires_updating?(current_version, yarn_dependency.last)
  else
    true
  end
end

.bundler_specs ⇒ Object 



18
19
20
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 18

def bundler_specs
  @bundler_specs ||= Bundler.load.requested_specs
end

.find_yarn_dependency(loaded_gem) ⇒ Object

rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity



123
124
125
126
127
128
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 123

def self.find_yarn_dependency(loaded_gem)
  yarn_dependency = loaded_gem.to_spec&.metadata&.dig("yarn-add")&.match(YARN_DEPENDENCY_REGEXP)
  return nil if yarn_dependency&.length != 3 || yarn_dependency[2] == ""

  yarn_dependency[1..2]
end

.install_yarn_dependencies(required_gems = bundler_specs, name: nil) ⇒ Bundler::SpecSet

Iterates through loaded gems and finds yard-add gemspec metadata. If that exact package hasn’t been installed, execute yarn add

Returns:

  • (Bundler::SpecSet) 


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 94

def self.install_yarn_dependencies(required_gems = bundler_specs, name: nil)
  return required_gems unless File.exist?("package.json")

  package_json = JSON.parse(File.read("package.json"))

  gems_to_search = if name
                     required_gems.select do |loaded_gem|
                       loaded_gem.to_spec&.name == name.to_s
                     end
                   else
                     required_gems
                   end

  # all right, time to install the package
  gems_to_search.each do |loaded_gem|
    yarn_dependency = find_yarn_dependency(loaded_gem)
    next unless add_yarn_dependency?(yarn_dependency, package_json)

    next if package_manager.empty?

    cmd = "#{package_manager} #{package_manager_install_command} #{yarn_dependency.join("@")}"
    system cmd
  end

  gems_to_search
end

.load_determined_bundler_environment ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 41

def self.load_determined_bundler_environment
  boot_file = File.join("config", "boot.rb")

  if File.file?(boot_file)
    # We'll let config/boot.rb take care of Bundler setup
    require File.expand_path(boot_file)
  elsif File.file?(File.join("config", "initializers.rb"))
    # We'll just make sure the default and environmental gems are available.
    # Note: the default Bundler config will set up all gem groups,
    #   see: https://bundler.io/guides/groups.html
    Bundler.setup(:default, Bridgetown.env)
  end
end

.package_manager ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 72

def self.package_manager
  @package_manager ||= if File.exist?("yarn.lock")
                         "yarn"
                       elsif File.exist?("package-lock.json")
                         "npm"
                       elsif File.exist?("pnpm-lock.yaml")
                         "pnpm"
                       else
                         ""
                       end
end

.package_manager_install_command ⇒ Object 



84
85
86
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 84

def self.package_manager_install_command
  package_manager == "npm" ? "install" : "add"
end

.package_requires_updating?(current_version, dep_version) ⇒ Boolean

Returns:

  • (Boolean) 


142
143
144
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 142

def self.package_requires_updating?(current_version, dep_version)
  current_version.nil? || (current_version != dep_version && !current_version.include?("/"))
end

.require_gem(name) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 55

def self.require_gem(name)
  Bridgetown::Utils::RequireGems.require_with_graceful_fail(name)
  plugins = Bridgetown::PluginManager.install_yarn_dependencies(name:)

  plugin_to_register = if plugins.length == 1
                         plugins.first
                       else
                         bundler_specs.find do |loaded_gem|
                           loaded_gem.to_spec&.name == name.to_s
                         end
                       end
  add_registered_plugin plugin_to_register

  Bridgetown.logger.debug("PluginManager:",
                          "Registered #{plugin_to_register.name}")
end

.setup_bundler ⇒ Object Also known as: require_from_bundler 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 23

def self.setup_bundler
  if !ENV["BRIDGETOWN_NO_BUNDLER_REQUIRE"] &&
      (Bundler::SharedHelpers.in_bundle? || Bridgetown.env.test?)
    require "bundler"

    require_relative "utils/initializers"
    load_determined_bundler_environment

    ENV["BRIDGETOWN_NO_BUNDLER_REQUIRE"] = "true"
    true
  else
    false
  end
end

Instance Method Details

#plugins_path ⇒ Array<String>

Expands the path(s) of the plugins_dir config value

Returns:

  • (Array<String>) —

    one or more plugin search paths



177
178
179
180
181
182
183
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 177

def plugins_path
  if site.config["plugins_dir"].eql? Bridgetown::Configuration::DEFAULTS["plugins_dir"]
    [site.in_root_dir(site.config["plugins_dir"])]
  else
    Array(site.config["plugins_dir"]).map { |d| File.expand_path(d) }
  end
end

#require_plugin_files ⇒ void

This method returns an undefined value.

Finds and registers plugins in the local folder(s)



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'bridgetown-core/lib/bridgetown-core/plugin_manager.rb', line 156

def require_plugin_files
  plugins_path.each do |plugin_search_path|
    plugin_files = Utils.safe_glob(plugin_search_path, File.join("**", "*.rb"))

    # Require "site_builder.rb" first if present so subclasses can all
    # inherit from SiteBuilder without needing explicit require statements
    sorted_plugin_files = plugin_files.select do |path|
      path.include?("site_builder.rb")
    end + plugin_files.reject do |path|
      path.include?("site_builder.rb")
    end

    sorted_plugin_files.each do |plugin_file|
      self.class.add_registered_plugin plugin_file
    end
  end
end