2010-12-15 22:34:19 +00:00
|
|
|
module Shoulda # :nodoc:
|
|
|
|
module Matchers
|
|
|
|
module ActiveRecord # :nodoc:
|
|
|
|
|
|
|
|
# Ensures that there are DB indices on the given columns or tuples of
|
|
|
|
# columns.
|
|
|
|
#
|
|
|
|
# Options:
|
|
|
|
# * <tt>unique</tt> - whether or not the index has a unique
|
|
|
|
# constraint. Use <tt>true</tt> to explicitly test for a unique
|
|
|
|
# constraint. Use <tt>false</tt> to explicitly test for a non-unique
|
2012-04-23 21:37:40 +00:00
|
|
|
# constraint.
|
2010-12-15 22:34:19 +00:00
|
|
|
#
|
|
|
|
# Examples:
|
|
|
|
#
|
|
|
|
# it { should have_db_index(:age) }
|
|
|
|
# it { should have_db_index([:commentable_type, :commentable_id]) }
|
|
|
|
# it { should have_db_index(:ssn).unique(true) }
|
|
|
|
#
|
|
|
|
def have_db_index(columns)
|
2012-03-30 15:36:04 +00:00
|
|
|
HaveDbIndexMatcher.new(columns)
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
class HaveDbIndexMatcher # :nodoc:
|
2012-03-30 15:36:04 +00:00
|
|
|
def initialize(columns)
|
2010-12-15 22:34:19 +00:00
|
|
|
@columns = normalize_columns_to_array(columns)
|
2012-04-23 21:37:40 +00:00
|
|
|
@options = {}
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
|
2014-03-04 12:47:16 +00:00
|
|
|
def unique(unique = true)
|
2012-04-23 21:37:40 +00:00
|
|
|
@options[:unique] = unique
|
2010-12-15 22:34:19 +00:00
|
|
|
self
|
|
|
|
end
|
|
|
|
|
|
|
|
def matches?(subject)
|
|
|
|
@subject = subject
|
|
|
|
index_exists? && correct_unique?
|
|
|
|
end
|
|
|
|
|
2013-12-24 11:24:27 +00:00
|
|
|
def failure_message
|
2010-12-15 22:34:19 +00:00
|
|
|
"Expected #{expectation} (#{@missing})"
|
|
|
|
end
|
2013-12-24 11:24:27 +00:00
|
|
|
alias failure_message_for_should failure_message
|
2010-12-15 22:34:19 +00:00
|
|
|
|
2013-12-24 11:24:27 +00:00
|
|
|
def failure_message_when_negated
|
2010-12-15 22:34:19 +00:00
|
|
|
"Did not expect #{expectation}"
|
|
|
|
end
|
2013-12-24 11:24:27 +00:00
|
|
|
alias failure_message_for_should_not failure_message_when_negated
|
2010-12-15 22:34:19 +00:00
|
|
|
|
|
|
|
def description
|
2012-04-23 21:37:40 +00:00
|
|
|
if @options.key?(:unique)
|
|
|
|
"have a #{index_type} index on columns #{@columns.join(' and ')}"
|
|
|
|
else
|
|
|
|
"have an index on columns #{@columns.join(' and ')}"
|
|
|
|
end
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
protected
|
|
|
|
|
|
|
|
def index_exists?
|
|
|
|
! matched_index.nil?
|
|
|
|
end
|
|
|
|
|
|
|
|
def correct_unique?
|
2012-04-23 21:37:40 +00:00
|
|
|
return true unless @options.key?(:unique)
|
|
|
|
|
2012-09-19 07:40:57 +00:00
|
|
|
is_unique = matched_index.unique
|
|
|
|
|
|
|
|
is_unique = !is_unique unless @options[:unique]
|
|
|
|
|
|
|
|
unless is_unique
|
2010-12-15 22:34:19 +00:00
|
|
|
@missing = "#{table_name} has an index named #{matched_index.name} " <<
|
2012-09-19 07:40:57 +00:00
|
|
|
"of unique #{matched_index.unique}, not #{@options[:unique]}."
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
2012-09-19 07:40:57 +00:00
|
|
|
|
|
|
|
is_unique
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def matched_index
|
|
|
|
indexes.detect { |each| each.columns == @columns }
|
|
|
|
end
|
|
|
|
|
|
|
|
def model_class
|
|
|
|
@subject.class
|
|
|
|
end
|
|
|
|
|
|
|
|
def table_name
|
|
|
|
model_class.table_name
|
|
|
|
end
|
|
|
|
|
|
|
|
def indexes
|
|
|
|
::ActiveRecord::Base.connection.indexes(table_name)
|
|
|
|
end
|
|
|
|
|
|
|
|
def expectation
|
2012-03-30 15:22:31 +00:00
|
|
|
"#{model_class.name} to #{description}"
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def index_type
|
2012-04-23 21:37:40 +00:00
|
|
|
if @options[:unique]
|
2010-12-15 22:34:19 +00:00
|
|
|
'unique'
|
2012-04-23 21:37:40 +00:00
|
|
|
else
|
|
|
|
'non-unique'
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def normalize_columns_to_array(columns)
|
2012-04-10 01:03:19 +00:00
|
|
|
Array.wrap(columns).map(&:to_s)
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|