From 69552343d11b5602b0120f4053db0039af68680a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9my?= <jeremyvdw@gmail.com>
Date: Tue, 6 Apr 2010 12:00:04 +0200
Subject: [PATCH] Setup project architecture; Added real specs

---
 lib/rack/locale-selector.rb.bak     |  42 ----------
 lib/rack/locale-selector/context.rb | 118 ----------------------------
 lib/rack/locale-selector/options.rb |  75 ------------------
 spec/spec_context.rb                |  23 ------
 spec/spec_locale_selector.rb        |  35 +++++----
 spec/spec_options.rb                |  79 -------------------
 spec/spec_setup.rb                  | 111 --------------------------
 7 files changed, 19 insertions(+), 464 deletions(-)
 delete mode 100644 lib/rack/locale-selector.rb.bak
 delete mode 100644 lib/rack/locale-selector/context.rb
 delete mode 100644 lib/rack/locale-selector/options.rb
 delete mode 100644 spec/spec_context.rb
 delete mode 100644 spec/spec_options.rb
 delete mode 100644 spec/spec_setup.rb

diff --git a/lib/rack/locale-selector.rb.bak b/lib/rack/locale-selector.rb.bak
deleted file mode 100644
index fd0c490..0000000
--- a/lib/rack/locale-selector.rb.bak
+++ /dev/null
@@ -1,42 +0,0 @@
-require 'rack'
-
-# = HTTP Locale selection For Rack
-#
-# Rack::Cache is suitable as a quick, drop-in component to enable HTTP caching
-# for Rack-enabled applications that produce freshness (+Expires+, +Cache-Control+)
-# and/or validation (+Last-Modified+, +ETag+) information.
-#
-# * Standards-based (RFC 2616 compliance)
-# * Freshness/expiration based caching and validation
-# * Supports HTTP Vary
-# * Portable: 100% Ruby / works with any Rack-enabled framework
-# * Disk, memcached, and heap memory storage backends
-#
-# === Usage
-#
-# Create with default options:
-#   require 'rack/cache'
-#   Rack::LocaleSelector.new(app, :verbose => true, :blacklist => %w('tunnel', 'assets'))
-#
-# Within a rackup file (or with Rack::Builder):
-#   require 'rack/cache'
-#   use Rack::LocaleSelector do
-#     set :verbose, true
-#     set :whitelist => I18n.available_locales,
-#     set :blacklist => ['tunnel', 'assets']
-#   end
-#   run app
-module Rack::LocaleSelector
-  autoload :Options, 'rack/locale-selector/options'
-  autoload :Context, 'rack/locale-selector/context'
-  
-  # Create a new Rack::LocaleSelector middleware component that fetches resources from
-  # the specified backend application. The +options+ Hash can be used to
-  # specify default configuration values (see attributes defined in
-  # Rack::LocaleSelector::Options for possible key/values). When a block is given, it
-  # is executed within the context of the newly create Rack::LocaleSelector::Context
-  # object.
-  def self.new(backend, options={}, &b)
-    Context.new(backend, options, &b)
-  end
-end
diff --git a/lib/rack/locale-selector/context.rb b/lib/rack/locale-selector/context.rb
deleted file mode 100644
index 5575486..0000000
--- a/lib/rack/locale-selector/context.rb
+++ /dev/null
@@ -1,118 +0,0 @@
-require 'rack/locale-selector/options'
-
-module Rack::LocaleSelector
-  # Implements Rack's middleware interface and provides the context for all
-  # locale selection logic.
-  class Context
-    include Rack::LocaleSelector::Options
-
-    def initialize(app, options={})
-      @app = app
-      @request =  Rack::Response.new(@env)
-      
-      initialize_options options
-      yield self if block_given?
-    end
-
-    def call(env)
-      if deflect?
-        dispatch
-      else
-        @app.call(@env)
-      end
-    end
-
-    def deflect?
-      @subdomain = parse_host
-      return !@option[:blacklist].include?(@subdomain) unless @option[:blacklist].empty?
-      return !@option[:whitelist].include?(@subdomain) unless @option[:whitelist].empty?
-    end
-
-    def parse_host
-      @request.host_with_port.split('.').first
-      env["HTTP_HOST"].match(/^[a-z]{2}(?=\.)/)
-    end
-
-    def get_browser_language
-      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
-      if lang = @env["HTTP_ACCEPT_LANGUAGE"]
-        lang = lang.split(",").map { |l|
-          l += ';q=1.0' unless l =~ /;q=\d+\.\d+$/
-          l.split(';q=')
-        }.first
-        locale = options['rack-locale-selector.locale'] = lang.first.split("-").first
-      else
-        locale = options['rack-locale-selector.locale'] = I18n.default_locale
-      end
-      locale
-    end
-
-    def custom_domain?(host)
-      domain = @default_domain.sub(/^\./, '')
-      host !~ Regexp.new("#{domain}$", Regexp::IGNORECASE)
-    end
-
-    # def dispatch
-    #   host = env.has_key?("HTTP_HOST") ? env["HTTP_HOST"].split(':').first : @default_domain
-    #   @env["rack.session.options"][:domain] = custom_domain?(host) ? ".#{host}" : "#{@default_domain}" unless Rails.env == 'test'
-    # 
-    #   status, headers, body = builder.call(@env)
-    #   @response = Rack::Response.new(body, status, headers)
-    # 
-    #   if @response.redirect? && options["rack-bug.intercept_redirects"]
-    #     intercept_redirect
-    #   elsif modify?
-    #     inject_toolbar
-    #   end
-    # 
-    #   return @response.to_a
-    # end
-
-    def dispatch
-      # Coming from http://www.smartdate.com or http://whatever.smartdate.com
-      if @subdomain == "www" or !locale_exist?(domain_locale)
-        # Find the best locale
-        I18n.locale = locale = env['rack.locale'] = if locale_exist?(cookies["language"])
-          cookies["language"]
-        elsif locale_exist?(get_language_from_browser(env).to_s.downcase)
-          get_language_from_browser(env).to_s.downcase
-        else
-          I18n.default_locale
-        end
-        # puts "middleware: locale set to '#{locale}'\n" unless Rails.env == 'production'
-
-        # If locale is english: continue
-        # If the referer pointing to us we should change the language to english
-        default_locale_str = I18n.default_locale.to_s
-        if (locale == default_locale_str) or (locale != default_locale_str and env.has_key?("HTTP_REFERER") and env["HTTP_REFERER"].include?(env["HTTP_HOST"].sub(/www\./, '')))
-          I18n.locale = locale = env['rack.locale'] = default_locale_str
-          status, headers, body = @app.call(env)
-          response = Rack::Response.new(body, status, headers)
-          response.set_cookie("language", {:value => locale, :path => '/', :domain => env["rack.session.options"][:domain]}) unless cookies["language"] == default_locale_str
-          # Fixes issue http://github.com/chneukirchen/rack/issues/#issue/3/comment/150615
-          response.headers["Set-Cookie"].delete_if {|x| x.empty?} if response.headers["Set-Cookie"].is_a? Array
-          return response.finish
-        end
-
-        # We redirect to the proper subdomain
-        response = Rack::Response.new("Redirecting you to the #{locale} website.", 302, {"Location" => localized_url(env)})
-        response.set_cookie("language", {:value => locale, :path => '/', :domain => env["rack.session.options"][:domain]})
-        return response.finish
-      end
-
-      # Coming from http://<domain_locale>.smartdate.com
-      I18n.locale = locale = env['rack.locale'] = @subdomain
-      status, headers, body = @app.call(env)
-      response = Rack::Response.new(body, status, headers)
-      response.set_cookie("language", {:value => @subdomain, :path => '/', :domain => env["rack.session.options"][:domain]}) if domain_locale != cookies["language"]
-      return response.finish
-    end
-
-    def log(message)
-      return unless options[:log]
-      options[:log].puts(options[:log_format] % [Time.now.strftime(options[:log_date_format]), message])
-    end
-
-  end
-
-end
\ No newline at end of file
diff --git a/lib/rack/locale-selector/options.rb b/lib/rack/locale-selector/options.rb
deleted file mode 100644
index 642c768..0000000
--- a/lib/rack/locale-selector/options.rb
+++ /dev/null
@@ -1,75 +0,0 @@
-module Rack::LocaleSelector
-  # Configuration options and utility methods for option access. Rack::LocaleSelector
-  # uses the Rack Environment to store option values. All options documented
-  # below are stored in the Rack Environment as "rack-locale-selector.<option>", where
-  # <option> is the option name.
-  module Options
-    class << self
-      private
-      def option_accessor(key)
-        define_method(key) { || read_option(key) }
-        define_method("#{key}=") { |value| write_option(key, value) }
-        define_method("#{key}?") { || !! read_option(key) }
-      end
-    end
-
-    # Enable verbose trace logging. This option is currently enabled by
-    # default but is likely to be disabled in a future release.
-    option_accessor :verbose
-
-    # The underlying options Hash. During initialization (or outside of a
-    # request), this is a default values Hash. During a request, this is the
-    # Rack environment Hash. The default values Hash is merged in underneath
-    # the Rack environment before each request is processed.
-    def options
-      @env || @default_options
-    end
-
-    # Set multiple options.
-    def options=(hash={})
-      hash.each { |key,value| write_option(key, value) }
-    end
-
-    # Set an option. When +option+ is a Symbol, it is set in the Rack
-    # Environment as "rack-locale-selector.option". When +option+ is a String, it
-    # exactly as specified. The +option+ argument may also be a Hash in
-    # which case each key/value pair is merged into the environment as if
-    # the #set method were called on each.
-    def set(option, value=self, &block)
-      if block_given?
-        write_option option, block
-      elsif value == self
-        self.options = option.to_hash
-      else
-        write_option option, value
-      end
-    end
-
-  private
-
-    def read_option(key)
-      options[option_name(key)]
-    end
-
-    def write_option(key, value)
-      options[option_name(key)] = value
-    end
-
-    def option_name(key)
-      case key
-      when Symbol ; "rack-locale-selector.#{key}"
-      when String ; key
-      else raise ArgumentError
-      end
-    end
-
-    def initialize_options(options={})
-      @default_options = {
-        'rack-locale-selector.locale' => nil,
-        'rack-locale-selector.verbose' => nil
-      }
-      self.options = options
-    end
-
-  end
-end
diff --git a/spec/spec_context.rb b/spec/spec_context.rb
deleted file mode 100644
index 8269502..0000000
--- a/spec/spec_context.rb
+++ /dev/null
@@ -1,23 +0,0 @@
-# require "#{File.dirname(__FILE__)}/spec_setup"
-# require 'rack/locale-selector/context'
-# 
-# module Rack::LocaleSelector
-#   describe Context do
-#     before(:each) { setup_locale_selector_context }
-#     after(:each)  { teardown_locale_selector_context }
-#   
-#     context "Accessing a black listed resource should not select locale" do
-#       it "should return the target app" do
-#         get "/"
-#         last_response.body.should contain("Target app")
-#       end
-#     end
-# 
-#     context "Accessing a white listed resource" do
-#       it "should return the target app" do
-#         get "/"
-#         last_response.body.should contain("Target app")
-#       end
-#     end
-#   end
-# end
\ No newline at end of file
diff --git a/spec/spec_locale_selector.rb b/spec/spec_locale_selector.rb
index 5e4b4bf..cdf88d0 100644
--- a/spec/spec_locale_selector.rb
+++ b/spec/spec_locale_selector.rb
@@ -3,7 +3,10 @@
 require 'rack/locale_selector'
 
 def mock_env(http_host, path = '/', cookie = '', http_accept_language = 'fr,en-EN;q=0.8')
