cmdx-rspec 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65acfca8209e73048a17abf0bc8c9b260904be2d222eb8d2f620c39452da0d0b
-  data.tar.gz: 64c7756f01efe07324193ca891bf4ce841361e2ce93235437b0a63ed4c74bfea
+  metadata.gz: 0616efb98c57af6ccff186eac481bf366c42feb22c3c9da20e9060c79a261ab5
+  data.tar.gz: abaf7805901a616df62e2d3825862f221981d4e9a7424ee442ddd18203e7074d
 SHA512:
-  metadata.gz: e05b1817afbfacd6d8fca1bf97b3f1b94ba9fdff4ab9acbb089655641430cc636efd9a60cdadc506d347ab58b907b7b11e3991eff22655a24b5b7c5660599d75
-  data.tar.gz: 5b37bad356a2973d7ab0030afe938a8baa2b8a86d62a769e1ecd9bc7ffa31c5aa424b24016b14cb564e4e5db48c10b7dfce58dfbc626a81666212ae3b77923aa
+  metadata.gz: 986ae1097c9f5b084f8ec3b65b9c803f3443bc77fbd21299712d8fceb1983c05e61ea7ca7619053e48fd8d6057002259fb315c1a8b16457de79d6bfd874c6c84
+  data.tar.gz: 00e76f0d58ce7b4334adccc0e39dec3b83f22b4399ffe42511f747bbc0ab87eedbb3edf0357a7e5a0438d727103b2563ea92253d92696c36d66f0c04ec866c9b

data/CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 ## [Unreleased]
 
+## [1.4.0] - 2026-04-09
+
+### Added
+- Added `stub_workflow_tasks` helper
+
+## [1.3.0] - 2025-11-09
+
+### Added
+- Added context options to unstub and unmock methods
+
 ## [1.2.0] - 2025-11-08
 
 ### Added

data/README.md

@@ -221,6 +221,28 @@ it "stubs task with a custom cause" do
 end
 ```
 
+#### Workflows
+
+Yields each distinct task class from the workflow’s pipeline (first-seen order) so you can stub them in one place.
+
+```ruby
+it "stubs every pipeline task for a workflow" do
+  stub_workflow_tasks(MyWorkflow) do |t|
+    if t == TaskB
+      stub_task_success(t)
+    elsif t == TaskC
+      stub_task_skip(t)
+    else
+      stub_task_success(t)
+    end
+  end
+
+  MyWorkflow.execute
+
+  # Your specs...
+end
+```
+
 #### Reset
 
 ```ruby
@@ -233,6 +255,16 @@ it "unstubs task executions by type" do
 
   # Your specs...
 end
+
+it "unstubs task with arguments" do
+  # eg: SomeTask.execute(some: "value")
+  unstub_task(SomeTask, some: "value")
+
+  # eg: SomeTask.execute!(some: "value")
+  unstub_task!(SomeTask, some: "value")
+
+  # Your specs...
+end
 ```
 
 ### Mocks
@@ -245,9 +277,11 @@ Helper methods for setting expectations on CMDx command execution.
 it "mocks task executions by type" do
   # eg: SomeTask.execute
   expect_task_execution(SomeTask)
+  expect_no_task_execution(SomeTask)
 
   # eg: SomeTask.execute!
   expect_task_execution!(BangCommand)
+  expect_no_task_execution!(SomeTask)
 
   # Your specs...
 end
@@ -255,19 +289,11 @@ end
 it "mocks task with arguments" do
   # eg: SomeTask.execute(some: "value")
   expect_task_execution(SomeTask, some: "value")
+  expect_no_task_execution(SomeTask, some: "value")
 
   # eg: SomeTask.execute!(some: "value")
   expect_task_execution!(SomeTask, some: "value")
-
-  # Your specs...
-end
-
-it "mocks no task executions by type" do
-  # eg: SomeTask.execute
-  expect_no_task_execution(SomeTask)
-
-  # eg: SomeTask.execute!
-  expect_no_task_execution!(SomeTask)
+  expect_no_task_execution!(SomeTask, some: "value")
 
   # Your specs...
 end

data/lib/cmdx/rspec/helpers.rb

@@ -208,29 +208,49 @@ module CMDx
       # Unstubs a command's :execute method.
       #
       # @param command [Class] The command class to unstub execution on
+      # @param context [Hash] Optional keyword arguments to match against
       #
       # @return [void]
       #
-      # @example Unstubbing execute
+      # @example Unstubbing execute with context
+      #   unstub_task(MyCommand, foo: "bar")
+      #
+      #   MyCommand.execute(foo: "bar")
+      #
+      # @example Unstubbing execute without context
       #   unstub_task(MyCommand)
       #
       #   MyCommand.execute
-      def unstub_task(command)
-        allow(command).to receive(:execute).and_call_original
+      def unstub_task(command, **context)
+        if context.empty?
+          allow(command).to receive(:execute).and_call_original
+        else
+          allow(command).to receive(:execute).with(**context).and_call_original
+        end
       end
 
       # Unstubs a command's :execute! method.
       #
       # @param command [Class] The command class to unstub execution on
+      # @param context [Hash] Optional keyword arguments to match against
       #
       # @return [void]
       #
       # @example Unstubbing execute!
+      #   unstub_task!(MyCommand, foo: "bar")
+      #
+      #   MyCommand.execute!(foo: "bar")
+      #
+      # @example Unstubbing execute! without context
       #   unstub_task!(MyCommand)
       #
       #   MyCommand.execute!
-      def unstub_task!(command)
-        allow(command).to receive(:execute!).and_call_original
+      def unstub_task!(command, **context)
+        if context.empty?
+          allow(command).to receive(:execute!).and_call_original
+        else
+          allow(command).to receive(:execute!).with(**context).and_call_original
+        end
       end
 
       # Sets up an expectation that a command will receive :execute with the given context.
@@ -284,29 +304,79 @@ module CMDx
       # Sets up an expectation that a command will not receive :execute.
       #
       # @param command [Class] The command class to expect execution on
+      # @param context [Hash] Optional keyword arguments to match against
       #
       # @return [RSpec::Mocks::MessageExpectation] The RSpec expectation object
       #
-      # @example Expecting no execution
+      # @example Expecting no execution with context
+      #   expect_no_task_execution(MyCommand, foo: "bar")
+      #
+      #   MyCommand.execute(foo: "bar")
+      #
+      # @example Expecting no execution with empty context
       #   expect_no_task_execution(MyCommand)
       #
       #   MyCommand.execute
-      def expect_no_task_execution(command)
-        expect(command).not_to receive(:execute)
+      def expect_no_task_execution(command, **context)
+        if context.empty?
+          expect(command).not_to receive(:execute)
+        else
+          expect(command).not_to receive(:execute).with(**context)
+        end
       end
 
       # Sets up an expectation that a command will not receive :execute!.
       #
       # @param command [Class] The command class to expect execution on
+      # @param context [Hash] Optional keyword arguments to match against
       #
       # @return [RSpec::Mocks::MessageExpectation] The RSpec expectation object
       #
-      # @example Expecting no execution!
+      # @example Expecting no execution! with context
+      #   expect_no_task_execution!(MyCommand, foo: "bar")
+      #
+      #   MyCommand.execute!(foo: "bar")
+      #
+      # @example Expecting no execution! with empty context
       #   expect_no_task_execution!(MyCommand)
       #
       #   MyCommand.execute!
-      def expect_no_task_execution!(command)
-        expect(command).not_to receive(:execute!)
+      def expect_no_task_execution!(command, **context)
+        if context.empty?
+          expect(command).not_to receive(:execute!)
+        else
+          expect(command).not_to receive(:execute!).with(**context)
+        end
+      end
+
+      # Yields each unique pipeline task class so workflow specs can stub tasks in one place.
+      #
+      # @param command [Class] Class including {CMDx::Workflow}
+      # @yield [Class] Distinct task class per pipeline stage (first-seen order)
+      # @return [Array<Class>] Deduplicated task list ({#each} return value)
+      # @raise [ArgumentError] if no block is given
+      # @raise [ArgumentError] if +command+ does not include {CMDx::Workflow}
+      #
+      # @example
+      #   stub_workflow_tasks(MyWorkflow) do |t|
+      #     if t == TaskB
+      #       stub_task_success(t)
+      #     elsif t == TaskC
+      #       stub_task_skip(t)
+      #     else
+      #       stub_task_success(t)
+      #     end
+      #   end
+      #
+      #   MyWorkflow.execute
+      def stub_workflow_tasks(command, &)
+        if !block_given?
+          raise ArgumentError, "block required"
+        elsif !command.include?(Workflow)
+          raise ArgumentError, "#{command.inspect} must be a workflow"
+        end
+
+        command.pipeline.flat_map(&:tasks).uniq.each(&)
       end
 
     end

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

@@ -58,7 +58,7 @@ RSpec::Matchers.define :be_deprecated do |expected_behavior = nil|
     target = actual.is_a?(Class) ? actual : actual.class
 
     # Check if deprecate setting exists and is truthy
-    deprecate_setting = target.settings[:deprecate]
+    deprecate_setting = target.settings.deprecate
     return false unless deprecate_setting
 
     # If no specific behavior expected, just check if deprecated

data/lib/cmdx/rspec/version.rb

@@ -3,7 +3,7 @@
 module CMDx
   module RSpec
 
-    VERSION = "1.2.0"
+    VERSION = "1.4.0"
 
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmdx-rspec
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Juan Gomez
@@ -128,13 +128,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".cursor/prompts/docs.md"
-- ".cursor/prompts/llms.md"
-- ".cursor/prompts/rspec.md"
-- ".cursor/prompts/yardoc.md"
-- ".cursor/rules/cursor-instructions.mdc"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -151,9 +144,6 @@ files:
 - lib/cmdx/rspec/matchers/have_matching_metadata.rb
 - lib/cmdx/rspec/matchers/have_skipped.rb
 - lib/cmdx/rspec/version.rb
-- src/cmdx-dark-logo.png
-- src/cmdx-light-logo.png
-- src/cmdx-logo.svg
 homepage: https://github.com/drexed/cmdx-rspec
 licenses:
 - MIT
@@ -178,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Simple CMDx task testing via RSpec matchers.
 test_files: []

data/.cursor/prompts/docs.md

@@ -1,12 +0,0 @@
-You are a senior Ruby developer with expert knowledge of CMDx and writing documentation.
-
-Update the active tab using the following guidelines:
-
-- Follow best practices and implementation
-- Use a consistent professional voice
-- Examples should be concise, non-repetitive, and realistic
-- Update any pre-existing documentation to match stated rules
-- Examples should not cross boundaries or focus
-- Docs must cover both typical use cases, including invalid inputs and error conditions
-- Use GitHub flavored markdown, including alerts to emphasize critical information (https://github.com/orgs/community/discussions/16925)
-- Optimize for LLM's including coding and AI agents

data/.cursor/prompts/llms.md

@@ -1,20 +0,0 @@
-Process the following instructions in the order given:
-
-1. Create an `LLM.md` file
-2. Append all files within `docs/**/*.md` into @LLM.md
-  2a. Use order outlined in the table of contents of @README.md
-  2b. Process one file at a time faster performance and improved accuracy
-  2c. Remove the table of contents from the chunk
-  2c. Remove the navigations below `---` from the chunk
-  2d. Wrap the chunk the files GitHub url the top and a spacer at the bottom like so:
-      ```
-
-      ---
-      url: https://github.com/drexed/cmdx/blob/main/docs/callbacks.md
-      ---
-
-      {{ chunk }}
-
-      ---
-
-      ```

data/.cursor/prompts/rspec.md

@@ -1,24 +0,0 @@
-You are a senior Ruby developer with expert knowledge of RSpec.
-
-Add tests for the active tab using the following guidelines:
-
-- Expectations should be concise, non-repetitive, and realistic (how it would be used in the real world)
-- Follow best practices and implementation
-- Update any pre-existing specs to match stated rules
-- New tests should be consistent with current `spec/cmdx` specs
-- Use custom matchers available within `lib/cmdx/rspec`
-- Use task helpers available within `spec/support/helpers`
-- Use stubs to return predefined values for specific methods. Isolate the unit being tested, but avoid over-mocking; test real behavior when possible (mocks should be used only when necessary)
-- Ensure each test is independent; avoid shared state between tests
-- Use let and let! to define test data, ensuring minimal and necessary setup
-- Context block descriptions should start with the following words: `when`, `with`, `without`
-- Organize tests logically using describe for classes/modules and context for different scenarios
-- Use subject to define the object under test when appropriate to avoid repetition
-- Ensure test file paths mirror the structure of the files being tested, but within the spec directory (e.g., lib/cmdx/task.rb → spec/cmdx/task_spec.rb)
-- Use clear and descriptive names for describe, context, and it blocks
-- Prefer the expect syntax for assertions to improve readability
-- Keep test code concise; avoid unnecessary complexity or duplication
-- Tests must cover both typical cases and edge cases, including invalid inputs and error conditions
-- Consider all possible scenarios for each method or behavior and ensure they are tested
-- Do NOT include integration or real world examples
-- Verify all specs are passing

data/.cursor/prompts/yardoc.md

@@ -1,14 +0,0 @@
-You are a senior Ruby developer with expert knowledge of YARDoc.
-
-Add yardoc to the active tab using the following guidelines:
-
-- Follow best practices and implementation
-- New documentation should be consistent with current `lib/cmdx` documentation
-- Examples should be concise, non-repetitive, and realistic
-- Avoid unnecessary complexity or duplication
-- Update any pre-existing documentation to match stated rules
-- Do NOT include `CMDx` module level docs
-- Module level docs description should NOT include `@example`
-- Method level docs should include `@example`, `param`, `@options`, `@return`, and any `@raise`
-- Hash `@params` should expand with possible `@option`
-- Module and method level docs should NOT include `@since`

data/.cursor/rules/cursor-instructions.mdc

@@ -1,62 +0,0 @@
----
-description:
-globs:
-alwaysApply: true
----
-
-# Ruby Coding Standards
-
-Follow the official Ruby gem guides for best practices.
-Reference the guides outlined in https://guides.rubygems.org
-
-## Project Context
-CMDx::RSpec is a collection of RSpec matchers for the CMDx framework.
-Reference the CMDx documentation in https://drexed.github.io/cmdx/llms.txt
-Reference the CMDx::RSpec documentation in https://github.com/drexed/cmdx-rspec/blob/main/README.md
-
-## Technology Stack
-- Ruby 3.4+
-- RSpec 3.1+
-- CMDx 1.5+
-
-## Code Style and Structure
-- Write concise, idiomatic Ruby code with accurate examples
-- Follow Ruby conventions and best practices
-- Use object-oriented and functional programming patterns as appropriate
-- Prefer iteration and modularization over code duplication
-- Use descriptive variable and method names (e.g., user_signed_in?, calculate_total)
-- Write comprehensive code documentation using the Yardoc format
-
-## Naming Conventions
-- Use snake_case for file names, method names, and variables
-- Use CamelCase for class and module names
-
-## Syntax and Formatting
-- Follow the Ruby Style Guide (https://rubystyle.guide/)
-- Follow Ruby style conventions (2-space indentation, snake_case methods)
-- Use Ruby's expressive syntax (e.g., unless, ||=, &.)
-- Prefer double quotes for strings
-- Respect my Rubocop options
-
-## Performance Optimization
-- Use memoization for expensive operations
-
-## Testing
-- Follow the RSpec Style Guide (https://rspec.rubystyle.guide/)
-- Write comprehensive tests using RSpec
-- It's ok to put multiple assertions in the same example
-- Include both BDD and TDD based tests
-- Create test objects to share across tests
-- Do NOT make tests for obvious or reflective expectations
-- Prefer real objects over mocks. Use `instance_double` if necessary; never `double`
-- Don't test declarative configuration
-- Use appropriate matchers
-- Update tests and update Yardocs after you write code
-
-## Documentation
-- Utilize the YARDoc format when documenting Ruby code
-- Follow these best practices:
-  - Avoid redundant comments that merely restate the code
-  - Keep comments up-to-date with code changes
-  - Keep documentation consistent
-- Update CHANGELOG.md with any changes

data/.rspec

@@ -1,4 +0,0 @@
---backtrace
---color
---format progress
---order random

data/.rubocop.yml

@@ -1,64 +0,0 @@
-plugins:
-  - rubocop-performance
-  - rubocop-rake
-  - rubocop-rspec
-AllCops:
-  NewCops: enable
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  TargetRubyVersion: 3.1
-Gemspec/DevelopmentDependencies:
-  EnforcedStyle: gemspec
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-Layout/EmptyLinesAroundClassBody:
-  EnforcedStyle: empty_lines_except_namespace
-Layout/EmptyLinesAroundModuleBody:
-  EnforcedStyle: empty_lines_except_namespace
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-Layout/LineLength:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
-Metrics/PerceivedComplexity:
-  Enabled: false
-RSpec/DescribeClass:
-  Enabled: false
-RSpec/ExampleLength:
-  Enabled: false
-RSpec/IndexedLet:
-  Enabled: false
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-RSpec/MultipleExpectations:
-  Enabled: false
-RSpec/MultipleMemoizedHelpers:
-  Enabled: false
-RSpec/NestedGroups:
-  Enabled: false
-RSpec/SpecFilePathFormat:
-  CustomTransform:
-    CMDx: cmdx
-RSpec/SubjectStub:
-  Enabled: false
-RSpec/StubbedMock:
-  Enabled: false
-RSpec/VerifiedDoubleReference:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: true
-  EnforcedStyle: always_true
-  SafeAutoCorrect: true
-Style/ModuleFunction:
-  EnforcedStyle: extend_self
-Style/StringLiterals:
-  EnforcedStyle: double_quotes

data/src/cmdx-logo.svg

@@ -1 +0,0 @@
-<svg width="352.2" height="112.266" viewBox="0 0 203 64.708" xmlns="http://www.w3.org/2000/svg" xmlSpace="preserve"><path d="M172.908 17.723 169.4 23.17 156.385 3.323h3.507l9.508 14.77 1.938-3.139L161.738 0h-11.446L169.4 29.262 188.046 0h-3.97L173 17.54zm-20.677 43.57h-3.139l18.646-29.447L147.431.093h-3.97l20.308 31.846L143 64.708l10.985-.092 39.138-61.2h3.323L174.57 37.754l13.662 21.415h3.969l-13.754-21.415L202.538.093H191.37zm29.63-23.262 15.047 23.262h-10.523l-13.662-20.77-15.508 24.093h3.97l11.63-18 11.723 18H203l-18.83-29.262-.278-.461z" fill="#fe1817"/><path d="M41.667 14v12.8h-23.42c-3.214.272-5.665 3.05-5.665 6.318s2.45 5.937 5.664 6.318H33.17v4.248H18.246a10.65 10.65 0 0 1-9.858-10.62c0-5.447 4.194-10.077 9.64-10.512h19.39v-4.303H18.246v.054A14.823 14.823 0 0 0 4.248 33.118c0 7.898 6.21 14.38 13.998 14.815h19.172v-8.497h4.249v12.745h-23.42A19.063 19.063 0 0 1 0 33.118a19.033 19.033 0 0 1 18.246-19.063zM75 35.623 87.2 14h13.508v38.181H87.963v-14.27l-8.116 14.27h-9.749L57.734 30.504v-8.007l14.87 25.436h4.792l14.815-25.436v25.436h4.249V18.249H89.65l-14.76 25.49-14.542-25.49H53.54v29.684h4.194v-8.007l4.249 7.299v4.956H49.292v-38.18H62.8zM108.333 14h23.42C141.94 14.436 150 22.824 150 33.064c0 10.294-8.061 18.681-18.246 19.117h-23.42V22.497h23.42a10.65 10.65 0 0 1 9.858 10.621c0 5.447-4.194 10.13-9.64 10.566H116.83V30.286h4.248v9.15l10.676-.054c3.213-.273 5.664-3.05 5.664-6.264 0-2.778-1.743-5.065-4.194-5.991-.926-.382-1.47-.382-2.94-.382h-17.702v21.188h19.172a14.84 14.84 0 0 0 13.998-14.87c0-7.897-6.21-14.379-13.998-14.814h-23.42z"/></svg>