cobra_commander 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a05f3e1ab4ccff9ca040dcf4d694aebc28df0f50160067cf73eaea89f4bad59
-  data.tar.gz: d0132e226b7527e72ebb84e3844116dd3a0c2ed8ecc1394d9df5f7fad5f777d8
+  metadata.gz: 6f1de2b5ceb4fbde7dcd12fd71606c55cdd733e6928e4c6a866dfc1f3ec65af3
+  data.tar.gz: 5a9537dabd13b974df919be911755debf92761b6bdf99b370c59cec2c8fc09af
 SHA512:
-  metadata.gz: 1cb90f61448f1bc69088418fc86dafbc25fce09d069507e22fc22f0a2d9a63eccf95ce3edeb13b6ee2657e19303489c2b59087944ddc07597c7d0e201c36a307
-  data.tar.gz: '023961e1f0abe297e0d0cacc169b3da23fac68f833627d01d480f06d0822019877cd1ac78bb20bf7f951b2bbdce04a0c0ddbb7b3b444a90669f18c967a43775c'
+  metadata.gz: 58f066894063d46d3b1c25baf2b085f3212db9ac716eee5c8ef6c2465c82233f06fae79e30c04205d95b75551799cd3f1c67901a60a516bf079e2cb154baa2b2
+  data.tar.gz: 99babd4c1ae0b5e218ed913bf175cbd38d4efe4bc19d11ea108d8f914c9f3381a7f43bb6c8a4d64171bec648e5c5e8441c39c30f5c3a83f11e0c9f1aa4e0948b

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,32 @@
 
 ## Unreleased
 
+## Version 0.8 - 2020-07-21
+
+* Standardize Cobra CLI options
+* More powerful filters to all cobra commands (--js, --ruby)
+* More powerful filters to cobra ls and exec (--dependencies, --dependents)
+* Graphs for components, not just umbrella
+
+## 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)

data/README.md

@@ -24,24 +24,115 @@ Or install it yourself as:
 
     $ gem install cobra_commander
 
