spec_forge 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f8c38cb9ff50cb02ee74171a4d571ac411807b1dcce43edab0f28a757269b2f
-  data.tar.gz: 1595911a7a84d7712ddcc5bf0e2a08c0c30afce995ac02bb1372c1ae29ca7db0
+  metadata.gz: 9891353d8acd7d64ec4b2690e4e91d68c0d455913b8ca81c7f9e410859f51774
+  data.tar.gz: 7ff9aa712f7d21a75ae8a383175702ed8973b25e2935458bd75dd713f59b6fb3
 SHA512:
-  metadata.gz: 731ff8f0cc847010f38caab823c7d30c0d3d7083d4ea53de6ac46c19929c2c31ce698db787303c706ae6ee517dea396ef5ceb220732dd172050967404dd102af
-  data.tar.gz: 1a24dd8f84528427e30d105c4e358ca226b699e79a68a9ac2eb5385a974abb2acb27f8c8a3751e8c69a70001ef8d2ef3938ab06f9c81f1f041325b1b038923e1
+  metadata.gz: 0637e96a8739579015af17ee0a6c8442b51c9fd189b2a220b7828ae68f0784760aad4d5312eabf450f18ee7e6db2789dad3fb55327cee0aa19f3a8e9b88be243
+  data.tar.gz: 3d10cc2cafb76d2d14b42e104fba62a5e8ec35d70cb92f6769e3fcde9611d9949d707fdc287caae52454e04d6542c507274e357bb38f41090792efa40e5d6436

data/CHANGELOG.md

@@ -15,14 +15,49 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 -->
 
