class Shoulda::Matchers::ActiveRecord::AssociationMatcher
@private
Attributes
macro[R]
missing[R]
name[R]
options[R]
subject[R]
submatchers[R]
Public Class Methods
new(macro, name)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 615 def initialize(macro, name) @macro = macro @name = name @options = {} @submatchers = [] @missing = '' end
Public Instance Methods
autosave(autosave)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 658 def autosave(autosave) @options[:autosave] = autosave self end
class_name(class_name)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 663 def class_name(class_name) @options[:class_name] = class_name self end
conditions(conditions)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 653 def conditions(conditions) @options[:conditions] = conditions self end
counter_cache(counter_cache = true)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 641 def counter_cache(counter_cache = true) counter_cache_matcher = AssociationMatchers::CounterCacheMatcher.new(counter_cache, name) add_submatcher(counter_cache_matcher) self end
dependent(dependent)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 629 def dependent(dependent) dependent_matcher = AssociationMatchers::DependentMatcher.new(dependent, name) add_submatcher(dependent_matcher) self end
description()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 683 def description description = "#{macro_description} #{name}" description += " class_name => #{options[:class_name]}" if options.key?(:class_name) [description, submatchers.map(&:description)].flatten.join(' ') end
failure_message()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 689 def failure_message "Expected #{expectation} (#{missing_options})" end
Also aliased as: failure_message_for_should
failure_message_when_negated()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 694 def failure_message_when_negated "Did not expect #{expectation}" end
Also aliased as: failure_message_for_should_not
matches?(subject)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 699 def matches?(subject) @subject = subject association_exists? && macro_correct? && class_exists? && foreign_key_exists? && class_name_correct? && autosave_correct? && conditions_correct? && join_table_exists? && validate_correct? && touch_correct? && submatchers_match? end
order(order)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 635 def order(order) order_matcher = AssociationMatchers::OrderMatcher.new(order, name) add_submatcher(order_matcher) self end
source(source)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 647 def source(source) source_matcher = AssociationMatchers::SourceMatcher.new(source, name) add_submatcher(source_matcher) self end
through(through)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 623 def through(through) through_matcher = AssociationMatchers::ThroughMatcher.new(through, name) add_submatcher(through_matcher) self end
touch(touch = true)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 678 def touch(touch = true) @options[:touch] = touch self end
validate(validate = true)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 673 def validate(validate = true) @options[:validate] = validate self end
with_foreign_key(foreign_key)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 668 def with_foreign_key(foreign_key) @options[:foreign_key] = foreign_key self end
Private Instance Methods
add_submatcher(matcher)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 726 def add_submatcher(matcher) @submatchers << matcher end
association_exists?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 757 def association_exists? if reflection.nil? @missing = "no association called #{name}" false else true end end
autosave_correct?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 810 def autosave_correct? if options.key?(:autosave) if option_verifier.correct_for_boolean?(:autosave, options[:autosave]) true else @missing = "#{name} should have autosave set to #{options[:autosave]}" false end else true end end
belongs_foreign_key_missing?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 779 def belongs_foreign_key_missing? macro == :belongs_to && !class_has_foreign_key?(model_class) end
class_exists?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 802 def class_exists? associated_class true rescue NameError @missing = "#{reflection.class_name} does not exist" false end
class_has_foreign_key?(klass)
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 864 def class_has_foreign_key?(klass) if options.key?(:foreign_key) option_verifier.correct_for_string?(:foreign_key, options[:foreign_key]) else if klass.column_names.include?(foreign_key) true else @missing = "#{klass} does not have a #{foreign_key} foreign key." false end end end
class_name_correct?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 789 def class_name_correct? if options.key?(:class_name) if option_verifier.correct_for_string?(:class_name, options[:class_name]) true else @missing = "#{name} should resolve to #{options[:class_name]} for class_name" false end else true end end
conditions_correct?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 823 def conditions_correct? if options.key?(:conditions) if option_verifier.correct_for_relation_clause?(:conditions, options[:conditions]) true else @missing = "#{name} should have the following conditions: #{options[:conditions]}" false end else true end end
expectation()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 743 def expectation "#{model_class.name} to have a #{macro} association called #{name}" end
failing_submatchers()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 751 def failing_submatchers @failing_submatchers ||= submatchers.select do |matcher| !matcher.matches?(subject) end end
foreign_key()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 877 def foreign_key if foreign_key_reflection if foreign_key_reflection.respond_to?(:foreign_key) foreign_key_reflection.foreign_key.to_s else foreign_key_reflection.primary_key_name.to_s end end end
foreign_key_exists?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 775 def foreign_key_exists? !(belongs_foreign_key_missing? || has_foreign_key_missing?) end
foreign_key_reflection()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 887 def foreign_key_reflection if [:has_one, :has_many].include?(macro) && reflection.options.include?(:inverse_of) associated_class.reflect_on_association(reflection.options[:inverse_of]) else reflection end end
has_foreign_key_missing?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 783 def has_foreign_key_missing? [:has_many, :has_one].include?(macro) && !through? && !class_has_foreign_key?(associated_class) end
join_table_exists?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 836 def join_table_exists? if macro != :has_and_belongs_to_many || model_class.connection.tables.include?(join_table) true else @missing = "join table #{join_table} doesn't exist" false end end
macro_correct?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 766 def macro_correct? if reflection.macro == macro true else @missing = "actual association type was #{reflection.macro}" false end end
macro_description()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 730 def macro_description case macro.to_s when 'belongs_to' 'belong to' when 'has_many' 'have many' when 'has_one' 'have one' when 'has_and_belongs_to_many' 'have and belong to many' end end
missing_options()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 747 def missing_options [missing, failing_submatchers.map(&:missing_option)].flatten.join end
option_verifier()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 722 def option_verifier @option_verifier ||= AssociationMatchers::OptionVerifier.new(reflector) end
reflector()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 718 def reflector @reflector ||= AssociationMatchers::ModelReflector.new(subject, name) end
submatchers_match?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 895 def submatchers_match? failing_submatchers.empty? end
touch_correct?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 855 def touch_correct? if option_verifier.correct_for_boolean?(:touch, options[:touch]) true else @missing = "#{name} should have touch: #{options[:touch]}" false end end
validate_correct?()
click to toggle source
# File lib/shoulda/matchers/active_record/association_matcher.rb, line 846 def validate_correct? if option_verifier.correct_for_boolean?(:validate, options[:validate]) true else @missing = "#{name} should have validate: #{options[:validate]}" false end end