rails_i18n_routes 1.1.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Mattways
+
+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.rdoc

@@ -0,0 +1,50 @@
+=== NOTE: The localize method has been changed from localize to localized in version 1.1.2
+
+---
+
+{<img src="https://codeclimate.com/github/mattways/rails_i18n_routes.png" />}[https://codeclimate.com/github/mattways/rails_i18n_routes] {<img src="https://secure.travis-ci.org/mattways/rails_i18n_routes.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mattways/rails_i18n_routes] {<img src="https://gemnasium.com/mattways/rails_i18n_routes.png" alt="Dependency Status" />}[https://gemnasium.com/mattways/rails_i18n_routes]
+
+= Rails I18n Routes
+
+Minimalistic toolkit to handle i18n routes and detect locale from subdomain or prefix.
+
+= Install
+
+Put this line in your Gemfile:
+  gem 'rails_i18n_routes'
+  
+Then bundle:
+  $ bundle  
+  
+= Usage
+
+Choose how the language would be selected in your application.rb...
+
+To use prefix (default):
+  config.i18n_routes.selection = :prefix
+
+To use subdomain:
+  config.i18n_routes.selection = :subdomain
+  config.i18n_routes.mapping = {
+    :es => [:ar, :uy]
+    :pt => [:br]
+  }
+
+In the case of subdomains you need to name the yml file in your locales dir using this format:
+  es-UY.yml
+  es-AR.yml
+  pt-BR.yml
+  
+Inside each yaml file:
+  es-UY:
+    routes:
+      users: "usuarios"
+      profile: "perfil"
+      login: "entrar"
+      
+(Please note each part of the path it's translated individually, you don't have to put translations for paths like "users/1/profile" just translate "users" and "profile", the plugin will do the rest)
+  
+Finally in your routes.rb pass the routes you want to be localized to localize method:
+  localized do
+    math 'contact' => 'static#contact', :as => 'contact'
+  end

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsI18nRoutes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+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/lib/rails_i18n_routes.rb

@@ -0,0 +1,6 @@
+require 'rails_i18n_routes/action_controller'
+require 'rails_i18n_routes/action_dispatch'
+require 'rails_i18n_routes/railtie'
+
+module RailsI18nRoutes
+end

data/lib/rails_i18n_routes/action_controller.rb

@@ -0,0 +1,37 @@
+module RailsI18nRoutes
+  module ActionController
+    module BaseMethods
+        
+      def self.included(base)
+        base.send :prepend_before_filter, :select_locale
+      end
+      
+      protected
+      
+      def select_locale
+        if Rails.application.config.i18n_routes.selection == :subdomain
+          Rails.application.config.i18n_routes.mapping.each_pair do |key, value|
+            if (value.is_a? Array and value.include? request.subdomain.to_sym) or value == request.subdomain.to_sym
+              I18n.locale = "#{key}-#{request.subdomain.upcase}" 
+              break
+            end
+          end
+        elsif not params[:locale].nil?
+          I18n.locale = params[:locale] 
+        end       
+      end
+      
+      def subdomains
+        @subdomains ||= begin
+          values = []
+          Rails.application.config.i18n_routes.mapping.values.each do |value|
+            value = [value] unless value.is_a? Array
+            values.concat value
+          end
+          values
+        end
+      end
+
+    end
+  end
+end

data/lib/rails_i18n_routes/action_dispatch.rb

@@ -0,0 +1,86 @@
+module RailsI18nRoutes
+  module ActionDispatch
+    module MapperMethods
+    
+      def localized
+        @locales = I18n.available_locales.dup
+        case Rails.application.config.i18n_routes.selection
+        when :prefix
+          scope ':locale' do
+            yield
+          end
+        when :subdomain
+          @locales.shift # For some reason :en is always there          
+          yield
+        end    
+        @locales = nil # Needed to routes below localize block to work
+      end
+      
+      def add_route(action, options)
+       if @locales
+          scope = @scope.dup
+          @locales.each do |locale|
+            @scope[:path] = i18n_path(@scope[:path], locale) if @scope[:path]
+            super(*[i18n_path(action, locale), i18n_options(options, locale)])
+          end
+          @set.named_routes.define_i18n_route_helper @scope[:as] ? "#{@scope[:as]}_#{options[:as]}" : options[:as] 
+          @scope = scope
+          return
+        end
+        super
+      end     
+      
+      protected
+
+      def i18n_options(options, locale)
+        selection = Rails.application.config.i18n_routes.selection  
+        subdomain = locale.to_s.split('-')[1].downcase if selection == :subdomain
+        changes = { :constraints => selection == :prefix ? {:locale => locale.to_s} : {:subdomain => subdomain.to_s} }
+        suffix = selection == :prefix ? locale.to_s.gsub('-', '_').downcase : subdomain
+        if options[:as].present?
+          changes[:as] = "#{options[:as]}_#{suffix}"
+        elsif @scope[:scope_level_resource].present?
+          resource = @scope[:scope_level_resource]
+          ['singular', 'plural'].each do |context|
+            resource.instance_variable_set "@original_#{context}".to_sym, resource.send(context.to_sym) unless resource.instance_variable_get "@original_#{context}".to_sym
+            resource.instance_variable_set "@#{context}".to_sym, "#{resource.instance_variable_get "@original_#{context}".to_sym}_#{suffix}"
+          end
+        end
+        options.merge changes
+      end
+      
+      def i18n_path(path, locale)
+        i18n_path = []
+        path.to_s.split('/').each do |part|
+          next if part == ''
+          part.gsub!(/-/, '_')
+          i18n_path << ((part[0] == ':' or part[0] == '*') ? part : I18n.t("routes.#{part}", :locale => locale, :default => part.gsub(/_/, '-')))
+        end  
+        i18n_path.join('/')
+      end
+    
+    end
+    module NamedRouteCollectionMethods
+      
+      def define_i18n_route_helper(name)
+        ['url', 'path'].each do |kind|
+          selector = url_helper_name(name, kind)
+          @module.module_eval <<-END_EVAL, __FILE__, __LINE__ + 1
+            remove_possible_method :#{selector}
+            def #{selector}(*args)
+              options = args.extract_options!
+              if Rails.application.config.i18n_routes.selection == :subdomain
+                suffix = (options[:subdomain] ? options[:subdomain] : request.subdomain)
+              else
+                suffix = (options[:locale] ? options[:locale] : I18n.locale).to_s.gsub('-', '_').downcase
+              end
+              send ("#{name}_" + suffix.to_s + "_#{kind}"), *(args << options)
+            end
+          END_EVAL
+          helpers << selector
+        end                
+      end    
+    
+    end
+  end
+end

data/lib/rails_i18n_routes/railtie.rb

@@ -0,0 +1,14 @@
+module RailsI18nRoutes
+  class Railtie < Rails::Railtie
+
+    config.i18n_routes = ActiveSupport::OrderedOptions.new
+    config.i18n_routes.selection = :prefix
+
+    initializer 'rails_i18n_routes' do
+      ::ActionDispatch::Routing::Mapper.send :include, RailsI18nRoutes::ActionDispatch::MapperMethods
+      ::ActionDispatch::Routing::RouteSet::NamedRouteCollection.send :include, RailsI18nRoutes::ActionDispatch::NamedRouteCollectionMethods
+      ::ActionController::Base.send :include, RailsI18nRoutes::ActionController::BaseMethods
+    end
+  
+  end
+end

data/lib/rails_i18n_routes/version.rb

@@ -0,0 +1,5 @@
+module RailsI18nRoutes
+
+  VERSION = '1.1.6'
+
+end

data/test/action_controller_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class ActionControllerTest < ActionController::TestCase
+  tests SimplesController
+
+  test "should select correct locale by subdomain" do
+    Rails.application.config.i18n_routes.selection = :subdomain
+    subdomains = []
+    Rails.application.config.i18n_routes.mapping.each_pair do |lang, countries|
+      countries = [countries] unless countries.is_a? Array
+      countries.each do |country|
+
+        @request.host = "#{country}.example.org"
+        get :show
+        assert_equal I18n.locale.to_s, "#{lang}-#{country.upcase}"
+ 
+        subdomains << country  
+
+      end
+    end
+    assert_equal @controller.send(:subdomains), subdomains
+  end
+
+  test "should select correct locale by prefix" do
+    Rails.application.config.i18n_routes.selection = :prefix 
+    I18n.available_locales.select{|l|l!=:en}.each do |locale|
+      
+      get :show, :locale => locale.to_s
+      assert_equal I18n.locale.to_s, locale.to_s
+
+    end
+  end
+
+end

data/test/action_dispatch_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+class ActionDispatchTest < ActionController::IntegrationTest
+
+  test "should translate subdomain routes" do
+    with_routes_type :subdomain do
+      Rails.application.config.i18n_routes.mapping.each_pair do |lang, countries|
+        countries = [countries] unless countries.is_a? Array
+        countries.each do |country|
+          I18n.locale = "#{lang}-#{country.upcase}"
+
+          assert_recognizes(
+            { :controller => 'namespace/nesteds_resources', :action => 'show' },
+            "http://#{country}.example.org/#{I18n.t('routes.namespace')}/#{I18n.t('routes.nesteds_resources')}"
+          )
+
+          assert_recognizes(
+            { :controller => 'namespace/nesteds', :action => 'show' },
+            "http://#{country}.example.org/#{I18n.t('routes.namespace')}/#{I18n.t('routes.nesteds')}"
+          )
+
+          assert_recognizes(
+            { :controller => 'simples', :action => 'show' },
+            "http://#{country}.example.org/#{I18n.t('routes.simples')}"
+          )
+
+          assert_recognizes(
+            { :controller => 'params', :action => 'show', :p1 => '1', :p2 => '2' },
+            "http://#{country}.example.org/params/1/2"
+          )
+
+          assert_recognizes(
+            { :controller => 'resources', :action => 'show' },
+            "http://#{country}.example.org/#{I18n.t('routes.resources')}"
+          )
+
+        end
+      end    
+    end    
+  end
+
+  test "should translate prefix routes" do
+    with_routes_type :prefix do
+      I18n.available_locales.select{|l|l!=:en}.each do |locale|            
+        I18n.locale = locale
+
+        assert_recognizes(
+          { :controller => 'namespace/nesteds', :action => 'show', :locale => locale.to_s },
+          "/#{locale}/#{I18n.t('routes.namespace')}/#{I18n.t('routes.nesteds')}"
+        )
+
+        assert_recognizes(
+          { :controller => 'namespace/nesteds_resources', :action => 'show', :locale => locale.to_s },
+          "/#{locale}/#{I18n.t('routes.namespace')}/#{I18n.t('routes.nesteds_resources')}"
+        )
+
+        assert_recognizes(
+          { :controller => 'simples', :action => 'show', :locale => locale.to_s },
+          "/#{locale}/#{I18n.t('routes.simples')}"
+        )
+
+        assert_recognizes(
+          { :controller => 'params', :action => 'show', :locale => locale.to_s, :p1 => '1', :p2 => '2' },
+          "/#{locale}/params/1/2"
+        )
+
+        assert_recognizes(
+          { :controller => 'resources', :action => 'show', :locale => locale.to_s },
+          "/#{locale}/#{I18n.t('routes.resources')}"
+        )
+
+      end
+    end
+  end
+
+  protected
+
+  def with_routes_type(type)
+    Rails.application.config.i18n_routes.selection = type
+    with_routing do |set|
+      set.draw do
+        localized do
+          namespace :namespace do
+            match 'nesteds' => 'nesteds#show', :as => :nesteds
+            resource :nesteds_resources
+          end        
+          match 'simples' => 'simples#show', :as => :simples
+          match 'params/:p1/:p2' => 'params#show', :as => :params
+          resource :resources
+        end
+      end
+      yield
+    end
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.