jekyll-locales 0.1.4 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f624b6ce22236cefd09c7a87d223595565a4d54e16eb99af05f8a3e870a514f8
-  data.tar.gz: 740a7f2e5efe294d6be4d3ae2b5bd01aaa2171d4130497ac46adcde76866095e
+  metadata.gz: 6b8cd80411bc24509a21502d5972966dd9cb990ec1716aacc19724855e8c957b
+  data.tar.gz: 557fdfd91a846aa99f180076b186ddf21fad118cc0b01de438e66e0a7303c2bd
 SHA512:
-  metadata.gz: 3eca8c0b1d7ab98b58fd46a5f4445f66af25a0390a90d9501325a0b85d6c60244258b9e53f8117681fa97b30ff5acc980242ee00a0c3ab3de096deb1ad593dab
-  data.tar.gz: 27f25f04d670cba30d79f7706c63b7fe9500affe6fd37098dc2c146bb260726c880891503820e8ddbb4e3cee3a8659136aba3e7af13cf3f06a10b1efdfd0df39
+  metadata.gz: 2d3826a63a1f0d581e4c9a0e516680fe012f99c88d6ad62a761e61140a3a25f1c71ca9ea08853155c7a817d3919f32715c0b20dd9d87c1383e052984c55832a5
+  data.tar.gz: 5471c147d18a8bd76445857b4251902c454d09f123e4e64e177fd7df02c0d4b1789b465c465e590ca8f590f9539af9fc35602623579137d8b8acabb161cb2b5f

data/.gitignore

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

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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
 

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,6 @@
 
 require 'jekyll/site'
 require 'jekyll/locales/site'
+require 'jekyll/locales/site_drop'
 require 'jekyll/locales/hooks/page_post_init'
+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/site.rb

@@ -28,19 +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
 
-      return unless locales?
-
-      copy_redirector
+      # 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
@@ -48,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
@@ -90,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')
@@ -120,5 +171,9 @@ module Jekyll
     def default_symlink
       FileUtils.ln_s(default_locale, default_destination)
     end
+
+    def self_symlink
+      FileUtils.ln_s('.', locale_destination)
+    end
   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.4'
+    VERSION = '0.1.10'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-locales
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.10
 platform: ruby
 authors:
 - f
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-27 00:00:00.000000000 Z
+date: 2020-05-27 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,10 @@ 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/site.rb
+- lib/jekyll/locales/site_drop.rb
 - lib/jekyll/locales/version.rb
 homepage: https://0xacab.org/sutty/jekyll/jekyll-locales
 licenses:
@@ -115,8 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Jekyll plugin for localized sites

data/Gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jekyll-locales (0.1.4)
-
-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