cobra_commander 0.4.0 → 0.7.0

data/lib/cobra_commander/cli.rb

@@ -1,20 +1,54 @@
 # frozen_string_literal: true
 
 require "thor"
+require "fileutils"
 
 module CobraCommander
   # Implements the tool's CLI
   class CLI < Thor
-    desc "ls APP_PATH", "Prints tree of components for an app"
-    def ls(app_path)
-      puts FormattedOutput.new(app_path).run!
+    CACHE_DESCRIPTION = "[DEPRECATED] Path to a cache file to use (default: nil). If specified, this file will " \
+      "be used to store the component tree for the app to speed up subsequent invocations. Must be rotated any time " \
+      "the component dependency structure changes."
+    COMMON_OPTIONS = "[--app=pwd] [--format=FORMAT] [--cache=nil]"
+
+    desc "do [command] [--app=pwd] [--cache=nil]", "Executes the command in the context of each component in [app]"
+    method_option :app, default: Dir.pwd, aliases: "-a", desc: "App path (default: CWD)"
+    method_option :cache, default: nil, aliases: "-c", desc: CACHE_DESCRIPTION
+    def do(command)
+      executor = Executor.new(umbrella(options.app).components)
+      executor.exec(command)
+    end
+
+    desc "ls [app_path] #{COMMON_OPTIONS}", "Prints tree of components for an app"
+    method_option :app, default: Dir.pwd, aliases: "-a", desc: "App path (default: CWD)"
+    method_option :format, default: "tree", aliases: "-f", desc: "Format (list or tree, default: list)"
+    method_option :cache, default: nil, aliases: "-c", desc: CACHE_DESCRIPTION
+    def ls(app_path = Dir.pwd)
+      Output.print(
+        umbrella(app_path).root,
+        options.format
+      )
     end
 
-    desc "dependencies_of APP_PATH", "Outputs count of components in APP_PATH dependent on COMPONENT"
-    method_option :component, required: true, aliases: "-c", desc: "Name of component. Ex: my_component"
+    desc "dependents_of [component] #{COMMON_OPTIONS}", "Outputs count of components in [app] dependent on [component]"
+    method_option :app, default: Dir.pwd, aliases: "-a", desc: "Path to the root app where the component is mounted"
     method_option :format, default: "count", aliases: "-f", desc: "count or list"
-    def dependencies_of(app_path)
-      puts FormattedOutput.new(app_path).dependencies_of!(@options[:component], @options[:format])
+    method_option :cache, default: nil, aliases: "-c", desc: CACHE_DESCRIPTION
+    def dependents_of(component)
+      dependents = umbrella(options.app).dependents_of(component)
+      return unless dependents
+      puts "list" == options.format ? dependents.map(&:name) : dependents.size
+    end
+
+    desc "dependencies_of [component] #{COMMON_OPTIONS}", "Outputs a list of components that [component] depends on"
+    method_option :app, default: Dir.pwd, aliases: "-a", desc: "App path (default: CWD)"
+    method_option :format, default: "list", aliases: "-f", desc: "Format (list or tree, default: list)"
+    method_option :cache, default: nil, aliases: "-c", desc: CACHE_DESCRIPTION
+    def dependencies_of(component)
+      Output.print(
+        umbrella(options.app).find(component),
+        options.format
+      )
     end
 
     desc "version", "Prints version"
@@ -22,17 +56,33 @@ module CobraCommander
       puts CobraCommander::VERSION
     end
 
-    desc "graph APP_PATH [--format=FORMAT]", "Outputs graph"
+    desc "graph APP_PATH [--format=FORMAT] [--cache=nil] [--component]", "Outputs graph"
     method_option :format, default: "png", aliases: "-f", desc: "Accepts png or dot"
+    method_option :cache, default: nil, aliases: "-c", desc: CACHE_DESCRIPTION
     def graph(app_path)
-      Graph.new(app_path, @options[:format]).generate!
+      Graph.new(umbrella(app_path).root, options.format).generate!
     end
 
-    desc "changes APP_PATH [--results=RESULTS] [--branch=BRANCH]", "Prints list of changed files"
+    desc "changes APP_PATH [--results=RESULTS] [--branch=BRANCH] [--cache=nil]", "Prints list of changed files"
     method_option :results, default: "test", aliases: "-r", desc: "Accepts test, full, name or json"
     method_option :branch, default: "master", aliases: "-b", desc: "Specified target to calculate against"
+    method_option :cache, default: nil, aliases: "-c", desc: CACHE_DESCRIPTION
     def changes(app_path)
-      Change.new(app_path, @options[:results], @options[:branch]).run!
+      Change.new(umbrella(app_path), options.results, options.branch).run!
+    end
+
+    desc "cache APP_PATH CACHE_PATH", "[DEPRECATED] Caches a representation of the component structure of the app"
+    def cache(app_path, cache_path)
+      tree = CobraCommander.umbrella_tree(app_path)
+      FileUtils.mkdir_p(File.dirname(cache_path))
+      File.write(cache_path, tree.to_json)
+      puts "Created cache of component tree at #{cache_path}"
+    end
+
+  private
+
+    def umbrella(path)
+      CobraCommander.umbrella(path)
     end
   end
 end

data/lib/cobra_commander/component.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module CobraCommander
+  # Represents a component withing an Umbrella
+  class Component
+    attr_reader :name, :dependencies, :sources
+
+    def initialize(umbrella, name)
+      @umbrella = umbrella
+      @name = name
+      @dependency_names = []
+      @sources = {}
+    end
+
+    def add_source(key, path, dependency_names)
+      @sources[key] = path
+      @dependency_names |= dependency_names
+    end
+
+    def root_paths
+      @sources.values.map(&File.method(:dirname)).uniq
+    end
+
+    def inspect
+      "#<CobraCommander::Component:#{object_id} #{name} dependencies=#{dependencies.map(&:name)} packages=#{sources}>"
+    end
+
+    def deep_dependents
+      @deep_dependents ||= @umbrella.components.find_all do |dep|
+        dep.deep_dependencies.include?(self)
+      end
+    end
+
+    def deep_dependencies
+      @deep_dependencies ||= dependencies.reduce(dependencies) do |deps, dep|
+        deps | dep.deep_dependencies
+      end
+    end
+
+    def dependents
+      @dependents ||= @umbrella.components.find_all do |dep|
+        dep.dependencies.include?(self)
+      end
+    end
+
+    def dependencies
+      @dependencies ||= @dependency_names.sort
+                                         .map(&@umbrella.method(:find))
+                                         .compact
+    end
+  end
+end

data/lib/cobra_commander/component_tree.rb

@@ -1,140 +1,69 @@
 # frozen_string_literal: true
 
+require "bundler"
 require "json"
 
 module CobraCommander
-  # Representation of the tree of components and their dependencies
+  # Represents a dependency tree in a given context
   class ComponentTree
-    def initialize(path)
-      @root_path = path
-    end
+    attr_reader :name, :path
 
-    def to_h
-      Tree.new(UMBRELLA_APP_NAME, @root_path).to_h
+    def initialize(name, path)
+      @name = name
+      @path = path
     end
 
-    # Generates component tree
-    class Tree
-      def initialize(name, path, ancestry = Set.new)
-        @name = name
-        @root_path = path
-        @ancestry = ancestry
-        @ruby = Ruby.new(path)
-        @js = Js.new(path)
-        @type = type_of_component
-      end
-
-      def to_h
-        {
-          name: @name,
-          path: @root_path,
-          type: @type,
-          ancestry: @ancestry,
-          dependencies: dependencies.map(&method(:dep_representation)),
-        }
-      end
-
-    private
-
-      def type_of_component
-        return "Ruby & JS" if @ruby.gem? && @js.node?
-        return "Ruby" if @ruby.gem?
-        return "JS" if @js.node?
-      end
+    def flatten
+      _flatten(self)
+    end
 
-      def dependencies
-        @deps ||= begin
-          deps = @ruby.dependencies + @js.dependencies
-          deps.sort_by { |dep| dep[:name] }
-        end
-      end
+    def subtree(name)
+      _subtree(name, self)
+    end
 
-      def dep_representation(dep)
-        full_path = File.expand_path(File.join(@root_path, dep[:path]))
-        ancestry = @ancestry + [{ name: @name, path: @root_path, type: @type }]
-        self.class.new(dep[:name], full_path, ancestry).to_h
+    def depends_on?(component_name)
+      dependencies.any? do |component|
+        component.name == component_name || component.depends_on?(component_name)
       end
+    end
 
-      # Calculates ruby dependencies
-      class Ruby
-        def initialize(root_path)
-          @root_path = root_path
-        end
-
-        def dependencies
-          @deps ||= begin
-            return [] unless gem?
-            gems = bundler_definition.dependencies.select { |dep| path?(dep.source) }
-            format(gems)
-          end
-        end
-
-        def path?(source)
-          return if source.nil?
-          source_has_path = source.respond_to?(:path?) ? source.path? : source.is_a_path?
-          source_has_path && source.path.to_s != "."
-        end
-
-        def format(deps)
-          deps.map do |dep|
-            path = File.join(dep.source.path, dep.name)
-            { name: dep.name, path: path }
-          end
-        end
-
-        def gem?
-          @gem ||= File.exist?(gemfile_path)
-        end
-
-        def bundler_definition
-          ::Bundler::Definition.build(gemfile_path, gemfile_lock_path, nil)
-        end
-
-        def gemfile_path
-          File.join(@root_path, "Gemfile")
-        end
-
-        def gemfile_lock_path
-          File.join(@root_path, "Gemfile.lock")
-        end
+    def dependents_of(component_name)
+      depends = depends_on?(component_name) ? self : nil
+      dependents_below = dependencies.map do |component|
+        component.dependents_of(component_name)
       end
