localized 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.swp
+log/*.log
+.DS_Store
+

data/.rvmrc

@@ -0,0 +1,3 @@
+rvm use 1.9.2
+rvm gemset create gem-localized
+rvm gemset use gem-localized

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    localized (0.0.1)
+      rails (>= 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.4)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.2)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  localized!
+  rspec (= 2.6.0)
+  rspec-rails (= 2.6.0)
+  ruby-debug19

data/README.md

@@ -0,0 +1,45 @@
+### Localized
+
+A simple gem for Rails 3 that helps set the locale for your application from a
+subdomain. It also contains a way for overriding the "site" in url helpers.
+
+## Setup
+
+1. Add a config/localized.yml file with your supported subdomain/site name and locale mappings.
+
+2. Add your domains to your /etc/hosts file for development:
+
+         127.0.0.1 www.mysite.localhost # default locale
+         127.0.0.1 www.it.mysite.localhost
+         127.0.0.1 www.ca.mysite.localhost
+
+3. Create your "change locale widget" using simple url helpers:
+
+         root_url(:site => :us) # => http://www.mysite.com/
+         root_url(:site => :it) # => http://www.it.mysite.com/
+         root_url(:site => :ca) # => http://www.ca.mysite.com/
+
+  OR to keep the current locale:
+
+    root_url # => http://www.<whatever the current site is>.mysite.com
+
+## Contributing
+
+This is a very simple gem and I am sure you could think of something you could
+add to it, please create a pull request.
+
+## Author
+
+Paul Hepworth (http://peppyheppy.com)
+
+## License
+
+The MIT License (MIT)
+Copyright (c) 2011 Paul Hepworth
+
+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/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => [:spec]
+

data/config/defaults.yml

@@ -0,0 +1,5 @@
+default_host_prefix: 'www.'
+default_site: 'us'
+site_locale_map:
+  us: 'en-US'
+

data/lib/localized.rb

@@ -0,0 +1,14 @@
+require 'rails'
+require 'action_view'
+require 'action_controller'
+require 'active_model'
+module Localized; end
+require 'localized/config'
+require 'localized/helper'
+
+# load the modules into the rails world
+[
+  ActionView::Helpers::UrlHelper, 
+  ActionController::Base
+].each { |mod| mod.send :include, Localized::Helper }
+

data/lib/localized/config.rb

@@ -0,0 +1,54 @@
+require 'yaml'
+
+module Localized::Config
+  def self.configuration
+    @configuration ||= begin
+      config_file = File.expand_path(File.join(Rails.root.to_s,'/config/localized.yml'))
+      defaults = YAML.load_file('config/defaults.yml')
+      custom   = YAML.load_file(config_file) if File.exists?(config_file)
+      symobolize_keys_and_values(defaults.merge(custom || {}))
+    end.symbolize_keys
+  end
+
+  def self.default_host_prefix
+    @default_host_prefix ||= self.configuration[:default_host_prefix].to_s
+  end
+
+  def self.site_to_locale_map
+    @site_to_locale_map ||= self.configuration[:site_locale_map].symbolize_keys
+  end
+
+  def self.locale_to_site_map
+    @locale_to_site_map ||= site_to_locale_map.invert
+  end
+
+  def self.default_site
+    @default_site ||= self.configuration[:default_site]
+  end  
+  
+  def self.supported_sites
+    @supported_sites ||= site_to_locale_map.symbolize_keys.keys.sort
+  end
+
+  def self.supported_locales
+    @supported_locales ||= site_to_locale_map.values.sort
+  end
+
+  def self.default_locale
+    @default_locale ||= site_to_locale_map[default_site]
+  end
+
+  private
+
+  def self.symobolize_keys_and_values(hash_name)
+    new_hash = HashWithIndifferentAccess.new({})
+    hash_name.each do |k,v| 
+      if v.is_a? Hash
+        new_hash[k.to_sym] = symobolize_keys_and_values(v)
+      else
+        new_hash[k.to_sym] = v.to_s.to_sym
+      end
+    end
+    new_hash
+  end
+end

data/lib/localized/helper.rb

@@ -0,0 +1,43 @@
+module Localized::Helper
+  extend ActiveSupport::Concern
+
+  included do
+    if self.respond_to? :before_filter
+      before_filter :set_locale
+    end
+  end
+
+  def set_locale
+    key = request.subdomains.last.to_s.to_sym
+    unless Localized::Config.site_to_locale_map[key]
+      key = Localized::Config.default_site
+    end
+    I18n.locale = Localized::Config.site_to_locale_map[key]
+  end
+
+  def url_for(options = nil)
+    if options.kind_of?(Hash)
+      options[:host] = with_locale(options.delete(:site))
+    end
+    super options
+  end
+
+  protected
+
+  def with_locale(site = nil)
+    current_site =  Localized::Config.locale_to_site_map[I18n.locale]
+    site = if site.blank? and current_site != Localized::Config.default_site
+      current_site
+    else
+      site || Localized::Config.default_site
+    end.to_s.to_sym
+     Localized::Config.site_to_locale_map.fetch(site) {
+      raise ArgumentError,
+        "the site locale alias #{site} does not exist in list: #{Localized::Config.site_to_locale_map.stringify_keys.keys.sort.join(', ')}",
+        caller(5)
+    }
+
+    subdomain = (Localized::Config.default_site != site ? "#{site}." : nil)
+    [Localized::Config.default_host_prefix, subdomain, request.domain, request.port_string].join
+  end
+end

data/localized.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'localized'
+  s.author      = 'Paul Hepworth'
+  s.email       = 'paul<dot>hepworth<at>peppyheppy<dot>com'
+  s.version     = '0.0.1'
+  s.date        = '2011-07-09'
+  s.summary     = "A ruby on rails gem that provides locale setting support through the subdomain (in a box)"
+  s.description = "This gem allows you to set locale using a subdomain and url helper support for switching sites."
+  s.files       = s.files = `git ls-files`.split("\n")
+  s.add_runtime_dependency "rails", ">= 3.0"
+  s.add_development_dependency "ruby-debug19"
+  s.add_development_dependency "rspec", "2.6.0"
+  s.add_development_dependency "rspec-rails", "2.6.0"
+end
+

data/spec/config/localized.yml

@@ -0,0 +1,18 @@
+default_host_prefix: 'www.'
+default_site: 'us'
+site_locale_map:
+  au: 'en-AU'
+  nl: 'nl-NL'
+  uk: 'en-GB'
+  us: 'en-US'
+  fr: 'fr-FR'
+  de: 'de-DE'
+  it: 'it-IT'
+  se: 'sv-SE'
+  es: 'es-ES'
+  jp: 'ja-JP'
+  ca: 'en-CA'
+  es: 'es-ES'
+  jp: 'ja-JP'
+  ca: 'en-CA'
+

data/spec/config/routes.rb

@@ -0,0 +1,2 @@
+LocalizedApp::Application.routes.draw do
+end

data/spec/lib/localized/config_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Localized::Config do
+
+  before :each do
+    Rails.stub(:root).and_return(Pathname.new(File.join(File.dirname(__FILE__),'..', '..')))
+  end
+
+  it "should load defaults" do
+    Localized::Config.configuration.should_not be_nil
+    Localized::Config.configuration.keys.should include :site_locale_map
+  end
+
+  it "should have site to local mappings" do
+    Localized::Config.should respond_to :site_to_locale_map
+    Localized::Config.site_to_locale_map.should be_a Hash
+    Localized::Config.site_to_locale_map.keys.should include(:us)
+  end
+
+  it "should have local to site mappings" do
+    Localized::Config.should respond_to :locale_to_site_map
+    Localized::Config.locale_to_site_map.should be_a Hash
+    Localized::Config.locale_to_site_map.keys.should include(:'en-US')
+  end
+
+  it "should have default site" do
+    Localized::Config.should respond_to :default_site
+    Localized::Config.site_to_locale_map.keys.should include(Localized::Config.default_site)
+  end
+
+  it "should have default host prefix" do
+    Localized::Config.should respond_to :default_host_prefix
+    Localized::Config.default_host_prefix.should == "www."
+  end
+
+  it "should have supported sites" do
+    Localized::Config.should respond_to :supported_sites
+    Localized::Config.supported_sites.should be_a Array
+    Localized::Config.supported_sites.should include(:us) 
+  end
+
+  it "should have supported locales" do
+    Localized::Config.should respond_to :supported_locales
+    Localized::Config.supported_locales.should be_a Array
+    Localized::Config.supported_locales.should include(:'en-US') 
+  end
+
+  it "should have default locale" do
+    Localized::Config.should respond_to :default_locale
+    Localized::Config.default_locale.should == :'en-US'
+  end
+
+end

data/spec/lib/localized/helper_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+class FoobarController < ::ActionController::Base
+  def test
+    render :text => 'success'
+  end
+end
+
+describe FoobarController , "locale specific routes", :type => :controller do
+  before :all do
+    Rails.stub(:root).and_return(Pathname.new(File.join(File.dirname(__FILE__),'..', '..')))
+    Rails.application.routes.draw do
+      get '/test' => 'foobar#test', :as => :test
+      root :to => "foobar#test"
+    end
+  end
+
+  after :all do
+    silence_warnings do
+      Rails.application.reload_routes!
+    end
+  end
+
+  describe "sites and subdomain" do
+    before :each do
+      @request.host = "www.roadrunnerrecords.test"
+    end
+
+    it "should have the regular tests host" do
+      root_url.should == 'http://www.roadrunnerrecords.test/'
+    end
+
+    it "should have the default host prefix and default locale" do
+      root_url(:site => 'us').should == 'http://www.roadrunnerrecords.test/'
+    end
+
+    it "should error if site is not supported" do
+      expect { 
+        root_url(:site => 'cz')
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should allow for locale override" do
+      root_url(:site => 'it').should == 'http://www.it.roadrunnerrecords.test/'
+    end
+
+    it "should set the default site when Locale is set" do
+      original_locale = I18n.locale
+      I18n.locale = Localized::Config.site_to_locale_map[:es]
+      root_url.should == 'http://www.es.roadrunnerrecords.test/'
+      I18n.locale = original_locale
+    end
+
+  end
+
+  describe "subdomain locale" do
+
+    it "should set the current locale to that of the subdomain" do
+      @request.host = "www.us.example.com"
+      get :test
+      I18n.locale.should == :"en-US"
+    end
+
+    it "should set the current locale to that of the subdomain" do
+      @request.host = "www.it.example.com"
+      get :test
+      I18n.locale.should == :"it-IT"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+require "bundler/setup"
+require "ruby-debug"
+require "localized"
+require "action_controller/railtie"
+require 'rspec/rails'
+
+class Application < Rails::Application
+  # abusing locale for site/locale
+  config.i18n.default_locale = :'en-US'
+end
+Application.initialize!
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: localized
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Hepworth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-09 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id004
+description: This gem allows you to set locale using a subdomain and url helper support for switching sites.
+email: paul<dot>hepworth<at>peppyheppy<dot>com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- config/.DS_Store
+- config/defaults.yml
+- lib/localized.rb
+- lib/localized/config.rb
+- lib/localized/helper.rb
+- localized.gemspec
+- spec/config/localized.yml
+- spec/config/routes.rb
+- spec/lib/localized/config_spec.rb
+- spec/lib/localized/helper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+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.6.2
+signing_key: 
+specification_version: 3
+summary: A ruby on rails gem that provides locale setting support through the subdomain (in a box)
+test_files: []
+