enum_help 0.0.14 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7af8f0949dd254a92a7bb439af880de5d05ad9f8
-  data.tar.gz: 15c71d3eb00bf6fa0a2aa400129b9ae4d2246388
+SHA256:
+  metadata.gz: 6b1fb56c71d55485d1b9c413179c4ec402c4b3ea0b3e9ee362b213122f6fdc6c
+  data.tar.gz: 2e105e8b000e82fc026ebf56aecbd1de97ac944b8f20294615af88efaf95c49c
 SHA512:
-  metadata.gz: f5e119aa5242b8a35451a4e4e7f37315be76fa413fd445d0d9dd8a8b22e82eac7199bbaefefc79619b0cfdcc66b65ef4ecf24773a33a8c135eb8585b747dd729
-  data.tar.gz: 0a6f6529c29db06ac3cb17a2627d95f7da3827c52e2b71ba0973158746d176db3726c380df5a3a4ffeb75fb7645a558ed9e3883f7f044a7818c115f816ac38f1
+  metadata.gz: e4f0adcc0a7829ad4d44449eb930e76eed390ea39037f34fabcd640bff615a02ce0b63f6910264f532798381b58527eabf4392b64b77957bce28faf05f494a8a
+  data.tar.gz: ca449b158ab5a0c9a487e95300d0ad91b8581afda1dd28373bd29fb03ceb6a1d94977c0cb0a0ab38fbff462ce34f9807fb22467833313396e493cfdb387df5e5

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - head
+          - 3.1
+          - "3.0"
+          - 2.7
+          - 2.6
+        rails-version:
+          - "edge"
+          - "~> 7.0.1"
+          - "~> 6.1.4"
+          - "~> 6.0.4"
+          - "~> 5.2.6"
+        exclude:
+          - ruby-version: head
+            rails-version: "~> 5.2.6"
+          - ruby-version: 3.1
+            rails-version: "~> 5.2.6"
+          - ruby-version: "3.0"
+            rails-version: "~> 5.2.6"
+          - ruby-version: 2.6
+            rails-version: "edge"
+          - ruby-version: 2.6
+            rails-version: "~> 7.0.1"
+    env:
+      RAILS_VERSION: "${{ matrix.rails-version }}"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "${{ matrix.ruby-version }}"
+          bundler-cache: true
+      - run: bundle exec rspec

data/.rspec

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

data/Gemfile

@@ -2,3 +2,17 @@ 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/README.md

@@ -8,6 +8,31 @@ As you know in Rails 4.1.0 , ActiveRecord supported Enum method. But it doesn't
 
 This gem can help you work fine with Enum feather, I18n and simple_form
 
