tolgee_liquid 0.1.1 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd9abf93aafe9fcbc1382685660eae4a7f6bb56fc7552559732f49833032892
-  data.tar.gz: '08ea31a081f4aba7f8c55adf989ffbf4b3c591784eb76706984125de2e716c42'
+  metadata.gz: dca99fd61c6ef48a8ed0e9859d8bf699018694413886d2fcca125715ae469487
+  data.tar.gz: 6a87046ae897d9c133ff9b8f5898f0d10d0008faf7f5fb6ce1e92bac957226c0
 SHA512:
-  metadata.gz: bf3feac6e7028c221788d4a25acae048db1bff38bda024516b98902deda0682b5879093f5a800673b6634c67944bdf6e594250d78379b209d9bcc6ceeb389dd4
-  data.tar.gz: b4ec4b5de66a1e1927ed5e14c96e681894373fdbfb3151e8150b01ba7c6279c18df6a8714c868c73dd8c1626db38139672f084836331704081a03ae08dc98057
+  metadata.gz: 73eea62ed05227aa481dc869095f1beaad7ee32aa7f9079e15aebcfa4549e69a8ee7644692b089afd27f978d94047fbb248cab3f0ab3de0fb0e495a241c2a9b0
+  data.tar.gz: 03b837fa231f52f88fd2eeae62f1b059fb27684a20dd5ce21f23a6f844b31643fb14d38ab7ab5d5e98cd7a5adffe2e981f2434a25ab0f89c1456eeb8d11e0110

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*.rb

data/.ruby-version

@@ -0,0 +1 @@
+2.6.10

data/.travis.yml

@@ -4,4 +4,26 @@ language: ruby
 cache: bundler
 rvm:
   - 2.6.10
-before_install: gem install bundler -v 1.17.2
+
+before_install:
+  - gem install bundler -v 1.17.2
+
+script:
+  - bin/setup
+  - bundle exec rubocop
+  - bundle exec rake spec
+  - gem build tolgee_liquid.gemspec
+
+before_deploy:
+  - export TRAVIS_TAG=$(git describe --tags --abbrev=0)
+
+deploy:
+  provider: rubygems
+  api_key: "$RUBYGEMS_API_KEY"
+  on:
+    tags: true
+
+branches:
+  only:
+    - main
+    - /^v\d+(\.\d+(\.\d+)?)?$/

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+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

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tolgee_liquid (0.1.1)
+    tolgee_liquid (0.1.9)
       message_format (~> 0.0.8)
 
 GEM
@@ -9,19 +9,30 @@ GEM
   specs:
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
     bigdecimal (3.1.8)
     camertron-eprun (1.1.1)
     cldr-plurals-runtime-rb (1.1.0)
-    concurrent-ruby (1.3.1)
+    concurrent-ruby (1.3.2)
     crack (1.0.0)
       bigdecimal
       rexml
     diff-lcs (1.5.1)
     hashdiff (1.1.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
     message_format (0.0.8)
       twitter_cldr (~> 6.0)
+    parallel (1.24.0)
+    parser (3.3.2.0)
+      ast (~> 2.4.1)
+      racc
     public_suffix (5.0.5)
+    racc (1.8.0)
+    rainbow (3.1.1)
     rake (10.5.0)
+    regexp_parser (2.9.2)
     rexml (3.2.8)
       strscan (>= 3.0.9)
     rspec (3.13.0)
@@ -37,6 +48,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     strscan (3.1.0)
     twitter_cldr (6.12.1)
       camertron-eprun
@@ -44,6 +68,7 @@ GEM
       tzinfo
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
     webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -54,8 +79,10 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.17)
+  i18n (~> 1.14)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 1.50)
   tolgee_liquid!
   webmock (~> 3.23)
 

data/README.md

@@ -1,11 +1,18 @@
 # 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.
