indirect-webrat 0.7.4

data/lib/webrat/core_extensions/nil_to_query_string.rb

@@ -0,0 +1,5 @@
+class NilClass #:nodoc:
+  def to_query_string
+    nil
+  end
+end

data/lib/webrat/core_extensions/tcp_socket.rb

@@ -0,0 +1,27 @@
+class TCPSocket
+
+  def self.wait_for_service_with_timeout(options)
+    start_time = Time.now
+
+    until listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not open within #{options[:timeout]} seconds")
+      end
+    end
+  end
+
+  def self.wait_for_service_termination_with_timeout(options)
+    start_time = Time.now
+
+    while listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not terminate within #{options[:timeout]} seconds")
+      end
+    end
+  end
+
+end

data/lib/webrat/integrations/merb.rb

@@ -0,0 +1,10 @@
+module Merb #:nodoc:
+  module Test #:nodoc:
+    module RequestHelper #:nodoc:
+      def request(uri, env = {})
+        @_webrat_session ||= Webrat::MerbAdapter.new
+        @_webrat_session.response = @_webrat_session.request(uri, env)
+      end
+    end
+  end
+end

data/lib/webrat/integrations/rack.rb

@@ -0,0 +1,9 @@
+if defined?(ActionController::IntegrationTest)
+  module ActionController #:nodoc:
+    IntegrationTest.class_eval do
+      include Rack::Test::Methods
+      include Webrat::Methods
+      include Webrat::Matchers
+    end
+  end
+end

data/lib/webrat/integrations/rails.rb

@@ -0,0 +1,25 @@
+require "action_controller"
+require "action_controller/integration"
+
+module ActionController #:nodoc:
+  IntegrationTest.class_eval do
+    include Webrat::Methods
+    include Webrat::Matchers
+
+    # The Rails version of within supports passing in a model and Webrat
+    # will apply a scope based on Rails' dom_id for that model.
+    #
+    # Example:
+    #   within User.last do
+    #     click_link "Delete"
+    #   end
+    def within(selector_or_object, &block)
+      if selector_or_object.is_a?(String)
+        super
+      else
+        super('#' + RecordIdentifier.dom_id(selector_or_object), &block)
+      end
+    end
+
+  end
+end

data/lib/webrat/integrations/rspec-rails.rb

@@ -0,0 +1,11 @@
+# Supports using the matchers in controller, helper, and view specs if you're
+# using rspec-rails. Just add a require statement to spec/spec_helper.rb or env.rb:
+#
+#   require 'webrat/integrations/rspec-rails'
+#
+require "nokogiri"
+require "webrat/core/matchers"
+
+Spec::Runner.configure do |config|
+  config.include(Webrat::Matchers, :type => [:controller, :helper, :view])
+end

data/lib/webrat/integrations/selenium.rb

@@ -0,0 +1,11 @@
+require "webrat/selenium"
+
+if defined?(ActionController::IntegrationTest)
+  module ActionController #:nodoc:
+    IntegrationTest.class_eval do
+      include Webrat::Methods
+      include Webrat::Selenium::Methods
+      include Webrat::Selenium::Matchers
+    end
+  end
+end

data/lib/webrat/merb.rb

@@ -0,0 +1,9 @@
+require "webrat"
+
+# This is a temporary hack to support backwards compatibility
+# with Merb 1.0.8 until it's updated to use the new Webrat.configure
+# syntax
+
+Webrat.configure do |config|
+  config.mode = :merb
+end

data/lib/webrat/rspec-rails.rb

@@ -0,0 +1,2 @@
+warn("Requiring 'webrat/rspec-rails' is deprecated. Please require 'webrat/integrations/rspec-rails' instead")
+require "webrat/integrations/rspec-rails"

data/lib/webrat/selenium.rb

