unidom-position 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56b90af2bb4f6f1323b250f73a3ae94809836dec
-  data.tar.gz: 45a77a41d29fd24921126dc93583064574922b82
+  metadata.gz: 80e180955365b86c13d846f158c09e0b0d4e8481
+  data.tar.gz: 925df0f09a34d753c08477b0038ec496c30f569c
 SHA512:
-  metadata.gz: 420a76be6bb9a848ab84ae646cab39b959cc9e82657b90cf760b77c5e5adf355f8917ad73eaa8bfc5e33964e1d7aedfa11eec4c845dd5844d05d8741c6761a2d
-  data.tar.gz: 85ad988a4a1673ee2fc12f41b743712dabd7f2455424767e2644d1fef44fac11a01044f4cd539f21446c43c54a07c2608dac5c2130cb99d7ea084986561d2fe6
+  metadata.gz: de79f6dc7e5fcf1bb85e1c3b4d66943721d266551fa447d13d6ae9f3822e12252d190caf4e34fb9987cd5ba3b635b140f53e23084ca69b5ef0c153aeb9df10c7
+  data.tar.gz: e44f83de2faa6d66b64d930b00c6120ac8731a36bfd1ed31f74bffca81da1df4b7d5cc772c9e4f722974e4ff3a3876594cec39d86aa3ecba13eb0a3ba1ffcf31

data/README.md

@@ -1,6 +1,8 @@
 # Unidom Position 职位领域模型引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/unidom-position/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/unidom-position.svg)](https://badge.fury.io/rb/unidom-position)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/unidom-position.svg)](https://gemnasium.com/github.com/topbitdu/unidom-position)
 
@@ -69,16 +71,40 @@ include Unidom::Position::Concerns::AsSuperiorPost
 
 ### As Inferior Post
 
-The As Inferior Post concern do the following tasks for the includer automatically:  
-1. Define the has_many :superior_post_reporting_structures macro as: ``has_many :superior_post_reporting_structures, class_name: 'Unidom::Position::PostReportingStructure', source: :inferior_post, foreign_key: :inferior_post_id``  
-2. Define the has_many :superior_posts macro as: ``has_many :superior_posts, through: :superior_post_reporting_structures, source: :superior_post``  
-3. Define the #report_to! method as: ``report_to!(superior_post, at: Time.now, primary: true)``  
+The As Inferior Post concern do the following tasks for the includer automatically:
+
+1. Define the has_many :superior_post_reporting_structures macro as: ``has_many :superior_post_reporting_structures, class_name: 'Unidom::Position::PostReportingStructure', source: :inferior_post, foreign_key: :inferior_post_id``
+
+2. Define the has_many :superior_posts macro as: ``has_many :superior_posts, through: :superior_post_reporting_structures, source: :superior_post``
+
+3. Define the #report_to! method as: ``report_to!(superior_post, at: Time.now, primary: true)``
+
 4. Define the #report_to? method as: ``report_to?(superior_post, at: Time.now, primary: true)``
 
 ### As Superior Post
 
-The As Superior Post concern do the following tasks for the includer automatically:  
-1. Define the has_many :inferior_post_reporting_structures macro as: ``has_many :inferior_post_reporting_structures, class_name: 'Unidom::Position::PostReportingStructure', source: :superior_post, foreign_key: :superior_post_id``  
-2. Define the has_many :inferior_posts macro as: ``has_many :inferior_posts, through: :inferior_post_reporting_structures, source: :inferior_post``  
-3. Define the #is_reported_to! method as: ``is_reported_to!(by: nil, at: Time.now, primary: true)``  
+The As Superior Post concern do the following tasks for the includer automatically:
+
+1. Define the has_many :inferior_post_reporting_structures macro as: ``has_many :inferior_post_reporting_structures, class_name: 'Unidom::Position::PostReportingStructure', source: :superior_post, foreign_key: :superior_post_id``
+
+2. Define the has_many :inferior_posts macro as: ``has_many :inferior_posts, through: :inferior_post_reporting_structures, source: :inferior_post``
+
+3. Define the #is_reported_to! method as: ``is_reported_to!(by: nil, at: Time.now, primary: true)``
+
 4. Define the #is_reported_to? method as: ``is_reported_to?(by: nil, at: Time.now, primary: true)``
