spec_forge 0.7.1 → 1.0.0

data/lib/templates/forge_helper.rb.tt

@@ -4,13 +4,13 @@
 # Framework Integration
 ##########################################
 
-# Rails Integration
+## Rails Integration
 # require_relative "../config/environment"
 
-# RSpec Integration (includes your existing configurations)
+## RSpec Integration (includes your existing configurations)
 # require_relative "../spec/spec_helper"
 
-# Custom requires (models, libraries, etc)
+## Custom requires (models, libraries, etc)
 # Dir[File.join(__dir__, "..", "lib", "**", "*.rb")].sort.each { |f| require f }
 
 ##########################################
@@ -18,31 +18,52 @@
 ##########################################
 
 SpecForge.configure do |config|
-  # Base configuration
+  # Base URL for all requests
   config.base_url = "http://localhost:3000"
 
-  # Default request headers
-  config.headers = {
-    "Authorization" => "Bearer #{ENV.fetch("API_TOKEN", "")}"
-  }
+  ## Global variables (available in all blueprints via {{ variable_name }})
+  ## Use for shared values like auth tokens, API versions, etc.
+  # config.global_variables = {
+  #   api_version: "v1",
+  #   auth_header: "Bearer #{ENV['API_TOKEN']}"
+  # }
 
-  # Optional: Default query parameters
-  # config.query = {api_key: ENV['API_KEY']}
-
-  # Factory configuration
+  ## Factory configuration
   # config.factories.auto_discover = false        # Default: true
   # config.factories.paths += ["lib/factories"]   # Adds to default paths
 
-  # Debug configuration
-  # Available in specs with debug: true (aliases: breakpoint, pry)
-  # Defaults to printing state overview (-> { puts inspect })
-  # Available context: expectation, variables, request, response,
-  #                   expected_status, expected_json
+  ## Debug configuration
+  # Triggers when debug: true is set on a step
   # config.on_debug { binding.pry }
 
-  # Test Framework Configuration
-  # Useful for database cleaners, test data setup, etc
-  # config.specs.before(:suite) { }
-  # config.specs.around { |example| example.run }
-  # config.specs.formatter = :documentation
+  ## Callbacks and Hooks
+  # Register reusable callbacks for use with `call:` in blueprints or lifecycle hooks
+
+  ## Basic callback registration
+  # config.register_callback(:seed_database) do |context|
+  #   User.create!(email: "test@test.com")
+  # end
+
+  ## With arguments
+  # config.register_callback(:create_records) do |context, count:, type:|
+  #   count.times { type.constantize.create! }
+  # end
+
+  ## Complete example: Database cleanup
+  # config.register_callback(:cleanup_db) do |context|
+  #   DatabaseCleaner.clean
+  # end
+  # 
+  # config.after(:forge, :cleanup_db)  # Runs once after all tests
+
+  ## Hooks can also be defined directly (useful for simple one-off hooks)
+  # config.after(:step) do |context|
+  #   next unless context.step.request?
+  #
+  #   request = context.variables[:request]
+  #   puts "→ #{request[:http_verb]} #{request[:url]}"
+  # end
+
+  ## Test Framework Configuration
+  # config.rspec.formatter = :documentation
 end

data/lib/templates/new_blueprint.yml.tt

