fixturama 0.1.0 → 0.2.0

data/lib/fixturama/changes/chain/raise_action.rb

@@ -0,0 +1,35 @@
+class Fixturama::Changes::Chain
+  #
+  # @private
+  # Raise a specified exception as a result of stubbing
+  #
+  class RaiseAction
+    attr_reader :repeat
+
+    def call
+      raise @error
+    end
+
+    private
+
+    def initialize(**options)
+      @error  = error_from options
+      @repeat = repeat_from options
+    end
+
+    def error_from(options)
+      case value = options[:raise]
+      when NilClass, TrueClass, "true" then StandardError
+      when Class then value < Exception ? value : raise("Not an exception")
+      else Kernel.const_get(value)
+      end
+    rescue StandardError => err
+      raise Fixturama::FixtureError.new("an exception class", options, err)
+    end
+
+    def repeat_from(options)
+      options.fetch(:repeat, 1).to_i.tap { |val| return val if val.positive? }
+      raise Fixturama::FixtureError.new("a number of repeats", options)
+    end
+  end
+end

data/lib/fixturama/changes/chain/return_action.rb

@@ -0,0 +1,33 @@
+class Fixturama::Changes::Chain
+  #
+  # @private
+  # Return a specified value as a result of stubbing
+  #
+  class ReturnAction
+    attr_reader :repeat
+
+    def call
+      @value
+    end
+
+    private
+
+    def initialize(**options)
+      @value  = value_from(options)
+      @repeat = repeat_from(options)
+    end
+
+    def value_from(options)
+      value = options[:return]
+      value.respond_to?(:dup) ? value.dup : value
+    rescue TypeError
+      # in the Ruby 2.3.0 Fixnum#dup is defined, but raises TypeError
+      value
+    end
+
+    def repeat_from(options)
+      options.fetch(:repeat, 1).to_i.tap { |val| return val if val.positive? }
+      raise Fixturama::FixtureError.new("a number of repeats", options)
+    end
+  end
+end

data/lib/fixturama/changes/const.rb

@@ -0,0 +1,30 @@
+class Fixturama::Changes
+  #
+  # @private
+  # Stub a constant
+  #
+  class Const < Base
+    def key
+      name
+    end
+
+    def call(example)
+      example.send(:stub_const, name, value)
+      self
+    end
+
+    private
+
+    def initialize(**options)
+      @options = options
+    end
+
+    def name
+      @options[:const]
+    end
+
+    def value
+      @options[:value]
+    end
+  end
+end

data/lib/fixturama/changes/request.rb

@@ -0,0 +1,91 @@
+class Fixturama::Changes
+  #
+  # @private
+  # Stub an HTTP(S) request using +Webmock+
+  #
+  class Request < Base
+    require_relative "request/response"
+    require_relative "request/responses"
+
+    def call(example)
+      stub = example.stub_request(http_method, uri)
+      stub = stub.with(request) if request.any?
+      stub.to_return { |_| responses.next }
+      self
+    end
+
+    private
+
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+      with_error { @options = Hash(@options).transform_keys(&:to_sym) }
+    end
+
+    HTTP_METHODS = %i[get post put patch delete head options any].freeze
+
+    def http_method
+      with_error("http method") do
+        value = with_error("method") { options[:method]&.to_sym&.downcase }
+        value ||= :any
+        raise("Invalid HTTP method") unless HTTP_METHODS.include?(value)
+        value
+      end
+    end
+
+    def uri
+      with_error("uri") { maybe_regexp(options[:uri] || options[:url]) }
+    end
+
+    def headers
+      with_error("headers") do
+        Hash(options[:headers]).transform_keys(&:to_s) if options.key? :headers
+      end
+    end
+
+    def query
+      with_error("query") do
+        Hash(options[:query]).transform_keys(&:to_s) if options.key?(:query)
+      end
+    end
+
+    def body
+      with_error("body") { maybe_regexp options[:body] }
+    end
+
+    def basic_auth
+      with_error("basic auth") do
+        value = options[:auth] || options[:basic_auth]
+        Hash(value).transform_keys(&:to_s).values_at("user", "pass") if value
+      end
+    end
+
+    def request
+      @request ||= {
+        headers: headers,
+        body: body,
+        query: query,
+        basic_auth: basic_auth
+      }.select { |_, val| val }
+    end
+
+    def responses
+      @responses ||= Responses.new(options[:response] || options[:responses])
+    end
+
+    def with_error(part = nil)
+      yield
+    rescue StandardError => err
+      part = ["a valid request", part].compact.join(" ")
+      raise Fixturama::FixtureError.new(part, options, err)
+    end
+
+    def maybe_regexp(str)
+      return unless str
+
+      str = str.to_s
+      str[%r{\A/.*/\z}] ? Regexp.new(str[1..-2]) : str
+    end
+  end
+end

