spec_forge 0.7.1 → 1.0.0

data/lib/spec_forge/context/callbacks.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  class Context
-    #
-    # Manages user-defined callbacks grouped by lifecycle hook
-    #
-    # This class collects and organizes callbacks by their hook type
-    # (before_file, after_each, etc.) to support the test lifecycle.
-    # It ensures callbacks are properly categorized for execution.
-    #
-    # @example Creating callback groups
-    #   callbacks = Context::Callbacks.new([
-    #     {before_file: "setup_environment"},
-    #     {after_each: "log_test_result"}
-    #   ])
-    #
-    class Callbacks
-      #
-      # Creates a new callbacks collection
-      #
-      # @param callback_array [Array] Optional initial callbacks to register
-      #
-      # @return [Callbacks] A new callbacks collection
-      #
-      def initialize(callback_array = [])
-        set(callback_array)
-      end
-
-      #
-      # Updates the callbacks collection
-      #
-      # @param callback_array [Array] New callbacks to register
-      #
-      # @return [self]
-      #
-      def set(callback_array)
-        @inner = organize_callbacks_by_hook(callback_array)
-        self
-      end
-
-      #
-      # Returns the hash representation of callbacks
-      #
-      # @return [Hash] Callbacks organized by hook type
-      #
-      def to_h
-        @inner
-      end
-
-      #
-      # Executes all registered callbacks for a specific lifecycle hook
-      #
-      # @param hook_name [String, Symbol] The lifecycle hook (before_file, after_each, etc.)
-      # @param context [Hash] State data that will be converted to a structured object
-      #   and passed to callbacks
-      #
-      def run(hook_name, context = {})
-        context = context.to_struct
-
-        @inner[hook_name].each do |callback_name|
-          SpecForge::Callbacks.run(callback_name, context)
-        end
-      end
-
-      private
-
-      #
-      # Organizes callbacks from an array to hash structure by hook type
-      # Groups callbacks like before_file, after_each, etc. for easier lookup
-      #
-      # @param callback_array [Array] The array of callbacks
-      #
-      # @return [Hash] Callbacks indexed by hook type
-      #
-      # @private
-      #
-      def organize_callbacks_by_hook(callback_array)
-        groups = Hash.new { |h, k| h[k] = Set.new }
-
-        callback_array.each_with_object(groups) do |callbacks, groups|
-          callbacks.each do |hook, name|
-            next if name.blank?
-
-            groups[hook].add(name)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/spec_forge/context/global.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  class Context
-    #
-    # Manages global state and variables at the spec file level.
-    #
-    # The Global class provides access to variables that are defined at the global level
-    # in a spec file and are accessible across all specs and expectations in a file.
-    # Unlike regular variables, global variables do not support overlaying - they maintain
-    # consistent values throughout test execution.
-    #
-    # @example Basic usage
-    #   global = Global.new(variables: {api_version: "v2", environment: "test"})
-    #
-    #   global.variables[:api_version] #=> "v2"
-    #   global.variables[:environment] #=> "test"
-    #
-    #   # Update global variables
-    #   global.set(variables: {environment: "staging"})
-    #   global.variables[:environment] #=> "staging"
-    #   global.variables[:api_version] #=> nil
-    #
-    class Global
-      # @return [Context::Variables] The container for global variables
-      attr_reader :variables
-
-      # @return [Context::Callbacks] The container for callbacks
-      attr_reader :callbacks
-
-      #
-      # Creates a new Global context instance
-      #
-      # @param variables [Hash<Symbol, Object>] A hash of variable names and values
-      # @param callbacks [Array<Hash<Symbol, String>>] An array of callback hooks
-      #
-      # @return [Global] The new Global instance
-      #
-      def initialize(variables: {}, callbacks: [])
-        @variables = Variables.new(base: variables)
-        @callbacks = Callbacks.new(callbacks)
-      end
-
-      #
-      # Sets the global variables
-      #
-      # @param variables [Hash<Symbol, Object>] A hash of variable names and values
-      # @param callbacks [Array<Hash<Symbol, String>>] An array of callback hooks
-      #
-      # @return [self]
-      #
-      def set(variables: {}, callbacks: [])
-        @variables.set(base: variables)
-        @callbacks.set(callbacks)
-
-        self
-      end
-
-      #
-      # Returns a hash representation of the global context
-      #
-      # @return [Hash]
-      #
-      def to_h
-        {
-          variables: variables.to_h,
-          callbacks: callbacks.to_h
-        }
-      end
-    end
-  end
-end

