pseudolocalization 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b97967a1646541cff93df46f1fa9c826d348842344516343cfd17d86d8464301
-  data.tar.gz: a2209f17067aabeda5373723c1c6aae95ea022476659c1d0e460e1d055c8f29b
+  metadata.gz: ca597fc6e2ea40f05915ef289dc48d3deb1c95872aec4a8b69474caeabfc8b39
+  data.tar.gz: 7485fd957362b90aeedd711c4197c96b8629d641896fa65e77f016a613a486b6
 SHA512:
-  metadata.gz: 5a6d988688b696fcb97227f7b77e7c939a4e8c5b35c4376ca78fdf1796d565978d6f2d895aa7b9015a216fee10e5415ea786ae285237984cd2b262fb66f0bf05
-  data.tar.gz: 66e67baf24e25a98df6caa37fd3c0bc19d5cafdd800e1ae024a6309db1618d2d319c46d4e8aeae6bcbe279dac67882b5576ffd82cfc9445d4deed4cb6662c828
+  metadata.gz: 6d238815d07f095314e6fbbca25a71ea44543e8a8d57a1b4c3fc2f7d55a5e76b56d75cd7a8f308ed89757ee3710fd4e5e0dcfd4d5ce3968ca065535a4e01a824
+  data.tar.gz: 35e98480b647dc3203e2c09248db82dd060d08d77032c410cfc76492eaa4775e214a07fe9582429a57025a1da7e641bde3cb95cf4ef9f9029777abd61fb350bf

data/.dependabot/config.yml

@@ -0,0 +1,12 @@
+version: 1
+update_configs:
+  - package_manager: "ruby:bundler"
+    directory: "/"
+    update_schedule: "weekly"
+    automerged_updates:
+      - match:
+          dependency_type: "all"
+          update_type: "all"
+    version_requirement_updates: "auto"
+    default_reviewers:
+      - Shopify/intl-languages

data/.github/probots.yml

@@ -0,0 +1,3 @@
+# .github/probots.yml
+enabled:
+  - cla

