cobra_commander 0.15.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d625729cf3e531754033d5e368c51e228ffb2e4e46d3c85e841e1731ec3ebc16
-  data.tar.gz: 7e9e07583026f458cae3eb4820e6a2de08afd91ea1d76203cc17c6f7666bd0a5
+  metadata.gz: 1a3895a540b9a0393d9574c2117b0cf84bb2de0109be7dada0f75e7355179d39
+  data.tar.gz: 254aff0eb790d9db8b1cb1f216b4e2a3d964b91dee54250403dac9089b4db944
 SHA512:
-  metadata.gz: 2cbf7b292a417763f26e2b4345c90d77bd33ad33e96b12c0823274fbcd94cc545d6f0ee58508171d1020ebfbddef33dd376406887a1a7a04583e8dec760b942d
-  data.tar.gz: dfbb0224eea4dcac7037add00b03f8e41cc4563e50ec3880283028fb940b2f9ad72dba4aa40f6d487f4ef4df68431f1e40b6bb9a74208299e822e7e80fce7ea3
+  metadata.gz: 7825c34b935c88c0f36549bba626bddd3f9d58f6cfd815035b8bba7c2f13d07344b4c01b0666d2540ed53ad7001ddd7ddc40edd385be4e30e23ef9dcb616fb04
+  data.tar.gz: c063f162e6525252c4692a026f36f7e016c335fcf5ac48213f77da487737f9378244b233959abbe42ec738bc877e2e40422ca512fbb3ace997f5daa56cac6d20

data/.gitignore

@@ -4,7 +4,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /graph.*
 /pkg/
 /spec/examples.txt
@@ -15,4 +14,3 @@
 /tmp/
 
 .bundle
