activerecord-enum_translation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cb93380b76689c28e8185ecf8e9f42c71ea37ab4749e2a20a04b6cc6b63d29b
-  data.tar.gz: 1be69a77028bb7c288cf963f0e4f0ec805cb4f80be1064aa15dc5281eded0359
+  metadata.gz: dbf4f2ef6f45d81466d61cedef509795f25fae8bc0ecce8e5bd852f0c99f814c
+  data.tar.gz: 0bbfda5aa2830d39d20d64db65cc408e56570cea305048e2a552c8b369b3edc3
 SHA512:
-  metadata.gz: d720793c9ad6a52424f43cbecfc3955e4cac384fd95869eb0c067cd322bbe41f180429d9cfed5b1ab5999b80ff7878a7d50e8c4a30fd350ced7e509caabc3617
-  data.tar.gz: c53707553b5cba77392b821a9f963d63b3dbc086de4d4b56fd275d519c52d78e04e488eece58109c880715241eef4625a6c7b1510c63cb6a22f845ccf434acc1
+  metadata.gz: a9c078857b0ba9995b74076847247b38473d878058dedc6c880f94516c4a28c75046e9f64843e314db59ef093ad715f2f8c4d039565cfefa227cef7cc2a63113
+  data.tar.gz: 5e1087ed582fb2bf1c6d3ec3159552ac14e80760b6d544899756137ac54525a7ad9ead67ac14f125f50124f8cb9652e406ac0e5dc2cb2eefc367f69dad19099d

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## v0.2.0
+
+### Added
+
+- Add `:count` option.
+- Add `"attributes.#{enum_name}.#{enum_value}" key.
+- Add humanized enum value as default value.
+- Support `i18n_scope` override.
+
+### Fixed
+
+- Fix broken `:default` option on `#human_enum_name_reader_for`.
+
+## v0.1.0 - 2020-09-12
+
+### Added
+
+- Add 1st implementation.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-enum_translation (0.1.0)
+    activerecord-enum_translation (0.2.0)
       activerecord
       activesupport
 

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2020 Ryo Nakamura
+
+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

@@ -1,5 +1,7 @@
 # ActiveRecord::EnumTranslation
 
+[![Gem Version](https://badge.fury.io/rb/activerecord-enum_translation.svg)](https://rubygems.org/gems/activerecord-enum_translation)
+
 Provides integration between ActiveRecord::Enum and I18n.
 
 ## Installation
@@ -39,23 +41,23 @@ end
 Add translations in your locale files:
 
 ```yaml
-en:
+ja:
   activerecord:
     attributes:
       user:
         status:
-          active: Active
-          inactive: Inactive
+          active: 利用中
+          inactive: 停止中
 ```
 
 Get the translation by `human_enum_name_for`:
 
 ```ruby
 user = User.new(status: :active)
-user.human_enum_name_for(:status)
+user.human_enum_name_for(:status) #=> "利用中"
 ```
 
-This gem also provides `human_name_reader_for`:
+This gem also provides `human_enum_name_reader_for`:
 
 ```ruby
 class User < ApplicationRecord
@@ -68,7 +70,7 @@ Finally you can use `human_enum_name_for_status`:
 
 ```ruby
 user = User.new(status: :active)
-user.human_enum_name_for_status
+user.human_enum_name_for_status #=> "利用中"
 ```
 
 ## Development

data/activerecord-enum_translation.gemspec

@@ -3,6 +3,7 @@ require_relative 'lib/activerecord/enum_translation/version'
 Gem::Specification.new do |spec|
   spec.name          = "activerecord-enum_translation"
   spec.version       = ActiveRecord::EnumTranslation::VERSION
+  spec.licenses      = ["MIT"]
   spec.authors       = ["Ryo Nakamura"]
   spec.email         = ["r7kamura@gmail.com"]
 

data/lib/activerecord/enum_translation.rb

@@ -7,6 +7,7 @@ module ActiveRecord
 
     # Translates enum identifiers into a more human format, such as `"Active"` instead of `:active`.
     # @param [Symbol] enum_name
+    # @param [Integer] count
     # @param [Symbol, String, nil] default
     # @return [String, nil]
     # @example
@@ -14,33 +15,41 @@ module ActiveRecord
     #   User.new.human_enum_name_for(:status) #=> nil
     #   User.new.human_enum_name_for(:status, default: "Unknown") #=> "Unknown"
     #   User.new.human_enum_name_for(:status, default: :"common.unknown") #=> "Unknown"
-    def human_enum_name_for(enum_name, default: nil)
+    def human_enum_name_for(enum_name, count: 1, default: nil)
+      options = { count: count }
       enum_value = public_send(enum_name)
+      scope = "#{self.class.i18n_scope}.attributes"
+
       defaults = []
       if enum_value
         defaults += self.class.lookup_ancestors.map do |ancestor|
-          :"activerecord.attributes.#{ancestor.model_name.i18n_key}.#{enum_name}.#{enum_value}"
+          :"#{scope}.#{ancestor.model_name.i18n_key}.#{enum_name}.#{enum_value}"
         end
+        defaults << :"attributes.#{enum_name}.#{enum_value}"
       else
         defaults << nil
       end
       defaults << default if default
-      ::I18n.t(defaults.shift, default: defaults.empty? ? nil : defaults)
+      defaults << enum_value.humanize if enum_value
+
+      key = defaults.shift
+      options[:default] = defaults.empty? ? nil : defaults
+      ::I18n.t(key, options)
     end
 
     module ClassMethods
       # Defines handy reader method for enum translation.
       # @param [Symbol] enum_name
-      # @param [Symbol, String, nil] default
+      # @param [Hash] options
       # @example
       #   class User < ApplicationRecord
       #     human_enum_name_reader_for :status
       #   end
       #
       #   User.new(status: :active).human_enum_name_for_status #=> "Active"
-      def human_enum_name_reader_for(enum_name, default: nil)
-        define_method("human_enum_name_for_#{enum_name}") do
-          human_enum_name_for(enum_name, default: default)
+      def human_enum_name_reader_for(enum_name)
+        define_method("human_enum_name_for_#{enum_name}") do |**options|
+          human_enum_name_for(enum_name, **options)
         end
       end
     end

data/lib/activerecord/enum_translation/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module EnumTranslation
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-enum_translation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -47,8 +47,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - activerecord-enum_translation.gemspec
@@ -57,7 +59,8 @@ files:
 - lib/activerecord/enum_translation.rb
 - lib/activerecord/enum_translation/version.rb
 homepage: https://github.com/r7kamura/activerecord-enum_translation
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/r7kamura/activerecord-enum_translation
   source_code_uri: https://github.com/r7kamura/activerecord-enum_translation