octopress-multilingual 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f88280a6ba9bc3da6a1d14232454780c116c1101
-  data.tar.gz: 9a111ba706ab49eb94ee5fedb61dca7111e086eb
+  metadata.gz: 981b8a85ae89b0b5e014752f4a7aa40f91e7fb57
+  data.tar.gz: f072ab8273a2e0768b726c6fd842d67bd3df279d
 SHA512:
-  metadata.gz: 6739a5a56c07b022fae9e1a5a37c3079376f604b1cef538acde7c40bd7fcb1c22b33181e3e053563d6c9cc320f8ef8c37dc6e7a29470d4838d5b90ba76b39a54
-  data.tar.gz: 9c5e311e5e2499896d99eb496821d030b09f40f42ad468e2c54e71d6e3b51d9aa90076cc4c3a581ecc83cbde15d25b42f1ef40a664f430149cc261f99be31e06
+  metadata.gz: ca81dc779eca08eee26031d3a211916c13f8c0a4b5b7702abfc190c01215c9804b6e53e3fdb4ae70cd343bbd57d3ef89bae1c85f8465389517c69da112314404
+  data.tar.gz: 372f2fff3287ce3498303f0cc9af335d1638d43ea0c593cab5665e07a4b2fe44701284d671fb93c5ae3b42c41c0fa6e1e87849969629005da42834970f7015a9

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### 1.1.0 (2015-02-16)
+- New: Tags and Categories are now also filtered by language.
+
 ### 1.0.2 (2015-02-10)
 - Fix: Page permalinks were getting set to by language names.
 

data/README.md

@@ -7,6 +7,7 @@ Add multiple language features to your Jekyll site. This plugin makes it easy to
 - Use language in your permalinks. 
 - Cross-post a single post to all languages.
 - Add translation dictionaries to simplify site templates.
+- Tag and category indexes are automatically filtered by language.
 
 [![Build Status](http://img.shields.io/travis/octopress/multilingual.svg)](https://travis-ci.org/octopress/multilingual)
 [![Gem Version](http://img.shields.io/gem/v/octopress-multilingual.svg)](https://rubygems.org/gems/octopress-multilingual)
@@ -43,13 +44,20 @@ Note: First-party Octopress plugins are designed to support multilingual sites b
 
 Also, if you are using flags to represent languages on your site, you might like to read, [Why flags do not represent language](http://flagsarenotlanguages.com/blog/why-flags-do-not-represent-language/).
 
+## Helpful Plugins
+
+These plugins automatically add multilingual features to your site when used with Octopress Multilingual.
+
+- [Octopress Linkblog](https://github.com/octopress/linkblog) adds link-blogging indexes (articles-only, links-only) and feeds for each language.
+- [Octopress Feeds](https://github.com/octopress/feeds) adds RSS feeds for each language.
+
 ## Setup
 
 When adding this plugin to your site, you will need to:
 
 1. Configure your site's main language, e.g. `lang: en`.
 2. Add a language to the YAML front-matter of your posts, e.g. `lang: de`.
-3. Add new RSS feeds and post indexes for secondary languages.
+3. Add post indexes and RSS feeds for secondary languages.
 
 First, be sure to configure your Jekyll site's main language. An site written primarily in English would add this to its Jekyll configuration:
 
@@ -112,7 +120,8 @@ lang: en
 If your default post index is at `/index.html` you should create additional indexes for each secondary language. If you also write in German, you can create a posts index at `/de/index.html`. This approach will work for post archives and RSS feeds, though if you are using [octopress-feeds](https://github.com/octopress/feeds), RSS feeds for each language will be generated automatically.
 
 How does it work? First this plugin groups all of your posts by language. Then at build time, any page with a language defined will
-have its posts filtered to display only matching languages. If your site uses [octopress-linkblog](https://github.com/octopress/linkblog) to publish link-posts, your `site.articles` and `site.linkposts` will be filtered as well.
+have its posts filtered to display only matching languages. This also works for `site.categories` and `site.tags`.
+If your site uses [octopress-linkblog](https://github.com/octopress/linkblog) to publish link-posts, your `site.articles` and `site.linkposts` will be filtered as well.
 
 ## Site template language dictionaries
 

data/lib/octopress-multilingual/hooks.rb

@@ -12,14 +12,12 @@ module Octopress
 
         # Add translation page data to each page or post.
         #
-        [site.pages, site.posts].flatten.each do |item|
-          if item.translated
-            # Access array of translated items via (post/page).translations
-            item.data.merge!({
-              'translations' => item.translations,
-              'translated' => item.translated
-            })
-          end
+        [site.pages, site.posts].flatten.select(&:translated).each do |item|
+          # Access array of translated items via (post/page).translations
+          item.data.merge!({
+            'translations' => item.translations,
+            'translated' => item.translated
+          })
         end
       end
 
@@ -45,6 +43,14 @@ module Octopress
         end
       end
 
+      # Override deep_merge to prevent categories and tags from being combined when they shouldn't
+      #
+      def deep_merge_payload(page_payload, hook_payload)
+        %w{site page}.each do |key|
+          hook_payload[key] = page_payload[key].merge(hook_payload[key] || {})
+        end
+        hook_payload
+      end
     end
   end
 end

data/lib/octopress-multilingual/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Multilingual
-    VERSION = "1.0.2"
+    VERSION = "1.1.0"
   end
 end

data/lib/octopress-multilingual.rb

@@ -134,12 +134,43 @@ module Octopress
       end
     end
 
+    def metadata_index_by_language(index)
+      # Get site categories or tags
+      site_indexes = site.send(index)
+
+      indexes = {}
+
+      # Filter indexes for each language
+      languages.each do |lang|
+        indexes[lang] = {}
+        site_indexes.each do |index, posts|
+          posts = posts.select do |p| 
+            p.lang == lang || (lang == main_language && p.lang.nil?) || p.crosspost_languages
+          end
+
+          indexes[lang][index] = posts unless posts.empty?
+        end
+      end
+
+      indexes
+    end
+
+    def categories_by_language
+      @categories ||= metadata_index_by_language(:categories)
+    end
+
+    def tags_by_language
+      @tags ||= metadata_index_by_language(:tags)
+    end
+
     def page_payload(lang)
       payload = {
         'site' => { 
-          'posts'     => posts_by_language[lang],
-          'linkposts' => linkposts_by_language[lang],
-          'articles'  => articles_by_language[lang]
+          'posts'      => posts_by_language[lang],
+          'linkposts'  => linkposts_by_language[lang],
+          'articles'   => articles_by_language[lang],
+          'categories' => categories_by_language[lang],
+          'tags'       => tags_by_language[lang]
         },
         'lang' => lang_dict[lang]
       }
@@ -155,10 +186,12 @@ module Octopress
       if main_language
         @payload ||= {
           'site' => {
-            'posts_by_language'     => posts_by_language,
-            'linkposts_by_language' => linkposts_by_language,
-            'articles_by_language'  => articles_by_language,
-            'languages'             => languages
+            'posts_by_language'      => posts_by_language,
+            'linkposts_by_language'  => linkposts_by_language,
+            'articles_by_language'   => articles_by_language,
+            'categories_by_language' => categories_by_language,
+            'tags_by_language'       => tags_by_language,
+            'languages'              => languages
           },
           'lang' => lang_dict[main_language]
         }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-multilingual
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-hooks