fixturama 0.0.7 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64d9722c641abfd4aa64fbf45b8f1177f768d1b8d2b99a89aa824e1f64db9417
-  data.tar.gz: e1186c8944916943bbab46584747553b07b9d5cfc4e9d875d1a401fc8bd7017a
+  metadata.gz: 779a1dc8057604e6a5524eff0ef07520ecdbaf62895711411a312fb5c81a7558
+  data.tar.gz: 7976718e10f2fe8036d9e934d6e720cdcb91890f4263221720bfe76815eca071
 SHA512:
-  metadata.gz: 29d44cd1b06c482ba40df2d4397c064888a64ae1f9a0a4151aa581bf81a83e9ca1a5e84c052340d515032d0f580f11418f9838a5efe00fd722401117248a0311
-  data.tar.gz: 2b8a86f7fffdb20bae92839790254e052d2dbbbb39172003c9cfb4439620c782e4bc3f2ccdd985540dcba4d19e1fc228a3f7d940d58a865ad289f2f265427589
+  metadata.gz: 25047655a38dedca47af366563ad14c7f0bea54ddd0230097f6a940b127593a70a6144cf556670308dc1ad1048cce74180cecfe7c89871682602e5e5bbca0988
+  data.tar.gz: c23c3fe8662badf370ffc5cb02c756d510ca2be2f75639bc77e8d54f4243b49be74f17f54561329861865778a06b7e08efcf1c24d6fbb873dfacbb912f53618b

data/CHANGELOG.md

@@ -5,6 +5,101 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.4.1] - [2021-03-31]
+
+### Fixed
+
+- Dependency from hashie updated to allow v4+ (nepalez)
+
+## [0.4.0] - [2020-03-15]
+
+### Added
+
+- Support for stubbing ENV variables (nepalez)
+
+```yaml
+---
+- env: GOOGLE_CLOUD_KEY
+  value: foo
+
+- env: GOOGLE_CLOUD_PASSWORD
+  value: bar
+```
+
+This would stub selected variables only, not touching the others
+
+## [0.3.0] - [2020-03-08]
+
+### Added
+
+- Support for exception arguments (nepalez)
+
+```yaml
+---
+- class: API
+  chain: get_product
+  arguments:
+    - 1
+  actions:
+    - raise: API::NotFoundError
+      arguments: # <--- that's that
+        - "Cannot find a product by id: 1"
+```
+
+which would raise `API::NotFoundError.new("Cannot find a product by id: 1")`
+
+## [0.2.0] - [2020-02-17]
+
+### Added
+
+- Stubbing and seeding from the same source file via the `call_fixture` method (nepalez)
+
+```yaml
+# ./changes.yml
+---
+- type: user
+  params:
+    id: 1
+
+- const: DEFAULT_USER_ID
+  value: 1
+
+- url: https://example.com/users/default
+  method: get
+  responses:
+    - body:
+        id: 1
+        name: Andrew
+```
+
+```ruby
+before { call_fixture "#{__dir__}/changes.yml" }
+```
+
+## [0.1.0] - [2020-02-09]
+
+### Added
+
+- Stubbing of the HTTP requests using webmock (nepalez)
+
+  ```yaml
+  ---
+  - url: example.com/foo
+    method: get
+    body: foobar
+    query:
+      foo: bar
+    basic_auth:
+      user: foo
+      password: bar
+    headers:
+      Accept: utf-8
+    responses:
+      - status: 200
+        body: foobar
+      - status: 404
+  ```
+
 ## [0.0.7] - [2019-07-01]
 
 ### Added
@@ -175,3 +270,8 @@ This is a first public release with features extracted from production app.
 [0.0.5]: https://github.com/nepalez/fixturama/compare/v0.0.4...v0.0.5
 [0.0.6]: https://github.com/nepalez/fixturama/compare/v0.0.5...v0.0.6
 [0.0.7]: https://github.com/nepalez/fixturama/compare/v0.0.6...v0.0.7
