routing_filter_locale_unless_api 0.0.1 → 0.1.0

data/.gitignore

@@ -1,3 +1,17 @@
-pkg/*
+*.rbc
+*.sw?
 *.gem
+.DS_Store
 .bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+bin
+coverage*
+doc
+gemfiles
+pkg
+rdoc
+rerun.txt
+tags
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.1
+  - 1.9.2
+  - ruby-head
+  - ree

data/.yardopts

@@ -0,0 +1,8 @@
+--no-document
+--no-private
+--exclude features
+--title 'Routing Filter\'s Locale Unless API Filter Documentation'
+-
+README.md
+Changelog.md
+License.txt

data/Appraisals

@@ -0,0 +1,10 @@
+appraise "3.0" do
+  gem "i18n", "~> 0.5.0"
+  gem "actionpack", "~> 3.0"
+end
+
+# Not yet supported
+# appraise "3.1.0.rc4" do
+#   gem "i18n", "~> 0.6.0"
+#   gem "actionpack", "~> 3.1.0.rc4"
+# end

data/Changelog.md

@@ -0,0 +1,16 @@
+### Dev
+
+[full changelog](https://github.com/ZenCocoon/routing_filter_locale_unless_api/compare/v0.1.0...master)
+
+### 0.1.0 / 2011-07-04
+
+[full changelog](https://github.com/ZenCocoon/routing_filter_locale_unless_api/compare/v0.0.1...v0.1.0)
+
+* Enhancements
+  * Isolate the LocaleUnlessApi filter under it's own namespace
+  * Add [Appraisal](https://github.com/thoughtbot/appraisal) support to test with all ActionPack supported version.
+  * Move tests to RSpec.
+
+### 0.0.1 / 2011-03-01
+
+* Initial release.

data/Gemfile

@@ -1,4 +1,7 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in routing_filter_locale_unless_api.gemspec
 gemspec
+
+### MRI 1.8 and 1.9
+gem "rb-fsevent", "~> 0.3.9", :platforms => [:mri_18, :mri_19]
+gem "ruby-prof", "~> 0.9.2", :platforms => [:mri_18, :mri_19]

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', :version => 2 do
+  watch(/^spec\/(.*)_spec.rb/)
+  watch(/^lib\/(.*)\.rb/) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(/^spec\/spec_helper.rb/) { "spec" }
+end
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2011 Sébastien Grosjean
+
+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,79 @@
+# Routing Filter, Locale Unless API [![build status](http://travis-ci.org/ZenCocoon/routing_filter_locale_unless_api.png)](http://travis-ci.org/ZenCocoon/routing_filter_locale_unless_api)
+
+RoutingFilterLocaleUnlessAPI is a extension filter to Sven Fuchs’s routing-filter
+
+http://github.com/svenfuchs/routing-filter
+
+RoutingFilterLocaleUnlessAPI 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` (or any defined API format)
+* with the root url and default locale
+
+## Documentation
+
+The [RDoc](http://rubydoc.info/gems/routing_filter_locale_unless_api/0.1.0/frames) provides
+additional information for contributors and/or extenders.
+
+All of the documentation is open source and a work in progress. If you find it
+lacking or confusing, you can help improve it by submitting requests and
+patches to the [routing_filter_locale_unless_api issue
+tracker](https://github.com/ZenCocoon/routing_filter_locale_unless_api/issues).
+
+## Requirements
+
+    actionpack ~> 3.0.9
+    i18n >= 0.5.0
+    routing-filter ~> 0.2.3
+
+## Installation
+
+in your `Gemfile`
+
+    gem 'routing_filter_locale_unless_api'
+
+then 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
+
+    products_path(:locale => 'fr', :format => 'xml')
+    generated_path: /products.xml
+
+    root_path(:locale => 'en')
+    generated_path: /
+
+    root_path(:locale => 'fr')
+    generated_path: /fr
+
+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
+
+## Also see
+
+* [http://github.com/svenfuchs/routing-filter](http://github.com/svenfuchs/routing-filter)
+
+## License
+
+MIT License. Copyright 2011 Sébastien Grosjean, sponsored by [BookingSync, Vacation Rental's Booking Calendar Software](http://www.bookingsync.com)

data/Rakefile

@@ -1,2 +1,31 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'bundler/setup'
+require 'rake'
+require 'rspec/core/rake_task'
+# require 'cucumber/rake/task'
+require 'appraisal'
+
+desc "Default: Run all specs under all ActionPack supported versions."
+task :default => ["appraisal:install"] do
+  exec('rake appraisal spec')
+end
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+# Cucumber::Rake::Task.new(:cucumber)
+
+task :clobber do
+  rm_rf 'pkg'
+  rm_rf 'tmp'
+  rm_rf 'coverage'
+  rm 'coverage.data'
+end
+
+namespace :clobber do
+  desc "remove generated rbc files"
+  task :rbc do
+    Dir['**/*.rbc'].each {|f| File.delete(f)}
+  end
+end

