lost_in_translations 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcda78e45d1191420fb5863127b77c5315fa7b46
+  data.tar.gz: 6cdf234915545512aac5e751a692986454fcfe27
+SHA512:
+  metadata.gz: 55dd44bafc0005398321643ca0b44cef0ede2dd18365735809aceeeb06acec6e0a0b8201eba40380d2fe0b552738d317633ae9a3d8f6699fd667ba1e817f0bc2
+  data.tar.gz: c73c4f621cf6dc45e67fe3ba2901319604dbdb12ff481c01a8600edced13100a8c0d55d4e8e9a97aa1f7df8a3fd1d83851e1271d04a953251f1c0a3e56c050f8

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.DS_Store
+
+# Jetbrains Idea files
+.idea/
+api.iml
+
+db/schema.rb

data/.rspec

@@ -0,0 +1,4 @@
+--tty
+--color
+--format documentation
+--format html -o "tmp/rspec_result.html"

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'spec/**/*'
+    - 'Gemfile*'
+    - '*.gemspec'
+
+Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.1.0
+- 2.3.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    lost_in_translations (1.2.0)
+      i18n (~> 0.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    ast (2.2.0)
+    builder (3.2.2)
+    byebug (8.2.5)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.9.0)
+    parser (2.3.0.6)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
+    rainbow (2.1.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.37.2)
+      parser (>= 2.3.0.4, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
+    ruby-progressbar (1.7.5)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sqlite3 (1.3.11)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 4.2.6)
+  byebug (= 8.2.5)
+  codeclimate-test-reporter (= 0.4.8)
+  lost_in_translations!
+  pry-byebug (= 3.3.0)
+  rspec (= 3.4.0)
+  rubocop (= 0.37.2)
+  simplecov (= 0.11.2)
+  sqlite3 (= 1.3.11)
+
+RUBY VERSION
+   ruby 2.3.0p0
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -0,0 +1,203 @@
+# 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)
+
+## 1. Basic Usage
+```ruby
+class User < Struct.new(:title, :first_name, :last_name)
+  include LostInTranslations
+
+  translate :title, :first_name
+
+  def 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**, otherwise calls the original redefined method.
+
+```ruby
+@user = User.new('Cavaleiro', 'Joao', 'Neve')
+
+I18n.locale = :fr
+
+@user.first_name # returns 'Jean'
+@user.last_name # returns 'Neve'
+@user.title # returns 'Cavaleiro'
+
+I18n.with_locale(:en) do
+  @user.first_name # returns 'Jon'
+  @user.last_name # returns 'Neve'
+  @user.title # returns 'Cavaleiro'
+end
+
+I18n.with_locale(:de) do
+  @user.first_name # returns 'Joao'
+  @user.last_name # returns 'Neve'
+  @user.title # returns 'Cavaleiro'
+end
+```
+
+Instance method **#translate** is also available:
+```ruby
+@user.translate(:first_name, :fr) # returns 'Jean'
+@user.translate(:first_name, :en) # returns 'Jon'
+@user.translate(:first_name, :de) # returns 'Joao'
+```
+
+## 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.json :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 'Cavaleiro'
+```
+
+## 3. Configuration
+
+### 3.1 Your "translation_data" method (in all of your objects) is not called "translation_data"
+```ruby
+LostInTranslations.configure do |config|
+  config.translation_data_field = 'my_translation_data_field'
+end
+```
+
+```ruby
+class User < ActiveRecord::Base
+  include LostInTranslations
+
+  translate :first_name
+
+  def my_translation_data_field
+    {
+      en: { first_name: 'Jon', last_name: 'Snow' },
+      fr: { first_name: 'Jean', last_name: 'Neige' }
+    }
+  end
+end
+
+I18n.locale = :fr
+
+User.find(1).first_name # returns 'Jean'
+```
+
+### 3.2 Your "translation_data" method (in a particular object) is not called "translation_data"
+```ruby
+class User < ActiveRecord::Base
+  include LostInTranslations
+
+  translate :first_name
+
+  self.translation_data_field = :my_translation_data_field
+
+  def my_translation_data_field
+    {
+      en: { first_name: 'Jon', last_name: 'Snow' },
+      fr: { first_name: 'Jean', last_name: 'Neige' }
+    }
+  end
+end
+
+I18n.locale = :fr
+
+User.find(1).first_name # returns 'Jean'
+```
+
+### 3.3 Custom translation mechanism
+```ruby
+class MyTranslator
+  def self.translate(object, field, locale)
+    translations = #get_data_from_redis_or_yaml_file(object)
+
+    (translations[locale] || {})[field]
+  end
+end
+```
+
+```ruby
+LostInTranslations.configure do |config|
+  config.translator = MyTranslator
+end
+```
+
+```ruby
+class User < ActiveRecord::Base
+  include LostInTranslations
+
+  translate :first_name
+end
+
+I18n.locale = :fr
+
+User.find(1).first_name # returns 'Jean' from redis or yaml file
+```
+
+Don't forget that you can do the same at the object level
+```ruby
+class User < ActiveRecord::Base
+  include LostInTranslations
+
+  translate :first_name
+
+  def translation_data
+    # get_data_from_redis_or_yaml_file(self)
+  end
+end
+
+I18n.locale = :fr
+
+User.find(1).first_name # returns 'Jean' from redis or yaml file
+```
+
+## 4 Instalation
+
+Add your application's Gemfile:
+```
+gem 'lost_in_translations'
+```
+
+And then execute:
+
+```
+$> bundle install
+```