-gemfiles/*.lock

data/.rubocop.yml

@@ -1,13 +1,8 @@
-inherit_from: .rubocop_todo.yml
-
 require:
   - rubocop-powerhome
 
 Rails:
   Enabled: false
 
-Gemspec/RequireMFA:
-  Enabled: false
-
 Style/ClassAndModuleChildren:
   Enabled: false

data/Gemfile

@@ -3,3 +3,10 @@
 source "https://rubygems.org"
 
 gemspec
+
+bundler_version = ENV.fetch("BUNDLER_VERSION", "2")
+gem "bundler", "~> #{bundler_version}"
+
+group :cobra do
+  gem "cobra_commander-stub", path: "./spec/support/", require: "stub_source"
+end

data/cobra_commander.gemspec

@@ -26,6 +26,11 @@ Gem::Specification.new do |spec|
   spec.homepage = "http://tech.powerhrg.com/cobra_commander/"
   spec.license = "MIT"
 
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/powerhome/cobra_commander"
+  spec.metadata["changelog_uri"] = "https://github.com/powerhome/cobra_commander/blob/main/cobra_commander/docs/CHANGELOG.md"
+
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -35,7 +40,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "bundler"
   spec.add_dependency "concurrent-ruby", "~> 1.1"
-  spec.add_dependency "ruby-graphviz", "~> 1.2.3"
   spec.add_dependency "thor", ["< 2.0", ">= 0.18.1"]
   spec.add_dependency "tty-command", "~> 0.10.0"
   spec.add_dependency "tty-prompt", "~> 0.23.1"
@@ -44,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "aruba", "~> 0.14.2"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "license_finder", ">= 7.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.5"

data/doc/dependency_decisions.yml

@@ -0,0 +1,9 @@
+---
+- - :inherit_from
+  - https://raw.githubusercontent.com/powerhome/oss-guide/master/license_rules.yml
+- - :approve
+  - bundler
+  - :who: Carlos Palhares <carlos.palhares@powerhrg.com>
+    :why: 'Bundler <https://rubygems.org/gems/bundler/versions/1.17.3> is licensed under MIT, but license_finder sometimes fails to resolve that with 1.17.3.'
+    :versions: [1.17.3]
+    :when: 2022-11-02 20:36:55.617698000 Z

data/docs/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## Version 1.0.0 - 2022-10-15
+
+* Extract Ruby and Yarn package loading to plugins by @xjunior [#87](https://github.com/powerhome/cobra_commander/pull/87)
+* Remove unused/broken methods from CobraCommander API by @xjunior [#84](https://github.com/powerhome/cobra_commander/pull/84)
+* Ruby sources are not hardcoded to "components" anymore by @xjunior [#85](https://github.com/powerhome/cobra_commander/pull/85)
+* Remove graphviz graph in favor of plain dot graph file by @xjunior [#88](https://github.com/powerhome/cobra_commander/pull/88)
+* Add license_finder to cobra CI by @xjunior [#89](https://github.com/powerhome/cobra_commander/pull/89)
+* Umbrella now "depends" on all packages in Yarn AND Ruby by @xjunior [#90](https://github.com/powerhome/cobra_commander/pull/90)
+* Refactor affected to reuse umbrella#resolve by @xjunior [#91](https://github.com/powerhome/cobra_commander/pull/91)
+* Umbrella root is not a component by itself anymore by @xjunior [#92](https://github.com/powerhome/cobra_commander/pull/92)
+* Move output into CLI by @xjunior [#93](https://github.com/powerhome/cobra_commander/pull/93)
+* Simplify Executor and remove Executor::Concurrent by @xjunior [#94](https://github.com/powerhome/cobra_commander/pull/94)
+
 ## Version 0.15.1 - 2022-08-23
 
 * Fix `--affected` filter [#82](https://github.com/powerhome/cobra_commander/pull/82)

data/docs/README.md

@@ -1,10 +1,5 @@
 # cobra_commander
 
-[![Gem](https://img.shields.io/gem/dv/cobra_commander/stable.svg)](https://rubygems.org/gems/cobra_commander)
-[![Gem](https://img.shields.io/gem/v/cobra_commander.svg)](https://rubygems.org/gems/cobra_commander)
-[![CI](https://github.com/powerhome/cobra_commander/actions/workflows/ci.yml/badge.svg)](https://github.com/powerhome/cobra_commander/actions/workflows/ci.yml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/7fe0781c18f6923ab753/maintainability)](https://codeclimate.com/github/powerhome/cobra_commander/maintainability)
-
 Tools for working with Component Based Rails Apps (see https://cbra.info). Includes tools for graphing both Ruby and Javascript components in an application and their relationships, as well as selectively testing components based on changes made.
 
 ## Installation
@@ -23,138 +18,17 @@ Or install it yourself as:
 
     $ gem install cobra_commander
 
-## Usage (cobra help)
-
-```bash
-Commands:
-  cobra changes [--results=RESULTS] [--branch=BRANCH]  # Prints list of changed files
-  cobra exec [components] <command>                    # Executes the command in the context of a given component or set thereof. Defaults to 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 [components]                                # 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/me/myapp
-      [--js], [--no-js]      # Consider only the JS dependency graph
-      [--ruby], [--no-ruby]  # Consider only the Ruby dependency graph
-```
-
-### cobra changes
-
-```sh
-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/me/myapp
-      [--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 [components] <command>
-
-[components] is all components by default, or a comma separated list of component names (no spaces between)
-
-Options:
-      [--affected=AFFECTED]                  # Components affected since given branch [default: main]
-  -d, [--dependencies], [--no-dependencies]  # Run the command on each dependency of a given component
-  -D, [--dependents], [--no-dependents]      # Run the command on each dependent of a given component
-      [--self], [--no-self]                  # Include the own component
-                                             # Default: true
-  -c, [--concurrency=N]                      # Max number of jobs to run concurrently
-                                             # Default: 5
-  -i, [--interactive], [--no-interactive]    # Runs in interactive mode to allow the user to inspect the output of each component
-                                             # Default: true
-  -a, [--app=APP]
-                                             # Default: /Users/me/myapp
-      [--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 thereof. Defaults to all components.
-```
-
-### cobra graph
-
-```sh
-Usage:
-  cobra graph [component]
-
-Options:
-  -o, [--output=OUTPUT]      # Output file, accepts .png or .dot
-                             # Default: /Users/me/myapp/output.png
-  -a, [--app=APP]
-                             # Default: /Users/me/myapp
-      [--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 [components]
-
-[components] is all components by default, or a comma separated list of component names (no spaces between)
-
-Options:
-      [--affected=AFFECTED]                  # Components affected since given branch [default: main]
-  -d, [--dependencies], [--no-dependencies]  # Lists all dependencies of a given component
-  -D, [--dependents], [--no-dependents]      # Lists all dependents of a given component
-      [--self], [--no-self]                  # Include the own component
-                                             # Default: true
-  -t, [--total], [--no-total]                # Prints the total count of components
-  -a, [--app=APP]
-                                             # Default: /Users/me/myapp
-      [--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/me/myapp
-      [--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. 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).
+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.
 
 ### 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:
+In order to maintain the features around umbrella apps and specially `changes`, a bundled [`umbrella app repo`](spec/fixtures/modified-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 modified-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 .`
+1. from within the app run `tar cfz path/to/cobra/spec/fixtures/modified-app.tgz .`
 
 ## Contributing
 

data/exe/cobra

@@ -1,6 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require "bundler"
+
+# Require plugins
+Bundler.require(:cobra)
+
 require "cobra_commander/cli"
 
 CobraCommander::CLI.start

data/lib/cobra_commander/affected.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
+require "json"
+
 module CobraCommander
   # Calculates directly & transitively affected components
   class Affected
     def initialize(umbrella, changes)
       @umbrella = umbrella
       @changes = changes
-      run!
     end
 
     def names
-      @names ||= all_affected.map(&:name)
+      @names ||= all.map(&:name)
     end
 
-    def all_affected
-      @all_affected ||= (@directly | @transitively).sort_by(&:name)
+    def all
+      @all ||= (directly | transitively).sort_by(&:name)
     end
 
     def scripts
@@ -22,75 +23,42 @@ module CobraCommander
     end
 
     def directly
-      @directly.map(&method(:affected_component))
+      @directly ||= @changes.filter_map { |path| @umbrella.resolve(path) }
+                            .uniq.sort_by(&:name)
     end
 
     def transitively
-      @transitively.map(&method(:affected_component))
+      @transitively ||= directly.flat_map(&:deep_dependents)
+                                .uniq.sort_by(&:name)
     end
 
-    def json_representation
+    def to_json(*_args)
       {
         changed_files: @changes,
-        directly_affected_components: directly,
-        transitively_affected_components: transitively,
+        directly_affected_components: directly.map { |c| affected_component(c) },
+        transitively_affected_components: transitively.map { |c| affected_component(c) },
         test_scripts: scripts,
         component_names: names,
-        languages: { ruby: contains_ruby?, javascript: contains_js? },
+        languages: all_affected_packages,
       }.to_json
     end
 
   private
 
-    def run!
-      @transitively = Set.new
-      @directly = Set.new
-      @umbrella.components.each(&method(:add_if_changed))
-      @transitively = @transitively.sort_by(&:name)
-      @directly = @directly.sort_by(&:name)
-    end
-
-    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)
-      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.packages.keys.map(&:to_s).map(&:capitalize).join(" & "),
+        path: component.root_paths.map(&:to_s),
+        type: component.packages.map(&:key).map(&:to_s),
       }
     end
 
     def paths
-      @paths ||= all_affected.map(&:root_paths).flatten
+      @paths ||= all.map(&:root_paths).flatten
     end
 
     def all_affected_packages
-      all_affected
-        .map(&:packages)
-        .map(&:keys)
-        .flatten
-        .uniq
-    end
-
-    def contains_ruby?
-      all_affected_packages.include?(:bundler)
-    end
-
-    def contains_js?
-      all_affected_packages.include?(:yarn)
+      all.flat_map(&:packages).map(&:key).uniq
     end
   end
 end

data/lib/cobra_commander/cli/filters.rb

@@ -13,8 +13,6 @@ module CobraCommander
   private
 
     def find_component(name)
-      return umbrella.root unless name
-
       umbrella.find(name) || error("Component #{name} not found, maybe #{suggestion(name)}") || exit(1)
     end
 
@@ -31,7 +29,7 @@ module CobraCommander
 
     def affected_by_changes(origin_branch)
       changes = GitChanged.new(umbrella.path, origin_branch)
-      Affected.new(umbrella, changes).all_affected
+      Affected.new(umbrella, changes).all
     end
 
     def filter_component(component_name)

data/lib/cobra_commander/{output → cli/output}/ascii_tree.rb

@@ -3,7 +3,7 @@
 require "stringio"
 
 module CobraCommander
-  module Output
+  module CLI::Output
     # Prints the tree in a nice tree form
     class AsciiTree
       SPACE = "    "
@@ -11,14 +11,16 @@ module CobraCommander
       TEE = "├── "
       CORNER = "└── "
 
-      def initialize(component)
-        @component = component
+      def initialize(components)
+        @components = components.sort_by(&:name)
       end
 
       def to_s
         StringIO.new.tap do |io|
-          io.puts @component.name
-          list_dependencies(io, @component)
+          @components.each do |component|
+            io.puts component.name
+            list_dependencies(io, component)
+          end
         end.string
       end
 

data/lib/cobra_commander/cli/output/change.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "cobra_commander/git_changed"
+require "cobra_commander/affected"
+
+module CobraCommander
+  class CLI
+    module Output
+      # Calculates and prints affected components & files
+      class Change
+        InvalidSelectionError = Class.new(StandardError)
+
+        def initialize(umbrella, oformat, branch, changes: nil)
+          @format = oformat
+          @branch = branch
+          @umbrella = umbrella
+          @changes = changes || GitChanged.new(umbrella.path, branch)
+        end
+
+        def run!
+          assert_valid_result_choice
+          if selected_format?("json")
+            puts affected.to_json
+          else
+            show_full if selected_format?("full")
+            tests_to_run
+          end
+        rescue GitChanged::InvalidSelectionError => e
+          puts e.message
+        end
+
+      private
+
+        def affected
+          @affected ||= Affected.new(@umbrella, @changes)
+        end
+
+        def show_full
+          changes_since_last_commit
+          directly_affected_components
+          transitively_affected_components
+        end
+
+        def assert_valid_result_choice
+          return if %w[test full name json].include?(@format)
+
+          raise InvalidSelectionError, "--results must be 'test', 'full', 'name' or 'json'"
+        end
+
+        def selected_format?(result)
+          @format == result
+        end
+
+        def changes_since_last_commit
+          puts "<<< Changes since last commit on #{@branch} >>>"
+          puts(*@changes) if @changes.any?
+          puts blank_line
+        end
+
+        def directly_affected_components
+          puts "<<< Directly affected components >>>"
+          affected.directly.each { |component| puts display(component) }
+          puts blank_line
+        end
+
+        def transitively_affected_components
+          puts "<<< Transitively affected components >>>"
+          affected.transitively.each { |component| puts display(component) }
+          puts blank_line
+        end
+
+        def tests_to_run
+          puts "<<< Test scripts to run >>>" if selected_format?("full")
+          if selected_format?("name")
+            affected.names.each { |component_name| puts component_name }
+          else
+            affected.scripts.each { |component_script| puts component_script }
+          end
+        end
+
+        def display(component)
+          "#{component.name} - #{component.packages.map(&:key).map(&:to_s).map(&:capitalize).join(' & ')}"
+        end
+
+        def blank_line
+          ""
+        end
+      end
+    end
+  end
+end

data/lib/cobra_commander/cli/output/dot_graph.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CobraCommander
+  class CLI
+    module Output
+      # Generates graphs of components
+      module DotGraph
+        def self.generate(components, output)
+          output << "digraph G {\n"
+          [*components, *components.flat_map(&:deep_dependencies)].uniq.each do |comp|
+            output << "\t#{comp.name};\n"
+            comp.dependencies.each do |dep|
+              output << "\t#{comp.name} -> #{dep.name};\n"
+            end
+          end
+          output << "}\n"
+        end
+      end
+    end
+  end
+end