progne_tapera 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd661dd328a0cca1b2cbe396620e0fdcf890cced
-  data.tar.gz: 392c0a5cdd3b5dce2eaf38c0eac3a01c747de6e5
+  metadata.gz: c347517d3cc7131f1969253a474a29966720f1e1
+  data.tar.gz: da0e6d466b75fcc15823623de76a97e00e0335b5
 SHA512:
-  metadata.gz: 22d0667f8df930b057ac45c28af5a0b27eb0c0835e70e2e30a108bbcfce347591a03a6e8e153d7e3f0e6d41f5e5d8da67a01d2f6d10a461a8460a52fc284a35f
-  data.tar.gz: 8d0f4d43dac0fe24fe10b50362a8de3ff1956dfa0af233b8ffa79ba9ec59bf643b7209ef8e7b08ce21963776762b913566adb801372d2bc4517249a0fc7b6865
+  metadata.gz: 77d5dad91214242e8bca4fe35c0f33278648fd98c940da3c9e2a4b5898cf9439ba0fce86288835440d4ad192b594992ee4a7a0093da74ca2d4180d563fa6cd4f
+  data.tar.gz: 04d98c24b1377dfdd90524aaed64c3c53ff031fd121860297efb9e9d8e71ba76586857903c9fb1a2fb6fb31e5cfd4fb0687f39abddaa0b9975ecb0eba2b21365

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -11,5 +10,6 @@
 *.so
 *.o
 *.a
+*.gem
 mkmf.log
 .DS_Store

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 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. Improve the Ruby Gem Specification to depend on Rails v4.2

data/Gemfile.lock