@@ -0,0 +1,54 @@
+# <%= original_name %>.yml
+
+# Store some test data
+- store:
+    test_email: "test@example.com"
+    test_name: "Test <%= singular_name.titleize %>"
+
+# Create a <%= singular_name %>
+- name: "Create <%= singular_name %>"
+  request:
+    path: /<%= plural_name %>
+    method: POST
+    json:
+      name: "{{ test_name }}"
+      email: "{{ test_email }}"
+  expect:
+  - status: 201
+    json:
+      shape:
+        id: integer
+        name: string
+        email: string
+  store:
+    <%= singular_name %>_id: "{{ response.body.id }}"
+
+# Get the <%= singular_name %> we just created
+- name: "Show <%= singular_name %>"
+  request:
+    path: "/<%= plural_name %>/{{ <%= singular_name %>_id }}"
+    method: GET
+  expect:
+  - status: 200
+    json:
+      content:
+        id: "{{ <%= singular_name %>_id }}"
+        name: "{{ test_name }}"
+
+# Update the <%= singular_name %>
+- name: "Update <%= singular_name %>"
+  request:
+    path: "/<%= plural_name %>/{{ <%= singular_name %>_id }}"
+    method: PATCH
+    json:
+      name: "Updated <%= singular_name.titleize %>"
+  expect:
+  - status: 200
+
+# Delete the <%= singular_name %>
+- name: "Delete <%= singular_name %>"
+  request:
+    path: "/<%= plural_name %>/{{ <%= singular_name %>_id }}"
+    method: DELETE
+  expect:
+  - status: 200

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spec_forge
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Bryan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-09 00:00:00.000000000 Z
+date: 2026-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description: Write API tests in YAML without sacrificing power. SpecForge combines
   RSpec's matcher system, Faker's data generation, and factory patterns into a clean,
   declarative syntax that eliminates boilerplate while preserving control over your
@@ -203,9 +231,10 @@ files:
 - lib/spec_forge.rb
 - lib/spec_forge/attribute.rb
 - lib/spec_forge/attribute/chainable.rb
+- lib/spec_forge/attribute/environment.rb
 - lib/spec_forge/attribute/factory.rb
 - lib/spec_forge/attribute/faker.rb
-- lib/spec_forge/attribute/global.rb
+- lib/spec_forge/attribute/generate.rb
 - lib/spec_forge/attribute/literal.rb
 - lib/spec_forge/attribute/matcher.rb
 - lib/spec_forge/attribute/parameterized.rb
@@ -213,11 +242,11 @@ files:
 - lib/spec_forge/attribute/resolvable.rb
 - lib/spec_forge/attribute/resolvable_array.rb
 - lib/spec_forge/attribute/resolvable_hash.rb
-- lib/spec_forge/attribute/store.rb
+- lib/spec_forge/attribute/resolvable_struct.rb
+- lib/spec_forge/attribute/template.rb
 - lib/spec_forge/attribute/transform.rb
 - lib/spec_forge/attribute/variable.rb
-- lib/spec_forge/backtrace_formatter.rb
-- lib/spec_forge/callbacks.rb
+- lib/spec_forge/blueprint.rb
 - lib/spec_forge/cli.rb
 - lib/spec_forge/cli/actions.rb
 - lib/spec_forge/cli/command.rb
@@ -228,32 +257,22 @@ files:
 - lib/spec_forge/cli/run.rb
 - lib/spec_forge/cli/serve.rb
 - lib/spec_forge/configuration.rb
-- lib/spec_forge/context.rb
-- lib/spec_forge/context/callbacks.rb
-- lib/spec_forge/context/global.rb
-- lib/spec_forge/context/store.rb
-- lib/spec_forge/context/variables.rb
-- lib/spec_forge/core_ext.rb
 - lib/spec_forge/core_ext/array.rb
-- lib/spec_forge/core_ext/rspec.rb
 - lib/spec_forge/documentation.rb
 - lib/spec_forge/documentation/builder.rb
+- lib/spec_forge/documentation/builder/cache.rb
+- lib/spec_forge/documentation/builder/compiler.rb
+- lib/spec_forge/documentation/builder/extractor.rb
 - lib/spec_forge/documentation/document.rb
 - lib/spec_forge/documentation/document/operation.rb
 - lib/spec_forge/documentation/document/parameter.rb
 - lib/spec_forge/documentation/document/request_body.rb
 - lib/spec_forge/documentation/document/response.rb
 - lib/spec_forge/documentation/document/response_body.rb
-- lib/spec_forge/documentation/generators.rb
-- lib/spec_forge/documentation/generators/base.rb
-- lib/spec_forge/documentation/generators/openapi.rb
-- lib/spec_forge/documentation/generators/openapi/base.rb
-- lib/spec_forge/documentation/generators/openapi/error_formatter.rb
-- lib/spec_forge/documentation/generators/openapi/v3_0.rb
-- lib/spec_forge/documentation/loader.rb
-- lib/spec_forge/documentation/loader/cache.rb
+- lib/spec_forge/documentation/generator.rb
 - lib/spec_forge/documentation/openapi.rb
