jekyll_i18n_multi_page 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c5ddb36f4854a6045602943d170083ee5c51d1d48af49d295e6df760853e652
+  data.tar.gz: 3df4b08e1376a156a9598282c647be92ceccd6e9e16d915a8db44d21f96576ec
+SHA512:
+  metadata.gz: 979de192576658b9386ecddf2dfe9a13e0f281681c05499bb39926f563f247def71ec374ba143542074a58956444b3be1aca6a8ecdb0ef94ad7ccaa4f02b4cb9
+  data.tar.gz: 59038f63b591d94c69432eb7924e81ee2340e0c8adf14eea962cedb664b3326dc8a6dd0ef27b5c644253a9232009f143497b633597bc94f7b05f52f3bc3c63b4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/dist/
+/tmp/
+/pkg/
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+script:
+  - bundle exec rspec

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 jekyll_i18n_multi_page.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    jekyll_i18n_multi_page (0.1.0)
+      activesupport (~> 6.0)
+      i18n (~> 1.6)
+      jekyll (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    ffi (1.11.1)
+    forwardable-extended (2.6.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.6.3)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 3)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-watch (1.5.1)
+      listen (~> 3.0)
+    json (2.2.0)
+    kramdown (1.17.0)
+    liquid (4.0.3)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (0.3.6)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.1.1)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rouge (2.2.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  jekyll_i18n_multi_page!
+  pry (~> 0.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.17)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yi Feng
+
+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,109 @@
+# Jekyll I18n MultiPage
+
+Generate multiple pages for different locales based on single template.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll_i18n_multi_page'
+```
+
+And then execute:
+
+    $ bundle
+
+Add the plugin to  `_config.yml` file:
+
+```yml
+plugins:
+  - jekyll_i18n_multi_page
+```
+
+## Usage
+
+Declare available locales in your website in `_config.yml`:
+
+```yml
+i18n:
+  - path: /
+    locale: en
+  - path: /tw
+    locale: zh-TW
+``` 
+
+For each entry must contain `path`(the output of localized page) and `locale`.
+
+Define files with localized contents in `_i18n` folder, filenames aren't mattered. For examples:
+
+```yml
+# _i18n/my-en-site.yml
+en:
+  index:
+    title: English title
+    hello: Hello
+```
+
+```yml
+# _i18n/my-tw-site.yml
+zh-TW:
+  index:
+    title: 中文標題
+    hello: 哈囉
+```
+
+`page.i18n` is the way to access the current localized contents, said you have a HTML named `index.html` with content as the following:
+```html
+---
+---
+{{ page.i18n.hello }}
+```
+
+After building of Jekyll, the dist folder should have two files `index.html` and `tw/index.html`
+
+Assume you have a file named `some/where/my.html` you should have its path in the localization file:
+```yml
+# _i18n/my-en-site.yml
+en:
+  some:
+    where:
+      my:
+        hello: Hello # access this text via page.i18n.hello
+```
+
+## Use cases
+
+**For some reason, I have a page which is only available for certain locales**
+
+```html
+---
+i18n_locales: ['zh-TW']
+---
+{{ page.i18n.hello }}
+```
+Using `i18n_locales` to declare the support locales. Then Jekyll will build `tw/index.html` file only.
+
+**How to disable the features on certain pages**
+
+```html
+---
+i18n_disabled: true
+---
+```
+Using `i18n_disabled` to tell the plugin do not do anything for me.
+
+**Translate helper**
+
+```
+{% t index.hello %}
+```
+`t` tag provides a way to translate content. When you take this way, you must write a full path.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yfxie/jekyll_i18n_multi_page. 
+
+## 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 "jekyll_i18n_multi_page"
+
+# 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/jekyll_i18n_multi_page.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll_i18n_multi_page/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll_i18n_multi_page"
+  spec.version       = JekyllI18nMultiPage::VERSION
+  spec.authors       = ["Yi Feng"]
+  spec.email         = ["yfxie@me.com"]
+
+  spec.summary       = %q{Jekyll plugin for handling I18n multiple pages.}
+  spec.description   = %q{Generate multiple pages for different locales based on single template.}
+  spec.homepage      = "https://github.com/yfxie/jekyll_i18n_multi_page"
+  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.require_paths = ["lib"]
+
+  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 "pry", "~> 0.12"
+  spec.add_development_dependency "simplecov", "~> 0.17"
+  spec.add_dependency "jekyll", "~> 3.0"
+  spec.add_dependency "i18n", "~> 1.6"
+  spec.add_dependency "activesupport", "~> 6.0"
+end

data/lib/jekyll_i18n_multi_page/page_extension.rb

@@ -0,0 +1,22 @@
+module JekyllI18nMultiPage
+  module PageExtension
+    def translate_key
+      path.gsub('/','.')
+        .gsub(/\.(html|md)$/,'')
+    end
+
+    def i18n_disabled
+      data['i18n_disabled']
+    end
+
+    def template
+      return super if i18n_disabled
+      "/:i18n_path#{super}"
+    end
+
+    def url_placeholders
+      return super if i18n_disabled
+      super.merge({ i18n_path: data['i18n_path'] })
+    end
+  end
+end

data/lib/jekyll_i18n_multi_page/translate_tag.rb

@@ -0,0 +1,14 @@
+module JekyllI18nMultiPage
+  class TranslateTag < Liquid::Tag
+    attr_accessor :markup
+
+    def initialize(tag_name, translate_path, tokens)
+      super
+      @translate_path = translate_path.strip
+    end
+
+    def render(context)
+      I18n.t(@translate_path, locale: context['page']['i18n_locale'])
+    end
+  end
+end

data/lib/jekyll_i18n_multi_page/version.rb

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

data/lib/jekyll_i18n_multi_page.rb

@@ -0,0 +1,46 @@
+require 'jekyll'
+require 'i18n'
+require 'active_support/core_ext/hash'
+require 'jekyll_i18n_multi_page/version'
+require 'jekyll_i18n_multi_page/page_extension'
+require 'jekyll_i18n_multi_page/translate_tag'
+
+module JekyllI18nMultiPage; end
+
+
+Jekyll::Page.class_eval do
+  prepend JekyllI18nMultiPage::PageExtension
+end
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  I18n.load_path << Dir[File.join(site.config['source'], '_i18n', '**/*.{yml,yaml}')]
+end
+
+Jekyll::Hooks.register :site, :post_read do |site|
+  config = site.config['i18n']
+
+  locale_config_mappings = config.reduce({}) do |map, config|
+    map[config['locale']] = config
+    map
+  end
+
+  site.pages = site.pages.flat_map do |page|
+    next page if page.i18n_disabled
+
+    locales = page.data['i18n_locales'] || locale_config_mappings.keys
+    locales.map do |locale|
+      config = locale_config_mappings[locale]
+      i18n_hash = I18n.t(page.translate_key, locale: locale)
+      data = page.data.clone.tap do |data|
+        data['i18n_locale'] = locale
+        data['i18n'] = i18n_hash.is_a?(Hash) ? i18n_hash.with_indifferent_access : {}
+        data['i18n_path'] = config['path']
+      end
+      page.clone.tap do |p|
+        p.data = data
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('t', JekyllI18nMultiPage::TranslateTag)

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_i18n_multi_page
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yi Feng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-22 00:00:00.000000000 Z
+dependencies:
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Generate multiple pages for different locales based on single template.
+email:
+- yfxie@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll_i18n_multi_page.gemspec
+- lib/jekyll_i18n_multi_page.rb
+- lib/jekyll_i18n_multi_page/page_extension.rb
+- lib/jekyll_i18n_multi_page/translate_tag.rb
+- lib/jekyll_i18n_multi_page/version.rb
+homepage: https://github.com/yfxie/jekyll_i18n_multi_page
+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
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin for handling I18n multiple pages.
+test_files: []