route_localize 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac33fb44a9d0ae4cb2d20a38e66c3e5b01938b7b
-  data.tar.gz: 8377b6a2ca45e7e5d14afebf1322b33ebba48b40
+  metadata.gz: cca893b796c2a21728b27513a273af3f69081c1a
+  data.tar.gz: 793b0fe5a3653b53279dd3c7554516b187c339f1
 SHA512:
-  metadata.gz: c7d9a28eed03ce3429a45d240acd304c215761608b5494e5c1a0bb2aac9bd7c00120d52775de6fda8d37379c016b5de09a3169526281f766e0268059a5a7eb13
-  data.tar.gz: e9fd2c544fd8fd7eb98dfc401849fe222cb6073189f96a24412446887c7c7e0a717c71c59546d8efefeb8d3bbb606135bdfd4761f1e33c055666caec2ffc4880
+  metadata.gz: 35330f4f8b663bc3750bd7db411e139b5fbcba6936ae297a577b43adb48dfaf4e10550d5d32d151438b284c0e74c4968a8d5087323f517a5f0567f8aa21d0fe3
+  data.tar.gz: ab214de2024c22b2d991bed5631ff30bf5ba0ee095f2679ecb0e418647741caf78c85256355e260bd7e9ef1304969b2a63a3f955b4b729dd87da6d054291f465

data/README.md

@@ -17,10 +17,17 @@ Install the plugin by running:
 $ bundle
 ```
 
+## Scopes
+
+Route Localize adds two routing scopes you can use on your routes:
+
+- `localize`: your locale is the first thing in the path (`http://example.com/en/foo`)
+- `localize_subdomain`: your locale is your subdomain (`http://en.example.com/foo`)
+
 
 ## Usage
 
-In your `config/routes.rb`, localize the routes you want by surrounding them with a scope. For example:
+In your `config/routes.rb`, localize some routes with one of the scopes. For example:
 
 ```rb
 scope localize: [:en, :fr] do
@@ -59,7 +66,7 @@ module ApplicationHelper
 end
 ```
 
-You can then use the `locale_switch_url` helper in your views:
+You can then use the `locale_switch_url` or `locale_switch_subdomain_url` helpers in your views:
 
 ```erb
 <%= link_to "fr", locale_switch_url("fr") %>
@@ -73,7 +80,8 @@ 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`
+For example if you would like to switch from
+`http://en.example.org/products/keyboard`
 to `http://fr.example.org/produits/clavier`, where `keyboard` and `clavier`
 are the `:id` parameter.
 
@@ -103,37 +111,39 @@ Then you would need to add this inside your controller:
 
 ## Caveats
 
-- Tests are missing for the `locale_switch_url` helper.
-- Rails' `url_for` cannot find the translation, prefer to use the `_path` and
-  `_url` methods instead. If you can't, one way around is  to use
-  `RouteLocalize.translate_path`.
+Rails' `url_for` cannot find the translation url automatically,
+prefer to use the `_path` and `_url` methods instead.
 
-  For example :
+If you can't, one way around is to use `RouteLocalize.translate_path`.
+
+For example :
+
+```ruby
+RouteLocalize.translate_path(url_for(controller: 'trees', action: 'index'),
+                             I18n.locale)
+```
 
-  ```ruby
-  url = url_for(controller: 'trees', action: 'index')
-  url = RouteLocalize.translate_path(url, I18n.locale)
-  ```
+If you are using subdomains you should add `by_subdomain: true` option.
 
 
 ## Development
 
