remi-rackbox 0.0.6 → 0.7.0

data/README.markdown

@@ -8,8 +8,6 @@ This currently only works with [RSpec][].
 Installation
 ------------
 
-    **NOTE** I haven't built the gem yet!  This will work in a little while, once I build the gem ...
-
     $ sudo gem install remi-rackbox -s http://gems.github.com
 
 Rails

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 7

data/lib/rackbox.rb

@@ -1,105 +1,22 @@
+# TODO split up into different files!  sheesh!
+
 $:.unshift File.dirname(__FILE__)
 require 'rubygems'
 begin
   require 'thin' # required for Rails pre Rails 2.3, as Thin has the Rack::Adapter::Rails
 rescue LoadError
 end
-require 'rack'
-require 'rackbox/rack_content_length_fix'
-
-# To add blackbox testing to a Rails app,
-# in your spec_helper.rb
-#
-#   require 'rackbox'
-#
-#   Spec::Runner.configure do |config|
-#     config.use_blackbox = true
-#   end
-#
-class RackBox
-  class << self
-    # the Rack appliction to do 'Black Box' testing against
-    #
-    # To set, in your spec_helper.rb or someplace:
-    #   RackBox.app = Rack::Adapter::Rails.new :root => '/root/directory/of/rails/app', :environment => 'test'
-    #
-    # If not explicitly set, uses RAILS_ROOT (if defined?) and RAILS_ENV (if defined?)
-    attr_accessor :app
-
-    def app
-      unless @app and @app.respond_to?:call
-        if File.file? 'config.ru'
-          @app = Rack::Builder.new { eval(File.read('config.ru')) }
-        elsif defined?RAILS_ENV and defined?RAILS_ROOT
-          raise "You need the Rack::Adapter::Rails to run Rails apps with RackBox." + 
-                " Try: sudo gem install thin" unless defined?Rack::Adapter::Rails
-          @app = Rack::Adapter::Rails.new :root => RAILS_ROOT, :environment => RAILS_ENV
-        else
-          raise "RackBox.app not configured."
-        end
-      end
-      @app
-    end
-  end
-end
 
-module RackBox::SpecHelpers
-  # A port of Merb's request() method, used in tests
-  #
-  # At the moment, we're using #req instead because #request conflicts 
-  # with an existing RSpec-Rails method
-  #
-  # Usage:
-  #   
-  #   req '/'
-  #   req login_path
-  #   req url_for(:controller => 'login')
-  #
-  #   req '/', :method => :post, :params => { 'chunky' => 'bacon' }
-  #
-  # TODO support inner hashes, so { :foo => { :chunky => :bacon } } becomes 'foo[chunky]=bacon'
-  #
-  # TODO take any additional options and pass them along to the environment, so we can say 
-  #      req '/', :user_agent => 'some custom user agent'
-  #
-  def req url, options = {}
-    options[:method] ||= :get
-    options[:params] ||= { }
-    Rack::MockRequest.new(RackBox.app).send options[:method], url, :input => Rack::Utils.build_query(options[:params])
-  end
+require 'rack'
 
-  alias request req unless defined? request
-end
+require 'rackbox/rack/content_length_fix'
+require 'rackbox/rack/sticky_sessions'
+require 'rackbox/rack/extensions_for_rspec'
 
-spec_configuration_class = nil
-spec_configuration_class = Spec::Example::Configuration if defined? Spec::Example::Configuration
-spec_configuration_class = Spec::Runner::Configuration if defined? Spec::Runner::Configuration
+require 'rackbox/rackbox'
 
-if spec_configuration_class
-  spec_configuration_class.class_eval do
-    # Adds blackbox testing to your Rails application using RackBox.
-    #
-    # To use, put your 'blackbox' specs into the spec/blackbox
-    # directory, eg. spec/blackbox/login_spec.rb
-    #
-    # In these specs, the RackBox::SpecHelpers#req method will be available to you
-    #
-    def use_blackbox= bool
-      if bool == true
-        before(:all, :type => :blackbox) do
-          self.class.instance_eval {
-            # include our own helpers, eg. RackBox::SpecHelpers#req
-            include RackBox::SpecHelpers
+require 'rspec/custom_matcher'
+require 'rackbox/matchers'
 
-            # include generated url methods, eg. login_path.
-            # default_url_options needs to have a host set for the Urls to work
-            if defined?ActionController::UrlWriter
-              include ActionController::UrlWriter
-              default_url_options[:host] = 'example.com'
-            end
-          }
-        end
-      end
-    end
-  end
-end
+require 'rackbox/spec/helpers'
+require 'rackbox/spec/configuration'

data/lib/rackbox/matchers.rb