@@ -0,0 +1,135 @@
+PATH
+  remote: .
+  specs:
+    progne_tapera (0.1)
+      rails (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.0.1)
+      actionview (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    builder (3.2.2)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    loofah (2.0.3)
+      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.9.1)
+    nio4r (1.2.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pkg-config (1.1.7)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.0.1)
+      actioncable (= 5.0.0.1)
+      actionmailer (= 5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activerecord (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6.0)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      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.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  progne_tapera!
+  rake (~> 11.3)
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -1,8 +1,21 @@
-# ProgneTapera
+# Progne Tapera
+
+[![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)
 
 Progne Tapera is a Rails-based configurable enumeration implementation. Progne Tapera is the Brown-chested Martin in Latin.
 Progne Tapera 是基于 Rails 的可配置的枚举实现。Progne Tapera 是棕胸崖燕的拉丁学名。
 
+
+
+## Recent Update
+
+Check out the [Road Map](ROADMAP.md) to find out what's the next.
+Check out the [Change Log](CHANGELOG.md) to find out what's new.
+
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,13 +32,115 @@ Or install it yourself as:
 
     $ gem install progne_tapera
 
+
+
 ## Usage
 
-TODO: Write usage instructions here
+config/initializers/enum.rb
+```ruby
+Unidom::Common::YamlHelper.load_enum config: Rails.configuration, root: Rails.root
+```
+
+config/enum.yml
+```yaml
+enum:
+
+  gender:
+    male:
+      code: '1'
+    female:
+      code: '2'
+    not_specified:
+      code: '9'
+
+  china_ethnicity:
+    han:
+      code: HA
+      numeric_code: '01'
+    mongel:
+      code: 'MG'
+      numeric_code: '02'
+```
+
+config/locales/enum.zh-CN.yml
+```yaml
+'zh-CN':
+  enum:
+
+    gender:
+      male:          男
+      female:        女
+      not_specified: 未指定
+
+    china_ethnicity:
+      han:    汉
+      mongel: 蒙古
+```
+
+app/types/gender.rb
+```ruby
+class Gender < ActiveRecord::Type::Value
+
+  include ProgneTapera::EnumConfig
+
+  enum
+
+end
+```
+
+app/types/ethnicity.rb
+```ruby
+class Ethnicity < ActiveRecord::Type::Value
+
+  include ProgneTapera::EnumConfig
+
+  enum :china_ethnicity
+
+end
+```
+
+
+
+## Include the Concerns
+
+```ruby
+include ProgneTapera::EnumList
+include ProgneTapera::EnumConfig
+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)``  
+10. Define the .form_options method as: ``form_options(&block)``  
+11. Define the .deserialize method as: ``deserialize(value)``  
+12. Define the .serialize method as: ``serialize(value)``
+
+### Enum Config 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)``
+
+### Enum Code concern
+
+The Enum Code concern do the following tasks for the includer automatically:  
+1. Define the .code method as: ``code(field, enum)``
+
+
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/progne_tapera/fork )
+1. Fork it ( https://github.com/topbitdu/progne_tapera/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/ROADMAP.md

@@ -0,0 +1,10 @@
+# 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 v4.2

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/progne_tapera/version.rb

@@ -1,3 +1,3 @@
 module ProgneTapera
-  VERSION = "0.1"
+  VERSION = "0.1.1"
 end

data/progne_tapera.gemspec

@@ -4,23 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'progne_tapera/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "progne_tapera"
+  spec.name          = 'progne_tapera'
   spec.version       = ProgneTapera::VERSION
-  spec.authors       = ["Du Hengfeng"]
-  spec.email         = ["topbit.du@gmail.com"]
-  spec.summary       = %q{A configurable enumeration for Ruby.}
-  spec.description   = %q{Progne Tapera is another enum implementation for Ruby. It focuses on configurable enumeration.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = [ 'Topbit Du' ]
+  spec.email         = [ 'topbit.du@gmail.com' ]
+  spec.summary       = 'Rails-based configurable enumeration 基于 Rails 的可配置的枚举'
+  spec.description   = 'Progne Tapera is a Rails-based configurable enumeration implementation. Progne Tapera is the Brown-chested Martin in Latin. Progne Tapera 是基于 Rails 的可配置的枚举实现。Progne Tapera 是棕胸崖燕的拉丁学名。'
+  spec.homepage      = 'https://github.com/topbitdu/progne_tapera'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = [ 'lib' ]
 
-  spec.add_dependency             "rails",   "~> 5.0"
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 11.3"
-  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_dependency 'rails', '>= 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake',    '~> 11.3'
+  spec.add_development_dependency 'rspec',   '~> 3.5'
 
 end

data/spec/progne_tapera/enum_item_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'progne_tapera'
 
 describe ProgneTapera::EnumItem do
 

data/spec/progne_tapera/enum_list_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'progne_tapera'
 
 describe ProgneTapera::EnumList do
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'progne_tapera'
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: progne_tapera
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
-- Du Hengfeng
+- Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2016-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-description: Progne Tapera is another enum implementation for Ruby. It focuses on
-  configurable enumeration.
+description: Progne Tapera is a Rails-based configurable enumeration implementation.
+  Progne Tapera is the Brown-chested Martin in Latin. Progne Tapera 是基于 Rails 的可配置的枚举实现。Progne
+  Tapera 是棕胸崖燕的拉丁学名。
 email:
 - topbit.du@gmail.com
 executables: []
@@ -76,10 +77,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
+- ROADMAP.md
 - Rakefile
 - lib/progne_tapera.rb
 - lib/progne_tapera/enum_code.rb
@@ -91,7 +94,7 @@ files:
 - spec/progne_tapera/enum_item_spec.rb
 - spec/progne_tapera/enum_list_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/topbitdu/progne_tapera
 licenses:
 - MIT
 metadata: {}
@@ -114,7 +117,7 @@ rubyforge_project:
 rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
-summary: A configurable enumeration for Ruby.
+summary: Rails-based configurable enumeration 基于 Rails 的可配置的枚举
 test_files:
 - spec/progne_tapera/enum_item_spec.rb
 - spec/progne_tapera/enum_list_spec.rb

data/CHANGELOG

@@ -1 +0,0 @@
-Version 0.0.1: The initial EnumListing module and EnumItem class is released.