-  Rack::MockRequest.env_for(path, { 'HTTP_HOST' => http_host, 'HTTP_ACCEPT_LANGUAGE' => http_accept_language, 'HTTP_COOKIE' => cookie })
+  opts = {'HTTP_HOST' => http_host}
+  opts.merge!({'HTTP_COOKIE' => cookie}) if cookie
+  opts.merge!({'HTTP_ACCEPT_LANGUAGE' => http_accept_language}) if http_accept_language
+  Rack::MockRequest.env_for(path, opts)
 end
 
 def middleware(options = {})
@@ -18,21 +21,21 @@ def middleware(options = {})
   
   context "Root domain host without cookie does redirect" do
     before do
-      app = middleware
+      @app = middleware
     end
     
     it "should follow HTTP_ACCEPT_LANGUAGE headers" do
-      status, headers, body = app.call(mock_env("example.com"))
+      status, headers, body = @app.call(mock_env("example.com"))
       status.should.equal 403
-      locale.should.equal 'fr'
+      I18n.locale.should.equal 'fr'
       headers["Set-Cookie"].should.equal "language=fr"
       headers["Location"].should.equal "fr.example.com"
     end
     
     it "should follow default locale if no HTTP_ACCEPT_LANGUAGE headers" do
-      status, headers, body = app.call(mock_env("example.com"))
+      status, headers, body = @app.call(mock_env('example.com', '/', '', false))
       status.should.equal 403
