umbrella.rb in cobra_commander-1.0.0

- old
+ new
@@ -1,41 +1,94 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 module CobraCommander
   # An umbrella application
   class Umbrella
-    attr_reader :name, :path
+    attr_reader :path, :config
 
-    def initialize(name, path)
-      @root_component = Component.new(self, name)
-      @path = path
+    def self.load_config(path)
+      return {} unless path.exist?
+
+      YAML.safe_load(path.read, permitted_classes: [Symbol], aliases: true)
+    end
+
+    # Umbrella constructor. This will load the given source packages.
+    #
+    # @see Umbrella#load
+    # @param path [String,Pathname] path to umbrella app
+    # @param **source_selector [Symbol => Boolean] selector as explained above
+    #
+    def initialize(path, config = nil, **source_selector)
+      @path = Pathname.new(path)
       @components = {}
+      @config = config || Umbrella.load_config(@path.join("cobra.yml"))
+      load(**source_selector)
     end
 
+    #
+    # Finds a component by name
+    #
+    # @param name [String] the name of the component
+    # @return [::CobraCommander::Component,nil] the component with a matching name or nil
+    #
     def find(name)
       @components[name]
     end
 
-    def root
-      @root_component
-    end
-
-    def resolve(component_root_path)
-      return root if root.root_paths.include?(component_root_path)
-
+    #
+    # Resolve a component given the path.
+    #
+    # This method resolves the component if the given path is inside
+    # any of the packages composing this component.
+    #
+    # @param path [String,Pathname] the path to be resolved
+    # @return [::CobraCommander::Component,nil] the component where the path is
+    #
+    def resolve(path)
       components.find do |component|
-        component.root_paths.include?(component_root_path)
+        component.root_paths.any? do |component_path|
+          component_path.eql?(Pathname.new(path)) || path.to_s.start_with?("#{component_path.cleanpath}/")
+        end
       end
     end
 
-    def add_source(key, source)
-      @root_component.add_package key, source.root
-      source.packages.each do |packages|
-        @components[packages.name] ||= Component.new(self, packages.name)
-        @components[packages.name].add_package key, packages
+    #
+    # Loads the given sources, or all of none given. This method is fired
+    # by the constructor with the inital selector.
+    #
+    # I.e.:
+    #
+    #   If the environment has both ruby and yarn plugins loaded, this
+    #   would load the yarn workspaces packages and rubygems package
+    #   graphs:
+    #
+    #      umbrella.load(ruby: true, js: true)
+    #
+    #   If no selector is given, all plugins are loaded. So assuming the
+    #   same plugins exist, this would also load yarn and ruby packages:
+    #
+    #      umbrella.load()
+    #
+    #   Specifying plugins will only load what is specified, and this would
+    #   only load ruby packages:
+    #
+    #      umbrella.load(ruby: true)
+    #
+    # @see CobraCommander::Registry
+    #
+    def load(**source_selector)
+      Source.load(path, config["sources"], **source_selector).flatten.each do |package|
+        @components[package.name] ||= Component.new(self, package.name)
+        @components[package.name].add_package package
       end
     end
 
+    # All components in this umbrella
+    #
+    # @return [Array<CobraCommander::Component>]
+    #
     def components
       @components.values
     end
   end
 end