human_enum_name 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac99776bd21ab5d235608341fd7fa70d068641a951e1d17baad0c6c81931ef87
+  data.tar.gz: a4129aef430a552a50ad4933881c219b7730f73ee68796fc2f0e8731fd70b2e3
+SHA512:
+  metadata.gz: 5cd90d13d38ff8e91d403cac03407f909e1687e6f680a57f27be0b8a956cb8587094aebddd048d55cee09147d3c1e3f042d594559e72e21d1a3df09e5f4b3a78
+  data.tar.gz: c39fe10389f47ef5dbc763aab99a506540b8604073dab0f8335553990b3e0a0421cacfd193f26515627b25e82eb3f9a8cf34de06c01394fb4f036899b40f7563

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Juraj Kostolansky
+
+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,70 @@
+# human_enum_name
+
+I18n support for Rails enums.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'human_enum_name'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install human_enum_name
+```
+
+## Usage
+
+Declare your enums:
+
+```ruby
+class Conversation < ActiveRecord::Base
+  enum status: [:active, :archived]
+end
+```
+
+Add the enum values to your locale files:
+
+```yml
+en:
+  activerecord:
+    attributes:
+      conversation:
+        statuses:
+          active: Active conversation
+          archived: Archived conversation
+```
+
+Then, you can use the class method `human_enum_name`:
+
+```ruby
+Conversation.human_enum_name(:status, :active) #=> "Active conversation"
+```
+
+For an instance:
+
+```ruby
+conversation = Conversation.new(status: :archived)
+Conversation.human_enum_name(:status, conversation.status) #=> "Archived conversation"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jkostolansky/human_enum_name. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the human_enum_name project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jkostolansky/human_enum_name/blob/master/CODE_OF_CONDUCT.md).

data/human_enum_name.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "human_enum_name/version"
+
+Gem::Specification.new do |spec|
+  spec.name         = "human_enum_name"
+  spec.version      = HumanEnumName::VERSION
+  spec.authors      = ["Juraj Kostolansky"]
+  spec.email        = ["juraj@kostolansky.sk"]
+
+  spec.summary      = "I18n support for Rails enums"
+  spec.homepage     = "https://github.com/jkostolansky/human_enum_name"
+  spec.license      = "MIT"
+
+  spec.files        = Dir["README.md", "LICENSE.txt", "human_enum_name.gemspec", "lib/**/*.rb"]
+  spec.require_path = "lib"
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency "activesupport", ">= 4.2.0"
+end

data/lib/human_enum_name.rb

@@ -0,0 +1,6 @@
+require "human_enum_name/version"
+require "human_enum_name/helpers"
+
+ActiveSupport.on_load :active_record do
+  include HumanEnumName::Helpers
+end

data/lib/human_enum_name/helpers.rb

@@ -0,0 +1,14 @@
+module HumanEnumName
+  module Helpers
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def human_enum_name(enum_name, enum_value)
+        enum_i18n_key = enum_name.to_s.pluralize
+        I18n.t("activerecord.attributes.#{model_name.i18n_key}.#{enum_i18n_key}.#{enum_value}")
+      end
+    end
+  end
+end

data/lib/human_enum_name/version.rb

@@ -0,0 +1,3 @@
+module HumanEnumName
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: human_enum_name
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juraj Kostolansky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: 
+email:
+- juraj@kostolansky.sk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- human_enum_name.gemspec
+- lib/human_enum_name.rb
+- lib/human_enum_name/helpers.rb
+- lib/human_enum_name/version.rb
+homepage: https://github.com/jkostolansky/human_enum_name
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: I18n support for Rails enums
+test_files: []