-      locale.should.equal 'en'
+      I18n.locale.should.equal 'en'
       headers["Set-Cookie"].should.equal "language=en"
       headers["Location"].should.equal "en.example.com"
     end
@@ -41,18 +44,18 @@ def middleware(options = {})
   context "Root domain host with cookie" do
     specify "redirect should follow cookie's value" do
       app = middleware
-      status, headers, body = app.call(mock_env("example.com", '/', 'language=fr'))
+      status, headers, body = @app.call(mock_env("example.com", '/', 'language=fr'))
       status.should.equal 403
-      locale.should.equal 'fr'
+      I18n.locale.should.equal 'fr'
       headers["Set-Cookie"].should.equal "language=fr"
       headers["Location"].should.equal "fr.example.com"
     end
     
     specify "should be redirected to spanish website" do
       app = middleware
-      status, headers, body = app.call(mock_env("example.com", '/', 'language=es'))
+      status, headers, body = @app.call(mock_env("example.com", '/', 'language=es'))
       status.should.equal 403
-      locale.should.equal 'es'
+      I18n.locale.should.equal 'es'
       headers["Set-Cookie"].should.equal ""
       headers["Location"].should.equal "es.example.com"
     end
@@ -61,9 +64,9 @@ def middleware(options = {})
   context "Home page with cookie" do
     specify "should be redirected to french website with french locale (when cookie)" do
       app = middleware
