pseudolocalization 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca597fc6e2ea40f05915ef289dc48d3deb1c95872aec4a8b69474caeabfc8b39
-  data.tar.gz: 7485fd957362b90aeedd711c4197c96b8629d641896fa65e77f016a613a486b6
+  metadata.gz: '090ec80bbdb475a3a34314d973d911af6ae22121c50bb5bf9ca0fc9e9801df4c'
+  data.tar.gz: 6850bb50f3ccd2767ad8b5080c1616a7e82a7d5321d30568adb419efc1f06140
 SHA512:
-  metadata.gz: 6d238815d07f095314e6fbbca25a71ea44543e8a8d57a1b4c3fc2f7d55a5e76b56d75cd7a8f308ed89757ee3710fd4e5e0dcfd4d5ce3968ca065535a4e01a824
-  data.tar.gz: 35e98480b647dc3203e2c09248db82dd060d08d77032c410cfc76492eaa4775e214a07fe9582429a57025a1da7e641bde3cb95cf4ef9f9029777abd61fb350bf
+  metadata.gz: 319d0c9e1f9aa8ac9439312e1ddba612a7a9f403f989cb056b79a8d909103425be7bcaa89ed45d89368b1b692ea7ae706ca055f72a8081055f0211a3cd1784f1
+  data.tar.gz: 967d013f09fbe58c769b441e3bfcc43154d0fb94922e7ab2e8c46c50dc02a106a7ef3fb97bd1e280412778e1b7526d5b206da417172c3c381054027b6bf75d9b

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+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

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

@@ -6,26 +6,32 @@ on:
       - '**'
   push:
     branches:
