Skip to content
This repository
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 211 lines (180 sloc) 5.447 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 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 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
module Shoulda # :nodoc:
  module Matchers
    module ActiveModel # :nodoc:

      # Ensures that the attribute can be set to the given value or values. If
      # multiple values are given the match succeeds only if all given values
      # are allowed. Otherwise, the matcher fails at the first bad value in the
      # argument list (the remaining arguments are not processed then).
      #
      # Options:
      # * <tt>with_message</tt> - value the test expects to find in
      # <tt>errors.on(:attribute)</tt>. Regexp or string. If omitted,
      # the test looks for any errors in <tt>errors.on(:attribute)</tt>.
      #
      # Example:
      # it { should_not allow_value('bad').for(:isbn) }
      # it { should allow_value("isbn 1 2345 6789 0").for(:isbn) }
      #
      def allow_value(*values)
        if values.empty?
          raise ArgumentError, "need at least one argument"
        else
          AllowValueMatcher.new(*values)
        end
      end

      class AllowValueMatcher # :nodoc:
        include Helpers

        def initialize(*values)
          @values_to_match = values
          @strict = false
          @options = {}
        end

        def for(attribute)
          @attribute = attribute
          self
        end

        def with_message(message)
          @options[:expected_message] = message
          self
        end

        def strict
          @strict = true
          self
        end

        def matches?(instance)
          @instance = instance
          @values_to_match.none? do |value|
            @value = value
            @instance.send("#{@attribute}=", @value)
            errors_match?
          end
        end

        def failure_message
          "Did not expect #{expectation}, got error: #{@matched_error}"
        end

        def negative_failure_message
          "Expected #{expectation}, got #{error_description}"
        end

        def description
          base = "allow #{@attribute} to be set to #{allowed_values}"

          if strict?
            "strictly #{base}"
          else
            base
          end
        end

        private

        def errors_match?
          if strict?
            exception_message_matches?
          else
            validation_messages_match?
          end
        end

        def exception_message_matches?
          @instance.valid?
          false
        rescue ::ActiveModel::StrictValidationFailed => exception
          @strict_exception = exception
          errors_for_attribute_match?
        end

        def validation_messages_match?
          if @instance.valid?
            false
          else
            errors_for_attribute_match?
          end
        end

        def errors_for_attribute_match?
          if expected_message
            @matched_error = errors_match_regexp? || errors_match_string?
          else
            errors_for_attribute.compact.any?
          end
        end

        def errors_for_attribute
          if strict?
            [strict_exception_message]
          else
            validation_messages_for_attribute
          end
        end

        def strict_exception_message
          @strict_exception.message
        end

        def validation_messages_for_attribute
          if @instance.errors.respond_to?(:[])
            errors = @instance.errors[@attribute]
          else
            errors = @instance.errors.on(@attribute)
          end
          Array.wrap(errors)
        end

        def strict?
          @strict
        end

        def errors_match_regexp?
          if Regexp === expected_message
            errors_for_attribute.detect { |e| e =~ expected_message }
          end
        end

        def errors_match_string?
          if errors_for_attribute.include?(expected_message)
            expected_message
          end
        end

        def expectation
          includes_expected_message = expected_message ? "to include #{expected_message.inspect}" : ''
          [error_source, includes_expected_message, "when #{@attribute} is set to #{@value.inspect}"].join(' ')
        end

        def error_source
          if strict?
            'exception'
          else
            'errors'
          end
        end

        def error_description
          if strict?
            exception_description
          else
            validation_error_description
          end
        end

        def exception_description
          if @strict_exception
            strict_exception_message
          else
            'no exception'
          end
        end

        def validation_error_description
          if @instance.errors.empty?
            "no errors"
          else
            "errors: #{pretty_error_messages(@instance)}"
          end
        end

        def allowed_values
          if @values_to_match.length > 1
            "any of [#{@values_to_match.map(&:inspect).join(', ')}]"
          else
            @values_to_match.first.inspect
          end
        end

        def expected_message
          if @options.key?(:expected_message)
            if Symbol === @options[:expected_message]
              default_error_message(@options[:expected_message], :model_name => model_name, :attribute => @attribute)
            else
              @options[:expected_message]
            end
          end
        end

        def model_name
          @instance.class.to_s.underscore
        end
      end
    end
  end
end
Something went wrong with that request. Please try again.