spec_forge 0.1.0 → 0.3.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spec_forge
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bryan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-01 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -177,8 +177,7 @@ files:
 - 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/configuration.rb
 - lib/spec_forge/error.rb
 - lib/spec_forge/factory.rb
 - lib/spec_forge/http.rb
@@ -187,7 +186,7 @@ files:
 - 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/configuration.rb
 - lib/spec_forge/normalizer/constraint.rb
 - lib/spec_forge/normalizer/expectation.rb
 - lib/spec_forge/normalizer/factory.rb
@@ -199,9 +198,9 @@ files:
 - 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
+- lib/templates/forge_helper.tt
 - spec_forge/factories/user.yml
+- spec_forge/forge_helper.rb
 - spec_forge/specs/users.yml
 homepage: https://github.com/itsthedevman/spec_forge
 licenses:
@@ -220,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/spec_forge/config.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  #
-  # Represents `config.yml`
-  #
-  class Config < Struct.new(:base_url, :authorization, :factories, :environment)
-    #
-    # authorization: {}
-    #
-    class Authorization < Struct.new(:header, :value)
-      attr_predicate :header, :value
-    end
-
-    #
-    # factories: {}
-    #
-    class Factories < Struct.new(:paths, :auto_discover)
-      attr_predicate :paths, :auto_discover
-    end
-
-    #
-    # environment: {}
-    #
-    class Environment < Struct.new(:use, :preload, :models_path)
-      attr_predicate :use, :preload, :models_path
-
-      def initialize(string_or_hash)
-        use, preload, models_path = "", "", ""
-
-        # "rails" or other preset
-        if string_or_hash.is_a?(String)
-          use = string_or_hash
-        else
-          string_or_hash => {use:, preload:, models_path:}
-        end
-
-        super(use:, preload:, models_path:)
-      end
-    end
-
-    ############################################################################
-
-    #
-    # Creates a config with the user's config overlaid on the default
-    #
-    def initialize
-      config = Normalizer.default_config.deep_merge(load_from_file)
-      normalized = Normalizer.normalize_config!(config)
-
-      super(
-        base_url: normalized.delete(:base_url),
-        authorization: transform_authorization(normalized),
-        factories: transform_factories(normalized),
-        environment: transform_environment(normalized)
-      )
-    end
-
-    private
-
-    def load_from_file
-      path = SpecForge.forge.join("config.yml")
-      return unless File.exist?(path)
-
-      erb = ERB.new(File.read(path)).result
-      YAML.safe_load(erb, aliases: true, symbolize_names: true)
-    end
-
-    def transform_authorization(hash)
-      # The intention for authorization hash is to support different authorization schemes
-      # authorization: {default: {}, admin: {}, dev: {}}
-      # But I won't know exactly what will be defined - `to_struct` will handle that.
-      hash[:authorization].transform_values { |v| Authorization.new(**v) }.to_struct
-    end
-
-    def transform_factories(hash)
-      Factories.new(**hash[:factories])
-    end
-
-    def transform_environment(hash)
-      Environment.new(hash[:environment])
-    end
-  end
-end

data/lib/spec_forge/environment.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  class Environment
-    attr_reader :environment, :framework
-
-    #
-    # Creates a new environment loader
-    #
-    # @param environment [Config::Environment] The environment to load
-    #
-    def initialize(environment = SpecForge.config.environment)
-      @environment = environment
-      @framework = environment.use
-    end
-
-    #
-    # Loads the environment
-    #
-    def load
-      load_framework
-      load_preload
-
-      self
-    end
-
-    private
-
-    def load_framework
-      case framework
-      when "rails"
-        load_rails
-      else
-        load_generic
-      end
-    end
-
-    def load_rails
-      path = SpecForge.root.join("config", "environment.rb")
-
-      if File.exist?(path)
-        require path
-      else
-        warn <<~WARNING.chomp
-          SpecForge warning: Config attribute "environment" set to "rails" but Rails environment (config/environment.rb) does not exist.
-          Factories or model-dependent features may not function as expected.
-            - For non-Rails projects, set your environment's 'models_path' or 'preload' in your config.yml
-            - To disable this warning, set 'environment: ""' in your config.yml.
-        WARNING
-      end
-    end
-
-    def load_generic
-      return unless environment.models_path? && environment.models_path.present?
-
-      models_path = SpecForge.root.join(environment.models_path)
-      return if !File.exist?(models_path)
-
-      Dir[models_path.join("**/*.rb")].each { |file| require file }
-    end
-
-    def load_preload
-      return unless environment.preload? && environment.preload.present?
-
-      path = SpecForge.root.join(environment.preload)
-      return if !File.exist?(path)
-
-      require path
-    end
-  end
-end

data/lib/spec_forge/normalizer/config.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-module SpecForge
-  class Normalizer
-    class Config < Normalizer
-      STRUCTURE = {
-        environment: {
-          # Allows for a shorthand:
-          #   environment: rails
-          # Long form:
-          #   environment:
-          #     use: rails
-          type: [String, Hash],
-          default: "rails",
-          structure: {
-            use: {type: String, default: "rails"},
-            preload: {type: String, default: ""},
-            models_path: {
-              type: String,
-              aliases: %i[models],
-              default: ""
-            }
-          }
-        },
-        base_url: {type: String}, # Required
-        authorization: {
-          type: Hash,
-          default: {
-            # Default is a key on this hash
-            default: {}
-          },
-          structure: {
-            default: {
-              type: Hash,
-              structure: {
-                header: {type: String, default: ""},
-                value: {type: String, default: ""}
-              }
-            }
-          }
-        },
-        factories: {
-          type: Hash,
-          default: {},
-          structure: {
-            paths: {
-              type: Array,
-              default: []
-            },
-            auto_discover: {
-              type: [TrueClass, FalseClass],
-              default: true
-            }
-          }
-        }
-      }.freeze
-    end
-
-    # On Normalizer
-    class << self
-      #
-      # Generates an empty config hash
-      #
-      # @return [Hash]
-      #
-      def default_config
-        Config.default
-      end
-
-      #
-      # Normalizes a config hash by standardizing its keys while ensuring the required data
-      # is provided or defaulted.
-      # Raises InvalidStructureError if anything is missing/invalid type
-      #
-      # @param input [Hash] The hash to normalize
-      #
-      # @return [Hash] A normalized hash as a new instance
-      #
-      def normalize_config!(input)
-        raise_errors! do
-          normalize_config(input)
-        end
-      end
-
-      #
-      # Normalize a config hash
-      # Used internally by .normalize_config, but is available for utility
-      #
-      # @param config [Hash] Config representation as a Hash
-      #
-      # @return [Array] Two item array
-      #   First - The normalized hash
-      #   Second - Array of errors, if any
-      #
-      # @private
-      #
-      def normalize_config(config)
-        raise InvalidTypeError.new(config, Hash, for: "config") unless Type.hash?(config)
-
-        Normalizer::Config.new("config", config).normalize
-      end
-    end
-  end
-end

data/lib/templates/config.tt

@@ -1,19 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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