@@ -0,0 +1,17 @@
+# Custom RSpec matchers
+module RackBox::Matchers
+  def self.included base
+    
+    # this should really just be matcher(:foo){ ... }
+    # but there's a bit of other meta logic to deal with here
+    Object.send :remove_const, :RedirectTo if defined? RedirectTo
+    undef redirect_to if defined? redirect_to
+
+    # the actual matcher logic
+    matcher(:redirect_to, base) do |response, url|
+      return false unless response['Location']
+      response['Location'] == url
+    end
+
+  end
+end

data/lib/rackbox/rack/extensions_for_rspec.rb

@@ -0,0 +1,31 @@
+# some more Rack extensions to help when testing
+class Rack::MockResponse
+
+  # these methods help with RSpec specs so we can ask things like:
+  #
+  #   request('/').should be_successful
+  #   request('/').should be_redirect
+  #   request('/').should be_error
+  #
+
+  def success?
+    self.status.to_s.start_with?'2' # 200 status codes are successful
+  end
+
+  def redirect?
+    self.status.to_s.start_with?'3' # 300 status codes are redirects
+  end
+
+  def client_error?
+    self.status.to_s.start_with?'4' # 400 status codes are client errors
+  end
+
+  def server_error?
+    self.status.to_s.start_with?'5' # 500 status codes are server errors
+  end
+
+  def error?
+    self.status.to_s.start_with?('4') || self.status.to_s.start_with?('5') # 400 & 500 status codes are errors
+  end
+
+end

data/lib/rackbox/rack/sticky_sessions.rb

@@ -0,0 +1,54 @@
+#
+# little extension to Rack::MockRequest to track cookies
+#
+class Rack::MockRequest
+  # cookies is a hash of persistent cookies (by domain)
+  # that let you test cookies for your app
+  #
+  # cookies = {
+  #    'example.org' => {
+  #       'cookie-name' => 'cookie-value',
+  #       'chunky' => 'bacon'
+  #    }
+  # }
+  attr_accessor :cookies
+
+  # shortcut to get cookies for a particular domain
+  def cookies_for domain
+    @cookies ||= {}
+    @cookies[ domain ]
+  end
+
+  # oh geez ... it looks like i basically copy/pasted this.  there's gotta be a way to do this that's 
+  #             more resilient to Rack changes to this method.  i don't like overriding the whole method!
+  #
+  def request method = "GET", uri = "", opts = { }
+
+    env = self.class.env_for(uri, opts.merge(:method => method))
+    
+    unless @cookies.nil? or @cookies.empty? or @cookies[env['SERVER_NAME']].nil? or @cookies[env['SERVER_NAME']].empty?
+      env['HTTP_COOKIE'] = @cookies[env['SERVER_NAME']].map{ |k,v| "#{ k }=#{ v }" }.join('; ')
+    end
+
+    if opts[:lint]
+      app = Rack::Lint.new(@app)
+    else
+      app = @app
+    end 
+
+    errors = env["rack.errors"]
+    response = Rack::MockResponse.new(*(app.call(env) + [errors]))
+    
+    if response.original_headers['Set-Cookie']
+      @cookies ||= {}
+      @cookies[ env['SERVER_NAME'] ] ||= {}
+      response.original_headers['Set-Cookie'].map{ |str| /(.*); path/.match(str)[1] }.each do |cookie|
+        name, value = cookie.split('=').first, cookie.split('=')[1]
+        @cookies[ env['SERVER_NAME'] ][ name ] = value
+      end
+    end
+
+    response
+  end
+
+end

data/lib/rackbox/rackbox.rb

@@ -0,0 +1,35 @@
+# To add blackbox testing to a Rails app,
+# in your spec_helper.rb
+#
+#   require 'rackbox'
+#
+#   Spec::Runner.configure do |config|
+#     config.use_blackbox = true
+#   end
+#
+class RackBox
+  class << self
+    # the Rack appliction to do 'Black Box' testing against
+    #
+    # To set, in your spec_helper.rb or someplace:
+    #   RackBox.app = Rack::Adapter::Rails.new :root => '/root/directory/of/rails/app', :environment => 'test'
+    #
+    # If not explicitly set, uses RAILS_ROOT (if defined?) and RAILS_ENV (if defined?)
+    attr_accessor :app
+
+    def app
+      unless @app and @app.respond_to?:call
+        if File.file? 'config.ru'
+          @app = Rack::Builder.new { eval(File.read('config.ru')) }
+        elsif defined?RAILS_ENV and defined?RAILS_ROOT
+          raise "You need the Rack::Adapter::Rails to run Rails apps with RackBox." + 
+                " Try: sudo gem install thin" unless defined?Rack::Adapter::Rails
+          @app = Rack::Adapter::Rails.new :root => RAILS_ROOT, :environment => RAILS_ENV
+        else
+          raise "RackBox.app not configured."
+        end
+      end
+      @app
+    end
+  end
+end

