tolgee_liquid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 115f1b6b36f7ce8170a03661eafb9f994c8f4f8756323e5c384d5190d73bb58c
+  data.tar.gz: 360ce4f158ead855313cb7346ec7b25bf2ab15586c1de6e7c81595f40420b96e
+SHA512:
+  metadata.gz: 435f14d941be45e2985fd91aa8d1a980f3a420d7201c60e2dbe63340f6e563935c9c89e0d87e8bfd20fc0b8bd7906e47db70f0161dc1a9e9dfb3207784d76567
+  data.tar.gz: f2e7948c8f45cc4942c1385a66036ca63ac20bee6a759d6a5f647d5c3b6e3ad2935440bb8bdb8e977bee313fa1838a163d67b09134b1d57b79d2528aaf337bea

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,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    tolgee_liquid (0.1.0)
+      message_format (~> 0.0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    bigdecimal (3.1.8)
+    camertron-eprun (1.1.1)
+    cldr-plurals-runtime-rb (1.1.0)
+    concurrent-ruby (1.3.1)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    hashdiff (1.1.0)
+    message_format (0.0.8)
+      twitter_cldr (~> 6.0)
+    public_suffix (5.0.5)
+    rake (10.5.0)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    strscan (3.1.0)
+    twitter_cldr (6.12.1)
+      camertron-eprun
+      cldr-plurals-runtime-rb (~> 1.1)
+      tzinfo
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tolgee_liquid!
+  webmock (~> 3.23)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Allen He
+
+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,39 @@
+# TolgeeLiquid
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tolgee_liquid`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tolgee_liquid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tolgee_liquid
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/tolgee_liquid.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "tolgee_liquid"
+
+# 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/tolgee_liquid/translate.rb

@@ -0,0 +1,54 @@
+require 'net/http'
+require 'message_format'
+
+class Translate
+  def initialize
+    @tolgee_api_url = TolgeeLiquid.configuration.api_url
+    @tolgee_api_key = TolgeeLiquid.configuration.api_key
+    @tolgee_project_id = TolgeeLiquid.configuration.project_id
+  end
+
+  def execute(name, vars = {}, opts)
+    locale = opts[:locale]
+    dev_mode = opts[:mode] == 'development'
+    static_data = opts[:static_data]
+    dict = dev_mode ? get_remote_dict(locale.to_s) : static_data[locale.to_sym]
+    value = fetch_translation(dict, name)
+    return name if value.nil?
+
+    translation = MessageFormat.new(value, locale.to_s).format(vars.transform_keys(&:to_sym))
+
+    if dev_mode
+      message = { k: name }.to_json
+      hidden_message = ZeroWidthCharacterEncoder.new.execute(message)
+      "#{translation}#{hidden_message}"
+    else
+      translation
+    end
+  end
+
+  def fetch_translation(dict, name)
+    name.split('.'.freeze).reduce(dict) do |level, cur|
+      return nil if level[cur].nil?
+
+      level[cur]
+    end
+  end
+
+  def get_remote_dict(locale)
+    @remote_dict ||= begin
+      url = URI("#{@tolgee_api_url}/v2/projects/#{@tolgee_project_id}/translations/#{locale}")
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true if url.scheme == 'https'
+
+      request = Net::HTTP::Get.new(url)
+      request['Accept'] = 'application/json'
+      request['X-API-Key'] = @tolgee_api_key
+
+      response = http.request(request)
+      JSON.parse(response.body)[locale]
+    rescue
+      {}
+    end
+  end
+end

data/lib/tolgee_liquid/version.rb

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

data/lib/tolgee_liquid/zero_width_character_encoder.rb

@@ -0,0 +1,19 @@
+class ZeroWidthCharacterEncoder
+  INVISIBLE_CHARACTERS = ["\u200C", "\u200D"].freeze
+
+  def execute(text)
+    bytes = text.bytes
+    binary = bytes.map { |byte| to_binary_with_extra_non_join_character(byte) }.join
+    to_invisible_string(binary)
+  end
+
+  private
+
+  def to_binary_with_extra_non_join_character(byte)
+    "#{byte.to_s(2).rjust(8, '0')}0"
+  end
+
+  def to_invisible_string(binary)
+    binary.chars.map { |bit| INVISIBLE_CHARACTERS[bit.to_i].encode('utf-8') }.join
+  end
+end

data/lib/tolgee_liquid.rb

@@ -0,0 +1,56 @@
+require "tolgee_liquid/version"
+require "tolgee_liquid/translate"
+require "tolgee_liquid/zero_width_character_encoder"
+
+module TolgeeLiquid
+  class << self
+    attr_accessor :configuration
+
+    class Configuration
+      attr_accessor :api_url, :api_key, :project_id
+    end
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    def registers(options)
+      options.slice(:locale, :static_data, :mode)
+    end
+  end
+end
+
+def with_tolgee(method_name)
+  original_method = instance_method(method_name)
+  define_method(method_name) do |*args, &fn|
+    mode = @context.registers[:mode] || 'production'
+    locale = @context.registers[:locale] || I18n.default_locale
+
+    if mode == 'development'
+      message = { k: args.first }.to_json
+      hidden_message = ZeroWidthCharacterEncoder.new.execute(message)
+
+      t = Translate.new
+      dict = t.get_remote_dict(locale)
+      value = t.fetch_translation(dict, args.first)
+      return args.first if value.nil?
+
+      translation = MessageFormat.new(value, locale.to_s).format(args.second&.transform_keys(&:to_sym))
+      "#{translation}#{hidden_message}"
+    else
+      original_method.bind(self).call(*args, &fn)
+    end
+  end
+end
+
+module TolgeeFilter
+  def t(name, vars = {})
+    opts = {
+      locale: @context.registers[:locale] || I18n.default_locale,
+      mode: @context.registers[:mode] || 'production',
+      static_data: @context.registers[:static_data] || {},
+    }
+    Translate.new.execute(name, vars, opts)
+  end
+end

data/tolgee_liquid.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tolgee_liquid/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tolgee_liquid"
+  spec.version       = TolgeeLiquid::VERSION
+  spec.authors       = ["Allen He"]
+  spec.email         = ["pooopooo543@gmail.com"]
+
+  spec.summary       = %q{Tolgee Integration for Liquid}
+  spec.description   = %q{A gem that integrate Tolgee Platform to Shopify Liquid template engine.}
+  spec.license       = "MIT"
+
+  # 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_dependency 'message_format', '~> 0.0.8'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.23"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: tolgee_liquid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Allen He
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: message_format
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: 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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+description: A gem that integrate Tolgee Platform to Shopify Liquid template engine.
+email:
+- pooopooo543@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tolgee_liquid.rb
+- lib/tolgee_liquid/translate.rb
+- lib/tolgee_liquid/version.rb
+- lib/tolgee_liquid/zero_width_character_encoder.rb
+- tolgee_liquid.gemspec
+homepage: 
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Tolgee Integration for Liquid
+test_files: []