-- lib/spec_forge/documentation/openapi/base.rb
+- lib/spec_forge/documentation/openapi/v3_0.rb
+- lib/spec_forge/documentation/openapi/v3_0/error_formatter.rb
 - lib/spec_forge/documentation/openapi/v3_0/example.rb
 - lib/spec_forge/documentation/openapi/v3_0/media_type.rb
 - lib/spec_forge/documentation/openapi/v3_0/operation.rb
@@ -262,42 +281,54 @@ files:
 - lib/spec_forge/documentation/openapi/v3_0/tag.rb
 - lib/spec_forge/error.rb
 - lib/spec_forge/factory.rb
-- lib/spec_forge/filter.rb
 - lib/spec_forge/forge.rb
+- lib/spec_forge/forge/action.rb
+- lib/spec_forge/forge/actions/call.rb
+- lib/spec_forge/forge/actions/debug.rb
+- lib/spec_forge/forge/actions/expect.rb
+- lib/spec_forge/forge/actions/request.rb
+- lib/spec_forge/forge/actions/store.rb
+- lib/spec_forge/forge/callbacks.rb
+- lib/spec_forge/forge/context.rb
+- lib/spec_forge/forge/display.rb
+- lib/spec_forge/forge/hooks.rb
+- lib/spec_forge/forge/runner.rb
+- lib/spec_forge/forge/runner/array_io.rb
+- lib/spec_forge/forge/runner/content_validator.rb
+- lib/spec_forge/forge/runner/header_validator.rb
+- lib/spec_forge/forge/runner/reporter.rb
+- lib/spec_forge/forge/runner/schema_validator.rb
+- lib/spec_forge/forge/timer.rb
+- lib/spec_forge/forge/variables.rb
 - lib/spec_forge/http.rb
 - lib/spec_forge/http/backend.rb
 - lib/spec_forge/http/client.rb
 - lib/spec_forge/http/request.rb
 - lib/spec_forge/http/verb.rb
 - lib/spec_forge/loader.rb
+- lib/spec_forge/loader/filter.rb
+- lib/spec_forge/loader/step_processor.rb
 - lib/spec_forge/matchers.rb
 - lib/spec_forge/normalizer.rb
 - lib/spec_forge/normalizer/default.rb
-- lib/spec_forge/normalizer/definition.rb
+- lib/spec_forge/normalizer/structure.rb
+- lib/spec_forge/normalizer/transformers.rb
 - lib/spec_forge/normalizer/validators.rb
-- lib/spec_forge/normalizers/_shared.yml
+- lib/spec_forge/normalizers/callback.yml
 - lib/spec_forge/normalizers/configuration.yml
-- lib/spec_forge/normalizers/constraint.yml
-- lib/spec_forge/normalizers/expectation.yml
 - lib/spec_forge/normalizers/factory.yml
 - lib/spec_forge/normalizers/factory_reference.yml
-- lib/spec_forge/normalizers/global_context.yml
-- lib/spec_forge/normalizers/spec.yml
-- lib/spec_forge/runner.rb
-- lib/spec_forge/runner/adapter.rb
-- lib/spec_forge/runner/callbacks.rb
-- lib/spec_forge/runner/debug_proxy.rb
-- lib/spec_forge/runner/listener.rb
-- lib/spec_forge/runner/metadata.rb
-- lib/spec_forge/runner/state.rb
-- lib/spec_forge/spec.rb
-- lib/spec_forge/spec/expectation.rb
-- lib/spec_forge/spec/expectation/constraint.rb
+- lib/spec_forge/normalizers/json_schema.yml
+- lib/spec_forge/normalizers/step.yml
+- lib/spec_forge/step.rb
+- lib/spec_forge/step/call.rb
+- lib/spec_forge/step/expect.rb
+- lib/spec_forge/step/source.rb
 - lib/spec_forge/type.rb
 - lib/spec_forge/version.rb
 - lib/templates/forge_helper.rb.tt
+- lib/templates/new_blueprint.yml.tt
 - lib/templates/new_factory.yml.tt