+A Ruby gem that integrates the [Tolgee Platform](https://tolgee.io/integrations) with Shopify's [Liquid template language](https://github.com/Shopify/liquid).
 
-TODO: Delete this and the text above, and describe your gem
+If you are developing a multilingual web application using the Liquid template language, check out the Tolgee Platform (translation as a service). It enhances your translation workflow, making it more efficient and accurate.
+
+This gem focuses on the "In-Context" translation integration. See the example project at https://github.com/cccccroge/tolgee-rails-liquid.
 
 ## Installation
 
+### Prerequisite
+Make sure you have liquid installed.
+
+### Install
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -16,23 +23,99 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install tolgee_liquid
+### Setup Credentials
+Add the following block to your application initialization. If you are using Rails, place it in config/initializers/tolgee.rb:
 
-## Usage
+```.rb
+TolgeeLiquid.configure do |config|
+  config.api_url = 'https://example.tolgee.io'
+  config.api_key = <TOLGEE_API_KEY>
+  config.project_id = <TOLGEE_PROJECT_ID>
+end
+```
+This allows the gem to fetch data from the corresponding Tolgee project in development mode.
 
-TODO: Write usage instructions here
+### Register `t` method for Liquid
+There are two ways to setup.
 
-## Development
+#### Use Decorator
+If you already have your own translation method `t` defined.
+```.rb
+module MyFilterContainsTranslationMethod
+  def t(name, vars = {})
+    # Own implementation
+  end    
+end
+
+Liquid::Template.register_filter(MyFilterContainsTranslationMethod)
+```
+
+Add the prefix `with_tolgee` on translation method:
+```.rb
+module MyFilterContainsTranslationMethod
+  with_tolgee def t(name, vars = {})
+    # Own implementation
+  end    
+end
+```
+
+Note that the arguments of the original t method must match the format above (the first argument being the translation key, and an optional hash argument providing variables for string interpolation). Otherwise, it won't work correctly.
 
-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.
+#### Use gem's `t` method
+You can use the t method provided by the gem, which utilizes ICU MessageFormat patterns under the hood.
+
+```.rb
+Liquid::Template.register_filter(TolgeeFilter)
+```
+
+### Use `t` filter in Liquid template
+
+Example Liquid snippet:
+```.html
+<div>{{ 'key.nested_key' | t: fruit: 'Pitaya' }}</div>
+```
+
+Example application's controller code for Rails project:
+```.rb
+class PagesController < ApplicationController
+  def index
+    # get liquid template file...
+    template = Liquid::Template.parse(liquid)
+
+    # provide translations and meta data 
+    tolgee_registers = TolgeeLiquid.registers({
+      locale: 'en',
+      mode: 'development',
+      static_data: {
+        en: YAML.load_file(Rails.root.join('config', 'locales', 'en.yml')),
+      },
+    })
+    
+    html = template.render({}, registers: tolgee_registers)
+    # put html to view...
+  end
+end
+```
+
+Example translation yaml file:
+```.yml
+key:
+  nested_key: "I like {fruit}!"
+```
+
+## Development
 
-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).
+- Run `install dependencies` to install dependencies.
+- Run `rake spec` to run the tests.
+- Run `bin/console` for an interactive prompt that will allow you to experiment.
+- Run `rubocop` to find code smells.
+- Run `bin/deploy` to release a new version
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tolgee_liquid.
+Bug reports and pull requests are welcome.
 
 ## License
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "tolgee_liquid"
+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.
@@ -10,5 +11,5 @@ require "tolgee_liquid"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/deploy

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+set -e
+
+current_branch=$(git rev-parse --abbrev-ref HEAD)
+
+# Make sure we are on "main"
+if [ "$current_branch" != "main" ]; then
+  echo "Error: You must be on 'main' to deploy."
+  exit 1
+fi
+
+# Get commits to release
+last_release_tag=$(git describe --tags --abbrev=0)
+commits=$(git log --pretty=format:"%h %s" $last_release_tag..HEAD)
+
+if [ -z "$commits" ]; then
+  echo "No new commits to release."
+  exit 0
+fi
+
+# Preview commits
+echo "Commits to be released:"
+while read -r commit_hash commit_message; do
+  pr_title=$(git log -1 --pretty="%b" $commit_hash | sed -n '/^Pull Request Title:/s/^Pull Request Title: //p')
+  echo "$commit_hash $commit_message"
+  if [ -n "$pr_title" ]; then
+    echo "  Pull Request Title: $pr_title"
+  fi
+done <<< "$commits"
+
+# Bump version
+read -p "Bump version (major/minor/patch)? " version_bump
+current_version=$(ruby -r ./lib/tolgee_liquid/version.rb -e "puts TolgeeLiquid::VERSION")
+case "$version_bump" in
+  major)
+    new_version=$(ruby -e "puts Gem::Version.new('$current_version').bump.bump.to_s")
+    ;;
+  minor)
+    new_version=$(ruby -e "puts Gem::Version.new('$current_version').bump.to_s")
+    ;;
+  patch)
+    new_version=$(ruby -e "version = Gem::Version.new('$current_version'); segments = version.segments; segments[-1] += 1; puts segments.join('.')")
+    ;;
+  *)
+    echo "Invalid version bump type."
+    exit 1
+    ;;
+esac
+
+echo "Bumping version from $current_version to $new_version"
+ruby -i -pe "gsub(/VERSION = '$current_version'/, \"VERSION = '$new_version'\")" lib/tolgee_liquid/version.rb
+
+# Create commit and tag for new version
+git add lib/tolgee_liquid/version.rb
+bundle install
+git add Gemfile.lock
+git commit -m "Bump version to $new_version" --no-edit
+git tag v$new_version
+git push origin tag v$new_version
+git push

data/lib/tolgee_liquid/translate.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'message_format'
 
