benschwarz-webrat 0.3.2.1

data/lib/webrat/core/methods.rb

@@ -0,0 +1,54 @@
+module Webrat
+  module Methods #:nodoc:
+
+    def self.delegate_to_session(*meths)
+      meths.each do |meth|
+        self.class_eval <<-RUBY
+          def #{meth}(*args, &blk)
+            webrat_session.#{meth}(*args, &blk)
+          end
+          
+          def webrat_session
+            @_webrat_session ||= ::Webrat.session_class.new(self)
+          end
+        RUBY
+      end
+    end
+    
+    # all of these methods delegate to the @session, which should
+    # be created transparently.
+    #
+    # Note that when using Webrat, #request also uses @session, so
+    # that #request and webrat native functions behave interchangably
+
+    delegate_to_session \
+      :visits, :visit,
+      :within,
+      :header, :http_accept, :basic_auth,
+      :save_and_open_page,
+      :fills_in, :fill_in,
+      :checks, :check, 
+      :unchecks, :uncheck,
+      :chooses, :choose,
+      :selects, :select,
+      :attaches_file, :attach_file,
+      :current_page,
+      :current_url,
+      :clicks_link, :click_link,
+      :clicks_area, :click_area,
+      :clicks_button, :click_button,
+      :reload, :reloads,
+      :clicks_link_within, :click_link_within,
+      :field_labeled,
+      :select_option,
+      :set_hidden_field, :submit_form,
+      :request_page, :current_dom,
+      :selects_date, :selects_time, :selects_datetime,
+      :select_date, :select_time, :select_datetime,
+      :wait_for_page_to_load,
+      :field_by_xpath,
+      :field_with_id
+      
+    
+  end
+end

data/lib/webrat/core/mime.rb

@@ -0,0 +1,29 @@
+module Webrat #:nodoc:
+  module MIME #:nodoc:
+    
+    def self.mime_type(string_or_symbol) #:nodoc:
+      if string_or_symbol.is_a?(String)
+        string_or_symbol
+      else
+        case string_or_symbol
+        when :text              then "text/plain"
+        when :html              then "text/html"
+        when :js                then "text/javascript"
+        when :css               then "text/css"
+        when :ics               then "text/calendar"
+        when :csv               then "text/csv"
+        when :xml               then "application/xml"
+        when :rss               then "application/rss+xml"
+        when :atom              then "application/atom+xml"
+        when :yaml              then "application/x-yaml"
+        when :multipart_form    then "multipart/form-data"
+        when :url_encoded_form  then "application/x-www-form-urlencoded"
+        when :json              then "application/json"
+        else
+          raise ArgumentError.new("Invalid Mime type: #{string_or_symbol.inspect}")
+        end
+      end
+    end
+    
+  end
+end

data/lib/webrat/core/scope.rb

