unidom-authorization 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2435a1acf8dbeffb9852fab44ba2ddeecb970a4a
-  data.tar.gz: 128a9d021436050d539cace00f056707d9c5f857
+  metadata.gz: 0452e5f8f9c8d59d999f1d6ec3b3a3fd336d0077
+  data.tar.gz: 28558f7b515d8028f6e7e68735a740d65d2856fa
 SHA512:
-  metadata.gz: ab7a3e2e2df52ea095dbacce94bfd77d8a229d1bacc5580b7a0117adf8a01c134a0cf65d8e486e0592436385033f4bedbd1f93c1027d93a37bda94baaf09c99c
-  data.tar.gz: b5d9f1611b7d7902ebb998a619b56aad071fecaabb6850a9b4cf12f0467406ca158bda35acb07b4858141c436612924bd641cfb822e2fa673589837f591c0b53
+  metadata.gz: c5c900343d6233b7f173ac002b677aaf036474a6bf15e618249f1c09a6663949b2c99d881210ec3c0ad2e1a03b9bbed7a2df3e53a1d10f0e9c72cd29dec93460
+  data.tar.gz: 932228df055c759573f05607146c2c890f5f0c41b9fc933cd3cd27dfb5e7b8c800765f2ef0fc943415c5eb865cc5831b2d30cfd984a0af9a6d2309b25b669e9f

data/README.md

@@ -1,6 +1,8 @@
 # Unidom Authorization 授权领域模型引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/unidom-authorization/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/unidom-authorization.svg)](https://badge.fury.io/rb/unidom-authorization)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/unidom-authorization.svg)](https://gemnasium.com/github.com/topbitdu/unidom-authorization)
 
@@ -62,15 +64,36 @@ include Unidom::Authorization::Concerns::AsPermission
 
 ### As Authorized concern
 
-The As Authorized concern do the following tasks for the includer automatically:  
-1. Define the has_many :authorizings macro as: ``has_many :authorizings, class_name: 'Unidom::Authorization::Authorizing', as: :authorized``  
-2. Define the has_many :permissions macro as: ``has_many :permissions, through: :authorizings, source: :permission``  
-3. Define the #is_authorized! method as: ``is_authorized!(permission: nil, by: nil, at: Time.now)``  
+The As Authorized concern do the following tasks for the includer automatically:
+1. Define the has_many :authorizings macro as: ``has_many :authorizings, class_name: 'Unidom::Authorization::Authorizing', as: :authorized``
+
+2. Define the has_many :permissions macro as: ``has_many :permissions, through: :authorizings, source: :permission``
+
+3. Define the #is_authorized! method as: ``is_authorized!(permission: nil, by: nil, at: Time.now)``
+
 4. Define the #is_authorized? method as: ``is_authorized?(permission: nil, at: Time.now)``
 
 ### As Permission concern
 
-The As Permission concern do the following tasks for the includer automatically:  
-1. Define the has_many :authorizings macro as: ``has_many :authorizings, class_name: 'Unidom::Authorization::Authorizing'``  
-2. Define the #authorize! method as: ``authorize!(authorized, by: nil, at: Time.now)``  
+The As Permission concern do the following tasks for the includer automatically:
+1. Define the has_many :authorizings macro as: ``has_many :authorizings, class_name: 'Unidom::Authorization::Authorizing'``
+
+2. Define the #authorize! method as: ``authorize!(authorized, by: nil, at: Time.now)``
+
 3. Define the #authorize? method as: ``authorize?(authorized, 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::Authorization
+  }
+
+end
+```

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

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

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

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

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

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

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

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

data/app/models/unidom/authorization/authorizing.rb

@@ -15,6 +15,10 @@ class Unidom::Authorization::Authorizing < Unidom::Authorization::ApplicationRec
   scope :authorized_is, ->(authorized) { where authorized: authorized }
   scope :authorized_by, ->(authorizer) { where authorizer: authorizer }
 
+  ##
+  # 授予 authorized 权限 permission ，授权者是 authorizer ，授权时间是 opened_at。如：
+  # Unidom::Authorization::Authorizing.authorize! permission: permission,
+  #   authorized: selected_person, authorizer: current_person
   def self.authorize!(permission: nil, authorized: nil, authorizer: nil, opened_at: Time.now)
 
     assert_present! :permission, permission
@@ -33,4 +37,4 @@ class Unidom::Authorization::Authorizing < Unidom::Authorization::ApplicationRec
 
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Authorization::Authorizing'

data/app/models/unidom/authorization/concerns/as_authorized.rb

@@ -1,3 +1,6 @@
+##
+# As Authorized 是被授权的参与者或访问者的领域逻辑关注点。
+
 module Unidom::Authorization::Concerns::AsAuthorized
 
   extend ActiveSupport::Concern
@@ -7,6 +10,10 @@ module Unidom::Authorization::Concerns::AsAuthorized
     has_many :authorizings, class_name: 'Unidom::Authorization::Authorizing', as:     :authorized
     has_many :permissions,  through:    :authorizings,                        source: :permission
 
+    ##
+    # 将本参与者或访问者，授予指定的权限 permission ， by 是授权者， at 是授权时间，缺省为当前时间。如：
+    # 假设 selected_person 对应的类已经 include Unidom::Authorization::Concerns::AsAuthorized 。
+    # selected_person.is_authorized! permission, by: current_person
     def is_authorized!(permission: nil, by: nil, at: Time.now)
 
       assert_present! :permission, permission

data/app/models/unidom/authorization/concerns/as_permission.rb

@@ -1,3 +1,6 @@
+##
+# As Permission 是权限的领域逻辑关注点。
+
 module Unidom::Authorization::Concerns::AsPermission
 
   extend ActiveSupport::Concern
@@ -6,6 +9,9 @@ module Unidom::Authorization::Concerns::AsPermission
 
     has_many :authorizings, class_name: 'Unidom::Authorization::Authorizing'
 
+    ##
+    # 将本权限授予指定的参与者或访问者 authorized ， by 是授权者， at 是授权时间，缺省为当前时间。如：
+    # permission.authorize! selected_person, by: current_person
     def authorize!(authorized, by: nil, at: Time.now)
 
       assert_present! :authorized, authorized

data/app/models/unidom/authorization/permission.rb

@@ -13,4 +13,4 @@ class Unidom::Authorization::Permission < Unidom::Authorization::ApplicationReco
 
   scope :path_is, ->(path) { where path: path }
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Authorization::Permission'

data/lib/unidom/authorization/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Authorization
-    VERSION = '1.4.4'.freeze
+    VERSION = '1.4.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-authorization
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.5
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-01-21 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 Authorization domain model engine includes the Permission and Authorizing models.
   Unidom (统一领域对象模型)是一系列的领域模型引擎。授权领域模型引擎包括权限、授权的模型。