remockable 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee2c0d5e24fd72b1280d3919d63e2aaf3563dc4f
+  data.tar.gz: ca1a9717a4db8971bc24b37382751cb393929b14
+SHA512:
+  metadata.gz: 9c8d53e66884d01edb3ac664b804a000fabff8d5544c613709bcb484e0412517f5dde27441002e41cb0c099ab4313b23d7bbf8647c0f6caf048884af2491b4a4
+  data.tar.gz: a0130e79de52649f5df8af42afe7020fec8b112c650fcad1962dc7d9313b95addee9d598e4037c50ffa7d4d9a0c1dc29fca5a43721d3c19025c0dfa64901c16b

data/.gitignore

@@ -1,5 +1,6 @@
 *.swp
 .bundle
+.rspec
 .rvmrc
 Gemfile.lock
 bin

data/.rspec

@@ -1 +1,2 @@
 --color
+--require spec_helper

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 script: bundle exec rspec
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
+  - 2.0
+  - 2.1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.3.0 (2014-07-21)
+
+  * Support and require RSpec ~> 3.0 ([Tyler Hunt][tylerhunt])
+  * Improve documentation ([Olivier Lacan][olivierlacan])
+
 ## 0.2.1 (2013-10-18)
 
   * Require Rails ~> 4.0 ([Tyler Hunt][tylerhunt])
@@ -84,4 +89,5 @@
   * Initial release ([Tyler Hunt][tylerhunt])
 
 [jswanner]: https://github.com/jswanner
+[olivierlacan]: https://github.com/olivierlacan
 [tylerhunt]: https://github.com/tylerhunt

data/README.markdown

@@ -1,11 +1,15 @@
 # Remockable
 
-[![Build Status][travis-image]][travis]
+[![Build Status][travis-image]][travis] [![Dependency Status][gemnasium-image]][gemnasium] [![Gem Version][rubygems-image]][rubygems]
 
 [travis]: http://travis-ci.org/tylerhunt/remockable
 [travis-image]: https://secure.travis-ci.org/tylerhunt/remockable.png
+[gemnasium]: https://gemnasium.com/tylerhunt/remockable
+[gemnasium-image]: https://gemnasium.com/tylerhunt/remockable.png
+[rubygems]: http://badge.fury.io/rb/remockable
+[rubygems-image]: https://badge.fury.io/rb/remockable.png
 
-A collection of RSpec 2 matchers to simplify your web app specs.
+A collection of RSpec 3 matchers to simplify your web app specs.
 
 *Note:* Rails 3 support was dropped in version 0.2.
 
@@ -20,13 +24,13 @@ release of Rails 3 and 4.
 In looking at the code for Remarkable to determine the feasibility of continuing
 work on Remarkable itself, it seems clear that the scope of that project has
 outgrown its usefulness for most users. It was with this conclusion in mind that
-Remockable was born. It's an attempt to start with a clean slate but maintain
+Remockable was born. It’s an attempt to start with a clean slate but maintain
 the original goal of Remarkable in spirit.
 
 
 ## Installation
 
