spec_forge 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f8c38cb9ff50cb02ee74171a4d571ac411807b1dcce43edab0f28a757269b2f
-  data.tar.gz: 1595911a7a84d7712ddcc5bf0e2a08c0c30afce995ac02bb1372c1ae29ca7db0
+  metadata.gz: 2a63a7870c53ed507204c4848b271094c53a5be8d2925e7b04b359f6885b61cc
+  data.tar.gz: 12684cb3c690072fe1ead4c4ef5d4e9b2fb13d2e40f27c5eeea75fba9cdbff0e
 SHA512:
-  metadata.gz: 731ff8f0cc847010f38caab823c7d30c0d3d7083d4ea53de6ac46c19929c2c31ce698db787303c706ae6ee517dea396ef5ceb220732dd172050967404dd102af
-  data.tar.gz: 1a24dd8f84528427e30d105c4e358ca226b699e79a68a9ac2eb5385a974abb2acb27f8c8a3751e8c69a70001ef8d2ef3938ab06f9c81f1f041325b1b038923e1
+  metadata.gz: f656557492767c8f2391f334461ee4efbcad40118f7608b9d26ba6e5ee1492c3adddce4d76565a79b145b4d2f017de9f43aabbdfdf7e9e837fc71c77b54a4555
+  data.tar.gz: dbaf154a1d50d7399d7c25d5655ad9809185dd410de71d3f2b62809435dfdf75b1d0948ddcc848059c2ee0b7053fc31c148dac164c63636edf2b823c5562a963

data/CHANGELOG.md

@@ -15,14 +15,122 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 -->
 
