middleman-transpath 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62d93b69d638c1d6e6e80c37efe5950bcb99edc0
+  data.tar.gz: 5e97daa8405d3a3a4a5d392b77d13258fee1094c
+SHA512:
+  metadata.gz: 32c9f0fbc58124886d886e819cbf505efb9b41e947a801791cab08cdbc23c017cc6403a9a56db47b486ee592c376fa21dd5b8746e1692780b57bbea7cfcee489
+  data.tar.gz: fee39ee94882d6777344355f11d31aaaf9e1716aa1fd21c6669578ca8ce8e3a4b5e2c9ce2b1f1356e3628af0d5d8a6c31da95a5c112fb15c98704b3e70e4c640

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-transpath.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Bastien ROBERT
+
+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,47 @@
+# Middleman-transpath
+You're using i18n for your middleman website ? This extension is for you !
+
+## Why ?
+Translating path with middleman, or access to the same page but different locale and slug is not integrate by default in middleman-i18n.
+
+For example, you cannot access from :
+
+`projets/premier-projet` to `projects/first-project`
+
+## 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:
+
+```yaml
+fr: "🇫🇷 - FR"
+en: "🇺🇸 - EN"
+```
+
+- Wow, such great, your links are displayed ! Now, let's configure paths in the next step.
+
+## 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)
+
+## 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.
+```RUBY
+<%= link_translate(:fr) %>
+```
+
+## 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'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## License
+
+See LICENSE, which applies to everything in this repository.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-transpath')

data/lib/middleman-transpath/extension.rb

@@ -0,0 +1,38 @@
+# Require core library
+require 'middleman-core'
+
+# Extension namespace
+class Transpath < ::Middleman::Extension
+
+  def initialize(app, options_hash={}, &block)
+    super
+  end
+
+  helpers do
+    def path_translate(lang)
+      begin
+        current_page.data.dir.map { |dir| t("paths.#{dir}", locale: lang, :default => dir) + '/'}.join('')
+      rescue
+        return ''
+      end
+    end
+
+    def title_translate(lang)
+      t("paths.#{current_page.data.title}", locale: lang, :default => current_page.data.title)
+    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)
+      else
+        config[:host] + '/' +
+        lang.to_s + '/' +
+        path_translate(lang) +
+        title_translate(lang)
+      end
+    end
+  end
+end

data/lib/middleman-transpath.rb

@@ -0,0 +1,6 @@
+require "middleman-core"
+
+Middleman::Extensions.register :transpath do
+  require "middleman-transpath/extension"
+  Transpath
+end

data/middleman-transpath.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-transpath"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bastien Robert"]
+  # s.email       = ["email@example.com"]
+  # s.homepage    = "http://example.com"
+  s.summary     = "i18n helper for slug and current page translating"
+  s.description = "This helper allows you to translate your current path to the same path in another locale, with a different slug. It can be include in a partial, in the header for example ; and need a simple 2 minutes configuration."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 4.2.1"])
+
+  # Additional dependencies
+  # s.add_runtime_dependency("gem-name", "gem-version")
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: middleman-transpath
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bastien Robert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+description: This helper allows you to translate your current path to the same path
+  in another locale, with a different slug. It can be include in a partial, in the
+  header for example ; and need a simple 2 minutes configuration.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-transpath.rb
+- lib/middleman-transpath/extension.rb
+- middleman-transpath.gemspec
+homepage: 
+licenses: []
+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.6.13
+signing_key: 
+specification_version: 4
+summary: i18n helper for slug and current page translating
+test_files:
+- features/support/env.rb