cobra_commander 1.0.1 → 1.1.0

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&.(_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, **kwargs, &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, **kwargs, &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/package.rb

@@ -17,5 +17,9 @@ module CobraCommander
       @name = name
       @dependencies = dependencies
     end
+
+    def describe
+      "#{name} (#{key})"
+    end
   end
 end

data/lib/cobra_commander/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cobra_commander
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ben Langfeld
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -26,20 +26,6 @@ dependencies:
     - - ">="
       - !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'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -88,20 +74,6 @@ 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
@@ -241,16 +213,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 +226,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
@@ -301,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Tools for working with Component Based Rails Apps

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

data/Guardfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end

data/Rakefile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rubocop/rake_task"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new(:rubocop)
-
-task default: %i[spec rubocop]

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "cobra_commander"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/doc/dependency_decisions.yml

@@ -1,9 +0,0 @@
----
-- - :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/lib/cobra_commander/executor/execution.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require "concurrent-ruby"
-
-module CobraCommander
-  module Executor
-    # A threaded execution environment, limited by the number of given workers
-    class Execution < Hash
-      #
-      # @param jobs [Array<#call>] array of job objects
-      # @param workers [Integer] number of workers to process this execution
-      # @see CobraCommander::Executor::Job
-      def initialize(jobs, workers:)
-        super()
-
-        @executor = Concurrent::FixedThreadPool.new(workers, auto_terminate: true)
-        merge! create_futures(jobs)
-      end
-
-      # Wait for all jobs to complete, returns a future with all execution futures
-      # @return [Concurrent::Promises::Future]
-      def wait
-        Concurrent::Promises.zip_futures_on(@executor, *values)
-                            .tap(&:wait)
-      end
-
-      # The execution succeeds when all jobs succeeded
-      # @return [Boolean]
-      def success?
-        values.all?(&:fulfilled?)
-      end
-
-    private
-
-      def create_future(job)
-        Concurrent::Promises.future_on(@executor, job, &:call).then do |result|
-          status, output = result
-          case status
-          when :error then Concurrent::Promises.rejected_future(output)
-          when :success, :skip then Concurrent::Promises.fulfilled_future(output)
-          else
-            Concurrent::Promises.fulfilled_future(result)
-          end
-        end.flat
-      end
-
-      def create_futures(jobs)
-        jobs.to_h { |job| [job, create_future(job)] }
-      end
-    end
-  end
-end

data/lib/cobra_commander/executor/interactive_printer.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require "pastel"
-require "tty-prompt"
-
-module CobraCommander
-  module Executor
-    # Runs an interactive output printer
-    class InteractivePrinter
-      pastel = Pastel.new
-      SUCCESS = "#{pastel.green('✔')} %s"
-      ERROR = "#{pastel.red('✖')} %s"
-      BYE = pastel.decorate("\n\n👋 Bye!", :white, :on_black, :bold).freeze
-
-      def self.run(execution, output)
-        new(execution).run(output)
-      end
-
-      def initialize(execution)
-        @prompt = TTY::Prompt.new
-        @execution = execution
-      end
-
-      def run(output)
-        selected = nil
-        loop do
-          selected = @prompt.select("Print output?", options, default: options.key(selected))
-          output.puts selected.fulfilled? ? selected.value : selected.reason
-        end
-      rescue TTY::Reader::InputInterrupt
-        output.puts BYE
-      end
-
-    private
-
-      def options
-        @options ||= @execution.sort { |*args| sort_results(*args.flatten) }
-                               .reduce({}) do |options, (job, result)|
-          template = result.rejected? ? ERROR : SUCCESS
-          options.merge format(template, job.to_s) => result
-        end
-      end
-
-      def sort_results(job_a, result_a, job_b, result_b)
-        if result_a.rejected? == result_b.rejected?
-          job_a.to_s <=> job_b.to_s
-        else
-          result_b.rejected? ? 1 : -1
-        end
-      end
-    end
-  end
-end

data/lib/cobra_commander/executor/job.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require "tty-command"
-
-module CobraCommander
-  module Executor
-    #
-    # This is a helper module to help jobs return valid errors and success outputs.
-    #
-    # A CobraCommander::Executor::Job is actually any object responding to #call, and returning
-    # valid error or success responses.
-    #
-    # An error is an array containint `:error` and the output (i.e.: [:error, "string output"]).
-    # A success is either an array containint `:success` and the output, or just the output
-    # (i.e.: [:error, "string output"] or just "string output").
-    #
-    module Job
-      def skip(reason)
-        [:skip, reason]
-      end
-
-      def error(output)
-        [:error, output]
-      end
-
-      def success(output)
-        [:success, output]
-      end
-
-      def run_script(script, path)
-        result = isolate_bundle do
-          TTY::Command.new(pty: true, printer: :null)
-                      .run!(script, chdir: path, err: :out)
-        end
-        return error(result.out) if result.failed?
-
-        success(result.out)
-      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/markdown_printer.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module CobraCommander
-  module Executor
-    # Prints the given CobraCommander::Executor::Context to [output] collection in markdown
-    module MarkdownPrinter
-      SUCCESS = "\n## ✔ %s\n"
-      ERROR = "\n## ✖ %s\n"
-      OUTPUT = "\n```\n\n%s\n```\n"
-
-      def self.run(execution, output)
-        execution.each do |job, result|
-          template = result.fulfilled? ? SUCCESS : ERROR
-
-          output.print format(template, job)
-          output.print format(OUTPUT, result.fulfilled? ? result.value : result.reason)
-        end
-      end
-    end
-  end
-end

data/lib/cobra_commander/executor/spinners.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "pastel"
-require "tty-spinner"
-
-module CobraCommander
-  module Executor
-    class Spinners
-      pastel = ::Pastel.new
-      SPINNER_OPTIONS = {
-        format: :bouncing,
-        success_mark: pastel.green("[DONE]"),
-        error_mark: pastel.red("[ERROR]"),
-      }.freeze
-
-      def self.start(execution, output:)
-        new(execution, output: output).start
-      end
-
-      def initialize(execution, output:)
-        @multi = TTY::Spinner::Multi.new(":spinner :task", output: output)
-        @multi.top_spinner.update(task: "Running")
-        execution.each { |job, result| register_spinner(job, result) }
-      end
-
-      def start
-        @multi.auto_spin
-      end
-
-    private
-
-      def register_spinner(job, result)
-        @multi.register(":spinner #{job}", **SPINNER_OPTIONS) do |spinner|
-          result.on_fulfillment!(spinner) { |_, spin| spin.success }
-                .on_rejection!(spinner) { |_, spin| spin.error }
-        end
-      end
-    end
-  end
-end

data/mkdocs.yml

@@ -1,8 +0,0 @@
-site_name: Cobra Commander
-site_description: Cobra Commander Documentation
-repo_url: https://github.com/powerhome/cobra_commander
-nav:
-  - "Home": "README.md"
-  - "Changelog": "CHANGELOG.md"
-plugins:
-  - techdocs-core