mongoid-rspec 2.1.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 644aca9f2b61c8979ce8eb90856a3d7db324e506
-  data.tar.gz: 8f428ac11869473c94207866056850ceb113246a
+SHA256:
+  metadata.gz: 6c59448b4e72ebb718332a28e7ddf77de5b792a09ea273b75959930e2c6c2918
+  data.tar.gz: b1818ed7a513db7a4e31bcdd5a492504a75becfc866dd95505192da1db7a56cc
 SHA512:
-  metadata.gz: bb156c8186d891023ed5b423635aef4c673b150728372648cec95de064c72bc7fea35007ea1895d4002f880d787779dddcd9be0ce6304b68dfcdf0554a8aa8d6
-  data.tar.gz: 83b4e63454cc912622c081fc67b0ff0185bb4b612676ad9ec2e7c7240d39f066fa94fe023066a968ca3c848ac21df4dcfd84c6b29c595894ecb7e35dc716f2e6
+  metadata.gz: 995c284d71146d52d554e8eff18e48605e76546ebce9428674d1fcefe4c560a73973651f4eb4496d21a839fb35944c37f98cc21eb78ddd1e1eea80a57d1392c4
+  data.tar.gz: a2e400ead572f31c614a294f1d5d10116e08fa6f152b2f58cf112da45608a3d72be2c5893ceb035c8a6f514af8ef55bcfdffd0a55a81a2e0f97ad43fd0699cf2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Evan Sagge
+Copyright (c) 2009-2018 Evan Sagge and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,47 +1,219 @@
-# mongoid-rspec
+# [mongoid-rspec](https://github.com/mongoid/mongoid-rspec "A collection of RSpec-compatible matchers that help to test Mongoid documents.")
 