data/lib/rackbox/spec/configuration.rb

@@ -0,0 +1,63 @@
+# Extend the RSpec configuration class with a use_blackbox option
+#
+# To add blackbox testing to a Rails app,
+# in your spec_helper.rb
+#
+#   require 'rackbox'
+#
+#   Spec::Runner.configure do |config|
+#     config.use_blackbox = true
+#   end
+#
+
+spec_configuration_class = nil
+spec_configuration_class = Spec::Example::Configuration if defined? Spec::Example::Configuration
+spec_configuration_class = Spec::Runner::Configuration if defined? Spec::Runner::Configuration
+
+if spec_configuration_class
+  spec_configuration_class.class_eval do
+    # Adds blackbox testing to your Rails application using RackBox.
+    #
+    # To use, put your 'blackbox' specs into the spec/blackbox
+    # directory, eg. spec/blackbox/login_spec.rb
+    #
+    # In these specs, the RackBox::SpecHelpers#req method will be available to you
+    #
+    def use_blackbox= bool
+      if bool == true
+        
+        before(:all, :type => :blackbox) do
+          self.class.instance_eval {
+            # include our own helpers, eg. RackBox::SpecHelpers#req
+            include RackBox::SpecHelpers
+            include RackBox::Matchers
+
+            # include generated url methods, eg. login_path.
+            # default_url_options needs to have a host set for the Urls to work
+            if defined?ActionController::UrlWriter
+              include ActionController::UrlWriter
+              default_url_options[:host] = 'example.com'
+            end
+
+            attr_accessor :rackbox_request
+          }
+        end
+
+        before(:each, :type => :blackbox) do
+
+          # i'm sure there's a better way to write this!
+          #
+          # i believe metaid would write this as:
+          #   metaclass.class_eval do ... end
+          #
+          (class << self; self; end).class_eval do 
+            include RackBox::Matchers
+          end
+
+          @rackbox_request = Rack::MockRequest.new RackBox.app
+        end
+
+      end
+    end
+  end
+end

data/lib/rackbox/spec/helpers.rb

@@ -0,0 +1,34 @@
+# Helper methods to include in specs that want to use blackbox testing
+#
+# This module has the RackBox::SpecHelpers#request method, which is 
+# the main method used by RackBox blackbox tests
+#
+module RackBox::SpecHelpers
+
+  # A port of Merb's request() method, used in tests
+  #
+  # At the moment, we're using #req instead because #request conflicts 
+  # with an existing RSpec-Rails method
+  #
+  # Usage:
+  #   
+  #   req '/'
+  #   req login_path
+  #   req url_for(:controller => 'login')
+  #
+  #   req '/', :method => :post, :params => { 'chunky' => 'bacon' }
+  #
+  # TODO support inner hashes, so { :foo => { :chunky => :bacon } } becomes 'foo[chunky]=bacon'
+  #
+  # TODO take any additional options and pass them along to the environment, so we can say 
+  #      req '/', :user_agent => 'some custom user agent'
+  #
+  def req url, options = {}
+    options[:method] ||= (options[:params]) ? :post : :get # if params, default to POST, else default to GET
+    options[:params] ||= { }
+    @rackbox_request.send options[:method], url, :input => Rack::Utils.build_query(options[:params])
+  end
+
+  alias request req unless defined? request
+
+end

data/lib/rspec/custom_matcher.rb

@@ -0,0 +1,52 @@
+# created by: http://github.com/xdotcommer
+# from: http://github.com/xdotcommer/rspec-custom-matchers/blob/0ecfccd659d5038cdfc88fdc1fee08373e1ee75c/custom_matcher.rb
+class CustomMatcher
+  def self.create(class_name, &block)
+    klass = Class.new(CustomMatcher)
+    klass.send(:define_method, :matcher, &block) if block_given?
+    Object.const_set(build_class_name(class_name), klass)
+  end
+  
+  def initialize(expected = nil)
+    @expected = expected
+  end
+  
+  def failure_message
+    message
+  end
+
+  def negative_failure_message
+    message(false)
+  end
+  
+  def matcher(target, expected)
+    target == expected
+  end
+  
+  def matches?(target)
+    @target = target
+    if self.method(:matcher).arity == 2
+      matcher(@target, @expected)
+    else
+      matcher(@target)
+    end
+  end
+  
+private
+  def message(positive = true)
+    "#{positive ? 'Expected' : 'Did not expect'} #{@target.inspect} to #{class_display_name} #{@expected.inspect if self.method(:matcher).arity == 2}"
+  end
+  
+  def class_display_name
+    self.class.to_s.gsub(/[A-Z]/) {|m| ' ' + m.downcase }.lstrip
+  end
+  
+  def self.build_class_name(class_name)
+    class_name.to_s.split('_').map {|s| s.capitalize}.join
+  end
+end
+
+def matcher(name, context = self.class, &block)
+  klass = CustomMatcher.create(name, &block)
+  context.send(:define_method, name) { |*args| klass.new(*args) }
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: remi-rackbox
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.7.0
 platform: ruby
 authors: 
