cmdx 1.1.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dda80e40c4516ca1578dc67755ad2a5d97f55c3ce1137d80e2cee11460ab145
-  data.tar.gz: a42b255005f0d6fd52053948b9ba7839af23ddcffea51bd2382400e02c820b8a
+  metadata.gz: de49105a37f479ac8172f6329536b45a976adbb4e09c43b9351e329dbf662760
+  data.tar.gz: 7b100f2619d36ae0ac287c108bbab114168d87528beb1751951ac1282dbc37d3
 SHA512:
-  metadata.gz: c5510e7d51eb74f5c4250ccfa6f84bf299b9cea0c5caa38f68c269381be0feb8914eb325307002e7f2d96cbc3677a442206a09ad69f81acb36248f6f5aa684d3
-  data.tar.gz: 1f0073fbbfd2c578a3ea070fea968e1cbe92b152c1c7d9ffd2cd89729a4e5a017c12b1ce581bf3f61b37b426dc884ffb403f1247969ff7a766e75cf0799b483f
+  metadata.gz: becbfc6dcc4657b16697559c91bac79a2416610655f2831cef74745d30720ac6e0f64991b442229384c8c98259f3b9dc0df706b60c988c01462a8a02eb8ee097
+  data.tar.gz: e0dc0122625d710048768d0a31b39a1081ef800206e331f7e842b483c4639108177dbe83a6e1b47cbd08328ddfc5899e5d5b682ce65ec90287035b8e17a7d8f3

data/.cursor/prompts/docs.md

@@ -1,4 +1,6 @@
-Update the file in context using the following guidelines:
+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
@@ -7,3 +9,4 @@ Update the file in context using the following guidelines:
 - 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

@@ -0,0 +1,20 @@
+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,4 +1,6 @@
-Add tests for the file in context using the following guidelines:
+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
@@ -18,4 +20,5 @@ Add tests for the file in context using the following guidelines:
 - 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,10 +1,11 @@
-Add yardoc to the file in context using the following guidelines:
+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
-- Consider all possible scenarios for each method or behavior and ensure they are tested.
 - Update any pre-existing documentation to match stated rules
 - Do NOT include `CMDx` module level docs
 - Module level docs description should NOT include `@example`

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

@@ -3,4 +3,59 @@ description:
 globs:
 alwaysApply: true
 ---
-Use instructions found in [copilot-instructions.md](mdc:.github/copilot-instructions.md)
+
+# Ruby Coding Standards
+
+Follow the official Ruby gem guides for best practices.
+Reference the guides outlined in https://guides.rubygems.org
+
+## Project Context
+CMDx provides a framework for designing and executing complex
+business logic within service/command objects.
+
+## Technology Stack
+- Ruby 3.4+
+- RSpec 3.1+
+
+## 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/.irbrc

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "pp"
+
+# To reload the gem, you must exit and restart the IRB session
+require_relative "lib/cmdx" unless defined?(CMDx)

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
   NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
+  TargetRubyVersion: 3.1
 Gemspec/DevelopmentDependencies:
   EnforcedStyle: gemspec
 Layout/EmptyLinesAroundAttributeAccessor:
@@ -14,22 +15,25 @@ Layout/EmptyLinesAroundClassBody:
   EnforcedStyle: empty_lines_except_namespace
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
-Layout/ExtraSpacing:
-  Exclude:
-    - 'lib/generators/cmdx/templates/install.rb'
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
 Layout/LineLength:
   Enabled: false
 Lint/MissingSuper:
   Exclude:
-    - 'lib/cmdx/middlewares/**/*'
     - 'spec/**/**/*'
+Lint/ShadowedException:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/cmdx/coercions/**/*'
+    - 'lib/cmdx/log_formatters/**/*'
+    - 'lib/cmdx/middlewares/**/*'
+    - 'lib/cmdx/validators/**/*'
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:
-  Exclude:
-    - 'lib/cmdx/rspec/**/*'
-    - 'spec/**/**/*'
-    - '*.gemspec'
+  Enabled: false
 Metrics/ClassLength:
   Enabled: false
 Metrics/CyclomaticComplexity:
@@ -42,43 +46,50 @@ Metrics/PerceivedComplexity:
   Enabled: false
 Naming/MethodParameterName:
   Enabled: false
-RSpec/AnyInstance:
-  Enabled: false
 RSpec/DescribeClass:
   Exclude:
     - 'spec/integrations/**/*'
 RSpec/ExampleLength:
   Enabled: false
+RSpec/IndexedLet:
+  Enabled: false
 RSpec/MessageSpies:
+  EnforcedStyle: receive
+RSpec/MultipleExpectations:
   Enabled: false
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
-RSpec/MultipleExpectations:
-  Enabled: false
 RSpec/NestedGroups:
   Enabled: false
 RSpec/SpecFilePathFormat:
   CustomTransform:
     CMDx: cmdx
-RSpec/StubbedMock:
-  Enabled: false
 RSpec/SubjectStub:
   Enabled: false
-RSpec/VerifiedDoubles:
+RSpec/StubbedMock:
   Enabled: false
 RSpec/VerifiedDoubleReference:
   Enabled: false
+Style/ArgumentsForwarding:
+  Exclude:
+    - 'lib/cmdx/utils/call.rb'
+Style/CaseEquality:
+  Enabled: false
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
 Style/Documentation:
   Enabled: false
-Style/FormatStringToken:
+Style/DoubleNegation:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: true
   EnforcedStyle: always_true
   SafeAutoCorrect: true
-Style/OpenStructUse:
-  Enabled: false
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
 Style/OptionalBooleanParameter:
   Enabled: false
+Style/StringConcatenation:
+  Enabled: false
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -2,147 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [TODO]
 