-- lib/templates/new_spec.yml.tt
 - lib/templates/openapi.yml.tt
 - lib/templates/redoc.html.tt
 - lib/templates/swagger.html.tt

data/lib/spec_forge/attribute/global.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  class Attribute
-    #
-    # Represents an attribute that references values from the global context
-    #
-    # This class allows accessing shared data defined at the global level through
-    # namespaced references. It provides access to global variables that are shared
-    # across all specs in a file, enabling consistent test data without repetition.
-    #
-    # Currently supports the "variables" namespace.
-    #
-    # @example Basic usage in YAML
-    #   # Reference a global variable in a spec
-    #   session_token: global.variables.session_token
-    #
-    #   # Using within a request body
-    #   body:
-    #     api_version: global.variables.api_version
-    #     auth_token: global.variables.auth_token
-    #
-    class Global < Attribute
-      #
-      # Regular expression pattern that matches attribute keywords with this prefix
-      # Used for identifying this attribute type during parsing
-      #
-      # @return [Regexp]
-      #
-      KEYWORD_REGEX = /^global\./i
-
-      #
-      # An array of valid namespaces that can be access on global
-      #
-      # @return [Array<String>]
-      #
-      VALID_NAMESPACES = %w[
-        variables
-      ].freeze
-
-      #
-      # Creates a new global attribute from the input string
-      #
-      # Parses the input string to extract the namespace to validate it
-      # Conversion happens when `#value` is called
-      #
-      # @raise [Error::InvalidGlobalNamespaceError] If an unsupported namespace is referenced
-      #
-      def initialize(...)
-        super
-
-        # Check to make sure the namespace is valid
-        namespace = input.split(".").second
-
-        if !VALID_NAMESPACES.include?(namespace)
-          raise Error::InvalidGlobalNamespaceError, namespace
-        end
-      end
-
-      #
-      # Converts the global reference into an underlying attribute
-      #
-      # Parses the input and returns the corresponding attribute based on the namespace.
-      # Currently supports extracting variables from the global context.
-      #
-      # @return [Attribute] An attribute representing the referenced global value
-      #
-      def value
-        # Skip the "global" prefix
-        components = input.split(".")[1..]
-        namespace = components.first
-
-        global_context = SpecForge.context.global
-
-        case namespace
-        when "variables"
-          variable_input = components.join(".")
-          variable = Attribute::Variable.new(variable_input)
-          variable.bind_variables(global_context.variables.to_h)
-          variable
-        end
-      end
-
-      #
-      # Resolves the global reference to its actual value
-      #
-      # Delegates resolution to the underlying attribute and caches the result
-      #
-      # @return [Object] The fully resolved value from the global context
-      #
-      def resolved
-        @resolved ||= value.resolved
-      end
-    end
-  end
-end

data/lib/spec_forge/attribute/store.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  class Attribute
-    #
-    # Represents an attribute that references values from stored test results
-    #
-    # This class allows accessing data from previous test executions that were
-    # saved using the `store_as` directive. It provides access to response data
-    # including status, headers, and body from previously run expectations.
-    #
-    # @example Basic usage in YAML
-    #   create_user:
-    #     path: /users
-    #     method: post
-    #     expectations:
-    #     - store_as: new_user
-    #       body:
-    #         name: faker.name.name
-    #       expect:
-    #         status: 201
-    #
-    #   get_user:
-    #     path: /users/{id}
-    #     expectations:
-    #     - query:
-    #         id: store.new_user.body.id
-    #       expect:
-    #         status: 200
-    #
-    # @example Accessing specific response components
-    #   check_status:
-    #     path: /health
-    #     expectations:
-    #     - variables:
-    #         expected_status: store.new_user.status
-    #         auth_token: store.new_user.headers.authorization
-    #         user_name: store.new_user.body.user.name
-    #       expect:
-    #         status: 200
-    #
-    class Store < Attribute
-      include Chainable
-
-      #
-      # Regular expression pattern that matches attribute keywords with this prefix
-      # Used for identifying this attribute type during parsing
-      #
-      # @return [Regexp]
-      #
-      KEYWORD_REGEX = /^store\./i
-
-      alias_method :stored_id, :header
-
-      #
-      # Returns the base object for the variable chain
-      #
-      # @return [Context::Store::Entry, nil] The stored entry or nil if not found
-      #
-      def base_object
-        @base_object ||= SpecForge.context.store[stored_id.to_s]
-      end
-    end
-  end
-end

