i18n_strategy 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/
+log/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=d

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - rbx-19mode
+  - jruby-19mode
+  - jruby-head

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kentaro Kuribayashi
+
+MIT License
+
+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,69 @@
+# i18n_strategy [![BuildStatus](https://secure.travis-ci.org/kentaro/i18n_strategy.png)](http://travis-ci.org/kentaro/i18n_strategy)
+
+i18n_strategy provides a very much simple way to detect and set locale
+in your Rails application.
+
+## Usage
+
+Add a line below into your `Gemfile`:
+
+```
+gem 'i18n_strategy'
+```
+
+Then, set your custom strategy into `I18nStrategy.strategy`, which is
+to detect a locale for a user visiting your application.
+
+`initializers/i18n_strategy`:
+
+```
+module MyStrategy
+  def detect_locale
+    params[:locale]   # just simple and fragile way
+  end
+end
+
+I18nStrategy.strategy = MyStrategy
+I18nStrategy.available_languages = %w[ja en]
+```
+
+Users' locale detected by the strategy is automatically set to
+`I18n.locale`.
+
+That's all. Very much simple.
+
+## Customization
+
+### I18nStrategy.strategy
+
+Set your own custom strategy module via this method. If not set,
+[default strategy](./lib/i18n_strategy/strategy.rb) will be used.
+
+The module must implement `detect_locale` method or some other one set
+by `I18nStrategy.method_to_detect_locale` method described below.
+
+### I18nStrategy.method_to_detect_locale
+
+Set another method instead of default one, `detect_locale`.
+
+The method to be used to detect users' locale will be called as a
+instance method of a controller which is currently dispatched. That is
+to say, it can duplicate your existing method.
+
+In case above, you can set another method name to be called via this
+method.
+
+### I18nStrategy.available_languages
+
+Set available language in your application.
+
+The default strategy utilizes this method to detect whether the
+language from users can be available in your application or not.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.ruby_opts = %w[-w]
+end
+
+task :default => :spec

data/i18n_strategy.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n_strategy/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "i18n_strategy"
+  gem.version       = I18nStrategy::VERSION
+  gem.authors       = ["Kentaro Kuribayashi"]
+  gem.email         = ["kentarok@gmail.com"]
+  gem.description   = %q{Provides a very much simple way to detect and set locale in your Rails application}
+  gem.summary       = %q{Provides a very much simple way to detect and set locale in your Rails application}
+  gem.homepage      = "https://github.com/kentaro/i18n_strategy"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rails', '>= 3.0.0'
+  gem.add_dependency 'http_accept_language', '>= 2.0.0pre'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-rails'
+end

data/lib/i18n_strategy.rb

@@ -0,0 +1,4 @@
+require "i18n_strategy/version"
+require "i18n_strategy/initializer"
+require "i18n_strategy/strategy"
+require "i18n_strategy/railtie"

data/lib/i18n_strategy/initializer.rb

@@ -0,0 +1,27 @@
+module I18nStrategy
+  mattr_accessor :strategy, :method_to_detect_locale, :available_languages
+
+  class Initializer
+    def self.init(app)
+      # Set I18nStrategy::Strategy::Default as default strategy
+      I18nStrategy.strategy ||= I18nStrategy::Strategy::Default
+
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send(:include, Filter)
+      end
+    end
+  end
+
+  module Filter
+    extend ActiveSupport::Concern
+
+    included do
+      append_before_filter :set_locale
+    end
+
+    def set_locale
+      ActionController::Base.send(:include, I18nStrategy.strategy)
+      I18n.locale = send(I18nStrategy.method_to_detect_locale || :detect_locale)
+    end
+  end
+end

data/lib/i18n_strategy/railtie.rb

@@ -0,0 +1,7 @@
+module I18nStrategy
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'i18n_strategy' do |app|
+      I18nStrategy::Initializer.init(app)
+    end
+  end
+end

data/lib/i18n_strategy/strategy.rb