@@ -0,0 +1,70 @@
+require "webrat"
+require "selenium/client"
+require "webrat/selenium/silence_stream"
+require "webrat/selenium/selenium_session"
+require "webrat/selenium/matchers"
+require "webrat/core_extensions/tcp_socket"
+
+module Webrat
+  # To use Webrat's Selenium support, you'll need the selenium-client gem installed.
+  # Activate it with (for example, in your <tt>env.rb</tt>):
+  #
+  #   require "webrat"
+  #
+  #   Webrat.configure do |config|
+  #     config.mode = :selenium
+  #   end
+  #
+  # == Dropping down to the selenium-client API
+  #
+  # If you ever need to do something with Selenium not provided in the Webrat API,
+  # you can always drop down to the selenium-client API using the <tt>selenium</tt> method.
+  # For example:
+  #
+  #   When "I drag the photo to the left" do
+  #     selenium.dragdrop("id=photo_123", "+350, 0")
+  #   end
+  #
+  # == Choosing the underlying framework to test
+  #
+  # Webrat assumes you're using rails by default but it can also work with sinatra
+  # and merb.  To take advantage of this you can use the configuration block to
+  # set the application_framework variable.
+  #   require "webrat"
+  #
+  #   Webrat.configure do |config|
+  #     config.mode = :selenium
+  #     config.application_port = 4567
+  #     config.application_framework = :sinatra  # could also be :merb
+  #   end
+  #
+  # == Auto-starting of the appserver and java server
+  #
+  # Webrat will automatically start the Selenium Java server process and an instance
+  # of Mongrel when a test is run. The Mongrel will run in the "selenium" environment
+  # instead of "test", so ensure you've got that defined, and will run on port
+  # Webrat.configuration.application_port.
+  #
+  # == Waiting
+  #
+  # In order to make writing Selenium tests as easy as possible, Webrat will automatically
+  # wait for the correct elements to exist on the page when trying to manipulate them
+  # with methods like <tt>fill_in</tt>, etc. In general, this means you should be able to write
+  # your Webrat::Selenium tests ignoring the concurrency issues that can plague in-browser
+  # testing, so long as you're using the Webrat API.
+  module Selenium
+    module Methods
+      def response
+        webrat_session.response
+      end
+
+      def wait_for(*args, &block)
+        webrat_session.wait_for(*args, &block)
+      end
+
+      def save_and_open_screengrab
+        webrat_session.save_and_open_screengrab
+      end
+    end
+  end
+end

data/lib/webrat/selenium/application_server_factory.rb

@@ -0,0 +1,43 @@
+module Webrat
+  module Selenium
+
+    class ApplicationServerFactory
+
+      def self.app_server_instance
+        case Webrat.configuration.application_framework
+        when :sinatra
+          require "webrat/selenium/application_servers/sinatra"
+          return Webrat::Selenium::ApplicationServers::Sinatra.new
+        when :merb
+          require "webrat/selenium/application_servers/merb"
+          return Webrat::Selenium::ApplicationServers::Merb.new
+        when :rails
+          require "webrat/selenium/application_servers/rails"
+          return Webrat::Selenium::ApplicationServers::Rails.new
+        when :rack
+          require "webrat/selenium/application_servers/rack"
+          return Webrat::Selenium::ApplicationServers::Rack.new
+        when :external
+          require "webrat/selenium/application_servers/external"
+          return Webrat::Selenium::ApplicationServers::External.new
+        else
+          raise WebratError.new(<<-STR)
+Unknown Webrat application_framework: #{Webrat.configuration.application_framework.inspect}
+
+Please ensure you have a Webrat configuration block that specifies an application_framework
+in your test_helper.rb, spec_helper.rb, or env.rb (for Cucumber).
+
+For example:
+
+  Webrat.configure do |config|
+    # ...
+    config.application_framework = :rails
+  end
+      STR
+        end
+      end
+
+    end
+
+  end
+end

data/lib/webrat/selenium/application_servers.rb

@@ -0,0 +1,5 @@
+require "webrat/selenium/application_servers/base"
+require "webrat/selenium/application_servers/sinatra"
+require "webrat/selenium/application_servers/merb"
+require "webrat/selenium/application_servers/rails"
+require "webrat/selenium/application_servers/external"

data/lib/webrat/selenium/application_servers/base.rb

@@ -0,0 +1,46 @@
+require "webrat/selenium/silence_stream"
+
+module Webrat
+  module Selenium
+    module ApplicationServers
+      class Base
+        include Webrat::Selenium::SilenceStream
+
+        def boot
+          start
+          wait
+          stop_at_exit
+        end
+
+        def stop_at_exit
+          at_exit do
+            stop
+          end
+        end
+
+        def wait
+          $stderr.print "==> Waiting for #{Webrat.configuration.application_framework} application server on port #{Webrat.configuration.application_port}... "
+          wait_for_socket
+          $stderr.print "Ready!\n"
+        end
+
+        def wait_for_socket
+          silence_stream(STDOUT) do
+            TCPSocket.wait_for_service_with_timeout \
+              :host     => "0.0.0.0",
+              :port     => Webrat.configuration.application_port.to_i,
+              :timeout  => 30 # seconds
+          end
+          rescue SocketError
+          fail
+        end
+
+        def prepare_pid_file(file_path, pid_file_name)
+          FileUtils.mkdir_p File.expand_path(file_path)
+          File.expand_path("#{file_path}/#{pid_file_name}")
+        end
+
+      end
+    end
+  end
+end

data/lib/webrat/selenium/application_servers/external.rb