-- remi Taylor
+- remi
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-01-21 00:00:00 -08:00
+date: 2009-01-27 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -22,95 +22,27 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- examples/rack/config.ru
-- examples/rack/run-specs
-- examples/rack/spec/spec.opts
-- examples/rack/spec/spec_helper.rb
-- examples/rack/spec/blackbox/home_page_spec.rb
-- examples/rack/spec/rcov.opts
-- examples/rails/app/controllers/application.rb
-- examples/rails/app/controllers/welcome_controller.rb
-- examples/rails/app/helpers/application_helper.rb
-- examples/rails/app/helpers/welcome_helper.rb
-- examples/rails/lib/tasks/rspec.rake
-- examples/rails/db/test.sqlite3
-- examples/rails/db/development.sqlite3
-- examples/rails/db/schema.rb
-- examples/rails/log/test.log
-- examples/rails/log/development.log
-- examples/rails/log/production.log
-- examples/rails/log/server.log
-- examples/rails/run-specs
-- examples/rails/spec/spec.opts
-- examples/rails/spec/spec_helper.rb
-- examples/rails/spec/blackbox/home_page_spec.rb
-- examples/rails/spec/rcov.opts
-- examples/rails/doc/README_FOR_APP
-- examples/rails/public/dispatch.cgi
-- examples/rails/public/dispatch.rb
-- examples/rails/public/422.html
-- examples/rails/public/images/rails.png
-- examples/rails/public/404.html
-- examples/rails/public/500.html
-- examples/rails/public/robots.txt
-- examples/rails/public/favicon.ico
-- examples/rails/public/javascripts/prototype.js
-- examples/rails/public/javascripts/application.js
-- examples/rails/public/javascripts/dragdrop.js
-- examples/rails/public/javascripts/controls.js
-- examples/rails/public/javascripts/effects.js
-- examples/rails/public/dispatch.fcgi
-- examples/rails/test/test_helper.rb
-- examples/rails/test/functional/welcome_controller_test.rb
-- examples/rails/test/performance/browsing_test.rb
-- examples/rails/Rakefile
-- examples/rails/script/spec_server
-- examples/rails/script/autospec
-- examples/rails/script/destroy
-- examples/rails/script/dbconsole
-- examples/rails/script/performance/profiler
-- examples/rails/script/performance/request
-- examples/rails/script/performance/benchmarker
-- examples/rails/script/generate
-- examples/rails/script/process/reaper
-- examples/rails/script/process/inspector
-- examples/rails/script/process/spawner
-- examples/rails/script/spec
-- examples/rails/script/console
-- examples/rails/script/runner
-- examples/rails/script/server
-- examples/rails/script/plugin
-- examples/rails/script/about
-- examples/rails/README
-- examples/rails/config/boot.rb
-- examples/rails/config/locales/en.yml
-- examples/rails/config/environments/development.rb
-- examples/rails/config/environments/test.rb
-- examples/rails/config/environments/production.rb
-- examples/rails/config/routes.rb
-- examples/rails/config/database.yml
-- examples/rails/config/environment.rb
-- examples/rails/config/initializers/new_rails_defaults.rb
-- examples/rails/config/initializers/mime_types.rb
-- examples/rails/config/initializers/inflections.rb
-- lib/rackbox/rack_content_length_fix.rb
-- lib/rackbox.rb
+- VERSION.yml
 - README.markdown
-- run-specs
-- rackbox.gemspec
+- lib/rackbox.rb
+- lib/rspec
+- lib/rspec/custom_matcher.rb
+- lib/rackbox
+- lib/rackbox/rack
+- lib/rackbox/rack/extensions_for_rspec.rb
+- lib/rackbox/rack/sticky_sessions.rb
+- lib/rackbox/rack/content_length_fix.rb
+- lib/rackbox/spec
+- lib/rackbox/spec/configuration.rb
+- lib/rackbox/spec/helpers.rb
+- lib/rackbox/rackbox.rb
+- lib/rackbox/matchers.rb
 has_rdoc: true
 homepage: http://github.com/remi/rackbox
 post_install_message: 
 rdoc_options: 
-- --quiet
-- --title
-- RackBox - Merb-like BlackBox testing for Rack apps
-- --opname
-- index.html
-- --line-numbers
-- --main
-- RackBox
 - --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement