mongoid-spec 4.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2db94999da51dbfed3ab87f523aa9d5a28608918
+  data.tar.gz: 95298ae001c5e3dce8a60f1f224dc6a197042f3d
+SHA512:
+  metadata.gz: 28cf8f5ec27d608d91f6de5f2ba455447f01e9a2610db82aa6601b6ffd61d983cf721365f98d81d0653a46b391240a8e6f15cddc00f907485912cf149cd55eaa
+  data.tar.gz: 90ca7b34ab2492dffde3add00cf94b3b7444b20198feb8844d284f6b16ec1d6d586d08df76b4d4dddd52e89a8a01cf11fe6c73d91488005899322b40b9dfa217

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Evan Sagge
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,373 @@
+# [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
+
+Drop this line into your Gemfile:
+
+```ruby
+group :test do
+  gem 'mongoid-rspec'
+end
+
+```
+
+### Compatibility
+
+There's no stable version, that provides support for Mongoid 6. But for a time being you can use HEAD version:
+
+```ruby
+gem 'mongoid-rspec', github: 'mongoid-rspec/mongoid-rspec'
+```
+
+If you're using old version of mongoid, then you have to specify particular vesrion of mongoid-rspec. Use compatibility matrix to find out, which version suits your case.
+
+
+| mongoid version | mongoid-rspec version   |
+|-----------------|-------------------------|
+| 5.x             | [3.0.0][mongoid5]       |
+| 4.x             | [2.1.0][mongoid4]       |
+| 3.x             | [1.13.0][mongoid3]      |
+| 2.x             | [1.4.5][mongoid2]       |
+
+## Configuration
+
+### Rails
+
+Add to your `rails_helper.rb` file
+
+```ruby
+require 'mongoid-rspec'
+
+RSpec.configure do |config|
+  config.include Mongoid::Matchers, type: :model
+end
+```
+
+### Other
+
+Add to your `spec_helper.rb` file
+
+```ruby
+require 'mongoid-rspec'
+
+RSpec.configure do |config|
+  config.include Mongoid::Matchers
+end
+```
+
+## 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
+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
+  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
+  it { is_expected.to have_many(:comments).with_dependent(:destroy) }
+  #can verify autosave is set to true
+  it { is_expected.to have_many(:comments).with_autosave }
+
+  it { is_expected.to embed_one :profile }
+
+  it { is_expected.to have_and_belong_to_many(:children) }
+  it { is_expected.to have_and_belong_to_many(:children).of_type(User) }
+end
+
+RSpec.describe Profile do
+  it { is_expected.to be_embedded_in(:user).as_inverse_of(:profile) }
+end
+
+RSpec.describe Article do
+  it { is_expected.to belong_to(:author).of_type(User).as_inverse_of(:articles) }
+  it { is_expected.to belong_to(:author).of_type(User).as_inverse_of(:articles).with_index }
+  it { is_expected.to embed_many(:comments) }
+end
+
+RSpec.describe Comment do
+  it { is_expected.to be_embedded_in(:article).as_inverse_of(:comments) }
+  it { is_expected.to belong_to(:user).as_inverse_of(:comments) }
+end
+
+RSpec.describe Record do
+  it { is_expected.to belong_to(:user).as_inverse_of(:record) }
+end
+
+RSpec.describe Site do
+  it { is_expected.to have_many(:users).as_inverse_of(:site).ordered_by(:email.asc).with_counter_cache }
+end
+```
+
+### Validation Matchers
+
+```ruby
+RSpec.describe Site do
+  it { is_expected.to validate_presence_of(:name) }
+  it { is_expected.to validate_uniqueness_of(:name) }
+end
+
+RSpec.describe User do
+  it { is_expected.to validate_presence_of(:login) }
+  it { is_expected.to validate_uniqueness_of(:login).scoped_to(:site) }
+  it { is_expected.to validate_uniqueness_of(:email).case_insensitive.with_message("is already taken") }
+  it { is_expected.to validate_format_of(:login).to_allow("valid_login").not_to_allow("invalid login") }
+  it { is_expected.to validate_associated(:profile) }
+  it { is_expected.to validate_exclusion_of(:login).to_not_allow("super", "index", "edit") }
+  it { is_expected.to validate_inclusion_of(:role).to_allow("admin", "member") }
+  it { is_expected.to validate_confirmation_of(:email) }
+  it { is_expected.to validate_presence_of(:age).on(:create, :update) }
+  it { is_expected.to validate_numericality_of(:age).on(:create, :update) }
+  it { is_expected.to validate_inclusion_of(:age).to_allow(23..42).on([:create, :update]) }
+  it { is_expected.to validate_presence_of(:password).on(:create) }
+  it { is_expected.to validate_presence_of(:provider_uid).on(:create) }
+  it { is_expected.to validate_inclusion_of(:locale).to_allow([:en, :ru]) }
+end
+
+RSpec.describe Article do
+  it { is_expected.to validate_length_of(:title).within(8..16) }
+end
+
+RSpec.describe Profile do
+  it { is_expected.to validate_numericality_of(:age).greater_than(0) }
+end
+
+RSpec.describe MovieArticle do
+  it { is_expected.to validate_numericality_of(:rating).to_allow(:greater_than => 0).less_than_or_equal_to(5) }
+  it { is_expected.to validate_numericality_of(:classification).to_allow(:even => true, :only_integer => true, :nil => false) }
+end
+
+RSpec.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 { is_expected.to custom_validate(:ssn).with_validator(SsnValidator) }
+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) }
+end
+```
+
+### Accepts Nested Attributes 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
+```
+
+## 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.
+
+[mongoid-rspec]: https://github.com/mongoid-rspec/mongoid-rspec "A collection of RSpec-compatible matchers that help to test Mongoid documents."
+
+[durran]: https://github.com/durran
+[mongoid2]: https://rubygems.org/gems/mongoid-rspec/versions/1.4.5
+[mongoid3]: https://rubygems.org/gems/mongoid-rspec/versions/1.13.0
+[mongoid4]: https://rubygems.org/gems/mongoid-rspec/versions/2.1.0
+[mongoid5]: https://rubygems.org/gems/mongoid-rspec/versions/3.0.0
+
+[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/Rakefile

@@ -0,0 +1,17 @@
+$:.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"
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = "./spec/**/*_spec.rb"
+  spec.rcov = true
+end

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