data/lib/spec_forge/context/store.rb

@@ -1,131 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  class Context
-    #
-    # Manages storage of API responses for use in subsequent tests
-    #
-    # This class provides a mechanism to store HTTP requests and responses
-    # during test execution, allowing values to be referenced in later tests
-    # through the `store.id.body.attribute` syntax.
-    #
-    # @example Storing and retrieving a response in specs
-    #   # In one expectation:
-    #   store_as: user_creation
-    #
-    #   # In a later test:
-    #   query:
-    #     id: store.user_creation.body.id
-    #
-    class Store
-      #
-      # Represents a stored entry containing arbitrary data from test execution
-      #
-      # Entries are created during test execution to store custom data that can be
-      # accessed in subsequent tests. Unlike the original rigid Data structure, this
-      # OpenStruct-based approach allows storing any key-value pairs, making it perfect
-      # for complex test scenarios that need custom configuration, metadata, or
-      # computed values.
-      #
-      # @example Storing custom configuration data
-      #   SpecForge.context.store.set(
-      #     "app_config",
-      #     api_version: "v2.1",
-      #     feature_flags: { advanced_search: true }
-      #   )
-      #
-      # @example Accessing stored data in tests
-      #   headers:
-      #     X-API-Version: store.app_config.api_version
-      #   query:
-      #     search_enabled: store.app_config.feature_flags.advanced_search
-      #
-      class Entry < OpenStruct
-        #
-        # Creates a new store entry
-        #
-        # @param scope [Symbol] Scope of this entry, either :file or :spec
-        #
-        # @return [Entry] A new entry instance
-        #
-        def initialize(scope: :file, **)
-          super
-        end
-
-        #
-        # Returns all available methods that can be called
-        #
-        # @return [Array] The method names
-        #
-        def available_methods
-          @table.keys
-        end
-      end
-
-      #
-      # Creates a new empty store
-      #
-      # @return [Store] A new store instance
-      #
-      def initialize
-        @inner = {}
-      end
-
-      #
-      # Retrieves a stored entry by ID
-      #
-      # @param id [String, Symbol] The identifier for the stored entry
-      #
-      # @return [Entry, nil] The stored entry or nil if not found
-      #
-      def [](id)
-        @inner[id]
-      end
-
-      #
-      # Returns the number of entries in the store
-      #
-      # @return [Integer] The count of stored entries
-      #
-      def size
-        @inner.size
-      end
-
-      #
-      # Stores an entry with the specified ID
-      #
-      # @param id [String, Symbol] The identifier to store the entry under
-      #
-      # @return [self]
-      #
-      def set(id, **)
-        @inner[id] = Entry.new(**)
-
-        self
-      end
-
-      #
-      # Removes all entries from the store
-      #
-      def clear
-        @inner.clear
-      end
-
-      #
-      # Removes all spec entries from the store
-      #
-      def clear_specs
-        @inner.delete_if { |_k, v| v.scope == :spec }
-      end
-
-      #
-      # Returns a hash representation of store
-      #
-      # @return [Hash]
-      #
-      def to_h
-        @inner.transform_values(&:to_h).deep_stringify_keys
-      end
-    end
-  end
-end

data/lib/spec_forge/context/variables.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  class Context
-    #
-    # Manages variable resolution across different expectations in SpecForge tests.
-    #
-    # The Variables class handles two layers of variable definitions:
-    #   - Base variables: The core set of variables defined at the spec level
-    #   - Overlay variables: Additional variables defined at the expectation level
-    #       that can override base variables with the same name.
-    #
-    # @example Basic usage
-    #   variables = Variables.new(
-    #     base: {user_id: 123, name: "Test User"},
-    #     overlay: {
-    #       "expectation_1": {name: "Override User"}
-    #     }
-    #   )
-    #
-    #   variables[:user_id] #=> 123
-    #   variables[:name]    #=> "Test User"
-    #
-    #   variables.use_overlay("expectation_1")
-    #   variables[:name]    #=> "Override User"
-    #   variables[:user_id] #=> 123 (unchanged)
-    #
-    class Variables < Hash
-      attr_reader :base, :overlay
-
-      #
-      # Creates a new Variables container with base and overlay definitions
-      #
-      # @param base [Hash] The base set of variables (typically defined at spec level)
-      # @param overlay [Hash<String, Hash>] A hash of overlay variable sets keyed by ID
-      #
-      # @return [Variables]
-      #
-      def initialize(base: {}, overlay: {})
-        set(base:, overlay:)
-      end
-
-      #
-      # Sets the base and overlay variable hashes
-      #
-      # @param base [Hash] The new base variable hash
-      # @param overlay [Hash<String, Hash>] The new overlay variable hashes
-      #
-      # @return [self]
-      #
-      def set(base:, overlay: {})
-        @base = Attribute.from(base)
-        @overlay = overlay
-
-        resolve_into_self(@base)
-        self
-      end
-
-      #
-      # Applies a specific overlay to the base variables
-      # If the overlay doesn't exist or is empty, no changes are made.
-      #
-      # @param id [String] The ID of the overlay to apply
-      #
-      # @return [nil]
-      #
-      def use_overlay(id)
-        active = @base
-
-        if (overlay = @overlay[id]) && overlay.present?
-          active = active.deep_merge(overlay)
-        end
-
-        resolve_into_self(active)
-        self
-      end
-
-      private
-
-      def resolve_into_self(hash)
-        # Start fresh
-        clear
-
-        # Load the resolved values into self
-        hash.each do |key, value|
-          self[key] = Attribute.from(value).resolved
-        end
-      end
-    end
-  end
-end