data/lib/fixturama/changes/request/response.rb

@@ -0,0 +1,62 @@
+class Fixturama::Changes::Request
+  #
+  # @private
+  # Store data for a response to the corresponding request
+  #
+  class Response
+    # @!attribute [r] repeat A number of times the response to be repeated
+    # @return [Integer]
+    attr_reader :repeat
+
+    # @!attribute [r] to_h A hash for the +to_respond(...)+ part of the stub
+    # @return [Hash<Symbol, Object>]
+    attr_reader :to_h
+
+    private
+
+    def initialize(options)
+      @options = options
+      @options = with_error { Hash(options).transform_keys(&:to_sym) }
+      @to_h    = build_hash
+      @repeat  = build_repeat
+    end
+
+    def build_repeat
+      with_error("number of repeats") do
+        value = @options.fetch(:repeat, 1).to_i
+        value.positive? ? value : raise("Wrong value")
+      end
+    end
+
+    def build_hash
+      { status: status, body: body, headers: headers }.select { |_, v| v }
+    end
+
+    def status
+      with_error("status") { @options[:status]&.to_i } || 200
+    end
+
+    def body
+      with_error("body") do
+        case @options[:body]
+        when NilClass then nil
+        when Hash then JSON.dump(@options[:body])
+        else @options[:body].to_s
+        end
+      end
+    end
+
+    def headers
+      with_error("headers") do
+        Hash(@options[:headers]).map { |k, v| [k.to_s, v.to_s] }.to_h
+      end
+    end
+
+    def with_error(part = nil)
+      yield
+    rescue StandardError => err
+      object = ["a response", part].compact.join(" ")
+      raise Fixturama::FixtureError.new(object, options, err)
+    end
+  end
+end

data/lib/fixturama/changes/request/responses.rb

@@ -0,0 +1,22 @@
+class Fixturama::Changes::Request
+  #
+  # @private
+  # Iterate by a consecutive responses to the request
+  #
+  class Responses
+    # @return [Fixturama::Changes::Request::Response]
+    def next
+      @list.count > 1 ? @list.pop : @list.first
+    end
+
+    private
+
+    def initialize(*list)
+      list = [{ status: 200 }] if list.empty?
+      @list = list.flatten.reverse.flat_map do |item|
+        response = Response.new(item)
+        [response.to_h] * response.repeat
+      end
+    end
+  end
+end

data/lib/fixturama/changes/seed.rb

@@ -0,0 +1,39 @@
+class Fixturama::Changes
+  #
+  # @private
+  # Seed objects using the +FactoryBot+
+  #
+  class Seed < Base
+    private
+
+    def initialize(**options)
+      @type   = type_from(options)
+      @traits = traits_from(options)
+      @params = params_from(options)
+      @count  = count_from(options)
+      create_object
+    end
+
+    def type_from(options)
+      options[:type]&.to_sym&.tap { |value| return value }
+      raise Fixturama::FixtureError.new("a factory", options)
+    end
+
+    def traits_from(options)
+      Array(options[:traits]).map(&:to_sym)
+    end
+
+    def params_from(options)
+      Hash(options[:params]).transform_keys(&:to_sym)
+    end
+
+    def count_from(options)
+      options.fetch(:count, 1).to_i.tap { |val| return val if val.positive? }
+      raise Fixturama::FixtureError.new("a valid number of objects", options)
+    end
+
+    def create_object
+      FactoryBot.create_list(@type, @count, *@traits, **@params)
+    end
+  end
+end

data/lib/fixturama/config.rb

@@ -1,3 +1,8 @@
+#
+# @private
+# Configures the gem to exclude conflicts between
+# ids auto-generated by database and hardcoded in fixtures
+#
 module Fixturama::Config
   module_function
 

data/lib/fixturama/fixture_error.rb

