cobra_commander 1.0.1 → 1.2.0

data/lib/cobra_commander/executor/run_script.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CobraCommander
+  module Executor
+    module RunScript
+      def run_script(tty, script, path, env: {})
+        result = tty.run!(env, script, chdir: path, err: :out)
+
+        return [:error, result.out] if result.failed?
+
+        [:success, result.out]
+      end
+
+      def run_many(collection, &block)
+        collection.lazy.map(&block)
+                  .reduce do |(_, prev_output), (result, output)|
+                    new_output = [prev_output&.strip, output&.strip].join("\n")
+                    return [:error, new_output] if result == :error
+
+                    [:success, new_output]
+        end
+      end
+    end
+  end
+end

data/lib/cobra_commander/executor/script.rb

@@ -1,44 +1,30 @@
 # frozen_string_literal: true
 
-require_relative "./job"
-
 module CobraCommander
   module Executor
-    # This is a script job. It can tarket any CobraCommander::Package.
+    # This is a script job. It can target any CobraCommander::Component.
     #
-    # If you want to target a Component, you can use Script.for to target
-    # individual paths for each given component.
+    # Script runs the given script once for each Component#root_paths
     #
-    # @see Script.for
     class Script
-      include ::CobraCommander::Executor::Job
-
-      # Returns a set of scripts to be executed on the given commends.
-      #
-      # If a component has two packages in the same path, only one script for that component will be
-      # returned.
-      #
-      # @param components [Enumerable<CobraCommander::Component>] the target components
-      # @param script [String] shell script to run from the directories of the component's packages
-      # @return [Array<CobraCommander::Executor::Script>]
-      def self.for(components, script)
-        components.flat_map(&:packages).uniq(&:path).map do |package|
-          new(package, script)
-        end
-      end
+      include ::CobraCommander::Executor::RunScript
 
-      def initialize(package, script)
-        @package = package
+      def initialize(script)
         @script = script
       end
 
-      def to_s
-        @package.name
-      end
-
-      # @see CobraCommander::Executor::Job
-      def call
-        run_script @script, @package.path
+      # Runs the script in the given component
+      #
+      # It runs the script once for each Component#root_paths. If a component has two packages in the
+      # same path, it will run the script only once.
+      #
+      # @param tty [CobraComander::Executor::IsolatedPTY] tty to execute shell scripts
+      # @param component [CobraComander::Component] target component
+      # @return [Array<Symbol, String>]
+      def call(tty, component)
+        component.around_command do |env|
+          run_many(component.root_paths) { run_script(tty, @script, _1, env: env) }
+        end
       end
     end
   end

data/lib/cobra_commander/executor/worker_pool.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module CobraCommander
+  module Executor
+    # @private
+    #
+    # This WorkerPooll will queue up jobs, and execute them using
+    # Worker's, each with a thread running our work loop using the
+    # given runner.
+    #
+    # - A *job* is defined by a group of arguments to be passed to the runner.
+    # - A *runner* is an object that respond to #call(tty, *args), where TTY is
+    #   an instance of TTY::Command, and *args are the arguments queued in the
+    #   worker pool.
+    # - The *runner* call method must return an array of [status, output]
+    # - A worker manages a thread running the job wirh runner.call and updates
+    #   the job result and output.
+    #
+    class WorkerPool
+      Job = Struct.new(:name, :args) do
+        attr_reader :output, :status
+
+        def resolve!(status, output)
+          @status = status
+          @output = output
+        end
+
+        def resolved?
+          !@status.nil?
+        end
+      end
+
+      class Worker
+        attr_reader :id
+
+        def initialize(id, pool)
+          @id = id
+          @pool = pool
+        end
+
+        def kill
+          @thread&.kill
+        end
+
+        def spawn
+          @thread = Thread.new do
+            loop { break if @pool.run_next == :exit }
+          end
+        end
+
+        def wait
+          @thread.join
+        end
+      end
+
+      attr_reader :jobs
+
+      def initialize(runner:, workers:, printer:, jobs:, &name_f)
+        @tty = ::CobraCommander::Executor::IsolatedPTY.new(printer: printer)
+        @runner = runner
+        @workers = Array.new(workers) { |id| Worker.new(id, self) }
+        @jobs = []
+        @queue = Queue.new
+
+        push_all(jobs, &name_f || :describe)
+      end
+
+      def error?
+        jobs.map(&:status).any?(:error)
+      end
+
+      def push_all(jobs, &name_f)
+        jobs.each { push(name_f&.call(_1), *Array(_1)) }
+      end
+
+      def push(name, *args)
+        Job.new(name, args).tap do |job|
+          @jobs.push(job)
+          @queue.push(job)
+        end
+      end
+
+      def start
+        @stop = false
+        @workers.each(&:spawn)
+        @queue.close
+        begin
+          @workers.each(&:wait)
+        rescue Interrupt
+          @workers.each(&:kill) if @stop
+          @stop = true
+          retry
+        end
+      end
+
+      def run_next
+        return :exit if @stop
+        return :exit unless (job = @queue.pop)
+
+        job.resolve!(*@runner.call(@tty, *job.args))
+      end
+    end
+  end
+end

