mongoid-rspec 1.5.3 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22432282a4af9711e7ff58260bd7e9ccf7279a31
+  data.tar.gz: c183931632e9cdd7594ab6314678f3ca6f76f849
+SHA512:
+  metadata.gz: 1b3752eba793b316c4d0ccc611c4b6d9e8b766ceb43617a92185899c90839e4e9067dabe7b9b274868e85434c2c209189bb2278cbd7e644c51c8c7ecfcb83470
+  data.tar.gz: 69ac5c4fe2ddf2626021c2776e311394fc8a709713f926e16bb4ca4c3e58906d1f9880510d594c5887c4645155a285c8237e44b91082da7e2b32a4745a5321d3

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
+.rvmrc
 .bundle
 Gemfile.lock
 pkg/*
+

data/.ruby-gemset

@@ -0,0 +1 @@
+mongoid-rspec

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/.travis.yml

@@ -1,5 +1,10 @@
+services: mongodb
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
-  - ruby-head
+  - 2.1.3
+  - 2.2.0
+  - jruby-19mode
+
+gemfile:
+  - Gemfile

data/README.md

@@ -1,153 +1,228 @@
-mongoid-rspec
-=
-
-http://rubygems.org/gems/mongoid-rspec
-
-RSpec matchers for Mongoid 3.x.
-
-For Mongoid 2.x, use [mongoid-rspec 1.4.5](http://rubygems.org/gems/mongoid-rspec/versions/1.4.5)
-
-Association Matchers
--
-    describe User do
-      it { should have_many(:articles).with_foreign_key(:author_id) }
-
-      it { should have_one(:record) }
-
-      it { should have_many :comments }
-
-      #can also specify with_dependent to test if :dependent => :destroy/:destroy_all/:delete is set
-      it { should have_many(:comments).with_dependent(:destroy) }
-      #can verify autosave is set to true
-      it { should have_many(:comments).with_autosave }
-
-      it { should embed_one :profile }
-
-      it { should have_and_belong_to_many(:children) }
-      it { should have_and_belong_to_many(:children).of_type(User) }
-    end
-
-    describe Profile do
-      it { should be_embedded_in(:user).as_inverse_of(:profile) }
-    end
-
-    describe Article do
-      it { should belong_to(:author).of_type(User).as_inverse_of(:articles) }
-      it { should belong_to(:author).of_type(User).as_inverse_of(:articles).with_index }
-      it { should embed_many(:comments) }
-    end
-
-    describe Comment do
-      it { should be_embedded_in(:article).as_inverse_of(:comments) }
-      it { should belong_to(:user).as_inverse_of(:comments) }
-    end
-
-    describe Record do
-      it { should belong_to(:user).as_inverse_of(:record) }
-    end
-
-Mass Assignment Matcher
--
-    describe User do
-      it { should allow_mass_assignment_of(:login) }
-      it { should allow_mass_assignment_of(:email) }
-      it { should allow_mass_assignment_of(:age) }
-      it { should allow_mass_assignment_of(:password) }
-      it { should allow_mass_assignment_of(:password) }
-      it { should allow_mass_assignment_of(:role).as(:admin) }
-
-      it { should_not allow_mass_assignment_of(:role) }
-    end
-
-Validation Matchers
--
-    describe Site do
-      it { should validate_presence_of(:name) }
-      it { should validate_uniqueness_of(:name) }
-    end
-
-    describe User do
-      it { should validate_presence_of(:login) }
-      it { should validate_uniqueness_of(:login).scoped_to(:site) }
-      it { should validate_uniqueness_of(:email).case_insensitive.with_message("is already taken") }
-      it { should validate_format_of(:login).to_allow("valid_login").not_to_allow("invalid login") }
-      it { should validate_associated(:profile) }
-      it { should validate_exclusion_of(:login).to_not_allow("super", "index", "edit") }
-      it { should validate_inclusion_of(:role).to_allow("admin", "member") }
-      it { should validate_confirmation_of(:email) }
-      it { should validate_presence_of(:age).on(:create, :update) }
-      it { should validate_numericality_of(:age).on(:create, :update) }
-      it { should validate_inclusion_of(:age).to_allow(23..42).on([:create, :update]) }
-      it { should validate_presence_of(:password).on(:create) }
-      it { should validate_presence_of(:provider_uid).on(:create) }
-      it { should validate_inclusion_of(:locale).to_allow([:en, :ru]) }
-	  end
-
-    describe Article do
-      it { should validate_length_of(:title).within(8..16) }
-    end
-
-    describe Profile do
-      it { should validate_numericality_of(:age).greater_than(0) }
-    end
-
-    describe MovieArticle do
-      it { should validate_numericality_of(:rating).to_allow(:greater_than => 0).less_than_or_equal_to(5) }
-      it { should validate_numericality_of(:classification).to_allow(:even => true, :only_integer => true, :nil => false) }
-    end
-
-    describe Person do
-       # in order to be able to use the custom_validate matcher, the custom validator class (in this case SsnValidator)
-       # should redefine the kind method to return :custom, i.e. "def self.kind() :custom end"
-      it { should custom_validate(:ssn).with_validator(SsnValidator) }
-    end
-
-Index Matcher
--
-    describe Article do
-      it { should have_index_for(published: 1) }
-      it { should have_index_for(title: 1).with_options(unique: true, background: true) }
-    end
-
-    describe Profile do
-      it { should have_index_for(first_name: 1, last_name: 1) }
-    end
-
-Others
--
-    describe User do
-      it { should have_fields(:email, :login) }
-      it { should have_field(:active).of_type(Boolean).with_default_value_of(false) }
-      it { should have_fields(:birthdate, :registered_at).of_type(DateTime) }
-
-      it { should be_timestamped_document } # if you're declaring `include
-      Mongoid::Timestamps` or any of `include Mongoid::Timestamps::Created` and `Mongoid::Timestamps::Updated`
-      it { should be_timestamped_document.with(:created) }
-      it { should_not be_timestamped_document.with(:updated) }
-
-      it { should be_versioned_document } # if you're declaring `include Mongoid::Versioning`
-      it { should be_paranoid_document } # if you're declaring `include Mongoid::Paranoia`
-      it { should be_multiparameted_document } # if you're declaring `include Mongoid::MultiParameterAttributes`
-    end
-
-    describe Log do
-      it { should be_stored_in :logs }
-    end
-
-Use
--
-add in Gemfile
-
-    gem 'mongoid-rspec'
-
-drop in existing or dedicated support file in spec/support (spec/support/mongoid.rb)
-
-    RSpec.configure do |configuration|
-      configuration.include Mongoid::Matchers
-    end
-
-Acknowledgement
--
-Thanks to [Durran Jordan](https://github.com/durran) for providing the changes necessary to make
-this compatible with mongoid 2.0.0.rc, and for other [contributors](https://github.com/evansagge/mongoid-rspec/contributors)
+# mongoid-rspec
+
+[![Build Status][travis_badge]][travis]
+[![Gem Version][rubygems_badge]][rubygems]
+[![Code Climate][codeclimate_badge]][codeclimate]
+
+mongoid-rspec provides a collection of RSpec-compatible matchers that help to test mongoid documents.
+
+## Installation
+
+### With Mongoid 4.x
+
+Use mongoid-rspec [2.0.0.rc1][mongo4]
+
+    gem 'mongoid-rspec', '~> 2.0.0.rc1'
+
+### With Mongoid 3.x
+
+Use mongoid-rspec [1.11.0][mongo3].
+
+    gem 'mongoid-rspec', '~> 1.11.0'
+
+### With Mongoid 2.x
+
+Use mongoid-rspec [1.4.5][mongo2]
+
+    gem 'mongoid-rspec', '1.4.5'
+
+### Configuring
+
+Drop in existing or dedicated support file in spec/support.
+i.e: `spec/support/mongoid.rb`
+
+```ruby
+RSpec.configure do |config|
+  config.include Mongoid::Matchers, type: :model
+end
+```
+
+## Matchers
+
+### Association Matchers
+
+```ruby
+describe User do
+  it { should have_many(:articles).with_foreign_key(:author_id).ordered_by(:title) }
+
+  it { should have_one(:record) }
+  #can verify autobuild is set to true
+  it { should have_one(:record).with_autobuild }
+
+  it { should have_many :comments }
+
+  #can also specify with_dependent to test if :dependent => :destroy/:destroy_all/:delete is set
+  it { should have_many(:comments).with_dependent(:destroy) }
+  #can verify autosave is set to true
+  it { should have_many(:comments).with_autosave }
+
+  it { should embed_one :profile }
+
+  it { should have_and_belong_to_many(:children) }
+  it { should have_and_belong_to_many(:children).of_type(User) }
+end
+
+describe Profile do
+  it { should be_embedded_in(:user).as_inverse_of(:profile) }
+end
+
+describe Article do
+  it { should belong_to(:author).of_type(User).as_inverse_of(:articles) }
+  it { should belong_to(:author).of_type(User).as_inverse_of(:articles).with_index }
+  it { should embed_many(:comments) }
+end
+
+describe Comment do
+  it { should be_embedded_in(:article).as_inverse_of(:comments) }
+  it { should belong_to(:user).as_inverse_of(:comments) }
+end
+
+describe Record do
+  it { should belong_to(:user).as_inverse_of(:record) }
+end
+
+describe Site do
+  it { should have_many(:users).as_inverse_of(:site).ordered_by(:email.asc) }
+end
+```
+
+### Mass Assignment Matcher
+
+```ruby
+describe User do
+  it { should allow_mass_assignment_of(:login) }
+  it { should allow_mass_assignment_of(:email) }
+  it { should allow_mass_assignment_of(:age) }
+  it { should allow_mass_assignment_of(:password) }
+  it { should allow_mass_assignment_of(:password) }
+  it { should allow_mass_assignment_of(:role).as(:admin) }
+
+  it { should_not allow_mass_assignment_of(:role) }
+end
+```
+
+### Validation Matchers
+
+```ruby
+describe Site do
+  it { should validate_presence_of(:name) }
+  it { should validate_uniqueness_of(:name) }
+end
+
+describe User do
+  it { should validate_presence_of(:login) }
+  it { should validate_uniqueness_of(:login).scoped_to(:site) }
+  it { should validate_uniqueness_of(:email).case_insensitive.with_message("is already taken") }
+  it { should validate_format_of(:login).to_allow("valid_login").not_to_allow("invalid login") }
+  it { should validate_associated(:profile) }
+  it { should validate_exclusion_of(:login).to_not_allow("super", "index", "edit") }
+  it { should validate_inclusion_of(:role).to_allow("admin", "member") }
+  it { should validate_confirmation_of(:email) }
+  it { should validate_presence_of(:age).on(:create, :update) }
+  it { should validate_numericality_of(:age).on(:create, :update) }
+  it { should validate_inclusion_of(:age).to_allow(23..42).on([:create, :update]) }
+  it { should validate_presence_of(:password).on(:create) }
+  it { should validate_presence_of(:provider_uid).on(:create) }
+  it { should validate_inclusion_of(:locale).to_allow([:en, :ru]) }
+end
+
+describe Article do
+  it { should validate_length_of(:title).within(8..16) }
+end
+
+describe Profile do
+  it { should validate_numericality_of(:age).greater_than(0) }
+end
+
+describe MovieArticle do
+  it { should validate_numericality_of(:rating).to_allow(:greater_than => 0).less_than_or_equal_to(5) }
+  it { should validate_numericality_of(:classification).to_allow(:even => true, :only_integer => true, :nil => false) }
+end
+
+describe Person do
+   # in order to be able to use the custom_validate matcher, the custom validator class (in this case SsnValidator)
+   # should redefine the kind method to return :custom, i.e. "def self.kind() :custom end"
+  it { should custom_validate(:ssn).with_validator(SsnValidator) }
+end
+```
+
+### Accepts Nested Attributes Matcher
+
+```ruby
+describe User do
+  it { should accept_nested_attributes_for(:articles) }
+  it { should accept_nested_attributes_for(:comments) }
+end
+
+describe Article do
+  it { should accept_nested_attributes_for(:permalink) }
+end
+```
+
+### Index Matcher
+
+```ruby
+describe Article do
+  it { should have_index_for(published: 1) }
+  it { should have_index_for(title: 1).with_options(unique: true, background: true) }
+end
+
+describe Profile do
+  it { should have_index_for(first_name: 1, last_name: 1) }
+end
+```
+
+### Others
+
+```ruby
+describe User do
+  it { should have_fields(:email, :login) }
+  it { should have_field(:s).with_alias(:status) }
+  it { should have_fields(:birthdate, :registered_at).of_type(DateTime) }
+
+  # if you're declaring 'include Mongoid::Timestamps'
+  # or any of 'include Mongoid::Timestamps::Created' and 'Mongoid::Timestamps::Updated'
+  it { should be_timestamped_document }
+  it { should be_timestamped_document.with(:created) }
+  it { should_not be_timestamped_document.with(:updated) }
+
+  it { should be_versioned_document } # if you're declaring `include Mongoid::Versioning`
+  it { should be_paranoid_document } # if you're declaring `include Mongoid::Paranoia`
+  it { should be_multiparameted_document } # if you're declaring `include Mongoid::MultiParameterAttributes`
+end
+
+describe Log do
+  it { should be_stored_in :logs }
+end
+
+describe Article do
+  it { should have_field(:published).of_type(Boolean).with_default_value_of(false) }
+  it { should have_field(:allow_comments).of_type(Boolean).with_default_value_of(true) }
+  it { should_not have_field(:allow_comments).of_type(Boolean).with_default_value_of(false) }
+  it { should_not have_field(:number_of_comments).of_type(Integer).with_default_value_of(1) }
+end
+```
+
+## Known issues
+
+accept_nested_attributes_for matcher must test options [issue 91](https://github.com/mongoid-rspec/mongoid-rspec/issues/91).
+
+## Acknowledgement
+
+Thanks to [Durran Jordan][durran] for providing the changes necessary to make
+this compatible with mongoid 2.0.0.rc, and for other [contributors](https://github.com/mongoid-rspec/mongoid-rspec/contributors)
 to this project.
+
+[durran]: https://github.com/durran
+[mongo2]: http://rubygems.org/gems/mongoid-rspec/versions/1.4.5
+[mongo3]: http://rubygems.org/gems/mongoid-rspec/versions/1.11.0
+[mongo4]: http://rubygems.org/gems/mongoid-rspec/versions/2.0.0.rc1
+
+[travis_badge]: http://img.shields.io/travis/mongoid-rspec/mongoid-rspec.svg?style=flat
+[travis]: https://travis-ci.org/mongoid-rspec/mongoid-rspec
+
+[rubygems_badge]: http://img.shields.io/gem/v/mongoid-rspec.svg?style=flat
+[rubygems]: http://rubygems.org/gems/mongoid-rspec
+
+[codeclimate_badge]: http://img.shields.io/codeclimate/github/mongoid-rspec/mongoid-rspec.svg?style=flat
+[codeclimate]: https://codeclimate.com/github/mongoid-rspec/mongoid-rspec

data/lib/matchers/accept_nested_attributes.rb

@@ -0,0 +1,67 @@
+module Mongoid
+  module Matchers # :nodoc:
+
+    # Ensures that the model can accept nested attributes for the specified
+    # association.
+    #
+    # Example:
+    #   it { should accept_nested_attributes_for(:articles) }
+    #
+    def accept_nested_attributes_for(attribute)
+      AcceptNestedAttributesForMatcher.new(attribute)
+    end
+
+    class AcceptNestedAttributesForMatcher
+
+      def initialize(attribute)
+        @attribute = attribute.to_s
+        @options = {}
+      end
+
+      def matches?(subject)
+        @subject = subject
+        match?
+      end
+
+      def failure_message
+        "Expected #{expectation} (#{@problem})"
+      end
+
+      def negative_failure_message
+        "Did not expect #{expectation}"
+      end
+
+      alias :failure_message_when_negated :negative_failure_message
+
+      def description
+        description = "accepts_nested_attributes_for :#{@attribute}"
+      end
+
+      protected
+        def match?
+          exists?
+        end
+
+        def exists?
+          if config
+            true
+          else
+            @problem = 'is not declared'
+            false
+          end
+        end
+
+        def config
+          model_class.nested_attributes["#{@attribute}_attributes"]
+        end
+
+        def model_class
+          @subject.class
+        end
+
+        def expectation
+          "#{model_class.name} to accept nested attributes for #{@attribute}"
+        end
+    end
+  end
+end

data/lib/matchers/allow_mass_assignment.rb

@@ -3,6 +3,7 @@ module Mongoid
   module Matchers
     class AllowMassAssignmentOfMatcher # :nodoc:
       attr_reader :failure_message, :negative_failure_message
+      alias :failure_message_when_negated :negative_failure_message
 
       def initialize(attribute)
         @attribute = attribute.to_s