@@ -0,0 +1,318 @@
+require "webrat/core/elements/form"
+require "webrat/core/locators"
+require "webrat/core_extensions/deprecate"
+
+module Webrat
+  # An HTML element (link, button, field, etc.) that Webrat expected was not found on the page
+  class NotFoundError < WebratError
+  end
+  
+  class Scope
+    include Logging
+    include Locators
+    
+    def self.from_page(session, response, response_body) #:nodoc:
+      new(session) do
+        @response = response
+        @response_body = response_body
+      end
+    end
+    
+    def self.from_scope(session, scope, selector) #:nodoc:
+      new(session) do
+        @scope = scope
+        @selector = selector
+      end
+    end
+    
+    attr_reader :session
+    
+    def initialize(session, &block) #:nodoc:
+      @session = session
+      instance_eval(&block) if block_given?
+    end
+    
+    # Verifies an input field or textarea exists on the current page, and stores a value for
+    # it which will be sent when the form is submitted.
+    #
+    # Examples:
+    #   fill_in "Email", :with => "user@example.com"
+    #   fill_in "user[email]", :with => "user@example.com"
+    #
+    # The field value is required, and must be specified in <tt>options[:with]</tt>.
+    # <tt>field</tt> can be either the value of a name attribute (i.e. <tt>user[email]</tt>)
+    # or the text inside a <tt><label></tt> element that points at the <tt><input></tt> field.
+    def fill_in(field_locator, options = {})
+      field = locate_field(field_locator, TextField, TextareaField, PasswordField)
+      field.raise_error_if_disabled
+      field.set(options[:with])
+    end
+
+    webrat_deprecate :fills_in, :fill_in
+    
+    def set_hidden_field(field_locator, options = {})
+      field = locate_field(field_locator, HiddenField)
+      field.set(options[:to])
+    end
+    
+    # Verifies that an input checkbox exists on the current page and marks it
+    # as checked, so that the value will be submitted with the form.
+    #
+    # Example:
+    #   check 'Remember Me'
+    def check(field_locator)
+      locate_field(field_locator, CheckboxField).check
+    end
+
+    webrat_deprecate :checks, :check
+    
+    # Verifies that an input checkbox exists on the current page and marks it
+    # as unchecked, so that the value will not be submitted with the form.
+    #
+    # Example:
+    #   uncheck 'Remember Me'
+    def uncheck(field_locator)
+      locate_field(field_locator, CheckboxField).uncheck
+    end
+
+    webrat_deprecate :unchecks, :uncheck
+    
+    # Verifies that an input radio button exists on the current page and marks it
+    # as checked, so that the value will be submitted with the form.
+    #
+    # Example:
+    #   choose 'First Option'
+    def choose(field_locator)
+      locate_field(field_locator, RadioField).choose
+    end
+
+    webrat_deprecate :chooses, :choose
+    
+    # Verifies that a an option element exists on the current page with the specified
+    # text. You can optionally restrict the search to a specific select list by
+    # assigning <tt>options[:from]</tt> the value of the select list's name or
+    # a label. Stores the option's value to be sent when the form is submitted.
+    #
+    # Examples:
+    #   select "January"
+    #   select "February", :from => "event_month"
+    #   select "February", :from => "Event Month"
+    def select(option_text, options = {})
+      select_option(option_text, options[:from]).choose
+    end
+
+    webrat_deprecate :selects, :select
+    
+    DATE_TIME_SUFFIXES = {
+      :year   => '1i',
+      :month  => '2i',
+      :day    => '3i',
+      :hour   => '4i',
+      :minute => '5i'
+    }
+
+    # Verifies that date elements (year, month, day) exist on the current page 
+    # with the specified values. You can optionally restrict the search to a specific
+    # date's elements by assigning <tt>options[:from]</tt> the value of the date's 
+    # label. Selects all the date elements with date provided.  The date provided may
+    # be a string or a Date/Time object.
+    #
+    # Rail's convention is used for detecting the date elements. All elements
+    # are assumed to have a shared prefix.  You may also specify the prefix
+    # by assigning <tt>options[:id_prefix]</tt>.
+    #
+    # Examples:
+    #   select_date "January 23, 2004"
+    #   select_date "April 26, 1982", :from => "Birthday"
+    #   select_date Date.parse("December 25, 2000"), :from => "Event"
+    #   select_date "April 26, 1982", :id_prefix => 'birthday'
+    def select_date(date_to_select, options ={})
+      date = date_to_select.is_a?(Date) || date_to_select.is_a?(Time) ? 
+                date_to_select : Date.parse(date_to_select) 
+      
+      id_prefix = locate_id_prefix(options) do
+        year_field = FieldByIdLocator.new(@session, dom, /(.*?)_#{DATE_TIME_SUFFIXES[:year]}$/).locate
+        raise NotFoundError.new("No date fields were found") unless year_field && year_field.id =~ /(.*?)_1i/
+        $1
+      end
+        
+      select date.year, :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:year]}"
+      select date.strftime('%B'), :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:month]}"
+      select date.day, :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:day]}"
+    end
+
+    webrat_deprecate :selects_date, :select_date
+
+    # Verifies that time elements (hour, minute) exist on the current page 
+    # with the specified values. You can optionally restrict the search to a specific
+    # time's elements by assigning <tt>options[:from]</tt> the value of the time's 
+    # label. Selects all the time elements with date provided.  The time provided may
+    # be a string or a Time object.
+    #
+    # Rail's convention is used for detecting the time elements. All elements are
+    # assumed to have a shared prefix. You may specify the prefix by assigning
+    # <tt>options[:id_prefix]</tt>.
+    #
+    # Note: Just like Rails' time_select helper this assumes the form is using
+    # 24 hour select boxes, and not 12 hours with AM/PM.
+    # 
+    # Examples:
+    #   select_time "9:30"
+    #   select_date "3:30PM", :from => "Party Time"
+    #   select_date Time.parse("10:00PM"), :from => "Event"
+    #   select_date "10:30AM", :id_prefix => 'meeting'
+    def select_time(time_to_select, options ={})
+      time = time_to_select.is_a?(Time) ? time_to_select : Time.parse(time_to_select) 
+
+      id_prefix = locate_id_prefix(options) do
+        hour_field = FieldByIdLocator.new(@session, dom, /(.*?)_#{DATE_TIME_SUFFIXES[:hour]}$/).locate
+        raise NotFoundError.new("No time fields were found") unless hour_field && hour_field.id =~ /(.*?)_4i/
+        $1
+      end
+        
+      select time.hour.to_s.rjust(2,'0'), :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:hour]}"
+      select time.min.to_s.rjust(2,'0'), :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:minute]}"
+    end
+
+    webrat_deprecate :selects_time, :select_time
+   
+    # Verifies and selects all the date and time elements on the current page. 
+    # See #select_time and #select_date for more details and available options.
+    #
+    # Examples:
+    #   select_datetime "January 23, 2004 10:30AM"
+    #   select_datetime "April 26, 1982 7:00PM", :from => "Birthday"
+    #   select_datetime Time.parse("December 25, 2000 15:30"), :from => "Event"
+    #   select_datetime "April 26, 1982 5:50PM", :id_prefix => 'birthday'
+    def select_datetime(time_to_select, options ={})
+      time = time_to_select.is_a?(Time) ? time_to_select : Time.parse(time_to_select) 
+      
+      options[:id_prefix] ||= (options[:from] ? FieldByIdLocator.new(@session, dom, options[:from]).locate : nil)
+      
+      select_date time, options
+      select_time time, options
+    end
+
+    webrat_deprecate :selects_datetime, :select_datetime
+    
+    # Verifies that an input file field exists on the current page and sets
+    # its value to the given +file+, so that the file will be uploaded
+    # along with the form. An optional <tt>content_type</tt> may be given.
+    #
+    # Example:
+    #   attaches_file "Resume", "/path/to/the/resume.txt"
+    #   attaches_file "Photo", "/path/to/the/image.png", "image/png"
+    def attach_file(field_locator, path, content_type = nil)
+      locate_field(field_locator, FileField).set(path, content_type)
+    end
+
+    webrat_deprecate :attaches_file, :attach_file
+    
+    def click_area(area_name)
+      find_area(area_name).click
+    end
+    
+    webrat_deprecate :clicks_area, :click_area
+    
+    # Issues a request for the URL pointed to by a link on the current page,
+    # follows any redirects, and verifies the final page load was successful.
+    # 
+    # click_link has very basic support for detecting Rails-generated 
+    # JavaScript onclick handlers for PUT, POST and DELETE links, as well as
+    # CSRF authenticity tokens if they are present.
+    #
+    # Javascript imitation can be disabled by passing the option :javascript => false
+    #
+    # Passing a :method in the options hash overrides the HTTP method used
+    # for making the link request
+    # 
+    # It will try to find links by (in order of precedence):
+    #   innerHTML, with simple &nbsp; handling
+    #   title
+    #   id
+    #    
+    # innerHTML and title are matchable by text subtring or Regexp
+    # id is matchable by full text equality or Regexp
+    # 
+    # Example:
+    #   click_link "Sign up"
+    #   click_link "Sign up", :javascript => false
+    #   click_link "Sign up", :method => :put
+    def click_link(text_or_title_or_id, options = {})
+      find_link(text_or_title_or_id).click(options)
+    end
+
+    webrat_deprecate :clicks_link, :click_link
+    
+    # Verifies that a submit button exists for the form, then submits the form, follows
+    # any redirects, and verifies the final page was successful.
+    #
+    # Example:
+    #   click_button "Login"
+    #   click_button
+    #
+    # The URL and HTTP method for the form submission are automatically read from the
+    # <tt>action</tt> and <tt>method</tt> attributes of the <tt><form></tt> element.
+    def click_button(value = nil)
+      find_button(value).click
+    end
+
+    webrat_deprecate :clicks_button, :click_button
+    
+    def submit_form(id)
+      FormLocator.new(@session, dom, id).locate.submit
+    end
+    
+    def dom # :nodoc:
+      return @dom if @dom
+      
+      if @selector
+        @dom = scoped_dom
+      else
+        @dom = page_dom
+      end
+      
+      return @dom
+    end
+    
+  protected
+    
+    def page_dom #:nodoc:
+      return @response.dom if @response.respond_to?(:dom)
+      dom = Webrat::XML.document(@response_body)
+      Webrat.define_dom_method(@response, dom)
+      return dom
+    end
+    
+    def scoped_dom #:nodoc:
+      Webrat::XML.document("<html>" + Webrat::XML.to_html(Webrat::XML.css_search(@scope.dom, @selector).first) + "</html>")
+    end
+    
+    def locate_field(field_locator, *field_types) #:nodoc:
+      if field_locator.is_a?(Field)
+        field_locator
+      else
+        field(field_locator, *field_types)
+      end
+    end
+    
+    def locate_id_prefix(options, &location_strategy) #:nodoc:
+      return options[:id_prefix] if options[:id_prefix]
+      
+      if options[:from]
+        if (label = LabelLocator.new(@session, dom, options[:from]).locate)
+          label.for_id
+        else
+          raise NotFoundError.new("Could not find the label with text #{options[:from]}")
+        end
+      else
+        yield
+      end
+    end
+    
+    def forms #:nodoc:
+      @forms ||= Form.load_all(@session, dom)
+    end
+    
+  end
+end

