fixturama 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 8373fb84e1acca73b060d54aab09588b6f196aa9420a6378361a9f5e011c2e71
-  data.tar.gz: 286b6cf22fecdebe1f7fec48c30bbcc49879683726c1ad3da1282e9b2eb6cd66
+SHA1:
+  metadata.gz: bba5ba59d906e247aaa4e798664b7ec30802e960
+  data.tar.gz: b2bfc9b12596884af5dc875a9caede9c343522bb
 SHA512:
-  metadata.gz: 705ddbd4b4c6458d3fe7338748a9dcbb1166ca8dbedbb01a9c21e37036c5a71df70963af5e3d6ba6ae50baaf04435b23e69570c7360e9577175038ec238a7a41
-  data.tar.gz: 26cbcea20fd78fe35d78edf6161f66f048d6b406e1246c55d88432e0149d11cde13c2d2577b6735f3e74dda21764cee73e077df3063765312b1de0bc22422599
+  metadata.gz: c94ee6bb71480fc429ee9074d48eda1b8cb09914a5184ae676e6cbe07495754fbcaad3dccb6c74812c56866b7c60d6cf148b4c7cd2e0ae3003c0d0d745db7953
+  data.tar.gz: e1ecad3d926147300425c474757ecd0d1e80d6427c37bc5ef1d29d122680104f8913cea4511dec84e64b779588c1247e0326508de0226e0bb5d521bb7c8f608f

data/.rubocop.yml

@@ -12,32 +12,11 @@ Metrics/LineLength:
     - http
     - https
   
-Layout/SpaceInLambdaLiteral:
-  Enabled: false
-
-Style/CaseEquality:
-  Enabled: false
-
 Style/ClassAndModuleChildren:
   Enabled: false
 
 Style/Documentation:
   Enabled: false
 
-Style/DoubleNegation:
-  Enabled: false # by intention
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/Lambda:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/RaiseArgs:
-  Enabled: false
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/.travis.yml

@@ -11,9 +11,12 @@ script:
 rvm:
   - 2.3.0
   - 2.6.0
+  - jruby-9.2.0.0
   - ruby-head
-  - jruby-9.1.0.0
   - jruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -1,11 +1,41 @@
 # Change Log
+
 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.0.2] - [2018-04-27]
+
+### Added
+
+- Restriction of stub by arguments (nepalez)
+
+  ```yaml
+  ---
+  - class: Balance
+    chain: debet
+    arguments: 0
+    actions:
+      - return: 1
+
+  - class: Balance
+    chain: debet
+    arguments: 1
+    actions:
+      - return: 0
+      - raise: UnsifficientFunds
+
+  - class: Balance
+    chain: debet
+    arguments: 2
+    actions:
+      - raise: UnsifficientFunds
+  ```
+
 ## [0.0.1] - [2018-03-01]
 
 This is a first public release with features extracted from production app.
 
 [0.0.1]: https://github.com/nepalez/fixturama/releases/tag/v0.0.1
+[0.0.2]: https://github.com/nepalez/fixturama/compare/v0.0.1...v0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Fixturama
 
-Collection of helpers for dealing with fixtures in RSpec
+Collection of helpers for dealing with fixtures in [RSpec][rspec]
 
 <a href="https://evilmartians.com/">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
@@ -24,7 +24,7 @@ require "fixturama/rspec"
 The gem defines 3 helpers (support ERB bindings):
 
 - `load_fixture(path, **opts)` to load data from a fixture, and deserialize YAML and JSON
-- `seed_fixture(path_to_yaml, **opts)` to prepare database
+- `seed_fixture(path_to_yaml, **opts)` to prepare database using the [FactoryBot][factory-bot]
 - `stub_fixture(path_to_yaml, **opts)` to stub some classes
 
 ```ruby
@@ -79,6 +79,7 @@ Another opinionated format we use for stubs (`stub_fixture`):
 
 - `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
@@ -87,14 +88,26 @@ Every action either `return` some value, or `raise` some exception
 # ./stubs.yml
 #
 # The first invocation acts like
