progne_tapera 0.5 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c2a069aea2e81297eeac4d046451dbc3f94601c
-  data.tar.gz: b71391edfc0e159fbe3897b26181cf8db8042aa5
+  metadata.gz: 1b75c6db277e6d4dc91e00f4ec698c406dfedecf
+  data.tar.gz: cea58d461a2471da8240fb568c70d26e07cb5360
 SHA512:
-  metadata.gz: 6304fa68a8688b52add3af79d93912a5d0db3af98f15c12a0f6dff3408f4b63d21dcbb787ca72b882c344f0030cf43c1bf2c3b44a817a5b9832905475c670506
-  data.tar.gz: f0b24325729107a134e6994ca57196f9f18d2e657938b44ad10f2b54be30dad1435b21423c91366dcd859f885b57625cec8ba4793a307987213e30e384a5cb0b
+  metadata.gz: 6ed8152f257cba6d28b8160e38161f332dc5a561d2ec67963c2263480624008d9d5a9c3e096e0e05e4342834034c6e527fa289c2d8fe58cf3ff34b9ea33af07a
+  data.tar.gz: 125805f2dd69b3f4867be5500ccd73535eec0a05b17e1df5bd3fe80048c3a4a3d6eab645808eb9179e68f0ea8aa6ce36d219ed85576082109801eeac4a67fe2f

data/CHANGELOG.md

@@ -19,4 +19,7 @@
 1. Improved the Enum List concern to add the .``lookup`` method
 
 ## v0.5
-1. Improve the Enum Code concern to be able to be extended by lambda
+1. Improved the Enum Config concern to be able to be extended by lambda
+
+## v0.5.1
+1. Improve the Enum config concern for the Item Methods module

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    progne_tapera (0.4)
+    progne_tapera (0.5)
       rails (>= 4.2)
 
 GEM
@@ -61,7 +61,7 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
-    minitest (5.9.1)
+    minitest (5.10.1)
     nio4r (1.2.1)
     nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
@@ -112,7 +112,7 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.19.1)
+    thor (0.19.4)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)

data/README.md

