mongoid4-rspec 1.11.0

data/lib/matchers/associations.rb

@@ -0,0 +1,316 @@
+require 'mongoid/relations'
+
+module Mongoid
+  module Matchers
+    module Associations
+
+      HAS_MANY = Mongoid::Relations::Referenced::Many
+      HAS_AND_BELONGS_TO_MANY = Mongoid::Relations::Referenced::ManyToMany
+      HAS_ONE = Mongoid::Relations::Referenced::One
+      BELONGS_TO = Mongoid::Relations::Referenced::In
+      EMBEDS_MANY = Mongoid::Relations::Embedded::Many
+      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
+          @expectation_message = "#{type_description} #{@association[:name].inspect}"
+          @expectation_message << " of type #{@association[:class].inspect}" unless @association[:class].nil?
+        end
+
+        def of_type(klass)
+          @association[:class] = klass
+          @expectation_message << " of type #{@association[:class].inspect}"
+          self
+        end
+
+        def as_inverse_of(association_inverse_name)
+          raise "#{@association[:type].inspect} does not respond to :inverse_of" unless [HAS_MANY, HAS_AND_BELONGS_TO_MANY, BELONGS_TO, EMBEDDED_IN].include?(@association[:type])
+          @association[:inverse_of] = association_inverse_name.to_s
+          @expectation_message << " which is an inverse of #{@association[:inverse_of].inspect}"
+          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}"
+          self
+        end
+
+        def with_autosave
+          @association[:autosave] = true
+          @expectation_message << " which specifies autosave as #{@association[:autosave].to_s}"
+          self
+        end
+
+        def with_index
+          @association[:index] = true
+          @expectation_message << " which specifies index as #{@association[:index].to_s}"
+          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)
+          @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)
+          @association[:foreign_key] = foreign_key.to_s
+          @expectation_message << " using foreign key #{@association[:foreign_key].inspect}"
+          self
+        end
+
+        def matches?(actual)
+          @actual = actual.is_a?(Class) ? actual : actual.class
+          metadata = @actual.relations[@association[:name]]
+
+          if metadata.nil?
+            @negative_result_message = "no association named #{@association[:name]}"
+            return false
+          else
+            @positive_result_message = "association named #{@association[:name]}"
+          end
+
+          relation = metadata.relation
+          if relation != @association[:type]
+            @negative_result_message = "#{@actual.inspect} #{type_description(relation, false)} #{@association[:name]}"
+            return false
+          else
+            @positive_result_message = "#{@actual.inspect} #{type_description(relation, false)} #{@association[:name]}"
+          end
+
+          if !@association[:class].nil? and @association[:class] != metadata.klass
+            @negative_result_message = "#{@positive_result_message} of type #{metadata.klass.inspect}"
+            return false
+          else
+            @positive_result_message = "#{@positive_result_message}#{" of type #{metadata.klass.inspect}" if @association[:class]}"
+          end
+
+          if @association[:inverse_of]
+            if @association[:inverse_of].to_s != metadata.inverse_of.to_s
+              @negative_result_message = "#{@positive_result_message} which is an inverse of #{metadata.inverse_of}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which is an inverse of #{metadata.inverse_of}"
+            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}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which specified dependent as #{metadata.dependent}"
+            end
+          end
+
+          if @association[:autosave]
+            if metadata.autosave != true
+              @negative_result_message = "#{@positive_result_message} which did not set autosave"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which set autosave"
+            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"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which set index"
+            end
+          end
+
+          if @association[:foreign_key]
+            if metadata.foreign_key != @association[:foreign_key]
+              @negative_result_message = "#{@positive_result_message} with foreign key #{metadata.foreign_key.inspect}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} with foreign key #{metadata.foreign_key.inspect}"
+            end
+          end
+
+          return true
+        end
+
+        def failure_message_for_should
+          "Expected #{@actual.inspect} to #{@expectation_message}, got #{@negative_result_message}"
+        end
+
+        def failure_message_for_should_not
+          "Expected #{@actual.inspect} to not #{@expectation_message}, got #{@positive_result_message}"
+        end
+
+        alias :failure_message :failure_message_for_should
+        alias :failure_message_when_negated :failure_message_for_should_not
+
+        def description
+          @expectation_message
+        end
+
+        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
+          end
+        end
+
+        private
+          def order_way(operator)
+            [nil, "ascending", "descending"][operator]
+          end
+      end
+
+      def embed_one(association_name)
+        HaveAssociationMatcher.new(association_name, EMBEDS_ONE)
+      end
+
+      def embed_many(association_name)
+        HaveAssociationMatcher.new(association_name, EMBEDS_MANY)
+      end
+
+      def be_embedded_in(association_name)
+        HaveAssociationMatcher.new(association_name, EMBEDDED_IN)
+      end
+
+      def have_one_related(association_name)
+        HaveAssociationMatcher.new(association_name, HAS_ONE)
+      end
+      alias :have_one :have_one_related
+
+      def have_many_related(association_name)
+        HaveAssociationMatcher.new(association_name, HAS_MANY)
+      end
+      alias :have_many :have_many_related
+
+      def have_and_belong_to_many(association_name)
+        HaveAssociationMatcher.new(association_name, HAS_AND_BELONGS_TO_MANY)
+      end
+
+      def belong_to_related(association_name)
+        HaveAssociationMatcher.new(association_name, BELONGS_TO)
+      end
+      alias :belong_to :belong_to_related
+    end
+  end
+end