+## Breaking Changes
+
+Version 0.0.15 changes the behaviour of namespaced modules as per [this commit](https://github.com/zmbacker/enum_help/commit/fd1c09bcc5402b97bbf4d35313ce84cdffbe47d3): standard en.yml structures for enums `Foo::Bar::Baz#abc` and `Foo::Bar::Bat#def` change from
+
+    enums:
+      foo/bar/baz:
+        abc:
+          lorem: 'Ipsum'
+      foo/bar/bat:
+        def:
+          lorem: 'Ipsum'
+
+To
+
+    enums:
+      foo:
+        bar:
+          baz:
+            abc:
+              lorem: 'Ipsum'
+          bat:
+            def:
+              lorem: 'Ipsum'
+
+For different I18n backends, adjust accordingly as namespaced modules are now referenced by `.` rather than `/`.
 
 ## Installation
 
@@ -33,7 +58,7 @@ 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
@@ -63,7 +88,7 @@ In `_form.html.erb` using `simple_form`:
 <%= f.input :status %>
 ```
 
-This will generate select field with translations automaticlly.
+This will generate select field with translations automatically.
 
 And if you want to generate select except some values, then you can pass a collection option.
 
@@ -76,12 +101,12 @@ Other arguments for `simple_form` are supported perfectly.
 e.g.
 
 ```erb
-<%= f.input :status, prompt: 'Please select a stauts' %>
+<%= f.input :status, prompt: 'Please select a status' %>
 
 <%= f.input :status, as: :string %>
 ```
 
-From version 0.0.10, enum_help can automaticlly generate radio buttons with i18n labels.
+From version 0.0.10, enum_help can automatically generate radio buttons with i18n labels.
 
 e.g.
 ```erb
@@ -94,7 +119,7 @@ e.g.
 I18n local file example:
 
 ```yaml
-# config/locals/model/order.zh-cn.yml
+# config/locales/model/order.zh-cn.yml
 zh-cn:
   enums:
     order:
@@ -108,7 +133,7 @@ zh-cn:
 
 ## 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 raise an error as below:
+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...
 
@@ -121,6 +146,7 @@ Thanks for all the [contributors](https://github.com/zmbacker/enum_help/graphs/c
 
 1. Fork it ( http://github.com/zmbacker/enum_help/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 new Pull Request
+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

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

data/enum_help.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'enum_help/version'
+require "enum_help/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "enum_help"
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["zm.backer@gmail.com"]
   spec.summary       = %q{ Extends of ActiveRecord::Enum, which can used in simple_form and internationalization }
   spec.description   = %q{ Help ActiveRecord::Enum feature to work fine with I18n and simple_form.  }
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/zmbacker/enum_help"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,5 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_dependency "activesupport", ">= 3.0.0"
 end

data/lib/enum_help/i18n.rb

@@ -2,12 +2,26 @@ module EnumHelp
 
   module I18n
 
-    # 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)
+    if ActiveRecord::VERSION::MAJOR == 7
+      # overwrite the enum method
+      def enum(name = nil, values = nil, **options)
+        super(name, values, **options)
+
+        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
+    if ActiveRecord::VERSION::MAJOR < 7
+      # 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
 
@@ -28,7 +42,7 @@ module EnumHelp
       def #{attr_i18n_method_name}
         enum_label = self.send(:#{attr_name})
         if enum_label
-          ::EnumHelp::Helper.translate_enum_label(self.class, :#{attr_name}, enum_label)
+          ::EnumHelp::Helper.translate_enum_label('#{klass}', :#{attr_name}, enum_label)
         else
           nil
         end
@@ -43,7 +57,7 @@ module EnumHelp
       klass.instance_eval <<-METHOD, __FILE__, __LINE__
       def #{collection_i18n_method_name}
         collection_array = #{collection_method_name}.collect do |label, _|
-          [label, ::EnumHelp::Helper.translate_enum_label(self, :#{attr_name}, label)]
+          [label, ::EnumHelp::Helper.translate_enum_label('#{klass}', :#{attr_name}, label)]
         end
         Hash[collection_array].with_indifferent_access
       end
@@ -51,7 +65,7 @@ module EnumHelp
     end
 
     def self.translate_enum_label(klass, attr_name, enum_label)
-      ::I18n.t("enums.#{klass.to_s.underscore}.#{attr_name}.#{enum_label}", default: enum_label)
+      ::I18n.t("enums.#{klass.to_s.underscore.gsub('/', '.')}.#{attr_name}.#{enum_label}", default: enum_label.humanize)
     end
 
   end

data/lib/enum_help/railtie.rb

@@ -1,7 +1,9 @@
 module EnumHelp
   class Railtie < Rails::Railtie
     initializer "enum_help.i18n" do
-      ActiveRecord::Base.send :extend, EnumHelp::I18n
+      ActiveSupport.on_load(:active_record) do
+        extend EnumHelp::I18n
+      end
     end
   end
-end
+end

data/lib/enum_help/simple_form.rb

@@ -4,7 +4,7 @@ module EnumHelp
   module SimpleForm
     module BuilderExtension
 
-      def default_input_type_with_enum(*args, &block)
+      def default_input_type(*args, &block)
         att_name = (args.first || @attribute_name).to_s
         options = args.last
         return :enum_radio_buttons if options.is_a?(Hash) && options[:as] == :radio_buttons &&
@@ -13,7 +13,7 @@ module EnumHelp
         return :enum if (options.is_a?(Hash) ? options[:as] : @options[:as]).nil? &&
                         is_enum_attributes?( att_name )
 
-        default_input_type_without_enum(*args, &block)
+        super
       end
 
 
@@ -71,11 +71,10 @@ end
 
 
 SimpleForm::FormBuilder.class_eval do
-  include EnumHelp::SimpleForm::BuilderExtension
+  prepend EnumHelp::SimpleForm::BuilderExtension
 
   map_type :enum,               :to => EnumHelp::SimpleForm::EnumInput
   map_type :enum_radio_buttons, :to => EnumHelp::SimpleForm::EnumRadioButtons
   alias_method :collection_enum_radio_buttons, :collection_radio_buttons
   alias_method :collection_enum, :collection_select
-  alias_method_chain :default_input_type, :enum
 end

data/lib/enum_help/version.rb

@@ -1,3 +1,3 @@
 module EnumHelp
-  VERSION = "0.0.14"
+  VERSION = "0.0.18"
 end

data/spec/enum_i18n_help_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+EnumHelp::Railtie.initializers.each(&:run)
+
+class User < ActiveRecord::Base
+  if ActiveRecord.version < Gem::Version.new('6.1')
+    enum gender: [:male, :female]
+  else
+    enum gender: [:male, :female], _default: :male
+  end
+
+  enum status: %i[normal disable]
+end
+
+RSpec.describe EnumHelp::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 @@
+zh-CN:
+  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

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: enum_help
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.18
 platform: ruby
 authors:
 - Lester Zhao
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-07 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 description: " Help ActiveRecord::Enum feature to work fine with I18n and simple_form.
   \ "
 email:
@@ -46,7 +32,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -57,11 +45,16 @@ files:
 - lib/enum_help/railtie.rb
 - lib/enum_help/simple_form.rb
 - lib/enum_help/version.rb
-homepage: ''
+- spec/enum_i18n_help_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/zmbacker/enum_help
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,9 +69,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Extends of ActiveRecord::Enum, which can used in simple_form and internationalization
-test_files: []
+test_files:
+- spec/enum_i18n_help_spec.rb
+- spec/fixtures/locales/en.yml
+- spec/fixtures/locales/zh-CN.yml
+- spec/spec_helper.rb
+- spec/support/setup_database.rb