unidom-common 1.9.2 → 1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a55892117ff845f398d300492f2cfa3a4667830
-  data.tar.gz: a29d4636705703f4ebc6be67f4bfe6699310e606
+  metadata.gz: 82885ef3b635b592845732747e2969ff094fb704
+  data.tar.gz: 5dfb807730c4303586b7c434bc2adea8198a9614
 SHA512:
-  metadata.gz: f5090d419d1f2ecc3d3dc55d00a6a2d05cd032447ba8f9844e9e6437183e72de130ac1d04fdbc6d088cc827188048c6426d713d41ca91d54a61b0aa8467df86a
-  data.tar.gz: 4249e11d7d7e2e3a4e8d4a8f81360f167408f7690ea3f5f5c7370becd4c71f954081c8a06401ce718735e57bff7750a74c40f5558d6cbd63cdea0189874838bc
+  metadata.gz: a666ed1ac16160fcff279ea5d289b63f4b5b366eb6eef45cae6baf230feff72e0a15768149fd940c2cf9ad80631a64254519c8312e18682a95f7a73da471212e
+  data.tar.gz: 51499f8975ee71f6c40cb7e01a1c0029f58635b8bc230592290ee319e8745685e40d0bfaa1e0ca08e4c6201fbae18666db354439db65e21b9269176abfab2dde

data/README.md

@@ -44,6 +44,21 @@ include Unidom::Common::Concerns::ModelExtension
 
 
 
