middleman-transpath 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62d93b69d638c1d6e6e80c37efe5950bcb99edc0
-  data.tar.gz: 5e97daa8405d3a3a4a5d392b77d13258fee1094c
+  metadata.gz: c2f16960bde4558bb9f240f1d085a686ef03bcf8
+  data.tar.gz: 59a485d0749aebfabda6ae98b76878d6c0f32244
 SHA512:
-  metadata.gz: 32c9f0fbc58124886d886e819cbf505efb9b41e947a801791cab08cdbc23c017cc6403a9a56db47b486ee592c376fa21dd5b8746e1692780b57bbea7cfcee489
-  data.tar.gz: fee39ee94882d6777344355f11d31aaaf9e1716aa1fd21c6669578ca8ce8e3a4b5e2c9ce2b1f1356e3628af0d5d8a6c31da95a5c112fb15c98704b3e70e4c640
+  metadata.gz: 3d725bfef5f444c5e495cb9feee11c3816cce4b9f78e36c149ab7d4a099dd97a3e742a1387446b1ab23e1c81f608b037b149d5cf55fe043feb47ec0ccdde36dd
+  data.tar.gz: 116dd831464a68e117b8bd39fff2ace40e0c098f9411068a0b3c6bcf3063a5072fa37ae4cdd591e7d8c42c315a613d8bc173fa90049d8b70806d3875bca5a114

data/README.md

@@ -6,26 +6,90 @@ Translating path with middleman, or access to the same page but different locale
 
 For example, you cannot access from :
 
-`projets/premier-projet` to `projects/first-project`
+`/a-propos` to `/en/about`
+
+## Install
+Add the following line to your **Gemfile**: `gem 'middleman-transpath'`
+and this to your **config.rb**: `activate :transpath`
 
 ## Solution ?
-Yep, easily. Follow the steps :
-- Install and configure i18n with your favorite locales ! Presize your default locale too.
-- Then, generate a file named `languages.yml`, and configure how you want your languages links to be displayed. Here an example:
+Yep, easily. Install and configure i18n with your favorite locales, and don't forget to specify your default locale (for example : `activate :i18n, :mount_at_root => :fr` in your **config.rb**, to use French as default locale), check the [documentation](https://middlemanapp.com/advanced/localization/)
 
-```yaml
-fr: "🇫🇷 - FR"
-en: "🇺🇸 - EN"
+## Path configuration
+Add a slug on your page [frontmatter](https://middlemanapp.com/basics/frontmatter/).
+```YAML
+---
+slug: about
+---
 ```
 
-- Wow, such great, your links are displayed ! Now, let's configure paths in the next step.
+Then, you'll need your locales files (**/locales/LANG\_SYMBOL.yml**). For each locale, you have to set, one by one (not in a list):
+- The title translation in *titles*
+- The slug translation in *paths*
 
-## Path configuration
-Here is the most difficult part. You'll need your locales files (locales dir in the root folder). For each locale, you have to precise :
-- The title title of the page (identifier)
-- The title translation : in locale.titles
-- Subdirectories dir in a list (URL direction)
-- Subdirectories translation : in locale.paths (one by one, not a list)
+```YAML
+titles:
+  about: 'A propos' # Page title
+paths:
+  about: 'a-propos' # URL slug
+```
+
+If you want to see an example, go to the [wiki section](https://github.com/bastienrobert/middleman-transpath/wiki/Locale-example)
+
+### Subdirectories
+If you have subdirectories, like **/projects/project-one**, it's not a problem, set in your locales files:
+```YAML
+paths:
+  projects: 'projects'
+  project-one: 'project-one'
+```
+
+and on your page'frontmatter:
+```YAML
+slug: project-one
+dir:
+  - projects
+```
+
+You need to add all slugs, even if it's not a page. For example if you have a page like /about/me, and about is not a page, you need to set a translation for about anyway.
+
+### Dynamic pages
+When you generate dynamic pages using proxy, add `:data => { :slug => project.en.slug }`. You'll have to generate it on multiple languages like this:
+```RUBY
+data.projects.each do |project|
+  proxy "/projets/#{project.fr.slug}/index.html", "templates/project.html", :locals => { :project => project }, :locale => :fr, :ignore => true, :data => { :slug => project.fr.slug }
+  proxy "en/projects/#{project.en.slug}/index.html", "templates/project.html", :locals => { :project => project }, :locale => :en, :ignore => true, :data => { :slug => project.en.slug }
+end
+```
+
+Then, the frontmatter config is a bit difficult:
+```YAML
+---
+dynamic:
+  enable: true
+  data: project # The data you send using locals in your proxy
+  name: name # What you want to use for your page title (here: project.name)
+  slug: slug # What you want to use as slug (here: project.slug)
+dir:
+  - projects # You'll can access through /projects/the-project-slug
+---
+```
+
+The data in the data/projects.yml looks like this:
+```YAML
+- fr:
+    name: Premier projet
+    slug: premier-projet
+  en:
+    name: First Project
+    slug: first-project
+```
+
+### AAAAAAH! I need a complete example!
+Okok, just go here, to get everyting completely detailled:
+- [Simple static page](https://github.com/bastienrobert/middleman-transpath/wiki/Simple-static-page)
+- [Simple static with subfolder](https://github.com/bastienrobert/middleman-transpath/wiki/Simple-static-with-subfolder)
+- [Dynamic page](https://github.com/bastienrobert/middleman-transpath/wiki/Dynamic-page)
 
 ## Helper to translate the current page
 Simply use the following helper to translate your current page in another language. Replace the **:fr** by the locale symbol of your choise.
@@ -33,8 +97,10 @@ Simply use the following helper to translate your current page in another langua
 <%= link_translate(:fr) %>
 ```
 