-- Rebuild parameters to use a less magical approach
-- Revert deprecator to use old options
-- Validators to add errors directly instead of raising errors
-- Coercions to add errors directly instead of raising errors
-- Update procs to call with object as first item
+## [1.5.0] - 2025-08-21
 
-## [Unreleased]
+### Changes
+- BREAKING - Revamp CMDx for clarity, transparency, and higher performance
 
 ## [1.1.2] - 2025-07-20
 
-### Added
-- Add `UnknownDeprecationError` for unknown deprecation type
-
-## [1.1.1] - 2025-07-20
-
-### Changed
-- Updated all docs and specs
-- Update deprecation key words
-
-## [1.1.0] - 2025-07-17
-
-### Added
-- Added `CoercionRegistry` class for managing parameter coercions with support for custom type registration
-- Added `ValidatorRegistry` class for managing parameter validators with support for custom validator registration
-- Added `CallbackRegistry` class to take uninstantiated callback classes
-- Added `Validator` and `Coercion` classes to build their respective handlers
-- Added deprecation setting
-
-### Changed
-- Moved `Task::CALLBACKS` constant to `CallbackRegistry::TYPES`
-- Updated `ParameterRegistry` class to not inherit from `Hash`
-- Updated `MiddlewareRegistry` class to not inherit from `Hash`
-- Updated `CallbackRegistry` class to not inherit from `Hash`
-
-### Removed
-- Removed task `register` class method
-- Removed `Custom` validator since users can create and register a custom one
-
-## [1.0.1] - 2025-07-07
-
-### Added
-- Added comprehensive internationalization support with 24 language locales
-  - Arabic, Chinese, Czech, Danish, Dutch, English, Finnish, French, German, Greek
-  - Hebrew, Hindi, Italian, Japanese, Korean, Norwegian, Polish, Portuguese
-  - Russian, Spanish, Swedish, Thai, Turkish, Vietnamese
-- Added TLDR sections to documentation for improved accessibility
-
 ### Changed
-- Improved configuration template with better defaults and examples
-
-## [1.0.0] - 2025-07-03
-
-### Added
-- Added `Hook` class for flexible callback management
-- Added `perform!` and `perform` method aliases for class-level `call!` and `call` methods
-- Added comprehensive YARDoc documentation throughout codebase
-- Added configuration-based hook registration system
-- Added Cursor and GitHub Copilot configuration files for enhanced IDE support
-- Added middleware support for tasks enabling extensible request/response processing
-- Added pattern matching support for result objects
-- Added support for direct instantiation of Task and Workflow objects
-- Added Zeitwerk-based gem loading for improved performance and reliability
-
-### Changed
-- Changed `ArgumentError` to `TypeError` for type validation consistency
-- Changed configuration from hash-based to PORO (Plain Old Ruby Object) class structure
-- Improved documentation readability, consistency, and completeness
-- Improved test suite readability, consistency, and coverage
-- Renamed `Batch` to `Workflow` to better reflect functionality
-- Renamed `Hook` to `Callback` for naming consistency
-- Renamed `Parameters` to `ParameterRegistry` for clarity
-- Renamed `Run` and associated components to `Chain` for better semantic meaning
-- Updated `Chain` to use thread-based execution instead of context passing
-- Updated `Immutator` to use `SKIP_CMDX_FREEZING` environment variable instead of `RACK_ENV`/`RAILS_ENV`
-- Updated hooks from a hash structure to registry pattern
-
-### Removed
-- Removed deprecated `task_timeout` and `batch_timeout` configuration settings
-
-## [0.5.0] - 2025-03-21
-
-### Added
-- Added `on_[state]` and `on_[status]` based result callback handlers
-- Added `on_executed` state hook for task completion tracking
-- Added `on_good` and `on_bad` status hooks for success/failure handling
-- Added `state`, `status`, `outcome`, and `runtime` fields to run serializer
-- Added `to_a` alias for array of hashes serializers
-
-### Changed
-- Reordered status and state hook execution for more predictable behavior
-
-## [0.4.0] - 2025-03-17
-
-### Added
-- Added ANSI color utility for enhanced terminal output
-- Added JSON string parsing support in array coercion
-- Added JSON string parsing support in hash coercion
-
-### Changed
-- Improved ANSI escape sequence handling
-- Improved run inspector output formatting
-
-### Fixed
-- Fixed log settings assignment when logger is nil to prevent errors
-
-## [0.3.0] - 2025-03-14
-
-### Added
-- Added `LoggerSerializer` for standardized log output formatting
-- Added `progname` support for logger instances
-
-### Changed
-- Removed `pid` (process ID) from result serializer output
-- Reverted default log formatter from `PrettyLine` back to `Line`
-
-### Fixed
-- Fixed `call!` method not properly marking failure state as interrupted
-- Fixed serialization issues with frozen run objects
-
-## [0.2.0] - 2025-03-12
-
-### Added
-- Added `PrettyJson` log formatter for structured JSON output
-- Added `PrettyKeyValue` log formatter for key-value pair output
-- Added `PrettyLine` log formatter for enhanced line-based output
-
-### Changed
-- Renamed `DatetimeFormatter` utility to `LogTimestamp` for better clarity
-- Renamed `MethodName` utility to `NameAffix` for better clarity
-- Renamed `Runtime` utility to `MonotonicRuntime` for better clarity
-- Updated `PrettyLine` to be the default log formatter
-- Updated result logger to be wrapped in `Logger#with_logger` block for better context
-
-### Fixed
-- Fixed error when logging non-hash values
-- Fixed fault bubbling behavior with nested halted calls
+- All items between versions `0.1.0` and `1.1.2` should be reviewed within its own tag
 
 ## [0.1.0] - 2025-03-07