def_enum_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 590ddea64979d3f00a57ed5bf26f468377ca13c7
+  data.tar.gz: a362fd79ea34dbe0f1e0ff72190637acf44a7988
+SHA512:
+  metadata.gz: b9c5c97a0201046f5bcb2e08eff89a21dc2ad9fd202d3e46cfa3d234497ca3e24fc88ab0135dba49db08fb3a8f14856c40263f2d404fb3bb6c2ab0a8bd14202d
+  data.tar.gz: 04aeb46bad251b7ef006b1fd1ac9b5ca5501110e8c6dc0b93d24e24cc7f8767008322aa50c1112d167164850884c3c62423ab5a70aa6435fef3e0fe214a94581

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in def_enum_helper.gemspec
+gemspec

data/README.md

@@ -0,0 +1,70 @@
+# DefEnumHelper
+
+Define very powerful enum class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'def_enum_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install def_enum_helper
+
+## Usage
+
+```ruby
+# 默认枚举从1开始递增
+
+def_enum :YinYang, {YANG: "阳", YIN: "阴"}
+
+puts YinYang::YANG  	# 1
+puts YinYang::YIN   	# 2
+y = YinYang[1]
+puts y.index        	# 1
+puts y.display      	# 阳
+YinYang[:YANG]   		# same as YinYang[1]
+YinYang["阳"]    		# same as YinYang[1]
+YinYang.all         	# 所有枚举的struct array [#<struct index=1, display="阳">, # <struct index=2, display="阴">]
+puts YinYang.count  	# 2
+YinYang.each{|x| puts 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":"阴"}]
+```
+
+```ruby
+# 自定义枚举整数值
+
+def_enum_with_index(:DataOperationType,
+                    [:INSERT, 3, '插入'],
+                    [:UPDATE, 4, '修改'],
+                    [:DELETE, 5, '删除'])
+
+puts DataOperationType::INSERT	# 3
+
+```
+
+```ruby
+# 自定义枚举对象
+CustomStruct = Struct.new(:index, :display, :short_name)
+
+def_enum_struct_with_index(:Country,
+                           {
+                             CHINA: CustomStruct.new(1, '中华人民共和国', '中国'),
+                             USA: CustomStruct.new(2, '美利坚合众国', '美国')
+                         })
+
+Country[:CHINA]			# <struct CustomStruct index=1, display="中华人民共和国", short_name="中国">
+
+```
+
+### License
+
+(MIT License) - Copyright (c) 2016 Charles Zhang

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/def_enum_helper.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.version       = DefEnumHelper::VERSION
+  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.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.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/def_enum_helper/version.rb

@@ -0,0 +1,3 @@
+module DefEnumHelper
+  VERSION = "0.1.0"
+end

data/lib/def_enum_helper.rb

@@ -0,0 +1,111 @@
+require "def_enum_helper/version"
+
+# example
+
+# def_enum :YinYang, {YANG: "阳", YIN: "阴"}
+
+# puts YinYang::YANG   #1
+# puts YinYang::YIN    #2
+# y = YinYang[1]
+# puts y.index          #1
+# puts y.display        #阳
+# puts YinYang[:YANG]   #same as YinYang[1]
+# puts YinYang["阳"]    #same as YinYang[1]
+# YinYang.all           #所有枚举的struct array [#<struct index=1, display="阳">, #<struct index=2, display="阴">]
+# puts YinYang.count    #2
+# YinYang.each{|x| puts x}  #<struct index=1, display="阳"> #<struct index=2, display="阴">
+# puts YingYang.to_json_array  #[{"index":1,"display":"阳"},{"index":2,"display":"阴"}]
+
+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)
+  new_enum_hash = {}
+  enum_hash.each do |k, v|
+    new_enum_hash[k] = temp_struct.new(0, v)
+  end
+  def_enum_struct(module_name, new_enum_hash, enum_base: enum_base)
+end
+
+def def_enum_struct(module_name, enum_hash, enum_base: DEFAULT_ENUM_BASE_INDEX, index_name: :index, display_name: :display)
+  i = 0
+  set_index = (index_name.to_s + '=').to_sym
+  enum_hash.each do |_k, v|
+    enum_value = enum_base + i
+    v.public_send(set_index, enum_value)
+    i += 1
+  end
+
+  def_enum_struct_with_index(module_name, enum_hash, index_name: index_name, display_name: display_name)
+end
+
+EnumHelperStruct = Struct.new(:index, :display)
+
+def def_enum_with_index(module_name, *value_array)
+  h = {}
+  value_array.each do |variable|
+    h[variable[0]] = EnumHelperStruct.new(variable[1], variable[2])
+  end
+
+  def_enum_struct_with_index module_name, h
+end
+
+def define_iterator_methods(m, enum_index_hash)
+  m.define_singleton_method(:each) { |&blk| enum_index_hash.each_value { |v| blk.call(v) } }
+
+  m.define_singleton_method(:all) { enum_index_hash.values }
+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
+      enum_index_hash[const_get(k)]
+    else
+      enum_index_hash[from_number(k)]
+    end
+  end
+end
+
+def define_convert_methods(m, enum_index_hash)
+  m.define_singleton_method(:to_hash_array) { enum_index_hash.each_value.map(&:to_h) }
+
+  m.define_singleton_method(:to_json_array) { to_hash_array.to_json }
+end
+
+def define_enum_methods(m, enum_index_hash, enum_display_hash)
+  define_iterator_methods(m, enum_index_hash)
+
+  m.define_singleton_method(:include?) { |n| n.is_a?(Symbol) ? constants.include?(n) : enum_index_hash.key?(n) }
+
+  m.define_singleton_method(:member?) { |n| include?(n) }
+
+  m.define_singleton_method(:count) { enum_index_hash.count }
+
+  define_convert_methods(m, enum_index_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)
+  m = Module.new
+  enum_index_hash = {}
+  enum_display_hash = {}
+  i = 0
+  enum_hash.each do |k, v|
+    enum_value = v.public_send(index_name)
+    m.const_set(k, enum_value)
+    enum_index_hash[enum_value] = v
+    enum_display_hash[v.public_send(display_name)] = v
+    i += 1
+  end
+
+  define_enum_methods(m, enum_index_hash, enum_display_hash)
+
+  Kernel.const_set(module_name, m)
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: def_enum_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Charles Zhang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- gis05zc@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- def_enum_helper.gemspec
+- lib/def_enum_helper.rb
+- lib/def_enum_helper/version.rb
+homepage: https://github.com/chinazhangchao/def_enum_helper
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: define very powerful enum class
+test_files: []