route_localize 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51349b523338150efae0838602d873917d7c4a4b
+  data.tar.gz: eaad329dc22c4338def4c020665454d228485e79
+SHA512:
+  metadata.gz: c8a94094fced60c7fb92ad14a1978ae325e0f5362594f996f381edef1ccbe16af7ee8b13c215e4d37b2ce9a314340c58421ba8abc2fd7720c762b3a70cc23835
+  data.tar.gz: c116e2269b5541e95f01a78c4bc17db1c54af19b7c9769d8fc5f59b5ac3503e93706aa072b1e48ff77ddc7579de80cb84afd609658324e63ff5f4d60279e2209

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,126 @@
+# Route Localize
+
+Rails 4 engine to translate routes using locale files and subdomains.
+
+## Install
+
+In your Rails application's `Gemfile` add:
+
+```rb
+gem "route_localize", github: "sunny/route_localize"
+```
+
+Install the plugin by running:
+
+```sh
+$ bundle
+```
+
+## Usage
+
+In your `config/routes.rb`, localize the routes you want by surrounding them with a scope. For example:
+
+```rb
+scope localize: [:en, :fr] do
+  get 'trees/new', to: 'trees#new'
+end
+root 'pages#index'
+```
+
+Create a `config/locales/routes.yml` with translations for each part of your routes under the `routes` key. For example:
+
+```yml
+fr:
+  routes:
+    trees: arbres
+    new: nouveau
+```
+
+With this example you would have the following routes defined:
+
+            Prefix Verb URI Pattern               Controller#Action
+      trees_new_en GET /trees/new(.:format)      trees#new {:subdomain=>:en}
+      trees_new_fr GET /arbres/nouveau(.:format) trees#new {:subdomain=>:fr}
+
+You also get the `trees_new_path` and `trees_new_url` helpers that will call
+`trees_new_en` or `trees_new_fr` depending on the current locale.
+
+
+## Language switcher
+
+If you want to be able to switch to the current page in another language
+add the following inside your `app/helpers/application_helper.rb`:
+
+```rb
+module ApplicationHelper
+  include RouteLocalizeHelper
+end
+```
+
+You can then use the `locale_switch_url` helper in your views:
+
+```erb
+<%= link_to "fr", locale_switch_url("fr") %>
+<%= link_to "en", locale_switch_url("en") %>
+```
+
+### Change the parameters in your switcher
+
+If your params are different depending on the language, you can override
+the switcher's params by creating a `route_localize_options` method that
+takes the locale as a parameter.
+
+For example if you would like to switch `http://en.example.org/products/keyboard`
+to `http://fr.example.org/produits/clavier`, where `keyboard` and `clavier`
+are the `:id` parameter.
+
+In this case you might already have this in controller:
+
+```rb
+class ProductsController < ApplicationController
+  def show
+    if I18n.locale = "fr"
+      @tree = Product.find_by_name_fr(params[:id])
+    else
+      @tree = Product.find_by_name_en(params[:id])
+    end
+  end
+end
+```
+
+Then you would need to add this inside your controller:
+
+```
+  helper_method :route_localize_path_options
+  def route_localize_path_options(locale)
+    { id: (locale == "fr" ? @tree.name_fr : @tree.name_en) }
+  end
+```
+
+
+## Caveats
+
+- Tests are missing for the `locale_switch_url`.
+
+
+## Development
+
+Please help by [submitting issues](https://github.com/sunny/route_localize),
+creating pull requests, talking about the gem or saying thanks.
+
+
+## Other gems to translate Rails routes
+
+The following gems could be a good match for your project:
+
+- [translate_routes](https://github.com/raul/translate_routes)
+- [route_translator](https://github.com/enriclluelles/route_translator/)
+- [rails-translate-routes](https://github.com/francesc/rails-translate-routes/)
+- [routing-filter](https://github.com/svenfuchs/routing-filter)
+
+Route Localize is different because it:
+
+- adds a constraint to the subdomain instead of relying on the locale beeing in the url (`en/…` `fr/`)
+- plays well with gems that introduce extra locales, routes you don't want to translate, or reload routes before i18n is loaded (`activeadmin` for example)
+- includes a powerfull language switcher helper.
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RouteLocalize'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/helpers/route_localize_helper.rb

@@ -0,0 +1,48 @@
+# Helper to include in ApplicationHelper
+
+module RouteLocalizeHelper
+  # URL to another language to switch to.
+  # Can be overridden per-controller.
+  def locale_switch_url(locale)
+    name = request_route_name.to_s.sub(/_#{I18n.locale}$/, '')
+    method = "#{name}_#{locale}_url"
+    method = "#{name}_url" unless respond_to?(method)
+    method = "root_url" unless respond_to?(method)
+
+    options = { subdomain: locale }
+    options.merge! route_localize_options(locale)
+    route = send(method, options)
+
+    # Ensure the locale switcher only goes to GET routes
+    begin
+      Rails.application.routes.recognize_path(route, method: :get)
+    rescue ActionController::RoutingError
+      route = root_url
+    end
+
+    route
+  end
+
+  private
+
+  def request_route_name
+    Rails.application.routes.router.recognize(request) do |route, _|
+      return route.name
+    end
+  end
+
+  # Allow the app to add parameters to links by definining a
+  # `route_localize_path_options` method that accepts a locale.
+  def route_localize_options(locale)
+    if respond_to?(:route_localize_path_options)
+      route_localize_path_options(locale)
+
+    # DEPRECATED method that could redefine the id parameter
+    elsif respond_to?(:localize_param)
+      { id: localize_param(locale) }
+
+    else
+      {}
+    end
+  end
+end

data/lib/route_localize/engine.rb

@@ -0,0 +1,4 @@
+module RouteLocalize
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/route_localize/extensions.rb

@@ -0,0 +1,13 @@
+module ActionDispatch
+  module Routing
+    class RouteSet
+      def add_route_with_locale(app, conditions = {}, requirements = {}, defaults = {}, as = nil, anchor = true)
+        RouteLocalize.translate_route(app, conditions, requirements, defaults, as, anchor, self) do |*args|
+          # puts "#{$route} #{args.inspect}"
+          add_route_without_locale *args
+        end
+      end
+      alias_method_chain :add_route, :locale
+    end
+  end
+end

data/lib/route_localize/version.rb

@@ -0,0 +1,3 @@
+module RouteLocalize
+  VERSION = "0.0.2"
+end

data/lib/route_localize.rb

@@ -0,0 +1,69 @@
+require "route_localize/engine"
+require "route_localize/extensions"
+
+module RouteLocalize
+  extend self
+
+  # Yields one or several routes if the route definition has a `localize:` scope
+  def translate_route(app, conditions, requirements, defaults, as, anchor, route_set)
+
+    if defaults[:localize]
+      # Makes sure the routes aren't loaded before i18n can read translations
+      # This happens when gems like `activeadmin` call `Rails.application.reload_routes!`
+      return unless I18n.load_path.grep(/routes.yml$/).any?
+
+      locales = defaults.delete(:localize)
+      locales.each do |locale|
+        # Name
+        locale_as = "#{as}_#{locale}"
+        locale_as = nil if route_set.named_routes.routes[locale_as.to_sym]
+
+        # Path
+        locale_conditions = conditions.dup
+        locale_conditions[:path_info] = translate_path(locale_conditions[:path_info], locale)
+        locale_conditions[:subdomain] = locale.to_s
+        locale_conditions[:required_defaults] = locale_conditions[:required_defaults].reject { |l| l == :localize }
+
+        # Other arguments
+        locale_defaults = defaults.merge(subdomain: locale.to_s)
+
+        yield app, locale_conditions, requirements, locale_defaults, locale_as, anchor
+      end
+
+      define_locale_helpers(as, route_set.named_routes.module)
+    else
+      yield app, conditions, requirements, defaults, as, anchor
+    end
+  end
+
+  # Create _path and _url helpers for the given path name
+  # that uses I18n.locale to pick the current path
+  def define_locale_helpers(name, helper)
+    %w(url path).each do |method|
+      helper.send :define_method, "#{name}_#{method}" do |*args|
+        send("#{name}_#{I18n.locale}_#{method}", *args)
+      end
+    end
+  end
+
+  # Translate part of a path
+  def translate_segment(segment, locale)
+    if segment =~ /^[a-z_0-9]+$/i
+      translation = I18n.t "routes.#{segment}", default: segment, locale: locale
+      CGI.escape(translation)
+    else
+      segment
+    end
+  end
+
+  # Translate a path
+  def translate_path(path, locale)
+    path = path.dup
+    final_options = path.slice!(/(\(.+\))$/) # Removes "(.:format)"
+    segments = path.split('/').map do |segment|
+      translate_segment(segment, locale)
+    end
+    "#{segments.join('/')}#{final_options}"
+  end
+
+end

data/lib/tasks/route_localize_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :route_localize do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/trees_controller.rb

@@ -0,0 +1,16 @@
+class TreesController < ApplicationController
+  def home
+  end
+
+  def show
+  end
+
+  def create
+  end
+
+  def update
+  end
+
+  def index
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+module ApplicationHelper
+  include RouteLocalizeHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/trees/home.html.erb

@@ -0,0 +1,3 @@
+<p>Home: <%= home_path %></p>
+<p>Home en: <%= home_fr_path %></p>
+<p>Home fr: <%= home_en_path %></p>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "route_localize"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end