data/lib/spec_forge/backtrace_formatter.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  #
-  # Used internally by RSpec to format backtraces for test failures
-  # Customizes error output to make it more readable and useful for SpecForge
-  #
-  module BacktraceFormatter
-    #
-    # Returns the RSpec backtrace formatter instance
-    # Lazily initializes the formatter on first access
-    #
-    # @return [RSpec::Core::BacktraceFormatter] The backtrace formatter
-    #
-    def self.formatter
-      @formatter ||= RSpec::Core::BacktraceFormatter.new
-    end
-
-    #
-    # Formats a single backtrace line
-    # Delegates to the RSpec formatter
-    #
-    # @param line [String] The backtrace line to format
-    #
-    # @return [String] The formatted backtrace line
-    #
-    def self.backtrace_line(line)
-      formatter.backtrace_line(line)
-    end
-
-    #
-    # Formats a complete backtrace for an example
-    # Adds the YAML location to the front of the backtrace for better context
-    #
-    # @param backtrace [Array<String>] The raw backtrace lines
-    # @param example_metadata [Hash] Metadata about the failing example
-    #
-    # @return [Array<String>] The formatted backtrace with YAML location first
-    #
-    def self.format_backtrace(backtrace, example_metadata)
-      backtrace = SpecForge.backtrace_cleaner.clean(backtrace)
-
-      location = example_metadata[:example_group][:location]
-      line_number = example_metadata[:example_group][:line_number]
-
-      # Add the yaml location to the front so it's the first thing people see
-      ["#{location}:#{line_number}"] + backtrace[0..50]
-    end
-  end
-end

data/lib/spec_forge/callbacks.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  #
-  # Manages user-defined callbacks for test lifecycle events
-  #
-  # This singleton class stores and executes callback functions that
-  # users can register to run at specific points in the test lifecycle.
-  # Each callback receives a context object containing relevant state
-  # information for that point in execution.
-  #
-  # @example Registering and using a callback
-  #   SpecForge::Callbacks.register(:my_callback) do |context|
-  #     puts "Running test: #{context.expectation_name}"
-  #   end
-  #
-  class Callbacks < Hash
-    include Singleton
-
-    class << self
-      #
-      # Registers a new callback for a specific event
-      #
-      # @param name [String, Symbol] The name of the callback event
-      # @param block [Proc] The callback function to execute
-      #
-      # @raise [ArgumentError] If no block is provided
-      #
-      def register(name, &block)
-        raise ArgumentError, "A block must be provided" unless block.is_a?(Proc)
-
-        if registered?(name)
-          warn("Callback #{name.in_quotes} is already registered. It will be overwritten")
-        end
-
-        instance[name.to_s] = block
-      end
-
-      #
-      # Deregisters a callback
-      #
-      # @param name [String, Symbol] The name of the callback
-      #
-      def deregister(name)
-        instance.delete(name.to_s)
-      end
-
-      #
-      # Checks if a callback is registered for the given event
-      #
-      # @param name [String, Symbol] The name of the callback event
-      #
-      # @return [Boolean] True if the callback exists
-      #
-      def registered?(name)
-        instance.key?(name.to_s)
-      end
-
-      #
-      # Returns all registered callback names
-      #
-      # @return [Array<String>] List of registered callback names
-      #
-      def registered_names
-        instance.keys
-      end
-
-      #
-      # Executes a named callback with the provided context
-      #
-      # @param name [String, Symbol] The name of the callback to run
-      # @param context [Object] Context object containing state data
-      #
-      # @raise [ArgumentError] If the callback is not registered
-      #
-      def run(name, context)
-        callback = instance[name.to_s]
-        raise ArgumentError, "Callback #{name.in_quotes} is not defined" if callback.nil?
-
-        if callback.arity == 0
-          callback.call
-        else
-          callback.call(context)
-        end
-      end
-    end
-  end
-end