unidom-shopping 1.6.4 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d708cb2956ccc7b9b955dc0e3f7ad18b63b170c4
-  data.tar.gz: d9f6989eeca561e2d16066a101cd05cecb784e60
+  metadata.gz: d26d94a4ba3b2e459005323e41f55b23420f6128
+  data.tar.gz: aa5c50a608e51ae24131cd87f639e65b7e0f055a
 SHA512:
-  metadata.gz: 87f73e3c29a26339dc52ff5f20271bceffd1b6eb80ca66bb64e5153510fcd0b7497bb46fa8d3f53c2b94a95d706043c8108f90b21ceacd8939f3053590142d9d
-  data.tar.gz: 9c7bcd0c498332dbd8e017c7ec7754dbac429387185bc304cead979e8dd80058f95d56ce048b87304793920a3917efd0396a3565154f8b20e6d627780c4c8571
+  metadata.gz: 1bc634a438ebea10ac6d15c1cbe42d34434b4621aefd1d3475b73e950160df0669d0bccc7f8ad8857dd8fe5bf0af9045edee57ed35ed13f314dc6295e971d2b8
+  data.tar.gz: 372c43e865991c41938bcf919a7109a8188ec111be0ad21a80ab839fba5de5d6f8442d3391947a4e216791d7fc107de26f5ef4f1953816252d668e1c91558668

data/README.md

@@ -1,6 +1,8 @@
 # Unidom Shopping 购物领域模型引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/unidom-shopping/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/unidom-shopping.svg)](https://badge.fury.io/rb/unidom-shopping)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/unidom-shopping.svg)](https://gemnasium.com/github.com/topbitdu/unidom-shopping)
 
@@ -68,27 +70,43 @@ include Unidom::Shopping::Concerns::AsShopped
 
 ### As Cart Shopper
 
-The As Cart Shopper concern do the following tasks for the includer automatically:  
-1. Define the has_many :shopping_carts macro as: ``has_many :shopping_carts, class_name: 'Unidom::Shopping::ShoppingCart', as: :shopper``  
-2. Define the #get_cart! method as: ``get_cart!(from: nil, at: Time.now)``  
+The As Cart Shopper concern do the following tasks for the includer automatically:
+1. Define the has_many :shopping_carts macro as: ``has_many :shopping_carts, class_name: 'Unidom::Shopping::ShoppingCart', as: :shopper``
+2. Define the #get_cart! method as: ``get_cart!(from: nil, at: Time.now)``
 3. Define the #get_cart? method as: ``get_cart?(from: nil, at: Time.now)``
 
 ### As Item Shopper
 
-The As Item Shopper concern do the following tasks for the includer automatically:  
-1. Define the has_many :shopping_items macro as: ``has_many :shopping_items, class_name: 'Unidom::Shopping::ShoppingItem', as: :shopper``  
-2. Define the #add! method as: ``add!(it, into: nil, at: Time.now, unit_price: 0, quantity: 1)``  
+The As Item Shopper concern do the following tasks for the includer automatically:
+1. Define the has_many :shopping_items macro as: ``has_many :shopping_items, class_name: 'Unidom::Shopping::ShoppingItem', as: :shopper``
+2. Define the #add! method as: ``add!(it, into: nil, at: Time.now, unit_price: 0, quantity: 1)``
 3. Define the #add? method as: ``add?(it, into: nil, at: Time.now)``
 
 ### As Shop
 
-The As Shop concern do the following tasks for the includer automatically:  
-1. Define the has_many :shopping_carts macro as: ``has_many :shopping_carts, class_name: 'Unidom::Shopping::ShoppingCart', as: :shop``  
+The As Shop concern do the following tasks for the includer automatically:
+1. Define the has_many :shopping_carts macro as: ``has_many :shopping_carts, class_name: 'Unidom::Shopping::ShoppingCart', as: :shop``
 2. Define the #get_cart! method as: ``get_cart!(by: nil, at: Time.now)``
 
 ### As Shopped
 