+[0.1.0]: https://github.com/nepalez/fixturama/compare/v0.0.7...v0.1.0
+[0.2.0]: https://github.com/nepalez/fixturama/compare/v0.1.0...v0.2.0
+[0.3.0]: https://github.com/nepalez/fixturama/compare/v0.2.0...v0.3.0
+[0.4.0]: https://github.com/nepalez/fixturama/compare/v0.3.0...v0.4.0
+[0.4.1]: https://github.com/nepalez/fixturama/compare/v0.4.0...v0.4.1

data/README.md

@@ -124,21 +124,41 @@ Use the `count: 2` key to create more objects at once.
 
 ### Stubbing
 
-Another opinionated format we use for stubs (`stub_fixture`). The gem supports stubbing both message chains and constants.
+The gem supports stubbing message chains, constants and http requests with the following keys.
 
 For message chains:
 
 - `class` for stubbed class
 - `chain` for messages chain
 - `arguments` (optional) for specific arguments
-- `actions` for an array of actions for consecutive invocations of the chain
+- `actions` for an array of actions for consecutive invocations of the chain with keys
+    - `return` for a value to be returned
+    - `raise` for an exception to be risen
+    - `repeate` for a number of invocations with this action
 
 For constants:
 
 - `const` for stubbed constant
 - `value` for a value of the constant
 
