unidom-common 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88c40a102845260fbe5699f42e6d5c2735ffa0c0
-  data.tar.gz: 47f31fb4af3d8fb94cd73568399293dd6c0ebbe8
+  metadata.gz: 72b239e03d003ae2a4e0f68db103b014417ea67e
+  data.tar.gz: 24dc122ec9aa546cbbe8565eab0bd56ace09a143
 SHA512:
-  metadata.gz: 3e326b1f17168a898d71f72e2fd2f642d67c85cb8ddaa132a6abd28ff25c1a1a51b0cb3c016d32c630abc151d254c360cc2185004a572ff22309855cc8ad10af
-  data.tar.gz: 9c65b56a55eb3184101a42ead4afaca5b9c0fd0d67b8975ed469fc1f506d5776578c6f213b7423c5135b72920eaf5d00f8a286c8fbd976d47ad6007c8282d851
+  metadata.gz: d0ee19de3aaff418f90faf82cd2cf56e7dee37d42907057317161712d1f76ce7d06aa17321121ed9e22fbc817a3fb06bebc1b0342560c10cf669fd805e6f3a1d
+  data.tar.gz: b833df4e2a8e3efd2654ab64a379bcf0dd9ac1bbf4c99f6b4724fcdd89a5f3a7c9c78a27faa7bbb2400f34f20c329dd09196c56ff85f8f705f4c0eda3af07d1d

data/README.md

