pseudolocalization 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e5dc2b093b49d1731d6ddbfc5d00453034db141
+  data.tar.gz: 335002ef3a837e7a1b8beb06eae102e223e4e973
+SHA512:
+  metadata.gz: 2fd4bcc39748f2a0082866f15f634c870e9074a5446774394795d7cbe3428caed911aeafdfa23059784943dac737e95ddf34e5373418b0981101fe42eb47c215
+  data.tar.gz: 9f9484056e22ba0ddc6176c61c74288827a9cadc5320be34ad68185cae81e7b5ec44afeccb3f9a9d1d7b468005b293b48049288bf9274d5c6091ac6aa039bc06

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,8 @@
+ruby '~> 2.4'
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pseudolocalization.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    pseudolocalization (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    highline (1.6.20)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json_pure (1.8.1)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    minitest (5.11.3)
+    netrc (0.11.0)
+    package_cloud (0.3.04)
+      highline (= 1.6.20)
+      json_pure (= 1.8.1)
+      rainbow (= 2.2.2)
+      rest-client (~> 2.0)
+      thor (~> 0.18)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    thor (0.20.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  package_cloud
+  pseudolocalization!
+  rake (~> 10.0)
+
+RUBY VERSION
+   ruby 2.4.2p198
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2013 Shopify Inc.
+
+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,69 @@
+# Pseudolocalization
+
+> Pseudolocalization (or pseudo-localization) is a software testing method used for testing internationalization aspects of software. Instead of translating the text of the software into a foreign language, as in the process of localization, the textual elements of an application are replaced with an altered version of the original language.
+
+## Why?
+
+Internationalization is a hard and tedious process. Different character sets, different average word length, different pluralization rules... There's a lot going on and it's impossible to test against all possible scenarios. As a side effect, most of us will simply test against one or two known languages and hope for the best. Unfortunately, this often leads to broken UI elements, texts going out of bounds, or forgotten non-translated strings making their way into a final release.
+
+As an example, let's examine the string "Set the power switch to 0.";
+
+| Language | String | Characters | Percentage |
+|----------|--------|------------|------------|
+| English | Set the power switch to 0. | 26 chars | -
+| French | Placez l'interrupteur de tension à 0. | 37 chars | 42% more
+| Spanish | Ponga el interruptor de alimentación de corriente en 0. | 55 chars | 112% more
+
+It's easy to see that any hardcoded widths would likely break giving such a string. IBM suggests that on average, we should expect any English string to inflate by 30% when translating in another language.
+
+In an attempt to ease this whole process, we created a small tool that gives you the ability to preview your product with pseudo-translations in a way that will;
+
+1. Identify untranslated strings
+2. Expand words by doubling all vowels
+3. Use English lookalike UTF8 characters for readability
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'pseudolocalization', require: false
+end
+```
+
+Execute:
+
+    $ bundle
+
+Finally, in an initializer, add the following lines:
+
+```ruby
+if Rails.env.development? && ENV["I18N_BACKEND"]
+  case ENV["I18N_BACKEND"]
+  when 'pseudolocalization'
+    require 'pseudolocalization'
+    I18n.backend = Pseudolocalization::I18n::Backend.new(I18n.backend)
+  end
+end
+```
+
+## Usage
+
+When working on internationalization, you can boot your server with the pseudolocalization backend to quickly identify content that doesn't go through the I18n framework.
+
+```bash
+I18N_BACKEND=pseudolocalization bundle exec rails server
+```
+
+
+## Other Resources
+
+* [IBM Globalization Guidelines](http://www-01.ibm.com/software/globalization/guidelines/index.html)
+* [Design for internationalization - Dropbox Design](https://medium.com/dropbox-design/design-for-internationalization-24c12ea6b38f)
+* [Pseudolocalization](https://en.wikipedia.org/wiki/Pseudolocalization)
+* [Essential Guide to App Internationalization](https://drive.google.com/open?id=1c6nAw6ttF_uHRq0ZQaGu5gYD0vjq9lHP)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/pseudolocalization.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,15 @@
+machine:
+  environment:
+    RAILS_ENV: test
+    RACK_ENV: test
+  ruby:
+    version:
+      2.4.2
+
+dependencies:
+  override:
+    - bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+
+database:
+  override:
+    - echo "no database setup"

data/dev.yml

@@ -0,0 +1,14 @@
+name: pseudolocalization
+
+type: ruby
+
+up:
+  - ruby: 2.4.2
+  - bundler
+
+commands:
+  test:
+    syntax:
+      argument: file
+      optional: args...
+    run: rake test

data/lib/pseudolocalization.rb

@@ -0,0 +1,121 @@
+require "pseudolocalization/version"
+
+module Pseudolocalization
+  module I18n
+    class Backend
+      BRACKET_START = '<'
+      BRACKET_END = '>'
+
+      VOWELS = %w(a e i o u y A E I O U Y)
+
+      LETTERS = {
+        'a' => 'α',
+        'b' => 'ḅ',
+        'c' => 'ͼ',
+        'd' => 'ḍ',
+        'e' => 'ḛ',
+        'f' => 'ϝ',
+        'g' => 'ḡ',
+        'h' => 'ḥ',
+        'i' => 'ḭ',
+        'j' => 'ĵ',
+        'k' => 'ḳ',
+        'l' => 'ḽ',
+        'm' => 'ṃ',
+        'n' => 'ṇ',
+        'o' => 'ṓ',
+        'p' => 'ṗ',
+        'q' => 'ʠ',
+        'r' => 'ṛ',
+        's' => 'ṡ',
+        't' => 'ṭ',
+        'u' => 'ṵ',
+        'v' => 'ṽ',
+        'w' => 'ẁ',
+        'x' => 'ẋ',
+        'y' => 'ẏ',
+        'z' => 'ẓ',
+        'A' => 'Ḁ',
+        'B' => 'Ḃ',
+        'C' => 'Ḉ',
+        'D' => 'Ḍ',
+        'E' => 'Ḛ',
+        'F' => 'Ḟ',
+        'G' => 'Ḡ',
+        'H' => 'Ḥ',
+        'I' => 'Ḭ',
+        'J' => 'Ĵ',
+        'K' => 'Ḱ',
+        'L' => 'Ḻ',
+        'M' => 'Ṁ',
+        'N' => 'Ṅ',
+        'O' => 'Ṏ',
+        'P' => 'Ṕ',
+        'Q' => 'Ǫ',
+        'R' => 'Ṛ',
+        'S' => 'Ṣ',
+        'T' => 'Ṫ',
+        'U' => 'Ṳ',
+        'V' => 'Ṿ',
+        'W' => 'Ŵ',
+        'X' => 'Ẋ',
+        'Y' => 'Ŷ',
+        'Z' => 'Ż',
+      }.freeze
+
+      def initialize(old_backend)
+        @old_backend = old_backend
+      end
+
+      def method_missing(name, *args, &block)
+        if respond_to_missing?(name)
+          @old_backend.public_send(name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(name, include_private = false)
+        @old_backend.respond_to?(name) || super
+      end
+
+      def translate(locale, key, options)
+        translate_object(@old_backend.translate(locale, key, options))
+      end
+
+      def translate_object(object)
+        if object.is_a?(Hash)
+          object.transform_values { |value| translate_object(value) }
+        elsif object.is_a?(Array)
+          object.map { |value| translate_object(value) }
+        elsif object.is_a?(String)
+          translate_string(object)
+        else
+          object
+        end
+      end
+
+      def translate_string(string)
+        string = string.gsub(/&[a-z]+;/, ' ')
+
+        outside_brackets = true
+
+        string.chars.map do |char|
+          if char == BRACKET_START
+            outside_brackets = false
+            char
+          elsif char == BRACKET_END
+            outside_brackets = true
+            char
+          elsif outside_brackets && LETTERS.key?(char)
+            ret = LETTERS[char]
+            ret = ret * 2 if VOWELS.include?(char)
+            ret
+          else
+            char
+          end
+        end.join
+      end
+    end
+  end
+end

data/lib/pseudolocalization/version.rb

@@ -0,0 +1,3 @@
+module Pseudolocalization
+  VERSION = "0.4.0"
+end

data/pseudolocalization.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pseudolocalization/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pseudolocalization"
+  spec.version       = Pseudolocalization::VERSION
+  spec.authors       = ["Christian Blais"]
+  spec.email         = ["christ.blais@gmail.com"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = %q{Internationalization development tool}
+  spec.description   = %q{Internationalization development tool to help identify missing translations}
+  spec.homepage      = "https://github.com/Shopify/pseudolocalization"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/shipit.yml

@@ -0,0 +1,4 @@
+deploy:
+  override:
+    - bundle exec rake build
+    - bundle exec package_cloud push shopify/gems pkg/*.gem

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: pseudolocalization
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Christian Blais
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-27 00:00:00.000000000 Z
+dependencies:
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Internationalization development tool to help identify missing translations
+email:
+- christ.blais@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- dev.yml
+- lib/pseudolocalization.rb
+- lib/pseudolocalization/version.rb
+- pseudolocalization.gemspec
+- shipit.yml
+homepage: https://github.com/Shopify/pseudolocalization
+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.14
+signing_key: 
+specification_version: 4
+summary: Internationalization development tool
+test_files: []