@@ -0,0 +1,21 @@
+require 'http_accept_language/parser'
+
+module I18nStrategy
+  module Strategy
+    module Default
+      def detect_locale
+        lang      = nil
+        available = I18nStrategy.available_languages || []
+
+        if params[:locale] && available.include?(params[:locale])
+          lang = params[:locale]
+        else
+          parser = HttpAcceptLanguage::Parser.new(request.env['HTTP_ACCEPT_LANGUAGE'])
+          lang   = parser.preferred_language_from(available)
+        end
+
+        lang || I18n.default_locale
+      end
+    end
+  end
+end

data/lib/i18n_strategy/version.rb

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

data/spec/app/test_app.rb

@@ -0,0 +1,25 @@
+require 'action_controller/railtie'
+
+module I18nStrategyTestApp
+  class Application < Rails::Application
+    config.default_locale = 'en'
+    config.active_support.deprecation = :log
+  end
+end
+
+I18nStrategyTestApp::Application.initialize!
+
+# routes
+I18nStrategyTestApp::Application.routes.draw do
+  root :to => 'root#index'
+end
+
+# controllers
+class ApplicationController < ActionController::Base
+end
+
+class RootController < ApplicationController
+  def index
+    render :text => I18n.locale
+  end
+end

data/spec/controllers/locale_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe RootController do
+  before {
+    I18nStrategy.strategy = I18nStrategy::Strategy::Default
+    I18nStrategy.available_languages = %w[en ja fr]
+  }
+
+  describe 'GET /' do
+    context 'with no preferred language' do
+      before { get :index }
+
+      it {
+        expect(response.body).to be == 'en'
+      }
+    end
+
+    context 'with preferred language' do
+      context 'en' do
+        before {
+          request.env['HTTP_ACCEPT_LANGUAGE'] = 'en'
+          get :index
+        }
+
+        it {
+          expect(response.body).to be == 'en'
+        }
+      end
+
+      context 'ja' do
+        before {
+          request.env['HTTP_ACCEPT_LANGUAGE'] = 'ja'
+          get :index
+        }
+
+        it {
+          expect(response.body).to be == 'ja'
+        }
+      end
+    end
+
+    context 'with preferred language from query param' do
+      context 'with valid language' do
+        before {
+          request.env['HTTP_ACCEPT_LANGUAGE'] = 'ja'
+          get :index, :locale => 'fr'
+        }
+
+        it {
+          expect(response.body).to be == 'fr'
+        }
+      end
+
+      context 'with invalid language' do
+        before {
+          request.env['HTTP_ACCEPT_LANGUAGE'] = 'ja'
+          get :index, :locale => 'no_such_language'
+        }
+
+        it {
+          expect(response.body).to be == 'ja'
+        }
+      end
+    end
+
+    context 'with custom strategy' do
+      module MyStrategy
+        def detect_locale
+          'foo'
+        end
+
+        def another_detect_locale
+          'bar'
+        end
+      end
+
+      context 'with no preferred method' do
+        before {
+          I18nStrategy.strategy = MyStrategy
+          get :index
+        }
+
+        it {
+          expect(response.body).to be == 'foo'
+        }
+      end
+
+      context 'with preferred method' do
+        before {
+          I18nStrategy.strategy = MyStrategy
+          I18nStrategy.method_to_detect_locale = :another_detect_locale
+          get :index
+        }
+
+        it {
+          expect(response.body).to be == 'bar'
+        }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+ENV['RAILS_EN'] ||= 'test'
+
+require 'rails'
+require 'i18n_strategy'
+require 'app/test_app'
+require 'rspec/rails'

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: i18n_strategy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kentaro Kuribayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: http_accept_language
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0pre
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a very much simple way to detect and set locale in your Rails
+  application
+email:
+- kentarok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- i18n_strategy.gemspec
+- lib/i18n_strategy.rb
+- lib/i18n_strategy/initializer.rb
+- lib/i18n_strategy/railtie.rb
+- lib/i18n_strategy/strategy.rb
+- lib/i18n_strategy/version.rb
+- spec/app/test_app.rb
+- spec/controllers/locale_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kentaro/i18n_strategy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides a very much simple way to detect and set locale in your Rails application
+test_files:
+- spec/app/test_app.rb
+- spec/controllers/locale_spec.rb
+- spec/spec_helper.rb
+has_rdoc: