progne_tapera 0.5.2 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f20bbffd40c23bd5976b19f8fc18ec3f8cae4136
-  data.tar.gz: 7b40a0025a790f752ba33ca1bef881ece2097e87
+SHA256:
+  metadata.gz: 8d10a2c3b33b51e33b9a5b4c10c515c1906f44b93363618e1c40e8f8287f4ca4
+  data.tar.gz: c55437dc658e85ab1926186d358c3a7939a44a176c334baed4f96be14a3b01a1
 SHA512:
-  metadata.gz: 2d532bae2f9263f10a6eebfe7c52435be88d510ead89d470286e2d612a0a238d83816c85db171ffc1bb7c847302047146924e9fba4ebfcb86b93729e206f0e14
-  data.tar.gz: 249e257751bcc5fb4f703f395072b5cd436623ae54a356ed9a6c09354083d2c759ef9e6be9c7463b6337aae464aa085ddbf5cf06b2f865cb16acf9ef9f8cd1aa
+  metadata.gz: 5b723d945d8ef7480ceadab714a395bc745b4c94c2d08d6eab6937815e8c37fa0bf9251869329c01539a7bf9be0bc7e857106f49e86928b7d385ac83294cb3cc
+  data.tar.gz: 0e7c5d705548d63ea6e8dec96f345c31c074b4099b37fd68296a3c598f76e931200fdf2cc280e934175501a94a925cc26c7c0ca21c35d5ceb1b09edd32a0a75b

data/CHANGELOG.md

@@ -1,28 +1,40 @@
 # Progne Tapera Change Log 枚举库变更日志
 
 ## v0.1
+
 1. Enum Item class
 2. Enum List concern
 3. Enum Config concern
 4. Enum Code concern
 
 ## v0.1.1
+
 1. Improved the Ruby Gem Specification to depend on [rails](https://github.com/rails/rails) v4.2
 
 ## v0.2
+
 1. Improved the Enum Config concern to support the customized enum i18n name
 
 ## v0.3
+
 1. Improved the Enum Config concern to support the overloaded enum i18n name
 
 ## v0.4
+
 1. Improved the Enum List concern to add the .``lookup`` method
 
 ## v0.5
+
 1. Improved the Enum Config concern to be able to be extended by lambda
 
 ## v0.5.1
+
 1. Improved the Enum config concern for the Item Methods module
 
 ## v0.5.2
-1. Improve the Enum Config concern for the Item Methods module
+
+1. Improved the Enum Config concern for the Item Methods module
+
+## v1.0
+
+1. Improved the Ruby Gem Specification to depend on [rails](https://github.com/rails/rails) v6.0, bundler v2.0, rake v13.0, & rspec v3.9

data/Gemfile.lock

@@ -2,132 +2,157 @@ PATH
   remote: .
   specs:
     progne_tapera (0.5.2)
-      rails (>= 4.2)
+      rails (~> 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.0.1)
-      actionpack (= 5.0.1)
-      nio4r (~> 1.2)
-      websocket-driver (~> 0.6.1)
-    actionmailer (5.0.1)
-      actionpack (= 5.0.1)
-      actionview (= 5.0.1)
-      activejob (= 5.0.1)
+    actioncable (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.1)
-      actionview (= 5.0.1)
-      activesupport (= 5.0.1)
-      rack (~> 2.0)
-      rack-test (~> 0.6.3)
+    actionpack (6.0.2.2)
+      actionview (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.1)
-      activesupport (= 5.0.1)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.2)
+      activesupport (= 6.0.2.2)
       builder (~> 3.1)
-      erubis (~> 2.7.0)
+      erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (5.0.1)
-      activesupport (= 5.0.1)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.2)
+      activesupport (= 6.0.2.2)
       globalid (>= 0.3.6)
-    activemodel (5.0.1)
-      activesupport (= 5.0.1)
-    activerecord (5.0.1)
-      activemodel (= 5.0.1)
-      activesupport (= 5.0.1)
-      arel (~> 7.0)
-    activesupport (5.0.1)
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activestorage (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.4)
-    builder (3.2.3)
-    concurrent-ruby (1.0.4)
+      zeitwerk (~> 2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
     diff-lcs (1.3)
-    erubis (2.7.0)
-    globalid (0.3.7)
-      activesupport (>= 4.1.0)
-    i18n (0.8.0)
-    loofah (2.0.3)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.5.0)
+      crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.6.4)
-      mime-types (>= 1.16, < 4)
-    method_source (0.8.2)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
-    minitest (5.10.1)
-    nio4r (1.2.1)
-    nokogiri (1.7.0.1)
-      mini_portile2 (~> 2.1.0)
-    rack (2.0.1)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (5.0.1)
-      actioncable (= 5.0.1)
-      actionmailer (= 5.0.1)
-      actionpack (= 5.0.1)
-      actionview (= 5.0.1)
-      activejob (= 5.0.1)
-      activemodel (= 5.0.1)
-      activerecord (= 5.0.1)
-      activesupport (= 5.0.1)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 5.0.1)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.2)
+      actioncable (= 6.0.2.2)
+      actionmailbox (= 6.0.2.2)
+      actionmailer (= 6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actiontext (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2.2)
       sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.2)
-      activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.0.1)
-      actionpack (= 5.0.1)
-      activesupport (= 5.0.1)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (11.3.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    sprockets (3.7.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.0)
+    sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.19.4)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    websocket-driver (0.6.5)
+    websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.2)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.12)
+  bundler (~> 2.0)
   progne_tapera!
-  rake (~> 11.3)
-  rspec (~> 3.5)
+  rake (~> 13.0)
+  rspec (~> 3.9)
 
 BUNDLED WITH
-   1.13.6
+   2.1.4

data/ROADMAP.md

@@ -1,31 +1,44 @@
 # Progne Tapera Road Map 枚举库线路图
 
 ## v0.1
+
 1. Enum Item class
 2. Enum List concern
 3. Enum Config concern
 4. Enum Code concern
 
 ## v0.1.1
+
 1. Improve the Ruby Gem Specification to depend on [rails](https://github.com/rails/rails) v4.2
 
 ## v0.2
+
 1. Improve the Enum Config concern to support the customized enum i18n name
 
 ## v0.3
+
 1. Improve the Enum Config concern to support the overloaded enum i18n name
 
 ## v0.4
+
 1. Improve 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
 
 ## v0.5.1
+
 1. Improve the Enum config concern for the Item Methods module
 
 ## v0.5.2
+
 1. Improve the Enum Config concern for the Item Methods module
 
-## v0.6
+## v1.0
+
+1. Improve the Ruby Gem Specification to depend on [rails](https://github.com/rails/rails) v6.0, bundler v2.0, rake v13.0, & rspec v3.9
+
+## v1.1
+
 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_config.rb

@@ -11,6 +11,13 @@ module ProgneTapera::EnumConfig
 
   module ClassMethods
 
+    ##
+    # 为枚举类型提供 .enum 方法。如：
+    # enum :gender
+    # # 或
+    # enum :gender, :localized_gender
+    # 第一个参数是枚举类型在配置文件中存储的枚举项的 key 。
+    # 第二个参数是枚举类型在国际化配置文件中存储的枚举项文本的 key 。如果不提供第二个参数，则自动使用第一个参数进行查找。
     def enum(name = nil, localized_name = name)
 
       if block_given?
@@ -50,6 +57,9 @@ module ProgneTapera::EnumConfig
 
     end
 
+    ##
+    # 为枚举类型提供 .overload_enum_i18n 方法。如：
+    # overload_enum_i18n :your_gender_i18n_key
     def overload_enum_i18n(localized_name = nil)
 
       each do |enum_item|

data/lib/progne_tapera/enum_item.rb

@@ -8,6 +8,7 @@ class ProgneTapera::EnumItem
 
   attr_reader :code, :name, :options
 
+  ##
   # code = HA (value)
   # name = han
   # options = { localized_name: '汉' }
@@ -31,10 +32,14 @@ class ProgneTapera::EnumItem
 
   end
 
+  ##
+  # 判断两个枚举项的 #code 字段是否相等。
   def ==(that)
     self.code==that.code
   end
 
+  ##
+  # 根据 #code 字段的值，比较大小。
   def <=>(that)
     self.code<=>that.code
   end

data/lib/progne_tapera/enum_list.rb

@@ -13,12 +13,22 @@ module ProgneTapera::EnumList
     include Enumerable
 
     # Define the Enum type
+
+    ##
+    # 向枚举类型提供枚举的配置名。如果不提供配置名则根据枚举类型的名称自动猜测。如：
+    # eumu_name
+    # # 或
+    # enum_name :gender
     def enum_name(name = nil)
       return @enum_name if @enum_name.present?
       @enum_name = (name||self.name.demodulize.underscore).to_sym
     end
 
     # Define the Enum Items
+
+    ##
+    # 判断指定的枚举项是否已经定义。如：
+    # item_defined? male
     def item_defined?(item)
       const_defined? item.constant_name
     end
@@ -30,6 +40,11 @@ module ProgneTapera::EnumList
       const_set item.constant_name, item
     end
 
+    ##
+    # 以安全的方式向一个枚举列表中添加一个枚举项。如果该枚举项已经在枚举列表中，则不添加。如：
+    # Gender.safe_add_item male
+    # Gender.safe_add_item female
+    # Gender.safe_add_item male   # male won't be added twice.
     def safe_add_item(item)
       const_set item.constant_name, item if item.is_a?(ProgneTapera::EnumItem)&&!item_defined?(item)
     end
@@ -47,6 +62,9 @@ module ProgneTapera::EnumList
       }
     end
 
+    ##
+    # 列出所有的枚举型。如：
+    # Gender.all
     def all
       enum_constants.map { |constant| const_get constant }
     end

data/lib/progne_tapera/version.rb

@@ -1,3 +1,3 @@
 module ProgneTapera
-  VERSION = '0.5.2'
+  VERSION = '1.0'
 end

data/progne_tapera.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = [ 'lib' ]
 
-  spec.add_dependency 'rails', '>= 4.2'
+  spec.add_dependency 'rails', '~> 6.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake',    '~> 11.3'
-  spec.add_development_dependency 'rspec',   '~> 3.5'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake',    '~> 13.0'
+  spec.add_development_dependency 'rspec',   '~> 3.9'
 
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: progne_tapera
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: '1.0'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-20 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.9'
 description: Progne Tapera is a Rails-based configurable enumeration implementation.
   Progne Tapera is the Brown-chested Martin in Latin. Progne Tapera 是基于 Rails 的可配置的枚举实现。Progne
   Tapera 是棕胸崖燕的拉丁学名。
@@ -113,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Rails-based configurable enumeration 基于 Rails 的可配置的枚举