jekyll-translations 0.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 193b4cab49b666311eab24cb81b1ae8c304b4f5b
-  data.tar.gz: acce204fa83860d1ea53d12e49240e1754f8f0b5
+SHA256:
+  metadata.gz: 6d67696a7fe385237d6ea65429cc759c40caaae0fc0d04b646405593c792b5b3
+  data.tar.gz: 94e6b3251c933d79e524f0515fe277209ab2a5ec540148a0ef32200f659a44ab
 SHA512:
-  metadata.gz: 06fb12b5f0022d131bca1a2771db68a289c616439e878dcdf0f45f1f60b0d423a5e3ecc1c856de7a7b134060496cfd647715c60259d8125c849e316fcf2b1cd8
-  data.tar.gz: d3e94990bce50e346ce0ad1d6b1cd7f7d9d26e5e6354fc3207ea7a547391ff9c25dc62885b00a6177cabe0a198f264388c80bab3f5a4eeaacb8e2c36fb60cfe2
+  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/README.md

@@ -1,8 +1,6 @@
 # Jekyll::Translations
 
-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/jekyll/translations`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a Jekyll plugin to manage translations from a variety of sources, including AWS S3 and PO Editor.
 
 ## Installation
 
@@ -22,14 +20,4 @@ Or install it yourself as:
 
 ## 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]/jekyll-translations.
+If added correctly to the Gemfile, this plugin should work as a seamless replacement to local versions of the plugin that we have been using on our frontend Jekyll sites.

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       = "0.1.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

@@ -5,9 +5,10 @@ module Jekyll
     module Translations
         class Generator < Jekyll::Generator
             def generate(site)
-                translation_source = site.config['translations']['source']
+                translation_sources = site.config['translations']['sources']
 
-                site.data['translations'] = JSON.parse(open(translation_source).read)
+                site.data['translations'] = {}
+                translation_sources.each { |key, value| site.data['translations'][key] = JSON.parse(open(value).read) }
             end
         end
 
@@ -15,17 +16,19 @@ module Jekyll
             @translations = []
             @localizationContext = nil
             @skipTranslationCheck = nil
+            @showTerm = false
             @debug_translations = false
 
-            def translations
+            def translations(locale)
                 return @translations if @translations
 
                 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']
+                translation_data = site.data['translations'][locale]
                 translations = translation_data['common']
 
                 if config['context'] and translation_data[config['context']]
@@ -42,11 +45,36 @@ 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)
 
-                @translations = self.translations
+                page = @context.environments.first['page']
+                locale = page['locale'] ? page['locale'] : 'default'
+
+                @translations = self.translations(locale)
 
                 # Uncomment the following block to see a list of items missing translations
                 # if @translations[text].nil?
@@ -71,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,23 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-translations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.0.0
 platform: ruby
 authors:
-- Jordan Dalton
+- Research Square Company Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-10 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
@@ -25,6 +27,7 @@ files:
 - jekyll-translations.gemspec
 - lib/jekyll-translations.rb
 - lib/jekyll/translations.rb
+- lib/jekyll/version.rb
 homepage: https://github.com/researchsquare/jekyll-translations
 licenses:
 - MIT
@@ -44,8 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Translation tool for Jekyll