data/lib/cobra_commander/executor.rb

@@ -1,45 +1,47 @@
 # frozen_string_literal: true
 
-require_relative "executor/execution"
-require_relative "executor/job"
-require_relative "executor/script"
-require_relative "executor/command"
-require_relative "executor/spinners"
-require_relative "executor/interactive_printer"
-require_relative "executor/markdown_printer"
+require "pastel"
+require "tty-command"
+require "tty-prompt"
 
 module CobraCommander
   # Execute a command on all given packages
   module Executor
+    autoload :BufferedPrinter, "cobra_commander/executor/buffered_printer"
+    autoload :Command, "cobra_commander/executor/command"
+    autoload :OutputPrompt, "cobra_commander/executor/output_prompt"
+    autoload :IsolatedPTY, "cobra_commander/executor/isolated_pty"
+    autoload :PackageCriteria, "cobra_commander/executor/package_criteria"
+    autoload :Printers, "cobra_commander/executor/printers"
+    autoload :RunScript, "cobra_commander/executor/run_script"
+    autoload :Script, "cobra_commander/executor/script"
+    autoload :WorkerPool, "cobra_commander/executor/worker_pool"
+
   module_function
 
-    # Executes the given jobs in an CobraCommander::Executor::Execution.
-    #
-    # This facade also allows to execute the jobs with a spinner (@see CobraCommander::Executor::Spinners) to display
-    # the execution status of each job.
+    # Executes the given jobs in an CobraCommander::Executor::WorkerPool.
     #
-    # You can also determine how to display the execution once it's completed, by setting `output_mode` to either
-    # :interactive or :markdown. When using :interactive, a menu with each job will be displayed allowing the user
-    # to select a job and see its output. When using :markdown, a markdown will be printed to `output` with the
-    # output of each job.
+    # When only one job is queued, it choses the :quiet printer, to print the
+    # output as it happens.
+    # When more than one job is queued in interactive mode, it uses the :progress
+    # printer, which will display a green dot or a red F depending on the result
+    # of each script execution.
+    # If not in interactive mode, it will print the output in a buffered way to
+    # make it easier to read each output.
     #
     # @param jobs [Enumerable<CobraCommander::Executor::Job>] the jobs to run
-    # @param status_output [IO,nil] if not nil, will print the spinners for each job in this output
-    # @param workers [Integer] number of workers processing the jobs queue (see CobraCommander::Executor::Execution)
-    # @param output_mode [:interactive,:markdown,nil] how the output will be printed after execution
-    # @param workers [Integer] number of workers processing the jobs queue (see CobraCommander::Executor::Execution)
-    # @return [CobraCommander::Executor::Execution]
-    # @see CobraCommander::Executor::Execution
-    # @see CobraCommander::Executor::Spinners
-    # @see CobraCommander::Executor::InterativePrinter
-    # @see CobraCommander::Executor::MarkdownPrinter
-    def execute(jobs:, status_output: nil, output_mode: nil, output: nil, **kwargs)
-      Execution.new(jobs, **kwargs).tap do |execution|
-        Spinners.start(execution, output: status_output) if status_output
-        execution.wait
-        InteractivePrinter.run(execution, output) if output_mode == :interactive
-        MarkdownPrinter.run(execution, output) if output_mode == :markdown
-      end
+    # @param interactive [Boolean] prefer interactive output
+    # @see CobraCommander::Executor::WorkerPool for more options
+    def execute_and_handle_exit(jobs:, interactive: false, **, &name_f)
+      printer = if jobs.size == 1 then :quiet
+                elsif interactive then :progress
+                else
+                  ::CobraCommander::Executor::BufferedPrinter
+                end
+      pool = WorkerPool.new(jobs: jobs, printer: printer, **, &name_f).tap(&:start)
+      return CobraCommander::Executor::OutputPrompt.run(pool) if interactive && jobs.size > 1
+
+      exit(1) if pool.error?
     end
   end
 end

data/lib/cobra_commander/git_changed.rb

