cobra_commander 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf88be500ee51ad9217ce6729399a3dd45ea69bc91f8d0a2f9ffc97521f802a3
-  data.tar.gz: 13c889293a2173dc698257d1e614a2072b705faca25c3a59d8066e5d09326974
+  metadata.gz: 8461ea231fa9be478360d33fbadfb8983512172687831ac7c17ac1f927614200
+  data.tar.gz: 0b36b28eadecb6e0bc6e7ee8c3e6db951f7dc7d74be67c91b97659dc7bd52c5e
 SHA512:
-  metadata.gz: 2300c5d0b41084a2d6403444c8548710e57a6645e770ee0d1befa029bfa947e738fe0909d33c522a1543b24892580e0acd7dd2504baae7100ed05af5e32e4a45
-  data.tar.gz: 64e6ff60e979d5ffe2c0c7cceed3cd23733694cc479ad96f484b4af1b6ed421a2aa65ec2e4450699363b3006274784daed0737e27b4b4f4c904123764b1c11ed
+  metadata.gz: 39a0956db1750d63553d87e4d13ad75246f4f4633b3d6a42de621c45f11a515506ab5f0d7f14343d61f183d03df7e8218dee8f93a439da023e442d70c7f3b681
+  data.tar.gz: 227acbdb961e2903cdaacd44ed4bdd7b07a48e7298737bbe5b6228bd28df8aa6c7aea6a6949de2a3eea999287b633e9bfcd32b7b9e108e3f7f4fcaa7385e2806

data/.github/workflows/ci.yml

@@ -1,9 +1,6 @@
 name: CI
 
-on:
-  push:
-  pull_request:
-    types: [opened, reopened]
+on: push
 
 jobs:
   test:

data/.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Publish Gem
 on:
   push:
     branches:
