kotovalexarian-likes-github
/
thoughtbot--shoulda-matchers
mirror of https://github.com/thoughtbot/shoulda-matchers.git
1
0
Fork 0
Code Releases Activity
thoughtbot--shoulda-matchers/lib/shoulda/matchers/util.rb

101 lines
2.4 KiB
Ruby
Raw Normal View History

Improve the word_wrap utility method We use the word_wrap method right now to reformat warning messages so that they fit within a 72-character space. We'd like to use this for error messages too, but we want the word_wrap method to be smart when reformatting bulleted or numbered lists, and also to ignore code blocks.
2015-10-08 05:28:45 +00:00
require 'shoulda/matchers/util/word_wrap'
Fix define_class/model to support namespaces You can now say `define_class('Models::User')` and it will define a User class inside of the Models module. Similarly, you can also say `define_model('Models::User')` and it will set the table name of the model to `models_users` instead of just `users`.
2014-10-08 05:19:07 +00:00
module Shoulda
module Matchers
# @private
module Util
def self.deconstantize(path)
if defined?(ActiveSupport::Inflector) &&
ActiveSupport::Inflector.respond_to?(:deconstantize)
ActiveSupport::Inflector.deconstantize(path)
else
path.to_s[0...(path.to_s.rindex('::') || 0)]
end
end
Fix association matchers + namespaced class_name Fix `class_name` qualifier for association matchers so that if the model being referenced is namespaced, the matcher will correctly resolve the class before checking it against the association's `class_name`. Take these models for instance: module Models class Friend < ActiveRecord::Base end class User < ActiveRecord::Base has_many :friends, class_name: 'Friend' end end Here, the `has_many` is referring to Models::Friend, not just Friend. Previously in order to test the association, you had to write: describe Models::User do it { should have_many(:friends).class_name('Models::Friend') } end Now, `have_many` will attempt to resolve the string given to `class_name` within the context of the namespace first before treating it as a reference to a global constant. This means you can now write this: describe Models::User do it { should have_many(:friends).class_name('Friend') } end
2014-11-05 18:07:29 +00:00
def self.safe_constantize(camel_cased_word)
if defined?(ActiveSupport::Inflector) &&
ActiveSupport::Inflector.respond_to?(:safe_constantize)
ActiveSupport::Inflector.safe_constantize(camel_cased_word)
else
begin
camel_cased_word.constantize
rescue NameError
nil
end
end
end
Improve output of fail_with_message matcher
2015-01-23 01:46:01 +00:00
def self.indent(string, width)
Add matcher for has_secure_token
2017-06-29 07:10:21 +00:00
return if !string
Improve output of fail_with_message matcher
2015-01-23 01:46:01 +00:00
indentation = ' ' * width
string.split(/[\n\r]/).map { |line| indentation + line }.join("\n")
end
Add a_or_an utility method The purpose of this method is to add a word to a string which is prepended by "a" or "an", depending on whether that word starts with a vowel.
2015-12-08 05:00:37 +00:00
def self.a_or_an(next_word)
Rewrite have_db_index matcher * Bring the file up to date style-wise with other matcher files * Bring the tests up to date with other tests * Improve error messaging * Simplify documentation
2019-05-24 06:34:24 +00:00
if next_word =~ /\A[aeiou]/i && next_word != 'unique'
Add a_or_an utility method The purpose of this method is to add a word to a string which is prepended by "a" or "an", depending on whether that word starts with a vowel.
2015-12-08 05:00:37 +00:00
"an #{next_word}"
else
"a #{next_word}"
end
end
allow_value: Inspect values more clearly Modify descriptions and failure messages for all matchers by way of allow_value and put small angle brackets around inspected values. This is to visually distinguish an inspected value from the rest of the text, and is especially noticeable for complex values such as an array that contains an object, particularly if the inspected version of the value wraps onto another line. It's a little easier to see: When attempting to set :attr on Example to ‹[#<Child id: nil>]›... rather than: When attempting to set :attr on Example to [#<Child id: nil>]...
2015-12-22 07:00:51 +00:00
def self.inspect_value(value)
Improve failure messages for define_enum_for If a subtest fails, explain why. We're going to be adding another subtest later, and so without this extra information, users will most definitely be confused.
2018-01-26 19:33:27 +00:00
case value
when Hash
inspect_hash(value)
when Range
inspect_range(value)
else
"‹#{value.inspect}›"
end
allow_value: Inspect values more clearly Modify descriptions and failure messages for all matchers by way of allow_value and put small angle brackets around inspected values. This is to visually distinguish an inspected value from the rest of the text, and is especially noticeable for complex values such as an array that contains an object, particularly if the inspected version of the value wraps onto another line. It's a little easier to see: When attempting to set :attr on Example to ‹[#<Child id: nil>]›... rather than: When attempting to set :attr on Example to [#<Child id: nil>]...
2015-12-22 07:00:51 +00:00
end
def self.inspect_values(values)
values.map { |value| inspect_value(value) }
end
def self.inspect_range(range)
"#{inspect_value(range.first)} to #{inspect_value(range.last)}"
end
uniqueness: Extract code to gen dummy values We need to use this in another part of the codebase: later, when we add ignoring_interference_by_writer to all matchers, we will need a way of overriding an attribute such that it produces another value that invalidates the test. Some tests require us to generate dummy values.
2015-12-27 05:41:04 +00:00
Improve failure messages for define_enum_for If a subtest fails, explain why. We're going to be adding another subtest later, and so without this extra information, users will most definitely be confused.
2018-01-26 19:33:27 +00:00
def self.inspect_hash(hash)
output = '‹{'
output << hash.map { |key, value|
if key.is_a?(Symbol)
"#{key}: #{value.inspect}"
else
"#{key.inspect} => #{value.inspect}"
end
}.join(', ')
output << '}›'
end
uniqueness: Extract code to gen dummy values We need to use this in another part of the codebase: later, when we add ignoring_interference_by_writer to all matchers, we will need a way of overriding an attribute such that it produces another value that invalidates the test. Some tests require us to generate dummy values.
2015-12-27 05:41:04 +00:00
def self.dummy_value_for(column_type, array: false)
if array
[dummy_value_for(column_type, array: false)]
else
case column_type
when :integer
0
when :date
Date.new(2100, 1, 1)
when :datetime, :timestamp
DateTime.new(2100, 1, 1)
when :time
Time.new(2100, 1, 1)
when :uuid
SecureRandom.uuid
when :boolean
true
else
'dummy value'
end
end
end
Fix define_class/model to support namespaces You can now say `define_class('Models::User')` and it will define a User class inside of the Models module. Similarly, you can also say `define_model('Models::User')` and it will set the table name of the model to `models_users` instead of just `users`.
2014-10-08 05:19:07 +00:00
end
end
end