README.md in unidom-common-1.0.1 vs README.md in unidom-common-1.1
- old
+ new
@@ -26,11 +26,11 @@
## Include Concern in Models
```ruby
include Unidom::Common::Concerns::ModelExtension
```
-## Auto Generated Methods
+## Model Extension concern
```ruby
class Project < ActiveRecord::Base
include Unidom::Common::Concerns::ModelExtension
@@ -79,32 +79,108 @@
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)
<table class='table table-striped table-hover'>
<caption></caption>
<thead>
+
<tr>
<th>Ruby Gem</th>
<th>Migration</th>
<th>Model</th>
<th>Description</th>
</tr>
+
</thead>
<tbody>
+
<tr>
- <td>unidom-common [](https://badge.fury.io/rb/unidom-common)</td>
+ <td>[](https://github.com/topbitdu/unidom-common)</td>
<td>200001DDHHMMSS</td>
<td>-</td>
<td>The Common domain model engine includes the common models. 常用领域模型引擎包括一些常用的模型。</td>
</tr>
+
<tr>
- <td>unidom-visitor [](https://badge.fury.io/rb/unidom-visitor)</td>
+ <td>[](https://github.com/topbitdu/unidom-visitor)</td>
<td>200002DDHHMMSS</td>
<td>
- Identificating
- Authenticating
- Recognization
@@ -112,35 +188,160 @@
- Guest
- Password
</td>
<td>The Visitor domain model engine includes Identificating, Authenticating, Recognization, Visitor (User & Guest), and Password models. 访问者领域模型引擎包括身份标识、身份鉴别、身份识别、访问者（用户和游客）、密码的模型。</td>
</tr>
- </tbody>
-</table>
-* unidom-common: 200001DDHHMMSS
-* unidom-visitor: 200002DDHHMMSS
-* unidom-category: 200003DDHHMMSS
-* unidom-authorization: 200004DDHHMMSS
-* unidom-accounting: 200005DDHHMMSS
-* unidom-standard: 200006DDHHMMSS
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-category)</td>
+ <td>200003DDHHMMSS</td>
+ <td>
+ - Category
+ - Categorizing
+ - Category Rollup
+ - Category Associating
+ </td>
+ <td>The Category domain model engine includes Category and its relative models. 类别领域模型引擎包括类别及其相关的模型。</td>
+ </tr>
-* unidom-party: 200101DDHHMMSS
-* unidom-certificate: 200102DDHHMMSS
-* unidom-contact: 200103DDHHMMSS
-* unidom-geo: 200104DDHHMMSS
-* unidom-property: 200105DDHHMMSS
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-authorization)</td>
+ <td>200004DDHHMMSS</td>
+ <td>
+ - Permission
+ - Authorizing
+ </td>
+ <td>The Authorization domain model engine includes the Permission and Authorizing models. 授权领域模型引擎包括权限、授权的模型。</td>
+ </tr>
-* unidom-article_number: 200201DDHHMMSS
-* unidom-product: 200202DDHHMMSS
-* unidom-price: 200203DDHHMMSS
-* unidom-commodity: 200204DDHHMMSS
-* unidom-shopping: 200205DDHHMMSS
-* unidom-order: 200206DDHHMMSS
-* unidom-promotion: 200207DDHHMMSS
-* unidom-payment: 200208DDHHMMSS
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-standard)</td>
+ <td>200006DDHHMMSS</td>
+ <td>
+ - Standard
+ - Standard Associating
+ </td>
+ <td>The Standard domain model engine includes the Standard model and the Standard Associating model. 标准领域模型引擎包括行为标准和标准关联的模型。</td>
+ </tr>
-* unidom-position: 200402DDHHMMSS
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-party)</td>
+ <td>200101DDHHMMSS</td>
+ <td>
+ - Person
+ - Shop
+ - Company
+ - Government Agency
+ - Party Relation
+ </td>
+ <td>The Party domain model engine includes the Person, Shop, Company, Government Agency, and the Party Relation models. 参与者领域模型引擎包括个人、店铺、公司、政府机构、参与者关系的模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-certificate)</td>
+ <td>200102DDHHMMSS</td>
+ <td>
+ - Certificating
+ </td>
+ <td>The Certificate domain model engine includes the Certificating model.
+证书领域模型引擎包括证书认证的模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-contact)</td>
+ <td>200103DDHHMMSS</td>
+ <td>
+ - Contact Subscription
+ - Email Address
+ </td>
+ <td>The Contact domain model engine includes the Contact Subscription and Email Address models. 联系方式领域模型引擎包括联系方式订阅和电子邮箱地址的模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-geo)</td>
+ <td>200104DDHHMMSS</td>
+ <td>
+ - Location
+ - Locating
+ </td>
+ <td>The Geo domain model engine includes the Location and Locating models. 地理领域模型引擎包括位置和定位的模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-article_number)</td>
+ <td>200201DDHHMMSS</td>
+ <td>
+ - Marking
+ - EAN 13 Barcode
+ - EAN 8 Barcode
+ </td>
+ <td>The Article Number domain model engine includes Marking, EAN-13, and EAN-8 models. 物品编码领域模型引擎包括打码、EAN-13和EAN-8的模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-product)</td>
+ <td>200202DDHHMMSS</td>
+ <td>
+ - Product
+ - Product Associating
+ </td>
+ <td>The Product domain model engine includes Product and Produt Associating models. 产品领域模型引擎包括产品和产品关联的模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-price)</td>
+ <td>200203DDHHMMSS</td>
+ <td>
+ - Price
+ </td>
+ <td>The Price domain model engine includes Price and its relative models. 价格领域模型引擎包括定价及其相关的模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-shopping)</td>
+ <td>200205DDHHMMSS</td>
+ <td>
+ - Shopping Cart
+ - Shopping Item
+ </td>
+ <td>The Shopping domain model engine includes Shopping Cart and Shopping Item models. 购物领域模型引擎包括购物车和购物项的模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-order)</td>
+ <td>200206DDHHMMSS</td>
+ <td>
+ - Order
+ - Order Item
+ - Order Adjustment
+ </td>
+ <td>The Order domain model engine includes Order, Order Item, and Order Adjustment models. 订单领域模型引擎包括订单、订单项和订单调整的模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-position)</td>
+ <td>200402DDHHMMSS</td>
+ <td>
+ - Occupation
+ - Position
+ - Post
+ - Position Reporting Structure
+ </td>
+ <td>The Position domain model engine includes the Occupation, Position, Post, and Position Reporting Structure models.
+职位领域模型引擎包括职业、职位、岗位及岗位报告关系模型。</td>
+ </tr>
+
+ <tr>
+ <td>[](https://github.com/topbitdu/unidom-accession)</td>
+ <td>200405DDHHMMSS</td>
+ <td>
+ - Post Fulfillment
+ </td>
+ <td>The Position domain model engine includes the Post Fulfillment and its relative models. 就职领域模型引擎包括岗位履行及其相关的模型。</td>
+ </tr>
+
+ </tbody>
+</table>
### Country Extensions (200YMM9NNNMMSS)
The YMM part should be identical to the relative part of the Domain Models.
The NNN is the numeric code of [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1 "codes for the names of countries, dependent territories, and special areas of geographical interest").
The numeric code of China is 156.