@@ -0,0 +1,31 @@
+#
+# The exception complaining about invalid definition in some fixture
+#
+class Fixturama::FixtureError < ArgumentError
+  # The error message
+  # @return [String]
+  def message
+    <<~MESSAGE
+      Cannot infer #{@object} from the following part of the fixture #{@file}:
+      #{@data}
+    MESSAGE
+  end
+
+  # @private
+  # Add reference to the path of the fixture file
+  # @param [String] file
+  # @return [self]
+  def with_file(file)
+    @file = file
+    self
+  end
+
+  private
+
+  def initialize(object, data, _cause = nil)
+    @object = object
+    @data = YAML.dump(data)
+
+    super message
+  end
+end

data/lib/fixturama/loader.rb

@@ -1,4 +1,5 @@
 #
+# @private
 # Load fixture with some options
 #
 class Fixturama::Loader

data/lib/fixturama/loader/context.rb

@@ -1,5 +1,6 @@
 class Fixturama::Loader
   #
+  # @private
   # The context of some fixture
   #
   class Context

data/lib/fixturama/loader/value.rb

@@ -1,5 +1,6 @@
 class Fixturama::Loader
   #
+  # @private
   # Wraps a value with a reference to its key
   # in the [Fixturama::Loader::Context]
   #

data/spec/fixturama/seed_fixture/_spec.rb

@@ -26,6 +26,7 @@ RSpec.describe "seed_fixture" do
 
   it "runs the factory", aggregate_failures: true do
     expect(FactoryBot).to receive(:create_list).with(:foo, 1, :baz, qux: 42)
+
     expect(FactoryBot).to receive(:create_list) do |*args, **opts|
       expect(args).to eq [:foo, 3, :bar]
       expect(opts).to be_empty

data/spec/fixturama/seed_fixture/seed.yml

@@ -9,8 +9,3 @@
   count: 3
   traits:
     - bar
-
-- type: foo
-  count: 0
-  traits:
-    - baz

metadata

@@ -1,114 +1,114 @@
 --- !ruby/object:Gem::Specification
 name: fixturama
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kozin (nepalez)
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-  name: factory_bot
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  name: rspec
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  name: hashie
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  name: webmock
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-  name: rake
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-  name: rspec-its
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.49'
-  name: rubocop
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.49'
-description:
+description: 
 email: andrew.kozin@gmail.com
 executables: []
 extensions: []
@@ -127,23 +127,24 @@ files:
 - Rakefile
 - fixturama.gemspec
 - lib/fixturama.rb
+- lib/fixturama/changes.rb
+- lib/fixturama/changes/base.rb
+- lib/fixturama/changes/chain.rb
+- lib/fixturama/changes/chain/actions.rb
+- lib/fixturama/changes/chain/arguments.rb
+- lib/fixturama/changes/chain/raise_action.rb
+- lib/fixturama/changes/chain/return_action.rb
+- lib/fixturama/changes/const.rb
+- lib/fixturama/changes/request.rb
+- lib/fixturama/changes/request/response.rb
+- lib/fixturama/changes/request/responses.rb
+- lib/fixturama/changes/seed.rb
 - lib/fixturama/config.rb
+- lib/fixturama/fixture_error.rb
 - lib/fixturama/loader.rb
 - lib/fixturama/loader/context.rb
 - lib/fixturama/loader/value.rb
 - lib/fixturama/rspec.rb
-- lib/fixturama/seed.rb
-- lib/fixturama/stubs.rb
-- lib/fixturama/stubs/chain.rb
-- lib/fixturama/stubs/chain/actions.rb
-- lib/fixturama/stubs/chain/actions/raise.rb
-- lib/fixturama/stubs/chain/actions/return.rb
-- lib/fixturama/stubs/chain/arguments.rb
-- lib/fixturama/stubs/const.rb
-- lib/fixturama/stubs/request.rb
-- lib/fixturama/stubs/request/response.rb
-- lib/fixturama/stubs/request/responses.rb
-- lib/fixturama/utils.rb
 - spec/fixturama/load_fixture/_spec.rb
 - spec/fixturama/load_fixture/data.json
 - spec/fixturama/load_fixture/data.yaml
@@ -157,7 +158,7 @@ homepage: https://github.com/nepalez/fixturama
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -172,9 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
-signing_key:
+rubygems_version: 3.0.6
+signing_key: 
 specification_version: 4
 summary: A set of helpers to prettify specs with fixtures
 test_files: