unidom-certificate 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9f85b7345a1580bf9da3437f447500dc614cf40
-  data.tar.gz: ea9d05eb572e3096c92b405e6c46399d5bb70e33
+  metadata.gz: ca0e580e879911b3072e2cb3851d950dd9ef8da4
+  data.tar.gz: 498b1f4a7b64734fb93caa4776e69c9eab858e1b
 SHA512:
-  metadata.gz: 8820f842d51f3d1824e525fd6979daa41c6ab428e02f23b242589c8032ca69a0dd81a298e6609d0396c3d7dd27b0d52899d31859c7200255c7d4909a258bcc05
-  data.tar.gz: f7cb3594b446aa0bb6fee092827117e2c2ee40663f7afef2b5def658fb8c829ca5c9cec0ceeb64f62cefdb76d04bc57027023a3a43a6a1390cde8cb4115e8454
+  metadata.gz: 87ed53486673f17662470856658a9ce9b714b86d1b031551fe0de9bc3099ad660468eb7436ee94f75c7613cfde2676339bbeabe5f0afbd9a53fb8d2d5c4e175a
+  data.tar.gz: ec53b9a4f1edc6dc05e336aa1f02836ed2d1456ec35830b5af62608528dd543e99310e187a6cde84e638b576260a6249030a1eaa2ebef8fee1eeaac578b4ad99

data/README.md

@@ -1,6 +1,8 @@
 # Unidom Certificate 证书领域模型引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/unidom-certificate/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/unidom-certificate.svg)](https://badge.fury.io/rb/unidom-certificate)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/unidom-certificate.svg)](https://gemnasium.com/github.com/topbitdu/unidom-certificate)
 
@@ -38,7 +40,7 @@ The migration versions start with 200102.
 ```ruby
 officer       = Unidom::Party::Person.create! name: 'John'
 mall          = Unidom::Party::Shop.create!   name: 'WalMart'
-certification = Unidom::Certificate::China::BusinessLicense.registration_number_is('123456789012345').valid_at.alive.first_or_create! name: 'WalMart', address: 'Beijing', legal_representative_name: 'Tim' 
+certification = Unidom::Certificate::China::BusinessLicense.registration_number_is('123456789012345').valid_at.alive.first_or_create! name: 'WalMart', address: 'Beijing', legal_representative_name: 'Tim'
 certificating = Unidom::Certificate::Certificating.certificate!(certification: certification, certificated: mall, certificator: officer, opened_at: Time.now)
 ```
 
@@ -54,13 +56,29 @@ include Unidom::Certificate::Concerns::AsCertification
 ### As Certificated concern
 
 The As Certificated concern do the following tasks for the includer automatically:
-1. Define the has_many :certificatings macro as: ``has_many :certificatings, class_name: 'Unidom::Certificate::Certificating', as: :certificated``  
-2. Define the #is_certificated! method as: ``def is_certificated!(certification, by: nil, at: Time.now)``  
+1. Define the has_many :certificatings macro as: ``has_many :certificatings, class_name: 'Unidom::Certificate::Certificating', as: :certificated``
+2. Define the #is_certificated! method as: ``def is_certificated!(certification, by: nil, at: Time.now)``
 3. Define the #is_certificated? method as: ``def is_certificated?(certification, at: Time.now)``
 
 ### As Certification concern
 
 The As Certification concern do the following tasks for the includer automatically:
-1. Define the has_many :certificatings macro as: ``has_many :certificatings, class_name: 'Unidom::Certificate::Certificating', as: :certification``  
-2. Define the #certificate! method as: ``def certificate!(certificated, by: nil, at: Time.now)``  
+1. Define the has_many :certificatings macro as: ``has_many :certificatings, class_name: 'Unidom::Certificate::Certificating', as: :certification``
+2. Define the #certificate! method as: ``def certificate!(certificated, by: nil, at: Time.now)``
 3. Define the #certificate? method as: ``def certificate?(certificated, 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::Certificate
+  }
+
+end
+```

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

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

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

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

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

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

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

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

data/app/models/unidom/certificate/certificating.rb

@@ -15,8 +15,11 @@ class Unidom::Certificate::Certificating < Unidom::Certificate::ApplicationRecor
   scope :certificated_is,  ->(certificated)  { where certificated:  certificated  }
   scope :certification_is, ->(certification) { where certification: certification }
 
+  ##
+  # 由认证者 certificator 用证书 certification 去认证的人或者机构 certificated ，认证时间是： opened_at。
   def self.certificate!(certification: nil, certificated: nil, certificator: nil, opened_at: Time.now)
-    raise ArgumentError.new('The certification argument is required.') if certification.blank?
+    assert_present! :certification, certification
+    #raise ArgumentError.new('The certification argument is required.') if certification.blank?
     raise ArgumentError.new('The certificated argument is required.' ) if certificated.blank?
     raise ArgumentError.new('The opened_at argument is required.'    ) if opened_at.blank?
 
@@ -30,4 +33,4 @@ class Unidom::Certificate::Certificating < Unidom::Certificate::ApplicationRecor
     self.certification_is(certification).certificated_is(certificated).valid_at(now: opened_at).alive.first_or_create! attributes
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Certificate::Certificating'

data/app/models/unidom/certificate/concerns/as_certificated.rb

@@ -9,6 +9,9 @@ module Unidom::Certificate::Concerns::AsCertificated
 
     has_many :certificatings, class_name: 'Unidom::Certificate::Certificating', as: :certificated
 
+    ##
+    # 被认证者被证书 certification 认证，认证者为 by ，认证时间是 at （缺省为当前时间）。
+    # 如： person.is_certificated! mcse, by: bill_gates, at: Time.now
     def is_certificated!(certification, by: nil, at: Time.now)
 
       raise ArgumentError.new('The certification argument is required.') if certification.blank?
@@ -19,6 +22,9 @@ module Unidom::Certificate::Concerns::AsCertificated
 
     end
 
+    ##
+    # 判断当前被认证者在指定的时间 at (缺省为当前时间)是否有指定的证书 certification 。如：
+    # person.is_certificated? mcse, at: Time.now
     def is_certificated?(certification, at: Time.now)
 
       raise ArgumentError.new('The certification argument is required.') if certification.blank?

data/app/models/unidom/certificate/concerns/as_certification.rb

@@ -9,6 +9,9 @@ module Unidom::Certificate::Concerns::AsCertification
 
     has_many :certificatings, class_name: 'Unidom::Certificate::Certificating', as: :certification
 
+    ##
+    # 用证书去认证参与者（被认证者）。 by 是认证者， at 是认证时间（缺省为当前时间）。
+    # 如：mcse.certificate! person, by: bill_gates, at: Time.now
     def certificate!(certificated, by: nil, at: Time.now)
 
       raise ArgumentError.new('The certificated argument is required.') if certificated.blank?
@@ -19,6 +22,9 @@ module Unidom::Certificate::Concerns::AsCertification
 
     end
 
+    ##
+    # 判断当前认证书在指定的时间 at (缺省为当前时间)是否对被认证者 certificated 生效。如：
+    # mcse.certificated? person, at: Time.now
     def certificate?(certificated, at: Time.now)
 
       raise ArgumentError.new('The certificated argument is required.') if certificated.blank?

data/lib/unidom/certificate/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Certificate
-    VERSION = '2.0.4'.freeze
+    VERSION = '2.0.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-certificate
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.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 Certificate domain model engine includes Identity Card and Business License
   models. Unidom (统一领域对象模型)是一系列的领域模型引擎。证书领域模型引擎包括身份证和营业执照的模型。