tolgee_liquid 0.1.1 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd9abf93aafe9fcbc1382685660eae4a7f6bb56fc7552559732f49833032892
-  data.tar.gz: '08ea31a081f4aba7f8c55adf989ffbf4b3c591784eb76706984125de2e716c42'
+  metadata.gz: 135c8ea7a31e3de305940140011512b70acbcb3a2f1b1ce11ee576c8c5ae4837
+  data.tar.gz: 9cf05ee3c4c5e8616fc83788300c6d14f50ab8b22401dcd9f05ab87e2881d16a
 SHA512:
-  metadata.gz: bf3feac6e7028c221788d4a25acae048db1bff38bda024516b98902deda0682b5879093f5a800673b6634c67944bdf6e594250d78379b209d9bcc6ceeb389dd4
-  data.tar.gz: b4ec4b5de66a1e1927ed5e14c96e681894373fdbfb3151e8150b01ba7c6279c18df6a8714c868c73dd8c1626db38139672f084836331704081a03ae08dc98057
+  metadata.gz: ec5446a4b41750ef8b374ecb1bd8bbbb77d1afc2c29e134067e587b52206c48bf0e767b0f22fdbe1a70714322e4d23bbaca9f8575b5b5751a9370f61076300ab
+  data.tar.gz: 486b3b5a4fd57539dd567d88f1488786b3253977a98eba3767b40d59a460e01f89b0e8a9a10cb99203609331b12ff358d7bd52d35b1016c24a3abd9d88358afb

data/.travis.yml

@@ -4,4 +4,25 @@ 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 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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tolgee_liquid (0.1.1)
+    tolgee_liquid (0.1.8)
       message_format (~> 0.0.8)
 
 GEM
@@ -12,7 +12,7 @@ GEM
     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

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,13 +23,87 @@ 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.
+
+### Register `t` method for Liquid
+There are two ways to setup.
+
+#### 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.
+
+#### 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
 
-TODO: Write usage instructions here
+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
 
@@ -32,7 +113,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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/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"
+sed -i "s/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/version.rb

@@ -1,3 +1,3 @@
 module TolgeeLiquid
-  VERSION = "0.1.1"
+  VERSION = "0.1.8"
 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.8
 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
@@ -96,6 +96,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/deploy
 - bin/setup
 - lib/tolgee_liquid.rb
 - lib/tolgee_liquid/translate.rb
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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