local_ci_plus 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5e469a0e3234d66985a729cb66222e4f57ea4f627804a7ff4d96f39dcafc2c0
-  data.tar.gz: 0ae35f6c3627d2fdf6fd68b27278563d346a560d419259f115b685c41d1693c0
+  metadata.gz: e29292c8c4b406b43f0e1729ffbfbf52bb7931fa8f62dedab7e9631baab45a5f
+  data.tar.gz: 685c98aadeb7b563c077a5ebf99da60880403e3a9bcbcc15e646fac6c70f841d
 SHA512:
-  metadata.gz: 02d9a9b3b8af2921728c5e3c7625247e72ceee8d43e2512d7f8de851a956ae1c24a2cace9691655db01600e505e834d37d0792161b4a401a4b2cad3e629b2b12
-  data.tar.gz: '08442d855fa89ee0739d90e62145a19720ea6c44f961c1ba3af33dee3289928650e9fc32987699f0bec2a28187a81a235ef98ab0ef79ef7bb6f11d435a467d51'
+  metadata.gz: c40a186742fa94b71a099820f73a03feb79f8b347a00bc8d86d2835dec8070c8acd0f9c03ae30cd37d44f1b3a59bdebb3d897c4d8d0844430e75bd6f5fda1088
+  data.tar.gz: ac0a1b4b6adf8ca08457571a8f38fb2259e202c8bf5f4f2a47033495afeb5eb1439bebc9eab031d01083bdbbea9913d7fb05e97ce90e0a5e5d4948bc248434ee

data/README.md

@@ -28,6 +28,23 @@ continues to work without changes. In plain/non-TTY mode, output is ASCII-only.
 bin/ci
 ```
 
+Use `parallel_steps` when you want a parallel phase before sequential follow-up steps.
+If any step in `parallel_steps` fails, later steps are skipped and listed in the summary.
+If no `parallel_steps` block is present, all steps run in parallel (default behavior).
+
+```ruby
+CI.run do
+  parallel_steps do
+    step "Style: Ruby", "bin/standardrb"
+    step "JavaScript: lint", "npm run lint"
+    step "Security: Gem audit", "bin/bundler-audit"
+  end
+
+  step "Tests: Rails", "bin/rspec"
+  step "Tests: Seeds", "env RAILS_ENV=test bin/rails db:seed:replant"
+end
+```
+
 If your app does not already require the gem in `bin/ci`, run the installer generator:
 
 ```bash
@@ -51,16 +68,15 @@ require_relative "../config/ci"
 
 ### Options
 
+Runs all CI steps in parallel by default.
+
 ```
--f, --fail-fast   Stop immediately when a step fails
--c, --continue    Resume from the last failed step
+-f, --fail-fast   Stop immediately when a step fails (runs inline)
+-c, --continue    Resume from the last failed step (runs inline)
 -fc, -cf          Combine fail-fast and continue
--p, --parallel    Run all steps concurrently
+-i, --inline      Run steps sequentially instead of parallel
 --plain           Disable ANSI cursor updates/colors (also used for non-TTY)
 -h, --help        Show this help
-
-Compatibility:
-  --parallel cannot be combined with --fail-fast or --continue
 ```
 
 ### State file
@@ -83,8 +99,8 @@ bundle exec standardrb
 
 Or run them both:
 
-```base
-bin/ci --parallel
+```bash
+bin/ci
 ```
 
 ### Publishing Updates
@@ -96,3 +112,9 @@ bin/ci --parallel
 gem build local_ci_plus.gemspec
 gem push local_ci_plus-X.Y.Z.gem
 ```
+
+## Prior Work
+
+This  project is based off of ActiveSupport::ContinuousIntegration. 
+
+Many thanks to the Rails team for shipping the original work.

data/lib/local_ci_plus/continuous_integration.rb

@@ -4,7 +4,7 @@
 # - bin/ci -f (--fail-fast): Stop immediately when a step fails
 # - bin/ci -c (--continue): Resume from the last failed step
 # - bin/ci -fc: Both options combined
-# - bin/ci -p (--parallel): Run all steps concurrently
+# - bin/ci -i (--inline): Run steps sequentially (default is parallel)
 
 require "fileutils"
 require "tempfile"
