unidom-common 1.9.1 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bd08cfd199d4f29c2097191bf24f73d3291aae1
-  data.tar.gz: 566e2ee9e74cbb4faf9b2e63bc7e6fd3ffea75cf
+  metadata.gz: 4a55892117ff845f398d300492f2cfa3a4667830
+  data.tar.gz: a29d4636705703f4ebc6be67f4bfe6699310e606
 SHA512:
-  metadata.gz: 05ec87e12d971df5e1ff1ab7680375af71b0476a134d05f71f64a6eea713713fb0ef009e47da54a2169fea3febe384cf26b19623a3c0fe44e69226b4918f62c6
-  data.tar.gz: 4c8ae78ce001e40575d426621164b0871d34eed2310e031cda53ccb7355713a9285735b5d38fb7b8ef4028510ca1b924f635441d37055c5f3e87c7f2eb82c288
+  metadata.gz: f5090d419d1f2ecc3d3dc55d00a6a2d05cd032447ba8f9844e9e6437183e72de130ac1d04fdbc6d088cc827188048c6426d713d41ca91d54a61b0aa8467df86a
+  data.tar.gz: 4249e11d7d7e2e3a4e8d4a8f81360f167408f7690ea3f5f5c7370becd4c71f954081c8a06401ce718735e57bff7750a74c40f5558d6cbd63cdea0189874838bc

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

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

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

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

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

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

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

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

data/app/models/unidom/common/concerns/md5_digester.rb

@@ -1,3 +1,6 @@
+##
+# MD-5 Digester 基于 MD-5 算法的摘要逻辑关注点。
+
 module Unidom::Common::Concerns::Md5Digester
 
   extend ActiveSupport::Concern

data/app/models/unidom/common/concerns/sha1_digester.rb

@@ -1,3 +1,6 @@
+##
+# SHA-1 Digester 基于 SHA-1 算法的摘要逻辑关注点。
+
 module Unidom::Common::Concerns::Sha1Digester
 
   extend ActiveSupport::Concern

data/app/models/unidom/common/concerns/sha256_digester.rb

@@ -1,3 +1,6 @@
+##
+# SHA-256 Digester 基于 SHA-256 算法的摘要逻辑关注点。
+
 module Unidom::Common::Concerns::Sha256Digester
 
   extend ActiveSupport::Concern

data/app/models/unidom/common/concerns/sha2_digester.rb

@@ -1,3 +1,6 @@
+##
+# SHA-2 Digester 基于 SHA-2 算法的摘要逻辑关注点。
+
 module Unidom::Common::Concerns::Sha2Digester
 
   extend ActiveSupport::Concern

data/app/models/unidom/common/concerns/sha384_digester.rb

@@ -1,3 +1,6 @@
+##
+# SHA-384 Digester 基于 SHA-384 算法的摘要逻辑关注点。
+
 module Unidom::Common::Concerns::Sha384Digester
 
   extend ActiveSupport::Concern

data/app/models/unidom/common/concerns/sha512_digester.rb

@@ -1,3 +1,6 @@
+##
+# SHA-512 Digester 基于 SHA-512 算法的摘要逻辑关注点。
+
 module Unidom::Common::Concerns::Sha512Digester
 
   extend ActiveSupport::Concern

data/lib/unidom/common/data_helper.rb

@@ -5,6 +5,11 @@ module Unidom
 
     module DataHelper
 
+      ##
+      # 以 CSV 的格式加载 file_name 对应的文件，利用闭包遍历每一行。如：
+      # Unidom::Common::DataHelper.each_csv_row '/var/file.csv' do |line|
+      #   puts line.inspect
+      # end
       def each_csv_row(file_name, &block)
 
         started_at = Time.now
@@ -21,6 +26,11 @@ module Unidom
 
       end
 
+      ##
+      # 根据日期文本 date_text 解析出时间，如果日期文本为空，则返回指定的时间或当前时间。如：
+      # Unidom::Common::DataHelper.parse_time '2000-01-01'           # 2000-01-01 00:00:00
+      # Unidom::Common::DataHelper.parse_time ''                     # Time.now
+      # Unidom::Common::DataHelper.parse_time nil, Time.now-1.minute # Time.now-1.minute
       def parse_time(date_text, default = Time.now)
         return default if date_text.blank?
         date = Date.parse date_text

data/lib/unidom/common/engine_extension.rb

@@ -11,6 +11,11 @@ module Unidom::Common::EngineExtension
 
   module ClassMethods
 
+    ##
+    # 设置初始化器的开关。如:
+    # Unidom::Common::EngineExtension.enable_initializer enum_enabled: true, migration_enabled: false
+    # enum_enabled 表明是否加载枚举型。
+    # migration_enabled 表明是否运行领域模型数据库迁移脚本，同时也表明加载对应的领域模型。
     def enable_initializer(enum_enabled: false, migration_enabled: false)
 
       if enum_enabled

data/lib/unidom/common/neglection.rb

@@ -1,7 +1,19 @@
+##
+# Neglection 根据配置信息忽略指定的类或者命名空间。
+
 class Unidom::Common::Neglection
 
+  ##
+  # 判断指定的类名是否被忽略。如:
+  # Unidom::Common::Neglection.namespace_neglected? 'Namespace::ClassName'
+  # 在应用的 config/initializers/unidom.rb 文件中配置如下代码，即可忽略 Namespace::ClassName 这个类。
+  # Unidom::Common.configure do |options|
+  # # The migrations inside the following namespaces will be ignored. The models inside the following namespaces won't be defined.
+  # options[:neglected_namespaces] = %w{
+  #   Namespace::ClassName
+  # }
   def self.namespace_neglected?(class_name)
-    neglected_namespaces = Unidom::Common.options[:neglected_namespaces]
+    neglected_namespaces = Unidom::Common.try(:options).try(:[], :neglected_namespaces)
     neglected_namespaces.present? ? neglected_namespaces.include?(class_name.to_s.deconstantize) : false
   end
 

data/lib/unidom/common/numeration.rb

@@ -3,10 +3,16 @@
 
 class Unidom::Common::Numeration
 
+  ##
+  # 将二进制数据转换成 16 进制的表达。如：
+  # Unidom::Common::Numeration.hex [ 'A', '}' ]
   def self.hex(data)
     data.present? ? data.unpack('H*')[0] : nil
   end
 
+  ##
+  # 将十六进制数的表达字符串，转换成二进制数据。如：
+  # Unidom::Common::Numeration.rev_hex '6CA0'
   def self.rev_hex(hex)
     hex.present? ? hex.scan(/../).map(&:hex).pack('c*') : nil
   end

data/lib/unidom/common/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Common
-    VERSION = '1.9.1'.freeze
+    VERSION = '1.9.2'.freeze
   end
 end

data/lib/unidom/common/yaml_helper.rb

@@ -3,6 +3,8 @@
 
 module Unidom::Common::YamlHelper
 
+  ##
+  # 从应用或者引擎的跟路径 root 加载 config/enum.yml 中的内容到 config 中。
   def self.load_enum(config: nil, root: nil)
 
     enum_yaml_path = root.join 'config', 'enum.yml'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-common
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.9.2
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails