Unidom Common RSpec Unidom Common RSpec 库
Unidom Common RSpec is a RSpec-based Shared Example for the Unidom Common-based models. Unidom Common RSpec 是为 Unidom Common 设计的基于 RSpec 的共享测试用例。
Recent Update
Check out the Road Map to find out what's the next. Check out the Change Log to find out what's new.
Installation
Add this line to your application's Gemfile:
gem 'unidom-common-rspec'
And then execute:
$ bundle
Or install it yourself as:
$ gem install unidom-common-rspec
Usage
Assume we have the Person model, the Pet model, the Identity Card model, & the Identification Number validator as the following:
# person.rb
class Person < ApplicationRecord
include Unidom::Common::Concerns::ModelExtension
has_many :pets
has_one :identity_card
def own_identity_card!(identity_card, at: Time.now)
self.identity_card.soft_destroy
self.identity_card = identity_card
save!
end
end
# pet.rb
class Pet < ApplicationRecord
include Unidom::Common::Concerns::ModelExtension
belongs_to :owner, polymorphic: true
scope :owned_by, ->(owner) { where owner: owner }
end
# identity_card.rb
class IdentityCard < ApplicationRecord
include Unidom::Common::Concerns::ModelExtension
validates :identification_number, presence: true, identification_number: true
belongs_to :person
scope :owned_by, ->(owner) { where person_id: to_id(owner) }
end
# identification_number_validator.rb
class IdentificationNumberValidator < ActiveModel::EachValidator
WEIGHTS = [ 7, 9, 10, 5, 8, 4, 2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2 ].freeze
CHECK_DIGITS = %w{1 0 X 9 8 7 6 5 4 3 2}.freeze
def validate_each(record, attribute, value)
value = value.to_s
sum = 0
value[0..16].chars.each_with_index do |char, index| sum += char.to_i*WEIGHTS[index] end
record.errors[attribute] << ([:message]||'is invalid') unless CHECK_DIGITS[sum%11]==value[17]
end
end
Scope shared examples 范围共享用例
The person_spec.rb looks like the following:
If the count_diff is set to 'E', an error was expected to be raised.
# The :all scope and the :none scope are the scopes defined by Rails.
# The :transited_to scope is defined by Model Extension.
require 'rails_helper'
describe Person, type: :model do
context '.scope' do
model_attributes = { name: 'Tim' }
it_behaves_like 'scope', :all, [
{ attributes_collection: [ model_attributes ], count_diff: 1, args: [] },
{ attributes_collection: [ model_attributes.merge(defunct: true) ], count_diff: 1, args: [] },
{ attributes_collection: [ model_attributes.merge(closed_at: Time.now) ], count_diff: 1, args: [] }
]
it_behaves_like 'scope', :none, [
{ attributes_collection: [ model_attributes ], count_diff: 0, args: [] },
{ attributes_collection: [ model_attributes.merge(defunct: true) ], count_diff: 0, args: [] },
{ attributes_collection: [ model_attributes.merge(closed_at: Time.now) ], count_diff: 0, args: [] }
]
it_behaves_like 'scope', :transited_to, [
{ attributes_collection: [ model_attributes ], count_diff: 1, args: [ 'C' ] },
{ attributes_collection: [ model_attributes ], count_diff: 0, args: [ 'A' ] },
{ attributes_collection: [ model_attributes.merge(state: 'A') ], count_diff: 0, args: [ 'C' ] },
{ attributes_collection: [ model_attributes.merge(state: 'A') ], count_diff: 1, args: [ 'A' ] }
]
end
end
Monomorphic Scope shared examples 单态范围共享用例
The identity_card_spec.rb looks like the following:
require 'rails_helper'
describe IdentityCard, type: :model do
context do
tim_identity_card_attributes = { name: 'Tim', gender_code: '1', birth_date: '1980-07-01' }
it_behaves_like 'monomorphic scope', tim_identity_card_attributes, :owned_by, :person
end
end
Polymorphic Scope shared examples 多态范围共享用例
The pet_spec.rb looks like the following:
require 'rails_helper'
describe Pet, type: :model do
context do
cat_attributes = { name: 'Pearl', species: 'Persian' }
it_behaves_like 'polymorphic scope', cat_attributes, :owned_by, :person, [ Person ]
end
end
Validates shared examples 验证规则共享用例
The person_spec.rb looks like the following:
require 'rails_helper'
describe Person, type: :model do
context do
tim_attributes = { name: 'Tim' }
it_behaves_like 'validates', tim_attributes, :name,
{ } => 0,
{ name: nil } => 2,
{ name: '' } => 2,
{ name: 'A' } => 1,
{ name: 'AA' } => 0,
{ name: '0' } => 1,
{ name: '00' } => 0,
{ name: 0 } => 1
end
end
Validates Text shared examples 自由文本验证规则共享用例
The person_spec.rb looks like the following:
require 'rails_helper'
describe Person, type: :model do
context '.validates' do
tim_attributes = { name: 'Tim' }
it_behaves_like 'validates text', tim_attributes, :name, length: 2..columns_hash['name'].limit
end
end
Validates Numericality shared examples 数字验证规则共享用例
The person_spec.rb looks like the following:
require 'rails_helper'
describe Person, type: :model do
context do
tim_attributes = { name: 'Tim', age: 28 }
it_behaves_like 'validates numericality', tim_attributes, :age,
range: 0..150, minimum_inclusive: true, maximum_inclusive: true, only_integer: true
end
end
Belongs To shared examples 属于关联共享用例
The pet_spec.rb looks like the following:
require 'rails_helper'
describe Pet, type: :model do
context do
cat_attributes = { name: 'Pearl', species: 'Persian' }
tim_attributes = { name: 'Tim' }
it_behaves_like 'belongs_to', cat_attributes, :person, Person, tim_attributes
end
end
The identity_card_spec.rb looks like the following:
require 'rails_helper'
describe IdentityCard, type: :model do
context do
tim_attributes = { name: 'Tim' }
tim_identity_card_attributes = { name: 'Tim', gender_code: '1', birth_date: '1980-07-01' }
it_behaves_like 'belongs_to', tim_identity_card_attributes, :person, Person, tim_attributes
end
end
Has Many shared examples 拥有多个共享用例
The person_spec.rb looks like the following:
require 'rails_helper'
describe Person, type: :model do
context do
tim_attributes = { name: 'Tim' }
cat_attributes = { name: 'Pearl', species: 'Persian' }
dog_attribtues = { name: 'Flower', species: 'Chihuahua' }
it_behaves_like 'has_many', tim_attributes, :pets, Pet, [ cat_attributes, dog_attribtues ]
end
end
Has One shared examples 拥有单个共享用例
The person_spec.rb looks like the following:
require 'rails_helper'
describe Person, type: :model do
context do
tim_attributes = { name: 'Tim' }
tim_identity_card_attributes = { name: 'Tim', gender_code: '1', birth_date: '1980-07-01' }
it_behaves_like 'has_one', tim_attributes, :identity_card, IdentityCard, tim_identity_card_attributes
end
end
Model Extension shared examples 模型公共扩展共享用例
The person_spec.rb looks like the following:
require 'rails_helper'
describe Person, type: :model do
context do
tim_attributes = { name: 'Tim' }
it_behaves_like 'Unidom::Common::Concerns::ModelExtension', tim_attributes
end
end
Each Validator shared examples 单属性验证器共享用例
The identification_number_validator_spec.rb looks like the following:
RSpec.describe IdentificationNumberValidator, type: :validator do
context do
valid_values = %w{
231024198506186916
231024198506188110
231024198506185470
231024198506182851
231024198506187193
}
invalid_values = %w{
231024198506186917
231024198506188111
231024198506185471
231024198506182852
231024198506187194
}
it_behaves_like 'ActiveModel::EachValidator', valid_values, invalid_values
end
end
Assert Present shared examples 必填参数共享用例
The person_spec.rb looks like the following:
require 'rails_helper'
describe Person, type: :model do
context do
tim_attributes = { name: 'Tim' }
model = described_class.create! tim_attributes
tim_identity_card_attributes = { name: 'Tim', gender_code: '1', birth_date: '1980-07-01' }
identity_card_model = IdentityCard.create! tim_identity_card_attributes
it_behaves_like 'assert_present!', model, :own_identity_card!, [ identity_card, { at: Time.now } ], [ { 0 => :identity_card }, :at ]
end
end
Development
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/unidom-common-rspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.