unidom-visitor 1.12.3 → 1.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 628b0a826d6227185ecda5880be694b63a74a16e
-  data.tar.gz: 310f5b1253e666d8914c68c5c5d0f28dd154dcfa
+  metadata.gz: 11c45fb8f48e47ced170d411d5340609f6e8e50a
+  data.tar.gz: a40ac60d84c5995be8bc47d33a3af648f2753dc6
 SHA512:
-  metadata.gz: f88d39b9adff575d947818417d7898b9efbac4e7e6bc0f6e76b85a916851216c394e6ff13212b378f5ce5469d6d9e4230644b182a975bb96aaab3afd96c9bfbc
-  data.tar.gz: fed8e571b36faef204e43faee5cc729accdd18c2543fb651346cf8560c98311ded435154711ffcbd02589a439893221925fce592f1cfd839e8fdea7475512122
+  metadata.gz: f39fef87984dc8d517eb859e9540a0bbd983fe048d463e26f134affb9aacacdfc8d0915c0084293435ace4d2ae8b86def6cea2616b0740511824cca31b27e3e2
+  data.tar.gz: b625dce0ac7a1b79651974a57b14f81044984cb0a5521b43d53d556133e737c8bbf0b6eafb5f2db3009f572a231e3fc559d02c727e5095e6be544a5d80052bd6

data/README.md

@@ -1,6 +1,8 @@
 # Unidom Visitor 访问者领域模型引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/unidom-visitor/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/unidom-visitor.svg)](https://badge.fury.io/rb/unidom-visitor)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/unidom-visitor.svg)](https://gemnasium.com/github.com/topbitdu/unidom-visitor)
 
@@ -89,39 +91,39 @@ include Unidom::Visitor::Concerns::AsParty
 
 ### As Visitor concern
 
-The As Visitor concern do the following tasks for the includer automatically:  
-1. Define the has_many :identificatings macro as: ``has_many :identificatings, class_name: 'Unidom::Visitor::Identificating', as: :visitor``  
-2. Define the has_many :authenticatings macro as: ``has_many :authenticatings, class_name: 'Unidom::Visitor::Authenticating', as: :visitor``  
-3. Define the has_many :recognizations macro as: ``has_many :recognizations, class_name: 'Unidom::Visitor::Recognization', as: :visitor``  
-4. Define the .identified_by scope as: ``scope :identified_by, ->(identity) { joins(:identificatings).merge(Unidom::Visitor::Identificating.identity_is identity) }``  
-5. Define the .sign_up method as: ``sign_up(identity, password: nil, opened_at: Time.now)``  
-6. Define the #is_identificated! method as: ``is_identificated!(as: nil, at: Time.now)``  
-7. Define the #is_identificated? method as: ``is_identificated?(as: nil, at: Time.now)``  
-8. Define the #is_authenticated! method as: ``is_authenticated!(through: nil, at: Time.now, flag_code: 'RQRD')``  
-9. Define the #is_authenticated? method as: ``is_authenticated?(through: nil, at: Time.now, flag_code: 'RQRD')``  
-10. Define the #cognize! method as: ``cognize!(it, at: Time.now, primary: true)``  
-11. Define the #cognize? method as: ``cognize?(it, at: Time.now, primary: true)``  
+The As Visitor concern do the following tasks for the includer automatically:
+1. Define the has_many :identificatings macro as: ``has_many :identificatings, class_name: 'Unidom::Visitor::Identificating', as: :visitor``
+2. Define the has_many :authenticatings macro as: ``has_many :authenticatings, class_name: 'Unidom::Visitor::Authenticating', as: :visitor``
+3. Define the has_many :recognizations macro as: ``has_many :recognizations, class_name: 'Unidom::Visitor::Recognization', as: :visitor``
+4. Define the .identified_by scope as: ``scope :identified_by, ->(identity) { joins(:identificatings).merge(Unidom::Visitor::Identificating.identity_is identity) }``
+5. Define the .sign_up method as: ``sign_up(identity, password: nil, opened_at: Time.now)``
+6. Define the #is_identificated! method as: ``is_identificated!(as: nil, at: Time.now)``
+7. Define the #is_identificated? method as: ``is_identificated?(as: nil, at: Time.now)``
+8. Define the #is_authenticated! method as: ``is_authenticated!(through: nil, at: Time.now, flag_code: 'RQRD')``
+9. Define the #is_authenticated? method as: ``is_authenticated?(through: nil, at: Time.now, flag_code: 'RQRD')``
+10. Define the #cognize! method as: ``cognize!(it, at: Time.now, primary: true)``
+11. Define the #cognize? method as: ``cognize?(it, at: Time.now, primary: true)``
 12. Define the .sign_up! method as: ``sign_up!(it, as: nil, through: nil, at: Time.now, flag_code: 'RQRD', primary: true)``
 
 ### As Identity concern
 