data/.github/workflows/ruby-ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - '**'
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.version }} ${{ matrix.gemfile }}
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    strategy:
+      matrix:
+        version:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+        gemfile:
+          - Gemfile
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+
+      - name: Test
+        run: bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+Nil.
+
+## [0.9.0] - 2021-02-17
+### Added
+- Added support for ignoring specific translation keys [#59](https://github.com/Shopify/pseudolocalization/pull/59)
+
+## [0.8.4] - 2021-01-15
+### Added
+- Added support for Ruby 3. [#53](https://github.com/Shopify/pseudolocalization/pull/53)
+
+### Changed
+- Switched to GitHub Actions for CI. [#52](https://github.com/Shopify/pseudolocalization/pull/52)
+- Switched to Ruby 2.7.2 for development. [#55](https://github.com/Shopify/pseudolocalization/pull/55)
+
+## [0.8.3] - 2020-01-15
+### Added
+- Added CLA probot to legitimize external contributions. [#35](https://github.com/shopify/pseudolocalization/pull/35)
+
+### Changed
+- Switched to Ruby 2.7.0 for development. [#39](https://github.com/Shopify/pseudolocalization/pull/39)
+
+## [0.8.2] - 2019-10-08
+### Added
+- Added this CHANGELOG.md. [#32](https://github.com/Shopify/pseudolocalization/pull/32)
+
+### Changed
+- Switched to Ruby 2.6.5 for development. [#33](https://github.com/Shopify/pseudolocalization/pull/33)
+
+## [0.8.1] - 2019-08-23
+### Changed
+- Switched to Ruby 2.6.3 for development. [#22](https://github.com/Shopify/pseudolocalization/pull/22)
+- Switched to Travis CI for CI solutions. [#22](https://github.com/Shopify/pseudolocalization/pull/22)
+
+### Removed
+- Removed Shopify Build CI. [#22](https://github.com/Shopify/pseudolocalization/pull/22)
+
+## [0.8.0] - 2019-08-13
+### Added
+
+- Exposed `original_backend` on the backend via `attr_reader`. [#21](https://github.com/Shopify/pseudolocalization/pull/21)
+
+### Fixed
+
+- Escape quotes inside attributes. [#20](https://github.com/Shopify/pseudolocalization/pull/20)
+
+
+Please refer to [GitHub releases](https://github.com/Shopify/pseudolocalization/releases) for releases prior to [0.8.0].
+
+[Unreleased]: https://github.com/Shopify/pseudolocalization/compare/0.9.0...HEAD
+[0.9.0]: https://github.com/Shopify/pseudolocalization/compare/0.8.4...0.9.0
+[0.8.4]: https://github.com/Shopify/pseudolocalization/compare/0.8.3...0.8.4
+[0.8.3]: https://github.com/Shopify/pseudolocalization/compare/0.8.2...0.8.3
+[0.8.2]: https://github.com/Shopify/pseudolocalization/compare/0.8.1...0.8.2
+[0.8.1]: https://github.com/Shopify/pseudolocalization/compare/0.8.0...0.8.1
+[0.8.0]: https://github.com/Shopify/pseudolocalization/compare/0.7.0...0.8.0

data/Gemfile

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

data/Gemfile.lock

@@ -1,51 +1,21 @@
 PATH
   remote: .
   specs:
-    pseudolocalization (0.2.0)
+    pseudolocalization (0.9.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)
+    minitest (5.14.3)
+    rake (13.0.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   minitest (~> 5.0)
-  package_cloud
   pseudolocalization!
-  rake (~> 10.0)
-
-RUBY VERSION
-   ruby 2.4.2p198
+  rake (~> 13.0)
 
 BUNDLED WITH
-   1.16.1
+   2.2.4

data/README.md

@@ -1,8 +1,11 @@
 # 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.
+[![Version][gem]][gem_url] [![Build Status](https://github.com/Shopify/pseudolocalization/workflows/CI/badge.svg?branch=master)](https://github.com/Shopify/pseudolocalization/actions?query=workflow%3ACI)
 
-## Why?
+[About this repo](#about-this-repo) | [How to use this repo](#how-to-use-this-repo) | [Contribute to this repo](#contribute-to-this-repo)
+
+## About this repo
+### 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.
 
@@ -22,7 +25,8 @@ In an attempt to ease this whole process, we created a small tool that gives you
 2. Expand words by doubling all vowels
 3. Use English lookalike UTF8 characters for readability
 
-## Installation
+## How to use this repo
+### Installation
 
 Add these lines to your application's Gemfile:
 
@@ -48,7 +52,7 @@ if Rails.env.development? && ENV["I18N_BACKEND"]
 end
 ```
 
-## Usage
+### 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.
 
@@ -56,14 +60,31 @@ When working on internationalization, you can boot your server with the pseudolo
 I18N_BACKEND=pseudolocalization bundle exec rails server
 ```
 
+### Ignoring specific keys
+You may wish to have the backend ignore specific keys. These may be configured via an array, `ignores`, on the backend. The array can contain a mix of strings (with globbing allowed) and/or Regexes.
 
-## Other Resources
+```ruby
+I18n.backend = Pseudolocalization::I18n::Backend.new(I18n.backend)
+I18n.backend.ignores = ['ignored*', /Waldo.$/]
+```
+
+### How to run tests
+
+```bash
+bundle exec rake test
+```
+
+### 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)
+* [Pseudo Localization @ Netflix](https://medium.com/netflix-techblog/pseudo-localization-netflix-12fff76fbcbe)
 
-## Contributing
+## Contribute to this repo
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/pseudolocalization.
+
+[gem]: https://badgen.net/rubygems/v/pseudolocalization?color=green
+[gem_url]: https://rubygems.org/gems/pseudolocalization

data/dev.yml

@@ -3,7 +3,7 @@ name: pseudolocalization
 type: ruby
 
 up:
-  - ruby: 2.4.2
+  - ruby: 2.7.2
   - bundler
 
 commands:

data/lib/pseudolocalization.rb

@@ -1,126 +1,52 @@
-require "pseudolocalization/version"
+require_relative "pseudolocalization/version"
+require_relative "pseudolocalization/pseudolocalizer"
 
 module Pseudolocalization
   module I18n
     class Backend
-      ESCAPED_CHARS = [
-        ['<', '>'],
-        ['{{', '}}'],
-      ]
+      attr_reader :original_backend
+      attr_accessor :ignores
 
-      ESCAPED_PATTERNS = ESCAPED_CHARS.map do |(a, b)|
-        "#{a}.*?#{b}"
-      end
-
-      ESCAPED_REGEX = Regexp.new("(#{ESCAPED_PATTERNS.join('|')})")
-
-      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
+      def initialize(original_backend)
+        @original_backend = original_backend
+        @ignores = []
+        yield self if block_given?
       end
 
       def method_missing(name, *args, &block)
         if respond_to_missing?(name)
-          @old_backend.public_send(name, *args, &block)
+          original_backend.public_send(name, *args, &block)
         else
           super
         end
       end
 
       def respond_to_missing?(name, include_private = false)
-        @old_backend.respond_to?(name) || super
+        original_backend.respond_to?(name) || super
       end
 
       def translate(locale, key, options)
-        translate_object(@old_backend.translate(locale, key, options))
-      end
+        return original_backend.translate(locale, key, options) if key_ignored?(key)
 
-      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
+        ::Pseudolocalization::I18n::Pseudolocalizer.pseudolocalize(original_backend.translate(locale, key, options))
       end
 
-      def translate_string(string)
-        string = string.gsub(/&[a-z]+;/, ' ')
+      private
 
-        string.split(ESCAPED_REGEX).map do |part|
-          if part =~ ESCAPED_REGEX
-            part
+      def key_ignored?(key)
+        return false unless ignores
+
+        ignores.any? do |ignore|
+          case ignore
+          when Regexp
+            key.to_s.match(ignore)
+          when String
+            File.fnmatch(ignore, key.to_s)
           else
-            part.chars.map do |char|
-              if LETTERS.key?(char)
-                value = LETTERS[char]
-                value = value * 2 if VOWELS.include?(char)
-                value
-              else
-                char
-              end
-            end.join
+            Rails.logger.tagged('Pseudolocalization I18n').error('Ignore type unsupported. Expects an array of (mixed) Regexp or Strings.')
+            false
           end
-        end.join
+        end
       end
     end
   end

data/lib/pseudolocalization/pseudolocalizer.rb

@@ -0,0 +1,111 @@
+module Pseudolocalization
+  module I18n
+    class Pseudolocalizer
+      ESCAPED_REGEX = Regexp.new("(#{
+        [
+          "<.*?>",
+          "{{.*?}}",
+          "%{.*?}",
+          "https?:\/\/\\S+",
+          "&\\S*?;"
+        ].join('|')
+      })")
+
+      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
+
+      class << self
+        def pseudolocalize(object)
+          translate_object(object)
+        end
+
+        private
+
+        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.split(ESCAPED_REGEX).map do |part|
+            if part =~ ESCAPED_REGEX
+              part
+            else
+              part.chars.map do |char|
+                if LETTERS.key?(char)
+                  value = LETTERS[char]
+                  value = value * 2 if VOWELS.include?(char)
+                  value
+                else
+                  char
+                end
+              end.join
+            end
+          end.join
+        end
+      end
+    end
+  end
+end

data/lib/pseudolocalization/version.rb

@@ -1,3 +1,3 @@
 module Pseudolocalization
-  VERSION = "0.5.0"
+  VERSION = "0.9.0"
 end

data/pseudolocalization.gemspec

@@ -14,6 +14,10 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Internationalization development tool to help identify missing translations}
   spec.homepage      = "https://github.com/Shopify/pseudolocalization"
 
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org'
+  }
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -21,6 +25,6 @@ Gem::Specification.new do |spec|
   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 "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

data/service.yml

@@ -0,0 +1,7 @@
+org_line: Build
+owners:
+  - Shopify/intl-languages
+slack_channels:
+  - help-i18n-and-translation
+classification: library
+ci_url: https://github.com/Shopify/pseudolocalization/workflows/CI

data/shipit.rubygems.yml

@@ -0,0 +1,7 @@
+ci:
+  require:
+    - 'Ruby 2.4 Gemfile'
+    - 'Ruby 2.5 Gemfile'
+    - 'Ruby 2.6 Gemfile'
+    - 'Ruby 2.7 Gemfile'
+    - 'Ruby 3 Gemfile'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pseudolocalization
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Christian Blais
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -45,8 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dependabot/config.yml"
+- ".github/probots.yml"
+- ".github/workflows/ruby-ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -54,16 +57,18 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- circle.yml
 - dev.yml
 - lib/pseudolocalization.rb
+- lib/pseudolocalization/pseudolocalizer.rb
 - lib/pseudolocalization/version.rb
 - pseudolocalization.gemspec
-- shipit.yml
+- service.yml
+- shipit.rubygems.yml
 homepage: https://github.com/Shopify/pseudolocalization
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -79,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Internationalization development tool

data/.travis.yml

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

data/circle.yml

@@ -1,15 +0,0 @@
-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/shipit.yml

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