-# allow(Events).to receive_message_chain(:create).and_return true
 #
-# Afterwards it will act like
-# allow(Events).to receive_message_chain(:create).and_raise AlreadyRegisteredError
+# allow(Notifier)
+#   .to receive_message_chain(:create)
+#   .with(:profileDeleted, 42)
+#   .and_return true
+#
+# then it will act like
+#
+# allow(Notifier)
+#   .to receive_message_chain(:create)
+#   .with(:profileDeleted, 42)
+#   .and_raise AlreadyRegisteredError
+#
 ---
-- class: Events
+- class: Notifier
   chain:
     - create
+  arguments:
+    - :profileDeleted
+    - <%= profile_id %>
   actions:
     - return: true
     - raise: AlreadyRegisteredError
@@ -138,3 +151,5 @@ The gem is available as open source under the terms of the [MIT License][license
 [gem]: https://rubygems.org/gems/fixturama
 [travis]: https://travis-ci.org/nepalez/fixturama
 [license]: http://opensource.org/licenses/MIT
+[factory-bot]: https://github.com/thoughtbot/factory_bot
+[rspec]: https://rspec.info/

data/fixturama.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "fixturama"
-  gem.version  = "0.0.1"
+  gem.version  = "0.0.2"
   gem.author   = "Andrew Kozin (nepalez)"
   gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/nepalez/fixturama"

data/lib/fixturama/stubs/actions/raise.rb

@@ -0,0 +1,21 @@
+class Fixturama::Stubs::Actions::Raise
+  def call
+    raise @exception
+  end
+
+  #
+  # Human-readable representation of the expectation
+  # @return [String]
+  #
+  def to_s
+    "#{@stub} # raise #{@exception}"
+  end
+
+  private
+
+  def initialize(stub, name)
+    @stub = stub
+    name = name.to_s
+    @exception = name == "true" ? StandardError : Kernel.const_get(name)
+  end
+end

data/lib/fixturama/stubs/actions/return.rb

@@ -0,0 +1,23 @@
+class Fixturama::Stubs::Actions::Return
+  attr_reader :stub, :call
+
+  #
+  # Human-readable representation of the expectation
+  # @return [String]
+  #
+  def to_s
+    "#{@stub} # => #{call}"
+  end
+
+  private
+
+  def initialize(stub, output)
+    @stub = stub
+    @call = \
+      begin # in ruby 2.3.0 Fixnum#dup is defined, but raises TypeError
+        output.respond_to?(:dup) ? output.dup : output
+      rescue TypeError
+        output
+      end
+  end
+end

data/lib/fixturama/stubs/actions.rb

@@ -1,27 +1,39 @@
 module Fixturama
-  class Stubs
-    class Actions
-      def add(opts)
-        queue.push build(opts)
-        self
-      end
+  #
+  # Factory to provide a specific action from options
+  #
+  module Stubs::Actions
+    extend self
 
-      def call_next
-        queue.pop.tap { |item| queue.push(item.dup) if queue.empty? }.call
-      end
+    require_relative "actions/raise"
+    require_relative "actions/return"
 
-      private
+    #
+    # Builds an action
+    # @option [#to_s]  :raise
+    # @option [Object] :return
+    # @option [true]   :call_original
+    # @return [#call] a callable action
+    #
+    def build(stub, **options)
+      check!(stub, options)
+      key, value = options.to_a.first
+      TYPES[key].new(stub, value)
+    end
 
-      def build(opts)
-        opts = Utils.symbolize_hash(opts)
-        return Raise.new opts[:raise] if opts.key?(:raise)
+    private
 
-        Return.new opts[:return]
-      end
+    def check!(stub, options)
+      keys = options.keys & TYPES.keys
+      return if keys.count == 1
 
-      def queue
-        @queue ||= Queue.new
-      end
+      raise SyntaxError, <<~MESSAGE.squish
+        Invalid settings for stubbing message chain #{stub}: #{options}.
+        The action MUST have one and only one of the keys:
+        `#{TYPES.keys.join('`, `')}`.
+      MESSAGE
     end
+
+    TYPES = { raise: Raise, return: Return }.freeze
   end
 end

data/lib/fixturama/stubs/arguments.rb

@@ -0,0 +1,77 @@
+module Fixturama
+  #
+  # Collection of arguments for a stub with a list of actions to be called
+  #
+  class Stubs::Arguments
+    attr_reader :chain, :arguments
+
+    #
+    # Register new action for these set of arguments
+    # @option [#to_i] :repeat (1)
+    #   How much the action should be repeated during the consecutive calls
+    # @return [self] itself
+    #
+    def add!(*actions)
+      actions.each do |settings|
+        settings = Utils.symbolize_hash(settings)
+        repeat   = [0, settings.fetch(:repeat, 1).to_i].max
+        repeat.times { list << Stubs::Actions.build(self, settings) }
+      end
+
+      self
+    end
+
+    #
+    # Whether the current stub is applicable to actual arguments
+    # @param  [Array<Object>] actual_arguments
+    # @return [Boolean]
+    #
+    def applicable_to?(actual_arguments)
+      @arguments.zip(actual_arguments).map { |(x, y)| x == y }.reduce(true, :&)
+    end
+
+    #
+    # Reset the counter of calls
+    # @return [self] itself
+    #
+    def reset!
+      @counter = 0
+      self
+    end
+
+    #
+    # Calls the next action for these set of agruments
+    # @return [Object]
+    # @raise  [StandardError]
+    #
+    def call_next!
+      list.fetch(counter) { list.last }.call.tap { @counter += 1 }
+    end
+
+    #
+    # Human-readable representation of arguments
+    # @return [String]
+    #
+    def to_s
+      args = [*arguments.map(&:to_s), "*"].join(", ")
+      "#{chain}(#{args})"
+    end
+
+    private
+
+    # @param [Fixturama::Stubs::Chain] chain Back reference
+    # @param [Array<Object>] list Definition of arguments
+    def initialize(chain, list)
+      @chain     = chain
+      @arguments = Utils.array(list)
+    end
+
+    def counter
+      @counter ||= 0
+    end
+
+    def list
+      @list ||= []
+    end
+  end
+end

data/lib/fixturama/stubs/chain.rb

@@ -0,0 +1,78 @@
+module Fixturama
+  #
+  # Stubbed chain of messages
+  #
+  class Stubs::Chain
+    attr_reader :receiver, :messages
+
+    #
+    # Register new action for some arguments
+    #
+    # @option [Array<#to_s>, #to_s] :arguments The specific arguments
+    # @option (see Fixturama::Stubs::Arguments#add_action)
+    # @return [self]
+    #
+    def add(actions:, arguments: nil, **)
+      Utils.array(arguments).tap do |args|
+        stub = find_by(args)
+        unless stub
+          stub = Stubs::Arguments.new(self, args)
+          stubs << stub
+        end
+        stub.add!(*actions)
+        stubs.sort_by! { |stub| -stub.arguments.count }
+      end
+
+      self
+    end
+
+    #
+    # Resets all counters
+    # @return [self] itself
+    #
+    def reset!
+      tap { stubs.each(&:reset!) }
+    end
+
+    #
+    # Executes the corresponding action
+    # @return [Object]
+    # @raise  [StandardError]
+    #
+    def call!(actual_arguments)
+      stub = stubs.find { |item| item.applicable_to?(actual_arguments) }
+      raise "Unexpected arguments #{actual_arguments}" unless stub
+
+      stub.call_next!
+    end
+
+    #
+    # Human-readable representation of the chain
+    # @return [String]
+    #
+    def to_s
+      "#{receiver}.#{messages.join(".")}"
+    end
+
+    private
+
+    def initialize(**options)
+      @receiver = Utils.constantize options[:class]
+      @messages = Utils.symbolize_array options[:chain]
+      return if messages.any?
+
+      raise SyntaxError, <<~MESSAGE.squish
+        Indefined message chain for stubbing #{receiver}.
+        Use option `chain` to define it.
+      MESSAGE
+    end
+
+    def stubs
+      @stubs ||= []
+    end
+
+    def find_by(arguments)
+      stubs.find { |stub| stub.arguments == arguments }
+    end
+  end
+end

data/lib/fixturama/stubs.rb

@@ -1,37 +1,49 @@
 module Fixturama
+  #
+  # Collection of stubbed calls
+  #
   class Stubs
     require_relative "stubs/actions"
-    require_relative "stubs/raise"
-    require_relative "stubs/return"
+    require_relative "stubs/arguments"
+    require_relative "stubs/chain"
 
+    #
+    # Register new action and apply the corresponding stub
+    #
+    # @option [#to_s]        :class Class to stub
+    # @option [Array<#to_s>] :chain Methods chain for stubbing
+    # @option (see Fixturama::Stubs::Method#add)
+    # @return [self] itself
+    #
     def add(options)
-      options = Utils.symbolize_hash(options)
-      klass, chain, actions = options.values_at(:class, :chain, :actions)
+      tap do
+        options = Utils.symbolize_hash(options)
 
-      klass = Utils.constantize(klass)
-      chain = Utils.symbolize_array(chain)
-      actions ||= { return: nil }
-
-      Array(actions).each do |action|
-        collection[[klass, chain]] ||= Actions.new
-        collection[[klass, chain]].add action
+        options.select { |key| %i[class chain].include?(key) }.tap do |anchors|
+          chains[anchors] ||= Chain.new(anchors)
+          chains[anchors].add(options)
+        end
       end
-
-      self
     end
 
+    #
+    # Applies the stub to RSpec example
+    #
     def apply(example)
-      collection.each do |(klass, chain), actions|
-        example.send(:allow, klass).to example.receive_message_chain(chain) do
-          actions.call_next
-        end
+      chains.values.each do |chain|
+        chain.reset!
+        call_action = \
+          example.send(:receive_message_chain, *chain.messages) do |*args|
+            chain.call! args
+          end
+        example.send(:allow, chain.receiver).to call_action
       end
     end
 
     private
 
-    def collection
-      @collection ||= {}
+    def chains
+      @chains ||= {}
     end
   end
 end

data/lib/fixturama/utils.rb

@@ -2,20 +2,32 @@ module Fixturama
   module Utils
     module_function
 
+    def symbolize(item)
+      item.to_s.to_sym
+    end
+
     def symbolize_hash(data)
-      Hash(data).transform_keys { |key| key.to_s.to_sym }
+      Hash(data).transform_keys { |key| symbolize(key)}
     end
 
     def symbolize_array(data)
-      Array(data).map { |item| item.to_s.to_sym }
+      Array(data).map { |item| symbolize(item) }
     end
 
     def constantize(item)
-      item.to_s.constantize
+      Kernel.const_get(item.to_s)
     end
 
     def clone(item)
       item.respond_to?(:dup) ? item.dup : item
     end
+
+    def array(list)
+      case list
+      when NilClass then []
+      when Array    then list
+      else [list]
+      end
+    end
   end
 end

data/spec/fixturama/stub_fixture/_spec.rb

@@ -1,47 +1,69 @@
 RSpec.describe "stub_fixture" do
-  subject { Foo.new.bar }
+  subject { arguments.map { |argument| Payment.new.pay(argument) } }
 
   before do
-    class Foo
-      def bar
-        "bar"
+    class Payment
+      def pay(_)
+        5
       end
     end
   end
 
   context "without stubbing" do
-    it { is_expected.to eq "bar" }
+    let(:arguments) { [0] }
+
+    it { is_expected.to eq [5] }
   end
 
-  context "with first invocation" do
+  context "with stubbing" do
     before { stub_fixture "#{__dir__}/stub.yml" }
 
-    it { is_expected.to eq "baz" }
-  end
+    context "with a :raise option" do
+      let(:arguments) { [0] }
 
-  context "with next_day invocation" do
-    before do
-      stub_fixture "#{__dir__}/stub.yml"
-      Foo.new.bar
+      it "raises an exception" do
+        expect { subject }.to raise_error ArgumentError
+      end
     end
 
-    it "raises an exception" do
-      expect { subject }.to raise_error StandardError
+    context "with a :return option" do
+      let(:arguments) { [1] }
+
+      it "returns stubbed value" do
+        expect(subject).to eq [8]
+      end
     end
-  end
 
-  context "with later invocations" do
-    before do
-      stub_fixture "#{__dir__}/stub.yml"
-      3.times do begin
-                  Foo.new.bar
-                rescue
-                  nil
-                end end
+    context "with several actions" do
+      let(:arguments) { [2] * 4 }
+
+      it "calls the consecutive actions and then repeates the last one" do
+        expect(subject).to eq [4, 2, 0, 0]
+      end
+    end
+
+    context "with multi-count actions" do
+      let(:arguments) { [3] * 4 }
+
+      it "repeats the action a specified number of times" do
+        expect(subject).to eq [6, 6, 0, 0]
+      end
     end
 
-    it "raises an exception" do
-      expect { subject }.to raise_error StandardError
+    context "with several arguments" do
+      let(:arguments) { [2, 3, 2, 3, 2, 3] }
+
+      it "counts actions for every stub in isolation from the others" do
+        expect(subject).to eq [4, 6, 2, 6, 0, 0]
+      end
+    end
+
+    context "with unspecified argument" do
+      let(:arguments) { [4] }
+
+      it "uses universal stub" do
+        expect(subject).to eq [-1]
+      end
     end
   end
 end

data/spec/fixturama/stub_fixture/stub.yml

@@ -1,8 +1,47 @@
 ---
-- class: Foo
+- class: Payment
   chain:
     - new
-    - bar
+    - pay
   actions:
-    - return: baz
-    - raise: StandardError
+    - return: -1
+
+- class: Payment
+  chain:
+    - new
+    - pay
+  arguments:
+    - 0
+  actions:
+    - raise: ArgumentError
+
+- class: Payment
+  chain:
+    - new
+    - pay
+  arguments:
+    - 1
+  actions:
+    - return: 8
+
+- class: Payment
+  chain:
+    - new
+    - pay
+  arguments:
+    - 2
+  actions:
+    - return: 4
+    - return: 2
+    - return: 0
+
+- class: Payment
+  chain:
+    - new
+    - pay
+  arguments:
+    - 3
+  actions:
+    - return: 6
+      repeat: 2
+    - return: 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixturama
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Kozin (nepalez)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2019-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -117,8 +117,10 @@ files:
 - lib/fixturama/seed.rb
 - lib/fixturama/stubs.rb
 - lib/fixturama/stubs/actions.rb
-- lib/fixturama/stubs/raise.rb
-- lib/fixturama/stubs/return.rb
+- lib/fixturama/stubs/actions/raise.rb
+- lib/fixturama/stubs/actions/return.rb
+- lib/fixturama/stubs/arguments.rb
+- lib/fixturama/stubs/chain.rb
 - lib/fixturama/utils.rb
 - spec/fixturama/load_fixture/_spec.rb
 - spec/fixturama/load_fixture/data.json
@@ -148,7 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A set of helpers to prettify specs with fixtures

data/lib/fixturama/stubs/raise.rb

@@ -1,15 +0,0 @@
-module Fixturama
-  class Stubs
-    class Raise
-      def call
-        raise @exception
-      end
-
-      private
-
-      def initialize(exception)
-        @exception = Utils.constantize(exception || StandardError)
-      end
-    end
-  end
-end

data/lib/fixturama/stubs/return.rb

@@ -1,13 +0,0 @@
-module Fixturama
-  class Stubs
-    class Return
-      attr_reader :call
-
-      private
-
-      def initialize(output)
-        @call = Utils.clone(output)
-      end
-    end
-  end
-end