jekyll-locales 0.1.9 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e6fdd0bef170f9bc080d6ed57e256e3d1ace2c0faa9c33fad9073490dd0703
-  data.tar.gz: 4637537e057a944190caaff98070168a24a30cd866da6bd1596d072f42429724
+  metadata.gz: 12ea6328cebd340c5f8b48759962e5b45cb9fe2c0082834dd7e53fb00a614206
+  data.tar.gz: c66fa0b8ed57d3d1ccdeb12d03e59e2409df5e406a9337eaad49c673456ae41e
 SHA512:
-  metadata.gz: '0768e9186dae694e308d7e4b9471543a32de53bd1f3bb45668901241245b75b4ffb38c9134133fec6884effa2b6c164ff109f1682471856e525dc37dd271c63b'
-  data.tar.gz: 367a38099307c74170cd19a88e95a70a6823c73c03a77dbb3bddad1fd8a24442b9dd2ade786670d002c4f63efe58a2d5d6b3b286da1a16f007ce81d687ae4870
+  metadata.gz: 1fdb870f42080d6002d55c415e538646f54456f99701cde27ca5cf15c70b78e1a76433e49bbfda2ba799b37f79ccf36057e1a6aa0bc815cba8790476ddc065b0
+  data.tar.gz: 3250eb037d0557c84a69714ed3b49740ae480f8c9719582be6af0fa624faffe96f268a44ded6981a6e3310cd20663e0d3226a0b27bb33b4952cad3fa02cb942f

data/.gitignore

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

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 0.1.13
+
+- Alternate URLs were adding the locale innecessarily!
+
+## 0.1.12
+
+- Reset and setup every site so generators like jekyll-archive are
+  reloaded.  Otherwise we may have data copied over from the previous
+  locale.
+
+## 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

data/README.md

@@ -64,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/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,34 @@
+# 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.documents.each do |doc|
+    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, 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

@@ -27,6 +27,8 @@ module Jekyll
         Jekyll.logger.info 'Base URL:', config['baseurl']
 
         symlink
+        reset
+        setup
         process_single
         # The default locale is placed at the root of the
         # site and everything else is under a subdirectory, but we symlink
@@ -43,6 +45,23 @@ module Jekyll
       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
 
     # Redefine #render_docs so it doesn't render the locale collections
@@ -60,10 +79,6 @@ module Jekyll
       end
     end
 
-    def locales?
-      locales.size > 1
-    end
-
     def locale_config
       # XXX: Retrocompatibility
       config['locale'] = config['lang'] = locale
@@ -80,19 +95,6 @@ module Jekyll
       config['baseurl'] = locale_baseurl
     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
-
     # Read the other locales as collections but don't render them, only
     # make them available to templates.
     #
@@ -173,6 +175,7 @@ module Jekyll
     end
 
     def self_symlink
+      FileUtils.rm_f(locale_destination)
       FileUtils.ln_s('.', locale_destination)
     end
   end

data/lib/jekyll/locales/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Locales
-    VERSION = '0.1.9'
+    VERSION = '0.1.13'
   end
 end

data/lib/jekyll/locales.rb

@@ -4,3 +4,5 @@ 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-locales
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.13
 platform: ruby
 authors:
 - f
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2021-11-08 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,7 +89,9 @@ 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
@@ -101,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
@@ -116,8 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+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.9)
-
-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.1.4