cmdx-rspec 1.4.0 → 2.1.0

data/lib/cmdx/rspec/matchers/have_middleware.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Matcher to verify that a task class registered +middleware+. When given
+# a class, matches by `is_a?`; otherwise by `==` (works for module-level
+# callables like `MyMiddleware` referenced by name).
+#
+# @example
+#   expect(MyCommand).to have_middleware(LoggingMiddleware)
+RSpec::Matchers.define :have_middleware do |middleware|
+  description { "have middleware #{middleware.inspect}" }
+
+  failure_message do |actual|
+    target = actual.is_a?(Class) ? actual : actual.class
+    "expected #{target} to register middleware #{middleware.inspect}, but had #{target.middlewares.registry.inspect}"
+  end
+
+  match do |actual|
+    target = actual.is_a?(Class) ? actual : actual.class
+    next false unless target.respond_to?(:middlewares)
+
+    target.middlewares.registry.any? do |entry|
+      m, = entry
+      case middleware
+      when Class then m.is_a?(middleware) || m == middleware
+      else m == middleware
+      end
+    end
+  end
+end

data/lib/cmdx/rspec/matchers/have_no_errors.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Matcher to verify that a {CMDx::Result}, task instance, or {CMDx::Errors}
+# is free of errors.
+#
+# @example
+#   expect(result).to have_no_errors
+RSpec::Matchers.define :have_no_errors do
+  description { "have no errors" }
+
+  failure_message do |actual|
+    errors = extract_errors(actual)
+    "expected #{actual.inspect} to have no errors, but had #{errors&.to_h.inspect}"
+  end
+
+  match do |actual|
+    errors = extract_errors(actual)
+    next false if errors.nil?
+
+    errors.empty?
+  end
+
+  define_method(:extract_errors) do |actual|
+    case actual
+    when CMDx::Errors then actual
+    when CMDx::Result, CMDx::Task then actual.errors
+    else actual.respond_to?(:errors) ? actual.errors : nil
+    end
+  end
+end

data/lib/cmdx/rspec/matchers/have_output.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Matcher to verify that a task class declares an output named +name+.
+# Optional keyword arguments are matched against the output's serialized
+# {CMDx::Output#to_h} (partial match — only provided keys are checked).
+#
+# @example Existence check
+#   expect(MyCommand).to have_output(:total)
+#
+# @example Required output
+#   expect(MyCommand).to have_output(:total, required: true)
+RSpec::Matchers.define :have_output do |name, **expected|
+  description do
+    expected.empty? ? "have output #{name.inspect}" : "have output #{name.inspect} matching #{expected.inspect}"
+  end
+
+  failure_message do |actual|
+    target = actual.is_a?(Class) ? actual : actual.class
+    output = target.outputs.registry[name.to_sym]
+    if output.nil?
+      "expected #{target} to declare output #{name.inspect}, but registry has #{target.outputs.registry.keys.inspect}"
+    else
+      "expected #{target}'s output #{name.inspect} to match #{expected.inspect}, but it was #{output.to_h.inspect}"
+    end
+  end
+
+  match do |actual|
+    target = actual.is_a?(Class) ? actual : actual.class
+    next false unless target.respond_to?(:outputs)
+
+    output = target.outputs.registry[name.to_sym]
+    next false if output.nil?
+    next true if expected.empty?
+
+    expected.all? do |k, v|
+      actual =
+        case k
+        when :name then output.name
+        when :description then output.description
+        else output.to_h.fetch(:options, {})[k]
+        end
+      actual = false if k == :required && actual.nil?
+      values_match?(v, actual)
+    end
+  end
+end