data/lib/routing_filter_locale_unless_api/filter/locale_unless_api.rb

@@ -0,0 +1,126 @@
+require 'i18n'
+
+module RoutingFilterLocaleUnlessAPI
+  module Filter
+    class LocaleUnlessApi < RoutingFilter::Filter
+      @@api_formats = %w( xml json )
+      cattr_writer :api_formats
+
+      # Class Methods
+      class << self
+        # Returns +true+ if the given format is considered as an API, otherwise +false+.
+        #
+        # @param [String,Symbol] format
+        #
+        # @return [Boolean]
+        def api_format?(format)
+          format && @@api_formats.include?(format.to_s.downcase)
+        end
+
+        # Returns all available locales
+        #
+        # @return [Array]
+        def locales
+          @@locales ||= I18n.available_locales.map(&:to_sym)
+        end
+
+        # Set locales.
+        #
+        # @param [Array] locales
+        #
+        # @return [Array]
+        #   locales as an Array of Symbols
+        def locales=(locales)
+          @@locales = locales.map(&:to_sym)
+        end
+
+        # Define the locales pattern.
+        #
+        # @return [Regexp]
+        def locales_pattern
+          @@locales_pattern ||= %r(^/(#{self.locales.map { |l| Regexp.escape(l.to_s) }.join('|')})(?=/|$))
+        end
+      end
+
+      # Extract locale segments from the URL.
+      #
+      # @param [String] path
+      #   Current path to recognize, might have been modified by previous filters
+      #
+      # @param [Hash] env
+      #   Current environment
+      #
+      # @yield
+      #   Additional filters and finally routing
+      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
+
+      # Add locale segments to the generated URL if required.
+      #
+      # @param *args
+      #   Resources and Params given for the route generation
+      #
+      # @yield
+      #   Additional filters
+      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
+
+        # Returns true if the locale is valid.
+        #
+        # @param [Symbol,String] locale
+        #
+        # @return [Boolean]
+        def valid_locale?(locale)
+          locale && self.class.locales.include?(locale.to_sym)
+        end
+
+        # Returns true if the locale is the default one.
+        #
+        # @param [Symbol,String] locale
+        #
+        # @return [Boolean]
+        def default_locale?(locale)
+          locale && locale.to_sym == I18n.default_locale.to_sym
+        end
+
+        # Returns true if root path.
+        #
+        # @param [String] path
+        #
+        # @return [Boolean]
+        def root_path?(path)
+          path == '/'
+        end
+
+        # Returns true if it should prepend the locale
+        #
+        # @param [String] path
+        # @param [Symbol,String] locale
+        # @param [String,Symbol] format
+        #
+        # @return [Boolean]
+        def prepend_locale?(path, locale, format)
+          locale && !self.class.api_format?(format) && !(root_path?(path) && default_locale?(locale))
+        end
+
+    end
+  end
+end

data/lib/routing_filter_locale_unless_api/version.rb

@@ -1,3 +1,6 @@
-module RoutingFilterLocaleUnlessApi
-  VERSION = "0.0.1"
+module RoutingFilterLocaleUnlessAPI
+  # @private
+  module Version
+    STRING = "0.1.0"
+  end
 end

data/lib/routing_filter_locale_unless_api.rb

@@ -1,3 +1,61 @@
-module RoutingFilterLocaleUnlessApi
-  require 'routing_filter_locale_unless_api/locale_unless_api'
-end
+require 'routing_filter'
+require 'action_controller'
+require 'routing_filter_locale_unless_api/filter/locale_unless_api'
+require 'routing_filter_locale_unless_api/version'
+
+# RoutingFilterLocaleUnlessAPI is a extension filter to Sven Fuchs’s routing-filter
+#
+# http://github.com/svenfuchs/routing-filter
+#
+# RoutingFilter::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+ (or any defined API format)
+# * with the root url and default locale
+#
+# === Install:
+#
+# in your +Gemfile+
+#
+#   gem 'routing_filter_locale_unless_api'
+#
+# then in +config/routes.rb+
+#
+#   Rails.application.routes.draw do
+#     filter :locale_unless_api
+#   end
+#
+# @example
+#   incoming url: /fr/products
+#   filtered url: /products
+#   params: params[:locale] = 'fr'
+#
+#   products_path(:locale => 'fr')
+#   generated_path: /fr/products
+#
+#   products_path(:locale => 'fr', :format => 'xml')
+#   generated_path: /products.xml
+#
+#   root_path(:locale => 'en')
+#   generated_path: /
+#
+#   root_path(:locale => 'fr')
+#   generated_path: /fr
+#
+# === Configuration
+#
+# You can customize the API formats with
+#
+#    Rails.application.routes.draw do
+#      filter :locale_unless_api, :api_formats => %w( xml json xls )
+#    end
+module RoutingFilterLocaleUnlessAPI
+end
+
+module RoutingFilter
+  include RoutingFilterLocaleUnlessAPI::Filter
+end

data/routing_filter_locale_unless_api.gemspec

@@ -1,24 +1,33 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "routing_filter_locale_unless_api/version"
+require 'routing_filter_locale_unless_api/version'
 
 Gem::Specification.new do |s|
   s.name        = "routing_filter_locale_unless_api"
-  s.version     = RoutingFilterLocaleUnlessApi::VERSION
+  s.version     = RoutingFilterLocaleUnlessAPI::Version::STRING
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Sébastien Grosjean"]
-  s.email       = ["public@zencocoon.com"]
+  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 -- {spec,features}/*`.split("\n")
+  s.extra_rdoc_files  = "README.md"
+  s.rdoc_options      = "--charset=UTF-8"
+  s.require_path      = "lib"
 
-  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 "actionpack", "~> 3.0.9"
+  s.add_dependency "i18n", ">= 0.5.0"
   s.add_dependency "routing-filter", "~> 0.2.3"
-  s.add_development_dependency 'test_declarative'
+
+  s.add_development_dependency "rake", "~> 0.9"
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency "cucumber", "1.0.0"
+  s.add_development_dependency "guard-rspec", "0.1.9"
+  s.add_development_dependency 'guard-cucumber', "~> 0.5.1"
+  s.add_development_dependency "growl", "1.0.3"
+  s.add_development_dependency 'yard', "~> 0.7.2"
+  s.add_development_dependency "appraisal", '~> 0.3.6'
 end

data/spec/routing_filter_locale_unless_api/filter/locale_unless_api_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+module RoutingFilterLocaleUnlessAPI::Filter
+  describe LocaleUnlessApi do
+    before do
+      I18n.locale = nil
+      I18n.default_locale = :en
+      I18n.available_locales = %w(fr en)
+
+      RoutingFilter::LocaleUnlessApi.api_formats = %w( xml json )
+    end
+
+    let(:root) { { :controller => 'some', :action => 'index' } }
+    let(:params) { { :controller => 'some', :action => 'show', :id => '1' } }
+    let(:routes) do
+      draw_routes do
+        filter :locale_unless_api
+        match 'products/:id', :to => 'some#show'
+        root :to => 'some#index'
+      end
+    end
+
+    context "path recognition" do
+      it 'should recognize /en/products/1' do
+        params.merge(:locale => 'en').should == routes.recognize_path('/en/products/1')
+      end
+
+      it 'should recognize /fr/products/1' do
+        params.merge(:locale => 'fr').should == routes.recognize_path('/fr/products/1')
+      end
+
+      it 'should recognize /products/1.xml' do
+        params.merge(:format => 'xml').should == routes.recognize_path('/products/1.xml')
+      end
+
+      it 'should recognize /products/1.json' do
+        params.merge(:format => 'json').should == routes.recognize_path('/products/1.json')
+      end
+
+      it 'should recognize /en' do
+        root.merge(:locale => 'en').should == routes.recognize_path('/en/')
+      end
+
+      it 'should recognize /fr' do
+        root.merge(:locale => 'fr').should == routes.recognize_path('/fr')
+      end
+
+      it 'should recognize /' do
+        root.should == routes.recognize_path('/')
+      end
+    end
+
+    context "route generation" do
+      context "with locale set" do
+        before(:each) do
+          I18n.locale = 'fr'
+        end
+
+        context "prepends the segments /:locale to the generated path" do
+          it 'if the current locale is not the default locale' do
+            routes.generate(params).should == '/fr/products/1'
+          end
+
+          it 'if the current locale is the default locale' do
+            I18n.locale = 'en'
+            routes.generate(params).should == '/en/products/1'
+          end
+
+          it 'if the current locale is not the default locale and with root url' do
+            routes.generate(root).should == '/fr'
+          end
+
+          it 'if the format XLS is not considered as api' do
+            routes.generate(params.merge(:format => 'xls')).should == '/fr/products/1.xls'
+          end
+        end
+
+        context "does not prepend the segments /:locale to the generated path" do
+          it 'if the current locale is the default locale and with root url' do
+            I18n.locale = 'en'
+            routes.generate(root).should == '/'
+          end
+
+          it 'if the format XML is considered as api' do
+            routes.generate(params.merge(:format => 'xml')).should == '/products/1.xml'
+          end
+
+          it 'if the format JSON is considered as api' do
+            routes.generate(params.merge(:format => 'json')).should == '/products/1.json'
+          end
+
+          it 'if the format XLS is considered as api' do
+            RoutingFilter::LocaleUnlessApi.api_formats = %w( xml json xls )
+            routes.generate(params.merge(:format => 'xls')).should == '/products/1.xls'
+          end
+        end
+
+        it 'should work with format as symbol' do
+          routes.generate(params.merge(:format => :xml)).should == '/products/1.xml'
+        end
+      end
+
+      context "with locale as param" do
+        let(:params) { { :controller => 'some', :action => 'show', :id => '1', :locale => 'fr' } }
+
+        context "prepends the segments /:locale to the generated path" do
+          it 'if the given locale is not the default locale' do
+            routes.generate(params).should == '/fr/products/1'
+          end
+
+          it 'if the given locale is the default locale' do
+            routes.generate(params.merge(:locale => 'en')).should == '/en/products/1'
+          end
+
+          it 'if the given locale is not the default locale and with root url' do
+            routes.generate(root.merge(:locale => 'fr')).should == '/fr'
+          end
+
+          it 'if a given locale and the format XLS is not considered as api' do
+            routes.generate(params.merge(:format => 'xls')).should == '/fr/products/1.xls'
+          end
+        end
+
+        context "does not prepend the segments /:locale to the generated path" do
+          it 'if a given locale is the default locale and with the root url' do
+            routes.generate(root.merge(:locale => 'en')).should == '/'
+          end
+
+          it 'if a given locale and the format XML is considered as api' do
+            routes.generate(params.merge(:format => 'xml')).should == '/products/1.xml'
+          end
+
+          it 'if a given locale and the format JSON is considered as api' do
+            routes.generate(params.merge(:format => 'json')).should == '/products/1.json'
+          end
+
+          it 'if a given locale and the format XLS is considered as api' do
+            RoutingFilter::LocaleUnlessApi.api_formats = %w( xml json xls )
+            routes.generate(params.merge(:format => 'xls')).should == '/products/1.xls'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'routing_filter_locale_unless_api'
+
+RSpec::configure do |config|
+  config.color_enabled = true
+end
+
+include RoutingFilter
+
+class SomeController < ActionController::Base
+end
+
+def draw_routes(&block)
+  ActionDispatch::Routing::RouteSet.new.tap { |set| set.draw(&block) }
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: routing_filter_locale_unless_api
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - "S\xC3\xA9bastien Grosjean"
@@ -15,13 +15,45 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +02:00
+date: 2011-07-04 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: routing-filter
+  name: actionpack
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 3
+        - 0
+        - 9
+        version: 3.0.9
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: routing-filter
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,48 +65,166 @@ dependencies:
         - 3
         version: 0.2.3
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: test_declarative
+  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 25
         segments: 
         - 0
-        version: "0"
+        - 9
+        version: "0.9"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        - 9
+        version: 0.1.9
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: guard-cucumber
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 5
+        - 1
+        version: 0.5.1
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 7
+        - 2
+        version: 0.7.2
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: appraisal
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 3
+        - 6
+        version: 0.3.6
+  type: :development
+  version_requirements: *id011
 description: A routing-filter additional filter that add locale unless XML or JSON, or root_url with default locale
-email: 
-- public@zencocoon.com
+email: public@zencocoon.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.md
 files: 
 - .gitignore
+- .travis.yml
+- .yardopts
+- Appraisals
+- Changelog.md
 - Gemfile
-- README.rdoc
+- Guardfile
+- License.txt
+- README.md
 - Rakefile
 - lib/routing_filter_locale_unless_api.rb
-- lib/routing_filter_locale_unless_api/locale_unless_api.rb
+- lib/routing_filter_locale_unless_api/filter/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
+- spec/routing_filter_locale_unless_api/filter/locale_unless_api_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/ZenCocoon/routing_filter_locale_unless_api
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -97,11 +247,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: "[none]"
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.6.2
 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
+- spec/routing_filter_locale_unless_api/filter/locale_unless_api_spec.rb
+- spec/spec_helper.rb

data/README.rdoc

@@ -1,54 +0,0 @@
-= 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/lib/routing_filter_locale_unless_api/locale_unless_api.rb

@@ -1,95 +0,0 @@
-# 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/test/locale_unless_api_test.rb

@@ -1,130 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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