# Unidom Common 常用领域模型引擎 [](http://opensource.org/licenses/MIT) [](https://badge.fury.io/rb/unidom-common) [](https://gemnasium.com/github.com/topbitdu/unidom-common) Unidom (UNIfied Domain Object Model) is a series of domain model engines. The Common domain model engine includes the common models. Unidom (统一领域对象模型)是一系列的领域模型引擎。常用领域模型引擎包括一些常用的模型。 ## Recent Update Check out the [Road Map](ROADMAP.md) to find out what's the next. Check out the [Change Log](CHANGELOG.md) to find out what's new. ## Usage in Gemfile ```ruby gem 'unidom-common' ``` ## Run the Database Migration ```shell rake db:migrate ``` The migration versions starts with 200001. The migration enabled the PostgreSQL uuid-ossp extension. ## Include Concern in Models ```ruby include Unidom::Common::Concerns::ModelExtension ``` ## Model Extension concern ```ruby class Project < ActiveRecord::Base include Unidom::Common::Concerns::ModelExtension validates :name, presence: true, length: { in: 2..200 } validates :audition_state, presence: true, length: { is: 1 } belongs_to :customer belongs_to :team # other fields: code, description end Project.coded_as('JIRA').valid_at(Time.now).alive(true) # Same as Project.coded_as('JIRA').valid_at.alive team.projects.valid_during('2015-01-01'..'2015-12-31').dead Project.included_by([ id_1, id_2 ]).excluded_by id_3 Project.created_after('2015-01-01 00:00:00') Project.created_not_after('2015-01-01 00:00:00') Project.created_before('2015-01-01 00:00:00') Project.created_not_before('2015-01-01 00:00:00') Project.audition_transited_to('A').transited_to('C') ``` ## No-SQL Columns ```ruby class Project < ActiveRecord::Base include Unidom::Common::Concerns::ModelExtension notation_column :creator_comment, :last_updater_comment notation_boolean_column :enabled validates :creator_comment, allow_blank: true, length: { in: 2..200 } validates :last_updater_comment, allow_blank: true, length: { in: 2..200 } end project = Project.new project.creator_comment = 'My first project.' # Stored in project.notation['columns']['creator_comment'] project.valid? # true Project.notation_column_where(:creator_comment, :like, 'first') # Fuzzy search the creator_comment column Project.notation_column_where(:creator_comment, '=', 'My first project.') project.enabled = true project.enabled? # true Project.notation_boolean_column_where(:enabled, true) # All enabled projects ``` ## Numeration ```ruby binary = 'some string' hex = Unidom::Common::Numeration.hex binary # "736f6d6520737472696e67" # convert a binary (usually a string) to it's hex string text = Unidom::Common::Numeration.rev_hex hex # "some string" # convert a hex string to its text value ``` ## AES 256 Cryptor ```ruby class IdentityCard include Unidom::Common::Concerns::Aes256Cryptor attr_accessor :identification_number, :encrypted_identification_number def initialize(identification_number) self.identification_number = identification_number @aes_256_key = OpenSSL::Cipher::AES.new(256, 'CBC').random_key end def encrypt_identification_number encrypt identification_number, key: @aes_256_key end def decrypt_identification_number decrypt encrypted_identification_number, key: @aes_256_key end def cryption_padding 8 end # If the #cryption_padding method is missed, the default padding 9 is used instead end identification_number = '9527' identity_card = IdentityCard.new '9527' encrypted = identity_card.encrypt_identification_number decrypted = identity_card.decrypt_identification_number # The decrypted should equal to identification_number # The AES 256 Cryptor also has the #hex_encrypt and the #hex_decrypt methods ``` ## SHA 512 Digester ```ruby class IdentityCard include Unidom::Common::Concerns::Sha512Digester attr_accessor :identification_number def initialize(identification_number) self.identification_number = identification_number end def digest_identification_number digest identification_number, pepper: self.class.name end def hex_digest_identification_number hex_digest identification_number, pepper: self.class.name end end identity_card = IdentityCard.new '9527' digested = identity_card.digest_identification_number hex_digested = identity_card.hex_digest_identification_number hex_digested == Unidom::Common::Numeration.hex digested # true ``` ## ActiveRecord Migration Naming Convention ### Domain Models (200YMMDDHHMMSS)
Ruby Gem | Migration | Model | Description |
---|---|---|---|
[](https://github.com/topbitdu/unidom-common) | 200001DDHHMMSS | - | The Common domain model engine includes the common models. 常用领域模型引擎包括一些常用的模型。 |
[](https://github.com/topbitdu/unidom-visitor) | 200002DDHHMMSS | - Identificating - Authenticating - Recognization - User - Guest - Password | The Visitor domain model engine includes Identificating, Authenticating, Recognization, Visitor (User & Guest), and Password models. 访问者领域模型引擎包括身份标识、身份鉴别、身份识别、访问者(用户和游客)、密码的模型。 |
[](https://github.com/topbitdu/unidom-category) | 200003DDHHMMSS | - Category - Categorizing - Category Rollup - Category Associating | The Category domain model engine includes Category and its relative models. 类别领域模型引擎包括类别及其相关的模型。 |
[](https://github.com/topbitdu/unidom-authorization) | 200004DDHHMMSS | - Permission - Authorizing | The Authorization domain model engine includes the Permission and Authorizing models. 授权领域模型引擎包括权限、授权的模型。 |
[](https://github.com/topbitdu/unidom-standard) | 200006DDHHMMSS | - Standard - Standard Associating | The Standard domain model engine includes the Standard model and the Standard Associating model. 标准领域模型引擎包括行为标准和标准关联的模型。 |
[](https://github.com/topbitdu/unidom-party) | 200101DDHHMMSS | - Person - Shop - Company - Government Agency - Party Relation | The Party domain model engine includes the Person, Shop, Company, Government Agency, and the Party Relation models. 参与者领域模型引擎包括个人、店铺、公司、政府机构、参与者关系的模型。 |
[](https://github.com/topbitdu/unidom-certificate) | 200102DDHHMMSS | - Certificating | The Certificate domain model engine includes the Certificating model. 证书领域模型引擎包括证书认证的模型。 |
[](https://github.com/topbitdu/unidom-contact) | 200103DDHHMMSS | - Contact Subscription - Email Address | The Contact domain model engine includes the Contact Subscription and Email Address models. 联系方式领域模型引擎包括联系方式订阅和电子邮箱地址的模型。 |
[](https://github.com/topbitdu/unidom-geo) | 200104DDHHMMSS | - Location - Locating | The Geo domain model engine includes the Location and Locating models. 地理领域模型引擎包括位置和定位的模型。 |
[](https://github.com/topbitdu/unidom-article_number) | 200201DDHHMMSS | - Marking - EAN 13 Barcode - EAN 8 Barcode | The Article Number domain model engine includes Marking, EAN-13, and EAN-8 models. 物品编码领域模型引擎包括打码、EAN-13和EAN-8的模型。 |
[](https://github.com/topbitdu/unidom-product) | 200202DDHHMMSS | - Product - Product Associating | The Product domain model engine includes Product and Produt Associating models. 产品领域模型引擎包括产品和产品关联的模型。 |
[](https://github.com/topbitdu/unidom-price) | 200203DDHHMMSS | - Price | The Price domain model engine includes Price and its relative models. 价格领域模型引擎包括定价及其相关的模型。 |
[](https://github.com/topbitdu/unidom-shopping) | 200205DDHHMMSS | - Shopping Cart - Shopping Item | The Shopping domain model engine includes Shopping Cart and Shopping Item models. 购物领域模型引擎包括购物车和购物项的模型。 |
[](https://github.com/topbitdu/unidom-order) | 200206DDHHMMSS | - Order - Order Item - Order Adjustment | The Order domain model engine includes Order, Order Item, and Order Adjustment models. 订单领域模型引擎包括订单、订单项和订单调整的模型。 |
[](https://github.com/topbitdu/unidom-position) | 200402DDHHMMSS | - Occupation - Position - Post - Position Reporting Structure | The Position domain model engine includes the Occupation, Position, Post, and Position Reporting Structure models. 职位领域模型引擎包括职业、职位、岗位及岗位报告关系模型。 |
[](https://github.com/topbitdu/unidom-accession) | 200405DDHHMMSS | - Post Fulfillment | The Position domain model engine includes the Post Fulfillment and its relative models. 就职领域模型引擎包括岗位履行及其相关的模型。 |