data/lib/cmdx/rspec/matchers/have_pipeline_tasks.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Matcher to verify that a {CMDx::Workflow} class declares the given
+# pipeline tasks. Compares the flattened, deduplicated pipeline against
+# the expected task classes (order-sensitive).
+#
+# @example
+#   expect(MyWorkflow).to have_pipeline_tasks(StepA, StepB, StepC)
+#
+# @example Order-insensitive variant
+#   expect(MyWorkflow).to have_pipeline_tasks(StepA, StepC, StepB).in_any_order
+RSpec::Matchers.define :have_pipeline_tasks do |*expected|
+  description { "have pipeline tasks #{expected.inspect}" }
+
+  failure_message do |actual|
+    "expected #{actual} pipeline to be #{expected.inspect}, but was #{actual.pipeline.flat_map(&:tasks).uniq.inspect}"
+  end
+
+  match do |actual|
+    raise ArgumentError, "must be a CMDx::Workflow" unless actual.is_a?(Class) && actual.include?(CMDx::Workflow)
+
+    tasks = actual.pipeline.flat_map(&:tasks).uniq
+    @any_order ? tasks.sort_by(&:object_id) == expected.sort_by(&:object_id) : tasks == expected
+  end
+
+  chain(:in_any_order) { @any_order = true }
+end

data/lib/cmdx/rspec/matchers/have_retry_on.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Matcher to verify that a task class is configured to retry on +exception+.
+# Optional keyword arguments check the {CMDx::Retry} configuration values
+# (`:limit`, `:delay`, `:max_delay`, `:jitter`).
+#
+# @example
+#   expect(MyCommand).to have_retry_on(Net::OpenTimeout)
+#   expect(MyCommand).to have_retry_on(Net::OpenTimeout, limit: 5, jitter: :exponential)
+RSpec::Matchers.define :have_retry_on do |exception, **expected|
+  description do
+    expected.empty? ? "have retry on #{exception}" : "have retry on #{exception} matching #{expected.inspect}"
+  end
+
+  failure_message do |actual|
+    target = actual.is_a?(Class) ? actual : actual.class
+    retry_cfg = target.retry_on
+    if retry_cfg.exceptions.none?(exception)
+      "expected #{target} to retry on #{exception}, but only retries on #{retry_cfg.exceptions.inspect}"
+    else
+      mismatched = expected.reject { |k, v| retry_cfg.public_send(k) == v }
+      "expected #{target}'s retry_on to match #{expected.inspect}, but mismatched: #{mismatched.inspect}"
+    end
+  end
+
+  match do |actual|
+    target = actual.is_a?(Class) ? actual : actual.class
+    next false unless target.respond_to?(:retry_on)
+
+    retry_cfg = target.retry_on
+    next false unless retry_cfg.exceptions.include?(exception)
+    next true if expected.empty?
+
+    expected.all? { |k, v| retry_cfg.public_send(k) == v }
+  end
+end

data/lib/cmdx/rspec/matchers/have_skipped.rb

@@ -1,25 +1,11 @@
 # frozen_string_literal: true
 
-# Matcher to verify that a result represents a skipped execution.
+# Asserts a {CMDx::Result} was skipped (`state: interrupted`,
+# `status: skipped`). Extra keyword args constrain other `result.to_h`
+# fields such as `:reason`, `:cause`, or `:metadata`.
 #
-# @param data [Hash] Optional hash of additional attributes to match
-#   @option data [Symbol] :state Expected state (defaults to CMDx::Result::INTERRUPTED)
-#   @option data [Symbol] :status Expected status (defaults to CMDx::Result::SKIPPED)
-#   @option data [Symbol] :outcome Expected outcome (defaults to CMDx::Result::SKIPPED)
-#   @option data [String] :reason Expected reason string
-#   @option data [CMDx::SkipFault] :cause Expected cause fault
-#
-# @return [RSpec::Matchers::BuiltIn::BaseMatcher] The matcher instance
-#
-# @raise [ArgumentError] if the actual value is not a CMDx::Result
-#
-# @example Checking if a result is skipped
-#   result = MyCommand.execute
-#   expect(result).to have_skipped
-#
-# @example Checking skipped with specific reason
-#   result = MyCommand.execute
-#   expect(result).to have_skipped(reason: "Skipped for testing")
+# @example
+#   expect(result).to have_skipped(reason: "out of stock")
 RSpec::Matchers.define :have_skipped do |**data|
   description { "have been skipped" }
 
@@ -27,11 +13,8 @@ RSpec::Matchers.define :have_skipped do |**data|
     raise ArgumentError, "must be a CMDx::Result" unless result.is_a?(CMDx::Result)
 
     expect(result.to_h).to include(
-      state: CMDx::Result::INTERRUPTED,
-      status: CMDx::Result::SKIPPED,
-      outcome: CMDx::Result::SKIPPED,
-      reason: CMDx::Locale.t("cmdx.faults.unspecified"),
-      cause: be_a(CMDx::SkipFault),
+      state: CMDx::Signal::INTERRUPTED,
+      status: CMDx::Signal::SKIPPED,
       **data
     )
   end

