def_enum_helper 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6716d54dc234d894fe3c944da6eed2f95a333dcf
-  data.tar.gz: 97e542fc0a6594f65720686fd52f7a2ed9edc4c6
+SHA256:
+  metadata.gz: dc3f927c3dc00d6e938a46358c075ee1d5d2b6ac8f00462a5c7bf6db6a12d863
+  data.tar.gz: 3094efeafd6c868035c7ffd1d379580e3ad0347985316f08855ea73f7e589a33
 SHA512:
-  metadata.gz: bb0afcc78f37940a3c925177533b80b57f28499092bd0e3c2e2d75c13694f1454f2aab7be55bde68c002d6dabc80f60dab831b44eb071603567ecb0f624dc62f
-  data.tar.gz: da0bdcf1505507f3c5b62e3ad728c6308a647897ad4cc364baafe86034ee1087b27abfd7d37034b6fb059ab6e14b0fa5ec90d68f1af14a3781281dc63465057c
+  metadata.gz: 5c56039dd8d266490ab1e8192c69c463402e8948432fbf2ca6cd8f85f37737256719bd209ac404de33f199b5f92be9758cefb76744267ac0698b350a92add7bf
+  data.tar.gz: 2c7e9db0a796f3c0b27f7181a6490c2da13cd0bb3d6476ffd1db7abe7f053e61ceaa87946240d3c6018773b8eadd723379a99bff05c91dff2a23b8b23c9c6545

data/.gitignore

@@ -8,4 +8,5 @@
 /spec/reports/
 /tmp/
 *.gem
-.DS_Store
+.DS_Store
+rubocopresult

data/.rubocop.yml

@@ -0,0 +1,48 @@
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 50
+Metrics/ParameterLists:
+  Max: 12
+Metrics/AbcSize:
+  Max: 50
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
+Style/GuardClause:
+  MinBodyLength: 5
+Style/AsciiComments:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+Layout/DefEndAlignment:
+  AutoCorrect: true
+Layout/EndAlignment:
+  AutoCorrect: true
+Style/BracesAroundHashParameters:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/AutoResourceCleanup:
+  Enabled: true
+Style/CollectionMethods:
+  Enabled: true
+Style/Encoding:
+  Enabled: true
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+Style/OptionHash:
+  Enabled: true
+Style/StringMethods:
+  Enabled: true
+Style/SymbolArray:
+  Enabled: true
+Style/NonNilCheck:
+  IncludeSemanticChanges: true
+Style/Send:
+  Enabled: true

data/README.md

@@ -30,6 +30,7 @@ puts YinYang::YIN   	# 2
 y = YinYang[1]
 puts y.index        	# 1
 puts y.display      	# 阳
+puts y.symbol           # :YANG
 YinYang[:YANG]   		# same as YinYang[1]
 YinYang["阳"]    		# same as YinYang[1]
 YinYang.all         	# 所有枚举的struct array [#<struct index=1, display="阳">, # <struct index=2, display="阴">]
@@ -37,7 +38,14 @@ puts YinYang.count  	# 2
 YinYang.each{|x| puts x}  # <struct index=1, display="阳"> #<struct index=2, display="阴">
 YinYang.map{|x| x}        # [#<struct  index=1, display="阳">, #<struct  index=2, display="阴">]
 puts YinYang.to_hash_array # [{:index=>1, :display=>"阳"}, {:index=>2, :display=>"阴"}]
-puts YingYang.to_json_array  # [{"index":1,"display":"阳"},{"index":2,"display":"阴"}]
+puts YinYang.to_json_array  # [{"index":1,"display":"阳"},{"index":2,"display":"阴"}]
+puts YinYang.keys           # [:YANG, :YIN]
+puts YinYang.indexes        # [1, 2]
+```
+
+```ruby
+# 自定义字段名
+def_enum :YinYang, {YANG: "阳", YIN: "阴"}, symbol_name: :s, index_name: :i, display_name: :d
 ```
 
 ```ruby
@@ -49,7 +57,17 @@ def_enum_with_index(:DataOperationType,
                     [:DELETE, 5, '删除'])
 
 puts DataOperationType::INSERT	# 3
+```
 
+```ruby
+# 自定义字段名
+def_enum_with_index(:DataOperationType,
+                    [:INSERT, 3, '插入'],
+                    [:UPDATE, 4, '修改'],
+                    [:DELETE, 5, '删除'],
+                    symbol_name: :s,
+                    index_name: :i,
+                    display_name: :d)
 ```
 
 ```ruby