+## [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 +65,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 +80,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 +105,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 +127,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 +139,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 +162,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 +178,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 +190,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 +205,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 +218,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 +249,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 +300,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 +359,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 +369,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 +394,8 @@ 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/v0.7.1...HEAD
+[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

data/README.md

@@ -1,10 +1,10 @@
 # SpecForge
 
 [![Gem Version](https://badge.fury.io/rb/spec_forge.svg)](https://badge.fury.io/rb/spec_forge)
-![Ruby Version](https://img.shields.io/badge/ruby-3.3.7-ruby)
+![Ruby Version](https://img.shields.io/badge/ruby-3.2+-ruby)
 [![Tests](https://github.com/itsthedevman/spec_forge/actions/workflows/main.yml/badge.svg)](https://github.com/itsthedevman/spec_forge/actions/workflows/main.yml)
 
-> Note: The code in this repository represents the latest development version with new features and improvements that are being prepared for future releases. For the current stable version, check out [v0.6.0](https://github.com/itsthedevman/spec_forge/releases/tag/v0.6.0) on GitHub releases.
+> Note: The code in this repository represents the latest development version with new features and improvements that are being prepared for future releases. For the current stable version, check out [v0.7.1](https://github.com/itsthedevman/spec_forge/releases/tag/v0.7.1) on GitHub releases.
 
 Write API tests in YAML that read like documentation and generate OpenAPI specifications:
 

data/lib/spec_forge/attribute/transform.rb

@@ -59,7 +59,7 @@ module SpecForge
         case function
         when "join"
           # Technically supports any attribute, but I ain't gonna test all them edge cases
-          arguments[:positional].resolved.join
+          arguments[:positional].resolve.join
         end
       end
     end

data/lib/spec_forge/cli/serve.rb

@@ -17,6 +17,7 @@ module SpecForge
     #
     class Serve < Command
       include Docs::Generate
+
       #
       # Valid file formats for documentation output
       #

data/lib/spec_forge/configuration.rb

@@ -5,7 +5,7 @@ module SpecForge
   # Configuration container for SpecForge settings
   # Defines default values and validation for all configuration options
   #
-  class Configuration < Struct.new(:base_url, :headers, :query, :factories, :on_debug)
+  class Configuration < Struct.new(:base_url, :headers, :query, :factories, :on_debug_proc)
     #
     # Manages factory configuration settings
     # Controls auto-discovery behavior and custom factory paths
@@ -44,7 +44,7 @@ module SpecForge
 
       config[:base_url] = "http://localhost:3000"
       config[:factories] = Factories.new
-      config[:on_debug] = Runner::DebugProxy.default
+      config[:on_debug_proc] = Runner::DebugProxy.default
 
       super(**config)
     end
@@ -68,6 +68,15 @@ module SpecForge
       self
     end
 
+    def on_debug(&block)
+      self.on_debug_proc = block
+    end
+
+    def on_debug=(block)
+      warn("SpecForge::Configuration#on_debug= is deprecated. Use #on_debug instead")
+      self.on_debug_proc = block
+    end
+
     #
     # Recursively converts the configuration to a hash representation
     #
@@ -108,11 +117,6 @@ module SpecForge
     #
     # @return [Proc] The registered callback
     #
-    # @example Registering a custom debug handler
-    #   SpecForge.configure do |config|
-    #     config.register_callback(:on_debug) { binding.pry }
-    #   end
-    #
     # @example Cleaning database after each test
     #   SpecForge.configure do |config|
     #     config.register_callback(:after_expectation) do

data/lib/spec_forge/documentation/openapi/v3_0/operation.rb

@@ -26,7 +26,7 @@ module SpecForge
               # Required
               responses:,
               security:
-            }.merge_compact(
+            }.compact_merge(
               # All optional
               tags:,
               summary:,

data/lib/spec_forge/documentation/openapi/v3_0/response.rb

@@ -26,7 +26,7 @@ module SpecForge
               # Required
               description: "",
               content:
-            }.merge_compact(
+            }.compact_merge(
               # Optional
               headers:
             )

data/lib/spec_forge/http/backend.rb

@@ -166,6 +166,9 @@ module SpecForge
       # @private
       #
       def normalize_url(url, query)
+        # Strip leading slash so paths properly append to base URL
+        url = url.delete_prefix("/")
+
         # /users/<user_id>
         url = replace_url_placeholder(url, query, CURLY_PLACEHOLDER)
 

data/lib/spec_forge/normalizers/_shared.yml

@@ -8,6 +8,8 @@ base_url:
   type: string
   default: null
   required: false
+  aliases:
+  - base_path
 
 url:
   type: string

data/lib/spec_forge/normalizers/configuration.yml

@@ -19,5 +19,5 @@ factories:
       type: array
       default: []
 
-on_debug:
+on_debug_proc:
   type: proc

data/lib/spec_forge/runner/adapter.rb

@@ -152,8 +152,6 @@ module SpecForge
                     ############################################################
                     # JSON check
                     if match_json.present?
-                      expect(response.body).to match_json_class
-
                       case match_json
                       when Hash
                         match_json.each do |key, matcher|

data/lib/spec_forge/runner/debug_proxy.rb

@@ -30,7 +30,46 @@ module SpecForge
       # @return [Proc] The default debugging handler that outputs JSON state information
       #
       def self.default
-        -> { puts inspect }
+        lambda do
+          puts <<~STRING
+
+            Debug triggered for:
+            > #{example.metadata[:rerun_file_path]} on line #{expectation.line_number}
+
+            Available debugging contexts:
+            - spec: Current spec details
+            - expectation: Current expectation being tested
+            - variables: Variables defined for this test
+            - global: Global context shared across tests
+            - store: Stored data from expectations
+
+            Request & Response:
+            - request: HTTP request details (method, url, headers, body)
+            - response: HTTP response with headers, status and body
+
+            Expectations:
+            - expected_status: Expected HTTP status code
+            - expected_json: Expected response body structure
+
+            Matchers:
+            - match_status: Matcher used to test status
+            - match_json: Matcher used to test response body
+
+            Helper objects:
+            - http_client: The HTTP client used for the request
+            - request_data: Raw request configuration data
+            - example_group: Current RSpec example group
+            - example: Current RSpec example
+            - forge: Current file being tested
+
+            💡 Pro tips:
+              - Type 'self' or 'inspect' for a pretty-printed JSON overview
+              - Use 'to_h' for the hash representation
+              - Access the shared context with 'SpecForge.context'
+          STRING
+
+          puts inspect
+        end
       end
 
       # @return [RSpec::Forge] The current Forge that is being tested
@@ -67,7 +106,7 @@ module SpecForge
       # @return [SpecForge::Runner::DebugProxy]
       #
       def initialize(forge, spec, expectation, example_group)
-        @callback = SpecForge.configuration.on_debug
+        @callback = SpecForge.configuration.on_debug_proc
 
         @forge = forge
         @spec = spec
@@ -90,43 +129,6 @@ module SpecForge
       # @return [void]
       #
       def call
-        puts <<~STRING
-
-          Debug triggered for:
-          > #{example.metadata[:rerun_file_path]} on line #{expectation.line_number}
-
-          Available debugging contexts:
-          - spec: Current spec details
-          - expectation: Current expectation being tested
-          - variables: Variables defined for this test
-          - global: Global context shared across tests
-          - store: Stored data from expectations
-
-          Request & Response:
-          - request: HTTP request details (method, url, headers, body)
-          - response: HTTP response with headers, status and body
-
-          Expectations:
-          - expected_status: Expected HTTP status code
-          - expected_json: Expected response body structure
-
-          Matchers:
-          - match_status: Matcher used to test status
-          - match_json: Matcher used to test response body
-
-          Helper objects:
-          - http_client: The HTTP client used for the request
-          - request_data: Raw request configuration data
-          - example_group: Current RSpec example group
-          - example: Current RSpec example
-          - forge: Current file being tested
-
-          💡 Pro tips:
-            - Type 'self' or 'inspect' for a pretty-printed JSON overview
-            - Use 'to_h' for the hash representation
-            - Access the shared context with 'SpecForge.context'
-        STRING
-
         instance_exec(&@callback)
       end
 

data/lib/spec_forge/version.rb

@@ -4,5 +4,5 @@ module SpecForge
   #
   # Current version of SpecForge
   #
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spec_forge
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Bryan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-22 00:00:00.000000000 Z
+date: 2025-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport