localizable_routes 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f30440ad5de3d74b22c0db449f7352e66641215c
+  data.tar.gz: 483acff5872ffd7600b627151f1554e86b40a5c7
+SHA512:
+  metadata.gz: 268acb37ad8d2fa296619813e719f9df6f4299ab88aa7d76ddb987ab0b6c7da6996aae90669f7d6f8f98690079850a714abbb9391a96add1f8ff18d4ce3a4328
+  data.tar.gz: e3d3587a50180d3196c9814266dd8f6b4fc04835f140083e020b5aac5d39843e93e486fe25395e5642d25f1433da32e11556cdfc8130f7de765a727e9d2768a2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Mathías Montossi
+
+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,74 @@
+[![Gem Version](https://badge.fury.io/rb/localizable_routes.svg)](http://badge.fury.io/rb/localizable_routes)
+[![Code Climate](https://codeclimate.com/github/mmontossi/localizable_routes/badges/gpa.svg)](https://codeclimate.com/github/mmontossi/localizable_routes)
+[![Build Status](https://travis-ci.org/mmontossi/localizable_routes.svg)](https://travis-ci.org/mmontossi/localizable_routes)
+[![Dependency Status](https://gemnasium.com/mmontossi/localizable_routes.svg)](https://gemnasium.com/mmontossi/localizable_routes)
+
+# Localizable Routes
+
+Minimalistic toolkit to localize routes in rails.
+
+## Install
+
+Put this line in your Gemfile:
+```ruby
+gem 'localizable_routes'
+```
+
+Then bundle:
+```
+$ bundle
+```
+
+## Configuration
+
+In your config/routes.rb use the localized method to decide wich routes will be localized:
+```ruby
+localized strategy: :param, locales: %i(es en) do
+  get 'page' => 'pages#show', as: :param
+end
+
+localized strategy: :subdomain, locales: { 'uy' => :es, 'us' => :en } do
+  get 'page' => 'pages#show', as: :subdomain
+end
+
+localized strategy: :domain, locales: { 'domain.uy' => :es, 'domain.us' => :en } do
+  get 'page' => 'pages#show', as: :domain
+end
+```
+
+Put your localizations inside the routes key in your locales yamls:
+```yaml
+es:
+  routes:
+    page: "pagina"
+```
+
+NOTE: There is no need to put the full path, just localize each part individually.
+
+## Usage
+
+Helpers will continue working the same:
+```ruby
+param_path # Will output /en/pagina in case I18n.locale is :es for param strategy
+
+subdomain_url # Will output http://uy.domain.com/pagina if current subdomain is uy
+
+domain_url # Will output http://domain.uy/pagina if current domain is domain.uy
+```
+
+And you can change the locale by passing the corresponding parameter:
+```ruby
+param_path locale: :en # Will output /en/page
+
+subdomain_url sudomain: 'us' # Will output http://us.domain.com/page
+
+domain_url domain: 'domain.us' # Will output http://domain.us/page
+```
+
+## Credits
+
+This gem is maintained and funded by [mmontossi](https://github.com/mmontossi).
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,35 @@
+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    = 'LocalizableRoutes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+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/localizable_routes/extensions/action_dispatch/mapper.rb

@@ -0,0 +1,84 @@
+module LocalizableRoutes
+  module Extensions
+    module ActionDispatch
+      module Mapper
+        extend ActiveSupport::Concern
+
+        def initialize(set)
+          super
+          @localization = @locale = nil
+        end
+
+        def localized(options)
+          @localization = options
+          if options[:strategy] == :param
+            scope(':locale') do
+              yield
+            end
+          else
+            yield
+          end
+          @localization = nil
+        end
+
+        def add_route(action, options)
+          if @localization
+            @localization[:locales].each do |locale|
+              localized_options = options.dup
+              localized_options[:constraints] ||= {}
+              localized_options[:defaults] ||= {}
+              strategy = @localization[:strategy]
+              if strategy == :param
+                @locale = locale
+                localized_options[:constraints][:locale] = locale
+                localized_options[:defaults][:locale] = locale
+              else
+                @locale = locale.second
+                localized_options[:constraints][strategy] = locale.first
+                localized_options[:defaults][strategy] = locale.first
+              end
+              super action, localized_options
+            end
+            @locale = nil
+            if options.fetch(:as, true)
+              @set.named_routes.define_localized_url_helper(
+                name_for_action(options[:as], action),
+                @localization
+              )
+            end
+          else
+            super
+          end
+        end
+
+        def name_for_action(as, action)
+          candidate = super
+          if candidate && @locale
+            suffixed_candidate = "#{super}_#{@locale}"
+            if !as.nil? || !@set.named_routes.routes.has_key?(suffixed_candidate.to_sym)
+              suffixed_candidate
+            end
+          else
+            candidate
+          end
+        end
+
+        def path_for_action(action, path)
+          candidate = super
+          if candidate && @locale
+            candidate.gsub(/:?[a-z0-9_-]+/) do |slug|
+              if slug =~ /^[\:]/
+                slug
+              else
+                I18n.t "routes.#{slug.gsub('-', '_')}", locale: @locale.to_s, default: slug
+              end
+            end
+          else
+            candidate
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/localizable_routes/extensions/action_dispatch/named_route_collection.rb

@@ -0,0 +1,43 @@
+module LocalizableRoutes
+  module Extensions
+    module ActionDispatch
+      module NamedRouteCollection
+        extend ActiveSupport::Concern
+
+        def define_localized_url_helper(name, localization)
+          %w(path url).each do |type|
+            helper = :"#{name}_#{type}"
+
+            if Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR >= 2
+              target = instance_variable_get("@#{type}_helpers_module")
+            else
+              target = @module
+            end
+
+            target.remove_possible_method helper
+            target.module_eval do
+              define_method helper do |*args|
+                options = args.extract_options!
+                strategy = localization[:strategy]
+                if strategy == :param
+                  locale = (options[:locale] || url_options[:locale] || I18n.locale)
+                else
+                  key = (options[strategy] || url_options[strategy])
+                  locale = localization[:locales][key.to_s]
+                end
+                send "#{name}_#{locale}_#{type}", *(args << options)
+              end
+            end
+
+            if Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR >= 2
+              instance_variable_get("@#{type}_helpers") << helper
+            else
+              helpers << helper
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/localizable_routes/railtie.rb

@@ -0,0 +1,14 @@
+module LocalizableRoutes
+  class Railtie < Rails::Railtie
+
+    initializer 'localizable_routes' do
+      ::ActionDispatch::Routing::RouteSet::NamedRouteCollection.include(
+        LocalizableRoutes::Extensions::ActionDispatch::NamedRouteCollection
+      )
+      ::ActionDispatch::Routing::Mapper.prepend(
+        LocalizableRoutes::Extensions::ActionDispatch::Mapper
+      )
+    end
+
+  end
+end

data/lib/localizable_routes/version.rb

@@ -0,0 +1,5 @@
+module LocalizableRoutes
+
+  VERSION = '2.0.0'
+
+end

data/lib/localizable_routes.rb

@@ -0,0 +1,6 @@
+require 'localizable_routes/extensions/action_dispatch/named_route_collection'
+require 'localizable_routes/extensions/action_dispatch/mapper'
+require 'localizable_routes/railtie'
+
+module LocalizableRoutes
+end

data/test/dummy/Rakefile

@@ -0,0 +1,5 @@
+# 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__)
+Rails.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 any plugin's vendor/assets/javascripts directory 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/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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/pages_controller.rb

@@ -0,0 +1,6 @@
+class Namespace::PagesController < ApplicationController
+
+  def nested
+  end
+ 
+end

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

@@ -0,0 +1,6 @@
+class Namespace::ResourcesController < ApplicationController
+
+  def index
+  end
+ 
+end

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

@@ -0,0 +1,6 @@
+class NestedsController < ApplicationController
+
+  def index
+  end
+
+end

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

@@ -0,0 +1,12 @@
+class PagesController < ApplicationController
+ 
+  def index
+  end
+
+  def simple
+  end
+
+  def complex
+  end
+
+end

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

@@ -0,0 +1,6 @@
+class ResourcesController < ApplicationController
+
+  def index
+  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'

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/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts '== Installing dependencies =='
+  system 'gem install bundler --conservative'
+  system 'bundle check || bundle install'
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   system 'cp config/database.yml.sample config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system 'bin/rake db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system 'rm -f log/*'
+  system 'rm -rf tmp/cache'
+
+  puts "\n== Restarting application server =="
+  system 'touch tmp/restart.txt'
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'active_model/railtie'
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+require 'rails/test_unit/railtie'
+
+Bundler.require(*Rails.groups)
+require 'localizable_routes'
+
+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.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

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

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

@@ -0,0 +1,38 @@
+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
+
+  # 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
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

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

@@ -0,0 +1,76 @@
+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 threaded 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 serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # 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
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # 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
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # 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'
+
+  # 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 cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

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

@@ -0,0 +1,42 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static file server for tests with Cache-Control for performance.
+  config.serve_static_files = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Randomize the order test cases are executed.
+  config.active_support.test_order = :random
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/initializers/assets.rb

@@ -0,0 +1,11 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path
+# Rails.application.config.assets.paths << Emoji.images_path
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+# Rails.application.config.assets.precompile += %w( search.js )