data/lib/webrat/core/session.rb

@@ -0,0 +1,241 @@
+require "forwardable"
+require "ostruct"
+
+require "webrat/core/mime"
+
+module Webrat
+  # A page load or form submission returned an unsuccessful response code (500-599)
+  class PageLoadError < WebratError
+  end
+  
+  def self.session_class
+    case Webrat.configuration.mode
+    when :rails
+      RailsSession
+    when :merb
+      MerbSession
+    when :selenium
+      SeleniumSession
+    when :rack
+      RackSession
+    when :sinatra
+      SinatraSession
+    when :mechanize
+      MechanizeSession
+    else
+      raise WebratError.new("Unknown Webrat mode: #{Webrat.configuration.mode.inspect}")
+    end
+  end
+  
+  class Session
+    extend Forwardable
+    include Logging
+    
+    attr_reader :current_url
+    attr_reader :elements
+    
+    def initialize(context = nil) #:nodoc:
+      @http_method     = :get
+      @data            = {}
+      @default_headers = {}
+      @custom_headers  = {}
+      @context         = context
+      
+      reset
+    end
+
+    # Saves the page out to RAILS_ROOT/tmp/ and opens it in the default
+    # web browser if on OS X. Useful for debugging.
+    # 
+    # Example:
+    #   save_and_open_page
+    def save_and_open_page
+      return unless File.exist?(saved_page_dir)
+
+      filename = "#{saved_page_dir}/webrat-#{Time.now.to_i}.html"
+      
+      File.open(filename, "w") do |f|
+        f.write rewrite_css_and_image_references(response_body)
+      end
+
+      open_in_browser(filename)
+    end
+    
+    def current_dom #:nodoc:
+      current_scope.dom
+    end
+    
+    # For backwards compatibility -- removing in 1.0
+    def current_page #:nodoc:
+      page = OpenStruct.new
+      page.url = @current_url
+      page.http_method = @http_method
+      page.data = @data
+      page
+    end
+    
+    def doc_root #:nodoc:
+      nil
+    end
+    
+    def saved_page_dir #:nodoc:
+      File.expand_path(".")
+    end
+
+    def header(key, value)
+      @custom_headers[key] = value
+    end
+
+    def http_accept(mime_type)
+      header('Accept', Webrat::MIME.mime_type(mime_type))
+    end
+    
+    def basic_auth(user, pass)
+      encoded_login = ["#{user}:#{pass}"].pack("m*")
+      header('HTTP_AUTHORIZATION', "Basic #{encoded_login}")
+    end
+
+    def headers #:nodoc:
+      @default_headers.dup.merge(@custom_headers.dup)
+    end
+
+    def request_page(url, http_method, data) #:nodoc:
+      h = headers
+      h['HTTP_REFERER'] = @current_url if @current_url
+
+      debug_log "REQUESTING PAGE: #{http_method.to_s.upcase} #{url} with #{data.inspect} and HTTP headers #{h.inspect}"
+      if h.empty?
+        send "#{http_method}", url, data || {}
+      else
+        send "#{http_method}", url, data || {}, h
+      end
+
+      save_and_open_page if exception_caught? && Webrat.configuration.open_error_files?
+      raise PageLoadError.new("Page load was not successful (Code: #{response_code.inspect}):\n#{formatted_error}") unless success_code?
+      
+      reset
+      
+      @current_url  = url
+      @http_method  = http_method
+      @data         = data
+      
+      return response
+    end
+    
+    def success_code? #:nodoc:
+      (200..499).include?(response_code)
+    end
+    
+    def exception_caught? #:nodoc:
+      response_body =~ /Exception caught/
+    end
+    
+    def current_scope #:nodoc:
+      scopes.last || page_scope
+    end
+    
+    # Reloads the last page requested. Note that this will resubmit forms
+    # and their data.
+    def reloads
+      request_page(@current_url, @http_method, @data)
+    end
+
+    webrat_deprecate :reload, :reloads
+      
+    
+    # Works like click_link, but only looks for the link text within a given selector
+    # 
+    # Example:
+    #   click_link_within "#user_12", "Vote"
+    def click_link_within(selector, link_text)
+      within(selector) do
+        click_link(link_text)
+      end
+    end
+
+    webrat_deprecate :clicks_link_within, :click_link_within
+    
+    def within(selector)
+      scopes.push(Scope.from_scope(self, current_scope, selector))
+      ret = yield(current_scope)
+      scopes.pop
+      return ret
+    end
+    
+    # Issues a GET request for a page, follows any redirects, and verifies the final page
+    # load was successful.
+    #
+    # Example:
+    #   visit "/"
+    def visit(url = nil, http_method = :get, data = {})
+      request_page(url, http_method, data)
+    end
+    
+    webrat_deprecate :visits, :visit
+    
+    def open_in_browser(path) # :nodoc
+      platform = ruby_platform
+      if platform =~ /cygwin/ || platform =~ /win32/
+        `rundll32 url.dll,FileProtocolHandler #{path.gsub("/", "\\\\")}`
+      elsif platform =~ /darwin/
+        `open #{path}`
+      end
+    end
+    
+    def rewrite_css_and_image_references(response_html) # :nodoc:
+      return response_html unless doc_root
+      response_html.gsub(/"\/(stylesheets|images)/, doc_root + '/\1')
+    end
+
+    # Subclasses can override this to show error messages without html
+    def formatted_error #:nodoc:
+      response_body
+    end
+
+    def scopes #:nodoc:
+      @_scopes ||= []
+    end
+
+    def page_scope #:nodoc:
+      @_page_scope ||= Scope.from_page(self, response, response_body)
+    end
+    
+    def dom
+      page_scope.dom
+    end
+    
+    def_delegators :current_scope, :fill_in,            :fills_in
+    def_delegators :current_scope, :set_hidden_field
+    def_delegators :current_scope, :submit_form
+    def_delegators :current_scope, :check,              :checks
+    def_delegators :current_scope, :uncheck,            :unchecks
+    def_delegators :current_scope, :choose,             :chooses
+    def_delegators :current_scope, :select,             :selects
+    def_delegators :current_scope, :select_datetime,    :selects_datetime
+    def_delegators :current_scope, :select_date,        :selects_date
+    def_delegators :current_scope, :select_time,        :selects_time
+    def_delegators :current_scope, :attach_file,        :attaches_file
+    def_delegators :current_scope, :click_area,         :clicks_area
+    def_delegators :current_scope, :click_link,         :clicks_link
+    def_delegators :current_scope, :click_button,       :clicks_button
+    def_delegators :current_scope, :should_see
+    def_delegators :current_scope, :should_not_see
+    def_delegators :current_scope, :field_labeled
+    def_delegators :current_scope, :field_by_xpath
+    def_delegators :current_scope, :field_with_id
+    def_delegators :current_scope, :select_option
+    
+  private
+    
+    def reset
+      @elements     = {}
+      @_scopes      = nil
+      @_page_scope  = nil
+    end
+    
+    # accessor for testing
+    def ruby_platform
+      RUBY_PLATFORM
+    end
+  end
+end