-## Usage
+## Usage (cobra help)
 
 ```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  [--format=list|tree]                                     # Prints tree of components for an app
-  cobra version                                                               # Prints version
-  cobra do [command]                                                          # Executes the command in the context of each component
-  cobra dependencies_of [component] [--app=/path/to/app] [--format=list|tree] # Lists the dependencies of the component in the app context
-  cobra dependents_of [component] [--app=/path/to/app] [--format=list|count]  # Lists or counts the components that depend directly or indirectly on the given component
-  cobra version                                                               # Prints version
+  cobra changes [--results=RESULTS] [--branch=BRANCH]  # Prints list of changed files
+  cobra exec [component] <command>                     # Executes the command in the context of a given component or set of components. If no component is given executes the command in all components.
+  cobra graph [component]                              # Outputs a graph of a given component or umbrella
+  cobra help [COMMAND]                                 # Describe available commands or one specific command
+  cobra ls [component]                                 # Lists the components in the context of a given component or umbrella
+  cobra tree [component]                               # Prints the dependency tree of a given component or umbrella
+  cobra version                                        # Prints version
+
+Options:
+  -a, [--app=APP]
+                             # Default: /Users/chjunior/workspace/power/cobra_commander
+      [--js], [--no-js]      # Consider only the JS dependency graph
+      [--ruby], [--no-ruby]  # Consider only the Ruby dependency graph
+```
+
+### cobra changes
+
+```sh
+➜  nitro git:(nova/remove-cobra-commander) be cobra help changes
+Usage:
+  cobra changes [--results=RESULTS] [--branch=BRANCH]
+
+Options:
+  -r, [--results=RESULTS]    # Accepts test, full, name or json
+                             # Default: test
+  -b, [--branch=BRANCH]      # Specified target to calculate against
+                             # Default: master
+  -a, [--app=APP]
+                             # Default: /Users/chjunior/workspace/power/nitro
+      [--js], [--no-js]      # Consider only the JS dependency graph
+      [--ruby], [--no-ruby]  # Consider only the Ruby dependency graph
+
+Prints list of changed files
+```
+
+### cobra exec
+
+```sh
+Usage:
+  cobra exec [component] <command>
+
+Options:
+      [--dependencies], [--no-dependencies]  # Run the command on each dependency of a given component
+      [--dependents], [--no-dependents]      # Run the command on each dependency of a given component
+  -a, [--app=APP]
+                                             # Default: /Users/chjunior/workspace/power/cobra_commander
+      [--js], [--no-js]                      # Consider only the JS dependency graph
+      [--ruby], [--no-ruby]                  # Consider only the Ruby dependency graph
+
+Executes the command in the context of a given component or set of components. If no component is given executes the command in all components.
+```
+
+### cobra graph
+
+```sh
+Usage:
+  cobra graph [component]
+
+Options:
+  -o, [--output=OUTPUT]      # Output file, accepts .png or .dot
+                             # Default: /Users/chjunior/workspace/power/cobra_commander/output.png
+  -a, [--app=APP]
+                             # Default: /Users/chjunior/workspace/power/cobra_commander
+      [--js], [--no-js]      # Consider only the JS dependency graph
+      [--ruby], [--no-ruby]  # Consider only the Ruby dependency graph
+
+Outputs a graph of a given component or umbrella
+```
+
+### cobra ls
+
+```sh
+Usage:
+  cobra ls [component]
+
+Options:
+  -d, [--dependencies], [--no-dependencies]  # Run the command on each dependency of a given component
+  -D, [--dependents], [--no-dependents]      # Run the command on each dependency of a given component
+  -t, [--total], [--no-total]                # Prints the total count of components
+  -a, [--app=APP]
+                                             # Default: /Users/chjunior/workspace/power/cobra_commander
+      [--js], [--no-js]                      # Consider only the JS dependency graph
+      [--ruby], [--no-ruby]                  # Consider only the Ruby dependency graph
+
+Lists the components in the context of a given component or umbrella
+```
+
+### cobra tree
+
+```sh
+Usage:
+  cobra tree [component]
+
+Options:
+  -a, [--app=APP]
+                             # Default: /Users/chjunior/workspace/power/cobra_commander
+      [--js], [--no-js]      # Consider only the JS dependency graph
+      [--ruby], [--no-ruby]  # Consider only the Ruby dependency graph
+
+Prints the dependency tree of a given component or umbrella
 ```
 
 ## 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,11 @@ 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 "bundler", "~> 1.17"
+  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/exe/cobra

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "cobra_commander"
+require "cobra_commander/cli"
 
 CobraCommander::CLI.start

data/lib/cobra_commander.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require "cobra_commander/cli"
-require "cobra_commander/component_tree"
+require "cobra_commander/dependencies"
+require "cobra_commander/component"
+require "cobra_commander/umbrella"
 require "cobra_commander/version"
-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
@@ -15,7 +11,18 @@ require "cobra_commander/executor"
 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)