-Every action either `return` some value, or `raise` some exception
+For environment variables:
+
+- `env` for the name of a variable
+  `value` for a value of the variable
+
+For http requests:
+
+- `url` or `uri` for the URI of the request (treats values like `/.../` as regular expressions)
+- `method` for the specific http-method (like `get` or `post`)
+- `body` for the request body (treats values like `/.../` as regular expressions)
+- `headers` for the request headers
+- `query` for the request query
+- `basic_auth` for the `user` and `password` of basic authentication
+- `response` or `responses` for consecutively envoked responses with keys:
+    - `status`
+    - `body`
+    - `headers`
+    - `repeate` for the number of times this response should be returned before switching to the next one
 
 ```yaml
 # ./stubs.yml
@@ -166,10 +186,34 @@ Every action either `return` some value, or `raise` some exception
     - <%= profile_id %>
   actions:
     - return: true
+      repeate: 1 # this is the default value
     - raise: ActiveRecord::RecordNotFound
+      arguments:
+        - "Profile with id: 1 not found" # for error message
 
+# Here we stubbing a constant
 - const: NOTIFIER_TIMEOUT_SEC
   value: 10
+
+# This is a stub for ENV['DEFAULT_EMAIL']
+- env: DEFAULT_EMAIL
+  value: foo@example.com
+
+# Examples for stubbing HTTP
+- uri: /example.com/foo/ # regexp!
+  method: delete
+  basic_auth:
+    user: foo
+    password: bar
+  responses:
+    - status: 200 # for the first call
+      repeate: 1   # this is the default value, but you can set another one
+    - status: 404 # for any other call
+
+- uri: htpps://example.com/foo # exact string!
+  method: delete
+  responses:
+    - status: 401
 ```
 
 ```graphql
@@ -203,6 +247,30 @@ I find it especially helpful when I need to check different edge cases. Instead
 
 Looking at the spec I can easily figure out the "structure" of expectation, while looking at fixtures I can check the concrete corner cases.
 
+## Single Source of Changes
+
+If you will, you can list all stubs and seeds at the one single file like
+
+```yaml
+# ./changes.yml
+---
+- type: user
+  params:
+    id: 1
+    name: Andrew
+
+- const: DEFAULT_USER_ID
+  value: 1
+```
+
+This fixture can be applied via `call_fixture` method just like we did above with `seed_fixture` and `stub_fixture`:
+
+```ruby
+before { call_fixture "#{__dir__}/changes.yml" }
+```
+
+In fact, since the `v0.2.0` all those methods are just the aliases of the `call_fixture`.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License][license].

data/lib/fixturama.rb

@@ -3,46 +3,75 @@ require "factory_bot"
 require "hashie/mash"
 require "json"
 require "rspec"
+require "webmock/rspec"
 require "yaml"
 
+#
+# A set of helpers to prettify specs with fixtures
+#
 module Fixturama
+  require_relative "fixturama/fixture_error"
   require_relative "fixturama/config"
-  require_relative "fixturama/utils"
   require_relative "fixturama/loader"
-  require_relative "fixturama/stubs"
-  require_relative "fixturama/seed"
+  require_relative "fixturama/changes"
 
+  # Set the initial value for database-generated IDs
+  # @param [#to_i] value
+  # @return [Fixturama]
   def self.start_ids_from(value)
     Config.start_ids_from(value)
+    self
   end
 
-  def stub_fixture(path, **opts)
-    items = load_fixture(path, **opts)
-    raise "The fixture should contain an array" unless items.is_a?(Array)
+  # @!method read_fixture(path, options)
+  # Read the text content of the fixture
+  # @param [#to_s] path The path to the fixture file
+  # @param [Hash<Symbol, _>] options
+  #   The list of options to be accessible in the fixture
+  # @return [String]
+  def read_fixture(path, **options)
+    content  = File.read(path)
+    hashie   = Hashie::Mash.new(options)
+    bindings = hashie.instance_eval { binding }
 
-    items.each { |item| fixturama_stubs.add(item) }
-    fixturama_stubs.apply(self)
+    ERB.new(content).result(bindings)
   end
 
-  def seed_fixture(path, **opts)
-    Array(load_fixture(path, **opts)).each { |item| Seed.call(item) }
+  # @!method load_fixture(path, options)
+  # Load data from a fixture
+  # @param (see #read_fixture)
+  # @return [Object]
+  def load_fixture(path, **options)
+    Loader.new(path, options).call
   end
 
-  def load_fixture(path, **opts)
-    Loader.new(path, opts).call
+  # @!method call_fixture(path, options)
+  # Stub different objects and seed the database from a fixture
+  # @param (see #read_fixture)
+  # @return [RSpec::Core::Example] the current example
+  def call_fixture(path, **options)
+    items = Array load_fixture(path, **options)
+    items.each { |item| changes.add(item) }
+    tap { changes.call(self) }
+  rescue FixtureError => err
+    raise err.with_file(path)
   end
 
-  def read_fixture(path, **opts)
-    content  = File.read(path)
-    hashie   = Hashie::Mash.new(opts)
-    bindings = hashie.instance_eval { binding }
+  # @!method seed_fixture(path, options)
+  # The alias for the +call_fixture+
+  # @param (see #call_fixture)
+  # @return (see #call_fixture)
+  alias seed_fixture call_fixture
 
-    ERB.new(content).result(bindings)
-  end
+  # @!method stub_fixture(path, options)
+  # The alias for the +call_fixture+
+  # @param (see #call_fixture)
+  # @return (see #call_fixture)
+  alias stub_fixture call_fixture
 
   private
 
-  def fixturama_stubs
-    @fixturama_stubs ||= Stubs.new
+  def changes
+    @changes ||= Changes.new
   end
 end

data/lib/fixturama/changes.rb

@@ -0,0 +1,72 @@
+module Fixturama
+  #
+  # @private
+  # Registry of changes (stubs and seeds)
+  #
+  class Changes
+    require_relative "changes/base"
+    require_relative "changes/chain"
+    require_relative "changes/const"
+    require_relative "changes/env"
+    require_relative "changes/request"
+    require_relative "changes/seed"
+
+    # Match option keys to the type of an item
+    TYPES = {
+      actions: Chain,
+      arguments: Chain,
+      basic_auth: Request,
+      body: Request,
+      chain: Chain,
+      class: Chain,
+      const: Const,
+      count: Seed,
+      env: Env,
+      headers: Request,
+      http_method: Request,
+      object: Chain,
+      params: Seed,
+      query: Request,
+      response: Request,
+      responses: Request,
+      traits: Seed,
+      type: Seed,
+      uri: Request,
+      url: Request,
+    }.freeze
+
+    # Adds new change to the registry
+    # @param [Hash] options
+    # @return [Fixturama::Changes]
+    # @raise [Fixturama::FixtureError] if the options cannot be processed
+    def add(options)
+      options = Hash(options).transform_keys(&:to_sym)
+      types = options.keys.map { |key| TYPES[key] }.compact.uniq
+      raise "Wrong count" unless types.count == 1
+
+      @changes << types.first.new(options)
+      self
+    rescue FixtureError => err
+      raise err
+    rescue StandardError => err
+      raise FixtureError.new("an operation", options, err)
+    end
+
+    # Apply all registered changes to the RSpec example
+    # @param [RSpec::Core::Example] example
+    # @return [self]
+    def call(example)
+      @changes
+        .group_by(&:key)
+        .values
+        .map { |changes| changes.reduce :merge }
+        .each { |change| change.call(example) }
+    end
+
+    private
+
+    def initialize
+      @changes = []
+    end
+  end
+end

data/lib/fixturama/changes/base.rb

@@ -0,0 +1,28 @@
+class Fixturama::Changes
+  #
+  # @private
+  # @abstract
+  # Base class for changes downloaded from a fixture
+  #
+  class Base
+    # @!attribute [r] key The key identifier of the change
+    # @return [String]
+    alias key hash
+
+    # Merge the other change into the current one
+    # @param [Fixturama::Changes::Base] other
+    # @return [Fixturama::Changes::Base]
+    def merge(other)
+      # By default just take the other change if applicable
+      other.class == self.class && other.key == key ? other : self
+    end
+
+    # @abstract
+    # Call the corresponding change (either a stub or a seed)
+    # @param [RSpec::Core::Example] _example The RSpec example
+    # @return [self]
+    def call(_example)
+      self
+    end
+  end
+end

data/lib/fixturama/changes/chain.rb

@@ -0,0 +1,64 @@
+class Fixturama::Changes
+  #
+  # @private
+  # Stub a chain of messages
+  #
+  class Chain < Base
+    require_relative "chain/raise_action"
+    require_relative "chain/return_action"
+    require_relative "chain/actions"
+    require_relative "chain/arguments"
+
+    def key
+      @key ||= ["chain", @receiver.name, *@messages].join(".")
+    end
+
+    def merge(other)
+      return self unless other.class == self.class && other.key == key
+
+      tap { @arguments = (other.arguments | arguments).sort_by(&:order) }
+    end
+
+    def call(example)
+      call_action = example.send(:receive_message_chain, *@messages) do |*real|
+        action = arguments.find { |expected| expected.match?(*real) }
+        action ? action.call : raise("Unexpected arguments: #{real}")
+      end
+
+      example.send(:allow, @receiver).to call_action
+    end
+
+    protected
+
+    attr_reader :arguments
+
+    private
+
+    def initialize(**options)
+      @receiver  = receiver_from(options)
+      @messages  = messages_from(options)
+      @arguments = [Arguments.new(options)]
+    end
+
+    def receiver_from(options)
+      case options.slice(:class, :object).keys
+      when %i[class]  then Kernel.const_get(options[:class])
+      when %i[object] then Object.send(:eval, options[:object])
+      else raise
+      end
+    rescue StandardError => err
+      raise Fixturama::FixtureError.new("a stabbed object", options, err)
+    end
+
+    def messages_from(options)
+      case value = options[:chain]
+      when Array  then value.map(&:to_sym)
+      when String then [value.to_sym]
+      when Symbol then value
+      else raise
+      end
+    rescue StandardError => err
+      raise Fixturama::FixtureError.new("a messages chain", options, err)
+    end
+  end
+end