Unidom Price 价格领域模型引擎

Unidom (UNIfied Domain Object Model) is a series of domain model engines. The Price domain model engine includes Pricing and its relative models. Unidom (统一领域对象模型)是一系列的领域模型引擎。价格领域模型引擎包括定价及其相关的模型。

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.

Usage in Gemfile

gem 'unidom-price'

Run the Database Migration

rake db:migrate

The migration versions start with 200203.

Call the Model

# Create 2 Prices for the same product
product = Product.create name: 'iPhone 6S'
pricer  = Person.create  name: 'John'
price   = Unidom::Price::Price.create(priced: product,
  pricer:           pricer,
  calculation_code: 'AMNT',
  pricing_code:     'BASE',
  charging_code:    'ONCE',
  currency_code:    'RMB',
  amount:           20.00,
  description:      'the normal price',
  instruction:      'Here is a promotion coming soon.',
  opened_at:        Time.now)
promotion_price = Unidom::Price::Price.create(priced: product,
  pricer:           pricer,
  calculation_code: 'PCNT',
  pricing_code:     'DSCT',
  charging_code:    'ONCE',
  currency_code:    'RMB',
  amount:           15.00,
  description:      'the promotion price',
  instruction:      'Here is a promotion coming 1 week later.',
  opened_at:        Time.now+7.days)

# Find the prices.
prices = Unidom::Price::Price.priced_is(product).priced_by(pricer).charging_coded_as('ONCE').currency_coded_as('RMB').valid_at.alive.first

# Price a product
Unidom::Price::Price.price! product, amount: 100

Include the Concerns

include Unidom::Price::Concerns::AsPriced
include Unidom::Price::Concerns::AsPricer

As Priced

The As Priced concern do the following tasks for the includer automatically:

1. Define the has_many :prices macro as: has_many :prices, class_name: 'Unidom::Price::Price', as: :priced

2. Define the #is_priced! method as: is_priced!(amount, by: nil, at: Time.now)

3. Define the #is_priced? method as: is_priced?(at: Time.now)

As Pricer

The As Priced concern do the following tasks for the includer automatically:

1. Define the has_many :pricings macro as: has_many :pricings, class_name: 'Unidom::Price::Price', as: :pricer

2. Define the #price! method as: price!(it, amount, at: Time.now)

3. Define the #price? method as: price?(it, at: Time.now)

Enum codes

Calculation enum code

Unidom::Price::Calculation::AMOUNT     # 金额
Unidom::Price::Calculation::PERCENTAGE # 百分比

Charging enum code

Unidom::Price::Charging::ONE_TIME    # 一次性收费
Unidom::Price::Charging::RECURRING   # 重复性收费
Unidom::Price::Charging::UTILIZATION # 使用率收费

Pricing enum code

Unidom::Price::Pricing::BASE                   # 基价
Unidom::Price::Pricing::DISCOUNT               # 折扣成分
Unidom::Price::Pricing::SURCHARGE              # 额外收费成分
Unidom::Price::Pricing::MANUFACTURER_SUGGESTED # 厂家建议价

Disable the Model & Migration

If you only need the app components other than models, the migrations should be neglected, and the models should not be loaded.

# config/initializers/unidom.rb
Unidom::Common.configure do |options|

  options[:neglected_namespaces] = %w{
    Unidom::Price
  }

end

RSpec examples

RSpec example manifest (run automatically)

# spec/models/unidom_spec.rb
require 'unidom/price/models_rspec'

# spec/types/unidom_spec.rb
require 'unidom/price/types_rspec'

# spec/validators/unidom_spec.rb
require 'unidom/price/validators_rspec'

RSpec shared examples (to be integrated)

# lib/unidom.rb
def initialize_unidom

  Unidom::Party::Person.class_eval do
    include Unidom::Price::Concerns::AsPricer
  end

  Unidom::Product::Product.class_eval do
    include Unidom::Price::Concerns::AsPriced
  end

end

# spec/rails_helper.rb
require 'unidom'
initialize_unidom

# spec/support/unidom_rspec_shared_examples.rb
require 'unidom/price/rspec_shared_examples'

# spec/models/unidom/party/person_spec.rb
describe Unidom::Party::Person, type: :model do

  context do

    model_attribtues = {
      name: 'Tim'
    }

    priced_attributes = {
      name:             'Model X',
      abbreviation:     'MX',
      measurement_unit: 'set',
      packing_norm:     '1 per 1'
    }
    priced = Unidom::Product::Product.create! priced_attributes

    it_behaves_like 'Unidom::Price::Concerns::AsPricer', model_attribtues, priced

  end

end

# spec/models/unidom/position/post_spec.rb
describe Unidom::Product::Product, type: :model do

  context do

    model_attribtues = {
      name:             'Model X',
      abbreviation:     'MX',
      measurement_unit: 'set',
      packing_norm:     '1 per 1'
    }

    pricer = Unidom::Party::Person.create! name: 'Tim'

    it_behaves_like 'Unidom::Price::Concerns::AsPriced', model_attribtues, pricer

  end

end