-Add this line to your application's `Gemfile`:
+Add this line to your application’s `Gemfile`:
 
 ``` ruby
 gem 'remockable'
@@ -74,6 +78,16 @@ The following Active Record matchers are supported:
   * `validate_associated`
   * `validate_uniqueness_of`
 
+### Options
+
+Options may be passed to the matchers in the same way they’re passed to the
+macros. For instance, when dealing with `has_many :through` associations, you
+could specify the following:
+
+``` ruby
+it { should have_many :subscriptions, through: :customers }
+```
+
 
 ## Contributing
 

data/lib/remockable/active_model/allow_values_for.rb

@@ -1,32 +1,33 @@
 RSpec::Matchers.define(:allow_values_for) do |*attribute_and_values|
-  @attribute = attribute_and_values.shift
-  @values = attribute_and_values
+  def values
+    expected_as_array[1..-1]
+  end
 
-  match_for_should do |actual|
-    @values.all? do |value|
-      subject.stub(@attribute).and_return(value)
+  match do |actual|
+    values.all? do |value|
+      allow(subject).to receive(attribute).and_return(value)
       subject.valid?
-      subject.errors[@attribute].empty?
+      subject.errors[attribute].empty?
     end
   end
 
-  match_for_should_not do |actual|
-    @values.none? do |value|
-      subject.stub(@attribute).and_return(value)
+  match_when_negated do |actual|
+    values.none? do |value|
+      allow(subject).to receive(attribute).and_return(value)
       subject.valid?
-      subject.errors[@attribute].empty?
+      subject.errors[attribute].empty?
     end
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{actual.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{actual.class.name} to #{description}"
   end
 
   description do
-    "allow the values #{@values.collect(&:inspect).to_sentence} for #{@attribute}"
+    "allow the values #{values.collect(&:inspect).to_sentence} for #{attribute}"
   end
 end

data/lib/remockable/active_model/helpers.rb

@@ -1,28 +1,29 @@
+require 'active_support/concern'
+
 require 'remockable/helpers'
 
 module Remockable
   module ActiveModel
     module Helpers
+      extend ActiveSupport::Concern
       include Remockable::Helpers
 
       CONDITIONALS = [:if, :unless]
 
-      attr_reader :type
-
       def validator_for(attribute)
         subject.class.validators_on(attribute).detect do |validator|
           validator.kind == type
         end
       end
 
-      def options_match(validator, expected=expected)
-        actual = validator.options.slice(*(expected.keys - CONDITIONALS))
-        actual == expected.except(*CONDITIONALS)
+      def options_match(validator, options=options)
+        actual = validator.options.slice(*(options.keys - CONDITIONALS))
+        actual == options.except(*CONDITIONALS)
       end
 
       def conditionals_match(validator)
         CONDITIONALS.all? do |option|
-          expected_value = expected[option]
+          expected_value = options[option]
 
           if !expected_value.nil? && expected_value.is_a?(Symbol)
             validator.options[option] == expected_value

data/lib/remockable/active_model/validate_acceptance_of.rb

@@ -1,27 +1,25 @@
-RSpec::Matchers.define(:validate_acceptance_of) do |*attribute|
-  extend Remockable::ActiveModel::Helpers
+RSpec::Matchers.define(:validate_acceptance_of) do
+  include Remockable::ActiveModel::Helpers
 
-  @type = :acceptance
-  @expected = attribute.extract_options!
-  @attribute = attribute.shift
+  type :acceptance
 
-  valid_options %w(allow_nil accept if message on unless)
+  valid_options %i(allow_nil accept if message on unless)
 
   match do |actual|
-    validator = validator_for(@attribute)
+    validator = validator_for(attribute)
     validator && options_match(validator) && conditionals_match(validator)
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "validate #{type} of #{@attribute}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "validate #{type} of #{attribute}#{with}"
   end
 end

data/lib/remockable/active_model/validate_confirmation_of.rb

@@ -1,27 +1,25 @@
-RSpec::Matchers.define(:validate_confirmation_of) do |*attribute|
-  extend Remockable::ActiveModel::Helpers
+RSpec::Matchers.define(:validate_confirmation_of) do
+  include Remockable::ActiveModel::Helpers
 
-  @type = :confirmation
-  @expected = attribute.extract_options!
-  @attribute = attribute.shift
+  type :confirmation
 
-  valid_options %w(if message on unless)
+  valid_options %i(if message on unless)
 
   match do |actual|
-    validator = validator_for(@attribute)
+    validator = validator_for(attribute)
     validator && options_match(validator) && conditionals_match(validator)
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "validate #{type} of #{@attribute}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "validate #{type} of #{attribute}#{with}"
   end
 end

data/lib/remockable/active_model/validate_exclusion_of.rb

@@ -1,27 +1,25 @@
-RSpec::Matchers.define(:validate_exclusion_of) do |*attribute|
-  extend Remockable::ActiveModel::Helpers
+RSpec::Matchers.define(:validate_exclusion_of) do
+  include Remockable::ActiveModel::Helpers
 
-  @type = :exclusion
-  @expected = attribute.extract_options!
-  @attribute = attribute.shift
+  type :exclusion
 
-  valid_options %w(allow_nil allow_blank if in message on unless)
+  valid_options %i(allow_nil allow_blank if in message on unless)
 
   match do |actual|
-    validator = validator_for(@attribute)
+    validator = validator_for(attribute)
     validator && options_match(validator) && conditionals_match(validator)
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "validate #{type} of #{@attribute}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "validate #{type} of #{attribute}#{with}"
   end
 end

data/lib/remockable/active_model/validate_format_of.rb

@@ -1,27 +1,25 @@
-RSpec::Matchers.define(:validate_format_of) do |*attribute|
-  extend Remockable::ActiveModel::Helpers
+RSpec::Matchers.define(:validate_format_of) do
+  include Remockable::ActiveModel::Helpers
 
-  @type = :format
-  @expected = attribute.extract_options!
-  @attribute = attribute.shift
+  type :format
 
-  valid_options %w(allow_blank allow_nil if message on unless with without)
+  valid_options %i(allow_blank allow_nil if message on unless with without)
 
   match do |actual|
-    validator = validator_for(@attribute)
+    validator = validator_for(attribute)
     validator && options_match(validator) && conditionals_match(validator)
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "validate #{type} of #{@attribute}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "validate #{type} of #{attribute}#{with}"
   end
 end

data/lib/remockable/active_model/validate_inclusion_of.rb

@@ -1,27 +1,25 @@
-RSpec::Matchers.define(:validate_inclusion_of) do |*attribute|
-  extend Remockable::ActiveModel::Helpers
+RSpec::Matchers.define(:validate_inclusion_of) do
+  include Remockable::ActiveModel::Helpers
 
-  @type = :inclusion
-  @expected = attribute.extract_options!
-  @attribute = attribute.shift
+  type :inclusion
 
-  valid_options %w(allow_nil allow_blank if in message on unless)
+  valid_options %i(allow_nil allow_blank if in message on unless)
 
   match do |actual|
-    validator = validator_for(@attribute)
+    validator = validator_for(attribute)
     validator && options_match(validator) && conditionals_match(validator)
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "validate #{type} of #{@attribute}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "validate #{type} of #{attribute}#{with}"
   end
 end

data/lib/remockable/active_model/validate_length_of.rb

@@ -1,41 +1,54 @@
-RSpec::Matchers.define(:validate_length_of) do |*attribute|
-  extend Remockable::ActiveModel::Helpers
+RSpec::Matchers.define(:validate_length_of) do
+  include Remockable::ActiveModel::Helpers
 
-  @type = :length
-  @expected = attribute.extract_options!
-  @attribute = attribute.shift
+  type :length
 
-  unsupported_options %w(tokenizer)
-  valid_options %w(allow_blank allow_nil if in is maximum message minimum on
-    too_long too_short unless within wrong_length)
+  unsupported_options %i(tokenizer)
+
+  valid_options %i(
+    allow_blank
+    allow_nil
+    if
+    in
+    is
+    maximum
+    message
+    minimum
+    on
+    too_long
+    too_short
+    unless
+    within
+    wrong_length
+  )
 
   match do |actual|
-    if validator = validator_for(@attribute)
-      options_match = options_match(validator, normalized_expected)
+    if validator = validator_for(attribute)
+      options_match = options_match(validator, normalized_options)
       conditionals_match = conditionals_match(validator)
       options_match && conditionals_match
     end
   end
 
-  def normalized_expected
-    expected.dup.tap do |expected|
-      if within = expected.delete(:within) || expected.delete(:in)
-        expected[:minimum] = within.first
-        expected[:maximum] = within.last
+  def normalized_options
+    options.dup.tap do |options|
+      if within = options.delete(:within) || options.delete(:in)
+        options[:minimum] = within.first
+        options[:maximum] = within.last
       end
     end
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "validate #{type} of #{@attribute}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "validate #{type} of #{attribute}#{with}"
   end
 end

data/lib/remockable/active_model/validate_numericality_of.rb

@@ -1,28 +1,39 @@
-RSpec::Matchers.define(:validate_numericality_of) do |*attribute|
-  extend Remockable::ActiveModel::Helpers
+RSpec::Matchers.define(:validate_numericality_of) do
+  include Remockable::ActiveModel::Helpers
 
-  @type = :numericality
-  @expected = attribute.extract_options!
-  @attribute = attribute.shift
+  type :numericality
 
-  valid_options %w(allow_nil equal_to even greater_than greater_than_or_equal_to
-    if less_than less_than_or_equal_to message odd on only_integer unless)
+  valid_options %i(
+    allow_nil
+    equal_to
+    even
+    greater_than
+    greater_than_or_equal_to
+    if
+    less_than
+    less_than_or_equal_to
+    message
+    odd
+    on
+    only_integer
+    unless
+  )
 
   match do |actual|
-    validator = validator_for(@attribute)
+    validator = validator_for(attribute)
     validator && options_match(validator) && conditionals_match(validator)
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "validate #{type} of #{@attribute}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "validate #{type} of #{attribute}#{with}"
   end
 end

data/lib/remockable/active_model/validate_presence_of.rb

@@ -1,27 +1,25 @@
-RSpec::Matchers.define(:validate_presence_of) do |*attribute|
-  extend Remockable::ActiveModel::Helpers
+RSpec::Matchers.define(:validate_presence_of) do
+  include Remockable::ActiveModel::Helpers
 
-  @type = :presence
-  @expected = attribute.extract_options!
-  @attribute = attribute.shift
+  type :presence
 
-  valid_options %w(if message on unless)
+  valid_options %i(if message on unless)
 
   match do |actual|
-    validator = validator_for(@attribute)
+    validator = validator_for(attribute)
     validator && options_match(validator) && conditionals_match(validator)
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "validate #{type} of #{@attribute}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "validate #{type} of #{attribute}#{with}"
   end
 end

data/lib/remockable/active_record/accept_nested_attributes_for.rb

@@ -1,28 +1,25 @@
-RSpec::Matchers.define(:accept_nested_attributes_for) do |*association|
-  extend Remockable::ActiveRecord::Helpers
+RSpec::Matchers.define(:accept_nested_attributes_for) do
+  include Remockable::ActiveRecord::Helpers
 
-  @expected = association.extract_options!
-  @association = association.shift
-
-  unsupported_options %w(reject_if)
-  valid_options %w(allow_destroy limit update_only)
+  unsupported_options %i(reject_if)
+  valid_options %i(allow_destroy limit update_only)
 
   match do |actual|
-    if options = subject.class.nested_attributes_options[@association]
-      options.slice(*expected.keys) == expected
+    if actual_options = subject.class.nested_attributes_options[attribute]
+      actual_options.slice(*options.keys) == options
     end
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "accept nested attributes for #{@association}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "accept nested attributes for #{attribute}#{with}"
   end
 end

data/lib/remockable/active_record/belong_to.rb

@@ -1,30 +1,38 @@
-RSpec::Matchers.define(:belong_to) do |*association|
-  extend Remockable::ActiveRecord::Helpers
+RSpec::Matchers.define(:belong_to) do
+  include Remockable::ActiveRecord::Helpers
 
-  @expected = association.extract_options!
-  @association = association.shift
-
-  valid_options %w(class_name foreign_key foreign_type primary_key dependent
-    counter_cache polymorphic validate autosave touch inverse_of)
+  valid_options %i(
+    autosave
+    class_name
+    counter_cache
+    dependent
+    foreign_key
+    foreign_type
+    inverse_of
+    polymorphic
+    primary_key
+    touch
+    validate
+  )
 
   match do |actual|
-    if association = subject.class.reflect_on_association(@association)
+    if association = subject.class.reflect_on_association(attribute)
       macro_matches = association.macro == :belongs_to
-      options_match = association.options.slice(*expected.keys) == expected
+      options_match = association.options.slice(*options.keys) == options
       macro_matches && options_match
     end
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Expected #{subject.class.name} to #{description}"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_when_negated do |actual|
     "Did not expect #{subject.class.name} to #{description}"
   end
 
   description do
-    with = " with #{expected.inspect}" if expected.any?
-    "belong to #{@association}#{with}"
+    with = " with #{options.inspect}" if options.any?
+    "belong to #{attribute}#{with}"
   end
 end