# Unidom Common 常用领域模型引擎

[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
[![Gem Version](https://badge.fury.io/rb/unidom-common.svg)](https://badge.fury.io/rb/unidom-common)
[![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/unidom-common.svg)](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
```

## Auto Generated Methods
```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
```

## 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 [![Gem Version](https://badge.fury.io/rb/unidom-common.svg)](https://badge.fury.io/rb/unidom-common)</td>
      <td>200001DDHHMMSS</td>
      <td>-</td>
      <td>The Common domain model engine includes the common models. 常用领域模型引擎包括一些常用的模型。</td>
    </tr>
    <tr>
      <td>unidom-visitor [![Gem Version](https://badge.fury.io/rb/unidom-visitor.svg)](https://badge.fury.io/rb/unidom-visitor)</td>
      <td>200002DDHHMMSS</td>
      <td>
        - Identificating
        - Authenticating
        - Recognization
        - User
        - Guest
        - Password
      </td>
      <td>The Visitor domain model engine includes Identificating, Authenticating, Recognization, Visitor (User &amp; 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

* unidom-party:          200101DDHHMMSS
* unidom-certificate:    200102DDHHMMSS
* unidom-contact:        200103DDHHMMSS
* unidom-geo:            200104DDHHMMSS
* unidom-property:       200105DDHHMMSS

* 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

* unidom-position:       200402DDHHMMSS

### 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.
* unidom-certificate-china: 2001029156MMSS
* unidom-contact-china:     2001039156MMSS
* unidom-geo-china:         2001049156MMSS