rspec_candy 0.1.2 → 0.2.0

data/README.md

@@ -1,15 +1,51 @@
 #rspec_candy
 
 
-A collection of nifty helpers for your rspec suite.
+A collection of nifty helpers and matchers for your RSpec suite.
 
-Will work for RSpec1 and Rails 2, or RSpec2 and Rails 3, or no Rails at all..
+Will work for RSpec1 and Rails 2, or RSpec2 and Rails 3, or no Rails at all.
 
 
-##Usage
+##Installation
 
 Add `rspec_candy` to your Gemfile.
-Add `require 'rspec_candy/helpers'` to your spec_helper.rb, after the rspec requires.
+
+Now, in your `spec_helper.rb`, add this after your RSpec requires:
+
+    require 'rspec_candy/all'
+
+If you only care about the matchers or helpers you can also more specifically require:
+
+    require 'rspec_candy/matchers'
+    require 'rspec_candy/helpers'
+
+
+##Matchers provided
+
+**be_same_number_as**
+
+  Tests if the given number is the "same" as the receiving number, regardless of whether you're comparing `Fixnums` (integers), `Floats` and `BigDecimals`:
+
+    100.should be_same_number_as(100.0)
+    50.4.should be_same_number_as(BigDecimal('50.4'))
+
+  Note that "same" means "same for your purposes". Internally the matcher compares normalized results of `#to_s`.
+
+**be_same_second_as**
+
+  Tests if the given `Time` or `DateTime` is the same as the receiving `Time` or `DateTime`, [ignoring sub-second differences](https://makandracards.com/makandra/1057-why-two-ruby-time-objects-are-not-equal-although-they-appear-to-be):
+
+    Time.parse('2012-12-01 14:00:00.5').should == Time.parse('2012-12-01 14:00')
+
+  Note that two times in a different time zones will still be considered different.q
+
+**include_hash**
+
+  Matches if the given hash is included in the receiving hash:
+
+    { :foo => 'a', :bar => 'b' }.should include_hash(:foo => 'a') # passes
+    { :foo => 'a', :bar => 'b' }.should include_hash(:foo => 'b') # fails
+    { :foo => 'a', :bar => 'b' }.should include_hash(:foo => 'a', :baz => 'c') # fails
 
 
 ##Helpers provided

data/lib/rspec_candy/all.rb

@@ -0,0 +1,2 @@
+require 'rspec_candy/helpers'
+require 'rspec_candy/matchers'

data/lib/rspec_candy/base.rb

@@ -0,0 +1,2 @@
+require 'rspec_candy/version'
+require 'rspec_candy/switcher'

data/lib/rspec_candy/helpers.rb

@@ -1,5 +1,4 @@
-require 'rspec_candy/version'
-require 'rspec_candy/switcher'
+require 'rspec_candy/base'
 require 'rspec_candy/helpers/disposable_copy'
 require 'rspec_candy/helpers/it_should_act_like'
 require 'rspec_candy/helpers/new_with_stubs'

data/lib/rspec_candy/matchers/be_same_number_as.rb

@@ -0,0 +1,14 @@
+RSpecCandy::Switcher.define_matcher :be_same_number_as do |expected|
+
+  match do |actual|
+    actual.is_a?(Numeric) && expected.is_a?(Numeric) && normalize(expected) == normalize(actual)
+  end
+
+  def normalize(number)
+    number.to_s.tap do |str|
+      str << ".0" unless str.include?('.')
+    end
+  end
+
+end
+

data/lib/rspec_candy/matchers/be_same_second_as.rb

@@ -0,0 +1,9 @@
+RSpecCandy::Switcher.define_matcher :be_same_second_as do |expected|
+
+  match do |actual|
+    actual.to_i == expected.to_i
+  end
+
+
+end
+

data/lib/rspec_candy/matchers/include_hash.rb

@@ -0,0 +1,7 @@
+RSpecCandy::Switcher.define_matcher :include_hash do |expected|
+
+  match do |actual|
+    !actual.nil? && actual.slice(*expected.keys) == expected
+  end
+
+end

data/lib/rspec_candy/matchers.rb

@@ -0,0 +1,4 @@
+require 'rspec_candy/base'
+require 'rspec_candy/matchers/include_hash'
+require 'rspec_candy/matchers/be_same_number_as'
+require 'rspec_candy/matchers/be_same_second_as'

data/lib/rspec_candy/version.rb

@@ -1,3 +1,3 @@
 module RSpecCandy
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/rspec_candy.rb

@@ -1,2 +1,2 @@
-# empty, so Bundler does not require anything
-# put a "require rspec_candy/helpers" into your spec_helper
+# empty so bundler doesn't require a thing
+

data/spec/rspec1/spec_helper.rb

@@ -8,7 +8,7 @@ require "#{File.dirname(__FILE__)}/app_root/config/environment"
 require 'spec/rails'
 
 # Load dependencies
-require 'rspec_candy/helpers'
+require 'rspec_candy/all'
 
 # Require support code
 Dir["../shared/support/**/*.rb"].each {|f| require f}

data/spec/rspec2/spec_helper.rb

@@ -9,7 +9,7 @@ require "#{File.dirname(__FILE__)}/app_root/config/environment"
 require 'rspec/rails'
 
 # Load dependencies
-require 'rspec_candy/helpers'
+require 'rspec_candy/all'
 
 # Require support code
 Dir["../shared/support/**/*.rb"].each {|f| require f}

data/spec/shared/rspec_candy/matchers/be_same_number_as_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe RSpecCandy do
+  describe 'matchers' do
+    describe 'be_same_number_as' do
+
+      it 'should correctly compare Fixnums and Floats' do
+        1.should be_same_number_as(1.0)
+        2.should_not be_same_number_as(1.0)
+        -1.should be_same_number_as(-1.0)
+        -2.should_not be_same_number_as(-1.0)
+      end
+
+      it 'should correctly compare Fixnums and BigDecimals' do
+        1.should be_same_number_as(BigDecimal('1.0'))
+        2.should_not be_same_number_as(BigDecimal('1.0'))
+        -1.should be_same_number_as(BigDecimal('-1.0'))
+        -2.should_not be_same_number_as(BigDecimal('-1.0'))
+      end
+
+      it 'should correctly compare Floats and BigDecimals' do
+        1.1.should be_same_number_as(BigDecimal('1.1'))
+        2.1.should_not be_same_number_as(BigDecimal('1.1'))
+        -1.1.should be_same_number_as(BigDecimal('-1.1'))
+        -2.1.should_not be_same_number_as(BigDecimal('-1.1'))
+      end
+
+    end
+  end
+
+end

data/spec/shared/rspec_candy/matchers/be_same_second_as_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe RSpecCandy do
+  describe 'matchers' do
+    describe 'be_same_second_as' do
+
+      it 'should consider equal two Times with the same second' do
+        Time.parse('2012-05-01 14:15:16').should be_same_second_as(Time.parse('2012-05-01 14:15:16'))
+        Time.parse('2012-05-01 14:15:17').should_not be_same_second_as(Time.parse('2012-05-01 14:15:16'))
+      end
+
+      it 'should ignore sub-second differences' do
+        Time.parse('2012-05-01 00:00:00.1').should be_same_second_as(Time.parse('2012-05-01 00:00:00.2'))
+      end
+
+      it 'should correctly compare Time and DateTime objects' do
+        Time.parse('2012-05-01 14:15:16 +0000').should be_same_second_as(DateTime.parse('2012-05-01 14:15:16 +0000'))
+        Time.parse('2012-05-01 14:15:17 +0000').should_not be_same_second_as(DateTime.parse('2012-05-01 14:15:16 +0000'))
+        Time.parse('2012-05-01 00:00:00.1 +0000').should be_same_second_as(DateTime.parse('2012-05-01 00:00:00.2 +0000'))
+      end
+
+      it 'should consider different two times in different zones' do
+        Time.parse('2012-05-01 14:15:16 +0000').should_not be_same_second_as(Time.parse('2012-05-01 14:15:16 +0100'))
+      end
+
+    end
+  end
+
+end

data/spec/shared/rspec_candy/matchers/include_hash_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe RSpecCandy do
+  describe 'matchers' do
+    describe 'include_hash' do
+
+      it 'should match if all pairs in the given hash exist in the receiver' do
+        { :foo => 'a', :bar => 'b' , :bam => 'c'}.should include_hash(:foo => 'a', :bam => 'c')
+      end
+
+      it 'should not match if the given hash has keys that do not exist in the receiver' do
+        { :foo => 'a', :bar => 'b' , :bam => 'c'}.should_not include_hash(:foo => 'a', :baz => 'd')
+      end
+
+      it 'should not match if the given hash has values that are different in the receiver' do
+        { :foo => 'a', :bar => 'b' , :bam => 'c'}.should_not include_hash(:foo => 'a', :bam => 'different-value')
+      end
+
+      it 'should not crash and not match if the receiver is nil' do
+        nil.should_not include_hash(:foo => 'a')
+      end
+
+      it 'should match if the receiver is empty and the given hash is empty' do
+        {}.should include_hash({})
+      end
+
+    end
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rspec_candy
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Henning Koch
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-05 00:00:00 +02:00
+date: 2012-08-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,8 @@ files:
 - README.md
 - Rakefile
 - lib/rspec_candy.rb
+- lib/rspec_candy/all.rb
+- lib/rspec_candy/base.rb
 - lib/rspec_candy/helpers.rb
 - lib/rspec_candy/helpers/disposable_copy.rb
 - lib/rspec_candy/helpers/it_should_act_like.rb
@@ -58,6 +60,10 @@ files:
 - lib/rspec_candy/helpers/should_receive_chain.rb
 - lib/rspec_candy/helpers/stub_any_instance.rb
 - lib/rspec_candy/helpers/stub_existing.rb
+- lib/rspec_candy/matchers.rb
+- lib/rspec_candy/matchers/be_same_number_as.rb
+- lib/rspec_candy/matchers/be_same_second_as.rb
+- lib/rspec_candy/matchers/include_hash.rb
 - lib/rspec_candy/switcher.rb
 - lib/rspec_candy/version.rb
 - rspec_candy.gemspec
@@ -119,10 +125,11 @@ files:
 - spec/shared/rspec_candy/helpers/should_receive_chain_spec.rb
 - spec/shared/rspec_candy/helpers/stub_any_instance_spec.rb
 - spec/shared/rspec_candy/helpers/stub_existing_spec.rb
+- spec/shared/rspec_candy/matchers/be_same_number_as_spec.rb
+- spec/shared/rspec_candy/matchers/be_same_second_as_spec.rb
+- spec/shared/rspec_candy/matchers/include_hash_spec.rb
 - spec/shared/support/matchers/pass_as_describe_block.rb
 - spec/shared/support/matchers/pass_as_example.rb
-- template/spec_candy.rails2.rb
-- template/spec_candy.rails3.rb
 has_rdoc: true
 homepage: https://github.com/makandra/rspec_candy
 licenses: []

data/template/spec_candy.rails2.rb

@@ -1,171 +0,0 @@
-Object.class_eval do
-
-  def should_receive_chain(*parts)
-    setup_expectation_chain(parts)
-  end
-
-  def self.new_with_stubs(attrs)
-    new.tap do |obj|
-      obj.stub_existing attrs
-    end
-  end
-
-  def stub_existing(attrs)
-    attrs.each do |method, value|
-      if respond_to?(method, true)
-        stub(method => value)
-      else
-        raise "Attempted to stub non-existing method ##{method} on a #{self.class.name}"
-      end
-    end
-  end
-
-  def should_receive_and_return(methods_and_values)
-    methods_and_values.each do |method, value|
-      should_receive(method).and_return(value)
-    end
-  end
-
-  def should_receive_all_with(methods_and_values)
-    methods_and_values.each do |method, value|
-      should_receive(method).with(value)
-    end
-  end
-
-  def should_not_receive_and_execute(method)
-    should_receive_and_execute(method, true)
-  end
-
-  def should_receive_and_execute(method, negate = false)
-    method_base = method.to_s.gsub(/([\?\!\=\[\]]+)$/, '')
-    method_suffix = $1
-
-    method_called = "_#{method_base}_called#{method_suffix}"
-    method_with_spy = "#{method_base}_with_spy#{method_suffix}"
-    method_without_spy = "#{method_base}_without_spy#{method_suffix}"
-
-    prototype = respond_to?(:singleton_class) ? singleton_class : metaclass
-    prototype.class_eval do
-
-      unless method_defined?(method_with_spy)
-
-        define_method method_called do
-        end
-
-        define_method method_with_spy do |*args, &block|
-          send(method_called, *args)
-          send(method_without_spy, *args, &block)
-        end
-        alias_method_chain method, :spy
-      end
-
-    end
-
-    expectation = negate ? :should_not_receive : :should_receive
-    send(expectation, method_called)
-  end
-
-  private
-
-  def setup_expectation_chain(parts)
-    obj = self
-    for part in parts
-      if part == parts.last
-        obj = add_expectation_chain_link(obj, part)
-      else
-        next_obj = Spec::Mocks::Mock.new('chain link')
-        add_expectation_chain_link(obj, part).at_least(:once).and_return(next_obj)
-        obj = next_obj
-      end
-    end
-    obj
-  end
-
-  def add_expectation_chain_link(obj, part)
-    if part.is_a?(Array)
-      obj.should_receive(part.first).with(*part[1..-1])
-    else
-      obj.should_receive(part)
-    end
-  end
-
-end
-
-Spec::Example::ExampleGroupMethods.class_eval do
-
-  # Improves it_should_behave_like in some ways:
-  # - It scopes the reused examples so #let und #subject does not bleed into the reusing example groups
-  # - It allows to parametrize the reused example group by appending a hash argument.
-  #   Every key/value pair in the hash will become a #let variable for the reused example group
-  # - You can call it with a block. It will be available to the reused example group as let(:block)
-  def it_should_act_like(shared_example_group, environment = {}, &block)
-    description = "as #{shared_example_group}"
-    description << " (#{environment.inspect})" if environment.present?
-    describe description do
-      environment.each do |name, value|
-        let(name) { value }
-      end
-      let(:block) { block } if block
-      it_should_behave_like(shared_example_group)
-    end
-  end
-
-end
-
-Spec::Rails::Example::ModelExampleGroup.class_eval do
-
-  def self.it_should_run_callbacks_in_order(*callbacks)
-    callbacks.push(:ordered => true)
-    it_should_run_callbacks(*callbacks)
-  end
-
-  def self.it_should_run_callbacks(*callbacks)
-    options = callbacks.last.is_a?(Hash) ? callbacks.pop : {}
-    reason = callbacks.pop if callbacks.last.is_a?(String)
-    hook = description_parts.last.sub(/^#/, '')
-    should = ['should run callbacks', callbacks.inspect, ('in order' if options[:ordered]), reason].compact.join ' '
-    send(:it, should) do
-      callbacks.each do |callback|
-        expectation = subject.should_receive(callback).once
-        expectation.ordered if options[:ordered]
-      end
-      run_state_machine_callbacks_from_prose(hook) || subject.run_callbacks(hook)
-    end
-  end
-
-  private
-
-  def run_state_machine_callbacks_from_prose(prose)
-    if parts = prose.match(/^(\w+) from ([\:\w]+) to ([\:\w]+)$/)
-      name = parts[1].to_sym
-      from = parts[2].sub(/^:/, '').to_sym
-      to = parts[3].sub(/^:/, '').to_sym
-      transition = StateMachine::Transition.new(subject, subject.class.state_machine, name, from, to)
-      transition.run_callbacks
-    end
-  end
-
-end
-
-ActiveRecord::Base.class_eval do
-
-  # Prevents the databse from being touched, but still runs all validations.
-  def keep_invalid!
-    errors.stub :empty? => false
-  end
-
-end
-
-Class.class_eval do
-
-  define_method :stub_any_instance do |stubs|
-    unstubbed_new = method(:new)
-    stub(:new).and_return do |*args|
-      unstubbed_new.call(*args).tap do |obj|
-        obj.stub stubs
-      end
-    end
-    stubs
-  end
-
-end

data/template/spec_candy.rails3.rb

@@ -1,175 +0,0 @@
-Object.class_eval do
-
-#  def should_receive_chain(*parts)
-#    setup_expectation_chain(parts)
-#  end
-#
-#  def should_not_receive_chain(*parts)
-#    setup_expectation_chain(parts, :negate => true)
-#  end
-#
-#  def self.new_with_stubs(attrs)
-#    new.tap { |obj| obj.stub(attrs) }
-#  end
-#
-#  def should_receive_and_return(methods_and_values)
-#    methods_and_values.each do |method, value|
-#      should_receive(method).and_return(value)
-#    end
-#  end
-#
-#  def self.new_and_store(options = {})
-#    new.tap do |record|
-#      record.send(:attributes=, options, false)
-#      record.save!(:validate => false)
-#    end
-#  end
-#
-#  def stub_existing(attrs)
-#    attrs.each do |method, value|
-#      if respond_to?(method, true)
-#        stub(method => value)
-#      else
-#        raise "Attempted to stub non-existing method ##{method} on a #{self.class.name}"
-#      end
-#    end
-#  end
-#
-#  def should_receive_and_execute(method, negate = false)
-#    method_base = method.to_s.gsub(/([\?\!\=\[\]]+)$/, '')
-#    method_suffix = $1
-#
-#    method_called = "_#{method_base}_called#{method_suffix}"
-#    method_with_spy = "#{method_base}_with_spy#{method_suffix}"
-#    method_without_spy = "#{method_base}_without_spy#{method_suffix}"
-#
-#    prototype = respond_to?(:singleton_class) ? singleton_class : metaclass
-#    prototype.class_eval do
-#
-#      unless method_defined?(method_with_spy)
-#
-#        define_method method_called do
-#        end
-#
-#        define_method method_with_spy do |*args, &block|
-#          send(method_called, *args)
-#          send(method_without_spy, *args, &block)
-#        end
-#        alias_method_chain method, :spy
-#      end
-#
-#    end
-#
-#    expectation = negate ? :should_not_receive : :should_receive
-#    send(expectation, method_called)
-#  end
-#
-  private
-
-  def setup_expectation_chain(parts, options = {})
-    obj = self
-    for part in parts
-      if part == parts.last
-        expectation = options[:negate] ? :should_not_receive : :should_receive
-        obj = add_expectation_chain_link(obj, expectation, part)
-      else
-        next_obj = RSpec::Mocks::Mock.new('chain link')
-        add_expectation_chain_link(obj, :stub, part).and_return(next_obj)
-        obj = next_obj
-      end
-    end
-    obj
-  end
-
-  def add_expectation_chain_link(obj, expectation, part)
-    if part.is_a?(Array)
-      obj.send(expectation, part.first).with(*part[1..-1])
-    else
-      obj.send(expectation, part)
-    end
-  end
-
-end
-
-RSpec::Core::ExampleGroup.class_eval do
-
-  def self.it_should_run_callbacks_in_order(*callbacks)
-    callbacks.push(:ordered => true)
-    it_should_run_callbacks(*callbacks)
-  end
-
-
-  # Improves it_should_behave_like in some ways:
-  # - It scopes the reused examples so #let und #subject does not bleed into the reusing example groups
-  # - It allows to parametrize the reused example group by appending a hash argument.
-  #   Every key/value pair in the hash will become a #let variable for the reused example group
-  # - You can call it with a block. It will be available to the reused example group as let(:block)
-  def self.it_should_act_like(shared_example_group, environment = {}, &block)
-    description = "as #{shared_example_group}"
-    description << " (#{environment.inspect})" if environment.present?
-    describe description do
-      environment.each do |name, value|
-        let(name) { value }
-      end
-      let(:block) { block } if block
-      it_should_behave_like(shared_example_group)
-    end
-  end
-
-  def self.it_should_run_callbacks(*callbacks)
-    options = callbacks.last.is_a?(Hash) ? callbacks.pop : {}
-    reason = callbacks.pop if callbacks.last.is_a?(String)
-    example_description = description
-    send(:it, ["should run callbacks", callbacks.inspect, ('in order' if options[:ordered]), reason].compact.join(' ')) do
-      # Set expectations
-      callbacks.each do |callback|
-        expectation = subject.should_receive(callback).once
-        expectation.ordered if options[:ordered]
-      end
-      run_state_machine_callbacks_from_prose(example_description) || run_active_record_callbacks_from_prose(example_description)
-    end
-  end
-
-  def run_active_record_callbacks_from_prose(prose)
-    hook = prose.split.last.sub(/^#/, '')
-    if hook.sub!(/_on_(create|update)$/, '')
-      condition = "validation_context == :#{$1}"
-    else
-      condition = nil
-    end
-    if hook == 'validate'
-      kind = 'before'
-      action = 'validate'
-    else
-      hook =~ /^(before|after|around)_(.*)$/
-      kind = $1
-      action = $2
-    end
-    # Run all matching callbacks
-    subject.send("_#{action}_callbacks").each do |callback|
-      if callback.kind.to_s == kind && (condition.nil? || callback.options[:if].include?(condition))
-        subject.send callback.filter.to_s.gsub(/[\(,\)]/, '').to_sym
-      end
-    end
-  end
-
-  def run_state_machine_callbacks_from_prose(prose)
-    if parts = prose.match(/^(\#\w+) from ([\:\w]+) to ([\:\w]+)$/)
-      name = parts[1].sub(/^#/, '').to_sym
-      from = parts[2].sub(/^:/, '').to_sym
-      to = parts[3].sub(/^:/, '').to_sym
-      transition = StateMachine::Transition.new(subject, subject.class.state_machine, name, from, to)
-      transition.run_callbacks
-    end
-  end
-
-end
-
-ActiveRecord::Base.class_eval do
-
-  # Prevents the database from being touched, but still runs all validations.
-  def keep_invalid!
-    errors.stub :empty? => false
-  end
-
-end