if Mongoid::Compatibility::Version.mongoid7_or_newer? require 'mongoid/association' else require 'mongoid/relations' end module Mongoid module Matchers module Associations if Mongoid::Compatibility::Version.mongoid7_or_newer? HAS_MANY = Mongoid::Association::Referenced::HasMany HAS_AND_BELONGS_TO_MANY = Mongoid::Association::Referenced::HasAndBelongsToMany HAS_ONE = Mongoid::Association::Referenced::HasOne BELONGS_TO = Mongoid::Association::Referenced::BelongsTo EMBEDS_MANY = Mongoid::Association::Embedded::EmbedsMany EMBEDS_ONE = Mongoid::Association::Embedded::EmbedsOne EMBEDDED_IN = Mongoid::Association::Embedded::EmbeddedIn else 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 end 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) @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? association_kind_of @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]}" self end def with_autosave @association[:autosave] = true @expectation_message << " which specifies autosave as #{@association[:autosave]}" self end def with_index @association[:index] = true @expectation_message << " which specifies index as #{@association[:index]}" self end def with_autobuild @association[:autobuild] = true @expectation_message << " which specifies autobuild as #{@association[:autobuild]}" self end def with_polymorphism @association[:polymorphic] = true @expectation_message << " which specifies polymorphic as #{@association[:polymorphic]}" self end def with_cascading_callbacks @association[:cascade_callbacks] = true @expectation_message << " which specifies cascade_callbacks as #{@association[:cascade_callbacks]}" self end def cyclic @association[:cyclic] = true @expectation_message << " which specifies cyclic as #{@association[:cyclic]}" 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 with_counter_cache @association[:counter_cache] = true @expectation_message << " which specifies counter_cache as #{@association[:counter_cache]}" self end def with_optional @association[:optional] = true @expectation_message << " which specifies optional as #{@association[:optional]}" 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 = if Mongoid::Compatibility::Version.mongoid7_or_newer? metadata.class else metadata.relation end 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? && (@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.indexed? @positive_result_message = "#{@positive_result_message} which set index" else @negative_result_message = "#{@positive_result_message} which did not set index" return false 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 if @association[:counter_cache] if metadata.counter_cached? != true @negative_result_message = "#{@positive_result_message} which did not set counter_cache" return false else @positive_result_message = "#{@positive_result_message} which set counter_cache" end end if @association[:optional] if metadata.options[:optional] != true @negative_result_message = "#{@positive_result_message} which did not set optional" return false else @positive_result_message = "#{@positive_result_message} which set optional" end end 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 format("Unknown association type '%s'", type) end end private def order_way(operator) [nil, 'ascending', 'descending'][operator] end def association_kind_of Mongoid::Compatibility::Version.mongoid5_or_older? ? Origin::Key : Mongoid::Criteria::Queryable::Key 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