-      status, headers, body = app.call(mock_env('www.example.com', '/', 'language=fr'))
+      status, headers, body = @app.call(mock_env('www.example.com', '/', 'language=fr'))
       status.should.equal 403
-      locale.should.equal 'fr'
+      I18n.locale.should.equal 'fr'
       headers["Set-Cookie"].should.equal ""
       headers["Location"].should.equal "fr.example.com"
     end
@@ -72,9 +75,9 @@ def middleware(options = {})
   context "Locale page without cookie" do
     specify "should display the french website with french locale and set a cookie" do
       app = middleware
-      status, headers, body = app.call(mock_env('fr.example.com'))
+      status, headers, body = @app.call(mock_env('fr.example.com'))
       status.should.equal 200
-      locale.should.equal 'fr'
+      I18n.locale.should.equal 'fr'
       headers["Set-Cookie"].should.equal "language=fr"
     end
   end
@@ -82,9 +85,9 @@ def middleware(options = {})
   context "Locale page with cookie" do
     specify "should display the french website with french locale" do
       app = middleware
-      status, headers, body = app.call(mock_env('fr.example.com', '/', 'language=fr'))
+      status, headers, body = @app.call(mock_env('fr.example.com', '/', 'language=fr'))
       status.should.equal 200
-      locale.should.equal 'fr'
+      I18n.locale.should.equal 'fr'
       headers["Set-Cookie"].should.equal ''
     end
   end