+# A translator will try to get the translations, handle interpolations and convert it to static string.
+# If it's in development mode it will fetch translations from tolgee's platform.
+# Otherwise, it will use static translations provided by outside.
 class Translate
   def initialize
     @tolgee_api_url = TolgeeLiquid.configuration.api_url
@@ -8,11 +13,12 @@ class Translate
     @tolgee_project_id = TolgeeLiquid.configuration.project_id
   end
 
-  def execute(name, vars = {}, opts)
+  # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+  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]
+    dict = dev_mode ? remote_dict(locale.to_s) : static_data[locale.to_sym]
     value = fetch_translation(dict, name)
     return name if value.nil?
 
@@ -26,16 +32,18 @@ class Translate
       translation
     end
   end
+  # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
   def fetch_translation(dict, name)
-    name.split('.'.freeze).reduce(dict) do |level, cur|
+    name.split('.').reduce(dict) do |level, cur|
       return nil if level[cur].nil?
 
       level[cur]
     end
   end
 
-  def get_remote_dict(locale)
+  # rubocop:disable Metrics/MethodLength
+  def 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)
@@ -47,8 +55,9 @@ class Translate
 
       response = http.request(request)
       JSON.parse(response.body)[locale]
-    rescue
+    rescue StandardError
       {}
     end
   end
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/tolgee_liquid/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TolgeeLiquid
-  VERSION = "0.1.1"
+  VERSION = '0.1.9'
 end

data/lib/tolgee_liquid/zero_width_character_encoder.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# An string encoder that will transform original message to invisible ASCII characters.
+# See the detail in: https://tolgee.io/blog/2021/12/17/invisible-characters-for-better-localization
 class ZeroWidthCharacterEncoder
   INVISIBLE_CHARACTERS = ["\u200C", "\u200D"].freeze
 

data/lib/tolgee_liquid.rb

@@ -1,14 +1,19 @@
-require "tolgee_liquid/version"
-require "tolgee_liquid/translate"
-require "tolgee_liquid/zero_width_character_encoder"
+# frozen_string_literal: true
 
+require 'tolgee_liquid/version'
+require 'tolgee_liquid/translate'
+require 'tolgee_liquid/zero_width_character_encoder'
+
+# This allow user to configure Tolgee credentials
 module TolgeeLiquid
   class << self
     attr_accessor :configuration
 
+    # rubocop:disable Style/Documentation
     class Configuration
       attr_accessor :api_url, :api_key, :project_id
     end
+    # rubocop:enable Style/Documentation
 
     def configure
       self.configuration ||= Configuration.new
@@ -21,6 +26,7 @@ module TolgeeLiquid
   end
 end
 
+# rubocop:disable Metrics/MethodLength, Metrics/AbcSize
 def with_tolgee(method_name)
   original_method = instance_method(method_name)
   define_method(method_name) do |*args, &fn|
@@ -28,28 +34,30 @@ def with_tolgee(method_name)
     locale = @context.registers[:locale] || I18n.default_locale
 
     if mode == 'development'
-      message = { k: args.first }.to_json
+      message = { k: args[0] }.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?
+      dict = t.remote_dict(locale)
+      value = t.fetch_translation(dict, args[0])
+      return args[0] if value.nil?
 
-      translation = MessageFormat.new(value, locale.to_s).format(args.second&.transform_keys(&:to_sym))
+      translation = MessageFormat.new(value, locale.to_s).format(args[1]&.transform_keys(&:to_sym))
       "#{translation}#{hidden_message}"
     else
       original_method.bind(self).call(*args, &fn)
     end
   end
 end
+# rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
+# Expose translation method that used in Liquid filters
 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] || {},
+      static_data: @context.registers[:static_data] || {}
     }
     Translate.new.execute(name, vars, opts)
   end

data/tolgee_liquid.gemspec

@@ -1,31 +1,36 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "tolgee_liquid/version"
+require 'tolgee_liquid/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "tolgee_liquid"
+  spec.name          = 'tolgee_liquid'
   spec.version       = TolgeeLiquid::VERSION
-  spec.authors       = ["Allen He"]
-  spec.email         = ["pooopooo543@gmail.com"]
+  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"
+  spec.summary       = 'Tolgee Integration for Liquid'
+  spec.description   = '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
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.6.10'
 
   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"
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'i18n', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.50'
+  spec.add_development_dependency 'webmock', '~> 3.23'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tolgee_liquid
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.9
 platform: ruby
 authors:
 - Allen He
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-01 00:00:00.000000000 Z
+date: 2024-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: message_format
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +117,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -96,6 +126,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/deploy
 - bin/setup
 - lib/tolgee_liquid.rb
 - lib/tolgee_liquid/translate.rb
@@ -114,14 +145,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.10
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Tolgee Integration for Liquid