data/lib/matchers/collections.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers.define :be_stored_in do |collection_name|
+  match do |doc|
+    doc.class.collection_name == collection_name
+  end
+
+  description do
+    "be stored in #{collection_name.to_s}"
+  end
+end

data/lib/matchers/document.rb

@@ -0,0 +1,163 @@
+module Mongoid
+  module Matchers
+    class HaveFieldMatcher # :nodoc:
+      def initialize(*attrs)
+        @attributes = attrs.collect(&:to_s)
+      end
+
+      def localized
+        @localized = true
+        self
+      end
+
+      def of_type(type)
+        @type = type
+        self
+      end
+
+      def with_alias(field_alias)
+        @field_alias = field_alias
+        self
+      end
+
+      def with_default_value_of(default)
+        @default = default
+        self
+      end
+
+      def matches?(klass)
+        @klass = klass.is_a?(Class) ? klass : klass.class
+        @errors = []
+        @attributes.each do |attr|
+          if @klass.fields.include?(attr)
+            error = ""
+            if @type and @klass.fields[attr].type != @type
+              error << " of type #{@klass.fields[attr].type}"
+            end
+
+            if !@default.nil?
+              if @klass.fields[attr].default_val.nil?
+                error << " with default not set"
+              elsif @klass.fields[attr].default_val != @default
+                error << " with default value of #{@klass.fields[attr].default_val}"
+              end
+            end
+
+            if @field_alias and @klass.fields[attr].options[:as] != @field_alias
+              error << " with alias #{@klass.fields[attr].options[:as]}"
+            end
+
+            @errors.push("field #{attr.inspect}" << error) unless error.blank?
+
+            if @localized
+              unless @klass.fields[attr].localized?
+                @errors.push "is not localized #{attr.inspect}"
+              end
+            end
+
+          else
+            @errors.push "no field named #{attr.inspect}"
+          end
+        end
+        @errors.empty?
+      end
+
+      def failure_message_for_should
+        "Expected #{@klass.inspect} to #{description}, got #{@errors.to_sentence}"
+      end
+
+      def failure_message_for_should_not
+        "Expected #{@klass.inspect} to not #{description}, got #{@klass.inspect} to #{description}"
+      end
+
+      alias :failure_message :failure_message_for_should
+      alias :failure_message_when_negated :failure_message_for_should_not
+
+      def description
+        desc = "have #{@attributes.size > 1 ? 'fields' : 'field'} named #{@attributes.collect(&:inspect).to_sentence}"
+        desc << " of type #{@type.inspect}" if @type
+        desc << " with alias #{@field_alias}" if @field_alias
+        desc << " with default value of #{@default.inspect}" if !@default.nil?
+        desc
+      end
+    end
+
+    def have_field(*args)
+      HaveFieldMatcher.new(*args)
+    end
+    alias_method :have_fields, :have_field
+  end
+end
+
+RSpec::Matchers.define :have_instance_method do |name|
+  match do |klass|
+    klass.instance_methods.include?(name.to_sym)
+  end
+
+  description do
+    "have instance method #{name.to_s}"
+  end
+end
+
+RSpec::Matchers.define :be_mongoid_document do
+  match do |doc|
+    doc.class.included_modules.include?(Mongoid::Document)
+  end
+
+  description do
+    "be a Mongoid document"
+  end
+end
+
+RSpec::Matchers.define :be_versioned_document do
+  match do |doc|
+    doc.class.included_modules.include?(Mongoid::Versioning)
+  end
+
+  description do
+    "be a versioned Mongoid document"
+  end
+end
+
+RSpec::Matchers.define :be_timestamped_document do
+  match do |doc|
+    if [*@timestamped_module].any?
+      modules = [*@timestamped_module].map{|m| "Mongoid::Timestamps::#{m.to_s.classify}".constantize }
+      (modules - doc.class.included_modules).empty?
+    else
+      doc.class.included_modules.include?(Mongoid::Timestamps) or
+      doc.class.included_modules.include?(Mongoid::Timestamps::Created) or
+      doc.class.included_modules.include?(Mongoid::Timestamps::Updated)
+    end
+  end
+
+  chain :with do |timestamped_module|
+    @timestamped_module = timestamped_module
+  end
+
+  description do
+    desc = "be a timestamped Mongoid document"
+    desc << " with #{@timestamped_module}" if @timestamped_module
+    desc
+  end
+end
+
+RSpec::Matchers.define :be_paranoid_document do
+  match do |doc|
+    doc.class.included_modules.include?(Mongoid::Paranoia)
+  end
+
+  description do
+    "be a paranoid Mongoid document"
+  end
+end
+
+RSpec::Matchers.define :be_multiparameted_document do
+  match do |doc|
+    doc.class.included_modules.include?(Mongoid::MultiParameterAttributes)
+  end
+
+  description do
+    "be a multiparameted Mongoid document"
+  end
+end