data/lib/cmdx/rspec/matchers/have_tag.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Matcher to verify that a {CMDx::Result} (or task class) carries +tag+
+# in its settings tags.
+#
+# @example
+#   expect(result).to have_tag(:critical)
+#   expect(MyCommand).to have_tag(:critical)
+RSpec::Matchers.define :have_tag do |tag|
+  description { "have tag #{tag.inspect}" }
+
+  failure_message do |actual|
+    tags = extract_tags(actual)
+    "expected #{actual} to have tag #{tag.inspect}, but had #{tags.inspect}"
+  end
+
+  match do |actual|
+    extract_tags(actual).include?(tag)
+  end
+
+  define_method(:extract_tags) do |actual|
+    case actual
+    when CMDx::Result then actual.tags
+    when Class
+      actual.respond_to?(:settings) ? actual.settings.tags : []
+    else
+      actual.respond_to?(:tags) ? actual.tags : []
+    end
+  end
+end

data/lib/cmdx/rspec/matchers/raise_cmdx_fault.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Matcher to verify that a block raises a {CMDx::Fault}, optionally
+# constraining which task originated the failure, the failure reason, and
+# the underlying cause.
+#
+# @example Any CMDx fault
+#   expect { MyCommand.execute! }.to raise_cmdx_fault
+#
+# @example From a specific task class (matches `fault.task`, the leaf failure)
+#   expect { MyCommand.execute! }.to raise_cmdx_fault(MyCommand)
+#
+# @example With a specific reason
+#   expect { MyCommand.execute! }.to raise_cmdx_fault.with_reason("invalid")
+#
+# @example With a regex reason and a specific underlying cause
+#   expect { MyCommand.execute! }
+#     .to raise_cmdx_fault(MyCommand).with_reason(/invalid/).with_cause(MyError)
+RSpec::Matchers.define :raise_cmdx_fault do |expected_task = nil|
+  description do
+    parts = ["raise CMDx::Fault"]
+    parts << "from #{expected_task}" if expected_task
+    parts << "with reason #{@expected_reason.inspect}" if defined?(@expected_reason)
+    parts << "with cause #{@expected_cause.inspect}" if defined?(@expected_cause)
+    parts.join(" ")
+  end
+
+  supports_block_expectations
+
+  match do |block|
+    raise ArgumentError, "block required" unless block.respond_to?(:call)
+
+    @actual_fault = nil
+    begin
+      block.call
+    rescue CMDx::Fault => e
+      @actual_fault = e
+    end
+
+    next false if @actual_fault.nil?
+    next false if expected_task && !(@actual_fault.task <= expected_task) # rubocop:disable Style/InverseMethods
+    next false if defined?(@expected_reason) && !reason_matches?(@actual_fault.result.reason)
+    next false if defined?(@expected_cause) && !cause_matches?(@actual_fault.result.cause)
+
+    true
+  end
+
+  failure_message do
+    if @actual_fault.nil?
+      "expected block to raise CMDx::Fault, but nothing was raised"
+    else
+      "expected #{@actual_fault.inspect} (task: #{@actual_fault.task}, reason: " \
+        "#{@actual_fault.result.reason.inspect}, cause: #{@actual_fault.result.cause.inspect}) " \
+        "to satisfy the matcher"
+    end
+  end
+
+  chain(:with_reason) { |reason| @expected_reason = reason }
+  chain(:with_cause)  { |cause|  @expected_cause  = cause }
+
+  define_method(:reason_matches?) do |actual|
+    case @expected_reason
+    when Regexp then @expected_reason.match?(actual.to_s)
+    else @expected_reason == actual
+    end
+  end
+
+  define_method(:cause_matches?) do |actual|
+    case @expected_cause
+    when Class then actual.is_a?(@expected_cause)
+    else values_match?(@expected_cause, actual)
+    end
+  end
+end

data/lib/cmdx/rspec/version.rb

@@ -3,7 +3,8 @@
 module CMDx
   module RSpec
 