-Please help by [submitting issues](https://github.com/sunny/route_localize),
-creating pull requests, talking about the gem or saying thanks.
+You may help by [submitting issues](https://github.com/sunny/route_localize),
+creating pull requests, talking about the gem or by saying thanks.
 
 
 ## Other gems to translate Rails routes
 
-The following gems could be a good match for your project:
+The following gems could also 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:
+Route Localize is different from these solutions because it:
 
-- adds a constraint to the subdomain instead of relying on the locale beeing in the url (`en/…` `fr/`)
+- can add 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.
+- includes a language switcher helper that returns the correct url in each other language
 

data/Rakefile

@@ -1,11 +1,13 @@
+# Bundler
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
+Bundler::GemHelper.install_tasks
 
+# Rdoc
 require 'rdoc/task'
-
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'RouteLocalize'
@@ -14,21 +16,11 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+# Dummy app tasks
+APP_RAKEFILE = File.expand_path("../spec/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
+# Rspec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/helpers/route_localize_helper.rb

@@ -1,33 +1,44 @@
 # Helper to include in ApplicationHelper
 
 module RouteLocalizeHelper
-  # URL to another language to switch to.
-  # Can be overridden per-controller.
+
+  # Returns the URL to the current page in another locale
   def locale_switch_url(locale)
-    name = request_route_name.to_s.sub(/_#{I18n.locale}$/, '')
+    route_localize_switch(locale)
+  end
+
+  # Returns the URL to the current page in another locale, using subdomains
+  def locale_switch_subdomain_url(locale)
+    route_localize_switch(locale, subdomain: locale)
+  end
+
+
+  private
+
+  def route_localize_switch(locale, options = {})
+    name = route_localize_route_name
     method = "#{name}_#{locale}_url"
     method = "#{name}_url" unless respond_to?(method)
+    method = "#{locale}_root_url" unless respond_to?(method)
     method = "root_url" unless respond_to?(method)
 
-    options = { subdomain: locale }
-    options.merge! route_localize_options(locale).to_h
+    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
+      route = root_url(options)
     end
 
     route
   end
 
-  private
-
-  def request_route_name
-    Rails.application.routes.router.recognize(request) do |route, _|
-      return route.name
+  # Return current route name without the _en or _fr
+  def route_localize_route_name
+    Rails.application.routes.router.recognize(request) do |route, *_|
+      return route.name.to_s.sub(/_#{I18n.locale}$/, '')
     end
   end
 
@@ -35,12 +46,7 @@ module RouteLocalizeHelper
   # `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) }
-
+      route_localize_path_options(locale).to_h
     else
       {}
     end

data/lib/route_localize/route.rb

@@ -0,0 +1,78 @@
+module RouteLocalize
+  # Represents a route line that needs to be translated in a given locale.
+  #
+  # Instances of Route accept the same arguments that
+  # `ActionDispatch::Routing::RouteSet`'s method `add_route` accepts, with the
+  # addition of:
+  # - `route_set`: the app's current route set
+  # - `locale`: locale for the given route
+  Route = Struct.new(:app, :conditions, :requirements, :defaults,
+                        :as, :anchor, :route_set, :locale) do
+
+    # Returns the arguments to pass on to `add_route` to create the route
+    def to_add_route_arguments
+      [app,
+        locale_conditions,
+        locale_requirements,
+        locale_defaults,
+        locale_as,
+        anchor]
+    end
+
+
+    private
+
+    # Returns route conditions that match the locale
+    def locale_conditions
+      cond = conditions.dup
+
+      cond[:path_info] = RouteLocalize.translate_path(
+                           conditions[:path_info],
+                           locale,
+                           by_subdomain: by_subdomain?)
+
+      if by_subdomain?
+        cond[:subdomain] = locale.to_s
+      else
+        cond[:locale] = locale.to_s
+      end
+
+      # For good measure
+      cond[:required_defaults] -= [:localize, :localize_subdomain]
+
+      cond
+    end
+
+    def locale_requirements
+      if by_subdomain?
+        { subdomain: locale.to_s }
+      else
+        { locale: locale.to_s }
+      end
+    end
+
+    # Return route defaults for the locale
+    def locale_defaults
+      if by_subdomain?
+        defaults.merge(subdomain: locale.to_s)
+      else
+        defaults.merge(locale: locale.to_s)
+      end
+    end
+
+    # Returns a route name that includes the locale
+    # Example: "trees" -> "trees_fr"
+    def locale_as
+      locale_as = "#{as}_#{locale}"
+      locale_as = nil if route_set.named_routes.routes[locale_as.to_sym]
+      locale_as
+    end
+
+    # Returns true if the route must be by subdomain ("fr.example.com"),
+    # false if it should be by path ("example.com/fr")
+    def by_subdomain?
+      conditions[:required_defaults].include?(:localize_subdomain)
+    end
+
+  end
+end

data/lib/route_localize/version.rb

@@ -1,3 +1,3 @@
 module RouteLocalize
-  VERSION = "0.0.7"
+  VERSION = "1.0.0"
 end

data/lib/route_localize.rb

@@ -1,27 +1,37 @@
 require "route_localize/engine"
 require "route_localize/extensions"
+require "route_localize/route"
 
 module RouteLocalize
-  extend self
-
-  # Yields one or several routes if the route definition has a `localize:` scope
+  module_function
+
+  # Yields one or several route definitions if the route definition has a
+  # `localize` or `localize_subdomain` scope
+  #
+  # The arguments it accepts are the arguments given to
+  # `ActionDispatch::Routing::RouteSet`'s method `add_route`, with the addition
+  # of the `route_set` argument that should hold the current route set.
+  #
+  # The array it yields are the arguments accepted by `add_route` so that these
+  # can be handed back to Rails to insert the yielded route.
   def translate_route(app, conditions, requirements, defaults, as, anchor, route_set)
+    locales = defaults.delete(:localize) || defaults.delete(:localize_subdomain)
+    if locales.present?
 
-    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!`
+      # Makes sure the routes aren't created 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|
-        yield *route_args_for_locale(locale, app, conditions, requirements, defaults, as, anchor, route_set)
+        route = Route.new(app, conditions, requirements, defaults,
+                            as, anchor, route_set, locale)
+        yield *route.to_add_route_arguments
       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
@@ -34,8 +44,10 @@ module RouteLocalize
     end
   end
 
-  # Translate a path
-  def translate_path(path, locale)
+
+  # Returns a translated path
+  # Example: "/trees/:id(.:format)" -> "/arbres/:id(.:format)", …
+  def translate_path(path, locale, by_subdomain: false)
     path = path.dup
 
     # Remove "(.:format)" in routes or "?args" if used elsewhere
@@ -44,36 +56,22 @@ module RouteLocalize
     segments = path.split('/').map do |segment|
       translate_segment(segment, locale)
     end
-    "#{segments.join('/')}#{final_options}"
+
+    segments.unshift(":locale") unless by_subdomain
+    segments = segments.reject(&:blank?)
+
+    "/#{segments.join('/')}#{final_options}"
   end
 
-  # Translate part of a path
+  # Translates part of a path if it can
+  # Example: "trees" -> "arbres", ":id" -> ":id"
   def translate_segment(segment, locale)
     if segment =~ /^[a-z_0-9]+$/i
-      translation = I18n.t "routes.#{segment}", default: segment, locale: locale
+      translation = I18n.t "routes.#{segment}", default: segment,
+                                                locale: locale
       CGI.escape(translation)
     else
       segment
     end
   end
-
-
-  private
-
-  def route_args_for_locale(locale, app, conditions, requirements, defaults, as, anchor, route_set)
-    # 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)
-
-    [app, locale_conditions, requirements, locale_defaults, locale_as, anchor]
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: route_localize
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Sunny Ripert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: Rails 4 engine to to translate routes using locale files and subdomains.
 email:
 - sunny@sunfox.org
@@ -45,55 +59,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - app/helpers/route_localize_helper.rb
+- lib/route_localize.rb
 - lib/route_localize/engine.rb
 - lib/route_localize/extensions.rb
+- lib/route_localize/route.rb
 - lib/route_localize/version.rb
-- lib/route_localize.rb
 - lib/tasks/route_localize_tasks.rake
-- MIT-LICENSE
-- Rakefile
-- README.md
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/trees_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/models/tree.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/trees/home.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/reloader.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/routes.yml
-- test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/db/test.sqlite3
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
-- test/integration/routes_test.rb
-- test/route_localize_test.rb
-- test/test_helper.rb
 homepage: http://github.com/sunny/route_localize
 licenses:
 - MIT
@@ -114,48 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Rails 4 engine to translate routes.
-test_files:
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/trees_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/models/tree.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/trees/home.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/reloader.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/routes.yml
-- test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/db/test.sqlite3
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
-- test/integration/routes_test.rb
-- test/route_localize_test.rb
-- test/test_helper.rb
+test_files: []

data/test/dummy/README.rdoc

@@ -1,28 +0,0 @@
-== 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

@@ -1,6 +0,0 @@
-# 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

@@ -1,13 +0,0 @@
-// 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

@@ -1,13 +0,0 @@
-/*
- * 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

@@ -1,5 +0,0 @@
-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

@@ -1,25 +0,0 @@
-class TreesController < ApplicationController
-  def home
-    render text: 'home'
-  end
-
-  def show
-    render text: 'show'
-  end
-
-  def create
-    render text: 'create'
-  end
-
-  def edit
-    render text: 'edit'
-  end
-
-  def update
-    render text: 'update'
-  end
-
-  def index
-    render text: 'index'
-  end
-end

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

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

data/test/dummy/app/models/tree.rb

@@ -1,18 +0,0 @@
-# Object that acts like a routeable ActiveRecord model
-class Tree
-  def initialize(attributes)
-    @attributes = attributes
-  end
-
-  def to_param
-    @attributes[:id]
-  end
-
-  def self.model_name
-    self
-  end
-
-  def self.singular_route_key
-    "tree"
-  end
-end