+## [1.0.0] - 12026-01-29
+
+### ⚠️ Breaking Changes
+
+This release is a complete architectural redesign. See the [Migration Guide](https://github.com/itsthedevman/spec_forge/wiki/Migration-Guide) for detailed upgrade instructions.
+
+**Core changes:**
+- Directory renamed: `spec_forge/specs/` → `spec_forge/blueprints/`
+- CLI renamed: `spec_forge new spec` → `spec_forge new blueprint`
+- YAML structure rewritten from spec-based to sequential step-based workflows
+- Variable syntax changed: `variables.name` → `{{ name }}` template syntax
+- Execution architecture changed: Forge now orchestrates workflows and delegates validation to RSpec, replacing the previous fully RSpec-driven approach
+
+**Configuration:**
+- Removed: `config.headers`, `config.query` (use explicit inheritance instead)
+- Changed: `config.specs` → `config.rspec`
+- Changed: `config.on_debug = proc` → `config.on_debug { block }`
+
+### Added
+
+- **Step-based workflows**: Tests execute as sequential steps with explicit data flow between them. See [Writing Tests](https://github.com/itsthedevman/spec_forge/wiki/Writing-Tests).
+
+  ```yaml
+  - name: "Create user"
+    request:
+      url: /users
+      http_verb: POST
+      json:
+        email: "{{ faker.internet.email }}"
+    expect:
+    - status: 201
+    store:
+      user_id: "{{ response.body.id }}"
+
+  - name: "Fetch created user"
+    request:
+      url: "/users/{{ user_id }}"
+    expect:
+    - status: 200
+  ```
+
+- **Template variable system**: New `{{ }}` syntax for dynamic values—supports variables, Faker, factories, and environment variables. See [Dynamic Features](https://github.com/itsthedevman/spec_forge/wiki/Dynamic-Features).
+
+- **JSON validation modes**: Three modes for response validation—`shape:` for type checking with nullable/optional flags, `content:` for value matching, and `schema:` for explicit structure control. See [Validating Responses](https://github.com/itsthedevman/spec_forge/wiki/Validating-Responses).
+
+- **Configuration inheritance**: The `shared:` wrapper applies request configuration and hooks to nested steps, making auth flows and grouped operations cleaner.
+
+- **Lifecycle hooks**: Register callbacks for `before`/`after` events at forge, blueprint, and step levels. See [Callbacks](https://github.com/itsthedevman/spec_forge/wiki/Callbacks).
+
+- **Tag-based filtering**: Organize steps with tags and run subsets via `--tags` and `--skip-tags` CLI options. See [Running Tests](https://github.com/itsthedevman/spec_forge/wiki/Running-Tests).
+
+- **Improved output display**: Verbosity levels (`--verbose`, `--debug`, `--trace`) with colorized terminal output, detailed failure context, and YAML line number tracking in error messages.
+
+- **File includes**: Extract common workflows into separate files and inject them with `include:`.
+
+### Changed
+
+- Request options now nested under `request:` key
+- Expectations simplified from `expectations: [{ expect: ... }]` to `expect: [...]`
+- Error messages now include YAML line numbers and source file context
+- Factory references now support traits and attribute overrides via expanded syntax
+- Global variables defined in `forge_helper.rb` via `config.global_variables` instead of YAML
+
+### Removed
+
+- Global context system (`Context::Global`, `Context::Store`, `Context::Variables`)
+- Spec and Expectation classes (replaced with Step-based architecture)
+- Global headers/query configuration (use `shared:` inheritance instead)
+
+**[Full documentation](https://github.com/itsthedevman/spec_forge/wiki)** ｜ **[Migration Guide](https://github.com/itsthedevman/spec_forge/wiki/Migration-Guide)**
+
+---
+
+## [0.7.1] - 12025-10-08
+
+### Added
+
+- **Configuration alias**: `base_path` can now be used as an alias for `base_url` in spec definitions
+- **Improved debug configuration**: New `config.on_debug { }` block syntax for cleaner configuration
+
+  ```ruby
+  # New cleaner syntax (recommended)
+  config.on_debug { binding.pry }
+
+  # Old syntax still works with deprecation warning
+  config.on_debug = -> { binding.pry }
+  ```
+
+### Changed
+
+- **Fixed path handling in HTTP requests**: Paths with leading slashes (e.g., `/users`) now properly append to base URLs instead of replacing the entire path
+  - Previously, a base URL like `http://api.example.com/v1` with path `/users` would incorrectly resolve to `http://api.example.com/users`
+  - Now correctly resolves to `http://api.example.com/v1/users`
+  - This matches user expectations and common API patterns
+  - **Note**: If you need to replace the entire path, use absolute URLs like `https://api.example.com/users`
+- **CI/CD improvements**: Updated to GitHub Actions checkout v5 and streamlined Ruby version testing
+
+### Fixed
+
+- **Transform.join resolution**: Now properly generates fresh values instead of using cached results
+- **Test adapter optimization**: Removed JSON class validation check to allow matchers to be used
+
+### Deprecated
+
+- `config.on_debug = proc` syntax - use `config.on_debug { }` block syntax instead
+
 ## [0.7.0] - 12025-06-22
 
 ### Added
 
 #### 🚀 Documentation-First Architecture
+
 **The Big Picture**: SpecForge now generates OpenAPI documentation from your tests automatically!
 
 - **Primary Documentation Workflow**: New `docs` command (now the default!) generates OpenAPI specs from test execution
+
   - Smart caching system with `--fresh` flag for forced regeneration
   - Multiple output formats: YAML (default) or JSON via `--format`
   - Custom output paths with `--output` option
@@ -30,6 +138,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Optional validation skip with `--skip-validation` for faster iterations
 
 - **Live Documentation Server**: `spec_forge serve` command for immediate feedback
+
   - Local web server with Swagger UI (default) or Redoc (`--ui redoc`)
   - Configurable port with `--port` (defaults to 8080)
   - Auto-generated HTML templates for both UI options
@@ -44,17 +153,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### 🧪 Enhanced Testing Capabilities
 
 - **HTTP Header Testing**: Comprehensive header validation
+
   ```yaml
   headers:
     Content-Type: "application/json"
     X-Request-ID: /^[0-9a-f-]{36}$/
     Cache-Control:
       matcher.and:
-      - matcher.include: "max-age="
-      - matcher.include: "private"
+        - matcher.include: "max-age="
+        - matcher.include: "private"
   ```
 
 - **Flexible Store System**: Store anything, access everything
+
   - OpenStruct-based entries for maximum flexibility
   - Custom data via callbacks (config, metadata, computed values)
   - Same familiar `store.id.attribute` syntax
@@ -67,12 +178,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### ⚙️ Architecture Improvements
 
 - **YAML-Driven Normalizers**: Configuration over code
+
   - Structure definitions in `lib/spec_forge/normalizers/*.yml`
   - Powerful `reference:` system for reusable components
   - Wildcard support (`*`) for catch-all schemas
   - Centralized validation logic in dedicated module
 
 - **Enhanced CLI Experience**:
+
   - Improved `init` command with `--skip-openapi` and `--skip-factories` flags
   - Better help text and examples throughout
   - Clearer error messages with actionable context
@@ -87,6 +200,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### 🎯 User Experience Overhaul
 
 - **New Default Behavior**: `spec_forge` without arguments now shows help instead of running tests
+
   - **Breaking Change**: Use `spec_forge docs` for documentation or `spec_forge run` for test-only execution
   - Safer default that guides users to the right command for their needs
 
@@ -98,11 +212,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### 🏗️ Internal Refactoring
 
 - **Normalizer Architecture**: YAML-based instead of class-heavy approach
+
   - Consolidated shared definitions in `_shared.yml`
   - Easier maintenance and extension
   - Better error context with attribute path tracking
 
 - **Test Execution Pipeline**:
+
   - Clean separation between test preparation and execution
   - Enhanced RSpec adapter pattern
   - Better reusability for documentation generation
@@ -119,6 +235,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ---
 
 **Migration Notes**:
+
 - Update any scripts using bare `spec_forge` - now shows help instead of running tests
 - Use `spec_forge docs` for documentation generation or `spec_forge run` for testing
 - Store access patterns remain the same, but internal structure is more flexible
@@ -134,6 +251,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - `Context::Variables` for managing variables with overlay support
     - `Context::Store` for storing the results of the tests
 - Added support for defining and referencing global variables
+
   ```yaml
   global:
     variables:
@@ -145,13 +263,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     query:
       api_version: "global.variables.api_version"
   ```
+
 - Added compound matcher support via `matcher.and` for combining multiple matchers
   ```yaml
   email:
     matcher.and:
-    - kind_of.string
-    - /@/
-    - matcher.end_with: ".com"
+      - kind_of.string
+      - /@/
+      - matcher.end_with: ".com"
   ```
 - Added custom RSpec matcher `have_size` for checking an object's size via `matcher.have_size`
 - Added new `Loader` class for improved spec file processing
@@ -159,6 +278,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added normalizer for global context validation
 - Added line number tracking for specs and expectations
 - Added support for defining and referencing callbacks
+
   ```ruby
   # Configuration level
   SpecForge.configure do |config|
@@ -171,14 +291,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   # Module level (no aliases)
   SpecForge.register_callback("callback_name") { |context| }
   ```
+
   Once defined, callbacks can be referenced in spec files via the global context
+
   ```yaml
   global:
     callbacks:
-    - before: callback_name
-      after: cleanup_database_state
+      - before: callback_name
+        after: cleanup_database_state
   ```
+
 - Added support for storing and retrieving test data via the `store_as` directive and `store` attribute
+
   ```yaml
   create_user:
     path: "/users"
@@ -198,6 +322,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - expect:
         status: 200
   ```
+
 - Added `UndefinedMatcherError` for clearer error messaging when invalid matchers are used
 - Enhanced debugging capabilities with improved DebugProxy methods and store access
 - Added HTTP status descriptions for better error messages
@@ -248,7 +373,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   variables:
     users:
       factory.user:
-        size: 10  # Creates 10 user records
+        size: 10 # Creates 10 user records
   ```
   - All FactoryBot list methods now supported:
     - `create_list` (default)
@@ -307,6 +432,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Core Infrastructure
+
   - Configuration management
   - User input validation and normalization
   - Factory registration
@@ -316,11 +442,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Debugging tooling
 
 - CLI
+
   - Project initialization (`init`)
   - Spec/factory generation (`new`)
   - Test execution (`run`)
 
 - Attributes
+
   - Chainable attribute handling (through `Chainable`)
   - Expanded attribute handling (through `Parameterized`)
   - Factory (with chainable support) - `factories.`
@@ -339,7 +467,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial commit
 
-[unreleased]: https://github.com/itsthedevman/spec_forge/compare/v0.7.0...HEAD
+[unreleased]: https://github.com/itsthedevman/spec_forge/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/itsthedevman/spec_forge/compare/v0.7.1...v1.0.0
+[0.7.1]: https://github.com/itsthedevman/spec_forge/compare/v0.7.0...v0.7.1
 [0.7.0]: https://github.com/itsthedevman/spec_forge/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/itsthedevman/spec_forge/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/itsthedevman/spec_forge/compare/v0.4.0...v0.5.0