cobra_commander 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb2f9f51193bd4ec022e4f12eae0b43f02d0f4f7adac086ac8c38f2bd7f3bf56
-  data.tar.gz: bb44e1c12845cab98efdcb8cf1da499f67fa335bd781bf14f4c07d11ed3c9eb5
+  metadata.gz: 7155830962a165a9d34da676e053580b6a375543c0823cf89ce72db41b8fdc7e
+  data.tar.gz: db6fd674597394e4c5ee1f8e42b42d9e24305de678a9043f17ed026238f6edcc
 SHA512:
-  metadata.gz: fd838a67943d9e2ae8cc7038b81ccacaaea719f8cc08cea7704df5147ffc1609ef2a91622549d423954003465d1ec310b0d09bf10ec8f3cf915850e0dbdbe39c
-  data.tar.gz: a4dec3544d6a5fbcd258b759b9ba143955acf054b4ff44af1fb25d0f3391f37741e9c2d9e31221fd192ec08c843f39b62833a6741de6313e17453e37ca82722b
+  metadata.gz: ee123f0d3b655a028e76e991fd3c7c0d411f9ece583965f9f4547a6356cce527049b41e90d665b18c433d5c8a293e43726c9a5b3fa822fb0a433d08b23df8f6e
+  data.tar.gz: 3f9514a4c74710643361ac3d3950e3f3d3b72e864b44c6f5addfc35997ae99a779bf07d5382cb38fa424a9d859de741d7836cd93e57624e55d044d8c0a0cfc0a

data/.editorconfig

@@ -0,0 +1,11 @@
+# EditorConfig is awesome: https://EditorConfig.org
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2

data/.travis.yml

@@ -4,8 +4,9 @@ before_install:
   - "find /home/travis/.rvm/rubies -wholename '*default/bundler-*.gemspec' -delete"
   - gem install bundler:"$BUNDLER_VERSION"
   - sudo apt-get -qq install graphviz
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.13.0
+  - export PATH="$HOME/.yarn/bin:$PATH"
 rvm:
   - 2.5.1
 env:
-  - BUNDLER_VERSION=1.15.4
-  - BUNDLER_VERSION=1.16.3
+  - BUNDLER_VERSION=1.17.3

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 ## Unreleased
 
