cmdx 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd1613d4572cca134192d5c80bf3016b278b42a9a002d13fba66d2871da92fb
-  data.tar.gz: 1a174bc8b62bf3402e1e464b8252cdcd589731f8e81141723b8dbf3cf97f9f1b
+  metadata.gz: 2517b9b2e36f957800d10bf952bd8062fbcd4c66ff760574c741c96b5d76d925
+  data.tar.gz: f52d86024e590060604c17da1ff31ed520d9f5d561367d6ef59b6df93ed01b45
 SHA512:
-  metadata.gz: df70552dbf814fddff62cb3e1d593edf6bf5c33087d84154f36c794d430ee156b986998651383fa15b3b08e4d14d198d69020bb0dec7a13ffab43c75b1c57b02
-  data.tar.gz: 03ad35b1f6007e1afa3c41f3b63d44784566e78b9eb9b7f25f301d81165753af14b06bb8a6cfd67ea7e5bce02a03c311c338f61538d9d981d7de58d7f2b36f8f
+  metadata.gz: b260acf4cf76fa11cb9af6fd498536c8260b813880fb46dca0569162eda32d08f67c9a3ccd06611a84fc75067b7b49c8365beebeafc766b6098961cf2fa46830
+  data.tar.gz: 7fe5dd38adfdee7db0b54f2748f19a74bbe34da632288275fd012a4ea15216ad8bc35a8e189e9274463797511d59f260063dab2903d9052968fbb69653bb93ef

data/.cursor/prompts/docs.md

@@ -0,0 +1,9 @@
+Update the file in context 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)

data/.cursor/prompts/rspec.md

@@ -1,20 +1,21 @@
-Add tests for the file in context.
+Add tests for the file in context 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.
+- 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.
+- 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
 - Verify all specs are passing

data/.cursor/prompts/yardoc.md

@@ -1,8 +1,13 @@
-Add yardoc to the file in context.
-- Do NOT include `CMDx` module level docs
-- Module level docs description should NOT include `@example`
-- Method level docs should include `@example`, `@return`, `@raise`
-- Examples should be concise and realistic
+Add yardoc to the file in context using the following guidelines:
+
 - Follow best practices and implementation
-- Update any pre-existing docs to match stated rules
 - 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`
+- 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/CHANGELOG.md

@@ -7,16 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [TODO]
 
-- Add table and pretty_table log formatters
-- Refactor all `docs`
+- Rebuild parameters to use a less magical approach
+- 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
 
 ## [Unreleased]
 
+## [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`

data/README.md

@@ -102,6 +102,7 @@ end
 - [Logging](docs/logging.md)
 - [Internationalization (i18n)](docs/internationalization.md)
 - [Testing](docs/testing.md)
+- [Deprecation](docs/deprecation.md)
 - [AI Prompts](docs/ai_prompts.md)
 - [Tips & Tricks](docs/tips_and_tricks.md)