Top Level Namespace

Defined Under Namespace

Modules: DatabaseValidations, RuboCop

Instance Method Summary collapse

Instance Method Details

#validate_db_uniqueness_of ⇒ Object

Matches when model or instance of model validates database uniqueness of some field.

Modifiers:

  • ‘with_message(message)` – specifies a message of the error;

  • ‘scoped_to(scope)` – specifies a scope for the validator;

  • ‘with_where(where)` – specifies a where condition for the validator;

  • ‘with_index(index_name)` – specifies an index name for the validator;

  • ‘case_insensitive` – specifies case insensitivity for the validator;

Example:

“‘ruby it { expect(Model).to validate_db_uniqueness_of(:field) } “`

is the same as

“‘ruby it { expect(Model.new).to validate_db_uniqueness_of(:field) } “`



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/database_validations/rspec/uniqueness_validator_matcher.rb', line 23

RSpec::Matchers.define :validate_db_uniqueness_of do |field| # rubocop:disable Metrics/BlockLength
  chain(:with_message) do |message|
    @message = message
  end

  chain(:scoped_to) do |*scope|
    @scope = scope.flatten
  end

  chain(:with_where) do |where|
    @where = where
  end

  chain(:with_index) do |index_name|
    @index_name = index_name
  end

  chain(:case_insensitive) do
    @case_sensitive = false
  end

  chain(:case_sensitive) do
    @case_sensitive = true
  end

  match do |object|
    @validators = []

    model = object.is_a?(Class) ? object : object.class

    model.validators.grep(DatabaseValidations::DbUniquenessValidator).each do |validator|
      validator.attributes.each do |attribute|
        @validators << {
          field: attribute,
          scope: Array.wrap(validator.options[:scope]),
          where: validator.where,
          message: validator.options[:message],
          index_name: validator.index_name,
          case_sensitive: validator.options[:case_sensitive]
        }
      end
    end

    case_sensitive_default = ActiveRecord::VERSION::MAJOR >= 6 ? nil : true

    @validators.include?(
      field: field,
      scope: Array.wrap(@scope),
      where: @where,
      message: @message,
      index_name: @index_name,
      case_sensitive: @case_sensitive.nil? ? case_sensitive_default : @case_sensitive
    )
  end

  description do
    desc = "validate database uniqueness of #{field}. "
    desc += 'With options - ' if @message || @scope || @where
    desc += "message: '#{@message}'; " if @message
    desc += "scope: #{@scope}; " if @scope
    desc += "where: '#{@where}'; " if @where
    desc += "index_name: '#{@index_name}'; " if @index_name
    desc += 'be case insensitive.' unless @case_sensitive
    desc += 'be case sensitive.' if @case_sensitive
    desc
  end

  failure_message do
    <<-TEXT
      There is no such database uniqueness validator.
      Available validators are: #{@validators}.
    TEXT
  end
end