enum_translatable 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd16932b5577e7f652b6bd3df5ec1a4c33887fee194e645b9afad50056f05cc5
+  data.tar.gz: 4727e1bcef752b1ca495fab4c942b4ebf0d51569af7a0af2c748515e2ee00d11
+SHA512:
+  metadata.gz: d2aedc8343a18e9ba28b492b165b8330cc0ca55d457e8320dd1e3b731632ace316ba49f154ac0eb2275a5e657465b359da33ad14c5f1fdd6f49a05f1a7a0abb6
+  data.tar.gz: 7d6126dbfa7fa8672dc428503284c33c88014744745e60708cf172555045f78e8ab586a0f433759e3d7c985f78b895a4c659c02edd65b88b557321fbbddc04d1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+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 enum_translatable.gemspec
+gemspec
+
+gem "rake", ">= 0.8.7"
+gem "rspec", ">= 3.0"
+gem 'globalize', '~> 5.3.0'

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    enum_translatable (0.1.3)
+      globalize
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      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)
+    diff-lcs (1.4.4)
+    globalize (5.3.0)
+      activemodel (>= 4.2, < 6.1)
+      activerecord (>= 4.2, < 6.1)
+      request_store (~> 1.0)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.3)
+    rack (2.2.3)
+    rake (13.0.3)
+    request_store (1.5.0)
+      rack (>= 1.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  enum_translatable!
+  globalize (~> 5.3.0)
+  rake (>= 0.8.7)
+  rspec (>= 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 mohamedmmahfouz
+
+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,114 @@
+# EnumTranslatable
+
+A simple Gem that translates ruby on rails enums in a similar manner to I18n globalize gem.
+
+## Installation
+Make sure you add globalize gem https://github.com/globalize/globalize
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enum_translatable', '~> 0.1.1'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install enum_translatable
+
+## Usage
+
+
+The Gem will some methods into your selected model similar to what globalize gem adds to a translated field.
+for example if we have the following class
+````ruby
+class Order  < ApplicationRecord
+    enum status:{
+        pending: 0,
+        canceled: 1,
+        approved: 2,
+    }
+end
+````
+
+by adding the following
+````ruby
+class Order  < ApplicationRecord
+    enum status:{
+        pending: 0,
+        canceled: 1,
+        approved: 2,
+    }
+    include EnumTranslatable ##this has to be added after the last enum defined in your model which needs to be translated
+    #Note: Adding this line will translate ALL the enums defined above it.
+end
+````
+Then adding the translations in your local.yml
+````yml
+#en.yml
+en:
+  activerecord:
+    enum_translatable:
+      order:
+        status:
+          canceled: "canceled"
+          pending: "pending"
+          approved: "approved"
+````
+````yml
+#ar.yml
+ar:
+  activerecord:
+    enum_translatable:
+      order:
+        status:
+          canceled: "canceled in arabic"
+          pending: "pending in arabic"
+          approved: "approved in arabic"
+````
+````yml
+#es.yml
+es:
+  activerecord:
+    enum_translatable:
+      order:
+        status:
+          canceled: "canceled in spanish"
+          pending: "pending in spanish"
+          approved: "approved in spanish"
+````
+it will add the following methods
+
+````ruby
+order = Order.first
+order.status # => "canceled"
+order.translated_status # => "canceled"
+order.status_en # => "canceled"
+order.status_ar # => "canceled in arabic"
+order.status_es # => "canceled in spanish"
+I18.locale = :ar
+Order.translated_status = "canceled in arabic"
+````
+
+Make sure to add the locales you want to use, other wise you will have a method for each I18n locale which is unecessary
+````ruby
+# in config/initializer/locale.rb
+I18n.available_locales = [:ar, :es, :en]
+````
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/enum_translatable.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,28 @@
+require_relative 'lib/enum_translatable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enum_translatable"
+  spec.version       = EnumTranslatable::VERSION
+  spec.authors       = ["mohamedmmahfouz"]
+  spec.email         = ["mohamedmmahfouz24@gmail.com"]
+
+  spec.summary       = %q{Gem for translating enums with i18n.}
+  spec.description   = %q{ROR gem which to translate enums just like I18n Globalize gem}
+  spec.homepage      = "https://github.com/MohamedMMahfouz/enum_translatable"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "https://github.com/MohamedMMahfouz/enum_translatable"
+
+  # 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 "globalize"
+end

data/lib/enum_translatable.rb

@@ -0,0 +1,24 @@
+require "enum_translatable/version"
+require 'active_support/concern'
+
+module EnumTranslatable
+  extend ActiveSupport::Concern
+
+  included do
+    defined_enums.keys.each do |key|
+      define_method :"#{key}" do
+        enum_value = self[:"#{key}"]
+        return nil unless enum_value.present?
+        I18n.t("activerecord.enum_translatable.#{model_name.singular}.#{key}.#{enum_value}", default: enum_value)
+      end
+
+      I18n.available_locales.each do |locale|
+        define_method :"#{key}_#{locale}" do
+          I18n.with_locale(locale) do
+            send("#{key}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enum_translatable/version.rb

@@ -0,0 +1,3 @@
+module EnumTranslatable
+  VERSION = "0.1.3"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: enum_translatable
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- mohamedmmahfouz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: globalize
+  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: ROR gem which to translate enums just like I18n Globalize gem
+email:
+- mohamedmmahfouz24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enum_translatable-0.1.1.gem
+- enum_translatable-0.1.2.gem
+- enum_translatable.gemspec
+- lib/enum_translatable.rb
+- lib/enum_translatable/version.rb
+homepage: https://github.com/MohamedMMahfouz/enum_translatable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MohamedMMahfouz/enum_translatable
+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.2
+signing_key: 
+specification_version: 4
+summary: Gem for translating enums with i18n.
+test_files: []