unidom-contact 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b874d3ba342e76d007a360b44b328984fe4eb8a5
-  data.tar.gz: 757534342d0edbd0a4348c86a079a03b2249414d
+  metadata.gz: 6a31840fd34a0bb826bedc37522434d55e1b1892
+  data.tar.gz: 5b6e045f09fd6f10fed5181e7b959114facadc8a
 SHA512:
-  metadata.gz: 8ddb3d1d2a2199740a0eee46fc8927a8e5bbbbbdc61f5018d369c3b948ac718d9439cd092cf24d7dc7c8308d91f12a3a21500e460de548ad6b65d244ac129fd2
-  data.tar.gz: f8cfe18ac85bc1de6a59cf241e66c2d13f2ce85f201ec218c5acc823a0cecf1d9e5873c9114f7c3e247537280e891d19461fee89fdaaff87e57f30eee685ff59
+  metadata.gz: 2897744add33c91dcad01c36795676e0608369c58a2d4e889afedd09b531a2e1e35f978a9a4211c715a814887c3bd2d2791048d14540346023c1ecb40289ca69
+  data.tar.gz: ea63341ffc55c8d7dececc2527cfe922e694608041342216d3c27f1c71f7d83f415d8e59ea1e7cc2425679348362e5f136a29479cfc0d86f0951ea1ba00b7ff2

data/README.md

@@ -1,6 +1,8 @@
 # Unidom Contact 联系方式领域模型引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/unidom-contact/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/unidom-contact.svg)](https://badge.fury.io/rb/unidom-contact)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/unidom-contact.svg)](https://gemnasium.com/github.com/topbitdu/unidom-contact)
 
@@ -67,19 +69,43 @@ include Unidom::Contact::Concerns::AsEmailAddressSubscriber
 ### As Contact concern
 
 The As Contact concern do the following tasks for the includer automatically:
-1. Define the has_many :contact_subscriptions macro as: ``has_many :contact_subscriptions, class_name: 'Unidom::Contact::ContactSubscription', as: :contact``  
-2. Define the #is_subscribed_as_contact! method as: ``is_subscribed_as_contact!(by: nil, at: Time.now, name: by.try(:name), primary: true)``  
+
+1. Define the has_many :contact_subscriptions macro as: ``has_many :contact_subscriptions, class_name: 'Unidom::Contact::ContactSubscription', as: :contact``
+
+2. Define the #is_subscribed_as_contact! method as: ``is_subscribed_as_contact!(by: nil, at: Time.now, name: by.try(:name), primary: true)``
+
 3. Define the #is_subscribed_as_contact? method as: ``is_subscribed_as_contact?(by: nil, at: Time.now, primary: true)``
 
 ### As Subscriber concern
 
 The As Subscriber concern do the following tasks for the includer automatically:
-1. Define the has_many :contact_subscriptions macro as: ``has_many :contact_subscriptions, class_name: 'Unidom::Contact::ContactSubscription', as: :subscriber``  
-2. Define the #subscribe_contact! method as: ``subscribe_contact!(contact, at: Time.now, name: nil, primary: true)``  
+
+1. Define the has_many :contact_subscriptions macro as: ``has_many :contact_subscriptions, class_name: 'Unidom::Contact::ContactSubscription', as: :subscriber``
+
+2. Define the #subscribe_contact! method as: ``subscribe_contact!(contact, at: Time.now, name: nil, primary: true)``
+
 3. Define the #subscribe_contact? method as: ``subscribe_contact?(contact, at: Time.now, primary: true)``
 
 ### As Email Address Subscriber concern
 
 The As Email Address Subscriber concern do the following tasks for the includer automatically:
-1. Include the As Subscriber concern  
+
+1. Include the As Subscriber concern
+
 2. Define the has_many :email_addresses macro as: ``has_many :email_addresses, through: :contact_subscriptions, source: :contact, source_type: 'Unidom::Contact::EmailAddress'``