-    VERSION = "1.4.0"
+    # Gem version. Bumped on release; mirrored in the gemspec.
+    VERSION = "2.1.0"
 
   end
 end

data/lib/cmdx/rspec.rb

@@ -5,11 +5,30 @@ require "rspec"
 
 require_relative "rspec/helpers"
 
+require_relative "rspec/matchers/be_complete"
 require_relative "rspec/matchers/be_deprecated"
+require_relative "rspec/matchers/be_interrupted"
+require_relative "rspec/matchers/be_ko"
+require_relative "rspec/matchers/be_ok"
 require_relative "rspec/matchers/be_successful"
-require_relative "rspec/matchers/have_skipped"
-require_relative "rspec/matchers/have_failed"
+require_relative "rspec/matchers/have_been_retried"
+require_relative "rspec/matchers/have_been_rolled_back"
+require_relative "rspec/matchers/have_callback"
+require_relative "rspec/matchers/have_chain_root"
+require_relative "rspec/matchers/have_chain_size"
+require_relative "rspec/matchers/have_duration"
 require_relative "rspec/matchers/have_empty_context"
-require_relative "rspec/matchers/have_matching_context"
 require_relative "rspec/matchers/have_empty_metadata"
+require_relative "rspec/matchers/have_errors_on"
+require_relative "rspec/matchers/have_failed"
+require_relative "rspec/matchers/have_input"
+require_relative "rspec/matchers/have_matching_context"
 require_relative "rspec/matchers/have_matching_metadata"
+require_relative "rspec/matchers/have_middleware"
+require_relative "rspec/matchers/have_no_errors"
+require_relative "rspec/matchers/have_output"
+require_relative "rspec/matchers/have_pipeline_tasks"
+require_relative "rspec/matchers/have_retry_on"
+require_relative "rspec/matchers/have_skipped"
+require_relative "rspec/matchers/have_tag"
+require_relative "rspec/matchers/raise_cmdx_fault"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmdx-rspec
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Juan Gomez
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +128,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -135,14 +136,33 @@ files:
 - Rakefile
 - lib/cmdx/rspec.rb
 - lib/cmdx/rspec/helpers.rb
+- lib/cmdx/rspec/matchers/be_complete.rb
 - lib/cmdx/rspec/matchers/be_deprecated.rb
+- lib/cmdx/rspec/matchers/be_interrupted.rb
+- lib/cmdx/rspec/matchers/be_ko.rb
+- lib/cmdx/rspec/matchers/be_ok.rb
 - lib/cmdx/rspec/matchers/be_successful.rb
+- lib/cmdx/rspec/matchers/have_been_retried.rb
+- lib/cmdx/rspec/matchers/have_been_rolled_back.rb
+- lib/cmdx/rspec/matchers/have_callback.rb
+- lib/cmdx/rspec/matchers/have_chain_root.rb
+- lib/cmdx/rspec/matchers/have_chain_size.rb
+- lib/cmdx/rspec/matchers/have_duration.rb
 - lib/cmdx/rspec/matchers/have_empty_context.rb
 - lib/cmdx/rspec/matchers/have_empty_metadata.rb
+- lib/cmdx/rspec/matchers/have_errors_on.rb
 - lib/cmdx/rspec/matchers/have_failed.rb
+- lib/cmdx/rspec/matchers/have_input.rb
 - lib/cmdx/rspec/matchers/have_matching_context.rb
 - lib/cmdx/rspec/matchers/have_matching_metadata.rb
+- lib/cmdx/rspec/matchers/have_middleware.rb
+- lib/cmdx/rspec/matchers/have_no_errors.rb
+- lib/cmdx/rspec/matchers/have_output.rb
+- lib/cmdx/rspec/matchers/have_pipeline_tasks.rb
+- lib/cmdx/rspec/matchers/have_retry_on.rb
 - lib/cmdx/rspec/matchers/have_skipped.rb
+- lib/cmdx/rspec/matchers/have_tag.rb
+- lib/cmdx/rspec/matchers/raise_cmdx_fault.rb
 - lib/cmdx/rspec/version.rb
 homepage: https://github.com/drexed/cmdx-rspec
 licenses:
@@ -161,14 +181,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Simple CMDx task testing via RSpec matchers.
 test_files: []