-      - master
+      - main
 
 jobs:
   build:
     name: Ruby ${{ matrix.version }} ${{ matrix.gemfile }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
     strategy:
+      # Report every Ruby independently. Without this, one failing job
+      # cancels its siblings and hides their results.
+      fail-fast: false
       matrix:
+        # Quoted on purpose. Unquoted, YAML reads 3.0 as the number 3 and
+        # setup-ruby then installs "latest 3.x" instead of Ruby 3.0.
         version:
-          - 2.4
-          - 2.5
-          - 2.6
-          - 2.7
-          - 3.0
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - '3.4'
         gemfile:
           - Gemfile
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
 
       - name: Set up Ruby ${{ matrix.version }}
         uses: ruby/setup-ruby@v1

data/.ruby-version

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

data/CHANGELOG.md

@@ -6,6 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## Unreleased
 Nil.
 
+## [0.10.0] - 2026-10-12
+### Fixed
+- Fixed slow matching in `ESCAPED_REGEX` on strings with many unclosed `<`, `{{`, `%{` or `&` (CWE-1333). Lazy wildcards became character classes bounded by each token's own delimiters. Output is unchanged or improved for well-formed input; a token containing a nested opener of its own kind (`<b <i>x</i>`, `{{ a {b} }}`, `&a&amp;`) is no longer swallowed up to the first closer. Quoted HTML attribute values may now contain `<` and `>`.
+- `ESCAPED_REGEX` now also preserves HTML comments (`<!-- -->`), Liquid tags (`{% %}`), markup spanning a newline, and `{`/`}` inside quoted Liquid strings; a `<` not followed by a letter, `/`, `!` or `?` is treated as text; a URL ends at `<` or `>`; only well-formed character references (`&name;`, `&#39;`, `&#x27;`) are kept. Output is unchanged for every string in Shopify Core's English locale files except 19 Liquid email subjects, where `{% if … %}` tags are now preserved instead of pseudolocalized.
+
+## [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)
@@ -52,7 +61,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.9.0...HEAD
+[Unreleased]: https://github.com/Shopify/pseudolocalization/compare/v0.10.0...HEAD
+[0.10.0]: https://github.com/Shopify/pseudolocalization/compare/v0.9.1...v0.10.0
+[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

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    pseudolocalization (0.9.0)
+    pseudolocalization (0.10.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.14.3)
-    rake (13.0.3)
+    minitest (5.25.4)
+    rake (13.2.1)
 
 PLATFORMS
   ruby
@@ -18,4 +18,4 @@ DEPENDENCIES
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.2.4
+   2.4.22

data/README.md

@@ -1,6 +1,6 @@
 # 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)
+[![Version][gem]][gem_url] [![Build Status](https://github.com/Shopify/pseudolocalization/workflows/CI/badge.svg?branch=main)](https://github.com/Shopify/pseudolocalization/actions?query=workflow%3ACI)
 
 [About this repo](#about-this-repo) | [How to use this repo](#how-to-use-this-repo) | [Contribute to this repo](#contribute-to-this-repo)
 
@@ -9,7 +9,7 @@
 
 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.";
+As an example, let's examine the string "Set the power switch to 0.":
 
 | Language | String | Characters | Percentage |
 |----------|--------|------------|------------|
@@ -25,6 +25,12 @@ 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
 
+For the example above, this looks like:
+
+| Language | String | Characters | Percentage |
+|----------|--------|------------|------------|
+| Pseudo-English | Ṣḛḛṭ ṭḥḛḛ ṗṓṓẁḛḛṛ ṡẁḭḭṭͼḥ ṭṓṓ 0. | 32 chars | 23% more
+
 ## How to use this repo
 ### Installation
 

data/dev.yml

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

data/lib/pseudolocalization/pseudolocalizer.rb

@@ -3,11 +3,13 @@ module Pseudolocalization
     class Pseudolocalizer
       ESCAPED_REGEX = Regexp.new("(#{
         [
-          "<.*?>",
-          "{{.*?}}",
-          "%{.*?}",
-          "https?:\/\/\\S+",
-          "&\\S*?;"
+          "<!--(?:[^-]|-[^-])*-->",                                            # HTML comment
+          "<[a-zA-Z/!?][^<>\"']*(?:(?:\"[^\"]*\"|'[^']*')[^<>\"']*)*>",         # HTML tag, end tag, doctype
+          "{{[^{}\"']*(?:(?:\"[^\"]*\"|'[^']*')[^{}\"']*)*}}",                 # Liquid output
+          "{%-?\\s*[a-zA-Z#][^%\"']*(?:(?:\"[^\"]*\"|'[^']*')[^%\"']*)*%}",    # Liquid tag
+          "%{[^{}\\n]*}",                                                      # Ruby I18n interpolation
+          "https?:\/\/[^\\s<>]+",                                             # URL
+          "&(?:[a-zA-Z][a-zA-Z0-9]*|#[0-9]+|#[xX][0-9a-fA-F]+);",              # HTML character reference
         ].join('|')
       })")
 

data/lib/pseudolocalization/version.rb

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

data/lib/pseudolocalization.rb

@@ -31,6 +31,13 @@ module Pseudolocalization
         ::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)
@@ -48,6 +55,22 @@ module Pseudolocalization
           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,6 +10,8 @@ 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"

data/service.yml

@@ -1,7 +1 @@
-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

@@ -1,7 +1,8 @@
 ci:
   require:
-    - 'Ruby 2.4 Gemfile'
-    - 'Ruby 2.5 Gemfile'
-    - 'Ruby 2.6 Gemfile'
     - 'Ruby 2.7 Gemfile'
-    - 'Ruby 3 Gemfile'
+    - 'Ruby 3.0 Gemfile'
+    - 'Ruby 3.1 Gemfile'
+    - 'Ruby 3.2 Gemfile'
+    - 'Ruby 3.3 Gemfile'
+    - 'Ruby 3.4 Gemfile'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pseudolocalization
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Christian Blais
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,10 +44,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
@@ -69,7 +69,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -77,15 +76,14 @@ 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.0.3
-signing_key: 
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Internationalization development tool
 test_files: []

data/.dependabot/config.yml

@@ -1,12 +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:
-      - Shopify/intl-languages

data/.github/probots.yml

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