-      - master
+      - main
     tags:
       - v*
 jobs:

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## Version 0.12.0 - 2021-09-21
+
+* Add interactive UI and Markdown output to `cobra exec` [#63](https://github.com/powerhome/cobra_commander/pull/63)
+* Add `--self` and `--no-self` filters to `cobra exec` and `cobra ls`, defaults to `--self` [#61](https://github.com/powerhome/cobra_commander/pull/61)
+
 ## Version 0.11.0 - 2021-04-23
 
 * Add concurrency limit to multi exec [#57](https://github.com/powerhome/cobra_commander/pull/57)

data/cobra_commander.gemspec

@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
   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"
   spec.add_dependency "tty-spinner", "~> 0.9.3"
 
   spec.add_development_dependency "aruba", "~> 0.14.2"

data/lib/cobra_commander/cli/filters.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CobraCommander
+  # @private
+  class CLI
+    private_class_method def self.filter_options(dependents:, dependencies:)
+      method_option :dependencies, type: :boolean, aliases: "-d", desc: dependencies
+      method_option :dependents, type: :boolean, aliases: "-D", desc: dependents
+      method_option :self, type: :boolean, default: true, desc: "Include the own component"
+    end
+
+  private
+
+    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)
+      components = options.self ? [component] : []
+      components.concat component.deep_dependencies if options.dependencies
+      components.concat component.deep_dependents if options.dependents
+      components
+    end
+  end
+end

data/lib/cobra_commander/cli.rb

@@ -13,6 +13,8 @@ require "cobra_commander/output"
 module CobraCommander
   # Implements the tool's CLI
   class CLI < Thor
+    require "cobra_commander/cli/filters"
+
     DEFAULT_CONCURRENCY = (Concurrent.processor_count / 2.0).ceil
 
     class_option :app, default: Dir.pwd, aliases: "-a", type: :string
@@ -25,10 +27,8 @@ module CobraCommander
     end
 
     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"
+    filter_options dependents: "Lists all dependents of a given component",
+                   dependencies: "Lists all dependencies 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)
@@ -37,16 +37,24 @@ module CobraCommander
 
     desc "exec [component] <command>", "Executes the command in the context of a given component or set thereof. " \
                                        "Defaults to 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"
+    filter_options dependents: "Run the command on each dependent of a given component",
+                   dependencies: "Run the command on each dependency of a given component"
     method_option :concurrency, type: :numeric, default: DEFAULT_CONCURRENCY, aliases: "-c",
                                 desc: "Max number of jobs to run concurrently"
+    method_option :interactive, type: :boolean, default: true, aliases: "-i",
+                                desc: "Runs in interactive mode to allow the user to inspect the output of each component"
     def exec(command_or_component, command = nil)
-      CobraCommander::Executor.exec(
+      results = CobraCommander::Executor.exec(
         components: components_filtered(command && command_or_component),
         command: command || command_or_component,
-        concurrency: options.concurrency
+        concurrency: options.concurrency,
+        status_output: $stderr
       )
+      if options.interactive && results.size > 1
+        CobraCommander::Output::InteractivePrinter.run(results, $stdout)
+      else
+        CobraCommander::Output::MarkdownPrinter.run(results, $stdout)
+      end
     end
 
     desc "tree [component]", "Prints the dependency tree of a given component or umbrella"
@@ -80,22 +88,5 @@ module CobraCommander
     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

data/lib/cobra_commander/executor/{multi_exec.rb → concurrent.rb}

@@ -1,32 +1,26 @@
 # frozen_string_literal: true
 
 require "tty-spinner"
-require "stringio"
 require "concurrent-ruby"
 
-require_relative "component_exec"
-
 module CobraCommander
   module Executor
-    # Execute a command on multiple components
-    class MultiExec
-      def initialize(components, concurrency:, spin_output: $stderr)
+    # Execute a command on multiple components concurrently
+    class Concurrent
+      def initialize(components, concurrency:, spin_output:)
         @components = components
         @multi = TTY::Spinner::Multi.new(":spinner :task", output: spin_output)
-        @semaphore = Concurrent::Semaphore.new(concurrency)
+        @semaphore = ::Concurrent::Semaphore.new(concurrency)
       end
 
-      def run(command, output: $stdout, **kwargs)
-        buffer = StringIO.new
+      def exec(command)
         @multi.top_spinner.update(task: "Running #{command}")
+        @results = []
         @components.each do |component|
-          register_job(command: command, component: component,
-                       output: buffer, stderr: :stdout,
-                       only_output_on_error: true, **kwargs)
+          register_job(component, command)
         end
         @multi.auto_spin
-        output << buffer.string
-        @multi.success?
+        @results
       end
 
     private
@@ -43,15 +37,12 @@ module CobraCommander
         }
       end
 
-      def register_job(component:, command:, **kwargs)
+      def register_job(component, command)
         @multi.register(":spinner #{component.name}", **spinner_options) do |spinner|
           @semaphore.acquire
-          exec = ComponentExec.new(component)
-          if exec.run(command, **kwargs)
-            spinner.success
-          else
-            spinner.error
-          end
+          context = Context.new(component, command)
+          context.success? ? spinner.success : spinner.error
+          @results << context
           @semaphore.release
         end
       end

data/lib/cobra_commander/executor/context.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "tty-command"
+
+module CobraCommander
+  module Executor
+    class Context
+      attr_reader :component, :command
+
+      def initialize(component, command)
+        @component = component
+        @command = command
+        @tty = TTY::Command.new(pty: true, printer: :null, stderr: :stdout)
+      end
+
+      def results
+        @results ||= @component.root_paths.map do |path|
+          isolate_bundle do
+            @tty.run!(command, chdir: path)
+          end
+        end
+      end
+
+      def component_name
+        component.name
+      end
+
+      def success?
+        results.all?(&:success?)
+      end
+
+      def output
+        results.join("\n")
+      end
+
+    private
+
+      def isolate_bundle(&block)
+        if Bundler.respond_to?(:with_unbundled_env)
+          Bundler.with_unbundled_env(&block)
+        else
+          Bundler.with_clean_env(&block)
+        end
+      end
+    end
+  end
+end

data/lib/cobra_commander/executor.rb

@@ -1,19 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "executor/component_exec"
-require_relative "executor/multi_exec"
+require_relative "executor/context"
+require_relative "executor/concurrent"
 
 module CobraCommander
-  # Execute commands on all components of a ComponentTree
+  # Execute a command on all given components
   module Executor
-    def self.exec(components:, command:, concurrency:, output: $stdout, status_output: $stderr)
-      components = Array(components)
-      exec = if components.size == 1
-               ComponentExec.new(components.first)
-             else
-               MultiExec.new(components, concurrency: concurrency, spin_output: status_output)
-             end
-      exec.run(command, output: output)
+    def self.exec(components:, command:, concurrency:, status_output:)
+      Concurrent.new(components, concurrency: concurrency, spin_output: status_output)
+                .exec(command)
     end
   end
 end

data/lib/cobra_commander/output/ascii_tree.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "stringio"
+
 module CobraCommander
   module Output
     # Prints the tree in a nice tree form

data/lib/cobra_commander/output/interactive_printer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "pastel"
+require "tty-prompt"
+
+module CobraCommander
+  module Output
+    # Runs an interactive output printer
+    module InteractivePrinter
+      pastel = Pastel.new
+      SUCCESS = "#{pastel.green("✔")} %s".freeze
+      ERROR = "#{pastel.red("✖")} %s".freeze
+      BYE = pastel.decorate("👋 Bye!", :white, :on_black, :bold).freeze
+
+      def self.run(contexts, output)
+        prompt = TTY::Prompt.new
+        context_options = contexts.reduce({}) do |options, context|
+          template = context.success? ? SUCCESS : ERROR
+          options.merge(
+            format(template, context.component_name) => context
+          )
+        end
+        loop do
+          context = prompt.select("Print output?", context_options)
+          output.puts context.output
+        end
+      rescue TTY::Reader::InputInterrupt
+        output.puts "\n\n", BYE
+      end
+    end
+  end
+end

data/lib/cobra_commander/output/markdown_printer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "pastel"
+require "tty-prompt"
+
+module CobraCommander
+  module Output
+    # Prints the given CobraCommander::Executor::Context to [output] collection in markdown
+    module MarkdownPrinter
+      SUCCESS = "\n## ✔ %s\n".freeze
+      ERROR = "\n## ✖ %s\n".freeze
+      OUTPUT = "\n```\n$ %s\n\n%s\n```\n".freeze
+
+      def self.run(contexts, output)
+        contexts.each do |context|
+          template = context.success? ? SUCCESS : ERROR
+
+          output.print format(template, context.component_name)
+          output.print format(OUTPUT, context.command, context.output)
+        end
+      end
+    end
+  end
+end

data/lib/cobra_commander/output.rb

@@ -3,3 +3,5 @@
 require_relative "output/flat_list"
 require_relative "output/ascii_tree"
 require_relative "output/graph_viz"
+require_relative "output/interactive_printer"
+require_relative "output/markdown_printer"

data/lib/cobra_commander/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CobraCommander
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cobra_commander
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Ben Langfeld
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -237,6 +251,7 @@ files:
 - lib/cobra_commander/affected.rb
 - lib/cobra_commander/change.rb
 - lib/cobra_commander/cli.rb
+- lib/cobra_commander/cli/filters.rb
 - lib/cobra_commander/component.rb
 - lib/cobra_commander/dependencies.rb
 - lib/cobra_commander/dependencies/bundler.rb
@@ -244,12 +259,14 @@ files:
 - lib/cobra_commander/dependencies/yarn/package_repo.rb
 - lib/cobra_commander/dependencies/yarn_workspace.rb
 - lib/cobra_commander/executor.rb
-- lib/cobra_commander/executor/component_exec.rb
-- lib/cobra_commander/executor/multi_exec.rb
+- lib/cobra_commander/executor/concurrent.rb
+- lib/cobra_commander/executor/context.rb
 - lib/cobra_commander/output.rb
 - lib/cobra_commander/output/ascii_tree.rb
 - lib/cobra_commander/output/flat_list.rb
 - lib/cobra_commander/output/graph_viz.rb
+- lib/cobra_commander/output/interactive_printer.rb
+- lib/cobra_commander/output/markdown_printer.rb
 - lib/cobra_commander/umbrella.rb
 - lib/cobra_commander/version.rb
 - renovate.json

data/lib/cobra_commander/executor/component_exec.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "tty-command"
-
-module CobraCommander
-  module Executor
-    # Execute a command on a single component
-    class ComponentExec
-      def initialize(component)
-        @component = component
-      end
-
-      def run(command, output: $stdout, **cmd_options)
-        tty = TTY::Command.new(pty: true, printer: :quiet, output: output)
-        isolate_bundle do
-          @component.root_paths.all? do |path|
-            tty.run!(command, chdir: path, **cmd_options).success?
-          end
-        end
-      end
-
-    private
-
-      def isolate_bundle(&block)
-        if Bundler.respond_to?(:with_unbundled_env)
-          Bundler.with_unbundled_env(&block)
-        else
-          Bundler.with_clean_env(&block)
-        end
-      end
-    end
-  end
-end