@@ -24,7 +24,7 @@ module LocalCiPlus
     STATE_FILE = File.join("tmp", "ci_state")
     STATE_FILE_ENV = "CI_STATE_FILE"
 
-    attr_reader :results
+    attr_reader :results, :skipped_steps
 
     def self.run(title = "Continuous Integration", subtitle = "Running tests, style checks, and security audits", &block)
       new.tap do |ci|
@@ -45,17 +45,17 @@ module LocalCiPlus
       @results = []
       @step_names = []
       @parallel_steps = []
+      @using_explicit_parallel_steps = false
+      @inside_parallel_steps_block = false
+      @skip_remaining_steps = false
+      @skip_remaining_reason = nil
+      @skipped_steps = []
       @skip_until = continue_mode? ? load_failed_step : nil
       @skipping = !!@skip_until
     end
 
     def validate_mode_compatibility!
-      if parallel? && fail_fast?
-        abort colorize("#{status_marker(:error)} Cannot combine --parallel with --fail-fast", :error)
-      end
-      if parallel? && continue_mode?
-        abort colorize("#{status_marker(:error)} Cannot combine --parallel with --continue", :error)
-      end
+      # No incompatible combinations now that fail-fast/continue auto-disable parallel
     end
 
     def help?
@@ -66,16 +66,15 @@ module LocalCiPlus
       $stdout.puts <<~HELP
         Usage: bin/ci [options]
 
+        Runs all CI steps in parallel by default.
+
         Options:
-          -f, --fail-fast   Stop immediately when a step fails
-          -c, --continue    Resume from the last failed step
+          -f, --fail-fast   Stop immediately when a step fails (runs inline)
+          -c, --continue    Resume from the last failed step (runs inline)
           -fc, -cf          Combine fail-fast and continue
-          -p, --parallel    Run all steps concurrently
+          -i, --inline      Run steps sequentially instead of parallel
           --plain           Disable ANSI cursor updates/colors (also used for non-TTY)
           -h, --help        Show this help
-
-        Compatibility:
-          --parallel cannot be combined with --fail-fast or --continue
       HELP
     end
 
@@ -86,31 +85,48 @@ module LocalCiPlus
         if title == @skip_until
           @skipping = false
         else
-          heading title, "skipped (resuming from: #{@skip_until})", type: :skip
-          results << [true, title]
+          mark_step_skipped(title, "resuming from: #{@skip_until}")
           return
         end
       end
 
-      if parallel?
+      if @skip_remaining_steps
+        mark_step_skipped(title, @skip_remaining_reason || "parallel steps failed")
+        return
+      end
+
+      if queue_parallel_step?
         @parallel_steps << {title: title, command: command}
         return
       end
 
-      heading title, command.join(" "), type: :title
-      report(title) do
-        success = system(*command)
-        results << [success, title]
+      run_inline_step(title, command)
+    end
 
-        if success
-          clear_state if recorded_failed_step == title
-        else
-          record_failed_step(title)
-          if fail_fast?
-            abort colorize("\n#{status_marker(:error)} #{title} failed (fail-fast enabled)", :error)
-          end
+    def parallel_steps(&block)
+      return unless block
+
+      @using_explicit_parallel_steps = true
+
+      if parallel?
+        if @parallel_steps.any?
+          completed = run_parallel_steps!(@parallel_steps)
+          @parallel_steps.clear
+          mark_remaining_steps_skipped!("parallel_steps failed") if completed.any? { |job| !job[:success] }
         end
+
+        @inside_parallel_steps_block = true
+        queue_start = @parallel_steps.length
+        instance_eval(&block)
+        batch = @parallel_steps.slice!(queue_start, @parallel_steps.length - queue_start) || []
+        completed = run_parallel_steps!(batch)
+        mark_remaining_steps_skipped!("parallel_steps failed") if completed.any? { |job| !job[:success] }
+      else
+        @inside_parallel_steps_block = true
+        instance_eval(&block)
       end
+    ensure
+      @inside_parallel_steps_block = false
     end
 
     def success?
@@ -154,7 +170,7 @@ module LocalCiPlus
 
       elapsed = timing do
         ci.instance_eval(&block)