-[![Build Status][travis_badge]][travis]
-[![Gem Version][rubygems_badge]][rubygems]
-[![Code Climate][codeclimate_badge]][codeclimate]
+[![Build Status](https://travis-ci.org/mongoid/mongoid-rspec.svg?branch=master)](https://travis-ci.org/mongoid/mongoid-rspec)
+[![Gem Version](https://badge.fury.io/rb/mongoid-rspec.svg)](https://badge.fury.io/rb/mongoid-rspec)
 
-mongoid-rspec provides a collection of RSpec-compatible matchers that help to test mongoid documents.
+The mongoid-rspec library provides a collection of RSpec-compatible matchers that help to test Mongoid documents.
 
 ## Installation
 
-### With Mongoid 4.x
+Drop this line into your Gemfile:
 
-Use mongoid-rspec [2.1.0][mongoid4]
+```ruby
+group :test do
+  gem 'mongoid-rspec'
+end
 
-    gem 'mongoid-rspec', '~> 2.1.0'
+```
 
-### With Mongoid 3.x
+## Compatibility
 
-Use mongoid-rspec [1.13.0][mongoid3].
+This gem is compatible with Mongoid 3, 4, 5, 6 and 7.
 
-    gem 'mongoid-rspec', '~> 1.13.0'
+## Configuration
 
-### With Mongoid 2.x
+### Rails
 
-Use mongoid-rspec [1.4.5][mongoid2]
+Add to your `rails_helper.rb` file
 
-    gem 'mongoid-rspec', '1.4.5'
+```ruby
+require 'mongoid-rspec'
 
-### Configuring
+RSpec.configure do |config|
+  config.include Mongoid::Matchers, type: :model
+end
+```
+
+### Other
 
-Drop in existing or dedicated support file in spec/support.
-i.e: `spec/support/mongoid.rb`
+Add to your `spec_helper.rb` file.
 
 ```ruby
+require 'mongoid-rspec'
+
 RSpec.configure do |config|
-  config.include Mongoid::Matchers, type: :model
+  config.include Mongoid::Matchers
 end
 ```
 
-If you aren't using rails then you don't have to specify the type.
-If you want to know why visit [the rspec documentation](https://relishapp.com/rspec/rspec-rails/docs/directory-structure).
-
 ## Matchers
 
+### be_mongoid_document
+
+```ruby
+class Post
+  include Mongoid::Document
+end
+
+RSpec.describe Post, type: :model do
+  it { is_expected.to be_mongoid_document }
+end
+```
+
+### be_dynamic_document
+
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Attributes::Dynamic
+end
+
+RSpec.describe User, type: :model do
+  it { is_expected.to be_dynamic_document }
+end
+```
+
+### have_timestamps
+
+With full timestamps.
+
+```ruby
+class Log
+  include Mongoid::Document
+  include Mongoid::Timestamps
+end
+
+RSpec.describe Log, type: :model do
+  it { is_expected.to have_timestamps }
+end
+```
+
+With short timestamps.
+
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Timestamps::Short
+end
+
+RSpec.describe User, type: :model do
+  it { is_expected.to have_timestamps.shortened }
+end
+```
+
+With only creating or updating timestamps.
+
+```ruby
+class Admin
+  include Mongoid::Document
+  include Mongoid::Timestamps::Create
+  include Mongoid::Timestamps::Update
+end
+
+RSpec.describe Admin, type: :model do
+  it { is_expected.to have_timestamps.for(:creating) }
+  it { is_expected.to have_timestamps.for(:updating) }
+end
+```
+
+With short creating or updating timestamps.
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Mongoid::Timestamps::Create::Short
+end
+
+RSpec.describe Short, type: :model do
+  it { is_expected.to have_timestamps.for(:creating).shortened }
+end
+```
+
+### be_stored_in
+
+```ruby
+class Post
+  include Mongoid::Document
+
+  store_in database: 'db1', collection: 'messages', client: 'secondary'
+end
+
+RSpec.describe Post, type: :model do
+  it { is_expected.to be_stored_in(database: 'db1', collection: 'messages', client: 'secondary') }
+end
+```
+
+It checks only those options, that you specify. For instance, test in example below will pass, even though expectation contains only `database` option.
+
+```ruby
+class Comment
+  include Mongoid::Document
+
+  store_in database: 'db2', collection: 'messages'
+end
+
+RSpec.describe Comment, type: :model do
+  it { is_expected.to be_stored_in(database: 'db2') }
+end
+```
+
+It works fine with lambdas and procs.
+
+```ruby
+class User
+  include Mongoid::Document
+
+  store_in database: ->{ Thread.current[:database] }
+end
+
+RSpec.describe Post, type: :model do
+  it do
+    Thread.current[:database] = 'db3'
+    is_expected.to be_stored_in(database: 'db3')
+
+    Thread.current[:database] = 'db4'
+    is_expected.to be_stored_in(database: 'db4')
+  end
+end
+```
+
+### have_index_for
+
+```ruby
+class Article
+  index({ title: 1 }, { unique: true, background: true, drop_dups: true })
+  index({ title: 1, created_at: -1 })
+  index({ category: 1 })
+end
+
+RSpec.describe Article, type: :model do
+  it do
+    is_expected
+      .to have_index_for(title: 1)
+      .with_options(unique: true, background: true, drop_dups: true)
+  end
+  it { is_expected.to have_index_for(title: 1, created_at: -1) }
+  it { is_expected.to have_index_for(category: 1) }
+end
+```
+
+### Field Matchers
+
+```ruby
+RSpec.describe Article do
+  it { is_expected.to have_field(:published).of_type(Boolean).with_default_value_of(false) }
+  it { is_expected.to have_field(:allow_comments).of_type(Boolean).with_default_value_of(true) }
+  it { is_expected.not_to have_field(:allow_comments).of_type(Boolean).with_default_value_of(false) }
+  it { is_expected.not_to have_field(:number_of_comments).of_type(Integer).with_default_value_of(1) }
+end
+
+RSpec.describe User do
+  it { is_expected.to have_fields(:email, :login) }
+  it { is_expected.to have_field(:s).with_alias(:status) }
+  it { is_expected.to have_fields(:birthdate, :registered_at).of_type(DateTime) }
+end
+```
+
 ### Association Matchers
 
 ```ruby
@@ -49,14 +221,16 @@ RSpec.describe User do
   it { is_expected.to have_many(:articles).with_foreign_key(:author_id).ordered_by(:title) }
 
   it { is_expected.to have_one(:record) }
-  #can verify autobuild is set to true
+
+  # can verify autobuild is set to true
   it { is_expected.to have_one(:record).with_autobuild }
 
   it { is_expected.to have_many :comments }
 
-  #can also specify with_dependent to test if :dependent => :destroy/:destroy_all/:delete is set
+  # can also specify with_dependent to test if :dependent => :destroy/:destroy_all/:delete is set
   it { is_expected.to have_many(:comments).with_dependent(:destroy) }
-  #can verify autosave is set to true
+
+  # can verify autosave is set to true
   it { is_expected.to have_many(:comments).with_autosave }
 
   it { is_expected.to embed_one :profile }
@@ -87,20 +261,9 @@ end
 RSpec.describe Site do
   it { is_expected.to have_many(:users).as_inverse_of(:site).ordered_by(:email.asc).with_counter_cache }
 end
-```
-
-### Mass Assignment Matcher
-
-```ruby
-RSpec.describe User do
-  it { is_expected.to allow_mass_assignment_of(:login) }
-  it { is_expected.to allow_mass_assignment_of(:email) }
-  it { is_expected.to allow_mass_assignment_of(:age) }
-  it { is_expected.to allow_mass_assignment_of(:password) }
-  it { is_expected.to allow_mass_assignment_of(:password) }
-  it { is_expected.to allow_mass_assignment_of(:role).as(:admin) }
 
-  it { is_expected.not_to allow_mass_assignment_of(:role) }
+RSpec.describe Message do
+  it { is_expected.to belong_to(:user).with_optional }
 end
 ```
 
@@ -131,6 +294,11 @@ end
 
 RSpec.describe Article do
   it { is_expected.to validate_length_of(:title).within(8..16) }
+  it { is_expected.to validate_absence_of(:deletion_date) }
+end
+
+RSpec.describe Visitor do
+  it { is_expected.to validate_length_of(:name).with_maximum(160).with_minimum(1) }
 end
 
 RSpec.describe Profile do
@@ -149,88 +317,40 @@ RSpec.describe Person do
 end
 ```
 
-### Accepts Nested Attributes Matcher
+### Mass Assignment Matcher
 
 ```ruby
 RSpec.describe User do
-  it { is_expected.to accept_nested_attributes_for(:articles) }
-  it { is_expected.to accept_nested_attributes_for(:comments) }
-end
-
-RSpec.describe Article do
-  it { is_expected.to accept_nested_attributes_for(:permalink) }
-end
-```
-
-### Index Matcher
-
-```ruby
-RSpec.describe Article do
-  it { is_expected.to have_index_for(published: 1) }
-  it { is_expected.to have_index_for(title: 1).with_options(unique: true, background: true) }
-end
-
-RSpec.describe Profile do
-  it { is_expected.to have_index_for(first_name: 1, last_name: 1) }
-end
+  it { is_expected.to allow_mass_assignment_of(:login) }
+  it { is_expected.to allow_mass_assignment_of(:email) }
+  it { is_expected.to allow_mass_assignment_of(:age) }
+  it { is_expected.to allow_mass_assignment_of(:password) }
+  it { is_expected.to allow_mass_assignment_of(:password) }
+  it { is_expected.to allow_mass_assignment_of(:role).as(:admin) }
 
-Rspec.describe Log do
-  it { is_expected.to have_index_for(created_at: 1).with_options(bucket_size: 100, expire_after_seconds: 3600) }
+  it { is_expected.not_to allow_mass_assignment_of(:role) }
 end
 ```
 
-### Others
+### Accepts Nested Attributes Matcher
 
 ```ruby
 RSpec.describe User do
-  it { is_expected.to have_fields(:email, :login) }
-  it { is_expected.to have_field(:s).with_alias(:status) }
-  it { is_expected.to 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 { is_expected.to be_timestamped_document }
-  it { is_expected.to be_timestamped_document.with(:created) }
-  it { is_expected.not_to be_timestamped_document.with(:updated) }
-
-  it { is_expected.to be_versioned_document } # if you're declaring `include Mongoid::Versioning`
-  it { is_expected.to be_paranoid_document } # if you're declaring `include Mongoid::Paranoia`
-  it { is_expected.to be_multiparameted_document } # if you're declaring `include Mongoid::MultiParameterAttributes`
-end
-
-RSpec.describe Log do
-  it { is_expected.to be_stored_in :logs }
-  it { is_expected.to be_dynamic_document }
+  it { is_expected.to accept_nested_attributes_for(:articles) }
+  it { is_expected.to accept_nested_attributes_for(:comments) }
 end
 
 RSpec.describe Article do
-  it { is_expected.to have_field(:published).of_type(Boolean).with_default_value_of(false) }
-  it { is_expected.to have_field(:allow_comments).of_type(Boolean).with_default_value_of(true) }
-  it { is_expected.not_to have_field(:allow_comments).of_type(Boolean).with_default_value_of(false) }
-  it { is_expected.not_to have_field(:number_of_comments).of_type(Integer).with_default_value_of(1) }
+  it { is_expected.to accept_nested_attributes_for(:permalink) }
 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.
+## Contributing
 
-[durran]: https://github.com/durran
-[mongoid2]: http://rubygems.org/gems/mongoid-rspec/versions/1.4.5
-[mongoid3]: http://rubygems.org/gems/mongoid-rspec/versions/1.13.0
-[mongoid4]: http://rubygems.org/gems/mongoid-rspec/versions/2.0.0
+You're encouraged to contribute to this library. See [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-[travis_badge]: http://img.shields.io/travis/mongoid-rspec/mongoid-rspec.svg?style=flat
-[travis]: https://travis-ci.org/mongoid-rspec/mongoid-rspec
+## Copyright and License
 
-[rubygems_badge]: http://img.shields.io/gem/v/mongoid-rspec.svg?style=flat
-[rubygems]: http://rubygems.org/gems/mongoid-rspec
+Copyright (c) 2009-2018 Evan Sagge and Contributors.
 
-[codeclimate_badge]: http://img.shields.io/codeclimate/github/mongoid-rspec/mongoid-rspec.svg?style=flat
-[codeclimate]: https://codeclimate.com/github/mongoid-rspec/mongoid-rspec
+MIT License. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -1,17 +1,20 @@
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 
-task :default => :spec
-
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = "./spec/**/*_spec.rb"
+  spec.pattern = './spec/**/*_spec.rb'
 end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = "./spec/**/*_spec.rb"
+  spec.pattern = './spec/**/*_spec.rb'
   spec.rcov = true
 end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/lib/matchers/accept_nested_attributes.rb

@@ -1,6 +1,5 @@
 module Mongoid
   module Matchers # :nodoc:
-
     # Ensures that the model can accept nested attributes for the specified
     # association.
     #
@@ -12,7 +11,6 @@ module Mongoid
     end
 
     class AcceptNestedAttributesForMatcher
-
       def initialize(attribute)
         @attribute = attribute.to_s
         @options = {}
@@ -31,37 +29,38 @@ module Mongoid
         "Did not expect #{expectation}"
       end
 
-      alias :failure_message_when_negated :negative_failure_message
+      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 match?
+        exists?
+      end
 
-        def config
-          model_class.nested_attributes["#{@attribute}_attributes"]
+      def exists?
+        if config
+          true
+        else
+          @problem = 'is not declared'
+          false
         end
+      end
 
-        def model_class
-          @subject.class
-        end
+      def config
+        model_class.nested_attributes["#{@attribute}_attributes"]
+      end
 
-        def expectation
-          "#{model_class.name} to accept nested attributes for #{@attribute}"
-        end
+      def model_class
+        @subject.class
+      end
+
+      def expectation
+        "#{model_class.name} to accept nested attributes for #{@attribute}"
+      end
     end
   end
-end
+end