+## Constants
+
+```ruby
+Unidom::Common::NULL_UUID      # '00000000-0000-0000-0000-000000000000'
+Unidom::Common::MAXIMUM_AMOUNT # 1_000_000_000
+Unidom::Common::SELF           # '~'
+
+Unidom::Common::OPENED_AT # Time.utc(1970)
+Unidom::Common::CLOSED_AT # Time.utc(3000)
+
+Unidom::Common::FROM_DATE # '1970-01-01'
+Unidom::Common::THRU_DATE # '3000-01-01'
+
+```
+
 ## Model Extension concern
 
 ```ruby

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

@@ -7,10 +7,20 @@ module Unidom::Common::Concerns::Aes256Cryptor
 
   included do |includer|
 
+    ##
+    # 将明文 message 用秘钥 key 进行加密。如：
+    # encrypt 'clear text'
+    # 或
+    # encrypt 'clear text', key: aes256_key
     def encrypt(message, key: nil)
       self.class.encrypt message, key: key
     end
 
+    ##
+    # 将密文 encoded 用秘钥 key 进行解密。如：
+    # decrypt encoded
+    # 或
+    # decrypt encoded, key: aes256_key
     def decrypt(encoded, key: nil)
       self.class.decrypt encoded, key: key
     end

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

@@ -7,6 +7,9 @@ module Unidom::Common::Concerns::ArgumentValidation
 
   included do |includer|
 
+    ##
+    # 断言给定的参数 value 非空。如果为空，则抛出 ArgumentError 异常。如：
+    # assert_present! :person, person
     def assert_present!(name, value)
       raise ArgumentError.new("The #{name} argument is required.") if value.blank?
     end

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

@@ -10,6 +10,12 @@ module Unidom::Common::Concerns::ExactColumn
 
   module ClassMethods
 
+    ##
+    # 配置精确索引列。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::ExactColumn
+    #   exact_column :phone_number, :identification_number
+    # end
     def exact_column(*names)
 
       exact_column_names = exact_column_names||[]

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

@@ -7,6 +7,16 @@ module Unidom::Common::Concerns::Md5Digester
 
   included do |includer|
 
+    ##
+    # 对明文 message 进行 MD-5 摘要， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Md5Digester
+    #   def some_method(param_1)
+    #     digest param_1
+    #     # 或者
+    #     digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def digest(message, pepper: nil)
       self.class.digest message, pepper: pepper
     end

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

@@ -21,17 +21,6 @@ module Unidom::Common::Concerns::ModelExtension
     scope :alive, ->(living:  true) { where defunct: !living }
     scope :dead,  ->(defunct: true) { where defunct: defunct }
 
-=begin
-    scope :notation_column_where, ->(name, operator, value) do
-      operation = :like==operator ? { operator: 'ILIKE', value: "%#{value}%" } : { operator: operator.to_s, value: value }
-      where "#{table_name}.notation -> 'columns' ->> '#{name}' #{operation[:operator]} :value", value: operation[:value]
-    end
-
-    scope :notation_boolean_column_where, ->(name, value) do
-      where "(#{table_name}.notation -> 'columns' ->> '#{name}')::boolean = :value", value: (value ? true : false)
-    end
-=end
-
     if columns_hash['ordinal'].present?&&:integer==columns_hash['ordinal'].type
       validates :ordinal, presence: true, numericality: { only_integer: true, greater_than: 0 }
       scope :ordinal_is, ->(ordinal) { where ordinal: ordinal }
@@ -142,16 +131,14 @@ module Unidom::Common::Concerns::ModelExtension
       end
     end
 
-=begin
-    def assert_present!(name, value)
-      raise ArgumentError.new("The #{name} argument is required.") if value.blank?
-    end
-=end
-
   end
 
   module ClassMethods
 
+    ##
+    # 将模型对象或者 ID 转换成 ID 。如：
+    # to_id(person)    # person.id
+    # to_id(person.id) # person.id
     def to_id(model)
       model.respond_to?(:id) ? model.id : model
     end
@@ -160,65 +147,6 @@ module Unidom::Common::Concerns::ModelExtension
       code.respond_to?(:code) ? code.code : code
     end
 
-=begin
-    def notation_column(*names)
-      names.each do |name|
-        name = name.to_s
-        instance_eval do
-          define_method(name) do
-            notation.try(:[], 'columns').try(:[], name)
-          end
-          define_method("#{name}=") do |value|
-            notation['columns'] ||= {}
-            notation['columns'][name] = value
-          end
-        end
-      end
-    end
-
-    def notation_boolean_column(*names)
-      names.each do |name|
-        name = name.to_s
-        instance_eval do
-          define_method("#{name}?") do
-            notation.try(:[], 'columns').try(:[], name)
-          end
-          define_method("#{name}=") do |value|
-            notation['columns'] ||= {}
-            notation['columns'][name] = value
-          end
-        end
-      end
-    end
-=end
-
-=begin
-    def exact_column(*names)
-      names.each do |name|
-        name = name.to_s
-        instance_eval do
-          scope :"#{name}_is", ->(value) { where "#{name}_exact_signature" => exact_signature(self, name, value) }
-          before_save do
-            send "#{name}_exact_signature=", self.class.exact_signature(self.class, name, send(name))
-          end
-        end
-      end
-    end
-=end
-
-=begin
-    def assert_present!(name, value)
-      raise ArgumentError.new("The #{name} argument is required.") if value.blank?
-    end
-=end
-
-=begin
-    def exact_signature(klass, name, value)
-      text = "#{Rails.application.secrets[:secret_key_base]}@#{Rails.root}/#{klass.table_name}##{name}=#{value}"
-      "#{Digest::MD5.digest(text)}#{Digest::SHA512.digest(text)}"
-    end
-=end
-
   end
 
 end

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

@@ -17,6 +17,9 @@ module Unidom::Common::Concerns::NotationColumn
 
   module ClassMethods
 
+    ##
+    # 定义 JSON 类型的列。如：
+    # notation_column :given_name, :family_name
     def notation_column(*names)
       names.each do |name|
         name = name.to_s

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

@@ -7,10 +7,30 @@ module Unidom::Common::Concerns::Sha1Digester
 
   included do |includer|
 
+    ##
+    # 对明文 message 进行 SHA-1 摘要， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha1Digester
+    #   def some_method(param_1)
+    #     digest param_1
+    #     # 或者
+    #     digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def digest(message, pepper: nil)
       self.class.digest message, pepper: pepper
     end
 
+    ##
+    # 对明文 message 进行 SHA-1 摘要，并以16进制的形式返回， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha1Digester
+    #   def some_method(param_1)
+    #     hex_digest param_1
+    #     # 或者
+    #     hex_digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def hex_digest(message, pepper: nil)
       self.class.hex_digest message, pepper: pepper
     end

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

@@ -7,10 +7,30 @@ module Unidom::Common::Concerns::Sha256Digester
 
   included do |includer|
 
+    ##
+    # 对明文 message 进行 SHA-256 摘要， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha256Digester
+    #   def some_method(param_1)
+    #     digest param_1
+    #     # 或者
+    #     digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def digest(message, pepper: nil)
       self.class.digest message, pepper: pepper
     end
 
+    ##
+    # 对明文 message 进行 SHA-256 摘要，并以16进制的形式返回， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha256Digester
+    #   def some_method(param_1)
+    #     hex_digest param_1
+    #     # 或者
+    #     hex_digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def hex_digest(message, pepper: nil)
       self.class.hex_digest message, pepper: pepper
     end

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

@@ -7,10 +7,30 @@ module Unidom::Common::Concerns::Sha2Digester
 
   included do |includer|
 
+    ##
+    # 对明文 message 进行 SHA-2 摘要， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha2Digester
+    #   def some_method(param_1)
+    #     digest param_1
+    #     # 或者
+    #     digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def digest(message, pepper: nil)
       self.class.digest message, pepper: pepper
     end
 
+    ##
+    # 对明文 message 进行 SHA-2 摘要，并以16进制的形式返回， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha2Digester
+    #   def some_method(param_1)
+    #     hex_digest param_1
+    #     # 或者
+    #     hex_digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def hex_digest(message, pepper: nil)
       self.class.hex_digest message, pepper: pepper
     end

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

@@ -7,10 +7,30 @@ module Unidom::Common::Concerns::Sha384Digester
 
   included do |includer|
 
+    ##
+    # 对明文 message 进行 SHA-384 摘要， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha384Digester
+    #   def some_method(param_1)
+    #     digest param_1
+    #     # 或者
+    #     digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def digest(message, pepper: nil)
       self.class.digest message, pepper: pepper
     end
 
+    ##
+    # 对明文 message 进行 SHA-384 摘要，并以16进制的形式返回， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha384Digester
+    #   def some_method(param_1)
+    #     hex_digest param_1
+    #     # 或者
+    #     hex_digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def hex_digest(message, pepper: nil)
       self.class.hex_digest message, pepper: pepper
     end

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

@@ -7,10 +7,30 @@ module Unidom::Common::Concerns::Sha512Digester
 
   included do |includer|
 
+    ##
+    # 对明文 message 进行 SHA-512 摘要， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha512Digester
+    #   def some_method(param_1)
+    #     digest param_1
+    #     # 或者
+    #     digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def digest(message, pepper: nil)
       self.class.digest message, pepper: pepper
     end
 
+    ##
+    # 对明文 message 进行 SHA-512 摘要，并以16进制的形式返回， pepper 是用于增加混乱的内容。如：
+    # class SomeModel
+    #   include Unidom::Common::Concerns::Sha512Digester
+    #   def some_method(param_1)
+    #     hex_digest param_1
+    #     # 或者
+    #     hex_digest param_1, pepper: 'my_pepper'
+    #   end
+    # end
     def hex_digest(message, pepper: nil)
       self.class.hex_digest message, pepper: pepper
     end

data/lib/unidom/common.rb

@@ -7,17 +7,29 @@ require 'unidom/common/engine_extension'
 module Unidom
   module Common
 
-    NULL_UUID = '00000000-0000-0000-0000-000000000000'.freeze
-    SELF      = '~'.freeze
+    NULL_UUID      = '00000000-0000-0000-0000-000000000000'.freeze
+    MAXIMUM_AMOUNT = 1_000_000_000.freeze
+    SELF           = '~'.freeze
 
-    #OPENED_AT = Time.utc(1970).freeze
-    #CLOSED_AT = Time.utc(3000).freeze
+    OPENED_AT = Time.utc(1970).freeze
+    CLOSED_AT = Time.utc(3000).freeze
 
-    #FROM_DATE = '1970-01-01'.freeze
-    #THRU_DATE = '3000-01-01'.freeze
+    FROM_DATE = '1970-01-01'.freeze
+    THRU_DATE = '3000-01-01'.freeze
 
     mattr_accessor :options
 
+    ##
+    # 对 Unidom 的各个模块进行配置。如：
+    # Unidom::Common.configure do |options|
+    #
+    #   # neglected_namespaces 列出的命名空间对应的 migration 不会被执行， model 也不会被加载。
+    #   # 但 concern 、 validator 、 type 、 helper 、 controller 、 view 等都可以正常使用。
+    #   options[:neglected_namespaces] = %w{
+    #     Unidom::Action
+    #   }
+    #
+    # end
     def self.configure
 
       options = {}

data/lib/unidom/common/engine.rb

@@ -5,12 +5,6 @@ module Unidom
 
       config.autoload_paths += %W(
         #{config.root}/lib
-        #{config.root}/app/models/unidom/common/concerns
-      )
-
-      config.eager_load_paths += %W(
-        #{config.root}/lib
-        #{config.root}/app/models/unidom/common/concerns
       )
 
       isolate_namespace ::Unidom::Common

data/lib/unidom/common/version.rb

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

metadata

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