enum_i18n_helper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9f3e01ef207fb700cb7430b8fd162d61a8560b22a3f3e16e2ddb24cc1da4246
+  data.tar.gz: 58ff6024baf161bbb523580146e75ff3a531136e115b005deb9ab8e8e9d10001
+SHA512:
+  metadata.gz: f39213767680cf38f54c5e6bd7e05e6f38936e4cc7771e7e3a74f927ddce31f24820bd11edbb07275849c477b2995ccc20bb4ace9b3d863d99a132a085862ba0
+  data.tar.gz: a49e2631ee3a3dddccbd2ab4aea170b703da4f304cd4ed7fdb37a1457ddcd67194639f5afb7406a27b90f894aeb51162aa19cf4cfcec5b6be0c9300e69ff7895

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.envrc
+.env.*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--profile 3
+--format documentation

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enum_help.gemspec
+gemspec
+
+gem 'bundler'
+gem 'rake'
+gem 'rspec'
+gem 'sqlite3'
+
+case version = ENV['RAILS_VERSION']
+when nil
+  gem 'rails', '~> 7.0'
+when 'edge'
+  gem 'rails', github: 'rails/rails'
+else
+  gem 'rails', version
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 backer
+
+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,90 @@
+# EnumI18nHelp
+
+Help ActiveRecord::Enum feature to work fine with I18n.
+
+As you know in Rails 4.1.0 , ActiveRecord supported Enum method. But it doesn't work fine with I18n
+
+This gem can help you work fine with Enum and I18n
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enum_i18n_help'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enum_i18n_help
+
+## Usage
+
+
+Required Rails 4.1.x
+
+In model file:
+
+```ruby
+class Order < ActiveRecord::Base
+  enum status: { "nopayment" => 0, "finished" => 1, "failed" => 2, "destroyed" => 3 }
+
+  def self.restricted_statuses
+    statuses.except :failed, :destroyed
+  end
+end
+```
+
+You can call:
+
+```ruby
+order = Order.first
+order.update_attribute :status, 0
+order.status
+# > nopayment
+order.status_i18n # if you have an i18n file defined as following, it will return "未支付".
+# > 未支付
+```
+
+You can also fetch the translated enum collection, if you need to:
+
+```ruby
+Order.statuses_i18n
+```
+
+I18n local file example:
+
+```yaml
+# config/locales/model/order.zh-cn.yml
+zh-cn:
+  enums:
+    order:
+      status:
+        finished: 完成
+        nopayment: 未支付
+        failed: 失败
+        destroyed: 已删除
+```
+
+
+## Notice
+If you want to use enum feature, field of your table can't be named with `reference`.
+When it is named with 'reference' and define enum in model file, there will be raised an error as below:
+
+    NoMethodError: super: no superclass method `enum' for...
+
+
+## Thanks
+
+Thanks for all the [contributors](https://github.com/lyohich812/enum_i18n_help/graphs/contributors).
+
+## Contributing
+
+1. Fork it ( https://github.com/lyohich812/enum_i18n_help/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run test `rspec`
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

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

data/enum_i18n_helper.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "enum_i18n_helper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "enum_i18n_helper"
+  spec.version       = EnumI18nHelper::VERSION
+  spec.authors       = ["Alex P"]
+  spec.email         = ["youcanwinhtc@gmail.com"]
+  spec.summary       = %q{ Extends of ActiveRecord::Enum for use internationalization }
+  spec.description   = %q{ Help ActiveRecord::Enum feature to work fine with I18n.  }
+  spec.homepage      = "https://github.com/lyohich812/enum_i18n_helper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "activesupport", ">= 3.0.0"
+end

data/lib/enum_i18n_helper/i18n.rb

@@ -0,0 +1,75 @@
+module EnumI18nHelper
+
+  module I18n
+
+    if ActiveRecord::VERSION::MAJOR >= 7
+      # overwrite the enum method
+      def enum(name = nil, values = nil, **options)
+        super(name, values, **options)
+        if name # For new syntax in Rails7
+          Helper.define_attr_i18n_method(self, name)
+          Helper.define_collection_i18n_method(self, name)
+        else
+          definitions = options.slice!(:_prefix, :_suffix, :_scopes, :_default)
+          definitions.each do |name, _|
+            Helper.define_attr_i18n_method(self, name)
+            Helper.define_collection_i18n_method(self, name)
+          end
+        end
+      end
+    else
+      # overwrite the enum method
+      def enum( definitions )
+        super( definitions )
+        definitions.each do |name, _|
+          Helper.define_attr_i18n_method(self, name)
+          Helper.define_collection_i18n_method(self, name)
+        end
+      end
+    end
+
+    def self.extended(receiver)
+      # receiver.class_eval do
+      #   # alias_method_chain :enum, :enum_help
+      # end
+    end
+
+  end
+
+  module Helper
+
+    def self.define_attr_i18n_method(klass, attr_name)
+      attr_i18n_method_name = "#{attr_name}_i18n"
+
+      klass.class_eval <<-METHOD, __FILE__, __LINE__
+      def #{attr_i18n_method_name}
+        enum_label = self.send(:#{attr_name})
+        if enum_label
+          ::EnumI18nHelper::Helper.translate_enum_label('#{klass}', :#{attr_name}, enum_label)
+        else
+          nil
+        end
+      end
+      METHOD
+    end
+
+    def self.define_collection_i18n_method(klass, attr_name)
+      collection_method_name = "#{attr_name.to_s.pluralize}"
+      collection_i18n_method_name = "#{collection_method_name}_i18n"
+
+      klass.instance_eval <<-METHOD, __FILE__, __LINE__
+      def #{collection_i18n_method_name}
+        collection_array = #{collection_method_name}.collect do |label, _|
+          [label, ::EnumI18nHelper::Helper.translate_enum_label('#{klass}', :#{attr_name}, label)]
+        end
+        Hash[collection_array].with_indifferent_access
+      end
+      METHOD
+    end
+
+    def self.translate_enum_label(klass, attr_name, enum_label)
+      ::I18n.t("enums.#{klass.to_s.underscore.gsub('/', '.')}.#{attr_name}.#{enum_label}", default: enum_label.humanize)
+    end
+
+  end
+end

data/lib/enum_i18n_helper/railtie.rb

@@ -0,0 +1,9 @@
+module EnumI18nHelper
+  class Railtie < Rails::Railtie
+    initializer "enum_i18n_helper.i18n" do
+      ActiveSupport.on_load(:active_record) do
+        extend EnumI18nHelper::I18n
+      end
+    end
+  end
+end

data/lib/enum_i18n_helper/version.rb

@@ -0,0 +1,3 @@
+module EnumI18nHelper
+  VERSION = "0.0.1"
+end

data/lib/enum_i18n_helper.rb

@@ -0,0 +1,4 @@
+require "enum_i18n_helper/version"
+require "enum_i18n_helper/i18n"
+require "enum_i18n_helper/railtie"
+

data/spec/enum_i18n_helper_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+EnumI18nHelper::Railtie.initializers.each(&:run)
+
+class User < ActiveRecord::Base
+  if ActiveRecord.version < Gem::Version.new('6.1')
+    enum gender: [:male, :female]
+  elsif ActiveRecord.version < Gem::Version.new('7.0')
+    enum gender: [:male, :female], _default: :male
+  else # Rails 7.0 or higher
+    enum :gender, [:male, :female], default: :male
+  end
+
+  enum status: %i[normal disable]
+end
+
+RSpec.describe EnumI18nHelper::I18n do
+  describe '#enum' do
+    context 'With hash definitions' do
+      it 'responds defined _i18n method' do
+        expect(User.new).to respond_to("gender_i18n")
+      end
+
+      it 'responds defined genders_i18n method' do
+        expect(User).to respond_to("genders_i18n")
+      end
+    end
+
+    context 'With array definitions' do
+      it 'responds defined _i18n method' do
+        expect(User.new).to respond_to("status_i18n")
+      end
+
+      it 'responds defined status_i18n method' do
+        expect(User).to respond_to("statuses_i18n")
+      end
+    end
+  end
+
+  describe '#enum_key_i18n' do
+    describe 'user.gender' do
+      let(:gender) { "female" }
+      let(:user) { User.create(gender: gender) }
+
+
+      subject { user.gender_i18n }
+
+      context 'lang is zh-CN' do
+        before { I18n.locale = :"zh-CN" }
+
+        it { expect(I18n.locale).to eq :"zh-CN" }
+
+        context 'gender is male' do
+          let(:gender) { 'male' }
+          it { is_expected.to eq '男' }
+        end
+
+        context 'gender is female' do
+          let(:gender) { 'female' }
+          it { is_expected.to eq '女' }
+        end
+      end
+
+      context 'lang is en' do
+        before { I18n.locale = :en }
+
+        it { expect(I18n.locale).to eq :en }
+
+        context 'gender is male' do
+          let(:gender) { 'male' }
+          it { is_expected.to eq 'Male' }
+        end
+
+        context 'gender is female' do
+          let(:gender) { 'female' }
+          it { is_expected.to eq 'Female' }
+        end
+      end
+    end
+  end
+
+  describe '#enum_keys_i18n' do
+    subject { User.genders_i18n }
+
+    context 'lang is zh-CN' do
+      before { I18n.locale = :"zh-CN" }
+
+      it { expect(I18n.locale).to eq :"zh-CN" }
+      it { is_expected.to eq({"male"=>"男", "female"=>"女"}) }
+    end
+
+    context 'lang is en' do
+      before { I18n.locale = :en }
+
+      it { expect(I18n.locale).to eq :en }
+      it { is_expected.to eq({"male"=>"Male", "female"=>"Female"}) }
+    end
+  end
+end

data/spec/fixtures/locales/en.yml

@@ -0,0 +1,16 @@
+en:
+  activerecord:
+    models:
+      user: "User"
+    attributes:
+      user:
+        id: "ID"
+        gender: "Gender"
+  enums:
+    user:
+      gender:
+        male: "Male"
+        female: "Female"
+      status:
+        normal: "Normal"
+        disable: "Disable"

data/spec/fixtures/locales/zh-CN.yml

@@ -0,0 +1,16 @@
+zh-CN:
+  activerecord:
+    models:
+      user: "用户"
+    attributes:
+      user:
+        id: "ID"
+        gender: "性别"
+  enums:
+    user:
+      gender:
+        male: "男"
+        female: "女"
+      status:
+        normal: "正常"
+        disable: "禁用"

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "bundler/setup"
+
+require "rspec"
+
+require "rails"
+require "active_record"
+
+Bundler.require
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+I18n.load_path += Dir["#{File.dirname(__FILE__)}/fixtures/locales/*.yml"]
+I18n.enforce_available_locales = false
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)

data/spec/support/setup_database.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Base.configurations = { "test"=> {"adapter"=>"sqlite3", "database"=>":memory:"} }
+ActiveRecord::Base.establish_connection :test
+
+version = "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+class CreateAllTables < ActiveRecord::Migration[version]
+  def change
+    create_table :users do |t|
+      t.integer :gender, null: false, default: 0, limit: 1
+      t.integer :status, null: false, default: 0, limit: 1
+
+      t.timestamps
+    end
+  end
+end
+
+ActiveRecord::Migration.verbose = false
+CreateAllTables.new.change

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: enum_i18n_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex P
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: " Help ActiveRecord::Enum feature to work fine with I18n.  "
+email:
+- youcanwinhtc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enum_i18n_helper.gemspec
+- lib/enum_i18n_helper.rb
+- lib/enum_i18n_helper/i18n.rb
+- lib/enum_i18n_helper/railtie.rb
+- lib/enum_i18n_helper/version.rb
+- spec/enum_i18n_helper_spec.rb
+- spec/fixtures/locales/en.yml
+- spec/fixtures/locales/zh-CN.yml
+- spec/spec_helper.rb
+- spec/support/setup_database.rb
+homepage: https://github.com/lyohich812/enum_i18n_helper
+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: []
+rubygems_version: 3.0.9
+signing_key: 
+specification_version: 4
+summary: Extends of ActiveRecord::Enum for use internationalization
+test_files:
+- spec/enum_i18n_helper_spec.rb
+- spec/fixtures/locales/en.yml
+- spec/fixtures/locales/zh-CN.yml
+- spec/spec_helper.rb
+- spec/support/setup_database.rb