diff --git a/spec/spec_options.rb b/spec/spec_options.rb
deleted file mode 100644
index 52f1362..0000000
--- a/spec/spec_options.rb
+++ /dev/null
@@ -1,79 +0,0 @@
-# require "#{File.dirname(__FILE__)}/spec_setup"
-# require 'rack/locale-selector/options'
-# 
-# module Rack::LocaleSelector::Options
-#   option_accessor :foo
-# end
-# 
-# class MockOptions
-#   include Rack::LocaleSelector::Options
-#   def initialize
-#     @env = nil
-#     initialize_options
-#   end
-# end
-# 
-# module Rack::LocaleSelector
-#   describe Options do
-#     before { @options = MockOptions.new }
-# 
-#     describe '#set' do
-#       it 'sets a Symbol option as rack-locale_selector.symbol' do
-#         @options.set :bar, 'baz'
-#         @options.options['rack-locale_selector.bar'].should.equal 'baz'
-#       end
-#       it 'sets a String option as string' do
-#         @options.set 'foo.bar', 'bling'
-#         @options.options['foo.bar'].should.equal 'bling'
-#       end
-#       it 'sets all key/value pairs when given a Hash' do
-#         @options.set :foo => 'bar', :bar => 'baz', 'foo.bar' => 'bling'
-#         @options.foo.should.equal 'bar'
-#         @options.options['rack-locale_selector.bar'].should.equal 'baz'
-#         @options.options['foo.bar'].should.equal 'bling'
-#       end
-#     end
-# 
-#     it 'makes options declared with option_accessor available as attributes' do
-#       @options.set :foo, 'bar'
-#       @options.foo.should.equal 'bar'
-#     end
-# 
-#     it 'allows setting multiple options via assignment' do
-#       @options.options = { :foo => 'bar', :bar => 'baz', 'foo.bar' => 'bling' }
-#       @options.foo.should.equal 'bar'
-#       @options.options['foo.bar'].should.equal 'bling'
-#       @options.options['rack-locale_selector.bar'].should.equal 'baz'
-#     end
-# 
-#     it "allows storing the value as a block" do
-#       block = Proc.new { "bar block" }
-#       @options.set(:foo, &block)
-#       @options.options['rack-locale_selector.foo'].should.equal block
-#     end
-# 
-#     it 'allows the locale_selector key generator to be configured' do
-#       @options.should.respond_to :locale_selector_key
-#       @options.should.respond_to :locale_selector_key=
-#     end
-# 
-#     it 'allows the meta store to be configured' do
-#       @options.should.respond_to :metastore
-#       @options.should.respond_to :metastore=
-#       @options.metastore.should.not.be nil
-#     end
-# 
-#     it 'allows the entity store to be configured' do
-#       @options.should.respond_to :entitystore
-#       @options.should.respond_to :entitystore=
-#       @options.entitystore.should.not.be nil
-#     end
-# 
-#     it 'allows log verbosity to be configured' do
-#       @options.should.respond_to :verbose
-#       @options.should.respond_to :verbose=
-#       @options.should.respond_to :verbose?
-#       @options.verbose.should.not.be.nil
-#     end
-#   end
-# end
\ No newline at end of file
diff --git a/spec/spec_setup.rb b/spec/spec_setup.rb
deleted file mode 100644
index 49a1b57..0000000
--- a/spec/spec_setup.rb
+++ /dev/null
@@ -1,111 +0,0 @@
-# require 'rubygems'
-# require 'test/unit'
-# require 'spec'
-# require 'rack/test'
-# require 'webrat'
-# 
-# $LOAD_PATH.unshift File.dirname(File.dirname(__FILE__)) + '/lib'
-# 
-# require 'rack/locale-selector'
-# 
-# Spec::Runner.configure do |config|
-#   config.include Rack::Test::Methods
-#   config.include Webrat::Matchers
-# end
-# 
-# # Methods for constructing downstream applications / response
-# # generators.
-# module LocaleSelectorContextHelpers
-# 
-#   # The Rack::LocaleSelector::Context instance used for the most recent
-#   # request.
-#   attr_reader :locale_selector
-# 
-#   # An Array of Rack::LocaleSelector::Context instances used for each request, in
-#   # request order.
-#   attr_reader :locale_selectors
-# 
-#   # The Rack::Response instance result of the most recent request.
-#   attr_reader :response
-# 
-#   # An Array of Rack::Response instances for each request, in request order.
-#   attr_reader :responses
-# 
-#   # The backend application object.
-#   attr_reader :app
-# 
-#   def setup_locale_selector_context
-#     # holds each Rack::LocaleSelector::Context
-#     @app = nil
-# 
-#     @locale_selector = nil
-#     @locale_selectors = []
-#     @errors = StringIO.new
-#     @locale_selector_config = nil
-# 
-#     @called = false
-#     @request = nil
-#     @response = nil
-#     @responses = []
-#   end
-# 
-#   def teardown_locale_selector_context
-#     @app, @locale_selector, @locale_selectors, @called,
-#     @request, @response, @responses, @locale_selector_config = nil
-#   end
-# 
-#   # A basic response with 200 status code and a tiny body.
-#   def respond_with(status=200, headers={}, body=['Hello World'])
-#     called = false
-#     @app =
-#       lambda do |env|
-#         called = true
-#         response = Rack::Response.new(body, status, headers)
-#         request = Rack::Request.new(env)
-#         yield request, response if block_given?
-#         response.finish
-#       end
-#     @app.meta_def(:called?) { called }
-#     @app.meta_def(:reset!) { called = false }
-#     @app
-#   end
-# 
-#   def locale_selector_config(&block)
-#     @locale_selector_config = block
-#   end
-# 
-#   def request(method, uri='/', opts={})
-#     opts = {
-#       'rack.run_once' => true,
-#       'rack.errors' => @errors,
-#     }.merge(opts)
-# 
-#     fail 'response not specified (use respond_with)' if @app.nil?
-#     @app.reset! if @app.respond_to?(:reset!)
-# 
-#     @locale_selector_prototype ||= Rack::LocaleSelector::Context.new(@app, &@locale_selector_config)
-#     @locale_selector = @locale_selector_prototype.clone
-#     @locale_selectors << @locale_selector
-#     @request = Rack::MockRequest.new(@locale_selector)
-#     yield @locale_selector if block_given?
-#     @response = @request.request(method.to_s.upcase, uri, opts)
-#     @responses << @response
-#     @response
-#   end
-# 
-#   def get(stem, env={}, &b)
-#     request(:get, stem, env, &b)
-#   end
-# 
-#   def head(stem, env={}, &b)
-#     request(:head, stem, env, &b)
-#   end
-# 
-#   def post(*args, &b)
-#     request(:post, *args, &b)
-#   end
-# end
-# 
-# class Test::Unit::TestCase
-#   include LocaleSelectorContextHelpers
-# end