pseudo_l10n 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c57ea9e349e911eb327be71d880ff488f1c11aeb30f9d8bde8c8250886e10cd
+  data.tar.gz: ef641dcd92862f2c632a5f08ac5a5805223f5b3f913ea9e5a463d18f286ebe9f
+SHA512:
+  metadata.gz: 72061e39781fcaf8e84ca349d4d51e7fec06a4ab700bcc653705e2d3506c3aef8d79d10ff1da7f02164ec9d7349990ae14125e0bb26fe1b974a81aa014680f3b
+  data.tar.gz: d4d774c505da06be2b6a4273c5c357968776f20b3a18d7be80f1ebb1cbf82599300b80b12f5fef1295266a1b42cc4a06af961d682752d7ddf4fc06a8938d6fdd

data/.github/workflows/push_gem.yml

@@ -0,0 +1,36 @@
+name: Push Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository == 'aergonaut/pseudo_l10n'
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      # Set up
+      - name: Harden Runner
+        uses: step-security/harden-runner@v2.8.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+# We want Exclude directives from different
+# config files to get merged, not overwritten
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  # Standard's config uses custom cops,
+  # so it must be loaded along with custom Standard gems
+  - standard
+  - standard-custom
+  - standard-performance
+  # rubocop-performance is required when using Performance cops
+  - rubocop-performance
+
+inherit_gem:
+  standard: config/base.yml
+  # You can also choose a Ruby-version-specific config
+  # standard: config/ruby-3.0.yml
+  # Standard plugins must be loaded separately (since v1.28.0)
+  standard-performance: config/base.yml
+  standard-custom: config/base.yml
+
+# Sometimes we enable metrics cops
+# (which are disabled in Standard by default)
+#
+# Metrics:
+#   Enabled: true
+
+# Global options, like Ruby version
+AllCops:
+  SuggestExtensions: false
+
+Style/ArgumentsForwarding:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aergonaut@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pseudo_l10n.gemspec
+gemspec
+
+group :development do
+  gem "rubocop"
+  gem "standard", "~> 1.39", require: false
+  gem "syntax_tree"
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    pseudo_l10n (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    prettier_print (1.2.1)
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.1)
+      strscan
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.39.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    strscan (3.1.0)
+    syntax_tree (6.2.0)
+      prettier_print (>= 1.2.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-23
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2)
+  i18n (>= 1.12)
+  pseudo_l10n!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  standard (~> 1.39)
+  syntax_tree
+
+BUNDLED WITH
+   2.3.21

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Chris Fung
+
+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,77 @@
+# `PseudoL10n`
+
+`PseudoL10n` is a simple gem to add pseudolocalization to Ruby projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pseudo_l10n'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pseudo_l10n
+
+## Usage
+
+### Integration with `I18n`
+
+This gem provides a `PseudoL10n::Backend` class that is compatible with the `i18n` gem to provide automatic pseudolocalization to your project.
+
+To use the backend, wrap your existing `I18n.backend` with the `Backend` class from this gem:
+
+```ruby
+I18n.backend = PseudoL10n::Backend.new(I18n.backend)
+```
+
+### Pseudo-Locale
+
+This gem generates a pseudo-locale at runtime by applying varius transformations to strings from the source locale. By
+default the source locale is `:en`. You may change the source locale by setting `PseudoL10n.source_locale` to a
+different value:
+
+```ruby
+PseudoL10n.source_locale = :de
+```
+
+To activate pseudolocalization, set the current `I18n.locale` to the special pseudolocale code. By default, this code is
+the `source_locale` code with `-ZZ` appended. For example, the pseudo-locale code for `:de` would be `de-ZZ`. You may change the pseudo-locale code by setting `PseudoL10n.pseudo_locale` to a different value:
+
+```ruby
+PseudoL10n.pseudo_locale = :qps
+```
+
+### Low-level Transformer API
+
+This gem also provides a low-level transformer API. This can be used to transform a string according to pseudolocale rules.
+
+```ruby
+message = "Hello world"
+
+PseudoL10n::Transformer.call(message)
+# => "√Ｈｅｌｌｏ ｗｏｒｌｄ√"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pseudo_l10n. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PseudoL10n project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pseudo_l10n/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pseudo_l10n"
+
+# 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/lib/pseudo_l10n/backend.rb

@@ -0,0 +1,51 @@
+module PseudoL10n
+  class Backend
+    attr_reader :original_backend
+
+    def initialize(original_backend)
+      @original_backend = original_backend
+    end
+
+    def method_missing(name, *args, &block)
+      if respond_to_missing?(name)
+        original_backend.public_send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      original_backend.respond_to?(name) || super
+    end
+
+    def translate(locale, key, options)
+      if locale.to_sym == PseudoL10n.pseudo_locale
+        locale = PseudoL10n.source_locale
+        original = original_backend.translate(locale, key, options)
+        ::PseudoL10n::Transformer.call(original)
+      else
+        original_backend.translate(locale, key, options)
+      end
+    end
+
+    def translations
+      original = original_backend.translations
+      source_translations = original[PseudoL10n.source_locale] || {}
+      original[PseudoL10n.pseudo_locale] = ::PseudoL10n::Transformer.call(
+        source_translations
+      )
+      original
+    end
+
+    def available_locales
+      available = original_backend.available_locales
+      available << PseudoL10n.pseudo_locale
+    end
+
+    protected
+
+    def init_translations
+      original_backend.send(:init_translations)
+    end
+  end
+end

data/lib/pseudo_l10n/transformer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module PseudoL10n
+  module Transformer
+    module_function
+
+    MARKER = "√"
+    TEMPLATE = "%{marker}%{msg}%{marker}"
+
+    ESCAPE_PATTERN =
+      Regexp.new(
+        "(#{
+          ["<.*?>", "{{.*?}}", "%{.*?}", "https?://\\S+", "&\\S*?;"].join("|")
+        })"
+      )
+
+    def call(original)
+      if original.is_a?(Hash)
+        original.transform_values { |value| call(value) }
+      elsif original.is_a?(Array)
+        original.map { |value| call(value) }
+      elsif original.is_a?(String)
+        result = original
+        result = lengthen_string(result)
+        mark_string(result)
+      else
+        original
+      end
+    end
+
+    def mark_string(string)
+      format(TEMPLATE, marker: MARKER, msg: string)
+    end
+
+    def lengthen_string(string)
+      parts =
+        string
+          .split(ESCAPE_PATTERN)
+          .map do |part|
+            part.match?(ESCAPE_PATTERN) ? part : half_to_full_width(part)
+          end
+
+      parts.join
+    end
+
+    def half_to_full_width(string)
+      string.tr("0-9a-zA-Z", "０-９ａ-ｚＡ-Ｚ")
+    end
+  end
+end

data/lib/pseudo_l10n/version.rb

@@ -0,0 +1,3 @@
+module PseudoL10n
+  VERSION = "0.1.0"
+end

data/lib/pseudo_l10n.rb

@@ -0,0 +1,22 @@
+require "pseudo_l10n/version"
+
+module PseudoL10n
+  def self.pseudo_locale=(locale)
+    @pseudo_locale = locale&.to_sym
+  end
+
+  def self.pseudo_locale
+    @pseudo_locale || :"#{source_locale}-ZZ"
+  end
+
+  def self.source_locale=(locale)
+    @source_locale = locale&.to_sym
+  end
+
+  def self.source_locale
+    @source_locale || :en
+  end
+end
+
+require "pseudo_l10n/transformer"
+require "pseudo_l10n/backend"

data/pseudo_l10n.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pseudo_l10n/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pseudo_l10n"
+  spec.version = PseudoL10n::VERSION
+  spec.authors = ["Chris Fung"]
+  spec.email = ["aergonaut@gmail.com"]
+
+  spec.summary = "Simple utility for pseudo-localization in Ruby"
+  spec.homepage = "https://github.com/aergonaut/pseudo_l10n"
+  spec.license = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata[
+      "source_code_uri"
+    ] = "https://github.com/aergonaut/pseudo_l10n.git"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+            "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files =
+    Dir.chdir(File.expand_path("..", __FILE__)) do
+      `git ls-files -z`.split("\x0")
+        .reject { |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 "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "i18n", ">= 1.12"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: pseudo_l10n
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Fung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: 
+email:
+- aergonaut@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/push_gem.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pseudo_l10n.rb
+- lib/pseudo_l10n/backend.rb
+- lib/pseudo_l10n/transformer.rb
+- lib/pseudo_l10n/version.rb
+- pseudo_l10n.gemspec
+homepage: https://github.com/aergonaut/pseudo_l10n
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aergonaut/pseudo_l10n
+  source_code_uri: https://github.com/aergonaut/pseudo_l10n.git
+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: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: Simple utility for pseudo-localization in Ruby
+test_files: []