# Progne Tapera **Repository Path**: Unidom/progne_tapera ## Basic Information - **Project Name**: Progne Tapera - **Description**: Progne Tapera is a Rails-based configurable enumeration implementation. Progne Tapera is the Brown-chested Martin in Latin. Progne Tapera 是基于 Rails 的可配置的枚举实现。Progne Tapera 是棕胸崖燕的拉丁学名。 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-08-05 - **Last Updated**: 2024-03-18 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Progne Tapera [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/progne_tapera/frames) [![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: ```ruby gem 'progne_tapera' ``` And then execute: $ bundle Or install it yourself as: $ gem install progne_tapera ## Usage 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 # The Item Methods module must be defined before the ``enum :china_ethnicity`` code block, so it could be called there. module ItemMethods extend ActiveSupport::Concern included do |includer| def major? 'HA'==code end # Ethnicity::HAN.major? returns true # Ethnicity::MONGEL.major? returns false end end include ProgneTapera::EnumConfig enum :china_ethnicity # 用 :china_ethnicity 指定的 i18n 资源。 end ``` app/types/ethnicity.rb ```ruby class Ethnicity < ActiveRecord::Type::Value include ProgneTapera::EnumConfig enum :china_ethnicity_alphabetic, :china_ethnicity # 以民族字母代码为代码，用 :china_ethnicity 指定的 i18n 资源。 end ``` app/types/ethnicity.rb ```ruby class Ethnicity < ActiveRecord::Type::Value include ProgneTapera::EnumConfig enum :china_ethnicity_numeric, :china_ethnicity # 民族数字代码，用 :china_ethnicity 指定的 i18n 资源。 end ``` 在某处需要调用民族 (Ethnicity) 枚举型的代码中： ```ruby Ethnicity::HAN.code # 'HA' Ethnicity::HAN.localized_name # '汉' ``` 在使用枚举型的模型中：（如 app/models/person.rb） ```ruby class Person < ActiveRecord::Base code :ethnicity, Ethnicity # The :ethnicity above implies the Person model has the :ethnicity_code field. 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 .lookup method as: ``lookup(code)`` 11. Define the .form_options method as: ``form_options(&block)`` 12. Define the .deserialize method as: ``deserialize(value)`` 13. Define the .serialize method as: ``serialize(value)`` ```ruby gender = Gender.lookup '1' # Lookup the gender per code gender.name # male Gender.form_options # { '男' => '1', '女' => '2', '未指定' => '9' } # It's useful for the HTML select options ``` ### 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, localized_name = name, &block)`` 3. Define the .overload_enum_i18n method as: ``overload_enum_i18n(localized_name = nil)`` config/locales/enum.zh-CN.yml ```yaml 'zh-CN': enum: china_ethnicity_overloaded: han: 汉族 mongel: 蒙古族 ``` ```ruby # Overload the i18n resources of the Ethnicity enum code Ethnicity.class_eval do overload_enum_i18n :china_ethnicity_overloaded end ``` 在某处需要调用民族 (Ethnicity) 枚举型的代码中： ```ruby Ethnicity::HAN.code # 'HA' Ethnicity::HAN.localized_name # '汉族' not '汉' ``` 基于数据或者其他的方式扩展枚举型： ```ruby Ethnicity.enum do { miao: { code: 'MH', numeric_code: '06', localized_name: '苗' }, yi: { code: 'YI', numeric_code: '07', localized_name: '彝' } } end Ethnicity::MIAO.code # 'MH' Ethnicity::MIAO.localized_name # '苗' Ethnicity::YI.code # 'YI' Ethnicity::YI.localized_name # '彝' ``` ### 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://gitee.com/Unidom/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