octopress-multilingual 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 988ada1b8e7e3a6cd445a4c440476df940673fe0
+  data.tar.gz: 3c515dec3ace3c5aa14c8ee44bfd9315821ebf06
+SHA512:
+  metadata.gz: a3e26bcc97084f9ad7c91ef0fe11f449adc7d6ffb224a70db8be66d141eba73e1874fddb753d0178a6832f8630f25beafa8dc2a85bf8082ba22ec1dba0c28dd2
+  data.tar.gz: 67599396585ab3d2b09b088274c07bb29027d23bc475a870d2275ede43ab73c8d0629bb2638ce95c20dfaaff4ad55be1dfbd1ac221282935c0056264cce56a43

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brandon Mathis
+
+MIT License
+
+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,143 @@
+# Octopress Multilingual
+
+Add multiple language features to your Jekyll site.
+
+[![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)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://octopress.mit-license.org)
+
+## Installation
+
+If you're using bundler add this gem to your site's Gemfile in the `:jekyll_plugins` group:
+
+    group :jekyll_plugins do
+      gem 'octopress-multilingual'
+    end
+
+Then install the gem with Bundler
+
+    $ bundle
+
+To install manually without bundler:
+
+    $ gem install octopress-multilingual
+
+Then add the gem to your Jekyll configuration.
+
+    gems:
+      - octopress-multilingual
+
+
+## An important note
+
+**There is not a Jekyll standard for multilingual sites** and many plugins will not work properly with this setup. Octopress and it's
+plugins are being designed to support multilingual features, but without a standard, some use-cases may be overlooked. If you have a
+problem with an Octopress plugin supporting your multilingual site, please file an issue and we'll do our best to address it.
+
+## Setting up a multilingual site
+
+When adding this plugin to your site, you will need to:
+
+1. Configure your site's main language, e.g. `main_language: 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.
+
+Read on and I'll try to walk you through setting up your multilingual site. 
+
+Note: This guide will only cover the steps listed above. Your site may still have some plugins which are not designed for multilingual sites. If you are using plugins (like a category index generator) which create pages from your site's posts, they may need to be modified or removed. Modifying plugins is beyond the scope of this guide.
+
+## Configuration
+
+First, be sure to configure your Jekyll site's main language, for example:
+
+```yaml
+main_language: en
+```
+
+Here we are setting the default language to English. Posts without a defined language will be treated as English posts.
+
+## Defining a post's language
+
+Posts should specify their language in the YAML front matter. 
+
+```yaml
+title: "Ein Nachdenklich Beitrag"
+lang: de
+```
+
+If you are using Octopress, you can easily create a new post with the language already site like this:
+
+```
+$ octopress new post "Some title" --lang en
+```
+
+### Cross-posting languages
+
+Occasionally you may wish to write a post in a single language and have it show up in other languages indexes and feeds. This can be done in your post's YAML front-matter:
+
+```
+title: "Ein Nachdenklich Beitrag"
+lang: de
+crosspost_languages: true
+```
+
+If your site has language-specific feeds or post indexes, a post with this setting will show up in all of them. However, it isn't duplicated. It will still have one canonical URL.
+
+### Language in permalinks
+
+This plugin does not use categories to add language to URLs. Instead it adds the `:lang` key to Jekyll's permalink template.
+Any post **with a defined language** will have its language in the URL. If this changes URLs for your site, you probably should [set up redirects](https://github.com/jekyll/jekyll-redirect-from).
+
+If you define your own permalink style, you may use the `:lang` key like this:
+
+```yaml
+permalink: /posts/:lang/:title/
+```
+
+If you have not specified a permalink style, or if you are using one of Jekyll's default templates, your post URLs will change to include their language.
+When using Jekyll's `pretty` url template, URLs will look like this:
+
+```
+/site_updates/en/2015/01/17/moving-to-a-multilingual-site/index.html
+/site_updates/de/2015/01/17/umzug-in-eine-mehrsprachige-website/index.html
+```
+
+This plugin updates each of Jekyll's default permalink templates to include `:lang`.
+
+```ruby
+pretty  => /:lang/:categories/:year/:month/:day/:title/
+none    => /:lang/:categories/:title.html
+date    => /:lang/:categories/:year/:month/:day/:title.html
+ordinal => /:lang/:categories/:year/:y_day/:title.html
+```
+
+If you don't want language to appear in your URLs, you must configure your own permalinks without `:lang`.
+
+## Post Indexes and RSS Feeds
+
+This plugin modifies your site's post list. The `site.posts` array **will not contain every post**, but only posts defined with your site's main language or with no language defined.
+You may access secondary languages with `site.posts_by_language`.
+
+For example, to loop through the posts written in your main language (or without a defined language) you would do this:
+
+```
+{% for post in site.posts.reverse %}
+```
+
+This is probably the way your posts index and RSS feeds are generated. If you want to loop through the posts from a secondary language — in this case, German — you would want to do this:
+
+```
+{% for post in site.posts_by_language.de.reverse %}
+```
+
+If your default post index is at `/index.html` you should create additional indexes for each secondary language. If you're also writing in German, you'd copy your posts index to `/de/index.html`.
+
+This practice should work for RSS feeds and anything that works with the post loop.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/octopress-multilingual/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/octopress-multilingual.rb

@@ -0,0 +1,129 @@
+require "octopress-multilingual/version"
+require 'octopress-hooks'
+
+module Octopress
+  module Multilingual
+    extend self
+    attr_accessor :site, :posts
+
+    def main_language
+      if @lang ||= site.config['main_language']
+        @lang.downcase
+      else
+        abort "Build canceled by Octopress Multilingual.\n".red \
+             << "Your Jekyll site configuration must have a main language. For example:\n\n" \
+             << "  main_language: en\n\n"
+      end
+    end
+
+    def site
+      @site
+    end
+    
+    def languages
+      posts_by_language.keys
+    end
+
+    def posts_by_language
+      @posts_by_language ||= begin 
+        posts = site.posts.select(&:lang).group_by(&:lang) \
+        ## Add posts that crosspost to all languages
+        .each do |lang, posts|
+          if lang == main_language
+            posts.clear.concat(main_language_posts)
+          else
+            posts.concat(crossposts).sort_by(&:date)
+          end
+        end
+        posts
+      end
+    end
+
+    def main_language_posts
+      site.posts.reject do |post|
+        post.lang && post.lang != main_language
+      end
+    end
+
+    def crossposts
+      @cross_posts ||= begin
+        posts = site.posts.select do |post|
+          post.data['crosspost_languages']
+        end
+      end
+    end
+
+    def posts_without_lang
+      @posts_without_lang ||= site.reject(&:lang)
+    end
+
+    def site_payload(site)
+      @site = site
+
+      if main_language
+        {
+          'posts'             => main_language_posts,
+          'posts_by_language' => posts_by_language,
+          'languages'         => languages
+        }
+      end
+    end
+
+
+    class SiteHook < Hooks::Site
+      priority :low
+
+      def merge_payload(payload, site)
+
+        # Group posts by language, { 'en_post' => [posts,..] }
+        #
+
+        # Ensure that posts without an assigned language
+        # appear in each language's feed
+        #
+        
+        { 'site' => Octopress::Multilingual.site_payload(site) }
+      end
+    end
+  end
+end
+
+module Jekyll
+  class URL
+    def generate_url(template)
+      @placeholders.inject(template) do |result, token|
+        break result if result.index(':').nil? 
+        if token.last.nil?
+          result.gsub(/\/:#{token.first}/, '')
+        else
+          result.gsub(/:#{token.first}/, self.class.escape_path(token.last))
+        end
+      end
+    end
+  end
+
+  class Post
+    alias :template_orig :template
+    alias :url_placeholders_orig :url_placeholders 
+    
+    def template
+      template = template_orig
+
+      if [:pretty, :none, :date, :ordinal].include? site.permalink_style
+        template = File.join('/:lang', template)
+      end
+
+      template
+    end
+
+    def lang
+      data['lang'].downcase if data['lang'] 
+    end
+
+    def url_placeholders
+      url_placeholders_orig.merge({
+        :lang => lang
+      })
+    end
+  end
+end

data/lib/octopress-multilingual/version.rb

@@ -0,0 +1,5 @@
+module Octopress
+  module Multilingual
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: octopress-multilingual
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octopress-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: clash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octopress-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/octopress-multilingual.rb
+- lib/octopress-multilingual/version.rb
+homepage: https://github.com/octopress/multilingual
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Add multiple language features to your Jekyll site.
+test_files: []