translatable_routes 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d52f4c0975cb626cba3295c879d05aa6b794cbb
+  data.tar.gz: 06a26a45a03184dcf3910c79090c2211ab8d8cc9
+SHA512:
+  metadata.gz: 761514992cebab18345209e9d6c436b7e35e721e53da7289da9a8dc9b3e4e344d567d4add505af2f3720ec3c07ada2cad3712f38e39cf74526e53880d325d649
+  data.tar.gz: 2387b86d3771b0128702a2b5b084a440a9de24e22f092d523f031f3d040895a5021fb05a575befec4492c20dc51587b2012bb727326e8f9fff2e8ec28fa44ca6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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,46 @@
+{<img src="https://codeclimate.com/github/mattways/translatable_routes.png" />}[https://codeclimate.com/github/mattways/translatable_routes] {<img src="https://secure.travis-ci.org/mattways/translatable_routes.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mattways/translatable_routes] {<img src="https://gemnasium.com/mattways/translatable_routes.png" alt="Dependency Status" />}[https://gemnasium.com/mattways/translatable_routes]
+
+= Translatable Routes
+
+Minimalistic toolkit to handle translatable routes and detect locale from subdomain or prefix.
+
+= Install
+
+Put this line in your Gemfile:
+  gem 'translatable_routes'
+  
+Then bundle:
+  $ bundle  
+  
+= Usage
+
+Choose how the language would be selected in your application.rb:
+
+To use prefix (default):
+  config.translatable_routes.selection = :prefix
+
+To use subdomain:
+  config.translatable_routes.selection = :subdomain
+  config.translatable_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
+    get 'contact', to: 'static#contact', as: 'contact'
+  end

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'TranslatableRoutes'
+  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/translatable_routes/action_controller/base.rb

@@ -0,0 +1,38 @@
+module TranslatableRoutes
+  module ActionController
+    module Base
+      extend ActiveSupport::Concern
+        
+      included do
+        prepend_before_filter :select_locale
+      end
+      
+      protected
+      
+      def select_locale
+        if Rails.application.config.translatable_routes.selection == :subdomain
+          Rails.application.config.translatable_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.translatable_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/translatable_routes/action_dispatch/mapper.rb

@@ -0,0 +1,72 @@
+module TranslatableRoutes
+  module ActionDispatch
+    module Mapper
+      extend ActiveSupport::Concern
+    
+      def localized
+        @locales = I18n.available_locales.dup
+        case Rails.application.config.translatable_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
+          @locales.each do |locale|
+            path = @scope[:path].dup if @scope[:path].present?
+            path_names = @scope[:path_names].dup
+            @scope[:path] = i18n_path(path, locale) if @scope[:path].present?
+            @scope[:path_names].each { |key, value| @scope[:path_names][key] = I18n.t("routes.#{key}", locale: locale, default: value) }
+            super(*[i18n_path(action, locale), i18n_options(options, locale)])
+            @scope[:path] = path if @scope[:path].present?
+            @scope[:path_names] = path_names
+          end
+          @set.named_routes.define_i18n_route_helper @scope[:as] ? "#{@scope[:as]}_#{options[:as]}" : options[:as] unless @scope[:scope_level_resource].present?
+          return
+        end
+        super
+      end
+
+      protected
+
+      def i18n_options(options, locale)
+        selection = Rails.application.config.translatable_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[:path] = i18n_path(options[:path], locale) if options[:path].present?
+        options.merge changes
+      end
+      
+      def i18n_path(path, locale)
+        unless path.is_a? Symbol
+          i18n_path = []
+          path.split('/').each do |part|
+            next if part == ''
+            i18n_path << ((part[0] == ':' or part[0] == '*') ? part : I18n.t("routes.#{part}", locale: locale, default: part.gsub(/_/, '-')))
+          end  
+          i18n_path.join('/')
+        else
+          path
+        end
+      end
+    
+    end
+  end
+end

data/lib/translatable_routes/action_dispatch/named_route_collection.rb

@@ -0,0 +1,27 @@
+module TranslatableRoutes
+  module ActionDispatch
+    module NamedRouteCollection
+      extend ActiveSupport::Concern
+      
+      def define_i18n_route_helper(name)
+        ['url', 'path'].each do |kind|
+          helper = :"#{name}_#{kind}"
+          @module.remove_possible_method helper
+          @module.module_eval do 
+            define_method helper do |*args|
+              options = args.extract_options!
+              if Rails.application.config.translatable_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
+          helpers << helper
+        end
+      end
+ 
+    end
+  end
+end

data/lib/translatable_routes/railtie.rb

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

data/lib/translatable_routes/version.rb

@@ -0,0 +1,5 @@
+module TranslatableRoutes
+
+  VERSION = '1.2.0'
+
+end

data/lib/translatable_routes.rb

@@ -0,0 +1,8 @@
+require 'translatable_routes/action_controller/base'
+require 'translatable_routes/action_dispatch/named_route_collection'
+require 'translatable_routes/action_dispatch/mapper'
+require 'translatable_routes/railtie'
+require 'translatable_routes/version'
+
+module TranslatableRoutes
+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/namespace/nested_controller.rb

@@ -0,0 +1,6 @@
+class Namespace::NestedController < ApplicationController
+
+  def show
+  end
+  
+end

data/test/dummy/app/controllers/namespace/nested_resources_controller.rb

@@ -0,0 +1,6 @@
+class Namespace::NestedResourcesController < ApplicationController
+
+  def show
+  end
+  
+end

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

@@ -0,0 +1,6 @@
+class PagesController < ApplicationController
+
+  def show
+  end
+
+end

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

@@ -0,0 +1,6 @@
+class ParamsController < ApplicationController
+
+  def show
+  end
+
+end

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

@@ -0,0 +1,6 @@
+class ResourcesController < ApplicationController
+
+  def show
+  end
+
+end

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

@@ -0,0 +1,6 @@
+class SimpleController < ApplicationController
+
+  def show
+  end
+
+end

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

@@ -0,0 +1,2 @@
+module ApplicationHelper
+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/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'