# frozen_string_literal: true module Bridgetown class PluginManager PLUGINS_GROUP = :bridgetown_plugins YARN_DEPENDENCY_REGEXP = %r!(.+)@([^@]*)$!.freeze attr_reader :site, :component_loaders @source_manifests = Set.new @registered_plugins = Set.new def self.add_source_manifest(source_manifest) unless source_manifest.is_a?(Bridgetown::Plugin::SourceManifest) raise "You must add a SourceManifest instance" end @source_manifests << source_manifest end def self.new_source_manifest(*args) add_source_manifest(Bridgetown::Plugin::SourceManifest.new(*args)) end def self.add_registered_plugin(gem_or_plugin_file) @registered_plugins << gem_or_plugin_file end class << self attr_reader :source_manifests, :registered_plugins end # Create an instance of this class. # # site - the instance of Bridgetown::Site we're concerned with # # Returns nothing def initialize(site) @site = site @component_loaders = {} end def self.require_from_bundler if !ENV["BRIDGETOWN_NO_BUNDLER_REQUIRE"] && File.file?("Gemfile") require "bundler" required_gems = Bundler.require PLUGINS_GROUP required_gems.select! do |dep| (dep.groups & [PLUGINS_GROUP]).any? && dep.should_include? end install_yarn_dependencies(required_gems) required_gems.each do |installed_gem| add_registered_plugin installed_gem end Bridgetown.logger.debug("PluginManager:", "Required #{required_gems.map(&:name).join(", ")}") ENV["BRIDGETOWN_NO_BUNDLER_REQUIRE"] = "true" true else false end end # Iterates through loaded plugins and finds yard-add gemspec metadata. # If that exact package hasn't been installed, execute yarn add # # Returns nothing. def self.install_yarn_dependencies(required_gems, single_gemname = nil) return unless File.exist?("package.json") package_json = JSON.parse(File.read("package.json")) gems_to_search = if single_gemname required_gems.select do |loaded_gem| loaded_gem.to_spec&.name == single_gemname.to_s end else required_gems end gems_to_search.each do |loaded_gem| yarn_dependency = find_yarn_dependency(loaded_gem) next unless add_yarn_dependency?(yarn_dependency, package_json) # all right, time to install the package cmd = "yarn add #{yarn_dependency.join("@")}" system cmd end end 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 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"].dig(yarn_dependency.first) package_requires_updating?(current_version, yarn_dependency.last) else true end end def self.package_requires_updating?(current_version, dep_version) current_version.nil? || current_version != dep_version && !current_version.include?("/") end # Require all .rb files # # Returns nothing. 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 Bridgetown::Utils::RequireGems.require_with_graceful_fail(sorted_plugin_files) end end # Reload .rb plugin files via the watcher def reload_plugin_files plugins_path.each do |plugin_search_path| plugin_files = Utils.safe_glob(plugin_search_path, File.join("**", "*.rb")) Array(plugin_files).each do |name| Bridgetown.logger.debug "Reloading:", name.to_s self.class.add_registered_plugin name load name 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? 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 # rubocop:disable Metrics/AbcSize def setup_component_loaders unless @component_loaders.keys.empty? @component_loaders.each do |_path, loader| loader.unload end @component_loaders = {} end # Because "first constant wins" in Zeitwerk, we need to load the local # source components _before_ we load any from plugins site.components_load_paths.reverse_each do |load_path| next unless Dir.exist? load_path next if Zeitwerk::Registry.loaders.find { |loader| loader.manages?(load_path) } @component_loaders[load_path] = Zeitwerk::Loader.new @component_loaders[load_path].push_dir(load_path) @component_loaders[load_path].enable_reloading if load_path.start_with?(site.root_dir) @component_loaders[load_path].ignore(File.join(load_path, "**", "*.js.rb")) @component_loaders[load_path].setup end end # rubocop:enable Metrics/AbcSize def reload_component_loaders @component_loaders.each do |path, loader| loader.reload if path.start_with?(site.root_dir) end end end end