@@ -63,7 +81,6 @@ def_enum_struct_with_index(:Country,
                          })
 
 Country[:CHINA]			# <struct CustomStruct index=1, display="中华人民共和国", short_name="中国">
-
 ```
 
 ### License

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "def_enum_helper"
+require 'bundler/setup'
+require 'def_enum_helper'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "def_enum_helper"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/check_code.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+rubocop -a -D -f simple -o rubocopresult

data/def_enum_helper.gemspec

@@ -1,24 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'def_enum_helper/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "def_enum_helper"
+  spec.name          = 'def_enum_helper'
   spec.version       = DefEnumHelper::VERSION
-  spec.authors       = ["Charles Zhang"]
-  spec.email         = ["gis05zc@163.com"]
+  spec.authors       = ['Charles Zhang']
+  spec.email         = ['gis05zc@163.com']
 
-  spec.summary       = %q{define very powerful enum class}
-  spec.homepage      = "https://github.com/chinazhangchao/def_enum_helper"
+  spec.summary       = 'Define very powerful enum class.'
+  spec.description   = 'A tool help to define very powerful ruby enum class.'
+  spec.homepage      = 'https://github.com/chinazhangchao/def_enum_helper'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/def_enum_helper/version.rb

@@ -1,3 +1,3 @@
 module DefEnumHelper
-  VERSION = "1.0.0"
+  VERSION = '1.0.1'.freeze
 end

data/lib/def_enum_helper.rb

@@ -1,4 +1,4 @@
-require "def_enum_helper/version"
+require 'def_enum_helper/version'
 
 # Usage
 
@@ -11,6 +11,7 @@ require "def_enum_helper/version"
 # y = YinYang[1]
 # puts y.index          # 1
 # puts y.display        # 阳
+# puts y.symbol           # :YANG
 # YinYang[:YANG]      # same as YinYang[1]
 # YinYang["阳"]        # same as YinYang[1]
 # YinYang.all           # 所有枚举的struct array [#<struct index=1, display="阳">, # <struct index=2, display="阴">]
@@ -18,7 +19,11 @@ require "def_enum_helper/version"
 # YinYang.each{|x| puts x}  # <struct index=1, display="阳"> #<struct index=2, display="阴">
 # YinYang.map{|x| x}        # [#<struct  index=1, display="阳">, #<struct  index=2, display="阴">]
 # puts YinYang.to_hash_array # [{:index=>1, :display=>"阳"}, {:index=>2, :display=>"阴"}]
-# puts YingYang.to_json_array  # [{"index":1,"display":"阳"},{"index":2,"display":"阴"}]
+# puts YinYang.to_json_array  # [{"index":1,"display":"阳"},{"index":2,"display":"阴"}]
+# puts YinYang.keys           # [:YANG, :YIN]
+# puts YinYang.indexes        # [1, 2]
+
+# def_enum :YinYang, {YANG: "阳", YIN: "阴"}, symbol_name: :s, index_name: :i, display_name: :d
 
 # # 自定义枚举整数值
 
@@ -29,6 +34,14 @@ require "def_enum_helper/version"
 
 # puts DataOperationType::INSERT  # 3
 
+# def_enum_with_index(:DataOperationType,
+#                     [:INSERT, 3, '插入'],
+#                     [:UPDATE, 4, '修改'],
+#                     [:DELETE, 5, '删除'],
+#                     symbol_name: :s,
+#                     index_name: :i,
+#                     display_name: :d)
+
 # # 自定义枚举对象
 # CustomStruct = Struct.new(:index, :display, :short_name)
 
@@ -42,16 +55,20 @@ require "def_enum_helper/version"
 
 DEFAULT_ENUM_BASE_INDEX = 1
 
-def def_enum(module_name, enum_hash, enum_base: DEFAULT_ENUM_BASE_INDEX, index_name: :index, display_name: :display)
-  temp_struct = Struct.new(index_name, display_name)
+def def_enum(module_name, enum_hash, enum_base: DEFAULT_ENUM_BASE_INDEX,
+             symbol_name: :symbol, index_name: :index, display_name: :display)
+  temp_struct = Struct.new(symbol_name, index_name, display_name)
   new_enum_hash = {}
   enum_hash.each do |k, v|
-    new_enum_hash[k] = temp_struct.new(0, v)
+    new_enum_hash[k] = temp_struct.new(k, 0, v)
   end
-  def_enum_struct(module_name, new_enum_hash, enum_base: enum_base)
+  def_enum_struct(module_name, new_enum_hash,
+                  enum_base: enum_base, symbol_name: symbol_name,
+                  index_name: index_name, display_name: display_name)
 end
 
-def def_enum_struct(module_name, enum_hash, enum_base: DEFAULT_ENUM_BASE_INDEX, index_name: :index, display_name: :display)
+def def_enum_struct(module_name, enum_hash, enum_base: DEFAULT_ENUM_BASE_INDEX,
+                    symbol_name: :symbol, index_name: :index, display_name: :display)
   i = 0
   set_index = (index_name.to_s + '=').to_sym
   enum_hash.each do |_k, v|
@@ -60,18 +77,21 @@ def def_enum_struct(module_name, enum_hash, enum_base: DEFAULT_ENUM_BASE_INDEX,
     i += 1
   end
 
-  def_enum_struct_with_index(module_name, enum_hash, index_name: index_name, display_name: display_name)
+  def_enum_struct_with_index(module_name, enum_hash,
+                             symbol_name: symbol_name, index_name: index_name,
+                             display_name: display_name)
 end
 
-EnumHelperStruct = Struct.new(:index, :display)
-
-def def_enum_with_index(module_name, *value_array)
+def def_enum_with_index(module_name, *value_array,
+                        symbol_name: :symbol, index_name: :index, display_name: :display)
   h = {}
+  temp_struct = Struct.new(symbol_name, index_name, display_name)
   value_array.each do |variable|
-    h[variable[0]] = EnumHelperStruct.new(variable[1], variable[2])
+    h[variable[0]] = temp_struct.new(variable[0], variable[1], variable[2])
   end
 
-  def_enum_struct_with_index module_name, h
+  def_enum_struct_with_index(module_name, h, symbol_name: symbol_name,
+                                             index_name: index_name, display_name: display_name)
 end
 
 def define_iterator_methods(m, enum_index_hash)
@@ -79,23 +99,24 @@ def define_iterator_methods(m, enum_index_hash)
   m.define_singleton_method(:map) { |&blk| enum_index_hash.values.map { |v| blk.call(v) } }
 
   m.define_singleton_method(:all) { enum_index_hash.values }
-  m.define_singleton_method(:keys) { enum_index_hash.keys }
+  m.define_singleton_method(:keys) { m.constants }
+  m.define_singleton_method(:indexes) { enum_index_hash.keys }
 end
 
 def define_subscript_method(m, enum_index_hash, enum_display_hash)
   divisor = enum_index_hash.count
 
-  # m.define_singleton_method(:from_number) { |n| (n - DEFAULT_ENUM_BASE_INDEX) % divisor + DEFAULT_ENUM_BASE_INDEX }
   m.define_singleton_method(:[]) do |k|
     case k
     when String
       enum_display_hash[k]
     when Symbol
-      index = if self.is_a?(Module)
-        const_get(k)
-      else
-        Kernel.const_get(k)
-      end
+      index =
+        if is_a?(Module)
+          const_get(k)
+        else
+          Kernel.const_get(k)
+        end
       enum_index_hash[index]
     else
       enum_index_hash[k]
@@ -123,12 +144,15 @@ def define_enum_methods(m, enum_index_hash, enum_display_hash)
   define_subscript_method(m, enum_index_hash, enum_display_hash)
 end
 
-def def_enum_struct_with_index(module_name, enum_hash, index_name: :index, display_name: :display)
+def def_enum_struct_with_index(module_name, enum_hash, symbol_name: :symbol,
+                               index_name: :index, display_name: :display)
   m = Module.new
   enum_index_hash = {}
   enum_display_hash = {}
   i = 0
   enum_hash.each do |k, v|
+    v.define_singleton_method(symbol_name) { k } unless v.respond_to?(symbol_name)
+
     enum_value = v.public_send(index_name)
     m.const_set(k, enum_value)
     enum_index_hash[enum_value] = v
@@ -138,7 +162,7 @@ def def_enum_struct_with_index(module_name, enum_hash, index_name: :index, displ
 
   define_enum_methods(m, enum_index_hash, enum_display_hash)
 
-  if self.is_a?(Module)
+  if is_a?(Module)
     const_set(module_name, m)
   else
     Kernel.const_set(module_name, m)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: def_enum_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Charles Zhang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-30 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: 
+description: A tool help to define very powerful ruby enum class.
 email:
 - gis05zc@163.com
 executables: []
@@ -46,16 +46,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- check_code.sh
 - def_enum_helper.gemspec
 - lib/def_enum_helper.rb
 - lib/def_enum_helper/version.rb
 homepage: https://github.com/chinazhangchao/def_enum_helper
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -73,8 +76,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: define very powerful enum class
+summary: Define very powerful enum class.
 test_files: []