+      [depends, dependents_below].flatten.compact.uniq(&:name)
+    end
 
-      # Calculates js dependencies
-      class Js
-        def initialize(root_path)
-          @root_path = root_path
-        end
-
-        def dependencies
-          @deps ||= begin
-            return [] unless node?
-            json = JSON.parse(File.read(package_json_path))
-            format combined_deps(json)
-          end
-        end
+    def to_h(json_compatible: false)
+      {
+        name: @name,
+        path: path,
+        type: @type,
+        ancestry: json_compatible ? @ancestry.to_a : @ancestry,
+        dependencies: dependencies.map { |dep| dep.to_h(json_compatible: json_compatible) },
+      }
+    end
 
-        def format(deps)
-          return [] if deps.nil?
-          linked_deps = deps.select { |_, v| v.start_with? "link:" }
-          linked_deps.map do |_, v|
-            relational_path = v.split("link:")[1]
-            dep_name = relational_path.split("/")[-1]
-            { name: dep_name, path: relational_path }
-          end
-        end
+    def to_json
+      JSON.dump(to_h(json_compatible: true))
+    end
 
-        def node?
-          @node ||= File.exist?(package_json_path)
-        end
+  private
 
-        def package_json_path
-          File.join(@root_path, "package.json")
-        end
+    def _flatten(component)
+      component.dependencies.map do |dep|
+        [dep] + _flatten(dep)
+      end.flatten.uniq(&:name)
+    end
 
-        def combined_deps(json)
-          Hash(json["dependencies"]).merge(Hash(json["devDependencies"]))
-        end
+    def _subtree(name, tree)
+      return tree if tree.name == name
+      tree.dependencies.each do |component|
+        presence = _subtree(name, component)
+        return presence if presence
       end
+      nil
     end
   end
 end

data/lib/cobra_commander/dependencies.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "dependencies/yarn_workspace"
+require_relative "dependencies/bundler"

data/lib/cobra_commander/dependencies/bundler.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CobraCommander
+  module Dependencies
+    # Calculates ruby bundler dependencies
+    class Bundler
+      def initialize(root)
+        @definition = ::Bundler::Definition.build(
+          Pathname.new(File.join(root, "Gemfile")).realpath,
+          Pathname.new(File.join(root, "Gemfile.lock")).realpath,
+          false
+        )
+      end
+
+      def path
+        @definition.lockfile
+      end
+
+      def dependencies
+        @definition.dependencies.map(&:name)
+      end
+
+      def components
+        components_source.specs.map do |spec|
+          { path: spec.loaded_from, name: spec.name, dependencies: spec.dependencies.map(&:name) }
+        end
+      end
+
+    private
+
+      def components_source
+        @components_source ||= @definition.send(:sources).path_sources.find do |source|
+          source.path.to_s.eql?("components")
+        end
+      end
+    end
+  end
+end

data/lib/cobra_commander/dependencies/yarn/package.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "json"
+
+module CobraCommander
+  module Dependencies
+    module Yarn
+      # Represents an Yarn package.json file
+      class Package
+        attr_reader :path
+
+        def initialize(path)
+          @path = Pathname.new(File.join(path, "package.json")).realpath
+        end
+
+        def project_tag
+          name.match(%r{^@[\w-]+\/}).to_s
+        end
+
+        def name
+          json["name"]
+        end
+
+        def dependencies
+          json.fetch("dependencies", {})
+              .merge(json.fetch("devDependencies", {}))
+        end
+
+      private
+
+        def json
+          @json ||= JSON.parse(File.read(@path))
+        end
+      end
+    end
+  end
+end

data/lib/cobra_commander/dependencies/yarn/package_repo.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CobraCommander
+  module Dependencies
+    module Yarn
+      # Yarn package repository to load and cache package.json files
+      class PackageRepo
+        def initialize
+          @specs ||= {}
+        end
+
+        def specs
+          @specs.values
+        end
+
+        def load_linked_specs(package)
+          package.dependencies.values.each do |spec|
+            next unless spec =~ /link:(.+)/
+            load_spec(File.join(package.path, "..", Regexp.last_match(1)))
+          end
+        end
+
+        def load_spec(path)
+          @specs[path] ||= Package.new(path).tap do |package|
+            load_linked_specs(package)
+          end
+        end
+      end
+    end
+  end
+end