README.md in unidom-article_number-2.0 vs README.md in unidom-article_number-2.0.1
- old
+ new
@@ -1,64 +1,84 @@
# Unidom Article Number 物品编码领域模型引擎
[](http://opensource.org/licenses/MIT)
[](https://badge.fury.io/rb/unidom-article_number)
+[](https://gemnasium.com/github.com/topbitdu/unidom-accession)
[](https://travis-ci.org/topbitdu/unidom-article_number)
[](https://ci.appveyor.com/project/topbitdu/unidom-article-number)
Unidom (UNIfied Domain Object Model) is a series of domain model engines. The Article Number domain model engine includes EAN-13, EAN-8, and IMEI models.
Unidom (统一领域对象模型)是一系列的领域模型引擎。物品编码领域模型引擎包括EAN-13、EAN-8和IMEI的模型。
+
+
## 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-article_number'
```
+
+
## Run the Database Migration
+
```shell
rake db:migrate
```
The migration versions start with 200201.
+
+
## Call the Model
+
```ruby
ean_13_barcode = Unidom::ArticleNumber::Ean13Barcode.create code: '1234567890123'
ean_8_barcode = Unidom::ArticleNumber::Ean8Barcode.create code: '12345678'
marked = Unidom::Product::Product.create! name: 'Chocolate', abbreviation: 'Choc', packing_norm: '12 blocks', measurement_unit: 'box'
marker = Unidom::Party::Person.create! name: 'John'
ean_13_marking = Unidom::ArticleNumber::Marking.mark! barcode: ean_13_barcode, marked: marked, marker: marker, opened_at: Time.now
ean_8_marking = Unidom::ArticleNumber::Marking.mark! barcode: ean_8_barcode, marked: marked, marker: marker, opened_at: Time.now
```
+
+
## Include the Concern
+
```ruby
include Unidom::ArticleNumber::Concerns::AsBarcode
include Unidom::ArticleNumber::Concerns::AsMarked
include Unidom::ArticleNumber::Concerns::AsEan13Marked
include Unidom::ArticleNumber::Concerns::AsEan8Marked
```
### As Barcode concern
+
The As Barcode concern do the following tasks for the includer automatically:
-1. Define the has_many :markings macro as: ``has_many :markings, class_name: 'Unidom::ArticleNumber::Marking', as: :barcode``
-2. Define the #mark! method as: ``mark!(marked, by: nil, at: Time.now)``
+1. Define the has_many :markings macro as: ``has_many :markings, class_name: 'Unidom::ArticleNumber::Marking', as: :barcode``
+2. Define the #mark! method as: ``mark!(marked, by: nil, at: Time.now)``
3. Define the #mark? mathod as: ``mark?(marked, at: Time.now)``
### As Marked concern
+
The As Marked concern do the following tasks for the includer automatically:
-1. Define the has_many :markings macro as: ``has_many :markings, class_name: 'Unidom::ArticleNumber::Marking', as: :marked``
-2. Define the #is_marked! method as: ``is_marked!(as: nil, by: nil, at: Time.now)``
+1. Define the has_many :markings macro as: ``has_many :markings, class_name: 'Unidom::ArticleNumber::Marking', as: :marked``
+2. Define the #is_marked! method as: ``is_marked!(as: nil, by: nil, at: Time.now)``
3. Define the #is_marked? method as: ``is_marked?(as: nil, at: Time.now)``
### As EAN-13 Marked concern
+
The As EAN-13 Marked concern do the following tasks for the includer automatically:
-1. Include the As Marked concern
+1. Include the As Marked concern
2. Define the has_many :ean13_barcodes macro as: ``has_many :ean13_barcodes, through: :markings, source: :barcode, source_type: 'Unidom::ArticleNumber::Ean13Barcode'``
### As EAN-8 Marked concern
+
The As EAN-8 Marked concern do the following tasks for the includer automatically:
-1. Include the As Marked concern
+1. Include the As Marked concern
2. Define the has_many :ean8_barcodes macro as: ``has_many :ean8_barcodes, through: :markings, source: :barcode, source_type: 'Unidom::ArticleNumber::Ean8Barcode'``