-    ComponentTree.new(UMBRELLA_APP_NAME, 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/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 = CobraCommander.umbrella_tree(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

data/lib/cobra_commander/cli.rb

@@ -1,62 +1,93 @@
 # frozen_string_literal: true
 
 require "thor"
+require "fileutils"
+
+require "cobra_commander"
+require "cobra_commander/affected"
+require "cobra_commander/change"
+require "cobra_commander/executor"
+require "cobra_commander/output"
 
 module CobraCommander
   # Implements the tool's CLI
   class CLI < Thor
-    desc "do [command]", "Executes the command in the context of each component in [app]"
-    method_option :app, default: Dir.pwd, aliases: "-a", desc: "App path (default: CWD)"
-    def do(command)
-      tree = CobraCommander.umbrella_tree(options.app)
-      executor = Executor.new(tree)
-      executor.exec(command)
-    end
-
-    desc "ls [app_path]", "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)"
-    def ls(app_path = nil)
-      Output.print(
-        CobraCommander.umbrella_tree(app_path || options.app),
-        options.format
-      )
+    class_option :app, default: Dir.pwd, aliases: "-a", type: :string
+    class_option :js, default: false, type: :boolean, desc: "Consider only the JS dependency graph"
+    class_option :ruby, default: false, type: :boolean, desc: "Consider only the Ruby dependency graph"
+
+    desc "version", "Prints version"
+    def version
+      puts CobraCommander::VERSION
     end
 
-    desc "dependents_of [component]", "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 dependents_of(component)
-      dependents = CobraCommander.umbrella_tree(options.app).dependents_of(component)
-      puts "list" == options.format ? dependents.map(&:name) : dependents.size
+    desc "ls [component]", "Lists the components in the context of a given component or umbrella"
+    method_option :dependencies, type: :boolean, aliases: "-d",
+                                 desc: "Run the command on each dependency of a given component"
+    method_option :dependents, type: :boolean, aliases: "-D",
+                               desc: "Run the command on each dependency of a given component"
+    method_option :total, type: :boolean, aliases: "-t", desc: "Prints the total count of components"
+    def ls(component = nil)
+      components = components_filtered(component)
+      puts options.total ? components.size : CobraCommander::Output::FlatList.new(components).to_s
     end
 
-    desc "dependencies_of [component]", "Outputs a list of components that [component] depends on within [app] context"
-    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)"
-    def dependencies_of(component)
-      Output.print(
-        CobraCommander.umbrella_tree(options.app).subtree(component),
-        options.format
+    desc "exec [component] <command>", "Executes the command in the context of a given component or set of components. " \
+                                       "If no component is given executes the command in all components."
+    method_option :dependencies, type: :boolean, desc: "Run the command on each dependency of a given component"
+    method_option :dependents, type: :boolean, desc: "Run the command on each dependency of a given component"
+    def exec(command_or_component, command = nil)
+      CobraCommander::Executor.exec(
+        components_filtered(command && command_or_component),
+        command ? command : command_or_component
       )
     end
 
-    desc "version", "Prints version"
-    def version
-      puts CobraCommander::VERSION
+    desc "tree [component]", "Prints the dependency tree of a given component or umbrella"
+    def tree(component = nil)
+      component = find_component(component)
+      puts CobraCommander::Output::AsciiTree.new(component).to_s
     end
 
-    desc "graph APP_PATH [--format=FORMAT]", "Outputs graph"
-    method_option :format, default: "png", aliases: "-f", desc: "Accepts png or dot"
-    def graph(app_path)
-      Graph.new(app_path, options.format).generate!
+    desc "graph [component]", "Outputs a graph of a given component or umbrella"
+    method_option :output, default: File.join(Dir.pwd, "output.png"), aliases: "-o",
+                           desc: "Output file, accepts .png or .dot"
+    def graph(component = nil)
+      CobraCommander::Output::GraphViz.generate(
+        find_component(component),
+        options.output
+      )
+      puts "Graph generated at #{options.output}"
+    rescue ArgumentError => error
+      error error.message
     end
 
-    desc "changes APP_PATH [--results=RESULTS] [--branch=BRANCH]", "Prints list of changed files"
+    desc "changes [--results=RESULTS] [--branch=BRANCH]", "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"
-    def changes(app_path)
-      Change.new(app_path, options.results, options.branch).run!
+    def changes
+      Change.new(umbrella, options.results, options.branch).run!
+    end
+
+  private
+
+    def umbrella
+      @umbrella ||= CobraCommander.umbrella(options.app, yarn: options.js, bundler: options.ruby)
+    end
+
+    def find_component(name)
+      return umbrella.root unless name
+
+      umbrella.find(name) || error("Component #{name} not found, try one of `cobra ls`") || exit(1)
+    end
+
+    def components_filtered(component_name)
+      return umbrella.components unless component_name
+      component = find_component(component_name)
+
+      return component.deep_dependencies if options.dependencies
+      return component.deep_dependents if options.dependents
+      [component]
     end
   end
 end