pseudolocalization 0.8.4 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7bcc4fee756deba3c77c8c816ef2149b675b1135c61f21c4d41e754dbd72c52
-  data.tar.gz: 89a2a43c030b76e63f8375ed81a16d32d60746c27bc5e0fd324cc6ba343df0f8
+  metadata.gz: 953fc8645d51046e0ea9f3cf943d07d297f0e69894aea97ae986ea3793949eff
+  data.tar.gz: f2c5c2ff02cb1c8491794a0c48ccc7e045a95880d10a67b889e7a7ac1dd4592d
 SHA512:
-  metadata.gz: 19e144f8851d3be73ae5adea066debfce38035e7610d6cd1993ed59c99f83dcef80c5f601b427d1089746ce89e8ce0280ef2f9e0a59baf51983d42a78e90e8df
-  data.tar.gz: 6831bf06bb73be3911670220c8ff0330cda9e8aa4b9da694fc7b2cdf05e2ee269d5772a695df6607e81f10171cf95c46e000825d7ae1107bf3a052ffaada5463
+  metadata.gz: 21a1bc280d86b3f1c666f48c69fee633e047eae3cfc662c2bcde713acc2554575749557e01dce83c5629605db15a252d724dc4dc2560b45409ce0b0bb73c830e
+  data.tar.gz: f5324b187dc3c3113e486f90a89f9e1e2979286f732c5402fac5ac624e138eb2172bb4afa3a70d185912889a1c445deb6176af9fd4a8a39a0b4f9b67b66a0f07

data/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "10:00"
+    timezone: America/Toronto
+  open-pull-requests-limit: 99
+  reviewers:
+  - Shopify/intl-languages
+  registries:
+  - rubygems-server-pkgs-shopify-io

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

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

@@ -1,7 +1,12 @@
 name: CI
 
 on:
-  - push
+  pull_request:
+    branches:
+      - '**'
+  push:
+    branches:
+      - master
 
 jobs:
   build:
@@ -12,11 +17,11 @@ jobs:
     strategy:
       matrix:
         version:
-          - 2.4
-          - 2.5
-          - 2.6
           - 2.7
           - 3.0
+          - 3.1
+          - 3.2
+          - 3.3
         gemfile:
           - Gemfile
     steps:

data/.ruby-version

@@ -0,0 +1 @@
+2.7.5

data/CHANGELOG.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## Unreleased
 Nil.
 
