cobra_commander 0.6.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '037980fd32c80d6ea74549f570cf31cf88d92d4a2702f4ab6568a68bf6160893'
-  data.tar.gz: 46da654f6a423723487f595bfe1f397cb32208ef995634396e508594fd51b5fd
+  metadata.gz: d77734cb3eeb9f21c539f66a92d15e8aa94030046db7cdad3be8f6ed191c00aa
+  data.tar.gz: feacbdfbafb7baf191948e81014d9335b1cddf4a1ddd0f0a2aeac13af823efb3
 SHA512:
-  metadata.gz: aa50298aacd18c53e98f73859e3bd787def474fbd7854f67c014b6c35ca1ea2ee82b84d8af1ac25d47ff8b3317410951a2e021fead7d19eb4d0dabfafd8e89ab
-  data.tar.gz: b8b5e75884f2c3b49839c14654f0b729ba9247fb67e90d86b4946fe896f5bfe4da39149f5a79a2d6bb63507e862a91b30817b99905ebd77d95a04a8b839163e0
+  metadata.gz: dd926a0cc0bf9978b9b3dae6319e5b33853a2191f0d3b82645e696355a671769bf23894de45a58fb02fe5d0bb302c986d2ec8b3d71559c414248a82e2822c921
+  data.tar.gz: 60c750c84313992647cf94463ecc31fda2e5e3502f21a6eaacf4d6dbf206eddb8cacbd28d8925547c2851034bb64e3775413467f0c00962397e42af7484ac986

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/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - "2.5"
+          - "2.6"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: 1
+        bundler-cache: true
+    - name: Install Graphviz
+      run: sudo apt -qq install graphviz
+    - name: Run tests
+      run: bundle exec rake spec
+  lint:
+    name: Lint Ruby
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: rubocop
+      uses: reviewdog/action-rubocop@v1
+      with:
+        rubocop_version: 0.48.1
+        filter_mode: nofilter
+        fail_on_error: true
+        rubocop_extensions: ""
+        github_token: ${{ secrets.github_token }}

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,30 @@
 
 ## Unreleased
 
+## Version 0.9.0 - 2020-08-26
+
+* Add support for parallel task execution to `cobra exec`.
+
+## Version 0.8.1 - 2020-07-29
+
+* Fix CobraCommander::Executor when running [`bundler`](https://bundler.io/) based commands (i.e.: `bundle exec rspec`)
+
+## 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)

data/README.md

@@ -24,19 +24,110 @@ Or install it yourself as:
 
     $ gem install cobra_commander
 
-## Usage
+## Usage (cobra help)
 
 ```bash
 Commands:
-  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
+  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
@@ -45,6 +136,14 @@ After checking out the repo, run `bin/setup` to install dependencies. You will a
 
 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).
 
+### Bundled App
+
+In order to maintain the features around umbrella apps and specially `changes`, a bundled [`umbrella app repo`](spec/fixtures/app.tgz) is included in this repository. This repo is compacted by `tar`/`gzip` in order to keep isolation, the format was chosen to avoid issues described in https://github.com/swcarpentry/git-novice/issues/272. To avoid the same issues, the workflow for this fixture app is the following:
+
+1. unpack it somewhere outside your repo
+1. do your changes and commit (locally only, it doesn't have a remote)
+1. from within the app run `tar cfz path/to/cobra/spec/fixtures/app.tgz .`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/powerhome/cobra_commander. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

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,13 @@ DESCRIPTION
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  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_dependency "tty-command", "~> 0.9.0"
+  spec.add_dependency "tty-spinner", "~> 0.9.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,14 +1,9 @@
 # frozen_string_literal: true
 
-require "cobra_commander/cli"
-require "cobra_commander/cached_component_tree"
-require "cobra_commander/calculated_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
@@ -16,6 +11,13 @@ 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)
     CalculatedComponentTree.new(UMBRELLA_APP_NAME, path)
   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,56 @@ 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)
+    def component_changed?(component)
+      component.root_paths.any? do |component_path|
+        @changes.any? do |file_path|
+          file_path.start_with?(component_path)
+        end
       end
     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
+      return unless component_changed?(component)
+
+      @directly << component
+      @transitively.merge(component.deep_dependents)
+    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

@@ -8,12 +8,12 @@ module CobraCommander
   class Change
     InvalidSelectionError = Class.new(StandardError)
 
-    def initialize(tree, results, branch)
-      @root_dir = Dir.chdir(tree.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 = tree.to_h
-      @affected = Affected.new(@tree, changes, tree.path)
+      @umbrella = umbrella
+      @affected = Affected.new(@umbrella, changes)
     end
 
     def run!
@@ -85,8 +85,8 @@ module CobraCommander
       end
     end
 
-    def display(component)
-      "#{component[:name]} - #{component[:type]}"
+    def display(name:, type:, **)
+      "#{name} - #{type}"
     end
 
     def blank_line