@@ -0,0 +1,26 @@
+require "webrat/selenium/application_servers/base"
+
+module Webrat
+  module Selenium
+    module ApplicationServers
+      class External < Webrat::Selenium::ApplicationServers::Base
+        def start
+          warn "Webrat Ignoring Start Of Application Server Due to External Mode"
+        end
+
+        def stop
+        end
+
+        def fail
+        end
+
+        def pid_file
+        end
+
+        def wait
+        end
+
+      end
+    end
+  end
+end

data/lib/webrat/selenium/application_servers/merb.rb

@@ -0,0 +1,50 @@
+require "webrat/selenium/application_servers/base"
+
+module Webrat
+  module Selenium
+    module ApplicationServers
+      class Merb < Webrat::Selenium::ApplicationServers::Base
+
+        def start
+          system start_command
+        end
+
+        def stop
+          silence_stream(STDOUT) do
+            pid = File.read(pid_file)
+            system("kill -9 #{pid}")
+            FileUtils.rm_f pid_file
+          end
+        end
+
+        def fail
+          $stderr.puts
+          $stderr.puts
+          $stderr.puts "==> Failed to boot the Merb application server... exiting!"
+          $stderr.puts
+          $stderr.puts "Verify you can start a Merb server on port #{Webrat.configuration.application_port} with the following command:"
+          $stderr.puts
+          $stderr.puts "    #{start_command}"
+          exit
+        end
+
+        def pid_file
+        "log/merb.#{Webrat.configuration.application_port}.pid"
+        end
+
+        def start_command
+        "#{merb_command} -d -p #{Webrat.configuration.application_port} -e #{Webrat.configuration.application_environment}"
+        end
+
+        def merb_command
+          if File.exist?('bin/merb')
+            merb_cmd = 'bin/merb'
+          else
+            merb_cmd = 'merb'
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/webrat/selenium/application_servers/rack.rb

@@ -0,0 +1,51 @@
+require "webrat/selenium/application_servers/base"
+
+module Webrat
+  module Selenium
+    module ApplicationServers
+      class Rack < Webrat::Selenium::ApplicationServers::Base
+
+        def start
+          @pid = fork do
+            if File.exist?("log")
+              redirect_io(STDOUT, File.join("log", "webrat.webrick.stdout.log"))
+              redirect_io(STDERR, File.join("log", "webrat.webrick.stderr.log"))
+            end
+            exec start_command
+          end
+        end
+
+        def stop
+          Process.kill("INT", @pid)
+        end
+
+        def fail
+          $stderr.puts
+          $stderr.puts
+          $stderr.puts "==> Failed to boot the application server... exiting!"
+          $stderr.puts
+          $stderr.puts "Verify you can start a server on port #{Webrat.configuration.application_port} with the following command:"
+          $stderr.puts
+          $stderr.puts "    #{start_command}"
+          exit
+        end
+
+        def start_command
+          "#{bundler} rackup -s webrick --port #{Webrat.configuration.application_port} --env #{Webrat.configuration.application_environment}".strip
+        end
+
+      private
+
+        def bundler
+          File.exist?("./Gemfile") ? "bundle exec " : ""
+        end
+
+        def redirect_io(io, path)
+          File.open(path, 'ab') { |fp| io.reopen(fp) } if path
+          io.sync = true
+        end
+
+      end
+    end
+  end
+end

data/lib/webrat/selenium/application_servers/rails.rb

@@ -0,0 +1,44 @@
+require "webrat/selenium/application_servers/base"
+
+module Webrat
+  module Selenium
+    module ApplicationServers
+      class Rails < Webrat::Selenium::ApplicationServers::Base
+
+        def start
+          system start_command
+        end
+
+        def stop
+          silence_stream(STDOUT) do
+            system stop_command
+          end
+        end
+
+        def fail
+          $stderr.puts
+          $stderr.puts
+          $stderr.puts "==> Failed to boot the Rails application server... exiting!"
+          $stderr.puts
+          $stderr.puts "Verify you can start a Rails server on port #{Webrat.configuration.application_port} with the following command:"
+          $stderr.puts
+          $stderr.puts "    #{start_command}"
+          exit
+        end
+
+        def pid_file
+          prepare_pid_file("#{::Rails.root}/tmp/pids", "mongrel_selenium.pid")
+        end
+
+        def start_command
+          "mongrel_rails start -d --chdir='#{::Rails.root}' --port=#{Webrat.configuration.application_port} --environment=#{Webrat.configuration.application_environment} --pid #{pid_file} &"
+        end
+
+        def stop_command
+          "mongrel_rails stop -c #{::Rails.root} --pid #{pid_file}"
+        end
+
+      end
+    end
+  end
+end