-The As Shopped concern do the following tasks for the includer automatically:  
-1. Define the has_many :shopping_items macro as: ``has_many :shopping_items, class_name: 'Unidom::Shopping::ShoppingItem', as: :shopped``  
-2. Define the #is_added! method as: ``is_added!(into: nil, by: nil, at: Time.now, unit_price: 0, quantity: 1)``  
+The As Shopped concern do the following tasks for the includer automatically:
+1. Define the has_many :shopping_items macro as: ``has_many :shopping_items, class_name: 'Unidom::Shopping::ShoppingItem', as: :shopped``
+2. Define the #is_added! method as: ``is_added!(into: nil, by: nil, at: Time.now, unit_price: 0, quantity: 1)``
 3. Define the #is_added? method as: ``is_added?(into: nil, by: nil, at: Time.now)``
+
+
+
+## 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.
+```ruby
+# config/initializers/unidom.rb
+Unidom::Common.configure do |options|
+
+  options[:neglected_namespaces] = %w{
+    Unidom::Shopping
+  }
+
+end
+```

data/app/controllers/unidom/shopping/application_controller.rb

@@ -1,3 +1,6 @@
+##
+# Application controller 是模块内所有控制器的基类。
+
 class Unidom::Shopping::ApplicationController < ActionController::Base
   protect_from_forgery with: :exception
 end

data/app/jobs/unidom/shopping/application_job.rb

@@ -1,2 +1,5 @@
+##
+# Application job 是模块内所有异步任务的基类。
+
 class Unidom::Shopping::ApplicationJob < ActiveJob::Base
 end

data/app/mailers/unidom/shopping/application_mailer.rb

@@ -1,3 +1,6 @@
+##
+# Application mailer 是模块内所有电子邮件发送类的基类。
+
 class Unidom::Shopping::ApplicationMailer < ActionMailer::Base
   default from: 'from@example.com'
   layout 'mailer'

data/app/models/unidom/shopping/application_record.rb

@@ -1,3 +1,6 @@
+##
+# Application record 是模块内所有模型的抽象基类。
+
 class Unidom::Shopping::ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 end

data/app/models/unidom/shopping/concerns/as_cart_shopper.rb

@@ -1,3 +1,6 @@
+##
+# As Cart Shopper 是购物车所有者的领域逻辑关注点。
+
 module Unidom::Shopping::Concerns::AsCartShopper
 
   extend ActiveSupport::Concern
@@ -6,6 +9,9 @@ module Unidom::Shopping::Concerns::AsCartShopper
 
     has_many :shopping_carts, class_name: 'Unidom::Shopping::ShoppingCart', as: :shopper
 
+    ##
+    # 以购物者的身份，从指定的商店 from 获取购物车。时间为 at ，缺省为当前时间。如：
+    # current_person.get_cart! from: shop
     def get_cart!(from: nil, at: Time.now)
       shopping_carts.shop_is(from).valid_at(now: at).alive.first_or_create! opened_at: at
     end

data/app/models/unidom/shopping/concerns/as_item_shopper.rb

@@ -1,3 +1,6 @@
+##
+# As Item Shopper 是购物项所有者的领域逻辑关注点。
+
 module Unidom::Shopping::Concerns::AsItemShopper
 
   extend ActiveSupport::Concern
@@ -6,6 +9,9 @@ module Unidom::Shopping::Concerns::AsItemShopper
 
     has_many :shopping_items, class_name: 'Unidom::Shopping::ShoppingItem', as: :shopper
 
+    ##
+    # 以购物者的身份，将商品 it ，放入购物车 into 。购物时间是 at ，缺省为当前时间。单价是 unit_price ，缺省为 0 。数量是 quantity ，缺省为 1 。如：
+    # current_person.add! coca_cola, into: shopping_cart, unit_price: 3.50, quantity: 3
     def add!(it, into: nil, at: Time.now, unit_price: 0, quantity: 1)
       query = shopping_items.shopping_cart_is(into).shopped_is(it).valid_at(now: at).alive
       item  = query.first