@@ -1,6 +1,8 @@
 # Progne Tapera
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/progne_tapera/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/progne_tapera.svg)](https://badge.fury.io/rb/progne_tapera)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/progne_tapera.svg)](https://gemnasium.com/github.com/topbitdu/progne_tapera)
 
@@ -97,21 +99,28 @@ app/types/ethnicity.rb
 ```ruby
 class Ethnicity < ActiveRecord::Type::Value
 
-  include ProgneTapera::EnumConfig
+  # The Item Methods module must be defined before the ``enum :china_ethnicity`` code block, so it could be called there.
+  module ItemMethods
 
-  enum :china_ethnicity
-  # 用 :china_ethnicity 指定的 i18n 资源。
+    extend ActiveSupport::Concern
 
-  module ItemMethods
+    included do |includer|
+
+      def major?
+        'HA'==code
+      end
+      # Ethnicity::HAN.major? returns true
+      # Ethnicity::MONGEL.major? returns false
 
-    def major?
-      'HA'==code
     end
-    # Ethnicity::HAN.major? returns true
-    # Ethnicity::MONGEL.major? returns false
 
   end
 
+  include ProgneTapera::EnumConfig
+
+  enum :china_ethnicity
+  # 用 :china_ethnicity 指定的 i18n 资源。
+
 end
 ```
 
@@ -169,19 +178,19 @@ include ProgneTapera::EnumCode
 
 ### Enum List concern
 
-The Enum List concern do the following tasks for the includer automatically:  
-1. Include the Enumerable module  
-2. Define the .enum_name method as: ``enum_name(name = nil)``  
-3. Define the .item_defined? method as: ``item_defined?(item)``  
-4. Define the .add_item method as: ``add_item(item)``  
-5. Define the .safe_add_item method as: ``safe_add_item(item)``  
-6. Define the .enum_constants method as: ``enum_constants``  
-7. Define the .all method as: ``all``  
-8. Define the .selected method as: ``selected(&block)``  
-9. Define the .each method as: ``each(&block)``  
+The Enum List concern do the following tasks for the includer automatically:
+1. Include the Enumerable module
+2. Define the .enum_name method as: ``enum_name(name = nil)``
+3. Define the .item_defined? method as: ``item_defined?(item)``
+4. Define the .add_item method as: ``add_item(item)``
+5. Define the .safe_add_item method as: ``safe_add_item(item)``
+6. Define the .enum_constants method as: ``enum_constants``
+7. Define the .all method as: ``all``
+8. Define the .selected method as: ``selected(&block)``
+9. Define the .each method as: ``each(&block)``
 10. Define the .lookup method as: ``lookup(code)``
-11. Define the .form_options method as: ``form_options(&block)``  
-12. Define the .deserialize method as: ``deserialize(value)``  
+11. Define the .form_options method as: ``form_options(&block)``
+12. Define the .deserialize method as: ``deserialize(value)``
 13. Define the .serialize method as: ``serialize(value)``
 
 ```ruby
@@ -194,8 +203,8 @@ Gender.form_options        # { '男' => '1', '女' => '2', '未指定' => '9' }
 
 ### Enum Config concern
 
-The Enum Config concern do the following tasks for the includer automatically:  
-1. Include the Enum List concern  
+The Enum Config concern do the following tasks for the includer automatically:
+1. Include the Enum List concern
 2. Define the .enum method as: ``enum(name = nil, localized_name = name, &block)``
 3. Define the .overload_enum_i18n method as: ``overload_enum_i18n(localized_name = nil)``
 
@@ -239,7 +248,7 @@ Ethnicity::YI.localized_name   # '彝'
 
 ### Enum Code concern
 
-The Enum Code concern do the following tasks for the includer automatically:  
+The Enum Code concern do the following tasks for the includer automatically:
 1. Define the .code method as: ``code(field, enum)``
 
 

data/ROADMAP.md

@@ -20,3 +20,9 @@
 
 ## v0.5
 1. Improve the Enum Code concern to be able to be extended by lambda
+
+## v0.5.1
+1. Improve the Enum config concern for the Item Methods module
+
+## v0.6
+1. Improve the Enum Config concern to make the enum items be able to be updated or destroyable through the #enum method

data/lib/progne_tapera/enum_code.rb

@@ -1,3 +1,6 @@
+##
+# Enum Code 是在模型层配置知识层枚举的关注点，提供 .code 宏方法。
+
 module ProgneTapera::EnumCode
 
   extend ActiveSupport::Concern
@@ -7,6 +10,11 @@ module ProgneTapera::EnumCode
 
   module ClassMethods
 
+    ##
+    # 为关注的类提供以下逻辑：
+    # 1. 验证 ``field``_code 字段的值，是否在枚举类型的定义中。
+    # 2. 定义 ``field`` 方法，用于获取枚举型的值。
+    # 3. 定义 ``field``= 方法，用于为枚举型字段赋值。
     def code(field, enum)
       code_field_name = :"#{field}_code"
       validates code_field_name, inclusion: enum.all.map { |item| item.code }

data/lib/progne_tapera/enum_config.rb

@@ -1,3 +1,6 @@
+##
+# Enum Config 是知识层枚举类型的配置关注点。提供 .enum 和 .overload_enum_i18n 方法。
+
 module ProgneTapera::EnumConfig
 
   extend  ActiveSupport::Concern
@@ -14,6 +17,7 @@ module ProgneTapera::EnumConfig
 
         yield.each do |key, value|
           options = value.map { |k, v| [ k.to_sym, v ] }.to_h
+          #options[:optional] = true if options[:optional].nil?
           code    = options.delete :code
           safe_add_item ProgneTapera::EnumItem.new(code, key.to_s, options)
         end
@@ -26,9 +30,15 @@ module ProgneTapera::EnumConfig
 
         enumerations.each do |key, value|
           options = value.map { |k, v| [ k.to_sym, v ] }.to_h
+          #options[:optional] = false
           code    = options.delete :code
           options[:localized_name] = I18n.t "enum.#{localized_name||name}.#{key}"
-          safe_add_item ProgneTapera::EnumItem.new(code, key, options)
+          item = ProgneTapera::EnumItem.new code, key, options
+          class << item
+            item_method_module = "#{self.name}::ItemMethods".safe_constantize
+            include item_method_module if item_method_module.present?
+          end
+          safe_add_item item
         end
 
       end

data/lib/progne_tapera/enum_item.rb

@@ -1,5 +1,9 @@
 require 'rails'
 
+##
+# Enum Item 是枚举项。
+# enum_item = ProgneTapera::EnumItem.new '1', 'male', { localized_name: '男' }
+
 class ProgneTapera::EnumItem
 
   attr_reader :code, :name, :options

data/lib/progne_tapera/enum_list.rb

@@ -1,4 +1,5 @@
-require 'rails'
+##
+# Enum List 是知识层枚举列表的领域逻辑关注点。
 
 module ProgneTapera::EnumList
 
@@ -26,9 +27,6 @@ module ProgneTapera::EnumList
       raise ArgumentError.new "The #{item.inspect} item should be an instance of ProgneTapera::EnumItem." unless item.is_a?    ProgneTapera::EnumItem
       raise ArgumentError.new "The #{item.constant_name} enum item was defined already."                  if     item_defined? item
 
-      item_methods_module = "#{self.name}::ItemMethods".safe_constantize
-      item.class.include item_methods_module if item_methods_module.present?
-
       const_set item.constant_name, item
     end
 
@@ -36,6 +34,11 @@ module ProgneTapera::EnumList
       const_set item.constant_name, item if item.is_a?(ProgneTapera::EnumItem)&&!item_defined?(item)
     end
 
+    # Destroy or Update the Enum Items
+    #def clear_optional_items
+      #
+    #end
+
     # Infrastructure for the Enumerable
     def enum_constants
       constants.select { |constant|

data/lib/progne_tapera/version.rb

@@ -1,3 +1,3 @@
 module ProgneTapera
-  VERSION = '0.5'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progne_tapera
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: 0.5.1
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails