progne_tapera 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd661dd328a0cca1b2cbe396620e0fdcf890cced
+  data.tar.gz: 392c0a5cdd3b5dce2eaf38c0eac3a01c747de6e5
+SHA512:
+  metadata.gz: 22d0667f8df930b057ac45c28af5a0b27eb0c0835e70e2e30a108bbcfce347591a03a6e8e153d7e3f0e6d41f5e5d8da67a01d2f6d10a461a8460a52fc284a35f
+  data.tar.gz: 8d0f4d43dac0fe24fe10b50362a8de3ff1956dfa0af233b8ffa79ba9ec59bf643b7209ef8e7b08ce21963776762b913566adb801372d2bc4517249a0fc7b6865

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Du Hengfeng
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# ProgneTapera
+
+Progne Tapera is a Rails-based configurable enumeration implementation. Progne Tapera is the Brown-chested Martin in Latin.
+Progne Tapera 是基于 Rails 的可配置的枚举实现。Progne Tapera 是棕胸崖燕的拉丁学名。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'progne_tapera'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install progne_tapera
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/progne_tapera.rb

@@ -0,0 +1,11 @@
+require 'progne_tapera/version'
+
+require 'progne_tapera/enum_list'
+require 'progne_tapera/enum_item'
+require 'progne_tapera/enum_config'
+
+require 'progne_tapera/enum_code'
+
+module ProgneTapera
+
+end

data/lib/progne_tapera/enum_code.rb

@@ -0,0 +1,25 @@
+module ProgneTapera::EnumCode
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+  end
+
+  module ClassMethods
+
+    def code(field, enum)
+      code_field_name = :"#{field}_code"
+      validates code_field_name, inclusion: enum.all.map { |item| item.code }
+      instance_eval do
+        define_method field do
+          enum.select { |item| item.code==send(code_field_name.to_sym) }.first
+        end
+        define_method "#{field}=" do |value|
+          send "#{code_field_name}=".to_sym, value.code
+        end
+      end
+    end
+
+  end
+
+end

data/lib/progne_tapera/enum_config.rb

@@ -0,0 +1,25 @@
+module ProgneTapera::EnumConfig
+
+  extend  ActiveSupport::Concern
+  include ProgneTapera::EnumList
+
+  included do |includer|
+  end
+
+  module ClassMethods
+
+    def enum(name = nil)
+      name = enum_name(name).to_s
+      enumerations = Rails.configuration.enum[name]
+      raise ArgumentError.new "The enum.#{name} was not configured in the config/enum.yml file." if enumerations.blank?
+      enumerations.each do |key, value|
+        options = value.map { |k, v| [ k.to_sym, v ] }.to_h
+        code    = options.delete :code
+        options[:localized_name] = I18n.t "enum.#{name}.#{key}"
+        safe_add_item ProgneTapera::EnumItem.new(code, key, options)
+      end
+    end
+
+  end
+
+end

data/lib/progne_tapera/enum_item.rb

@@ -0,0 +1,42 @@
+require 'rails'
+
+class ProgneTapera::EnumItem
+
+  attr_reader :code, :name
+
+  # code = HA (value)
+  # name = han
+  # options = { localized_name: '汉' }
+  # -> constant: HAN
+  def initialize(code, name, options = {})
+
+    raise ArgumentError.new 'The code argument is required.' if code.blank?
+    raise ArgumentError.new 'The name argument is required.' if name.blank?
+
+    @code    = code
+    @name    = name
+    @options = options
+
+    @options.each do |key, value|
+      class_eval do
+        define_method(key.to_sym) do
+          value
+        end
+      end
+    end
+
+  end
+
+  def ==(that)
+    self.code==that.code
+  end
+
+  def <=>(that)
+    self.code<=>that.code
+  end
+
+  def constant_name
+    name.to_s.upcase
+  end
+
+end

data/lib/progne_tapera/enum_list.rb

@@ -0,0 +1,77 @@
+require 'rails'
+
+module ProgneTapera::EnumList
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+  end
+
+  module ClassMethods
+
+    include Enumerable
+
+    # Define the Enum type
+    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
+    def item_defined?(item)
+      const_defined? item.constant_name
+    end
+
+    def add_item(item)
+      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
+
+    def safe_add_item(item)
+      const_set item.constant_name, item if item.is_a?(ProgneTapera::EnumItem)&&!item_defined?(item)
+    end
+
+    # Infrastructure for the Enumerable
+    def enum_constants
+      constants.select { |constant|
+        value = const_get constant
+        value.is_a? ProgneTapera::EnumItem
+      }
+    end
+
+    def all
+      enum_constants.map { |constant| const_get constant }
+    end
+
+    def selected
+      block_given? ? yield(all) : all
+    end
+
+    # Enumerable
+    def each(&block)
+      all.each &block
+    end
+
+    # Form Option
+    def form_options(&block)
+      items = block_given? ? selected(&block) : selected
+      items.map { |item| [ item.localized_name, item.code ] }.to_h
+    end
+
+    # ActiveRecord::Type::Value
+    def deserialize(value)
+      select { |item| item.code==value }
+    end
+
+    def serialize(value)
+      value.respond_to?(:code) ? value.code : value
+    end
+
+  end
+
+end

data/lib/progne_tapera/version.rb

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

data/progne_tapera.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'progne_tapera/version'
+
+Gem::Specification.new do |spec|
+  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.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.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"
+
+end

data/spec/progne_tapera/enum_item_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'progne_tapera'
+
+describe ProgneTapera::EnumItem do
+
+  before :each do
+    @ethnicity_item = described_class.new 'HA',   :han,     localized_name: '汉',      numeric_code: '01'
+    @gender_item    = described_class.new '1',    :male,    localized_name: '男'
+    @algorithm_item = described_class.new 'AES8', :aes_256, localized_name: 'AES-256', digits: 256
+  end
+
+  after :each do
+  end
+
+  it 'should have constant name' do
+    expect(@ethnicity_item.constant_name).to eq('HAN')
+    expect(@gender_item.constant_name).to    eq('MALE')
+    expect(@algorithm_item.constant_name).to eq('AES_256')
+  end
+
+  it 'should have localized name' do
+    expect(@ethnicity_item.localized_name).to eq('汉')
+    expect(@gender_item.localized_name).to    eq('男')
+    expect(@algorithm_item.localized_name).to eq('AES-256')
+  end
+
+  it 'should have digits' do
+    expect(@algorithm_item.digits).to eq(256)
+  end
+
+  it 'should have numeric code' do
+    expect(@ethnicity_item.numeric_code).to eq('01')
+  end
+
+end

data/spec/progne_tapera/enum_list_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+require 'progne_tapera'
+
+describe ProgneTapera::EnumList do
+
+  let :subject do
+    class GenderEnum
+      include ProgneTapera::EnumList
+      module ItemMethods
+        def hello(name)
+          case code
+          when '1' then "#{name}先生"
+          when '2' then "#{name}女士"
+          else name.to_s
+          end
+        end
+      end
+    end
+    GenderEnum
+  end
+
+  let :male          do ProgneTapera::EnumItem.new '1', :male,          localized_name: '男'    end
+  let :female        do ProgneTapera::EnumItem.new '2', :female,        localized_name: '女'    end
+  let :not_specified do ProgneTapera::EnumItem.new '9', :not_specified, localized_name: '未指定' end
+
+  before :each do
+    subject.add_item male          unless subject.item_defined? male
+    subject.add_item female        unless subject.item_defined? female
+    subject.add_item not_specified unless subject.item_defined? not_specified
+  end
+
+  after :each do
+  end
+
+  it 'should have enum name' do
+    expect(subject.enum_name).to eq(:gender_enum)
+  end
+
+  it 'should respond to each' do
+    expect(subject).to respond_to(:each)
+  end
+
+  it 'should respond to map' do
+    expect(subject).to respond_to(:map)
+  end
+
+  it 'should be able to count' do
+    expect(subject).to       respond_to(:count)
+    expect(subject.count).to eq(3)
+  end
+
+  it 'should reject duplicate item' do
+    expect { subject.add_item male }.to raise_error(ArgumentError)
+  end
+
+  it 'should reject wrong type' do
+    expect { subject.add_item 'MALE' }.to raise_error(ArgumentError)
+  end
+
+  it 'should be able to add item safely' do
+    expect(subject.count).to eq(3)
+    subject.safe_add_item    male
+    expect(subject.count).to eq(3)
+  end
+
+  it 'should have all' do
+    gender_enums = GenderEnum.all
+
+    expect(gender_enums).to       be_present
+    expect(gender_enums.count).to eq(3)
+  end
+
+  it 'should have selected' do
+    gender_enums = GenderEnum.selected
+
+    expect(gender_enums).to       be_present
+    expect(gender_enums.count).to eq(3)
+  end
+
+  it 'should have customized selected' do
+    gender_enums = GenderEnum.selected do |items| items.select { |item| ['1', '2'].include? item.code } end
+
+    expect(gender_enums).to       be_present
+    expect(gender_enums.count).to eq(2)
+  end
+
+  it 'should have form options' do
+    options = GenderEnum.form_options
+
+    expect(options).to      be_present
+    expect(options.size).to eq(3)
+  end
+
+  it 'should have customized form options' do
+    options = GenderEnum.form_options do |items| items.select { |item| ['1', '2'].include? item.code } end
+
+    expect(options).to      be_present
+    expect(options.size).to eq(2)
+  end
+
+  it 'should hello to male' do
+    expect(GenderEnum::MALE.hello 'Wu').to eq('Wu先生')
+  end
+
+  it 'should hello to female' do
+    expect(GenderEnum::FEMALE.hello 'Wu').to eq('Wu女士')
+  end
+
+  it 'should hello to not specified' do
+    expect(GenderEnum::NOT_SPECIFIED.hello 'Wu').to eq('Wu')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+# 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
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: progne_tapera
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Du Hengfeng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-25 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Progne Tapera is another enum implementation for Ruby. It focuses on
+  configurable enumeration.
+email:
+- topbit.du@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/progne_tapera.rb
+- lib/progne_tapera/enum_code.rb
+- lib/progne_tapera/enum_config.rb
+- lib/progne_tapera/enum_item.rb
+- lib/progne_tapera/enum_list.rb
+- lib/progne_tapera/version.rb
+- progne_tapera.gemspec
+- spec/progne_tapera/enum_item_spec.rb
+- spec/progne_tapera/enum_list_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.4
+signing_key: 
+specification_version: 4
+summary: A configurable enumeration for Ruby.
+test_files:
+- spec/progne_tapera/enum_item_spec.rb
+- spec/progne_tapera/enum_list_spec.rb
+- spec/spec_helper.rb