jekyll-translations 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f072fa67b86fd28d693032f390a3c9328364dbe
-  data.tar.gz: 18490b493a89dbec2c72be8f7fdb8521826fb724
+SHA256:
+  metadata.gz: 6d67696a7fe385237d6ea65429cc759c40caaae0fc0d04b646405593c792b5b3
+  data.tar.gz: 94e6b3251c933d79e524f0515fe277209ab2a5ec540148a0ef32200f659a44ab
 SHA512:
-  metadata.gz: 4b8c37a27179ce8a0800ff46b66a9e9441fb7a1248dfa1025daa8772aa54614245720c1096f8054a13f217124bb3b3c3305c22e7b248a76a4e872c946658f5d6
-  data.tar.gz: eaba7423c0883035b99fff0abd9a60f68b56bd6c40023f3a544b2a820d0e9aba4ca55cd668b7753b40cdd3db127008c96f12e97af08e1925fd9a217d0323b9a2
+  metadata.gz: cb51ce3fe0b04c37d5b0a32f8bfb836a93abccf53f978935c976da715c6d08b5f4c68aad9b388c2fe6befcb21ecaccddeab79b1753d2ee5207c51b86f6310243
+  data.tar.gz: 94404d93696ef1ea6c4b9d54a63f651730a86b6e80f1af1381765ea203320a3d9e6c29c484dee8430f025bedea837041504503ae97bab981acab722f86114cb6

data/.github/workflows/release.yml

@@ -0,0 +1,55 @@
+name: release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: [ubuntu-latest]
+
+    steps:
+      - name: Release Please
+        uses: GoogleCloudPlatform/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: jekyll-translations
+          bump-minor-pre-major: true
+          version-file: "lib/jekyll/version.rb"
+
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+
+  publish-gem:
+    runs-on: [ubuntu-latest]
+    needs: [release-please]
+    if: ${{ needs.release-please.outputs.release_created }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+
+      - name: Install the bundle
+        run: bundle install
+
+      - name: publish gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem

data/.gitignore

@@ -5,3 +5,4 @@
 /doc/
 /pkg/
 /tmp/
+.gem

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## [2.0.0](https://github.com/researchsquare/jekyll-translations/compare/v1.0.0...v2.0.0) (2023-09-25)
+
+
+### ⚠ BREAKING CHANGES
+
+* Force 2.0.0 version
+
+### Features
+
+* Add optional wrapping of translation with html tag ([4ed6c89](https://github.com/researchsquare/jekyll-translations/commit/4ed6c899207701d6d0bf3b76a361eaaec53deb11))
+* Force 2.0.0 version ([2f37b24](https://github.com/researchsquare/jekyll-translations/commit/2f37b24974f5e34bee4c5357654992d27d80f540))

data/jekyll-translations.gemspec

@@ -1,8 +1,12 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/version'
+
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-translations"
-  spec.version       = "1.0.0"
-  spec.authors       = ["Jordan Dalton"]
-  spec.email         = ["jordan.dalton@researchsquare.com"]
+  spec.version       = Jekyll::Translations::VERSION
+  spec.authors       = ["Research Square Company Engineering"]
+  spec.email         = ["customer@researchsquare.com"]
   spec.require_paths = ["lib"]
   spec.summary       = %q{Translation tool for Jekyll}
   spec.homepage      = "https://github.com/researchsquare/jekyll-translations"

data/lib/jekyll/translations.rb

@@ -16,6 +16,7 @@ module Jekyll
             @translations = []
             @localizationContext = nil
             @skipTranslationCheck = nil
+            @showTerm = false
             @debug_translations = false
 
             def translations(locale)
@@ -24,6 +25,7 @@ module Jekyll
                 site = @context.registers[:site]
                 config = site.config['translations']
                 @skipTranslationCheck = config['skipTranslationCheck']
+                @showTerm = !!config['showTerms']
                 @debug_translations = !@skipTranslationCheck and ENV['DEBUG_TRANSLATIONS'].to_i === 1
 
                 translation_data = site.data['translations'][locale]
@@ -43,6 +45,28 @@ module Jekyll
                 return translated_hash
             end
 
+            def show_translation_term(translation, tag)
+                if @showTerm && !@showTermOverride
+                    return "<#{tag} title=\"#{@lastTerm}\">#{translation}</#{tag}>"
+                end
+
+                return translation
+            end
+
+            def tns(text, args = [])
+                @showTermOverride = true;
+
+                translated = self.t(text, args)
+                
+                @showTermOverride = false;
+
+                return translated
+            end
+
+            def ts(translation)
+                return self.show_translation_term(translation, 'div')
+            end
+
             def t(text, args = [])
                 # If we've an array, translate each item and return
                 return self.translate_array(text) if text.kind_of?(Array)
@@ -75,8 +99,15 @@ module Jekyll
                     args = args.to_s
                 end
 
-                return (@translations[text] % args) if not args.empty?
-                return @translations[text]
+                if not args.empty?
+                    translated = (@translations[text] % args)
+                else
+                    translated = @translations[text]
+                end
+
+                @lastTerm = text
+
+                return self.show_translation_term(translated, 'span')
             end
         end
     end

data/lib/jekyll/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+    module Translations
+        VERSION = "2.0.0"
+    end
+end

data/lib/jekyll-translations.rb

@@ -1 +1,2 @@
 require 'jekyll/translations'
+require 'jekyll/version'

metadata

@@ -1,31 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-translations
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
-- Jordan Dalton
+- Research Square Company Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
-- jordan.dalton@researchsquare.com
+- customer@researchsquare.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - bin/console
 - bin/setup
-- jekyll-translations-0.1.1.gem
 - jekyll-translations.gemspec
 - lib/jekyll-translations.rb
 - lib/jekyll/translations.rb
+- lib/jekyll/version.rb
 homepage: https://github.com/researchsquare/jekyll-translations
 licenses:
 - MIT
@@ -45,8 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Translation tool for Jekyll