data/lib/spec_forge/context.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  #
-  # Core data structure that maintains context during test execution
-  #
-  # Context stores and provides access to global variables, test variables, and
-  # shared state across specs.
-  # It acts as a central repository for test data during execution.
-  #
-  # @example Accessing the current context
-  #   SpecForge.context.variables[:user_id] #=> 123
-  #
-  class Context < Data.define(:global, :store, :variables)
-    #
-    # Creates a new context with default values
-    #
-    # @param global [Hash] Global variables shared across all specs
-    # @param variables [Hash] Test variables specific to the current context
-    #
-    # @return [Context] A new context instance
-    #
-    def initialize(global: {}, variables: {})
-      super(
-        global: Global.new(**global),
-        store: Store.new,
-        variables: Variables.new(**variables)
-      )
-    end
-  end
-end
-
-require_relative "context/callbacks"
-require_relative "context/global"
-require_relative "context/store"
-require_relative "context/variables"

data/lib/spec_forge/core_ext/rspec.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-return if defined?(SPEC_FORGE_INTERNAL_TESTING)
-
-#
-# RSpec's core testing framework module
-# Provides the fundamental structure and functionality for RSpec tests
-#
-module RSpec
-  #
-  # Core implementation details and extensions for RSpec
-  # Contains the fundamental building blocks of the RSpec testing framework
-  #
-  module Core
-    #
-    # Handles notifications and reporting for RSpec test runs
-    # Manages how test results and metadata are processed and communicated
-    #
-    module Notifications
-      #
-      # A monkey patch of an internal RSpec class to allow SpecForge to replace parts of
-      # RSpec's reporting output in order to provide useful feedback to the user.
-      # This replaces "rspec" in commands with "spec_forge", removes any line numbers, and
-      # ensures that failures properly report the YAML file that it occurred in.
-      #
-      class SummaryNotification
-        #
-        # Create an alias to RSpec original colorized_rerun_commands so it can be called at a
-        # later point.
-        #
-        alias_method :og_colorized_rerun_commands, :colorized_rerun_commands
-
-        # Customizes RSpec's failure output to:
-        # 1. Use 'spec_forge' instead of 'rspec' for rerun commands
-        # 2. Remove line numbers since SpecForge uses dynamic spec generation
-        def colorized_rerun_commands(colorizer)
-          # Updating these at this point fixes the re-run for some failures - it depends
-          failed_examples.each do |example|
-            metadata = example.metadata[:example_group]
-
-            # I might've uncovered an inconsistency here
-            # When multiple specs fail, it appears that the rerun_commands will use
-            # :rerun_file_path from the example's metadata.
-            # But when a single spec is ran and fails, it's using :location.
-            example.metadata[:location] = metadata[:rerun_file_path]
-            example.metadata[:line_number] = metadata[:line_number]
-          end
-
-          og_colorized_rerun_commands.gsub(/rspec/i, "spec_forge")
-            .gsub(/\[[\d:]+\]/, "")
-        end
-      end
-    end
-  end
-end

data/lib/spec_forge/core_ext.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-Dir[File.expand_path("core_ext/*.rb", __dir__)].sort.each do |path|
-  require path
-end

