active_record-humanized_enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 143cd26447de95b6e2e544dfa68f08320be6091c
+  data.tar.gz: fdbbd2bfe348f05c04a0d2f856501bda22a68e8a
+SHA512:
+  metadata.gz: 526e274ca96c09e3aabc9a569b4a519734541061244fe96b4a5137d6c9f358941573240ba7ed71f88ed6adb9e20396091efe749b5c0087c7821583d98dde5fca
+  data.tar.gz: dc6bee2ddf8d0be1e3263d12d605e3f0af144aa20244fb6f868034ab06554ef3d39cc26eef8b366d4b9757ca50107e92acecf25802be2076f9eb6a620897767f

data/.editorconfig

@@ -0,0 +1,13 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+doc
+log
+*.lock

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing
+
+## Issues
+
+If you want to request a feature or report a bug, please use the following template.
+
+```markdown
+## Description
+
+[Add feature/bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Gem version:
+
+Rescuable version: [Add gem version here]
+```
+
+## Writing code
+
+Once you've made your great commits (include tests, please):
+
+1. [Fork](http://help.github.com/forking/) the [original repository](http://github.com/dhyegofernando/rescuable)
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. [Create an Issue](http://github.com/dhyegofernando/rescuable/issues) with a link to your branch
+5. That's it!
+
+Please respect the code style using [editorconfig](http://editorconfig.org/) in your text editor.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in rescuable.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dhyego Fernando
+
+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,52 @@
+# ActiveRecord Humanized Enum (I18n)
+Easily translate your Active Record\'s enums.
+
+## Installation
+Include to your Gemfile
+```ruby
+gem 'active_record-humanized_enum'
+```
+
+## Usage
+
+### ActiveRecord integration
+The installation automatically self-includes in the ```ActiveRecord::Base```.
+
+### How to use
+1. Call the `enum` macro method just like you already do:
+```ruby
+class User
+  enum status: [:enabled, :disabled]
+end
+```
+
+2. Translate the enums in your YML translation files:
+```yaml
+pt-BR:
+  activerecord:
+    attributes:
+      user:
+        status: Estado
+        statuses:
+          enabled: Ativo
+          disabled: Inativo
+```
+
+3. Will be available the following methods:
+```ruby
+User.humanized_status(:enabled) # Ativo
+User.humanized_status(:disnabled) # Inativo
+
+user = User.first
+puts user.status # enabled
+puts user.humanized_status # Ativo
+
+user.status = :disabled
+puts user.humanized_status # Inativo
+```
+
+## Related Projects
+- [Integration with ActiveAdmin](http://github.com/dhyegofernando/active_admin-humanized_enum)
+
+## Maintainer
+[Dhyego Fernando](https://github.com/dhyegofernando)

data/Rakefile

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

data/active_record-humanized_enum.gemspec

@@ -0,0 +1,25 @@
+require './lib/active_record/humanized_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'active_record-humanized_enum'
+  spec.version     = ActiveRecord::HumanizedEnum::Version::STRING
+  spec.authors     = ['Dhyego Fernando']
+  spec.email       = ['dhyegofernando@gmail.com']
+
+  spec.summary     = 'Easily translate your ActiveRecord\'s enums.'
+  spec.description = spec.summary
+  spec.homepage    = 'http://github.com/dhyegofernando/active_record-humanized_enum'
+  spec.license     = 'MIT'
+
+  spec.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.add_dependency 'railties', '~> 4.0'
+  spec.add_dependency 'activesupport', '~> 4.0'
+  spec.add_dependency 'i18n'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-utils'
+  spec.add_development_dependency 'pry-meta'
+end

data/lib/active_record/humanized_enum.rb

@@ -0,0 +1,82 @@
+require 'active_support/concern'
+require 'active_support/lazy_load_hooks'
+
+module ActiveRecord
+  module HumanizedEnum
+    extend ActiveSupport::Concern
+
+    class_methods do
+      ENUM_HUMANIZABLE_CONFLICT_MESSAGE = \
+        "You tried to humanize an enum named \"%{enum}\" on the model \"%{klass}\", but " \
+        "this will generate a %{type} method \"%{method}\", which is already defined " \
+        "by %{source}."
+
+      def enum(definitions)
+        super(definitions)
+        humanized_enum(*definitions.keys)
+      end
+
+      def humanized_enum(*enums)
+        klass = self
+        enums.each do |enum|
+          enum = enum.to_s
+          method_name = "humanized_#{enum}"
+
+          # def self.humanized_status(status) ... end
+          detect_humanized_enum_conflict! enum, method_name, true
+          klass.singleton_class.send :define_method, method_name do |enum_value|
+            I18n.t enum_value.to_sym, scope: [:activerecord, :attributes, klass.model_name.i18n_key, enum.pluralize.to_sym], default: enum_value.to_s.humanize if enum_value.present?
+          end
+
+          # def humanized_status ... end
+          detect_humanized_enum_conflict! enum, method_name
+          define_method method_name do
+            klass.send method_name.to_sym, send(enum.to_sym)
+          end
+        end
+      end
+
+      private
+
+      def detect_humanized_enum_conflict!(enum_name, method_name, klass_method = false)
+        if klass_method && dangerous_class_method?(method_name)
+          raise ArgumentError, ENUM_HUMANIZABLE_CONFLICT_MESSAGE % {
+            enum: enum_name,
+            klass: self.name,
+            type: 'class',
+            method: method_name,
+            source: 'Active Record'
+          }
+        elsif !klass_method && dangerous_attribute_method?(method_name)
+          raise ArgumentError, ENUM_HUMANIZABLE_CONFLICT_MESSAGE % {
+            enum: enum_name,
+            klass: self.name,
+            type: 'instance',
+            method: method_name,
+            source: 'Active Record'
+          }
+        elsif klass_method && respond_to?(method_name)
+          raise ArgumentError, ENUM_HUMANIZABLE_CONFLICT_MESSAGE % {
+            enum: enum_name,
+            klass: self.name,
+            type: 'class',
+            method: method_name,
+            source: 'another humanized enum'
+          }
+        elsif !klass_method && method_defined?(method_name)
+          raise ArgumentError, ENUM_HUMANIZABLE_CONFLICT_MESSAGE % {
+            enum: enum_name,
+            klass: self.name,
+            type: 'instance',
+            method: method_name,
+            source: 'another humanized enum'
+          }
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActiveRecord::HumanizedEnum
+end

data/lib/active_record/humanized_enum/version.rb

@@ -0,0 +1,10 @@
+module ActiveRecord
+  module HumanizedEnum
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: active_record-humanized_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dhyego Fernando
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily translate your ActiveRecord's enums.
+email:
+- dhyegofernando@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_record-humanized_enum.gemspec
+- lib/active_record/humanized_enum.rb
+- lib/active_record/humanized_enum/version.rb
+homepage: http://github.com/dhyegofernando/active_record-humanized_enum
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Easily translate your ActiveRecord's enums.
+test_files: []