fixturama 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bfb62ba99d427f8a3f03b6d46a0fb7e6712dd31bfff6da7c17fb075cfa930f0
-  data.tar.gz: fa1b0359c0681a73723a915dd499945602b350b3b802b68e6962a66753a5d208
+  metadata.gz: 4e21218a92d62cab4b0bbc73fe1f2ac02eb5c66a7315357a68189067d138d92a
+  data.tar.gz: 81861ef1dbf1eba81874fb929875c89f04dc3ebdeba9694ae02989762dd7aca5
 SHA512:
-  metadata.gz: 987b0cf303e78879b18278d85ace7cf26261e6c76000b0081571cb40a3dcf763435cb5560de122bf3a466b9c781684c8ed8d183697fbd1b84aa619c8409e34c8
-  data.tar.gz: d85486458d90dbff1e3f2136c5862e081aa1a1861bb5e6320fb68bbc258d11ce1e978de5603c900080ef719809e97a4d0bf793a46c8f90af33e7a6626d258835
+  metadata.gz: f09063278691d752987cc1b9bbc8d20a715624cce81f81e9c61b521d52af28b9fbe03e09ac9357e01c154b987608558231b3c0ca8d1bdd5677303f887630b3ad
+  data.tar.gz: b93be44d444875df3d793bb7947bbd9c906a0fcc699c3b1ec4625186a38eed3b58b8a11f11d6e7ae421db4615534533029c2fece7d592a357649ef24598e63a9

data/CHANGELOG.md

@@ -5,6 +5,100 @@ 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.5.0] - [2021-04-03]
+
+### Added
+
+- Support for <de>serialization PORO objects (nepalez)
+
+```yaml
+# target.yml
+---
+number: <%= object(be_positive) %>
+```
+
+```ruby
+RSpec.describe "something" do
+    subject { { "number" => 42 } }
+    
+    # no explicit params is needed here
+    let(:target) { load_fixture "target.yml" }
+    
+    it { is_expected.to match(target) }
+end
+```
+
+## [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
@@ -200,3 +294,8 @@ This is a first public release with features extracted from production app.
 [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
+[0.5.0]: https://github.com/nepalez/fixturama/compare/v0.4.1...v0.5.0

data/README.md

@@ -99,6 +99,38 @@ This feature can also be useful to produce a "partially defined" fixtures with [
 subject { load_fixture "#{__dir__}/data.yml", user: kind_of(ActiveRecord::Base) }
 ```
 
+Since the v0.5.0 we support another way to serialize PORO objects in fixtures. Just wrap them to the `object()` method:
+
+```yaml
+---
+:account: <%= object(user) %>
+```
+
+This time you don't need sending objects explicitly.
+
+```ruby
+RSpec.describe "example" do
+    subject { load_fixture "#{__dir__}/data.yml" }
+    
+    let(:user) { FactoryBot.create(:user) }
+    
+    # The same object will be returned
+    it { is_expected.to eq(account: user) }
+end
+```
+
+Under the hood we use `Marshal.dump` and `Marshal.restore` to serialize and deserialize the object back.
+
+**Notice**, that deserialization creates a new instance of the object which is not equivalent to the source (`user` in the example above)!
+In most cases this is enough. For example, you can provide matchers like:
+
+```yaml
+---
+number: <%= object(be_positive) %>
+```
+
+The loaded object would contain `{ "number" => be_positive }`.
+
 ### Seeding
 
 The seed (`seed_fixture`) file should be a YAML/JSON with opinionated parameters, namely:
@@ -124,22 +156,28 @@ 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
-
-Every action either `return` some value, or `raise` some exception
+- `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
 
+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)
@@ -152,6 +190,7 @@ For http requests:
     - `status`
     - `body`
     - `headers`
+    - `repeate` for the number of times this response should be returned before switching to the next one
 
 ```yaml
 # ./stubs.yml
@@ -179,11 +218,19 @@ For http requests:
     - <%= 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
@@ -192,6 +239,7 @@ For http requests:
     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!
@@ -231,6 +279,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

@@ -6,44 +6,72 @@ 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(self, 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.instance_of?(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