jekyll-locales 0.1.5 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e1e9d8ecdf4cc772d076592e186830a038f6efde890bf3df4fc0fba88ccf840
-  data.tar.gz: 7c0f9126b109040cbf0629209103651ee34974dd72f1bd47b9eac995b666c567
+  metadata.gz: 8064e214d9d871fab3a7d775064068f01acbf3194d8776601be47b245452b783
+  data.tar.gz: e00d19218061374a29e73baea210ad871535ff40c5bf3e775b5d1fa57ed04f5c
 SHA512:
-  metadata.gz: db58ab601603d7fb0571e7932f092b62df6949d5956278f35554e72732351f6eeb9a03e80083debb5651faad30f39e8933e43f017ae19fae71196a539b06219b
-  data.tar.gz: 265e7024461aa7001bece672057fcb899947b11c07c7a43102b1955fa55e2ddb375405ff01b6e07a98e93bbf445b54cddb3ffc51afad019e98a07e39aca8fffc
+  metadata.gz: 5b14589c075687b8f9c498b9b670339b37901690b4b51aebcd6b994d68d4b53d12ed47f42579df9abf8afd46a6585d7d3888eff420b22b79c742759b1325934e
+  data.tar.gz: 59d3a80ac8136b4b5e15343b4f25598c1468cde8797b6efae816f1303995d92c4559b9d26e73a460cea269965017e34dcf664d67eb2765b26534d385c043e612

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.1.11
+
+- Add alternate URLs to link between languages when using
+  jekyll-linked-posts
+
+## 0.1.10
+
+- Prevent cleanup from removing other languages
+
+## 0.1.9
+
+- Loading locales as collection makes Jekyll render them even when
+  they're not part of output.  This version prevents that.  A site with
+  three languages was taking 160 seconds before and 60 after patching!
+
+## 0.1.8
+
+- Load other locales as collections to make them available in templates.
+  Compatible with
+  [jekyll-linked-posts](https://rubygems.org/gems/jekyll-linked-posts).
+
 ## 0.1.0
 
 - Localized Jekyll sites

data/README.md

@@ -33,10 +33,13 @@ locales:
 - en
 - ahr
 - brasileiro
+redirect: true
 ```
 
-**The first locale is going to be your default locale**.  It doesn't do
-much, but still have it in mind.
+**The first locale is going to be your default locale**.  If you use
+a redirector.html, it will be the locale it will redirector to.  If you
+don't use a redirector, the default locale will be at the root of the
+site.
 
 ## Posts
 
@@ -61,6 +64,12 @@ locales:
 
 Then you can access them by using `page.locales` in your layout.
 
+**Tip:** You can use
+[jekyll-linked-posts](https://rubygems.org/gems/jekyll-linked-posts) to
+make this process more resilient.  It uses IDs instead of URLs and it
+also allows you to access other data.  From v0.1.11 it will also
+generate alternate URLs so search engines can link between translations.
+
 ### Pages
 
 You can translate the front matter by adding locale-specific variables

data/jekyll-locales.gemspec

@@ -35,6 +35,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rubocop', '~> 0.74'
 end

data/lib/jekyll/locales.rb

@@ -2,4 +2,7 @@
 
 require 'jekyll/site'
 require 'jekyll/locales/site'
+require 'jekyll/locales/site_drop'
 require 'jekyll/locales/hooks/page_post_init'
+require 'jekyll/locales/hooks/post_render'
+require 'jekyll/locales/hooks/cleanup'

data/lib/jekyll/locales/hooks/cleanup.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# We keep a global variable with the site in it because we can't access
+# it from the cleanup hook.
+$site = nil
+
+# Only run on the default locale since it's going to be in the root
+# destination
+Jekyll::Hooks.register :site, :post_render do |site|
+  next unless site.locales?
+  next unless site.default_locale?
+
+  $site = site
+end
+
+# Keep files in other locales since they're not generated by the default
+# locale.
+Jekyll::Hooks.register :clean, :on_obsolete do |obsolete|
+  next if $site.nil?
+
+  $site.locales.each do |locale|
+    next if locale == $site.locale
+
+    obsolete.delete_if do |x|
+      x.sub($site.dest + '/', '').start_with? locale
+    end
+  end
+end

data/lib/jekyll/locales/hooks/post_render.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Jekyll::Hooks.register :site, :post_render do |site|
+  unless site.config['plugins'].include? 'jekyll-linked-posts'
+    Jekyll.logger.warn 'Enable jekyll-linked-posts to generate metadata about alternate pages'
+    next
+  end
+
+  # URLs can be relative but Google asks for fully qualified URLs
+  # @see {https://support.google.com/webmasters/answer/189077?hl=en}
+  url = site.config['url']&.sub(%r{/\z}, '')
+
+  unless url
+    Jekyll.logger.warn 'Provide a `url` value in configuration to create fully qualified URLs'
+    next
+  end
+
+  site.each_site_file do |doc|
+    next unless doc.is_a? Jekyll::Document
+    next if doc.output.nil?
+    next unless doc&.data&.dig 'locales'
+
+    alternate = doc.data['locales'].map do |translation|
+      locale = translation.collection.label
+      # TODO: Every doc should know how to build their own URL
+      doc_url = [url, locale, translation.url].join('/')
+
+      %(<link rel="alternate" hreflang="#{locale}" href="#{doc_url}" />)
+    end
+
+    next if alternate.empty?
+
+    doc.output.sub! '<head>', '<head>' + alternate.join
+  end
+end

data/lib/jekyll/locales/site.rb

@@ -28,21 +28,53 @@ module Jekyll
 
         symlink
         process_single
+        # The default locale is placed at the root of the
+        # site and everything else is under a subdirectory, but we symlink
+        # root to default_locale for compatibility
+        self_symlink if default_locale? && !redirect?
       end
 
-      if locales?
-        copy_redirector
-        default_delete
-        default_symlink
-      else
-        self_symlink
-      end
+      # XXX: Default is expected by Sutty so we always create it
+      default_delete
+      default_symlink
+
+      # If we enable the redirector, the root of the site will consist
+      # of an index.html that allows visitors to select their locale.
+      copy_redirector if redirect?
+    end
+
+    def locales?
+      locales.length > 1
+    end
+
+    # Get locales from configuration
+    def locales
+      @locales ||= config.fetch('locales', [])
+    end
+
+    def default_locale
+      @default_locale ||= locales.first
+    end
+
+    def default_locale?
+      default_locale == locale
     end
 
     private
 
-    def locales?
-      locales.size > 1
+    # Redefine #render_docs so it doesn't render the locale collections
+    # for each independent locale.
+    #
+    # XXX: Jekyll should render on demand instead of rendering and
+    # writing separately.
+    def render_docs(payload)
+      collections.each do |name, collection|
+        next if locales.include? name
+
+        collection.docs.each do |document|
+          render_regenerated(document, payload)
+        end
+      end
     end
 
     def locale_config
@@ -50,19 +82,32 @@ module Jekyll
       config['locale'] = config['lang'] = locale
       config['default_locale'] = default_locale
 
+      # Don't touch the config unless there's more than one locale or we
+      # aren't using a redirector
       return unless locales?
 
+      other_locales_as_collections
+      return if default_locale? && !redirect?
+
       @dest = config['destination'] = locale_destination
       config['baseurl'] = locale_baseurl
     end
 
-    # Get locales from configuration
-    def locales
-      @locales ||= config.fetch('locales', [])
-    end
-
-    def default_locale
-      locales.first
+    # Read the other locales as collections but don't render them, only
+    # make them available to templates.
+    #
+    # The URL will be the permalink with the language prepended.
+    #
+    # {https://rubygems.org/gems/jekyll-linked-posts}
+    def other_locales_as_collections
+      locales.each do |l|
+        next if l == locale
+
+        config['collections'][l] = {
+          'output' => false,
+          'permalink' => [nil, l, config['permalink']].join('/')
+        }
+      end
     end
 
     # Cache original destination
@@ -92,6 +137,10 @@ module Jekyll
       FileUtils.ln_s("_#{locale}", '_posts')
     end
 
+    def redirect?
+      config.fetch('redirect', false)
+    end
+
     # TODO: Make configurable
     def redirector
       @redirector ||= File.join(locale_destination, 'redirector.html')
@@ -124,6 +173,7 @@ module Jekyll
     end
 
     def self_symlink
+      FileUtils.rm_f(locale_destination)
       FileUtils.ln_s('.', locale_destination)
     end
   end

data/lib/jekyll/locales/site_drop.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'jekyll/drops/site_drop'
+
+module Jekyll
+  module Drops
+    # Make i18n available to Liquid as site.i18n
+    class SiteDrop
+      def i18n
+        @i18n ||= @obj.data[@obj.config['lang']]
+      end
+    end
+  end
+end

data/lib/jekyll/locales/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Locales
-    VERSION = '0.1.5'
+    VERSION = '0.1.11'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-locales
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.11
 platform: ruby
 authors:
 - f
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-27 00:00:00.000000000 Z
+date: 2020-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,6 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -90,8 +89,11 @@ files:
 - jekyll-locales.gemspec
 - lib/jekyll-locales.rb
 - lib/jekyll/locales.rb
+- lib/jekyll/locales/hooks/cleanup.rb
 - lib/jekyll/locales/hooks/page_post_init.rb
+- lib/jekyll/locales/hooks/post_render.rb
 - lib/jekyll/locales/site.rb
+- lib/jekyll/locales/site_drop.rb
 - lib/jekyll/locales/version.rb
 homepage: https://0xacab.org/sutty/jekyll/jekyll-locales
 licenses:
@@ -100,7 +102,7 @@ metadata:
   homepage_uri: https://0xacab.org/sutty/jekyll/jekyll-locales
   source_code_uri: https://0xacab.org/sutty/jekyll/jekyll-locales
   changelog_uri: https://0xacab.org/sutty/jekyll/jekyll-locales/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,9 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Jekyll plugin for localized sites
 test_files: []

data/Gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jekyll-locales (0.1.5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.4.1)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  jekyll-locales!
-  minitest (~> 5.0)
-  rake (~> 10.0)
-  rubocop (~> 0.74)
-
-BUNDLED WITH
-   2.0.2