+## Version 0.7 - 2020-07-08
+
+* Introduces CobraCommander::Umbrella with optimizations for dependency resolution
+* Deprecates cobra cache and cache usages
+
+## Version 0.6.1 - 2019-07-05
+
+* Better supports yarn workspaces globbing by delegating to yarn to calculate the list of components rather than re-implementing in Ruby. PR [#34](https://github.com/powerhome/cobra_commander/pull/34)
+
+## Version 0.6.0 - 2019-07-03
+
+* Tracks package.json `workspaces` in addition to `dependencies` and `devDependencies`. PR [#31](https://github.com/powerhome/cobra_commander/pull/31)
+* Permits caching the component tree of a project on disk to avoid calculating it repeatedly on subsequent cobra invocations.
+
+## Version 0.5.1 - 2018-10-15
+
+* Fix a bug with dependencies_of where it wouldn't match components further down the list of umbrella's dependencies
+* Bumps Thor version from 0.19.4 to a range (< 2.0, >= 0.18.1) compatible with railties
+
+## Version 0.5.0 - 2018-09-20
+
+* Renames `dependencies_of` to `dependents_of`. PR [#25](https://github.com/powerhome/cobra_commander/pull/25)
+* Add `dependencies_of` command list the direct and indirect dependencies of one component. PR [#25](https://github.com/powerhome/cobra_commander/pull/25)
+* Add `do` command allow executing a command in the context of each component. PR [#26](https://github.com/powerhome/cobra_commander/pull/26)
+
 ## Version 0.4.0 - 2018-09-06
 
 * Add `dependencies_of` command to permit listing or counting the dependencies of a particular component. PR [#24](https://github.com/powerhome/cobra_commander/pull/24)

data/README.md

@@ -28,16 +28,20 @@ Or install it yourself as:
 
 ```bash
 Commands:
-  cobra changes APP_PATH [--results=RESULTS] [--branch=BRANCH]  # Prints list of changed files
-  cobra graph APP_PATH [--format=FORMAT]                        # Outputs graph
-  cobra help [COMMAND]                                          # Describe available commands or one specific command
-  cobra ls APP_PATH                                             # Prints tree of components for an app
-  cobra version                                                 # Prints version
+  cobra cache APP_PATH CACHE_PATH                                                # Caches a representation of the component structure of the app
+  cobra changes APP_PATH [--results=RESULTS] [--branch=BRANCH] [--cache=nil]     # Prints list of changed files
+  cobra dependencies_of [component] [--app=pwd] [--format=FORMAT] [--cache=nil]  # Outputs a list of components that [component] depends on within [app] context
+  cobra dependents_of [component] [--app=pwd] [--format=FORMAT] [--cache=nil]    # Outputs count of components in [app] dependent on [component]
+  cobra do [command] [--app=pwd] [--cache=nil]                                   # Executes the command in the context of each component in [app]
+  cobra graph APP_PATH [--format=FORMAT] [--cache=nil]                           # Outputs graph
+  cobra help [COMMAND]                                                           # Describe available commands or one specific command
+  cobra ls [app_path] [--app=pwd] [--format=FORMAT] [--cache=nil]                # Prints tree of components for an app
+  cobra version                                                                  # Prints version
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. You will also need to install `graphviz` by running `brew install graphviz`. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/cobra_commander.gemspec

@@ -11,10 +11,12 @@ Gem::Specification.new do |spec|
   spec.authors       = [
     "Ben Langfeld",
     "Garett Arrowood",
+    "Carlos Palhares",
   ]
   spec.email         = [
     "blangfeld@powerhrg.com",
     "garett.arrowood@powerhrg.com",
+    "carlos.palhares@powerhrg.com",
   ]
   spec.summary       = "Tools for working with Component Based Rails Apps"
   spec.description   = <<~DESCRIPTION
@@ -32,10 +34,10 @@ DESCRIPTION
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor", "~> 0.19.4"
+  spec.add_dependency "thor", ["< 2.0", ">= 0.18.1"]
   spec.add_dependency "ruby-graphviz", "~> 1.2.3"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "guard-rspec"

data/lib/cobra_commander.rb

@@ -1,16 +1,37 @@
 # frozen_string_literal: true
 
+require "cobra_commander/dependencies"
+require "cobra_commander/component"
+require "cobra_commander/umbrella"
+
 require "cobra_commander/cli"
-require "cobra_commander/component_tree"
+require "cobra_commander/cached_component_tree"
+require "cobra_commander/calculated_component_tree"
 require "cobra_commander/version"
-require "cobra_commander/formatted_output"
 require "cobra_commander/graph"
 require "cobra_commander/change"
 require "cobra_commander/affected"
+require "cobra_commander/output"
+require "cobra_commander/executor"
 
 # Tools for working with Component Based Rails Apps (see http://shageman.github.io/cbra.info/).
 # Includes tools for graphing the components of an app and their relationships, as well as selectively
 # testing components based on changes made.
 module CobraCommander
   UMBRELLA_APP_NAME = "App"
+
+  def self.umbrella(root_path, yarn: false, bundler: false, name: UMBRELLA_APP_NAME)
+    umbrella = Umbrella.new(name, root_path)
+    umbrella.add_source(:yarn, Dependencies::YarnWorkspace.new(root_path)) unless bundler
+    umbrella.add_source(:bundler, Dependencies::Bundler.new(root_path)) unless yarn
+    umbrella
+  end
+
+  def self.umbrella_tree(path)
+    CalculatedComponentTree.new(UMBRELLA_APP_NAME, path)
+  end
+
+  def self.tree_from_cache(cache_file)
+    CachedComponentTree.from_cache_file(cache_file)
+  end
 end

data/lib/cobra_commander/affected.rb

@@ -3,28 +3,33 @@
 module CobraCommander
   # Calculates directly & transitively affected components
   class Affected
-    attr_reader :directly, :transitively
-
-    def initialize(tree, changes, path)
-      @tree = tree
+    def initialize(umbrella, changes)
+      @umbrella = umbrella
       @changes = changes
-      @path = path
       run!
     end
 
     def names
-      @names ||= paths.map { |path| File.basename(path) }
+      @names ||= all_affected.map(&:name)
     end
 
     def scripts
       @scripts ||= paths.map { |path| File.join(path, "test.sh") }
     end
 
+    def directly
+      @directly.map(&method(:affected_component))
+    end
+
+    def transitively
+      @transitively.map(&method(:affected_component))
+    end
+
     def json_representation # rubocop:disable Metrics/MethodLength
       {
         changed_files: @changes,
-        directly_affected_components: @directly,
-        transitively_affected_components: @transitively,
+        directly_affected_components: directly,
+        transitively_affected_components: transitively,
         test_scripts: scripts,
         component_names: names,
         languages: {
@@ -39,46 +44,48 @@ module CobraCommander
     def run!
       @transitively = Set.new
       @directly = Set.new
-      find_dependencies(@tree)
-      @transitively.delete(name: UMBRELLA_APP_NAME, path: @path, type: @tree[:type])
-      @transitively = @transitively.to_a.sort_by { |h| h[:name] }
-      @directly = @directly.to_a.sort_by { |h| h[:name] }
+      @umbrella.components.each(&method(:add_if_changed))
+      @transitively = @transitively.sort_by(&:name)
+      @directly = @directly.sort_by(&:name)
     end
 
-    def find_dependencies(parent_component)
-      parent_component[:dependencies].each do |component|
-        add_if_changed(component)
-        find_dependencies(component)
-      end
+    def add_if_changed(component)
+      return if component.root_paths.uniq.none? { |path| @changes.any?(Regexp.new(path)) }
+
+      @directly << component
+      @transitively.merge(component.deep_dependents)
     end
 
-    def add_if_changed(component)
-      @changes.each do |change|
-        if change.start_with?(component[:path])
-          @directly << component.reject { |k| k == :dependencies || k == :ancestry }
-          @transitively.merge component[:ancestry]
-        end
-      end
+    def affected_component(component)
+      {
+        name: component.name,
+        path: component.root_paths,
+        type: component.sources.keys.map(&:to_s).map(&:capitalize).join(" & "),
+      }
     end
 
     def all_affected
-      @all_affected ||= (@directly + @transitively).uniq.sort_by { |h| h[:path] }
+      @all_affected ||= (@directly | @transitively).sort_by(&:name)
     end
 
     def paths
-      @paths ||= all_affected.map { |component| component[:path] }
+      @paths ||= all_affected.map(&:root_paths).flatten.uniq
     end
 
-    def types
-      @types ||= all_affected.map { |component| component[:type] }
+    def all_affected_sources
+      all_affected
+        .map(&:sources)
+        .map(&:keys)
+        .flatten
+        .uniq
     end
 
     def contains_ruby?
-      types.uniq.join.include?("Ruby")
+      all_affected_sources.include?(:bundler)
     end
 
     def contains_js?
-      types.uniq.join.include?("JS")
+      all_affected_sources.include?(:yarn)
     end
   end
 end

data/lib/cobra_commander/cached_component_tree.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "cobra_commander/component_tree"
+
+module CobraCommander
+  # Represents a dependency tree in a given context, built from a cache
+  class CachedComponentTree < ComponentTree
+    attr_reader :dependencies
+
+    def self.from_cache_file(cache_file)
+      cache = JSON.parse(File.read(cache_file), symbolize_names: true)
+      new(cache)
+    end
+
+    def initialize(cache)
+      super(cache[:name], cache[:path])
+      @type = cache[:type]
+      @ancestry = Set.new(cache[:ancestry])
+      @dependencies = (cache[:dependencies] || []).map do |dep|
+        CachedComponentTree.new(dep)
+      end
+    end
+  end
+end

data/lib/cobra_commander/calculated_component_tree.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "cobra_commander/component_tree"
+require "open3"
+
+module CobraCommander
+  # Represents a dependency tree in a given context
+  class CalculatedComponentTree < ComponentTree
+    attr_reader :name, :path
+
+    def initialize(name, path, ancestry = Set.new)
+      super(name, path)
+      @ancestry = ancestry
+      @ruby = Ruby.new(path)
+      @js = Js.new(path)
+      @type = type_of_component
+    end
+
+    def dependencies
+      @deps ||= begin
+        deps = @ruby.dependencies + @js.dependencies
+        deps.sort_by { |dep| dep[:name] }
+            .map(&method(:dep_representation))
+      end
+    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 dep_representation(dep)
+      full_path = File.expand_path(File.join(path, dep[:path]))
+      ancestry = @ancestry + [{ name: @name, path: path, type: @type }]
+      CalculatedComponentTree.new(dep[:name], full_path, ancestry)
+    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
+    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))
+          combined_deps(json)
+        end
+      end
+
+      def format_dependencies(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 node?
+        @node ||= File.exist?(package_json_path)
+      end
+
+      def package_json_path
+        File.join(@root_path, "package.json")
+      end
+
+      def combined_deps(json)
+        worskpace_dependencies = build_workspaces(json["workspaces"])
+        dependencies = format_dependencies Hash(json["dependencies"]).merge(Hash(json["devDependencies"]))
+        (dependencies + worskpace_dependencies).uniq
+      end
+
+      def build_workspaces(workspaces)
+        return [] if workspaces.nil?
+
+        yarn_workspaces.map do |_, component|
+          { name: component["location"].split("/")[-1], path: component["location"] }
+        end
+      end
+
+    private
+
+      def yarn_workspaces
+        @yarn_workspaces ||= begin
+          output, = Open3.capture2("yarn --json workspaces info", chdir: @root_path)
+          JSON.parse(JSON.parse(output)["data"])
+        end
+      end
+    end
+  end
+end

data/lib/cobra_commander/change.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "cobra_commander/component_tree"
 require "cobra_commander/affected"
 require "open3"
 
@@ -9,12 +8,12 @@ module CobraCommander
   class Change
     InvalidSelectionError = Class.new(StandardError)
 
-    def initialize(path, results, branch)
-      @root_dir = Dir.chdir(path) { `git rev-parse --show-toplevel`.chomp }
+    def initialize(umbrella, results, branch)
+      @root_dir = Dir.chdir(umbrella.path) { `git rev-parse --show-toplevel`.chomp }
       @results = results
       @branch = branch
-      @tree = ComponentTree.new(path).to_h
-      @affected = Affected.new(@tree, changes, path)
+      @umbrella = umbrella
+      @affected = Affected.new(@umbrella, changes)
     end
 
     def run!
@@ -86,8 +85,8 @@ module CobraCommander
       end
     end
 
-    def display(component)
-      "#{component[:name]} - #{component[:type]}"
+    def display(name:, type:, **)
+      "#{name} - #{type}"
     end
 
     def blank_line