@@ -19,8 +19,8 @@ module CobraCommander
       @base_branch = base_branch
     end
 
-    def each(&block)
-      changes.each(&block)
+    def each(&)
+      changes.each(&)
     end
 
   private

data/lib/cobra_commander/package.rb

@@ -9,7 +9,7 @@ module CobraCommander
 
     attr_reader :source, :path, :name, :dependencies
 
-    def_delegators :source, :key
+    def_delegators :source, :key, :around_command
 
     def initialize(source, path:, dependencies:, name:)
       @source = source
@@ -17,5 +17,9 @@ module CobraCommander
       @name = name
       @dependencies = dependencies
     end
+
+    def describe
+      "#{name} (#{key})"
+    end
   end
 end

data/lib/cobra_commander/source.rb

@@ -22,8 +22,19 @@ module CobraCommander
       to_a
     end
 
-    def each(&block)
-      packages.each(&block)
+    # Wraps the execution of commands on this source's packages, letting the
+    # source enhance the surrounding process (e.g. Bundler isolation) and
+    # contribute environment variables to the command. The base implementation
+    # yields an empty env; plugins override it (see CobraCommander::Ruby::Bundle).
+    #
+    # @yieldparam env [Hash{String => String}] env vars to pass to the command
+    # @return the value returned by the block
+    def around_command
+      yield({})
+    end
+
+    def each(&)
+      packages.each(&)
     rescue Errno::ENOENT => e
       raise Error, e.message
     end

data/lib/cobra_commander/version.rb

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

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cobra_commander
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ben Langfeld
 - Garett Arrowood
 - Carlos Palhares
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,28 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 2.4.17
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -88,146 +73,132 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.23.1
-- !ruby/object:Gem::Dependency
-  name: tty-spinner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.14.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.14.14
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.3
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: license_finder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: license_finder
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 0.6.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 1.82.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 1.82.1
 - !ruby/object:Gem::Dependency
   name: rubocop-powerhome
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.1
 description: |
   Tools for working with Component Based Rails Apps (see https://cbra.info).
   Includes tools for graphing the components of an app and their relationships, as well as selectively
@@ -241,16 +212,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- Gemfile
-- Guardfile
-- Rakefile
-- bin/console
-- bin/setup
 - cobra_commander.gemspec
-- doc/dependency_decisions.yml
 - docs/CHANGELOG.md
 - docs/README.md
 - exe/cobra
@@ -263,21 +225,20 @@ files:
 - lib/cobra_commander/cli/output/dot_graph.rb
 - lib/cobra_commander/component.rb
 - lib/cobra_commander/executor.rb
+- lib/cobra_commander/executor/buffered_printer.rb
 - lib/cobra_commander/executor/command.rb
-- lib/cobra_commander/executor/execution.rb
-- lib/cobra_commander/executor/interactive_printer.rb
-- lib/cobra_commander/executor/job.rb
-- lib/cobra_commander/executor/markdown_printer.rb
+- lib/cobra_commander/executor/isolated_pty.rb
+- lib/cobra_commander/executor/output_prompt.rb
 - lib/cobra_commander/executor/package_criteria.rb
+- lib/cobra_commander/executor/run_script.rb
 - lib/cobra_commander/executor/script.rb
-- lib/cobra_commander/executor/spinners.rb
+- lib/cobra_commander/executor/worker_pool.rb
 - lib/cobra_commander/git_changed.rb
 - lib/cobra_commander/package.rb
 - lib/cobra_commander/registry.rb
 - lib/cobra_commander/source.rb
 - lib/cobra_commander/umbrella.rb
 - lib/cobra_commander/version.rb
-- mkdocs.yml
 homepage: http://tech.powerhrg.com/cobra_commander/
 licenses:
 - MIT
@@ -286,7 +247,6 @@ metadata:
   homepage_uri: http://tech.powerhrg.com/cobra_commander/
   source_code_uri: https://github.com/powerhome/cobra_commander
   changelog_uri: https://github.com/powerhome/cobra_commander/blob/main/cobra_commander/docs/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -294,15 +254,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Tools for working with Component Based Rails Apps
 test_files: []

data/.gitignore

@@ -1,16 +0,0 @@
-/.bundle/
-/.DS_store
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/graph.*
-/pkg/
-/spec/examples.txt
-/spec/reports/
-/spec/fixtures/app/node_modules/
-/spec/fixtures/app/node_manifest/node_modules/
-/spec/fixtures/app/components/*/node_modules/
-/tmp/
-
-.bundle

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,8 +0,0 @@
-require:
-  - rubocop-powerhome
-
-Rails:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-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