route_localize 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cca893b796c2a21728b27513a273af3f69081c1a
-  data.tar.gz: 793b0fe5a3653b53279dd3c7554516b187c339f1
+  metadata.gz: 3213ab072255f6330c2f26ee072ade47f632bcff
+  data.tar.gz: bc248c471857e5b907d1f0dc17406911306cf8af
 SHA512:
-  metadata.gz: 35330f4f8b663bc3750bd7db411e139b5fbcba6936ae297a577b43adb48dfaf4e10550d5d32d151438b284c0e74c4968a8d5087323f517a5f0567f8aa21d0fe3
-  data.tar.gz: ab214de2024c22b2d991bed5631ff30bf5ba0ee095f2679ecb0e418647741caf78c85256355e260bd7e9ef1304969b2a63a3f955b4b729dd87da6d054291f465
+  metadata.gz: 6ef5b752784039c71ec50e115a04c325ed5783e7ee9816c993f794c13e209c5d7baf54a2c0fdc8f33048539140fc8e5ad7b7597eb30f044b7a36201ecc465606
+  data.tar.gz: f4849ca23b52085b7c28d7d96b84289daa11a8135918ca8a4c29379dea68872d07bbb9ab98d80de71964d119d65d8484443a7cc22180465426bca1e392c92de4

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 Sunny Ripert
+Copyright 2015 Sunny Ripert
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,17 +1,20 @@
 # Route Localize
 
-Rails 4 engine to translate routes using locale files and subdomains.
+Rails engine to translate routes using locale files and subdomains.
 
+**Only works with Rails 4.0**. Check out
+[route_translator](https://github.com/enriclluelles/route_translator/) for
+Rails 4.2 and Rails 5 compatibility.
 
 ## Install
 
 In your Rails application's `Gemfile` add:
 
 ```rb
-gem "route_localize", github: "sunny/route_localize"
+gem "route_localize"
 ```
 
-Install the plugin by running:
+Install the gem by running:
 
 ```sh
 $ bundle
@@ -19,15 +22,18 @@ $ bundle
 
 ## Scopes
 
-Route Localize adds two routing scopes you can use on your routes:
+Route Localize adds two scopes you can use in 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`)
+- `localize`: if your locale is the first parameter in the path.
+  For example `http://example.com/en/foo`.
+- `localize_subdomain`: if your locale is your subdomain.
+  For example `http://en.example.com/foo`.
 
 
 ## Usage
 
-In your `config/routes.rb`, localize some routes with one of the scopes. For example:
+In your `config/routes.rb`, add one of the scopes around your routes.
+For example:
 
 ```rb
 scope localize: [:en, :fr] do
@@ -36,7 +42,8 @@ end
 root 'pages#index'
 ```
 
-Create a `config/locales/routes.yml` with translations for each part of your routes under the `routes` key. For example:
+Then, create a `config/locales/routes.yml` with translations for each part
+of your routes under the `routes` key. For example:
 
 ```yml
 fr:
@@ -66,31 +73,32 @@ module ApplicationHelper
 end
 ```
 
-You can then use the `locale_switch_url` or `locale_switch_subdomain_url` helpers in your views:
+You can then use the `locale_switch_url` or `locale_switch_subdomain_url`
+helpers in your views like so:
 
 ```erb
-<%= link_to "fr", locale_switch_url("fr") %>
-<%= link_to "en", locale_switch_url("en") %>
+<%= link_to "Version française", locale_switch_url("fr") %>
+<%= link_to "English version", locale_switch_url("en") %>
 ```
 
 
 ### Change the parameters in your switcher
 
-If your params are different depending on the language, you can override
+If some of 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 from
 `http://en.example.org/products/keyboard`
 to `http://fr.example.org/produits/clavier`, where `keyboard` and `clavier`
-are the `:id` parameter.
+are the `:id` parameter in your routes.
 
-In this case you might already have this in controller:
+In this case you might already have something like this in controller:
 
 ```rb
 class ProductsController < ApplicationController
   def show
-    if I18n.locale = "fr"
+    if I18n.locale == :fr
       @tree = Product.find_by_name_fr(params[:id])
     else
       @tree = Product.find_by_name_en(params[:id])
@@ -99,20 +107,24 @@ class ProductsController < ApplicationController
 end
 ```
 
-Then you would need to add this inside your controller:
+In  this case you would need to add the `route_localize_path_options` method
+that returns a hash of params to change depending on the locale. Here, `:id`
+needs to be different because we are looking at two different database fields.
 
 ```
   helper_method :route_localize_path_options
   def route_localize_path_options(locale)
-    { id: (locale == "fr" ? @tree.name_fr : @tree.name_en) }
+    {
+      id: (locale == "fr" ? @tree.name_fr : @tree.name_en)
+    }
   end
 ```
 
 
-## Caveats
+## Translate a single path
 
-Rails' `url_for` cannot find the translation url automatically,
-prefer to use the `_path` and `_url` methods instead.
+Because Rails' `url_for` cannot find the translation url automatically,
+prefer to use the `_path` and `_url` helpers instead.
 
 If you can't, one way around is to use `RouteLocalize.translate_path`.
 
@@ -123,7 +135,8 @@ RouteLocalize.translate_path(url_for(controller: 'trees', action: 'index'),
                              I18n.locale)
 ```
 
-If you are using subdomains you should add `by_subdomain: true` option.
+If you are using subdomains you should add the `by_subdomain: true` option to
+`translate_path`.
 
 
 ## Development
@@ -143,7 +156,13 @@ The following gems could also be a good match for your project:
 
 Route Localize is different from these solutions because it:
 
-- 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 language switcher helper that returns the correct url in each other language
+- 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 language switcher helper that returns the correct url in every
+  other language
 
+## License
+
+By Sunny Ripert, Licensed under the MIT.

data/lib/route_localize/version.rb

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

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: route_localize
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sunny Ripert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.0.3
 - !ruby/object:Gem::Dependency
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Rails 4 engine to translate routes.