i18n-bamboo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 718a1e74f23f15a2d61c93ec2d64e1498886e449
+  data.tar.gz: b0c9f59693db52570dee83cabe5177a606847043
+SHA512:
+  metadata.gz: 89dc2394aac2b9a67836426a39491f13823b551afd3e793211446f48e0dd9109b0fcc2e95e4b4fb2b57f374fb41b64361f892a86c165b9db49172d69a26f42db
+  data.tar.gz: f6a8e679dd15867f3abb84de49e2de8732c78f1b837744fd5878504f4cb688bfebe3f2be0cb146fd90cdc56d3a8d238fef5c8e8b9a309b429186498758218406

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+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) 2014 Tim Downey
+
+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,50 @@
+# I18n::Bamboo
+
+Consider the noble bamboo.  This peculiar member of the Poaceae family has been known to grow to extraordinary lengths without yielding to (mostly) any obstacles.
+
+Not unlike bamboo, the i18n translations of a Rails app will continue to grow.  As a tenacious stalk of bamboo breaks through a slab of sidewalk, so too will long translations break a UI.
+
+I18n:Bamboo monkey patches the Rails I18n module and will force all calls to I18n.translate (I18n.t) and I18n.localize (I18n.l) to return the longest translated or localized value from all available locales.  For obvious reasons (monkey patching :cold_sweat:), this gem is intended to be used for development purposes only to aid in UI and internationalization/localization testing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'i18n-bamboo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n-bamboo
+
+## Usage
+### Automatic
+Simply add the following line to your `config/environments/development.rb` file:
+```ruby
+# config/environments/development.rb
+Rails.application.configure do
+    # ... previous config
+    config.i18n_bamboo.active = true
+    # further config ...
+end
+```
+
+Setting `config.i18n_bamboo.active` to `false` will disable the automatic initialization of the gem.
+
+### Manual
+If you want to use the gem temporarily in a pry session or something simply require the following:
+```ruby
+require 'i18n/bamboo/fertilizer'
+```
+**CAUTION:** Keep in mind that the fertilizer _does_ monkey patch the existing I18n module, so you will need to restart your console session/server to get the original I18n behavior back.
+
+## Contributing
+
+1. Fork it ( https://github.com/tcdowney/i18n-bamboo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/i18n-bamboo.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n/bamboo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'i18n-bamboo'
+  spec.version       = I18n::Bamboo::VERSION
+  spec.authors       = ['Tim Downey']
+  spec.email         = ['tim@downey.io']
+  spec.summary       = %q{
+                          Aids in development by monkey patching the Rails I18n module to always return the longest
+                          translation or localized value across all available locales.
+                         }
+  spec.description   = %q{
+                          Consider the noble bamboo.  This peculiar member of the Poaceae family has been known to 
+                          grow to extraordinary lengths without yielding to (mostly) any obstacles.
+
+                          Not unlike bamboo, the i18n translations of a Rails app will continue to grow.  As a 
+                          tenacious stalk of bamboo breaks through a slab of sidewalk, so too will long translations 
+                          break a UI.
+
+                          I18n:Bamboo monkey patches the Rails I18n module and will force all calls to I18n.translate 
+                          (I18n.t) and I18n.localize (I18n.l) to return the longest translated or localized value from 
+                          all available_locales.  For obvious reasons, this gem is intended to be used for development 
+                          purposes only to aid in UI and internationalization/localization testing.
+                        }
+  spec.homepage      = 'https://github.com/tcdowney/i18n-bamboo'
+  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_dependency 'i18n'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rubocop', '~> 0.27.1'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+end

data/lib/i18n/bamboo.rb

@@ -0,0 +1,7 @@
+require 'i18n/bamboo/version'
+require 'i18n/bamboo/railtie' if defined?(Rails)
+
+module I18n
+  module Bamboo
+  end
+end

data/lib/i18n/bamboo/fertilizer.rb

@@ -0,0 +1,47 @@
+require 'i18n'
+
+module I18n
+  module Bamboo
+    module Fertilizer
+      module ::I18n
+        class << self
+          alias_method :original_translate, :translate
+          alias_method :original_localize, :localize
+
+          def translate(*args)
+            translations = []
+
+            available_locales.each do |locale|
+              args_copy = args.dup
+
+              if args_copy.last.is_a? Hash
+                args_copy.last.merge!(locale: locale)
+              else
+                args_copy << {locale: locale}
+              end
+
+              translations << original_translate(*args_copy)
+            end
+
+            translations.max
+          end
+
+          def localize(object, options = {})
+            localized_values = []
+
+            available_locales.each do |locale|
+              options_copy = options.merge(locale: locale)
+
+              localized_values << original_localize(object, options_copy)
+            end
+
+            localized_values.max
+          end
+
+          alias_method :t, :translate
+          alias_method :l, :localize
+        end
+      end
+    end
+  end
+end

data/lib/i18n/bamboo/railtie.rb

@@ -0,0 +1,15 @@
+require 'active_support'
+
+module I18n
+  module Bamboo
+    class Railtie < Rails::Railtie
+
+      config.i18n_bamboo = ActiveSupport::OrderedOptions.new
+
+      config.after_initialize do
+        require 'i18n/bamboo/fertilizer' if config.i18n_bamboo.active
+      end
+
+    end
+  end
+end

data/lib/i18n/bamboo/version.rb

@@ -0,0 +1,5 @@
+module I18n
+  module Bamboo
+    VERSION = '0.1.0'
+  end
+end

data/spec/i18n/bamboo/fertilizer_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'i18n/bamboo/fertilizer'
+
+RSpec.describe 'I18n monkey patching' do
+  let(:available_locales) { [:en, :zh] }
+
+  let(:time) { Time.new(2014) }
+  let(:long_time) { '2014-01-01' }
+  let(:short_time) { '2014' }
+
+  let(:key) { 'key' }
+  let(:long_translation) { 'Something very long!' }
+  let(:short_translation) { 'Not as long.' }
+
+  before do
+    I18n.enforce_available_locales = false
+    I18n.default_locale = :en # English will always have the shortest translations for the sake of these tests
+    allow(I18n).to receive(:available_locales).and_return(available_locales)
+  end
+
+  describe '#translate' do
+    before do
+      expect(I18n).to receive(:original_translate)
+        .with(key, {locale: :en})
+        .and_return(short_translation)
+
+      expect(I18n).to receive(:original_translate)
+        .with(key, {locale: :zh})
+        .and_return(long_translation)
+    end
+
+    it 'returns the longest translation' do
+      expect(I18n.translate(key)).to eq(long_translation)
+    end
+  end
+
+  describe '#t' do
+    before do
+      expect(I18n).to receive(:original_translate)
+        .with(key, {locale: :en})
+        .and_return(short_translation)
+
+      expect(I18n).to receive(:original_translate)
+        .with(key, {locale: :zh})
+        .and_return(long_translation)
+    end
+
+    it 'returns the longest translation' do
+      expect(I18n.t(key)).to eq(long_translation)
+    end
+  end
+
+  describe '#localize' do
+    before do
+      expect(I18n).to receive(:original_localize)
+        .with(time, {locale: :en})
+        .and_return(short_time)
+
+      expect(I18n).to receive(:original_localize)
+        .with(time, {locale: :zh})
+        .and_return(long_time)
+    end
+
+    it 'returns the longest translation' do
+      expect(I18n.localize(time)).to eq(long_time)
+    end
+  end
+
+  describe '#l' do
+    before do
+      expect(I18n).to receive(:original_localize)
+        .with(time, {locale: :en})
+        .and_return(short_time)
+
+      expect(I18n).to receive(:original_localize)
+        .with(time, {locale: :zh})
+        .and_return(long_time)
+    end
+
+    it 'returns the longest translation' do
+      expect(I18n.l(time)).to eq(long_time)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'i18n/bamboo'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: i18n-bamboo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Downey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: "\n                          Consider the noble bamboo.  This peculiar
+  member of the Poaceae family has been known to \n                          grow
+  to extraordinary lengths without yielding to (mostly) any obstacles.\n\n                          Not
+  unlike bamboo, the i18n translations of a Rails app will continue to grow.  As a
+  \n                          tenacious stalk of bamboo breaks through a slab of sidewalk,
+  so too will long translations \n                          break a UI.\n\n                          I18n:Bamboo
+  monkey patches the Rails I18n module and will force all calls to I18n.translate
+  \n                          (I18n.t) and I18n.localize (I18n.l) to return the longest
+  translated or localized value from \n                          all available_locales.
+  \ For obvious reasons, this gem is intended to be used for development \n                          purposes
+  only to aid in UI and internationalization/localization testing.\n                        "
+email:
+- tim@downey.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- i18n-bamboo.gemspec
+- lib/i18n/bamboo.rb
+- lib/i18n/bamboo/fertilizer.rb
+- lib/i18n/bamboo/railtie.rb
+- lib/i18n/bamboo/version.rb
+- spec/i18n/bamboo/fertilizer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tcdowney/i18n-bamboo
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Aids in development by monkey patching the Rails I18n module to always return
+  the longest translation or localized value across all available locales.
+test_files:
+- spec/i18n/bamboo/fertilizer_spec.rb
+- spec/spec_helper.rb