spec_forge 0.1.0

data/lib/spec_forge/spec/expectation/constraint.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module SpecForge
+  class Spec
+    class Expectation
+      #
+      # Represents the "expect" hash
+      #
+      class Constraint < Data.define(:status, :json) # :xml, :html
+        #
+        # Creates a new Constraint
+        #
+        # @param status [Integer] The expected HTTP status code
+        # @param json [Hash] The expected JSON with matchers
+        #
+        def initialize(status:, json:)
+          super(status:, json: normalize_hash(json))
+        end
+
+        def resolve
+          {
+            status: status.resolve,
+            json: json.resolve.deep_stringify_keys
+          }
+        end
+
+        private
+
+        def normalize_hash(hash)
+          hash =
+            hash.transform_values do |attribute|
+              if attribute.is_a?(Attribute::Literal)
+                normalize_literal(attribute.value)
+              else
+                attribute
+              end
+            end
+
+          Attribute.from(hash)
+        end
+
+        def normalize_literal(value)
+          if value.is_a?(Regexp)
+            Attribute.from("matcher.match" => value)
+          else
+            Attribute.from("matcher.eq" => value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spec_forge/spec/expectation.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "expectation/constraint"
+
+module SpecForge
+  class Spec
+    class Expectation
+      attr_reader :name, :variables, :constraints, :http_client
+
+      #
+      # Creates a new Expectation
+      #
+      # @param input [Hash] A hash containing the various attributes to control the expectation
+      # @param name [String] The name of the expectation
+      #
+      def initialize(name, input, global_options: {})
+        load_name(name, input)
+
+        # This allows defining spec level attributes that can be overwritten by the expectation
+        input = Attribute.from(overlay_options(global_options, input))
+
+        load_variables(input)
+
+        # Must be after load_variables
+        load_constraints(input)
+
+        # Must be last
+        @http_client = HTTP::Client.new(variables:, **input.except(:name, :variables, :expect))
+      end
+
+      private
+
+      def overlay_options(source, overlay)
+        # Remove any blank values to avoid overwriting anything from source
+        overlay = overlay.delete_if { |_k, v| v.blank? }
+        source.deep_merge(overlay)
+      end
+
+      def load_name(name, input)
+        @name = input[:name].presence || name
+      end
+
+      def load_variables(input)
+        @variables = Attribute.bind_variables(input[:variables], input[:variables])
+      end
+
+      def load_constraints(input)
+        constraints = Attribute.bind_variables(input[:expect], variables)
+        @constraints = Constraint.new(**constraints)
+      end
+    end
+  end
+end

data/lib/spec_forge/spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "spec/expectation"
+
+module SpecForge
+  class Spec
+    #
+    # Loads the specs from their yml files and runs them
+    #
+    # @param path [String, Path] The base path where the specs directory is located
+    #
+    def self.load_and_run(base_path)
+      specs = load_from_path(base_path.join("specs", "**/*.yml"))
+      specs.each(&:run)
+    end
+
+    #
+    # Loads any specs defined in the path. A single file can contain one or more specs
+    #
+    # @param path [String, Path] The path where the specs are located
+    #
+    # @return [Array<Spec>] An array of specs that were loaded.
+    #
+    def self.load_from_path(path)
+      specs = []
+
+      Dir[path].map do |file_path|
+        hash = YAML.load_file(file_path).deep_symbolize_keys
+
+        hash.each do |spec_name, spec_hash|
+          spec_hash[:name] = spec_name
+          spec_hash[:file_path] = file_path
+
+          specs << new(**spec_hash)
+        end
+      end
+
+      specs
+    end
+
+    ############################################################################
+
+    attr_reader :name, :file_path, :expectations
+
+    #
+    # Creates a Spec based on the input
+    #
+    # @param name [String] The identifier for this spec
+    # @param file_path [String] The path where this spec is defined
+    # @param **input [Hash] Any attributes related to the spec, including expectations
+    #   See Normalizer::Spec
+    #
+    def initialize(name:, file_path:, **input)
+      @name = name
+      @file_path = file_path
+
+      input = Normalizer.normalize_spec!(input)
+      global_options = input.except(:expectations)
+
+      @expectations =
+        input[:expectations].map.with_index do |expectation_input, index|
+          Expectation.new(
+            "expectations (item #{index})",
+            expectation_input,
+            global_options:
+          )
+        end
+    end
+
+    #
+    # Runs the spec
+    #
+    def run
+      Runner.new(self).run
+    end
+  end
+end

data/lib/spec_forge/type.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SpecForge
+  module Type
+    #
+    # Checks if the object is a Hash, or a ResolvableHash (delegator)
+    #
+    # @param object [Object] The object to check
+    #
+    # @return [Boolean]
+    #
+    def self.hash?(object)
+      object.is_a?(Hash) || object.is_a?(Attribute::ResolvableHash)
+    end
+
+    #
+    # Checks if the object is an Array, or a ResolvableArray (delegator)
+    #
+    # @param object [Object] The object to check
+    #
+    # @return [Boolean]
+    #
+    def self.array?(object)
+      object.is_a?(Array) || object.is_a?(Attribute::ResolvableArray)
+    end
+  end
+end
+
+#
+# Represents Hash/ResolvableHash in a form that can be used in a case statement
+#
+class HashLike
+  def self.===(object)
+    SpecForge::Type.hash?(object)
+  end
+end
+
+#
+# Represents Array/ResolvableArray in a form that can be used in a case statement
+#
+class ArrayLike
+  def self.===(object)
+    SpecForge::Type.array?(object)
+  end
+end

data/lib/spec_forge/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SpecForge
+  VERSION = "0.1.0"
+end

data/lib/spec_forge.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "logger"
+require "active_support"
+require "active_support/core_ext"
+require "commander"
+require "everythingrb"
+require "factory_bot"
+require "faker"
+require "faraday"
+require "mime/types"
+require "pathname"
+require "rspec"
+require "singleton"
+require "thor"
+require "yaml"
+
+require_relative "spec_forge/attribute"
+require_relative "spec_forge/cli"
+require_relative "spec_forge/config"
+require_relative "spec_forge/environment"
+require_relative "spec_forge/error"
+require_relative "spec_forge/factory"
+require_relative "spec_forge/http"
+require_relative "spec_forge/normalizer"
+require_relative "spec_forge/runner"
+require_relative "spec_forge/spec"
+require_relative "spec_forge/type"
+require_relative "spec_forge/version"
+
+module SpecForge
+  #
+  # Loads all factories and specs located in "path", then runs all of the specs
+  #
+  # @param path [String] The file path that contains factories and specs
+  #
+  def self.run(path = SpecForge.forge)
+    SpecForge.environment.load
+
+    Factory.load_and_register(path)
+    Spec.load_and_run(path)
+  end
+
+  #
+  # Returns the directory root for the working directory
+  #
+  # @return [Pathname]
+  #
+  def self.root
+    @root ||= Pathname.pwd
+  end
+
+  #
+  # Returns SpecForge's working directory
+  #
+  # @return [Pathname]
+  #
+  def self.forge
+    @forge ||= root.join("spec_forge")
+  end
+
+  #
+  # Returns SpecForge's config
+  #
+  # @return [Config]
+  #
+  def self.config
+    @config ||= Config.new
+  end
+
+  #
+  # Returns a backtrace cleaner configured for SpecForge
+  #
+  # @return [ActiveSupport::BacktraceCleaner]
+  #
+  def self.backtrace_cleaner
+    @backtrace_cleaner ||= begin
+      root = "#{SpecForge.root}/"
+
+      cleaner = ActiveSupport::BacktraceCleaner.new
+      cleaner.add_filter { |line| line.delete_prefix(root) }
+      cleaner.add_silencer { |line| /rubygems|backtrace_cleaner/.match?(line) }
+      cleaner
+    end
+  end
+
+  def self.environment
+    @environment ||= Environment.new
+  end
+end

data/lib/templates/config.tt

@@ -0,0 +1,19 @@
+# Sets the base URL prefix for all API requests. All test paths will be appended to this URL.
+base_url: http://localhost:3000
+
+# Configures the global authorization header and value for API requests.
+authorization:
+  default:
+    header: Authorization
+    value: <%= default_authorization_value %>
+
+factories:
+  ## Optional: Overrides default FactoryBot definition paths for discovering factories
+  ## By default, FactoryBot will look in "spec/factories" and "test/factories"
+  # paths:
+  # - custom/factories/path
+
+  ## Optional: Enable/disable automatic factory discovery, default: true
+  ## Note: Disabling auto discovery will only disable FactoryBot's auto discovery. Any factories
+  ## defined in "spec_forge/factories" will still be loaded.
+  # auto_discover: false

data/spec_forge/config.yml

@@ -0,0 +1,19 @@
+# Sets the base URL prefix for all API requests. All test paths will be appended to this URL.
+base_url: http://localhost:3000
+
+# Configures the global authorization header and value for API requests.
+authorization:
+  default:
+    header: Authorization
+    value: Bearer <%= ENV.fetch("API_TOKEN", "") %>
+
+factories:
+  ## Optional: Overrides default FactoryBot definition paths for discovering factories
+  ## By default, FactoryBot will look in "spec/factories" and "test/factories"
+  # paths:
+  # - custom/factories/path
+
+  ## Optional: Enable/disable automatic factory discovery, default: true
+  ## Note: Disabling auto discovery will only disable FactoryBot's auto discovery. Any factories
+  ## defined in "spec_forge/factories" will still be loaded.
+  # auto_discover: false

data/spec_forge/factories/user.yml

@@ -0,0 +1,4 @@
+user:
+  class: User
+  attributes:
+    attribute: value

data/spec_forge/specs/users.yml

@@ -0,0 +1,63 @@
+index_users:
+  url: /users
+  expectations:
+  - expect:
+      status: 200
+
+show_user:
+  url: /users/{id}
+  expectations:
+  - expect:
+      status: 404
+  - expect:
+      status: 200
+      json:
+        name: kind_of.string
+        email: /\w+@example\.com/i
+    query:
+      id: 1
+
+create_user:
+  url: /users
+  method: post
+  expectations:
+  - expect:
+      status: 400
+  - expect:
+      status: 200
+      json:
+        name: variables.name
+        role: variables.role
+    variables:
+      name: faker.name.name
+      role: user
+    body:
+      name: variables.name
+
+update_user:
+  url: /users/{id}
+  method: patch
+  query:
+    id: 1
+  variables:
+    number:
+      faker.number.between:
+        from: 100000
+        to: 999999
+  expectations:
+  - expect:
+      status: 200
+      json:
+        name: kind_of.string
+        number: kind_of.integer
+    body:
+      number: variables.number
+
+destroy_user:
+  url: /users/{id}
+  method: delete
+  query:
+    id: 1
+  expectations:
+  - expect:
+      status: 200

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: spec_forge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: everythingrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+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
+  test suite.
+email:
+- bryan@itsthedevman.com
+executables:
+- spec_forge
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/spec_forge
+- flake.lock
+- flake.nix
+- lib/spec_forge.rb
+- lib/spec_forge/attribute.rb
+- lib/spec_forge/attribute/chainable.rb
+- lib/spec_forge/attribute/factory.rb
+- lib/spec_forge/attribute/faker.rb
+- lib/spec_forge/attribute/literal.rb
+- lib/spec_forge/attribute/matcher.rb
+- lib/spec_forge/attribute/parameterized.rb
+- lib/spec_forge/attribute/resolvable.rb
+- lib/spec_forge/attribute/resolvable_array.rb
+- lib/spec_forge/attribute/resolvable_hash.rb
+- lib/spec_forge/attribute/transform.rb
+- lib/spec_forge/attribute/variable.rb
+- lib/spec_forge/cli.rb
+- lib/spec_forge/cli/actions.rb
+- lib/spec_forge/cli/command.rb
+- lib/spec_forge/cli/init.rb
+- lib/spec_forge/cli/new.rb
+- lib/spec_forge/cli/run.rb
+- lib/spec_forge/config.rb
+- lib/spec_forge/environment.rb
+- lib/spec_forge/error.rb
+- lib/spec_forge/factory.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/normalizer.rb
+- lib/spec_forge/normalizer/config.rb
+- lib/spec_forge/normalizer/constraint.rb
+- lib/spec_forge/normalizer/expectation.rb
+- lib/spec_forge/normalizer/factory.rb
+- lib/spec_forge/normalizer/factory_reference.rb
+- lib/spec_forge/normalizer/spec.rb
+- lib/spec_forge/runner.rb
+- lib/spec_forge/spec.rb
+- lib/spec_forge/spec/expectation.rb
+- lib/spec_forge/spec/expectation/constraint.rb
+- lib/spec_forge/type.rb
+- lib/spec_forge/version.rb
+- lib/templates/config.tt
+- spec_forge/config.yml
+- spec_forge/factories/user.yml
+- spec_forge/specs/users.yml
+homepage: https://github.com/itsthedevman/spec_forge
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/itsthedevman/spec_forge
+  changelog_uri: https://github.com/itsthedevman/spec_forge/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/itsthedevman/spec_forge/issues
+  documentation_uri: https://github.com/itsthedevman/spec_forge#readme
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Write expressive API tests in YAML with the power of RSpec matchers
+test_files: []