mongoid-rspec 1.5.0 → 1.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90683af43b99f047532aad535c6e43dd6967f95d
+  data.tar.gz: 6dc40541b28ba2944e2a28e1db7aac2a1d8f986f
+SHA512:
+  metadata.gz: 4600c194356594e38e1ce975412e3a64ae740deaef458adc1f069936254bc2b85c59fffbee44ee6272197affab3a998e8bf76f4d2f62eab7715cdca68e58cb74
+  data.tar.gz: fbd39276f0ae7b8bf388c488df939ce343bbeaa25377b79094ff24b8593590e402549681e1290ba857d5a318d4675ca1e7ed3abe449c1cad20c4cd5b5d005350

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 @@
+ruby-2.1.0

data/.travis.yml

@@ -1,5 +1,17 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
-  - ruby-head
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+  - rbx-2.1.1
+  - rbx-head
+  - ree
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-head

data/README.md

@@ -1,125 +1,205 @@
 mongoid-rspec
 =
 
-RSpec matchers for Mongoid.
+[![Build Status](https://secure.travis-ci.org/evansagge/mongoid-rspec.png?branch=master)](https://travis-ci.org/evansagge/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)
+
+Installation
+-
+Add to your Gemfile
+
+    gem 'mongoid-rspec'
+
+Drop in existing or dedicated support file in spec/support (spec/support/mongoid.rb)
+
+```ruby
+RSpec.configure do |config|
+  config.include Mongoid::Matchers, type: :model
+end
+```
 
 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
+
+```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
 -
-    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) }
-		# The on matcher can take var args or an array. Validations do not fail if on is not specified.
-	    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) }
-	  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
+
+```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
 -
-    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 have_index_for(:last_name) }
-      it { should have_index_for(:email).with_options(:unique => true) }
-
-      # useful if you use factory_girl and have Factory(:user) defined for User
-      it { should save }
-      
-      it { should be_timestamped_document } # if you're declaring `include Mongoid::Timestamps`
-      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
+
+```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
 -
-add in Gemfile
 
-    gem 'mongoid-rspec'
-    
-drop in existing or dedicated support file in spec/support (spec/support/mongoid.rb)
+accept_nested_attributes_for matcher must test options [issue 91](https://github.com/evansagge/mongoid-rspec/issues/91).
 
-    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) 
+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)
 to this project.

data/lib/matchers/accept_nested_attributes.rb

@@ -0,0 +1,65 @@
+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
+
+      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/associations.rb

@@ -12,16 +12,11 @@ module Mongoid
       EMBEDS_ONE = Mongoid::Relations::Embedded::One
       EMBEDDED_IN = Mongoid::Relations::Embedded::In
 
-
       class HaveAssociationMatcher
         def initialize(name, association_type)
           @association = {}
           @association[:name] = name.to_s
           @association[:type] = association_type
-          # begin
-          #   @association[:class] = name.to_s.classify.constantize
-          # rescue
-          # end
           @expectation_message = "#{type_description} #{@association[:name].inspect}"
           @expectation_message << " of type #{@association[:class].inspect}" unless @association[:class].nil?
         end
@@ -39,6 +34,19 @@ module Mongoid
           self
         end
 
+        def ordered_by(association_field_name)
+          raise "#{@association[:type].inspect} does not respond to :order" unless [HAS_MANY, HAS_AND_BELONGS_TO_MANY, EMBEDS_MANY].include?(@association[:type])
+          @association[:order] = association_field_name.to_s
+          @expectation_message << " ordered by #{@association[:order].inspect}"
+
+          if association_field_name.is_a? Origin::Key
+            @association[:order_operator] = association_field_name.operator
+            @expectation_message << " #{order_way(@association[:order_operator])}"
+          end
+
+          self
+        end
+
         def with_dependent(method_name)
           @association[:dependent] = method_name
           @expectation_message << " which specifies dependent as #{@association[:dependent].to_s}"
@@ -57,8 +65,34 @@ module Mongoid
           self
         end
 
+        def with_autobuild
+          @association[:autobuild] = true
+          @expectation_message << " which specifies autobuild as #{@association[:autobuild].to_s}"
+          self
+        end
+
+        def with_polymorphism
+          @association[:polymorphic] = true
+          @expectation_message << " which specifies polymorphic as #{@association[:polymorphic].to_s}"
+          self
+        end
+
+        def with_cascading_callbacks
+          @association[:cascade_callbacks] = true
+          @expectation_message << " which specifies cascade_callbacks as #{@association[:cascade_callbacks].to_s}"
+          self
+        end
+
+        def cyclic
+          @association[:cyclic] = true
+          @expectation_message << " which specifies cyclic as #{@association[:cyclic].to_s}"
+          self
+        end
+
         def stored_as(store_as)
-          raise NotImplementedError, "`references_many #{@association[:name]} :stored_as => :array` has been removed in Mongoid 2.0.0.rc, use `references_and_referenced_in_many #{@association[:name]}` instead"
+          @association[:store_as] = store_as.to_s
+          @expectation_message << " which is stored as #{@association[:store_as].inspect}"
+          self
         end
 
         def with_foreign_key(foreign_key)
@@ -102,6 +136,24 @@ module Mongoid
             end
           end
 
+          if @association[:order]
+            if @association[:order].to_s != metadata.order.to_s
+              @negative_result_message = "#{@positive_result_message} ordered by #{metadata.order}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} ordered by #{metadata.order}"
+            end
+          end
+
+          if @association[:order_operator]
+            if @association[:order_operator] != metadata.order.operator
+              @negative_result_message = "#{@positive_result_message} #{order_way(@association[:order_operator] * -1)}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} #{order_way(@association[:order_operator])}"
+            end
+          end
+
           if @association[:dependent]
             if @association[:dependent].to_s != metadata.dependent.to_s
               @negative_result_message = "#{@positive_result_message} which specified dependent as #{metadata.dependent}"
@@ -120,6 +172,51 @@ module Mongoid
             end
           end
 
+          if @association[:autobuild]
+            if metadata.autobuilding? != true
+              @negative_result_message = "#{@positive_result_message} which did not set autobuild"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which set autobuild"
+            end
+          end
+
+          if @association[:polymorphic]
+            if metadata.polymorphic? != true
+              @negative_result_message = "#{@positive_result_message} which did not set polymorphic"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which set polymorphic"
+            end
+          end
+
+          if @association[:cascade_callbacks]
+            if metadata.cascading_callbacks? != true
+              @negative_result_message = "#{@positive_result_message} which did not set cascade_callbacks"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which set cascade_callbacks"
+            end
+          end
+
+          if @association[:cyclic]
+            if metadata.cyclic? != true
+              @negative_result_message = "#{@positive_result_message} which did not set cyclic"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which set cyclic"
+            end
+          end
+
+          if @association[:store_as]
+            if metadata.store_as != @association[:store_as]
+              @negative_result_message = "#{@positive_result_message} which is stored as #{metadata.store_as}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which is stored as #{metadata.store_as}"
+            end
+          end
+
           if @association[:index]
             if metadata.index != true
               @negative_result_message = "#{@positive_result_message} which did not set index"
@@ -156,24 +253,29 @@ module Mongoid
         def type_description(type = nil, passive = true)
           type ||= @association[:type]
           case type.name
-          when EMBEDS_ONE.name
-            (passive ? 'embed' : 'embeds') << ' one'
-          when EMBEDS_MANY.name
-            (passive ? 'embed' : 'embeds') << ' many'
-          when EMBEDDED_IN.name
-            (passive ? 'be' : 'is') << ' embedded in'
-          when HAS_ONE.name
-            (passive ? 'reference' : 'references') << ' one'
-          when HAS_MANY.name
-            (passive ? 'reference' : 'references') << ' many'
-          when HAS_AND_BELONGS_TO_MANY.name
-            (passive ? 'reference' : 'references') << ' and referenced in many'
-          when BELONGS_TO.name
-            (passive ? 'be referenced in' : 'referenced in')
-          else
-            raise "Unknown association type '%s'" % type
+            when EMBEDS_ONE.name
+              (passive ? 'embed' : 'embeds') << ' one'
+            when EMBEDS_MANY.name
+              (passive ? 'embed' : 'embeds') << ' many'
+            when EMBEDDED_IN.name
+              (passive ? 'be' : 'is') << ' embedded in'
+            when HAS_ONE.name
+              (passive ? 'reference' : 'references') << ' one'
+            when HAS_MANY.name
+              (passive ? 'reference' : 'references') << ' many'
+            when HAS_AND_BELONGS_TO_MANY.name
+              (passive ? 'reference' : 'references') << ' and referenced in many'
+            when BELONGS_TO.name
+              (passive ? 'be referenced in' : 'referenced in')
+            else
+              raise "Unknown association type '%s'" % type
           end
         end
+
+        private
+          def order_way(operator)
+            [nil, "ascending", "descending"][operator]
+          end
       end
 
       def embed_one(association_name)