-        ci.run_parallel_steps! if ci.parallel? && ci.parallel_steps.any?
+        ci.run_parallel_steps!(ci.queued_parallel_steps) if ci.parallel? && ci.queued_parallel_steps.any?
       end
 
       @skip_until = ci.instance_variable_get(:@skip_until)
@@ -171,6 +187,12 @@ module LocalCiPlus
             echo "   #{failure_bullet} #{step_title} failed", type: :error
           end
         end
+
+        if ci.skipped_steps.any?
+          ci.skipped_steps.each do |step_title|
+            echo "   #{failure_bullet} #{step_title} skipped", type: :skip
+          end
+        end
       end
 
       results.concat ci.results
@@ -198,7 +220,10 @@ module LocalCiPlus
     end
 
     def parallel?
-      ARGV.include?("-p") || ARGV.include?("--parallel")
+      return false if ARGV.include?("-i") || ARGV.include?("--inline")
+      return false if fail_fast? || continue_mode?
+
+      true
     end
 
     def plain?
@@ -211,24 +236,29 @@ module LocalCiPlus
       false
     end
 
-    attr_reader :parallel_steps
+    def queued_parallel_steps
+      @parallel_steps
+    end
 
     MAX_OUTPUT_BYTES = 100 * 1024  # 100KB max per output stream
 
-    def run_parallel_steps!
-      total = @parallel_steps.size
+    def run_parallel_steps!(steps = @parallel_steps)
+      return [] if steps.empty?
+
+      total = steps.size
+      @active_parallel_size = total
       @running_jobs = []
       completed = []
       completed_by_index = {}
 
       echo "\n#{status_marker(:pending)} Running #{total} steps in parallel:", type: :subtitle
       unless plain?
-        @parallel_steps.each do |step|
+        steps.each do |step|
           echo format_parallel_line(step[:title], :pending), type: :pending
         end
       end
 
-      @parallel_steps.each_with_index do |step_info, idx|
+      steps.each_with_index do |step_info, idx|
         title = step_info[:title]
         command = step_info[:command]
 
@@ -280,7 +310,7 @@ module LocalCiPlus
       end
 
       if plain?
-        @parallel_steps.each_with_index do |step, idx|
+        steps.each_with_index do |step, idx|
           job = completed_by_index[idx]
           type = job[:success] ? :success : :error
           echo format_parallel_line(step[:title], type, duration: job[:duration]), type: type
@@ -288,7 +318,9 @@ module LocalCiPlus
       end
 
       print_parallel_summary(completed)
+      completed
     ensure
+      @active_parallel_size = nil
       cleanup_all_jobs!
     end
 
@@ -340,6 +372,42 @@ module LocalCiPlus
 
     private
 
+    def run_inline_step(title, command)
+      heading title, command.join(" "), type: :title
+      report(title) do
+        success = system(*command)
+        results << [success, title]
+
+        if success
+          clear_state if recorded_failed_step == title
+        else
+          record_failed_step(title)
+          if fail_fast?
+            abort colorize("\n#{status_marker(:error)} #{title} failed (fail-fast enabled)", :error)
+          end
+        end
+      end
+    end
+
+    def mark_step_skipped(title, reason)
+      heading title, "skipped (#{reason})", type: :skip
+      @skipped_steps << title if reason == @skip_remaining_reason
+      results << [true, title]
+    end
+
+    def queue_parallel_step?
+      return false unless parallel?
+      return true if @inside_parallel_steps_block
+      return false if @using_explicit_parallel_steps
+
+      true
+    end
+
+    def mark_remaining_steps_skipped!(reason)
+      @skip_remaining_steps = true
+      @skip_remaining_reason = reason
+    end
+
     def print_parallel_summary(completed)
       failed_jobs = completed.reject { |j| j[:success] }
       return if failed_jobs.empty?
@@ -449,7 +517,7 @@ module LocalCiPlus
         return
       end
 
-      lines_up = @parallel_steps.size - index
+      lines_up = (@active_parallel_size || @parallel_steps.size) - index
       print "\033[s"
       print "\033[#{lines_up}A" if lines_up > 0
       print "\r\033[2K"

data/lib/local_ci_plus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LocalCiPlus
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: local_ci_plus
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Scott Watermasysk