translate_enum 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '0458034e29b34aa38f6ef31d4953f49b251c64d7'
+  data.tar.gz: 0fba5acb5a6f1ab53d84cd3fd16c43de285c34a5
+SHA512:
+  metadata.gz: f98032ffc41ba60eabea064af70fa58c083665bf1378379f79e4ff1a5db9a21554ace3b74290962085f34019879cc9f2602d6d2fc1c8b5098d532c8d44ee05ef
+  data.tar.gz: f32895d7d47d84777a602cbb381866f463de14b90852ab7119ab9b9add9a6bad58af105236f4e31d7f9e86721ba08bf862f43699c0e954f025a88735b6e25b70

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/README.md

@@ -0,0 +1,90 @@
+[![Build Status](https://semaphoreci.com/api/v1/shlima/translate_enum/branches/master/shields_badge.svg)](https://semaphoreci.com/shlima/translate_enum)
+[![Code Climate](https://codeclimate.com/github/shlima/translate_enum/badges/gpa.svg)](https://codeclimate.com/github/shlima/translate_enum)
+
+# TranslateEnum
+
+Simple, zero-dependant `enum` translation gem for Rails
+
+## Installation
+
+`gem install translate_enum`
+
+## Usage
+
+Here is a regular use case. ActiveRecord model:
+
+```ruby
+class Post < ActiveRecord::Base
+  include TranslateEnum
+  
+  enum status: { published: 0, archive: 1 }
+  translate_enum :status
+end
+```
+
+Localization file
+
+```yaml
+en:
+  activerecord:
+    attributes:
+      post:
+        status_list:
+          published: Was published
+          archive: Was achieved
+```
+
+```ruby
+Post.translated_status(:published) #=> "Was published"
+Post.translated_statuses => [["Was published", :published, 0], ["Was achieved", :archive, 1]]
+
+@post = Post.new(status: :published)
+@post.translated_status #=> "Was published"
+```
+
+### Use in a Form
+
+```haml
+= form_for @post do |f|
+  = f.select :status, options_for_select(f.object.translated_statuses.map { |translation, k, _v| [translation, k] })
+```
+
+## Extending ActiveRecord
+
+Be default you should extend each `ActiveRecord` model manually by including `TranslateEnum` module in it.
+You can extend `ActiveRecord` by requiring `translate_enum/active_record` in initializer or inside yout `Gemfile`:
+
+Gemfile:
+
+```ruby
+gem 'translate_enum', require: 'translate_enum/active_record'
+```
+
+Initializer:
+
+```ruby
+# config/initializers/translate_enum.rb
+require 'translate_enum/active_record'
+```
+
+## Advanced options
+
+```ruby
+class User < ActiveRecord::Base
+  enum gender: [:male, :female]
+  
+  translate_enum :gender do |tr|
+    tr.i18n_scope = 'activerecord.attributes'
+    tr.i18n_key = 'gender_list'
+    tr.enum_klass_method_name = 'genders'
+    tr.enum_instance_method_name = 'gender'
+    tr.method_name_singular = 'translated_gender'
+    tr.method_name_plural = 'translated_genders'
+  end
+  
+  # Or even provide your own logic
+  def self.translated_gender(key)
+    I18n.t(key, scope: 'global.gender_list')
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "translate_enum"
+
+# 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/translate_enum.rb

@@ -0,0 +1,46 @@
+require 'active_support/concern'
+require 'active_support/core_ext/string'
+require 'translate_enum/version'
+require 'translate_enum/builder'
+
+module TranslateEnum
+  extend ActiveSupport::Concern
+
+  # include TranslateEnum in ActiveModel or ActiveRecord
+  module ClassMethods
+    # @example
+    #   class User < ActiveRecord::Base
+    #     include TranslateEnum
+    #     enum status: %i(active archived)
+    #     translate_enum :status
+    #   end
+    #
+    #   User.translated_status(:active) #=> "Active translation"
+    def translate_enum(attribute, &block)
+      builder = Builder.new(self, attribute, &block)
+
+      # User.translated_status(:active)
+      define_singleton_method(builder.method_name_singular) do |key|
+        I18n.translate(builder.i18n_location(key), scope: builder.i18n_scope)
+      end
+
+      # @return [Array]
+      # @example
+      #   f.select_field :gender, f.object.class.translated_genders
+      define_singleton_method(builder.method_name_plural) do
+        public_send(builder.enum_klass_method_name).map do |key, value|
+          [public_send(builder.method_name_singular, key), key, value]
+        end
+      end
+
+      # @return [String]
+      # @example
+      #   @user.translated_gender
+      define_method(builder.method_name_singular) do
+        if (key = public_send(builder.enum_instance_method_name)).present?
+          self.class.public_send(builder.method_name_singular, key)
+        end
+      end
+    end
+  end
+end

data/lib/translate_enum/active_record.rb

@@ -0,0 +1,11 @@
+# Require this fle in order to be +TranslateEnum+ included in +ActiveRecord::Base+
+# @example
+#   require 'translate_enum/active_record'
+
+require_relative '../translate_enum'
+
+unless defined?(ActiveRecord::Base)
+  raise NameError, 'TranslateEnum requires ActiveRecord be defined but it is not'
+end
+
+ActiveRecord::Base.include(TranslateEnum)

data/lib/translate_enum/builder.rb

@@ -0,0 +1,55 @@
+module TranslateEnum
+  class Builder
+    attr_accessor :i18n_scope
+    attr_accessor :i18n_key
+
+    attr_accessor :enum_instance_method_name
+    attr_accessor :enum_klass_method_name
+
+    attr_accessor :method_name_singular
+    attr_accessor :method_name_plural
+
+    attr_reader :model, :attribute
+
+    # @param model [ActiveModel::Model, ActiveRecord::Base]
+    # @param attribute [String]
+    def initialize(model, attribute)
+      @model = model
+      @attribute = attribute
+      yield(self) if block_given?
+    end
+
+    # like "activerecord.attributes" or "activemodel.attributes"
+    def i18n_scope
+      @i18n_scope ||= "#{model.i18n_scope}.attributes"
+    end
+
+    def i18n_key
+      @i18n_key ||= "#{attribute}_list"
+    end
+
+    def i18n_location(key)
+      "#{model.model_name.i18n_key}.#{i18n_key}.#{key}"
+    end
+
+    # @param [String]
+    # like "translated_genders"
+    def method_name_plural
+      @method_name_plural ||= "translated_#{attribute.to_s.pluralize}"
+    end
+
+    # @param [String]
+    # like "translated_gender"
+    def method_name_singular
+      @method_name_singular ||= "translated_#{attribute.to_s.singularize}"
+    end
+
+    def enum_klass_method_name
+      @enum_klass_method_name ||= attribute.to_s.pluralize
+    end
+
+    def enum_instance_method_name
+      @enum_instance_method_name ||= attribute
+    end
+  end
+end

data/lib/translate_enum/version.rb

@@ -0,0 +1,3 @@
+module TranslateEnum
+  VERSION = '0.1.1'
+end

data/translate_enum.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'translate_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'translate_enum'
+  spec.version       = TranslateEnum::VERSION
+  spec.authors       = ['Aliaksandr Shylau']
+  spec.email         = ['alex.shilov.by@gmail.com']
+  spec.summary       = 'Rails translate enum'
+  spec.description   = 'Simple, zero-dependant enum translation gem for Rails'
+  spec.homepage      = 'https://github.com/shlima/translate_enum'
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency 'activesupport'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'activemodel'
+  spec.add_development_dependency 'actionview'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: translate_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Aliaksandr Shylau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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: rspec
+  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: activemodel
+  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: actionview
+  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: Simple, zero-dependant enum translation gem for Rails
+email:
+- alex.shilov.by@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/translate_enum.rb
+- lib/translate_enum/active_record.rb
+- lib/translate_enum/builder.rb
+- lib/translate_enum/version.rb
+- translate_enum.gemspec
+homepage: https://github.com/shlima/translate_enum
+licenses: []
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Rails translate enum
+test_files: []