@@ -235,6 +235,62 @@ hex_digested == Unidom::Common::Numeration.hex digested # true
 ```
 
 
+## SHA 1 Digester
+```ruby
+class IdentityCard
+
+  include Unidom::Common::Concerns::Sha1Digester
+  attr_accessor :identification_number
+
+  def initialize(identification_number)
+    self.identification_number = identification_number
+  end
+
+  def digest_identification_number
+    digest identification_number, pepper: self.class.name
+  end
+
+  def hex_digest_identification_number
+    hex_digest identification_number, pepper: self.class.name
+  end
+
+end
+
+identity_card = IdentityCard.new '9527'
+digested      = identity_card.digest_identification_number
+hex_digested  = identity_card.hex_digest_identification_number
+hex_digested == Unidom::Common::Numeration.hex digested # true
+```
+
+
+## SHA 2 Digester
+```ruby
+class IdentityCard
+
+  include Unidom::Common::Concerns::Sha1Digester
+  attr_accessor :identification_number
+
+  def initialize(identification_number)
+    self.identification_number = identification_number
+  end
+
+  def digest_identification_number
+    digest identification_number, pepper: self.class.name
+  end
+
+  def hex_digest_identification_number
+    hex_digest identification_number, pepper: self.class.name
+  end
+
+end
+
+identity_card = IdentityCard.new '9527'
+digested      = identity_card.digest_identification_number
+hex_digested  = identity_card.hex_digest_identification_number
+hex_digested == Unidom::Common::Numeration.hex digested # true
+```
+
+
 ## ActiveRecord Migration Naming Convention
 ### Domain Models (200YMMDDHHMMSS)
 
@@ -305,6 +361,7 @@ hex_digested == Unidom::Common::Numeration.hex digested # true
       <td>The Standard domain model engine includes the Standard model and the Standard Associating model. 标准领域模型引擎包括行为标准和标准关联的模型。</td>
     </tr>
 
+
     <tr>
       <td>[![unidom-party](https://badge.fury.io/rb/unidom-party.svg)](https://github.com/topbitdu/unidom-party)</td>
       <td>200101DDHHMMSS</td>
@@ -348,6 +405,7 @@ hex_digested == Unidom::Common::Numeration.hex digested # true
       <td>The Geo domain model engine includes the Location and Locating models. 地理领域模型引擎包括位置和定位的模型。</td>
     </tr>
 
+
     <tr>
       <td>[![unidom-article_number](https://badge.fury.io/rb/unidom-article_number.svg)](https://github.com/topbitdu/unidom-article_number)</td>
       <td>200201DDHHMMSS</td>
@@ -399,6 +457,19 @@ hex_digested == Unidom::Common::Numeration.hex digested # true
       <td>The Order domain model engine includes Order, Order Item, and Order Adjustment models. 订单领域模型引擎包括订单、订单项和订单调整的模型。</td>
     </tr>
 
+    <tr>
+      <td>[![unidom-inventory](https://badge.fury.io/rb/unidom-inventory.svg)](https://github.com/topbitdu/unidom-inventory)</td>
+      <td>200209DDHHMMSS</td>
+      <td>
+        - Serialized Inventory Item
+        - Grouped Inventory Item
+        - Lot
+        - Inventory Item Variance
+      </td>
+      <td>The Inventory domain model engine includes the Serialized Inventory Item, the Grouped Inventory Item, the Lot, and the Inventory Item Variance models. 库存领域模型引擎包括序列化库存项、分组库存项、批量和库存项变化的模型。</td>
+    </tr>
+
+
     <tr>
       <td>[![unidom-position](https://badge.fury.io/rb/unidom-position.svg)](https://github.com/topbitdu/unidom-position)</td>
       <td>200402DDHHMMSS</td>
@@ -421,6 +492,7 @@ hex_digested == Unidom::Common::Numeration.hex digested # true
       <td>The Position domain model engine includes the Post Fulfillment and its relative models. 就职领域模型引擎包括岗位履行及其相关的模型。</td>
     </tr>
 
+
   </tbody>
 </table>
 

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

@@ -4,6 +4,30 @@ module Unidom::Common::Concerns::Aes256Cryptor
 
   included do |includer|
 
+    def encrypt(message, key: nil)
+      self.class.encrypt message, key: key
+    end
+
+    def decrypt(encoded, key: nil)
+      self.class.decrypt encoded, key: key
+    end
+
+    def aes_256_padding
+      self.class.aes_256_padding
+    end
+
+    def hex_encrypt(message, key: nil)
+      self.class.hex_encrypt message, key: key
+    end
+
+    def hex_decrypt(encoded, key: nil)
+      self.class.hex_decrypt encoded, key: key
+    end
+
+  end
+
+  module ClassMethods
+
     def encrypt(message, key: nil)
 
       raise ArgumentError.new('The message argument is required.') if message.blank?

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

@@ -1,186 +1,179 @@
-module Unidom
-  module Common
-    module Concerns
+module Unidom::Common::Concerns::ModelExtension
 
-      module ModelExtension
+  extend ActiveSupport::Concern
 
-        extend ActiveSupport::Concern
+  included do |includer|
 
-        included do |includer|
+    validates :state, presence: true, length: { is: columns_hash['state'].limit }
 
-          validates :state, presence: true, length: { is: columns_hash['state'].limit }
+    scope :included_by, ->(inclusion) { where     id: inclusion }
+    scope :excluded_by, ->(exclusion) { where.not id: exclusion }
 
-          scope :included_by, ->(inclusion) { where     id: inclusion }
-          scope :excluded_by, ->(exclusion) { where.not id: exclusion }
+    scope :transited_to, ->(states) { where state: states }
 
-          scope :transited_to, ->(states) { where state: states }
+    scope :valid_at,       ->(now: Time.now) { where "? BETWEEN #{includer.table_name}.opened_at AND #{includer.table_name}.closed_at", now }
+    scope :valid_duration, ->(range)          { where "(#{includer.table_name}.opened_at BETWEEN ? AND ?) OR (#{includer.table_name}.closed_at <= ? AND #{includer.table_name}.closed_at >= ?)", range.min, range.max, range.max, range.min }
 
-          scope :valid_at,       ->(now: Time.now) { where "? BETWEEN #{includer.table_name}.opened_at AND #{includer.table_name}.closed_at", now }
-          scope :valid_duration, ->(range)          { where "(#{includer.table_name}.opened_at BETWEEN ? AND ?) OR (#{includer.table_name}.closed_at <= ? AND #{includer.table_name}.closed_at >= ?)", range.min, range.max, range.max, range.min }
+    scope :alive, ->(living:  true) { where defunct: !living }
+    scope :dead,  ->(defunct: true) { where defunct: defunct }
 
-          scope :alive, ->(living:  true) { where defunct: !living }
-          scope :dead,  ->(defunct: true) { where defunct: defunct }
+    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_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
 
-          scope :notation_boolean_column_where, ->(name, value) do
-            where "(#{table_name}.notation -> 'columns' ->> '#{name}')::boolean = :value", value: (value ? true : false)
-          end
+    if columns_hash['ordinal'].present?&&:integer==columns_hash['ordinal'].type
+      validates :ordinal, presence: true, numericality: { integer_only: true, greater_than: 0 }
+      scope :ordinal_is, ->(ordinal) { where ordinal: ordinal }
+    end
 
-          if columns_hash['ordinal'].present?&&:integer==columns_hash['ordinal'].type
-            validates :ordinal, presence: true, numericality: { integer_only: true, greater_than: 0 }
-            scope :ordinal_is, ->(ordinal) { where ordinal: ordinal }
-          end
+    if columns_hash['uuid'].present?&&:uuid==columns_hash['uuid'].type
+      validates :uuid, presence: true, length: { is: 36 }
+      scope :uuid_is, ->(uuid) { where uuid: uuid }
+    end
 
-          if columns_hash['uuid'].present?&&:uuid==columns_hash['uuid'].type
-            validates :uuid, presence: true, length: { is: 36 }
-            scope :uuid_is, ->(uuid) { where uuid: uuid }
-          end
+    if columns_hash['elemental'].present?&&:boolean==columns_hash['elemental'].type
+      scope :primary, ->(elemental = true) { where elemental: elemental }
+    end
 
-          if columns_hash['elemental'].present?&&:boolean==columns_hash['elemental'].type
-            scope :primary, ->(elemental = true) { where elemental: elemental }
-          end
+    if columns_hash['grade'].present?&&:integer==columns_hash['grade'].type
+      validates :grade, presence: true, numericality: { integer_only: true, greater_than_or_equal_to: 0 }
+      scope :grade_is,          ->(grade) { where grade: grade }
+      scope :grade_higher_than, ->(grade) { where "grade > :grade", grade: grade }
+      scope :grade_lower_than,  ->(grade) { where "grade < :grade", grade: grade }
+    end
 
-          if columns_hash['grade'].present?&&:integer==columns_hash['grade'].type
-            validates :grade, presence: true, numericality: { integer_only: true, greater_than_or_equal_to: 0 }
-            scope :grade_is,          ->(grade) { where grade: grade }
-            scope :grade_higher_than, ->(grade) { where "grade > :grade", grade: grade }
-            scope :grade_lower_than,  ->(grade) { where "grade < :grade", grade: grade }
-          end
+    if columns_hash['priority'].present?&&:integer==columns_hash['priority'].type
+      validates :priority, presence: true, numericality: { integer_only: true, greater_than_or_equal_to: 0 }
+      scope :priority_is,          ->(priority) { where priority: priority }
+      scope :priority_higher_than, ->(priority) { where "priority > :priority", priority: priority }
+      scope :priority_lower_than,  ->(priority) { where "priority < :priority", priority: priority }
+    end
 
-          if columns_hash['priority'].present?&&:integer==columns_hash['priority'].type
-            validates :priority, presence: true, numericality: { integer_only: true, greater_than_or_equal_to: 0 }
-            scope :priority_is,          ->(priority) { where priority: priority }
-            scope :priority_higher_than, ->(priority) { where "priority > :priority", priority: priority }
-            scope :priority_lower_than,  ->(priority) { where "priority < :priority", priority: priority }
-          end
+    if columns_hash['slug'].present?&&:string==columns_hash['slug'].type
+      validates :slug, presence: true, length: { in: 1..columns_hash['slug'].limit }, uniqueness: true
+      scope :slug_is, ->(slug) { where slug: slug }
+      before_validation -> {
+        prefix = build_slug.to_s[0..(self.class.columns_hash['slug'].limit-37)]
+        unique = prefix
+        while includer.slug_is(unique).count>0
+          unique = "#{prefix}-#{::SecureRandom.uuid}"
+        end
+        self.slug = unique
+      }, on: :create
+      # on update: re-generate the slug if the slug was assigned to empty.
+      # to_query:  escape characters
+    end
 
-          if columns_hash['slug'].present?&&:string==columns_hash['slug'].type
-            validates :slug, presence: true, length: { in: 1..columns_hash['slug'].limit }, uniqueness: true
-            scope :slug_is, ->(slug) { where slug: slug }
-            before_validation -> {
-              prefix = build_slug.to_s[0..(self.class.columns_hash['slug'].limit-37)]
-              unique = prefix
-              while includer.slug_is(unique).count>0
-                unique = "#{prefix}-#{::SecureRandom.uuid}"
-              end
-              self.slug = unique
-            }, on: :create
-            # on update: re-generate the slug if the slug was assigned to empty.
-            # to_query:  escape characters
-          end
+    columns_hash.each do |column_name, hash|
 
-          columns_hash.each do |column_name, hash|
-
-            name = column_name.to_s
-
-            if ('code'==name||name.ends_with?('_code'))&&:string==columns_hash[name].type
-              class_eval do
-                if columns_hash[name].null
-                  validates name.to_sym, allow_blank: true, length: { maximum: columns_hash[name].limit }
-                  scope "#{name}_length_is".to_sym, ->(length) { where "LENGTH(#{name}) = :length", length: length }
-                elsif columns_hash[name].limit<=4
-                  validates name.to_sym, presence: true, length: { is: columns_hash[name].limit }
-                else
-                  validates name.to_sym, presence: true, length: { maximum: columns_hash[name].limit }
-                end
-                scope "#{name}d_as".to_sym,     ->(code) { where     name => code }
-                scope "not_#{name}d_as".to_sym, ->(code) { where.not name => code }
-                scope "#{name}_starting_with".to_sym, ->(prefix) { where "#{name} LIKE :prefix", prefix: "#{prefix}%" }
-                scope "#{name}_ending_with".to_sym,   ->(suffix) { where "#{name} LIKE :suffix", suffix: "%#{suffix}" }
-              end
-            end
-
-            if name.ends_with?('_at')&&:datetime==columns_hash[name].type
-              matched = /\A(.+)_at\z/.match name
-              class_eval do
-                scope :"#{matched[1]}_on",         ->(date)  { where name => date.beginning_of_day..date.end_of_day }
-                scope :"#{matched[1]}_during",     ->(range) { where name => range }
-                scope :"#{matched[1]}_before",     ->(time)  { where "#{table_name}.#{name} <  :time", time: time }
-                scope :"#{matched[1]}_not_after",  ->(time)  { where "#{table_name}.#{name} <= :time", time: time }
-                scope :"#{matched[1]}_after",      ->(time)  { where "#{table_name}.#{name} >  :time", time: time }
-                scope :"#{matched[1]}_not_before", ->(time)  { where "#{table_name}.#{name} >= :time", time: time }
-              end
-            end
-
-            if name.ends_with?('_state')&&:string==columns_hash[name].type
-              matched = /\A(.+)_state\z/.match name
-              class_eval do
-                scope :"#{matched[1]}_transited_to", ->(states) { where name => states }
-              end
-            end
+      name = column_name.to_s
 
+      if ('code'==name||name.ends_with?('_code'))&&:string==columns_hash[name].type
+        class_eval do
+          if columns_hash[name].null
+            validates name.to_sym, allow_blank: true, length: { maximum: columns_hash[name].limit }
+            scope "#{name}_length_is".to_sym, ->(length) { where "LENGTH(#{name}) = :length", length: length }
+          elsif columns_hash[name].limit<=4
+            validates name.to_sym, presence: true, length: { is: columns_hash[name].limit }
+          else
+            validates name.to_sym, presence: true, length: { maximum: columns_hash[name].limit }
           end
+          scope "#{name}d_as".to_sym,     ->(code) { where     name => code }
+          scope "not_#{name}d_as".to_sym, ->(code) { where.not name => code }
+          scope "#{name}_starting_with".to_sym, ->(prefix) { where "#{name} LIKE :prefix", prefix: "#{prefix}%" }
+          scope "#{name}_ending_with".to_sym,   ->(suffix) { where "#{name} LIKE :suffix", suffix: "%#{suffix}" }
+        end
+      end
 
-          includer.define_singleton_method :default_scope do
-            includer.all.order("#{includer.table_name}.ordinal ASC") if includer.columns_hash['ordinal'].present?
-            includer.all.order("#{includer.table_name}.created_at ASC")
-            #relation = base.all
-            #scopes.each do |s| relation = relation.send s.to_sym end
-            #relation
-          end
+      if name.ends_with?('_at')&&:datetime==columns_hash[name].type
+        matched = /\A(.+)_at\z/.match name
+        class_eval do
+          scope :"#{matched[1]}_on",         ->(date)  { where name => date.beginning_of_day..date.end_of_day }
+          scope :"#{matched[1]}_during",     ->(range) { where name => range }
+          scope :"#{matched[1]}_before",     ->(time)  { where "#{table_name}.#{name} <  :time", time: time }
+          scope :"#{matched[1]}_not_after",  ->(time)  { where "#{table_name}.#{name} <= :time", time: time }
+          scope :"#{matched[1]}_after",      ->(time)  { where "#{table_name}.#{name} >  :time", time: time }
+          scope :"#{matched[1]}_not_before", ->(time)  { where "#{table_name}.#{name} >= :time", time: time }
+        end
+      end
 
-          def soft_destroy
-            self.closed_at = Time.now
-            self.defunct = true
-            self.save
-          end
+      if name.ends_with?('_state')&&:string==columns_hash[name].type
+        matched = /\A(.+)_state\z/.match name
+        class_eval do
+          validates name.to_sym, presence: true, length: { is: columns_hash[name].limit }
+          scope :"#{matched[1]}_transited_to", ->(states) { where name => states }
+        end
+      end
 
-          def build_slug
-            if respond_to? :name
-              name
-            elsif respond_to? :title
-              title
-            else
-              ::SecureRandom.uuid
-            end
-          end
+    end
 
-        end
+    includer.define_singleton_method :default_scope do
+      includer.all.order("#{includer.table_name}.ordinal ASC") if includer.columns_hash['ordinal'].present?
+      includer.all.order("#{includer.table_name}.created_at ASC")
+      #relation = base.all
+      #scopes.each do |s| relation = relation.send s.to_sym end
+      #relation
+    end
 
-        module ClassMethods
+    def soft_destroy
+      self.closed_at = Time.now
+      self.defunct = true
+      self.save
+    end
 
-          def to_id(model)
-            model.respond_to?(:id) ? model.id : model
-          end
+    def build_slug
+      if respond_to? :name
+        name
+      elsif respond_to? :title
+        title
+      else
+        ::SecureRandom.uuid
+      end
+    end
 
-          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
+  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
+  module ClassMethods
 
-        end
+    def to_id(model)
+      model.respond_to?(:id) ? model.id : model
+    end
 
+    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
-end
+
+end

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

@@ -0,0 +1,29 @@
+module Unidom::Common::Concerns::Sha1Digester
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    def digest(message, pepper: nil)
+      self.class.digest message, pepper: pepper
+    end
+
+    def hex_digest(message, pepper: nil)
+      self.class.hex_digest message, pepper: pepper
+    end
+
+  end
+
+  module ClassMethods
+
+    def digest(message, pepper: nil)
+      message.present? ? Digest::SHA1.digest("#{message}_#{Rails.application.secrets[:secret_key_base]}_#{pepper}") : nil
+    end
+
+    def hex_digest(message, pepper: nil)
+      message.present? ? Unidom::Common::Numeration.hex(digest(message, pepper: pepper)) : nil
+    end
+
+  end
+
+end

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

@@ -0,0 +1,29 @@
+module Unidom::Common::Concerns::Sha2Digester
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    def digest(message, pepper: nil)
+      self.class.digest message, pepper: pepper
+    end
+
+    def hex_digest(message, pepper: nil)
+      self.class.hex_digest message, pepper: pepper
+    end
+
+  end
+
+  module ClassMethods
+
+    def digest(message, pepper: nil)
+      message.present? ? Digest::SHA2.digest("#{message}_#{Rails.application.secrets[:secret_key_base]}_#{pepper}") : nil
+    end
+
+    def hex_digest(message, pepper: nil)
+      message.present? ? Unidom::Common::Numeration.hex(digest(message, pepper: pepper)) : nil
+    end
+
+  end
+
+end

data/lib/unidom/common.rb

@@ -5,8 +5,8 @@ require 'unidom/common/numeration'
 module Unidom
   module Common
 
-    NULL_UUID = '00000000-0000-0000-0000-000000000000' #.freeze
-    SELF      = '~' #.freeze
+    NULL_UUID = '00000000-0000-0000-0000-000000000000'.freeze
+    SELF      = '~'.freeze
 
     #OPENED_AT = Time.utc(1970).freeze
     #CLOSED_AT = Time.utc(3000).freeze

data/lib/unidom/common/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Common
-    VERSION = '1.2'.freeze
+    VERSION = '1.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-common
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,7 +84,9 @@ files:
 - app/models/unidom/common/concerns/aes256_cryptor.rb
 - app/models/unidom/common/concerns/md5_digester.rb
 - app/models/unidom/common/concerns/model_extension.rb
+- app/models/unidom/common/concerns/sha1_digester.rb
 - app/models/unidom/common/concerns/sha256_digester.rb
+- app/models/unidom/common/concerns/sha2_digester.rb
 - app/models/unidom/common/concerns/sha384_digester.rb
 - app/models/unidom/common/concerns/sha512_digester.rb
 - app/views/layouts/unidom/common/application.html.erb