acts_enum_translable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7466fd38a12ebb2684ef2cc7bd23ec0e03510078
+  data.tar.gz: 60c2786969fe6e2a5c2a91e14e015c0e44b46803
+SHA512:
+  metadata.gz: 1ba611948912654dddfe9097d22e8d385055c3b842ac797acba22f09da3d40b2d1317ead7f39f2f76367d9030e8f19645214b66d07bbf814270b771f8c8657e8
+  data.tar.gz: 627d4752ab6b972589ef21ef0e963aad8e5e08f52879dcc2ca17e63c21ecaeadf960cfa1980613d1dfddfac2a3a270e90201a1b053b1afb1364e7d0a9fc9a545

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Thadeu Esteves Jr
+
+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,154 @@
+# ActsEnumTranslable
+ActsEnumTranslable convention translate enums with .yml file.
+
+## Usage
+* Install Gem
+* Configure enum native Rails
+* Add acts_enum_translable in Model class
+* Configure active_record attributes in file .yml
+* Use methods
+
+## Install Gem for Ruby on Rails
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_enum_translable'
+```
+
+After:
+```bash
+$ bundle install
+```
+
+## Configure enum native Rails
+More details, please visit [ActiveRecord::Enum](http://api.rubyonrails.org/classes/ActiveRecord/Enum.html)
+
+```ruby
+# example model
+# user.rb
+
+class User < ApplicationRecord
+  enum status: { inactive: 0, active: 1, blocked: 2 }
+  enum visible: [:hide, :show]
+end
+```
+## Add acts_enum_translable in Model class
+
+Add in Model for inherit methods
+
+```ruby
+# exemple model
+# user.rb
+
+class User < ApplicationRecord
+  enum status: { inactive: 0, active: 1, blocked: 2 }
+  enum visible: [:hide, :show]
+
+  # Add in Model for inherit methods
+  acts_enum_translable
+end
+```
+
+## Configure active_record attributes in file .yml
+
+More details, please visit section [4.5 Translations for Active Record Models](http://guides.rubyonrails.org/i18n.html#translations-for-active-record-models)
+
+Configure *Locale English* for exemple
+
+```ruby
+# config/locales/en.activerecord.yml
+en:
+  activerecord:
+    attributes:
+      users:
+        status:
+          inactive: "Inactive"
+          active: "Active"
+          blocked: "Blocked"
+        visible:
+          hide: 'Hide'
+          show: 'Show'
+```
+
+Configure *Locale Portuguese* for exemple
+
+```ruby
+# config/locales/pt.activerecord.yml
+pt:
+  activerecord:
+    attributes:
+      users:
+        status:
+          inactive: "Inativo"
+          active: "Ativo"
+          blocked: "Bloqueado"
+        visible:
+          hide: 'Oculto'
+          show: 'Visível'
+```
+
+## Use methods sufix with _translable for enums key
+```ruby
+# print status
+user = User.new(status: :blocked, visible: :show)
+user.status_translable
+# english: Blocked
+# portuguese: Bloqueado
+
+# print visible
+user.visible_translable
+# english: Show
+# portuguese: Visível
+```
+
+## Use methods in Model class get enums for key
+
+_Required key param._
+
+```ruby
+# return Array with Values
+# in english
+# I18n.locale = :en
+User.enum_list(:status)
+# => ["Inactive", "Active", "Blocked"]
+
+# in portuguese
+# I18n.locale = :pt
+User.enum_list(:status)
+# => ["Inativo", "Ativo", "Bloqueado"]
+```
+
+Now return array with values and keys or reverse
+
+```ruby
+# return Arrary with par [value, key]
+# in english
+# I18n.locale = :en
+User.enum_with_keys(:status)
+# => [["Inactive", 0], ["Active", 1], ["Blocked", 2]]
+
+# in portuguese
+# I18n.locale = :pt
+User.enum_with_keys(:status)
+# => [["Inativo", 0], ["Ativo", 1], ["Bloqueado", 2]]
+
+# return par array [key, value]
+User.enum_form(:status)
+# => [[0, "Inativo"], [1, "Ativo"], [2, "Bloqueado"]]
+```
+
+### Use SimpleForm too
+
+Easy return enums translated.
+
+```ruby
+# with I18n.locale = :pt or :en
+<%= f.select :status, User.enum_form(:status), include_blank: true %>
+```
+
+## Contributing
+
+We have a long list of valued contributors. Check them all at: https://github.com/Thadeu/acts_enum_translable.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsEnumTranslable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/acts_enum_translable.rb

@@ -0,0 +1,8 @@
+require 'acts_enum_translable/support/runtime_error'
+require 'acts_enum_translable/support/i18n'
+require 'acts_enum_translable/active_model/model'
+require 'acts_enum_translable/active_model/concern'
+require 'acts_enum_translable/engine'
+
+module ActsEnumTranslable
+end

data/lib/acts_enum_translable/active_model/concern.rb

@@ -0,0 +1,42 @@
+# @author Thadeu Esteves
+module ActsEnumTranslable
+  # ActiveModel
+  module ActiveModel
+    # Concern for ActiveModel
+    module Concern
+      extend ActiveSupport::Concern
+      include ActsEnumTranslable::ActiveModel::Model
+
+      module ClassMethods
+        # Pega o nome da class corrente, verifica se tem enums
+        # e cria os metodos em tempo de execucao
+        # == Returns:
+        # @return [Method] method_translable
+        def acts_enum_translable(options = {})
+          cattr_accessor :class_name
+          klass = (options[:class_name] || self)
+          add_runtime_methods(klass) if klass.defined_enums?
+        end
+
+        private
+
+        # Cria metodos em tempo de execucao com sufixo _translable
+        #
+        # == Parameters:
+        # @param klass [Array] recebe um array com os enums definidos em uma class/model
+        #
+        # == Returns:
+        # @return [Method] retorna methods com sufixo _translable baseados nas keys dos enums
+        def add_runtime_methods(klass)
+          klass.defined_enums.keys.each do |enum_key|
+            define_method :"#{enum_key}_translable" do
+              trans_key = self.class.i18n_key(enum_key, send(enum_key))
+              return I18n.t(trans_key, locale: I18n.locale) if I18n.exists? trans_key
+              return send(enum_key).humanize
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acts_enum_translable/active_model/model.rb

@@ -0,0 +1,72 @@
+# @author Thadeu Esteves
+module ActsEnumTranslable
+  module ActiveModel
+    module Model
+      extend ActiveSupport::Concern
+
+      included do
+        extend ActsEnumTranslable::Support::RuntimeError
+        extend ActsEnumTranslable::Support::I18n
+        # Busca todos os enums do model corrente
+        # @return [Array] ["Nao Realizado", "Realizado", "Arquivado"]
+        def self.enum_list(enum_key = nil)
+          # runtime_error exception
+          runtime_error enum_key
+          defined_enums[enum_key.to_s].map do |enum|
+            trans_key = i18n_key(enum_key, enum.first)
+            # procura nos arquivo de traducao
+            # caso nao encontre humanize o proprio enum
+            if I18n.exists? trans_key
+              I18n.t(trans_key, locale: I18n.locale)
+            else
+              # original key
+              enum.first.humanize
+            end
+          end
+        end
+
+        # Busca todos os metodos do model corrente
+        #
+        # @return [Array] [["Nao Realizado", 0], ["Realizado", 1], ["Arquivado", 2]]
+        def self.enum_with_keys(enum_key = nil)
+          # runtime_error exception
+          runtime_error enum_key
+
+          defined_enums[enum_key.to_s].map do |enum|
+            original_key = enum.first.humanize
+            trans_key = i18n_key(enum_key, enum.first)
+
+            # procura nos arquivo de traducao
+            # caso nao encontre humanize o proprio enum
+            if I18n.exists? trans_key
+              [I18n.t(trans_key, locale: I18n.locale), enum.second]
+            else
+              [original_key, enum.second]
+            end
+          end
+        end
+
+        # Use with radio simple_form
+        #
+        # @return [Array] [["Nao Realizado", 0], ["Realizado", 1], ["Arquivado", 2]]
+        def self.enum_form(enum_key = nil)
+          # runtime_error exception
+          runtime_error enum_key
+
+          defined_enums[enum_key.to_s].map do |enum|
+            original_key = enum.first.humanize
+            trans_key = i18n_key(enum_key, enum.first)
+
+            # procura nos arquivo de traducao
+            # caso nao encontre humanize o proprio enum
+            if I18n.exists? trans_key
+              [enum.second, I18n.t(trans_key, locale: I18n.locale)]
+            else
+              [enum.second, original_key]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acts_enum_translable/engine.rb

@@ -0,0 +1,7 @@
+module ActsEnumTranslable
+  module Engine
+    ActiveSupport.on_load :active_record do
+      ActiveRecord::Base.send :include, ActsEnumTranslable::ActiveModel::Concern
+    end
+  end
+end

data/lib/acts_enum_translable/support/i18n.rb

@@ -0,0 +1,13 @@
+# @author Thadeu Esteves
+module ActsEnumTranslable
+  module Support
+    module I18n
+      # based in translations for active record models
+      # http://guides.rubyonrails.org/i18n.html#translations-for-active-record-models
+      # @return [String] activerecord.attributes.model_name.attribute_name.field_name
+      def i18n_key(i18n_key, key)
+        "activerecord.attributes.#{name.underscore.pluralize}.#{i18n_key}.#{key}"
+      end
+    end
+  end
+end

data/lib/acts_enum_translable/support/runtime_error.rb

@@ -0,0 +1,14 @@
+# @author Thadeu Esteves
+module ActsEnumTranslable
+  module Support
+    module RuntimeError
+      # Exception Method
+      # TODO: We need improve method
+      # @return [Exception] Enum key required for translation enums
+      def runtime_error(enum_key)
+        return raise 'Enum key required for translation enums' unless enum_key.present?
+        return raise 'Enum key must be type symbol' unless enum_key.class == Symbol
+      end
+    end
+  end
+end

data/lib/acts_enum_translable/version.rb

@@ -0,0 +1,3 @@
+module ActsEnumTranslable
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: acts_enum_translable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thadeu Esteves Jr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: sqlite3
+  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: 'ActsEnumTranslable convention translate enums with .yml file. '
+email:
+- tadeuu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/acts_enum_translable.rb
+- lib/acts_enum_translable/active_model/concern.rb
+- lib/acts_enum_translable/active_model/model.rb
+- lib/acts_enum_translable/engine.rb
+- lib/acts_enum_translable/support/i18n.rb
+- lib/acts_enum_translable/support/runtime_error.rb
+- lib/acts_enum_translable/version.rb
+homepage: http://github.com/thadeu/acts_enum_translable
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveRecord::Enum Translate with i18n
+test_files: []