+
+
+
+## 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::Contact
+  }
+
+end
+```

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

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

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

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

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

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

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

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

data/app/models/unidom/contact/concerns/as_contact.rb

@@ -1,3 +1,6 @@
+##
+# As Contact 是联系方式的领域逻辑关注点。
+
 module Unidom::Contact::Concerns::AsContact
 
   extend ActiveSupport::Concern
@@ -6,6 +9,9 @@ module Unidom::Contact::Concerns::AsContact
 
     has_many :contact_subscriptions, class_name: 'Unidom::Contact::ContactSubscription', as: :contact
 
+    ##
+    # 将当前联系方式与指定的参与者 by 关联起来。 at 是关联时间，缺省为当前时间。 name 是联系方式的备注。 primary 是主要联系标志。
+    # 如： phone_number.is_subscribed_as_contact! by: current_person, at: Time.now, name: '私人手机号码', primary: true
     def is_subscribed_as_contact!(by: nil, at: Time.now, name: by.try(:name), primary: true)
 
       raise ArgumentError.new('The by argument is required.') if by.blank?

data/app/models/unidom/contact/concerns/as_email_address_subscriber.rb

@@ -1,3 +1,6 @@
+##
+# As Email Address Subscriber 是 e-Mail 联系人的领域逻辑关注点。
+
 module Unidom::Contact::Concerns::AsEmailAddressSubscriber
 
   extend ActiveSupport::Concern

data/app/models/unidom/contact/concerns/as_subscriber.rb

@@ -1,3 +1,6 @@
+##
+# As Subscriber 是联系人的领域逻辑关注点。
+
 module Unidom::Contact::Concerns::AsSubscriber
 
   extend ActiveSupport::Concern
@@ -6,6 +9,9 @@ module Unidom::Contact::Concerns::AsSubscriber
 
     has_many :contact_subscriptions, class_name: 'Unidom::Contact::ContactSubscription', as: :subscriber
 
+    ##
+    # 将当前参与者与指定的联系方式 contact 关联起来。 at 是关联时间，缺省为当前时间。 name 是联系方式的备注。 primary 是主要联系标志。
+    # 如： current_person.subscribe_contact! phone_number, at: Time.now, name: '私人手机号码', primary: true
     def subscribe_contact!(contact, at: Time.now, name: nil, primary: true)
 
       raise ArgumentError.new('The contact argument is required.') if contact.blank?

data/app/models/unidom/contact/contact_subscription.rb

@@ -17,8 +17,15 @@ class Unidom::Contact::ContactSubscription < Unidom::Contact::ApplicationRecord
   scope :contact_is,    ->(contact)    { where contact:    contact    }
   scope :subscribed_by, ->(subscriber) { where subscriber: subscriber }
 
+  ##
+  # 将联系方式 contact 和订阅者 subscriber 关联起来。
+  # name 是关联的名称，主要用于备注作用，缺省为订阅者的 name 。
+  # primary 是主要联系方式标志，缺省为 true 。
+  # grade 是评分，缺省为 0 。 priority 是优先级，缺省为 0 。
+  # opened_at 是生效时间。
+  # 如： Unidom::Contact::ContactSubscription.subscribe! contact: phone_number, subscriber: selected_person
   def self.subscribe!(contact: nil, subscriber: nil, name: subscriber.try(:name), primary: true, grade: 0, priority: 0, opened_at: Time.now)
     contact_is(contact).subscribed_by(subscriber).valid_at(now: opened_at).alive.first_or_create! name: name, elemental: primary, grade: grade, priority: priority, opened_at: opened_at
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Contact::ContactSubscription'

data/app/models/unidom/contact/email_address.rb

@@ -97,4 +97,4 @@ class Unidom::Contact::EmailAddress < Unidom::Contact::ApplicationRecord
   }
 =end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Contact::EmailAddress'

data/lib/unidom/contact/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Contact
-    VERSION = '1.3.4'.freeze
+    VERSION = '1.3.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-contact
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.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 Contact domain model engine includes Contact Subscription and Email Address
   models. Unidom (统一领域对象模型)是一系列的领域模型引擎。联系方式领域模型引擎包括联系方式订阅和电子邮箱地址的模型。