data/app/models/unidom/shopping/concerns/as_shop.rb

@@ -1,3 +1,6 @@
+##
+# As Shop 是购物场所的领域逻辑关注点。
+
 module Unidom::Shopping::Concerns::AsShop
 
   extend ActiveSupport::Concern
@@ -6,6 +9,9 @@ module Unidom::Shopping::Concerns::AsShop
 
     has_many :shopping_carts, class_name: 'Unidom::Shopping::ShoppingCart', as: :shop
 
+    ##
+    # 从当前商店中，获取购物车。购物者为 by 。获取时间为 at ，缺省为当前时间。如：
+    # shop.get_cart! by: current_person
     def get_cart!(by: nil, at: Time.now)
       shopping_carts.shopped_by(by).valid_at(now: at).alive.first_or_create! opened_at: at
     end

data/app/models/unidom/shopping/concerns/as_shopped.rb

@@ -1,3 +1,6 @@
+##
+# As Shopped 是被购买的商品的领域逻辑关注点。
+
 module Unidom::Shopping::Concerns::AsShopped
 
   extend ActiveSupport::Concern
@@ -6,6 +9,9 @@ module Unidom::Shopping::Concerns::AsShopped
 
     has_many :shopping_items, class_name: 'Unidom::Shopping::ShoppingItem', as: :shopped
 
+    ##
+    # 将当前商品放入购物车 into ，购物者是 by 。购物时间是 at ，缺省为当前时间。单价是 unit_price ，缺省为 0 。数量是 quantity ，缺省为 1 。如：
+    # coca_cola.is_added! into: shopping_cart, by: current_person, unit_price: 3.50, quantity: 2
     def is_added!(into: nil, by: nil, at: Time.now, unit_price: 0, quantity: 1)
       query = shopping_items.shopping_cart_is(into).valid_at(now: at).alive
       item  = query.first

data/app/models/unidom/shopping/shopping_cart.rb

@@ -15,6 +15,9 @@ class Unidom::Shopping::ShoppingCart < Unidom::Shopping::ApplicationRecord
   scope :shopped_by, ->(shopper) { where shopper: shopper }
   scope :shop_is,    ->(shop)    { where shop:    shop    }
 
+  ##
+  # 将商品 shopped 放入购物车。购物者为 by 。单价为 unit_price ，缺省值为 0 。数量为 quantity ，缺省值是 1 。时间为 at ，缺省为当前时间。如：
+  # shopping_cart.add! coca_cola, by: current_person, unit_price: 3.50, quantity: 2
   def add!(shopped, by: nil, unit_price: 0, quantity: 1, at: Time.now)
     item = items.shopped_is(shopped).valid_at.alive.first
     if item.present?
@@ -25,4 +28,4 @@ class Unidom::Shopping::ShoppingCart < Unidom::Shopping::ApplicationRecord
     end
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Shopping::ShoppingCart'

data/app/models/unidom/shopping/shopping_item.rb

@@ -18,4 +18,4 @@ class Unidom::Shopping::ShoppingItem < Unidom::Shopping::ApplicationRecord
   scope :shopped_by,       ->(shopper)       { where shopper: shopper }
   scope :shopped_is,       ->(shopped)       { where shopped: shopped }
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Shopping::ShoppingItem'

data/lib/unidom/shopping/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Shopping
-    VERSION = '1.6.4'.freeze
+    VERSION = '1.6.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-shopping
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.6.5
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unidom-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
 description: Unidom (UNIfied Domain Object Model) is a series of domain model engines.
   The Shopping domain model engine includes Shopping Cart and Shopping Item models.
   Unidom (统一领域对象模型)是一系列的领域模型引擎。购物领域模型引擎包括购物车和购物项的模型。