activerecord-enum_translation 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-enum_translation.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "sqlite3"

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    activerecord-enum_translation (0.1.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    rake (12.3.3)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-enum_translation!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,83 @@
+# ActiveRecord::EnumTranslation
+
+Provides integration between ActiveRecord::Enum and I18n.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-enum_translation'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install activerecord-enum_translation
+
+## Usage
+
+Include `ActiveRecord::EnumTranslation`:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include ActiveRecord::EnumTranslation
+end
+```
+
+Define enum:
+
+```ruby
+class User < ApplicationRecord
+  enum status: %i[active inactive]
+end
+```
+
+Add translations in your locale files:
+
+```yaml
+en:
+  activerecord:
+    attributes:
+      user:
+        status:
+          active: Active
+          inactive: Inactive
+```
+
+Get the translation by `human_enum_name_for`:
+
+```ruby
+user = User.new(status: :active)
+user.human_enum_name_for(:status)
+```
+
+This gem also provides `human_name_reader_for`:
+
+```ruby
+class User < ApplicationRecord
+  enum status: %i[active inactive]
+  human_enum_name_reader_for :status
+end
+```
+
+Finally you can use `human_enum_name_for_status`:
+
+```ruby
+user = User.new(status: :active)
+user.human_enum_name_for_status
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/r7kamura/activerecord-enum_translation.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/activerecord-enum_translation.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/activerecord/enum_translation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-enum_translation"
+  spec.version       = ActiveRecord::EnumTranslation::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+
+  spec.summary       = "Provides integration between ActiveRecord::Enum and I18n."
+  spec.homepage      = "https://github.com/r7kamura/activerecord-enum_translation"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord"
+  spec.add_runtime_dependency "activesupport"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/enum_translation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord/enum_translation.rb

@@ -0,0 +1,48 @@
+require "active_support/concern"
+require "activerecord/enum_translation/version"
+
+module ActiveRecord
+  module EnumTranslation
+    extend ::ActiveSupport::Concern
+
+    # Translates enum identifiers into a more human format, such as `"Active"` instead of `:active`.
+    # @param [Symbol] enum_name
+    # @param [Symbol, String, nil] default
+    # @return [String, nil]
+    # @example
+    #   User.new(status: :active).human_enum_name_for(:status) #=> "Active"
+    #   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)
+      enum_value = public_send(enum_name)
+      defaults = []
+      if enum_value
+        defaults += self.class.lookup_ancestors.map do |ancestor|
+          :"activerecord.attributes.#{ancestor.model_name.i18n_key}.#{enum_name}.#{enum_value}"
+        end
+      else
+        defaults << nil
+      end
+      defaults << default if default
+      ::I18n.t(defaults.shift, default: defaults.empty? ? nil : defaults)
+    end
+
+    module ClassMethods
+      # Defines handy reader method for enum translation.
+      # @param [Symbol] enum_name
+      # @param [Symbol, String, nil] default
+      # @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)
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/enum_translation/version.rb

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

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-enum_translation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- activerecord-enum_translation.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/enum_translation.rb
+- lib/activerecord/enum_translation/version.rb
+homepage: https://github.com/r7kamura/activerecord-enum_translation
+licenses: []
+metadata:
+  homepage_uri: https://github.com/r7kamura/activerecord-enum_translation
+  source_code_uri: https://github.com/r7kamura/activerecord-enum_translation
+  changelog_uri: https://github.com/r7kamura/activerecord-enum_translation/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides integration between ActiveRecord::Enum and I18n.
+test_files: []