-The As Identity concern do the following tasks for the includer automatically:  
-1. Define the has_many :identificatings macro as: ``has_many :identificatings, class_name: 'Unidom::Visitor::Identificating', as: :identity``  
-2. Define the #identificate! method as: ``identificate!(it, at: Time.now)``  
+The As Identity concern do the following tasks for the includer automatically:
+1. Define the has_many :identificatings macro as: ``has_many :identificatings, class_name: 'Unidom::Visitor::Identificating', as: :identity``
+2. Define the #identificate! method as: ``identificate!(it, at: Time.now)``
 3. Define the #identificate? method as: ``identificate?(it, at: Time.now)``
 
 ### As Credential concern
 
-The As Credential concern do the following tasks for the includer automatically:  
-1. Define the has_one :authenticatings macro as: ``has_one :authenticating, class_name: 'Unidom::Visitor::Authenticating', as: :credential``  
-2. Define the #authenticate! method as: ``authenticate!(it, at: Time.now, flag_code: 'RQRD')``  
+The As Credential concern do the following tasks for the includer automatically:
+1. Define the has_one :authenticatings macro as: ``has_one :authenticating, class_name: 'Unidom::Visitor::Authenticating', as: :credential``
+2. Define the #authenticate! method as: ``authenticate!(it, at: Time.now, flag_code: 'RQRD')``
 3. Define the #authenticate? method as: ``authenticate?(it, at: Time.now, flag_code: 'RQRD')``
 
 ### As Party concern
 
-The As Party concern do the following tasks for the includer automatically:  
-1. Define the has_many :recognizations macro as: ``has_many :recognizations, class_name: 'Unidom::Visitor::Recognization', as: :party``  
-2. Define the #is_cognized! method as: ``is_cognized!(via: nil, at: Time.now, primary: true)``  
+The As Party concern do the following tasks for the includer automatically:
+1. Define the has_many :recognizations macro as: ``has_many :recognizations, class_name: 'Unidom::Visitor::Recognization', as: :party``
+2. Define the #is_cognized! method as: ``is_cognized!(via: nil, at: Time.now, primary: true)``
 3. Define the #is_cognized? method as: ``is_cognized!(via: nil, at: Time.now, primary: true)``
 
 
@@ -137,3 +139,19 @@ Unidom::Visitor::Flag::SUFFICIENT
 Unidom::Visitor::Flag::REQUISITE
 Unidom::Visitor::Flag::OPTIONAL
 ```
+
+
+
+## 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::Visitor
+  }
+
+end
+```

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

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

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

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

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

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

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

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

data/app/models/unidom/visitor/authenticating.rb

@@ -19,10 +19,13 @@ class Unidom::Visitor::Authenticating < Unidom::Visitor::ApplicationRecord
   scope :visitor_type_is,    ->(visitor_type)    { where visitor_type:    visitor_type    }
   scope :credential_type_is, ->(credential_type) { where credential_type: credential_type }
 
+  ##
+  # 将访问者 visitor 和信任状 credential 关联起来。关联时间是 opened_at ，缺省是当前时间。如：
+  # Unidom::Visitor::Authenticating.authenticate! user, with: password
   def self.authenticate!(visitor, with: nil, opened_at: Time.now)
     credential_is(with).visitor_is(visitor).valid_at.alive.first_or_create! opened_at: opened_at
   end
 
   code :flag, Unidom::Visitor::Flag
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Visitor::Authenticating'