data/lib/lost_in_translations.rb

@@ -0,0 +1,41 @@
+require 'i18n'
+require 'lost_in_translations/base'
+require 'lost_in_translations/ruby'
+require 'lost_in_translations/config'
+require 'lost_in_translations/translator'
+require 'lost_in_translations/active_record'
+
+module LostInTranslations
+
+  def self.included(base_class)
+    if defined?(::ActiveRecord::Base) &&
+       base_class.ancestors.include?(::ActiveRecord::Base)
+      base_class.include LostInTranslations::ActiveRecord
+    else
+      base_class.include Ruby
+    end
+  end
+
+  def self.config
+    @config ||= Config.new('translation_data', Translator)
+  end
+
+  def self.translate(*args)
+    config.translator.translate(*args)
+  end
+
+  def self.define_translation_methods(object, *fields)
+    fields.each do |field|
+      object.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{field}
+          translate(:#{field}, I18n.locale)
+        end
+      RUBY
+    end
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+end

data/lib/lost_in_translations/active_record.rb

@@ -0,0 +1,27 @@
+module LostInTranslations
+  module ActiveRecord
+
+    module ClassMethods
+
+      def translate(*fields)
+        LostInTranslations.define_translation_methods(self, *fields)
+      end
+
+    end
+
+    def self.included(base_class)
+      base_class.include Base
+      base_class.extend ClassMethods
+    end
+
+    def translate(field, locale = I18n.locale)
+      LostInTranslations.translate(self, field, locale) ||
+        ActiveRecord.call_original_field(self, field)
+    end
+
+    def self.call_original_field(object, field)
+      object.read_attribute(field)
+    end
+
+  end
+end

data/lib/lost_in_translations/base.rb

@@ -0,0 +1,20 @@
+module LostInTranslations
+  module Base
+
+    def self.included(base_class)
+      base_class.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      attr_writer :translation_data_field
+
+      def translation_data_field
+        @translation_data_field ||
+          LostInTranslations.config.translation_data_field
+      end
+
+    end
+
+  end
+end

data/lib/lost_in_translations/config.rb

@@ -0,0 +1,5 @@
+module LostInTranslations
+
+  Config = Struct.new(:translation_data_field, :translator)
+
+end

data/lib/lost_in_translations/ruby.rb

@@ -0,0 +1,39 @@
+module LostInTranslations
+  module Ruby
+
+    module ClassMethods
+
+      def translate(*fields)
+        fields.each do |field|
+          alias_method Ruby.original_field_name(field), field.to_sym
+        end
+
+        LostInTranslations.define_translation_methods(self, *fields)
+      end
+
+    end
+
+    def self.included(base_class)
+      base_class.include Base
+      base_class.extend ClassMethods
+    end
+
+    def translate(field, locale = I18n.locale)
+      LostInTranslations.translate(self, field, locale) ||
+        Ruby.call_original_field(self, field)
+    end
+
+    def self.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
+
+  end
+end

data/lib/lost_in_translations/translator.rb

@@ -0,0 +1,29 @@
+module LostInTranslations
+  class Translator
+
+    def self.translate(object, field, locale)
+      translations = translations_for(object, locale) || {}
+
+      translations[field.to_sym] || translations[field.to_s]
+    end
+
+    def self.translations_for(object, locale)
+      translations = translation_data(object) || {}
+
+      translations[locale.to_sym] || translations[locale.to_s]
+    end
+
+    def self.translation_data(object)
+      translation_data_field = object.class.translation_data_field
+
+      unless object.respond_to?(translation_data_field)
+        raise \
+          NotImplementedError,
+          "#{object.class.name} does not respond to .#{translation_data_field}"
+      end
+
+      object.send(translation_data_field)
+    end
+
+  end
+end

data/lib/lost_in_translations/version.rb

@@ -0,0 +1,5 @@
+module LostInTranslations
+
+  VERSION = '1.2.0'.freeze
+
+end

data/lost_in_translations.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'lost_in_translations/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'lost_in_translations'
+  gem.version = LostInTranslations::VERSION
+  gem.license = 'MIT'
+  gem.authors = ['StreetBees Dev Team']
+  gem.email = 'dev@streetbees.com'
+  gem.summary = 'Ruby Translation Gem'
+  gem.description = 'Super light Translation Ruby Gem agnostic to your framework and source data'
+  gem.homepage = 'https://github.com/streetbees/lost_in_translations'
+
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rspec', '3.4.0'
+  gem.add_development_dependency 'byebug', '8.2.5'
+  gem.add_development_dependency 'sqlite3', '1.3.11'
+  gem.add_development_dependency 'rubocop', '0.37.2'
+  gem.add_development_dependency 'simplecov', '0.11.2'
+  gem.add_development_dependency 'pry-byebug', '3.3.0'
+  gem.add_development_dependency 'activerecord', '4.2.6'
+  gem.add_development_dependency 'codeclimate-test-reporter', '0.4.8'
+
+  gem.add_dependency 'i18n', '~> 0.7'
+end

data/spec/lost_in_translations/active_record_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe LostInTranslations::ActiveRecord do
+
+  describe '.translate' do
+
+    context "when translating a field" do
+      before do
+        @user_class = Class.new(ActiveRecord::Base) do
+          self.table_name = 'users'
+
+          include LostInTranslations::ActiveRecord
+
+          translate :title, :first_name
+
+          def translation_data
+            {
+              en: { first_name: 'Jon', last_name: 'Snow' },
+              fr: { first_name: 'Jean', last_name: 'Neige' }
+            }
+          end
+        end
+
+        @user_class.create title: 'Cavaleiro', first_name: 'Joao', last_name: 'Neve'
+        @user = @user_class.first
+      end
+      after { @user.destroy }
+
+      it_behaves_like "a proper translator"
+    end
+
+    context "when a particular field is not translated" do
+      before do
+        @user_class = Class.new(ActiveRecord::Base) do
+          self.table_name = 'users'
+
+          include LostInTranslations::ActiveRecord
+
+          translate :title, :first_name
+
+          def translation_data
+            {
+              en: { first_name: 'Jon', last_name: 'Snow' },
+              fr: { first_name: 'Jean', last_name: 'Neige' }
+            }
+          end
+        end
+
+        @user = @user_class.new title: 'Cavaleiro', first_name: 'Joao', last_name: 'Neve'
+      end
+
+      it "#field must return the original data" do
+        I18n.with_locale(:en) do
+          expect(@user.last_name).to eq 'Neve'
+        end
+      end
+    end
+
+  end
+
+end

data/spec/lost_in_translations/base_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe LostInTranslations::Base do
+
+  describe '.translation_data_field =' do
+
+    context "when it points to a real method" do
+      before do
+        @user_class = Struct.new(:first_name, :last_name) do
+          include LostInTranslations::Base
+
+          self.translation_data_field = :translation_json
+
+          def translation_json
+            {
+              en: { first_name: 'Jon', last_name: 'Snow' },
+              fr: { first_name: 'Jean', last_name: 'Neige' }
+            }
+          end
+        end
+
+        LostInTranslations.define_translation_methods(@user_class, :first_name)
+
+        @user = @user_class.new('Joao', 'Neve')
+      end
+
+      it "LostInTranslations.translate must return a translation" do
+        expect(LostInTranslations.translate(@user, :first_name, :en)).to eq 'Jon'
+      end
+
+      it "calling a field not translated, must return the original data" do
+        I18n.with_locale(:en) do
+          expect(@user.last_name).to eq 'Neve'
+        end
+      end
+
+      context "and the translation data doesn't contain results" do
+        it "LostInTranslations.translate must return nil" do
+          expect(LostInTranslations.translate(@user, :first_name, :de)).to be_nil
+        end
+      end
+    end
+
+    context "when it DOENS't point to a real method" do
+      before do
+        @user_class = Struct.new(:first_name, :last_name) do
+          include LostInTranslations::Base
+
+          self.translation_data_field = :translation_json
+        end
+
+        LostInTranslations.define_translation_methods(@user_class, :first_name)
+
+        @user = @user_class.new('Joao', 'Neve')
+      end
+
+      it "LostInTranslations.translate must raise an error" do
+        expect { LostInTranslations.translate(@user, :first_name, :en) }.to raise_error(NotImplementedError)
+      end
+
+      it "calling a field not translated, must return the original data" do
+        I18n.with_locale(:en) do
+          expect(@user.last_name).to eq 'Neve'
+        end
+      end
+    end
+
+  end
+
+end

data/spec/lost_in_translations/lost_in_translations_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe LostInTranslations do
+
+  describe "#included" do
+    context "when the object inherits from ActiveRecord" do
+      before do
+        @user_class = Class.new(ActiveRecord::Base) do
+          self.table_name = 'users'
+
+          include LostInTranslations
+        end
+      end
+
+      it "LostInTranslations::ActiveRecord must be included" do
+        expect(@user_class.ancestors.include?(LostInTranslations::ActiveRecord)).to be true
+      end
+    end
+
+    context "when the object DOES NOT inherit from ActiveRecord" do
+      before do
+        @user_class = Class.new { include LostInTranslations }
+      end
+
+      it "LostInTranslations::Ruby must be included" do
+        expect(@user_class.ancestors.include?(LostInTranslations::Ruby)).to be true
+      end
+    end
+  end
+
+  describe "#config.translation_data_field" do
+
+    context "when setting the 'translation_data_field' to a known method" do
+      before do
+        LostInTranslations.configure do |config|
+          config.translation_data_field = 'translation_json'
+        end
+
+        @user_class = Struct.new(:first_name, :last_name) do
+          include LostInTranslations
+
+          translate :first_name
+
+          def translation_json
+            { en: { first_name: 'Jon', last_name: 'Snow' } }
+          end
+        end
+
+        @user = @user_class.new('joao', 'neve')
+      end
+      after { LostInTranslations.config.translation_data_field = 'translation_data' }
+
+      it "calling a translated field must return a translation" do
+        I18n.with_locale(:en) do
+          expect(@user.first_name).to eq 'Jon'
+        end
+      end
+    end
+
+    context "when setting the 'translation_data_field' to an unknown method" do
+      before do
+        LostInTranslations.configure do |config|
+          config.translation_data_field = 'translation_json'
+        end
+
+        @user_class = Struct.new(:first_name, :last_name) do
+          include LostInTranslations
+
+          translate :first_name
+        end
+
+        @user = @user_class.new('joao', 'neve')
+      end
+      after { LostInTranslations.config.translation_data_field = 'translation_data' }
+
+      it "calling a translated field, must raise an error" do
+        I18n.with_locale(:en) do
+          expect { @user.first_name }.to raise_error(NotImplementedError)
+        end
+      end
+    end
+
+  end
+
+  describe "#config.translator" do
+
+    context "changing the source of the translation_data" do
+      before do
+        LostInTranslations.configure do |config|
+          config.translator = Class.new(LostInTranslations::Translator) do
+            def self.translation_data(object)
+              { en: { first_name: 'Jon', last_name: 'Snow' } }
+            end
+          end
+        end
+
+        @user_class = Struct.new(:first_name, :last_name) do
+          include LostInTranslations
+
+          translate :first_name
+        end
+
+        @user = @user_class.new('joao', 'neve')
+      end
+      after { LostInTranslations.config.translator = LostInTranslations::Translator }
+
+      it "calling a translated field must return a translation" do
+        I18n.with_locale(:en) do
+          expect(@user.first_name).to eq 'Jon'
+        end
+      end
+    end
+
+  end
+
+end

data/spec/lost_in_translations/ruby_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe LostInTranslations::Ruby do
+
+  describe '.translate' do
+
+    context "when translating a field" do
+      before do
+        @user_class = Struct.new(:title, :first_name, :last_name) do
+          include LostInTranslations
+
+          translate :title, :first_name
+
+          def translation_data
+            {
+              en: { first_name: 'Jon', last_name: 'Snow' },
+              fr: { first_name: 'Jean', last_name: 'Neige' }
+            }
+          end
+        end
+
+        @user = @user_class.new('Cavaleiro', 'Joao', 'Neve')
+      end
+
+      it_behaves_like "a proper translator"
+    end
+
+    context "when a particular field is not translated" do
+      before do
+        @user_class = Struct.new(:title, :first_name, :last_name) do
+          include LostInTranslations
+
+          translate :title, :first_name
+
+          def translation_data
+            {
+              en: { first_name: 'Jon', last_name: 'Snow' },
+              fr: { first_name: 'Jean', last_name: 'Neige' }
+            }
+          end
+        end
+
+        @user = @user_class.new('Cavaleiro', 'Joao', 'Neve')
+      end
+
+      it "#field must return the original data" do
+        I18n.with_locale(:en) do
+          expect(@user.last_name).to eq 'Neve'
+        end
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require "codeclimate-test-reporter"
+
+CodeClimate::TestReporter.start
+
+require "simplecov"
+
+SimpleCov.start do
+  root("lib/")
+  coverage_dir("../tmp/coverage/")
+end
+
+$: << File.expand_path('../', File.dirname(__FILE__))
+
+require 'pry-byebug'
+require 'active_record'
+require 'lost_in_translations'
+
+I18n.available_locales = [:en, :pt, :fr, :de]
+I18n.default_locale = :pt
+
+ActiveRecord::Base.establish_connection \
+  pool: 5,
+  timeout: 5000,
+  adapter: 'sqlite3',
+  database: File.expand_path('../spec/support/db/test.sqlite3', File.dirname(__FILE__))
+
+Dir["./spec/**/support/**/*.rb"].each do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+
+  config.order = 'random'
+end

data/spec/support/shared_examples/proper_translator.rb

@@ -0,0 +1,23 @@
+shared_examples_for "a proper translator" do
+  it "#field must return a translation" do
+    I18n.with_locale(:en) do
+      expect(@user.first_name).to eq 'Jon'
+    end
+  end
+
+  context "when the translation data doesn't contain the desired language" do
+    it "#field must return the original data" do
+      I18n.with_locale(:de) do
+        expect(@user.first_name).to eq 'Joao'
+      end
+    end
+  end
+
+  context "when the translation data doesn't contain the desired field" do
+    it "#field must return the original data" do
+      I18n.with_locale(:en) do
+        expect(@user.title).to eq 'Cavaleiro'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: lost_in_translations
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- StreetBees Dev Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-07 00:00:00.000000000 Z
+dependencies:
+- !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.2.5
+- !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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !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:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- 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.rb
+- lib/lost_in_translations/version.rb
+- lost_in_translations.gemspec
+- spec/lost_in_translations/active_record_spec.rb
+- spec/lost_in_translations/base_spec.rb
+- spec/lost_in_translations/lost_in_translations_spec.rb
+- spec/lost_in_translations/ruby_spec.rb
+- spec/spec_helper.rb
+- spec/support/db/test.sqlite3
+- spec/support/shared_examples/proper_translator.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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Translation Gem
+test_files:
+- spec/lost_in_translations/active_record_spec.rb
+- spec/lost_in_translations/base_spec.rb
+- spec/lost_in_translations/lost_in_translations_spec.rb
+- spec/lost_in_translations/ruby_spec.rb
+- spec/spec_helper.rb
+- spec/support/db/test.sqlite3
+- spec/support/shared_examples/proper_translator.rb