-## Contributing
+## Helper to translate the page title
+Add `title_translate` in your layout `<title>`. It'll use the title you specified in frontmatter, automaticly.
 
+## Contributing
 1. Fork it ( https://github.com/bastienrobert/middleman-transpath/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/middleman-transpath/extension.rb

@@ -4,12 +4,14 @@ require 'middleman-core'
 # Extension namespace
 class Transpath < ::Middleman::Extension
 
+  option :label, {en: '🇺🇸 - EN', fr: '🇫🇷 - FR'}, 'This hash should contain the lang symbol and his label'
+
   def initialize(app, options_hash={}, &block)
     super
   end
 
   helpers do
-    def path_translate(lang)
+    def link_translate_path(lang)
       begin
         current_page.data.dir.map { |dir| t("paths.#{dir}", locale: lang, :default => dir) + '/'}.join('')
       rescue
@@ -17,22 +19,41 @@ class Transpath < ::Middleman::Extension
       end
     end
 
-    def title_translate(lang)
-      t("paths.#{current_page.data.title}", locale: lang, :default => current_page.data.title)
+    def link_translate_slug(lang)
+      dynamic = current_page.data.dynamic
+      unless (defined?(dynamic.enable)).nil?
+        current_page
+        .locals[dynamic.data.parameterize.underscore.to_sym][lang.to_s]
+        .send(dynamic.slug.to_s)
+      else
+        t("paths.#{current_page.data.slug}", locale: lang, :default => current_page.data.slug)
+      end
     end
 
-    def link_translate(lang)
-      return link_to data.languages.send(lang.to_s),
-      if lang === I18n.default_locale
-        config[:host] + '/' +
-        path_translate(lang) +
-        title_translate(lang)
+    def title_translate
+      dynamic = current_page.data.dynamic
+      unless (defined?(dynamic.enable)).nil?
+        current_page
+          .locals[dynamic.data.parameterize.underscore.to_sym][locale.to_s]
+          .send(dynamic.name.to_s)
+          .capitalize
       else
-        config[:host] + '/' +
-        lang.to_s + '/' +
-        path_translate(lang) +
-        title_translate(lang)
+        t("titles.#{current_page.data.slug}", locale: lang, :default => current_page.data.slug).capitalize
       end
     end
+
+    def link_translate(lang, params={})
+      return link_to (params[:label] ||= params['label'] ||= extensions[:transpath].options.label[lang]),
+        if lang === I18n.default_locale
+          config[:host] + '/' +
+          link_translate_path(lang) +
+          link_translate_slug(lang)
+        else
+          config[:host] + '/' +
+          lang.to_s + '/' +
+          link_translate_path(lang) +
+          link_translate_slug(lang)
+        end
+    end
   end
 end

data/middleman-transpath.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "middleman-transpath"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Bastien Robert"]
   # s.email       = ["email@example.com"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-transpath
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bastien Robert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2017-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -40,6 +40,7 @@ files:
 - features/support/env.rb
 - lib/middleman-transpath.rb
 - lib/middleman-transpath/extension.rb
+- middleman-transpath-0.0.1.gem
 - middleman-transpath.gemspec
 homepage: 
 licenses: []