i18n-backend-side_by_side 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d311a7851ea64a4d1115d3f7d675f44b0606d3d
+  data.tar.gz: c7f81ea78dfac9b4d0c8fd9ced3fa081f23d39a4
+SHA512:
+  metadata.gz: 2dfde3d797ea374e4d188c8dbe737bd35c4fdbfee4ccc7c7e4539e719a0bd0a7e0141d946e57fd902cad3fbadac0554d2f5f2e3a9eaef731f864f2f17f869b51
+  data.tar.gz: 59e9aa42b0b68db073af5e20fc0bf2fecfc41487587cc49737cf9a545a582140f0dcdca9f1d4e676a95d6d05c3a199f830434d89f4146f25250bdcb163917997

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ElectricFeel Mobility Systems GmbH
+
+MIT License
+
+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,99 @@
+# i18n-backend-side\_by\_side
+
+**Tired of jumping between language files when translating keys? Stop jumping
+and have all the languages side by side.**
+
+This gem is a subclass of the default `I18n::Backend::Simple` backend. It
+changes the way translations get loaded from files in order to support
+specifying the language code anywhere along the key path as opposed to the root
+key. This allows for all languages being defined next to each other,
+making it easier to translate between them.
+
+## How It Works
+
+Let's assume your app supports English, Spanish, and German. You probably have
+one file per language:
+
+```
+locales/
+  view.en.yml
+  view.es.yml
+  view.de.yml
+```
+
+The files might look something like this (e.g. `locales/en.yml`):
+
+```yaml
+en:
+  view:
+    title: Welcome
+    inbox:
+      zero: You have no messages
+      one: You have one message
+      other: 'You have %{count} messages'
+```
+
+Whenever you have to add or modify a key, you have to edit all files. Also, you
+can't see all translations at once for a specific key. With this gem you can
+merge all the files and specify the translation for a key at that key:
+
+```yaml
+_:
+  view:
+    title:
+      _en: Welcome
+      _es: Bienvenido
+      _de: Willkommen
+    inbox:
+      _en:
+        zero: You have no messages
+        one: You have one message
+        other: 'You have %{count} messages'
+      _es:
+        zero: No tiene mensajes
+        one: Tienes un mensaje
+        other: 'Tienes %{count} messajes'
+      _de:
+        zero: Du hast keine Nachrichten
+        one: Du hast eine Nachricht
+        other: 'Du hast %{count} Nachrichten'
+```
+
+Two things to note here:
+
+1. The root key is an underscore. Omitting it results in the file being
+   processed as a regular translation file, without support for side-by-side
+   translations.
+
+2. The language codes are prefixed with an underscore. This is needed in order
+   to distinguish a language code key from a normal key. This also means that
+   regular keys can't start with an underscore.
+
+When the files get loaded, they're transformed on the fly to the original format
+by moving the language code to the beginning of the key path:
+
+```
+_.foo.bar._en            => en.foo.bar
+_.foo.bar._en-UK.abc.xyz => en-UK.foo.bar.abc.xyz
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n-backend-side_by_side'
+```
+
+Set up `I18n` to use an instance of this backend:
+
+```ruby
+I18n.backend = I18n::Backend::SideBySide.new
+```
+
+That's it. Continue using `I18n` as you're used to. Happy translating!
+
+## Authors
+
+- Pratik Mukerji ([pmukerji](https://github.com/pmukerji))
+- Philipe Fatio ([fphilipe](https://github.com/fphilipe))

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/i18n-backend-side_by_side.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'i18n-backend-side_by_side'
+  spec.version       = File.read('VERSION').strip
+  spec.authors       = ['Philipe Fatio', 'Pratik Mukerji']
+  spec.email         = ['me@phili.pe', 'pratik@electricfeel.com']
+  spec.summary       = %q{Tired of jumping between language files when translating keys? Stop jumping and have all the languages side by side.}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/electric-feel/i18n-backend-side_by_side'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_dependency 'i18n', '< 1'
+end

data/lib/i18n/backend/side_by_side.rb

@@ -0,0 +1,56 @@
+require 'i18n'
+
+module I18n
+  module Backend
+    class SideBySide < Simple
+      VERSION = File.read(File.expand_path('../../../../VERSION', __FILE__))
+      LOCALE_PREFIX = '_'
+
+      protected
+
+      def load_file(filename)
+        type = File.extname(filename).tr('.', '').downcase
+        raise UnknownFileType.new(type, filename) unless respond_to?(:"load_#{type}", true)
+        data = send(:"load_#{type}", filename)
+        unless data.is_a?(Hash)
+          raise InvalidLocaleData.new(filename, 'expects it to return a hash, but does not')
+        end
+
+        if data.first.first == LOCALE_PREFIX
+          _process([], data[LOCALE_PREFIX].deep_symbolize_keys)
+        else
+          data.each { |locale, d| store_translations(locale, d || {}) }
+        end
+      end
+
+      private
+
+      def _process(path, hash)
+        if _contains_locales?(hash)
+          hash.each do |locale, value|
+            _store([_strip_locale_prefix(locale)] + path, value)
+          end
+        else
+          hash.each { |key, value| _process(path + [key], value) }
+        end
+      end
+
+      def _store(path, value)
+        *keys, last_key = path
+        target = keys.inject(translations) do |hash, key|
+          hash[key] ||= {}
+          hash[key]
+        end
+        target[last_key] = value
+      end
+
+      def _contains_locales?(hash)
+        hash.first.first[0] == LOCALE_PREFIX
+      end
+
+      def _strip_locale_prefix(locale)
+        locale[LOCALE_PREFIX.length..-1].to_sym
+      end
+    end
+  end
+end

data/test/locales/novel.yml

@@ -0,0 +1,21 @@
+_:
+  foo:
+    bar:
+      _en: Hi
+      _de: Hallo
+    hash:
+      key:
+        _en: value
+        _de: Wert
+    count:
+      _en:
+        one: one
+        zero: none
+        other: many
+      _de:
+        one: ein
+        zero: keine
+        other: mehrere
+    only_en:
+      some_key:
+        _en: 'some value'

data/test/locales/oldschool.de.yml

@@ -0,0 +1,2 @@
+de:
+  oldschool: Immer noch hier

data/test/locales/oldschool.en.yml

@@ -0,0 +1,2 @@
+en:
+  oldschool: Still here

data/test/test.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'i18n/backend/side_by_side'
+require 'minitest/autorun'
+
+I18n.load_path = Dir['test/locales/*.yml']
+I18n.backend = I18n::Backend::SideBySide.new
+
+class Test < Minitest::Test
+  def test_oldschool
+    assert_equal('Still here',      I18n.t('oldschool', locale: :en))
+    assert_equal('Immer noch hier', I18n.t('oldschool', locale: :de))
+  end
+
+  def test_simple
+    assert_equal('Hi',    I18n.t('foo.bar', locale: :en))
+    assert_equal('Hallo', I18n.t('foo.bar', locale: :de))
+  end
+
+  def test_hash
+    assert_equal({ key: 'value' }, I18n.t('foo.hash', locale: :en))
+    assert_equal({ key: 'Wert' },  I18n.t('foo.hash', locale: :de))
+  end
+
+  def test_count
+    assert_equal('none',  I18n.t('foo.count', count: 0, locale: :en))
+    assert_equal('keine', I18n.t('foo.count', count: 0, locale: :de))
+  end
+
+  def test_partially_missing
+    assert_equal('some value', I18n.t('foo.only_en.some_key', locale: :en))
+    assert_equal({ some_key: 'some value' }, I18n.t('foo.only_en', locale: :en))
+    assert_raises { I18n.t('foo.only_en.some_key', locale: :de, raise: true) }
+    assert_raises { I18n.t('foo.only_en', locale: :de, raise: true) }
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: i18n-backend-side_by_side
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Philipe Fatio
+- Pratik Mukerji
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Tired of jumping between language files when translating keys? Stop jumping
+  and have all the languages side by side.
+email:
+- me@phili.pe
+- pratik@electricfeel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- i18n-backend-side_by_side.gemspec
+- lib/i18n/backend/side_by_side.rb
+- test/locales/novel.yml
+- test/locales/oldschool.de.yml
+- test/locales/oldschool.en.yml
+- test/test.rb
+homepage: https://github.com/electric-feel/i18n-backend-side_by_side
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Tired of jumping between language files when translating keys? Stop jumping
+  and have all the languages side by side.
+test_files:
+- test/locales/novel.yml
+- test/locales/oldschool.de.yml
+- test/locales/oldschool.en.yml
+- test/test.rb