unidom-score 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0b5e95a644e2722c9025887c060acc57e1b6563
-  data.tar.gz: 37a987d4cb632e081ffae4e6ce3983624e605c98
+  metadata.gz: eaa607c731316c64167f570f7b5d6f9a9d35377c
+  data.tar.gz: a2910f4c55f4ce798026fbf5bfcdf03167e9be93
 SHA512:
-  metadata.gz: 21d8c2b0a3ca2a46183bcf0b5c9b145eb71a88316db3382415f7ea0a929bf784bbdcaf0e8597b754ff659452a6073a79a882ebbf10a9ff8013cb1827602d8cca
-  data.tar.gz: 8eae79d927f7cad9a8806b1648e902df96a8feaf4a98db2feb441481d7d876667fdefb89fad0ccfac08ce2c79673694b43705d99a3ec8dc9f1d4feaf1f133c64
+  metadata.gz: 92aeb82df2fbda87c322bad426f8d92fd9cfa1c54966b601eb61add780f63d746d5bd5896ef68419617690a246e9a7e9f7186da78c723049ee9b86a4795952d0
+  data.tar.gz: e712a734cd42ef93b35099f196150c6b53f03263f5787b9258a441c7f28a1e8c619845501883d6b6140c3b7949ec9142baa5027807c34fa27a792724e31ea267

data/README.md

@@ -1,6 +1,8 @@
 # Unidom Score 评分领域模型引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/unidom-score/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/unidom-score.svg)](https://badge.fury.io/rb/unidom-score)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/unidom-score.svg)](https://gemnasium.com/github.com/topbitdu/unidom-score)
 
@@ -51,3 +53,19 @@ item_1 = Unidom::Score::ScoreItem.score! sheet: score_sheet, scorer: score_sheet
 item_2 = Unidom::Score::ScoreItem.score! sheet: score_sheet, scorer: score_sheet.try(:scorer), template: item_template_2, title: item_template_2.try(:title), score: 39, scored_on: Date.current, opened_at: Time.now, description: nil, instruction: nil
 # The template could be nil
 ```
+
+
+
+## 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::Score
+  }
+
+end
+```

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

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

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

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

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

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

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

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

data/app/models/unidom/score/score_item.rb

@@ -21,8 +21,13 @@ class Unidom::Score::ScoreItem < Unidom::Score::ApplicationRecord
   scope :template_is, ->(template) { where template_id: to_id(template) }
   scope :scored_by,   ->(scorer)   { where scorer:      scorer          }
 
+  ##
+  # 评分员 scorer (缺省为评分表的评分员) 以 template 为模版（可以为空）在评分表 sheet 上评分。评分项的标题为 title ，缺省为评分项模版的标题。
+  # 得分为 score ，缺省为 0 。得分日期为 scored_on ，缺省为当天。记录时间为 opened_at ，缺省为当前时间。
+  # 另有适用于己方的备注 description 和适用于对方的备注 instruction。如：
+  # Unidom::Score::ScoreItem.score! sheet: score_sheet, template: score_item_template, score: 20
   def self.score!(sheet: nil, scorer: sheet.try(:scorer), template: nil, title: template.try(:title), score: 0, scored_on: Date.current, opened_at: Time.now, description: nil, instruction: nil)
     create! sheet: sheet, scorer: scorer, template: template, title: title, score: score, scored_on: scored_on, opened_at: opened_at, description: description, instruction: instruction
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Score::ScoreItem'

data/app/models/unidom/score/score_item_template.rb

@@ -18,4 +18,4 @@ class Unidom::Score::ScoreItemTemplate < Unidom::Score::ApplicationRecord
 
   scope :sheet_is, ->(sheet) { where sheet_id: to_id(sheet) }
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Score::ScoreItemTemplate'

data/app/models/unidom/score/score_sheet.rb

@@ -24,8 +24,13 @@ class Unidom::Score::ScoreSheet < Unidom::Score::ApplicationRecord
   scope :scored_by,     ->(scorer)       { where scorer:       scorer          }
   scope :score_kept_by, ->(score_keeper) { where score_keeper: score_keeper    }
 
+  ##
+  # 评分员 scorer 以 template 为模版（可以为空），对得分者 score_keeper 评分。评分表的名称为 name ，缺省为模版的名称。
+  # 得分为 score ，缺省为 0 。得分日期为 scored_on ，缺省为当天。记录时间为 opened_at ，缺省为当前时间。
+  # 另有适用于己方的备注 description 和适用于对方的备注 instruction。如：
+  # Unidom::Score::ScoreSheet.score! scorer: officer, score_keeper: shop, template: score_sheet_template, score: 100
   def self.score!(scorer: nil, score_keeper: nil, template: nil, name: template.try(:name), score: 0, scored_on: Date.current, opened_at: Time.now, description: nil, instruction: nil)
     create! scorer: scorer, score_keeper: score_keeper, template: template, name: name, score: score, scored_on: scored_on, opened_at: opened_at, description: description, instruction: instruction
   end
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Score::ScoreSheet'

data/app/models/unidom/score/score_sheet_template.rb

@@ -20,4 +20,4 @@ class Unidom::Score::ScoreSheetTemplate < Unidom::Score::ApplicationRecord
 
   scope :subject_is, ->(subject) { where subject: subject }
 
-end
+end unless Unidom::Common::Neglection.namespace_neglected? 'Unidom::Score::ScoreSheetTemplate'

data/lib/unidom/score/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Score
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.0.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-score
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 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 Score domain model engine includes the Score Sheet, the Score Sheet Item, the
   Score Sheet Template, and the Score Sheet Template Item. Unidom (统一领域对象模型)是一系列的领域模型引擎。评分领域模型引擎包括评分表、评分项、评分表模版和评分项模版模型。