data/lib/spec_forge/documentation/generators/base.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  module Documentation
-    module Generators
-      #
-      # Base class for all documentation generators
-      #
-      # Provides the common interface and shared functionality for generators
-      # that transform SpecForge documents into various output formats.
-      # Subclasses implement format-specific generation logic.
-      #
-      # @example Creating a custom generator
-      #   class MyGenerator < Base
-      #     def generate
-      #       # Transform input document to custom format
-      #     end
-      #   end
-      #
-      class Base
-        #
-        # Generates documentation from test data with optional caching
-        #
-        # @param use_cache [Boolean] Whether to use cached test data if available
-        #
-        # @return [Object] The generated documentation in the target format
-        #
-        # @raise [RuntimeError] Must be implemented by subclasses
-        #
-        def self.generate(use_cache: false)
-          raise "not implemented"
-        end
-
-        #
-        # Validates the generated output according to format specifications
-        #
-        # @param input [Object] The generated documentation to validate
-        #
-        # @return [void]
-        #
-        # @raise [RuntimeError] Must be implemented by subclasses
-        #
-        def self.validate!(input)
-          raise "not implemented"
-        end
-
-        #
-        # The input document containing structured API data
-        #
-        # Contains all the endpoint information extracted from tests,
-        # organized and ready for transformation into the target format.
-        #
-        # @return [Document] The document to be processed by the generator
-        #
-        attr_reader :input
-
-        #
-        # Initializes a new generators
-        #
-        # @param input [Hash, Document] The document to generate
-        #
-        # @return [Base] A new generator instance
-        #
-        def initialize(input = {})
-          @input = input
-        end
-
-        #
-        # Generates the document into a specific format
-        #
-        # @raise [RuntimeError] Must be implemented by subclasses
-        #
-        # @return [Object] The generated document
-        #
-        def generate
-          raise "not implemented"
-        end
-      end
-    end
-  end
-end

data/lib/spec_forge/documentation/generators/openapi/base.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  module Documentation
-    module Generators
-      module OpenAPI
-        #
-        # Base class for OpenAPI generators
-        #
-        # Provides common functionality for OpenAPI generators of different versions.
-        #
-        class Base < Generators::Base
-          #
-          # Converts the generator's version to a semantic version object
-          #
-          # @return [SemVersion] The semantic version
-          #
-          def self.to_sem_version
-            SemVersion.new(CURRENT_VERSION)
-          end
-
-          #
-          # Generates OpenAPI documentation from test data with optional caching
-          #
-          # Loads endpoint data from tests (either fresh or cached), creates a document,
-          # and generates the OpenAPI specification using the appropriate version generator.
-          #
-          # @param use_cache [Boolean] Whether to use cached test data if available
-          #
-          # @return [Hash] The generated OpenAPI specification
-          #
-          def self.generate(use_cache: false)
-            document = Documentation::Loader.load_document(use_cache:)
-            new(document).generate
-          end
-
-          #
-          # Validates an OpenAPI specification against the standard
-          #
-          # Uses the openapi3_parser gem to validate the generated specification
-          # and provides detailed error reporting if validation fails.
-          #
-          # @param output [Hash] The OpenAPI specification to validate
-          #
-          # @return [void]
-          #
-          # @raise [Error::InvalidOASDocument] If the specification is invalid
-          #
-          def self.validate!(output)
-            document = Openapi3Parser.load(output)
-            if document.valid?
-              puts "✅ No validation errors found!"
-              return
-            end
-
-            puts ErrorFormatter.format(document.errors.errors)
-            raise Error::InvalidOASDocument
-          end
-
-          protected
-
-          #
-          # Loads OpenAPI configuration from YAML
-          #
-          # @return [Hash] The normalized OpenAPI configuration
-          #
-          # @api private
-          #
-          def config
-            @config ||= begin
-              file_extension_glob = "*.{yml,yaml}"
-              base_path = SpecForge.openapi_path.join("config")
-
-              root_paths = base_path.join(file_extension_glob)
-              path_paths = base_path.join("paths", "**", file_extension_glob)
-              component_paths = base_path.join("components", "**", file_extension_glob)
-
-              config = load_yml_from_paths(root_paths).to_merged_h
-              paths_config = load_yml_from_paths(path_paths).to_merged_h
-              component_config = load_yml_from_paths(component_paths).to_merged_h
-
-              (config["paths"] ||= {}).deep_merge!(paths_config)
-              (config["components"] ||= {}).deep_merge!(component_config)
-
-              config
-            end
-          end
-
-          private
-
-          def load_yml_from_paths(paths)
-            Dir[paths].map do |path|
-              YAML.safe_load_file(path)
-            end
-          end
-        end
-      end
-    end
-  end
-end