+
+
+
+## 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::Position
+  }
+
+end
+```

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

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

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

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

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

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

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

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

data/app/models/unidom/position/concerns/as_inferior_post.rb

@@ -1,3 +1,6 @@
+##
+# As Inferior Post 是下级岗位的领域逻辑关注点。
+
 module Unidom::Position::Concerns::AsInferiorPost
 
   extend ActiveSupport::Concern
@@ -7,6 +10,10 @@ module Unidom::Position::Concerns::AsInferiorPost
     has_many :superior_post_reporting_structures, class_name: 'Unidom::Position::PostReportingStructure', source: :inferior_post, foreign_key: :inferior_post_id
     has_many :superior_posts,                     through:    :superior_post_reporting_structures,        source: :superior_post
 
+    ##
+    # 以下级岗位的身份与上级岗位 superior_post 建立岗位间的上下级汇报关系。
+    # 主要汇报标志是 primary ，缺省为 true 。建立时间是 at ，缺省为当前时间。如：
+    # rails_developer.report_to! project_manager, primary: false
     def report_to!(superior_post, at: Time.now, primary: true)
       superior_post_reporting_structures.superior_post_is(superior_post).valid_at(now: at).alive.first_or_create! elemental: primary, opened_at: at
     end

data/app/models/unidom/position/concerns/as_superior_post.rb

@@ -1,3 +1,6 @@
+##
+# As Superior Post 是上级岗位的领域逻辑关注点。
+
 module Unidom::Position::Concerns::AsSuperiorPost
 
   extend ActiveSupport::Concern
@@ -7,6 +10,10 @@ module Unidom::Position::Concerns::AsSuperiorPost
     has_many :inferior_post_reporting_structures, class_name: 'Unidom::Position::PostReportingStructure', source: :superior_post, foreign_key: :superior_post_id
     has_many :inferior_posts,                     through:    :inferior_post_reporting_structures,        source: :inferior_post
 
+    ##
+    # 以上级岗位的身份与下级岗位 by 建立岗位间的上下级汇报关系。
+    # 主要汇报标志是 primary ，缺省为 true 。建立时间是 at ，缺省为当前时间。如：
+    # project_manager.is_reported_to! by: rails_developer, primary: false
     def is_reported_to!(by: nil, at: Time.now, primary: true)
       inferior_post_reporting_structures.inferior_post_is(by).valid_at(now: at).alive.first_or_create! elemental: primary, opened_at: at
     end

data/app/models/unidom/position/occupation.rb

@@ -18,4 +18,4 @@ class Unidom::Position::Occupation < Unidom::Position::ApplicationRecord
   scope :scheme_id_is,   ->(scheme_id)   { where scheme_id:   scheme_id   }
   scope :scheme_type_is, ->(scheme_type) { where scheme_type: scheme_type }
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Position::Occupation'

data/app/models/unidom/position/position.rb

@@ -14,4 +14,4 @@ class Unidom::Position::Position < Unidom::Position::ApplicationRecord
 
   has_many :posts, class_name: 'Unidom::Position::Post'
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Position::Position'

data/app/models/unidom/position/post.rb

@@ -14,4 +14,4 @@ class Unidom::Position::Post < Unidom::Position::ApplicationRecord
   belongs_to :organization, polymorphic: true
   belongs_to :position,     class_name:  'Unidom::Position::Position'
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Position::Post'

data/app/models/unidom/position/post_reporting_structure.rb

@@ -13,10 +13,14 @@ class Unidom::Position::PostReportingStructure < Unidom::Position::ApplicationRe
   scope :superior_post_is, ->(superior_post) { where superior_post_id: to_id(superior_post) }
   scope :inferior_post_is, ->(inferior_post) { where inferior_post_id: to_id(inferior_post) }
 
+  ##
+  # 建立岗位间的上下级汇报关系。上级岗位是 superior_post ，下级岗位是 inferior_post 。
+  # 主要汇报标志是 elemental ，缺省为 true 。建立时间是 opened_at ，缺省为当前时间。如：
+  # Unidom::Position::PostReportingStructure.report! superior_post: superior_post, inferior_post: inferior_post
   def self.report!(superior_post: nil, inferior_post: nil, elemental: true, opened_at: Time.now)
     raise ArgumentError.new('The superior_post argument is required.') if superior_post.blank?
     raise ArgumentError.new('The inferior_post argument is required.') if inferior_post.blank?
     self.inferior_post_is(inferior_post).superior_post_is(superior_post).valid_at.alive.first_or_create! elemental: elemental, opened_at: opened_at
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Position::PostReportingStructure'

data/lib/unidom/position/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-position
 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-23 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 Position domain model engine includes the Occupation, Position, Post, and Position
   Reporting Structure models. Unidom (统一领域对象模型)是一系列的领域模型引擎。职位领域模型引擎包括职业、职位、岗位及职位报告关系模型。