+## [0.9.1] - 2024-06-27
+### Added
+- Added support for pseudolocalized translations [#82](https://github.com/Shopify/pseudolocalization/pull/82)
+
+## [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)
@@ -48,7 +56,9 @@ Nil.
 
 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.8.4...HEAD
+[Unreleased]: https://github.com/Shopify/pseudolocalization/compare/0.9.1...HEAD
+[0.9.1]: https://github.com/Shopify/pseudolocalization/compare/0.9.0...0.9.1
+[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

data/Gemfile

@@ -1,10 +1,4 @@
-ruby '>= 2.4'
-
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pseudolocalization.gemspec
 gemspec
-
-group :deployment do
-  gem 'package_cloud'
-end

data/Gemfile.lock

@@ -1,53 +1,21 @@
 PATH
   remote: .
   specs:
-    pseudolocalization (0.8.4)
+    pseudolocalization (0.9.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    highline (1.6.20)
-    http-accept (1.7.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    json_pure (1.8.1)
-    mime-types (3.2.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    minitest (5.14.3)
-    netrc (0.11.0)
-    package_cloud (0.3.05)
-      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
+    minitest (5.14.4)
     rake (13.0.3)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    thor (0.20.3)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   minitest (~> 5.0)
-  package_cloud
   pseudolocalization!
   rake (~> 13.0)
 
-RUBY VERSION
-   ruby 3.0.0p0
-
 BUNDLED WITH
-   2.2.4
+   2.2.22

data/README.md

@@ -1,11 +1,11 @@
-# Pseudolocalization [![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)
+# Pseudolocalization
 
-[gem]: https://badge.fury.io/rb/pseudolocalization.svg
-[gem_url]: https://rubygems.org/gems/pseudolocalization
+[![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)
 
-> 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.
+[About this repo](#about-this-repo) | [How to use this repo](#how-to-use-this-repo) | [Contribute to this repo](#contribute-to-this-repo)
 
-## Why?
+## 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.
 
@@ -25,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:
 
@@ -51,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.
 
@@ -59,8 +60,21 @@ 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.
+
+```ruby
+I18n.backend = Pseudolocalization::I18n::Backend.new(I18n.backend)
+I18n.backend.ignores = ['ignored*', /Waldo.$/]
+```
+
+### How to run tests
 
-## Other Resources
+```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)
@@ -68,6 +82,9 @@ I18N_BACKEND=pseudolocalization bundle exec rails server
 * [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.7.2
+  - ruby
   - bundler
 
 commands:

data/lib/pseudolocalization/version.rb

@@ -1,3 +1,3 @@
 module Pseudolocalization
-  VERSION = "0.8.4"
+  VERSION = "0.9.1"
 end

data/lib/pseudolocalization.rb

@@ -5,9 +5,12 @@ module Pseudolocalization
   module I18n
     class Backend
       attr_reader :original_backend
+      attr_accessor :ignores
 
       def initialize(original_backend)
         @original_backend = original_backend
+        @ignores = []
+        yield self if block_given?
       end
 
       def method_missing(name, *args, &block)
@@ -23,8 +26,51 @@ module Pseudolocalization
       end
 
       def translate(locale, key, options)
+        return original_backend.translate(locale, key, options) if key_ignored?(key)
+
         ::Pseudolocalization::I18n::Pseudolocalizer.pseudolocalize(original_backend.translate(locale, key, options))
       end
+
+      def translations
+        original = original_backend.translations
+        original.transform_values do |locale_translations|
+          pseudolocalize_node(locale_translations)
+        end
+      end
+
+      private
+
+      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
+            Rails.logger.tagged('Pseudolocalization I18n').error('Ignore type unsupported. Expects an array of (mixed) Regexp or Strings.')
+            false
+          end
+        end
+      end
+
+      def pseudolocalize_node(node, scope = [])
+        if node.is_a?(Hash)
+          node.each_with_object({}) do |(key, value), memo|
+            memo[key] = pseudolocalize_node(value, scope + [key])
+          end
+        elsif !key_ignored?(scope.join('.'))
+          ::Pseudolocalization::I18n::Pseudolocalizer.pseudolocalize(node)
+        else
+          node
+        end
+      end
+
+      def init_translations
+        original_backend.send(:init_translations)
+      end
     end
   end
 end

data/pseudolocalization.gemspec

@@ -10,10 +10,16 @@ Gem::Specification.new do |spec|
   spec.email         = ["christ.blais@gmail.com"]
   spec.licenses      = ['MIT']
 
+  spec.required_ruby_version = ">= 2.7"
+
   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.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

data/service.yml

@@ -1,9 +1 @@
-org_line: International Growth
-director: christianblais
-owners:
-- Shopify/intl-languages
-- Shopify/intl-eng
-slack_channels:
-  - intl-dev
-classification: library
-ci_url: https://github.com/Shopify/pseudolocalization/workflows/CI
+--- {}

data/{shipit.yml → shipit.rubygems.yml}

@@ -5,7 +5,3 @@ ci:
     - 'Ruby 2.6 Gemfile'
     - 'Ruby 2.7 Gemfile'
     - 'Ruby 3 Gemfile'
-deploy:
-  override:
-    - bundle exec rake build
-    - bundle exec package_cloud push shopify/gems pkg/*.gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pseudolocalization
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.1
 platform: ruby
 authors:
 - Christian Blais
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,10 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dependabot/config.yml"
-- ".github/probots.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/cla.yml"
 - ".github/workflows/ruby-ci.yml"
 - ".gitignore"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -63,12 +64,13 @@ files:
 - lib/pseudolocalization/version.rb
 - pseudolocalization.gemspec
 - service.yml
-- shipit.yml
+- shipit.rubygems.yml
 homepage: https://github.com/Shopify/pseudolocalization
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -76,15 +78,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key:
+rubygems_version: 3.5.13
+signing_key: 
 specification_version: 4
 summary: Internationalization development tool
 test_files: []

data/.dependabot/config.yml

@@ -1,13 +0,0 @@
-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:
-      - larouxn
-      - ChristianBlais

data/.github/probots.yml

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