data/app/models/unidom/visitor/guest.rb

@@ -11,4 +11,4 @@ class Unidom::Visitor::Guest < Unidom::Visitor::ApplicationRecord
 
   scope :platform_specific_identification_is, ->(platform_specific_identification) { where platform_specific_identification: platform_specific_identification }
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Visitor::Guest'

data/app/models/unidom/visitor/identificating.rb

@@ -17,8 +17,11 @@ class Unidom::Visitor::Identificating < Unidom::Visitor::ApplicationRecord
     visitor_is(visitor).first.try :identity
   end
 
+  ##
+  # 将访问者 visitor 和参与者 party 进行身份关联。关联时间是 at ，缺省为当前时间。如：
+  # Unidom::Visitor::Identificating.identificate! user, as: email
   def self.identificate!(visitor, as: nil, at: Time.now)
     self.visitor_is(visitor).identity_is(as).valid_at.alive.first_or_create! opened_at: at
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Visitor::Identificating'

data/app/models/unidom/visitor/password.rb

@@ -35,6 +35,9 @@ class Unidom::Visitor::Password < Unidom::Visitor::ApplicationRecord
     Digest::SHA512.hexdigest "#{::Rails.application.secrets[:secret_key_base]}#{clear_text}#{self.pepper_content}"
   end
 
+  ##
+  # 将当前密码更换为指定的新密码。如：
+  # password.change_to 'newpassword'
   def change_to(new_password)
     visitor = authenticating.visitor
     soft_destroy
@@ -50,4 +53,4 @@ class Unidom::Visitor::Password < Unidom::Visitor::ApplicationRecord
 
   private :hash
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Visitor::Password'

data/app/models/unidom/visitor/recognization.rb

@@ -13,6 +13,9 @@ class Unidom::Visitor::Recognization < Unidom::Visitor::ApplicationRecord
   scope :visitor_is,  ->(visitor) { where visitor: visitor }
   scope :party_is,    ->(party)   { where party:   party   }
 
+  ##
+  # 将访问者 visitor 和参与者 party 关联起来。关联时间为 at ，缺省为当前时间。主关联标志为 primary ，缺省为 false 。如：
+  # Unidom::Visitor::Recognization.cognize! user, as: selected_person
   def self.cognize!(visitor, as: nil, at: Time.now, primary: false)
     query = visitor_is(visitor).party_is(as).valid_at.alive
     recognization = query.first
@@ -25,4 +28,4 @@ class Unidom::Visitor::Recognization < Unidom::Visitor::ApplicationRecord
     end
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Visitor::Recognization'

data/app/models/unidom/visitor/user.rb

@@ -10,6 +10,9 @@ class Unidom::Visitor::User < Unidom::Visitor::ApplicationRecord
 
   has_many :passwords, through: :authenticatings, source: :credential, source_type: 'Unidom::Visitor::Password'
 
+  ##
+  # 注册用户。用户的登录账号是 identity ，密码是 password ，注册时间是 opened_at ，缺省为当前时间。如：
+  # Unidom::Visitor::User.sign_up email, password: 'yourpassword'
   def self.sign_up(identity, password: nil, opened_at: Time.now)
 
     Rails.logger.debug "Signing up user with identity: #{identity.inspect}."
@@ -28,4 +31,4 @@ class Unidom::Visitor::User < Unidom::Visitor::ApplicationRecord
 
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Visitor::User'

data/lib/unidom/visitor/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Visitor
-    VERSION = '1.12.3'.freeze
+    VERSION = '1.12.4'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-visitor
 version: !ruby/object:Gem::Version
-  version: 1.12.3
+  version: 1.12.4
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-01-28 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 Visitor domain model engine includes User, Guest, Administrator, and Password
   models. Unidom (统一领域对象模型)是一系列的领域模型引擎。访问者领域模型引擎包括用户、游客、管理员和密码的模型。