routing_filter_locale_unless_api 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in routing_filter_locale_unless_api.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,54 @@
+= Routing Filter : Locale Unless API
+
+The LocaleUnlessAPI filter is an extension to Sven Fuchs's routing-filter
+
+https://github.com/svenfuchs/routing-filter
+
+LocaleUnlessAPI filter extracts segments matching /:locale from the beginning of
+the recognized path and exposes the locale parameter as params[:locale]. When a
+path is generated the filter adds the segments to the path accordingly if
+the locale parameter is passed to the url helper.
+
+It will not add the locale parameter as a url fragment if:
+
+* the format is XML or JSON
+* with the root url and default locale
+
+== Requirements
+
+  routing-filter ~> 0.2.3
+
+== Installation
+
+in config/routes.rb
+
+  Rails.application.routes.draw do
+    filter :locale_unless_api
+  end
+
+== Usage
+
+  incoming url: /fr/products
+  filtered url: /products
+  params: params[:locale] = 'fr'
+  
+  products_path(:locale => 'fr')
+  generated_path: /fr/products
+
+More example visible in the tests cases
+
+== Configuration
+
+You can customize the API formats with
+
+  Rails.application.routes.draw do
+    filter :locale_unless_api, :api_formats => %w( xml json xls )
+  end
+
+== Maintainers
+
+* Sébastien Grosjean (http://www.github.com/ZenCocoon)
+
+== License
+
+MIT License. Copyright 2011 Sébastien Grosjean, sponsored by {BookingSync Vacation Rental Booking Calendar Software}[http://www.bookingsync.com]

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/routing_filter_locale_unless_api.rb

@@ -0,0 +1,3 @@
+module RoutingFilterLocaleUnlessApi
+  require 'routing_filter_locale_unless_api/locale_unless_api'
+end

data/lib/routing_filter_locale_unless_api/locale_unless_api.rb

@@ -0,0 +1,95 @@
+# The LocaleUnlessAPI filter is an extension to Sven Fuchs's routing-filter
+# 
+# https://github.com/svenfuchs/routing-filter
+# 
+# LocaleUnlessAPI filter extracts segments matching /:locale from the beginning of
+# the recognized path and exposes the locale parameter as params[:locale]. When a
+# path is generated the filter adds the segments to the path accordingly if
+# the locale parameter is passed to the url helper.
+# 
+# It will not add the locale parameter as a url fragment if:
+# 
+# * the format is XML or JSON
+# * with the root url and default locale
+# 
+# incoming url: /fr/products
+# filtered url: /products
+# params: params[:locale] = 'fr'
+# 
+# products_path(:locale => 'fr')
+# generated_path: /fr/products
+# 
+# You can install the filter like this:
+#
+# in config/routes.rb
+# 
+# Rails.application.routes.draw do
+#   filter :locale_unless_api
+# end
+
+require 'i18n'
+
+module RoutingFilter
+  class LocaleUnlessApi < Filter
+    @@api_formats = %w( xml json )
+    cattr_writer :api_formats
+
+    class << self
+      def api_format?(format)
+        format && @@api_formats.include?(format.to_s.downcase)
+      end
+
+      def locales
+        @@locales ||= I18n.available_locales.map(&:to_sym)
+      end
+
+      def locales=(locales)
+        @@locales = locales.map(&:to_sym)
+      end
+
+      def locales_pattern
+        @@locales_pattern ||= %r(^/(#{self.locales.map { |l| Regexp.escape(l.to_s) }.join('|')})(?=/|$))
+      end
+    end
+
+    def around_recognize(path, env, &block)
+      locale = extract_segment!(self.class.locales_pattern, path) # remove the locale from the beginning of the path
+      yield.tap do |params|                                       # invoke the given block (calls more filters and finally routing)
+        params[:locale] = locale if locale                        # set recognized locale to the resulting params hash
+      end
+    end
+
+    def around_generate(*args, &block)
+      params = args.extract_options!                              # this is because we might get a call like forum_topics_path(forum, topic, :locale => :en)
+
+      format = params[:format]                                    # save the current format
+      locale = params.delete(:locale)                             # extract the passed :locale option
+      locale = I18n.locale if locale.nil?                         # default to I18n.locale when locale is nil (could also be false)
+      locale = nil unless valid_locale?(locale)                   # reset to no locale when locale is not valid
+
+      args << params
+
+      yield.tap do |result|
+        prepend_segment!(result, locale) if prepend_locale?(result, locale, format)
+      end
+    end
+
+    protected
+
+      def valid_locale?(locale)
+        locale && self.class.locales.include?(locale.to_sym)
+      end
+
+      def default_locale?(locale)
+        locale && locale.to_sym == I18n.default_locale.to_sym
+      end
+      
+      def root_path?(result)
+        result == '/'
+      end
+
+      def prepend_locale?(result, locale, format)
+        locale && !self.class.api_format?(format) && !(root_path?(result) && default_locale?(locale))
+      end
+  end
+end

data/lib/routing_filter_locale_unless_api/version.rb

@@ -0,0 +1,3 @@
+module RoutingFilterLocaleUnlessApi
+  VERSION = "0.0.1"
+end

data/routing_filter_locale_unless_api.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "routing_filter_locale_unless_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "routing_filter_locale_unless_api"
+  s.version     = RoutingFilterLocaleUnlessApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Sébastien Grosjean"]
+  s.email       = ["public@zencocoon.com"]
+  s.homepage    = "https://github.com/ZenCocoon/routing_filter_locale_unless_api"
+  s.summary     = %q{routing filter that add locale unless XML or JSON, or root_url with default locale}
+  s.description = %q{A routing-filter additional filter that add locale unless XML or JSON, or root_url with default locale}
+
+  s.rubyforge_project = "[none]"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "routing-filter", "~> 0.2.3"
+  s.add_development_dependency 'test_declarative'
+end

data/test/locale_unless_api_test.rb

@@ -0,0 +1,130 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class LocaleUnlessApiTest < Test::Unit::TestCase
+  attr_reader :routes, :root, :params
+
+  def setup
+    I18n.locale = nil
+    I18n.default_locale = :en
+    I18n.available_locales = %w(fr en)
+
+    RoutingFilter::LocaleUnlessApi.api_formats = %w( xml json )
+
+    @root   = { :controller => 'some', :action => 'index' }
+    @params = { :controller => 'some', :action => 'show', :id => '1' }
+
+    @routes = draw_routes do
+      filter :locale_unless_api
+      match 'products/:id', :to => 'some#show'
+      root :to => 'some#index'
+    end
+  end
+
+  test 'recognizes the path /en/products/1' do
+    assert_equal params.merge(:locale => 'en'), routes.recognize_path('/en/products/1')
+  end
+
+  test 'recognizes the path /fr/products/1' do
+    assert_equal params.merge(:locale => 'fr'), routes.recognize_path('/fr/products/1')
+  end
+  
+  test 'recognizes the path /products/1.xml' do
+    assert_equal params.merge(:format => 'xml'), routes.recognize_path('/products/1.xml')
+  end
+
+  test 'recognizes the path /products/1.json' do
+    assert_equal params.merge(:format => 'json'), routes.recognize_path('/products/1.json')
+  end
+  
+  test 'recognizes the path /en' do
+    assert_equal root.merge(:locale => 'en'), routes.recognize_path('/en/')
+  end
+  
+  test 'recognizes the path /fr' do
+    assert_equal root.merge(:locale => 'fr'), routes.recognize_path('/fr')
+  end
+  
+  test 'recognizes the path /' do
+    assert_equal root, routes.recognize_path('/')
+  end
+
+
+  test 'prepends the segments /:locale to the generated path if the current locale is not the default locale' do
+    I18n.locale = 'fr'
+    assert_equal '/fr/products/1', routes.generate(params)
+  end
+  
+  test 'prepends the segments /:locale to the generated path even if the current locale is not the default locale' do
+    I18n.locale = 'en'
+    assert_equal '/en/products/1', routes.generate(params)
+  end
+  
+  test 'does not prepend the segments /:locale to the generated path if the current locale is the default locale and with root url' do
+    I18n.locale = 'en'
+    assert_equal '/', routes.generate(root)
+  end
+  
+  test 'prepends the segments /:locale to the generated path if the current locale is not the default locale and with root url' do
+    I18n.locale = 'fr'
+    assert_equal '/fr', routes.generate(root)
+  end
+  
+  test 'does not prepend the segments /:locale to the generated path if the format XML is considered as api' do
+    I18n.locale = 'fr'
+    assert_equal '/products/1.xml', routes.generate(params.merge(:format => 'xml'))
+  end
+  
+  test 'does not prepend the segments /:locale to the generated path if the format JSON is considered as api' do
+    I18n.locale = 'fr'
+    assert_equal '/products/1.json', routes.generate(params.merge(:format => 'json'))
+  end
+  
+  test 'prepends the segments /:locale to the generated path if the format XLS is not considered as api' do
+    I18n.locale = 'fr'
+    assert_equal '/fr/products/1.xls', routes.generate(params.merge(:format => 'xls'))
+  end
+  
+  test 'does not prepend the segments /:locale to the generated path if the format XLS is considered as api' do
+    I18n.locale = 'fr'
+    RoutingFilter::LocaleUnlessApi.api_formats = %w( xml json xls )
+    assert_equal '/products/1.xls', routes.generate(params.merge(:format => 'xls'))
+  end
+  
+  test 'should work with format as symbol' do
+    assert_equal '/products/1.xml', routes.generate(params.merge(:format => :xml))
+  end
+
+
+  test 'prepends the segments /:locale to the generated path if the given locale is not the default locale' do
+    assert_equal '/fr/products/1', routes.generate(params.merge(:locale => 'fr'))
+  end
+  
+  test 'prepends the segments /:locale to the generated path even if the given locale is the default locale' do
+    assert_equal '/en/products/1', routes.generate(params.merge(:locale => 'en'))
+  end
+  
+  test 'does not prepend the segments /:locale to the generated path if the given locale is the default locale and with root url' do
+    assert_equal '/', routes.generate(root.merge(:locale => 'en'))
+  end
+  
+  test 'prepends the segments /:locale to the generated path if the given locale is not the default locale and with root url' do
+    assert_equal '/fr', routes.generate(root.merge(:locale => 'fr'))
+  end
+  
+  test 'does not prepend the segments /:locale to the generated path if a given locale and the format XML is considered as api' do
+    assert_equal '/products/1.xml', routes.generate(params.merge(:format => 'xml', :locale => 'fr'))
+  end
+  
+  test 'does not prepend the segments /:locale to the generated path if a given locale and the format JSON is considered as api' do
+    assert_equal '/products/1.json', routes.generate(params.merge(:format => 'json', :locale => 'fr'))
+  end
+  
+  test 'prepends the segments /:locale to the generated path if a given locale and the format XLS is not considered as api' do
+    assert_equal '/fr/products/1.xls', routes.generate(params.merge(:format => 'xls', :locale => 'fr'))
+  end
+  
+  test 'does not prepend the segments /:locale to the generated path if a given locale and the format XLS is considered as api' do
+    RoutingFilter::LocaleUnlessApi.api_formats = %w( xml json xls )
+    assert_equal '/products/1.xls', routes.generate(params.merge(:format => 'xls', :locale => 'fr'))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+ENV['RAILS_ENV'] = 'test'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+
+require 'test/unit'
+require 'i18n'
+require 'action_pack'
+require 'active_support'
+require 'action_controller'
+require 'active_support/core_ext/enumerable.rb'
+require 'test_declarative'
+require 'routing_filter'
+require 'routing_filter_locale_unless_api'
+
+include RoutingFilter
+
+class SomeController < ActionController::Base
+end
+
+class Test::Unit::TestCase
+  def draw_routes(&block)
+    ActionDispatch::Routing::RouteSet.new.tap { |set| set.draw(&block) }
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: routing_filter_locale_unless_api
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "S\xC3\xA9bastien Grosjean"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: routing-filter
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 2
+        - 3
+        version: 0.2.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test_declarative
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A routing-filter additional filter that add locale unless XML or JSON, or root_url with default locale
+email: 
+- public@zencocoon.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/routing_filter_locale_unless_api.rb
+- lib/routing_filter_locale_unless_api/locale_unless_api.rb
+- lib/routing_filter_locale_unless_api/version.rb
+- routing_filter_locale_unless_api.gemspec
+- test/locale_unless_api_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/ZenCocoon/routing_filter_locale_unless_api
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: "[none]"
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: routing filter that add locale unless XML or JSON, or root_url with default locale
+test_files: 
+- test/locale_unless_api_test.rb
+- test/test_helper.rb