lost_in_translations_temp 1.4.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5fd582680517c1d790b2eb872fc08781540be63
+  data.tar.gz: ab6661e9fe1fdf23c944234506d35f66c579d9d4
+SHA512:
+  metadata.gz: cde2d1caded6e0c4d2bcb2877d60d0c35400c8d3ef2000b5dfeae5a9d7639371b4b8bc43dc99f91f536814a156e2ef0c75efbd8cb0e4714fd44b389307ff9ed9
+  data.tar.gz: 3e5680d8bf25ed39fbb0b90f502ff440578e0e1b70bc4ff28daaa9e7dd699ff4ee851d34e7f54c79ff4bdb9b9c51e20a85b7d5dd24127d244965f9e94d276b83

data/README.md

@@ -0,0 +1,217 @@
+# Lost In Translations
+Super light Translation Ruby Gem agnostic to your framework and source data
+
+[![Code Climate](https://codeclimate.com/github/Streetbees/lost-in-translations/badges/gpa.svg)](https://codeclimate.com/github/Streetbees/lost-in-translations)
+[![Test Coverage](https://codeclimate.com/github/Streetbees/lost-in-translations/badges/coverage.svg)](https://codeclimate.com/github/Streetbees/lost-in-translations/coverage)
+[![Build Status](https://travis-ci.org/Streetbees/lost-in-translations.svg?branch=master)](https://travis-ci.org/Streetbees/lost-in-translations)
+[![Gem Version](https://badge.fury.io/rb/lost_in_translations.svg)](https://badge.fury.io/rb/lost_in_translations)
+
+## 1) Basic Usage
+```ruby
+class User < Struct.new(:title, :first_name, :last_name)
+  include LostInTranslations
+
+  translate :title, :first_name
+
+  def translation_data
+    @translation_data ||= {
+      en: { first_name: 'Jon', last_name: 'Snow' },
+      fr: { first_name: 'Jean', last_name: 'Neige' }
+    }
+  end
+end
+```
+Class method ```.translate``` will redefine ```#title``` and ```#first_name``` instance methods in order to return the values that match the ```I18n.locale``` and the ```attribute name``` from the Hash returned by ```#translation_data```.
+
+```ruby
+@user = User.new('Cavaleiro', 'Joao', 'Neve')
+
+I18n.default_locale = :pt
+I18n.locale = :fr
+
+@user.first_name # returns 'Jean'
+@user.last_name # returns 'Neve'
+@user.title # returns nil
+
+I18n.with_locale(:en) do
+  @user.first_name # returns 'Jon'
+  @user.last_name # returns 'Neve'
+  @user.title # returns nil
+end
+
+I18n.with_locale(:pt) do
+  # there is no translation present but since locale
+  # matches the default_locale, the original value is returned
+
+  @user.first_name # returns 'Joao'
+  @user.last_name # returns 'Neve'
+  @user.title # returns 'Cavaleiro'
+end
+
+I18n.with_locale(:de) do
+  @user.first_name # returns nil
+  @user.last_name # returns 'Neve'
+  @user.title # returns nil
+end
+```
+
+The following instance methods are also available:
+#### 1.1) ```#translate```
+```ruby
+@user.translate(:first_name, :fr) # returns 'Jean'
+@user.translate(:first_name, :en) # returns 'Jon'
+@user.translate(:first_name, :pt) # returns 'Joao'
+@user.translate(:first_name, :de) # returns nil
+```
+
+#### 1.2) ```#<I18n.available_locales>_<translated_field>```
+```ruby
+@user.fr_first_name # returns 'Jean'
+@user.en_first_name # returns 'Jon'
+@user.pt_first_name # returns 'Joao'
+@user.de_first_name # returns nil
+```
+
+#### 1.3) ```#<I18n.available_locales>_<translated_field>=```
+```ruby
+@user.pt_first_name = 'João'
+@user.de_first_name = 'Hans'
+
+@user.translation_data  # will contain
+                        # {
+                        #   en: { first_name: 'Jon', last_name: 'Snow' },
+                        #   pt: { first_name: 'João' },
+                        #   de: { first_name: 'Hans' },
+                        #   fr: { first_name: 'Jean', last_name: 'Neige' }
+                        # }
+```
+
+## 2) Ideal usage
+If your ActiveRecord Model has a json attribute called ```translation_data```.
+```ruby
+class CreateUsers < ActiveRecord::Migration
+  def up
+    create_table :users do |t|
+      t.string :title
+      t.string :first_name
+      t.string :last_name
+      t.jsonb :translation_data
+      t.timestamps
+    end
+
+    User.create \
+      title: 'Cavaleiro',
+      first_name: 'Joao',
+      last_name: 'Neve',
+      translation_data: {
+        en: { first_name: 'Jon', last_name: 'Snow' },
+        fr: { first_name: 'Jean', last_name: 'Neige' }
+      }
+  end
+end
+```
+
+The usage becomes quite simple.
+```ruby
+class User < ActiveRecord::Base
+  include LostInTranslations
+
+  translate :title, :first_name
+end
+
+@user = User.find(1)
+
+I18n.locale = :fr
+
+@user.first_name # returns 'Jean'
+@user.last_name # returns 'Neve'
+@user.title # returns nil
+```
+
+## 3) Forcing locales
+
+There are many cases when you'll need to translate only a part of your data,
+specially if this part is returned in a list of translated data.
+
+For those cases you only have to define the field (virtual or persisted)
+`force_locale` with one valid locale:
+
+```ruby
+class User < ActiveRecord::Base
+  include LostInTranslations
+
+  translate :title, :first_name
+end
+
+User.create(
+  title: 'Cavaleiro',
+  first_name: 'Joao',
+  last_name: 'Neve',
+  force_locale: nil,
+  translation_data: {
+    en: { first_name: 'Jon', last_name: 'Snow' },
+    fr: { first_name: 'Jean', last_name: 'Neige' }
+  }
+)
+
+User.create(
+  title: 'Cavaleiro',
+  first_name: 'Joao',
+  last_name: 'Neve',
+  force_locale: 'fr'
+  translation_data: {
+    en: { first_name: 'Jon', last_name: 'Snow' },
+    fr: { first_name: 'Jean', last_name: 'Neige' }
+  }
+)
+
+User.create(
+  title: 'Cavaleiro',
+  first_name: 'Joao',
+  last_name: 'Neve',
+  force_locale: 'en'
+  translation_data: {
+    en: { first_name: 'Jon', last_name: 'Snow' },
+    fr: { first_name: 'Jean', last_name: 'Neige' }
+  }
+)
+
+I18n.locale = :pt
+
+User.all.each do |user|
+  puts user.name
+end
+
+# It'll automatically output:
+# Joao
+# Jean
+# Jon
+
+```
+
+
+## 4) Instalation
+
+Add this to your Gemfile:
+```
+gem 'lost_in_translations'
+```
+
+And then execute:
+
+```
+$> bundle install
+```
+
+In Rails, create the file **config/initializers/lost_in_translations.rb** with:
+```ruby
+LostInTranslations.reload
+```
+Because Rails starts with a set of **I18n.available_locales** different from when it finished loading and **LostInTranslations** needs to redefine new methods for those new locales in your classes.
+
+## 5) F.A.Q.
+
+- [I18n.available_locales as changed, how do I recreate the new translation methods?](https://github.com/Streetbees/lost-in-translations/wiki/Redefining-translation-methods)
+- [Your "translation_data" method (in all of your objects) is not called "translation_data"](https://github.com/Streetbees/lost-in-translations/wiki/translation_data-configuration-version-1)
+- [Your "translation_data" method (in a particular object) is not called "translation_data"](https://github.com/Streetbees/lost-in-translations/wiki/translation_data-configuration-version-2)
+- [Custom translation mechanism](https://github.com/Streetbees/lost-in-translations/wiki/Custom-translation-mechanism)

data/lib/lost_in_translations.rb

@@ -0,0 +1,85 @@
+require 'i18n'
+require 'lost_in_translations/base'
+require 'lost_in_translations/ruby'
+require 'lost_in_translations/config'
+require 'lost_in_translations/active_record'
+require 'lost_in_translations/translator/base'
+
+module LostInTranslations
+  def self.included(base_class)
+    if defined?(::ActiveRecord::Base) &&
+       base_class.ancestors.include?(::ActiveRecord::Base)
+      base_class.send(:include, LostInTranslations::ActiveRecord)
+    else
+      base_class.send(:include, Ruby)
+    end
+  end
+
+  def self.config
+    @config ||= Config.new(
+      'translation_data',
+      Translator::Base,
+      nil,
+      'force_locale'
+    )
+  end
+
+  def self.translate(*args)
+    config.translator.translate(*args)
+  end
+
+  def self.assign_translation(*args)
+    config.translator.assign_translation(*args)
+  end
+
+  def self.translation_data(object)
+    config.translator.translation_data(object)
+  end
+
+  def self.define_translation_methods(object, *fields)
+    fields.each do |field|
+      define_dynamic_translation_method(object, field)
+      define_particular_translation_methods(object, field)
+    end
+  end
+
+  def self.define_dynamic_translation_method(object, method_name)
+    object.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{method_name}
+        translate(:#{method_name}, I18n.locale)
+      end
+    RUBY
+  end
+
+  def self.define_particular_translation_methods(object, attribute)
+    I18n.available_locales.each do |locale|
+      method_name = "#{locale.to_s.downcase.tr('-', '_')}_#{attribute}"
+
+      define_translation_method(object, method_name, attribute, locale)
+    end
+  end
+
+  def self.define_translation_method(object, method_name, attribute, locale)
+    object.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{method_name}
+        translate(:#{attribute}, :'#{locale}')
+      end
+
+      def #{method_name}=(value)
+        assign_translation(:#{attribute}, value, :'#{locale}')
+      end
+    RUBY
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  def self.infected_classes
+    @infected_classes ||= []
+  end
+
+  def self.reload
+    infected_classes.each(&:define_translation_methods)
+  end
+end

data/lib/lost_in_translations/active_record.rb

@@ -0,0 +1,18 @@
+module LostInTranslations
+  module ActiveRecord
+    def self.included(base_class)
+      base_class.send(:include, Base)
+      base_class.extend ClassMethods
+    end
+
+    def call_original_field(object, field)
+      object.read_attribute(field)
+    end
+
+    module ClassMethods
+      def define_translation_methods
+        LostInTranslations.define_translation_methods self, *translation_fields
+      end
+    end
+  end
+end

data/lib/lost_in_translations/base.rb

@@ -0,0 +1,53 @@
+module LostInTranslations
+  module Base
+    def self.included(base_class)
+      LostInTranslations.infected_classes.push(base_class)
+
+      base_class.extend ClassMethods
+    end
+
+    def translate(field, locale = I18n.locale)
+      translation = LostInTranslations.translate(self, field, locale)
+
+      if translation.nil? && fallback_to_default_locale(locale)
+        translation = call_original_field(self, field)
+      end
+
+      translation
+    end
+
+    def assign_translation(field, value, locale = I18n.locale)
+      LostInTranslations.assign_translation(self, field, value, locale)
+    end
+
+    def fallback_to_default_locale(locale)
+      LostInTranslations.config.fallback_to_default_locale ||
+        locale.to_sym == I18n.default_locale.to_sym
+    end
+
+    module ClassMethods
+      attr_writer :translation_data_field
+      attr_writer :force_locale_field
+
+      def translation_data_field
+        @translation_data_field ||
+          LostInTranslations.config.translation_data_field
+      end
+
+      def force_locale_field
+        @force_locale_field ||
+          LostInTranslations.config.force_locale_field
+      end
+
+      def translation_fields
+        @translation_fields ||= []
+      end
+
+      def translate(*fields)
+        translation_fields.concat(fields)
+
+        define_translation_methods
+      end
+    end
+  end
+end

data/lib/lost_in_translations/config.rb

@@ -0,0 +1,5 @@
+module LostInTranslations
+  Config = Struct.new \
+    :translation_data_field, :translator, :fallback_to_default_locale,
+    :force_locale_field
+end

data/lib/lost_in_translations/ruby.rb

@@ -0,0 +1,34 @@
+module LostInTranslations
+  module Ruby
+    def self.included(base_class)
+      base_class.send(:include, Base)
+      base_class.extend ClassMethods
+    end
+
+    def call_original_field(object, field)
+      method_name = Ruby.original_field_name(field)
+
+      return object.send(field) unless object.respond_to?(method_name)
+
+      object.send(method_name)
+    end
+
+    def self.original_field_name(field)
+      "original_field_#{field}".to_sym
+    end
+
+    module ClassMethods
+      def define_translation_methods
+        translation_fields.each do |field|
+          next if instance_methods.include?(Ruby.original_field_name(field))
+
+          class_eval do
+            alias_method Ruby.original_field_name(field), field.to_sym
+          end
+        end
+
+        LostInTranslations.define_translation_methods self, *translation_fields
+      end
+    end
+  end
+end

data/lib/lost_in_translations/translator/base.rb

@@ -0,0 +1,61 @@
+module LostInTranslations
+  module Translator
+    class Base
+      def self.translate(object, field, original_locale)
+        locale = check_forcing_locale(object, original_locale)
+
+        data = translation_data(object)
+
+        translations = data[locale.to_sym] || data[locale.to_s] || {}
+
+        translations[field.to_sym] || translations[field.to_s]
+      end
+
+      def self.assign_translation(object, field, value, locale)
+        data = translation_data(object)
+
+        translations = data[locale.to_sym] || data[locale.to_s]
+
+        translations ||= data[locale.to_sym] = {}
+
+        translations[field.to_sym] = value
+      end
+
+      def self.translation_data(object)
+        translation_data_field = translation_data_field(object)
+
+        data = object.send(translation_data_field)
+
+        if data.nil? && object.respond_to?("#{translation_data_field}=")
+          data = object.send("#{translation_data_field}=", {})
+        end
+
+        data
+      end
+
+      def self.translation_data_field(object)
+        translation_data_field = object.class.translation_data_field
+
+        unless object.respond_to?(translation_data_field)
+          raise \
+            NotImplementedError,
+            "#{object.class.name} does not implement .#{translation_data_field}"
+        end
+
+        translation_data_field
+      end
+
+      def self.check_forcing_locale(object, locale)
+        force_locale_field = object.class.force_locale_field
+
+        if object.respond_to?(force_locale_field)
+          force_locale = object.send(force_locale_field)
+
+          return force_locale unless force_locale.to_s.length < 2
+        end
+
+        locale
+      end
+    end
+  end
+end

data/lib/lost_in_translations/version.rb

@@ -0,0 +1,3 @@
+module LostInTranslations
+  VERSION = '1.4.3'.freeze
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: lost_in_translations_temp
+version: !ruby/object:Gem::Version
+  version: 1.4.3
+platform: ruby
+authors:
+- StreetBees Dev Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Super light Translation Ruby Gem agnostic to your framework and source
+  data
+email: dev@streetbees.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/lost_in_translations.rb
+- lib/lost_in_translations/active_record.rb
+- lib/lost_in_translations/base.rb
+- lib/lost_in_translations/config.rb
+- lib/lost_in_translations/ruby.rb
+- lib/lost_in_translations/translator/base.rb
+- lib/lost_in_translations/version.rb
+homepage: https://github.com/streetbees/lost-in-translations
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Ruby Translation Gem
+test_files: []