mechanize 0.6.2 → 0.6.3

data/CHANGELOG

@@ -1,5 +1,20 @@
 = Mechanize CHANGELOG
 
+== 0.6.3
+
+* Added keys and values methods to Form
+* Added has_value? to Form
+* Added a has_field? method to Form
+* The add_field! method on Form now creates a field for you on the form.
+  Thanks to Mat Schaffer for the patch.
+  http://rubyforge.org/pipermail/mechanize-users/2006-November/000025.html
+* Fixed a bug when form actions have html ecoded entities in them.
+  http://rubyforge.org/pipermail/mechanize-users/2006-October/000019.html
+* Fixed a bug when links or frame sources have html encoded entities in the
+  href or src.
+* Fixed a bug where '#' symbols are encoded
+  http://rubyforge.org/forum/message.php?msg_id=14747
+
 == 0.6.2
 
 * Added a yield to Page#form so that dealing with forms can be more DSL like.

data/NOTES

@@ -1,5 +1,18 @@
 = Mechanize Release Notes
 
+== 0.6.3 (Big Man)
+
+Mechanize 0.6.3 (Big Man) has a few bug fixes and some new features added to
+the Form class.  The Form class is now more hash like.  I've added an
+Form#add_field! method that will add a field to your form.  Form#[]= will now
+add a field if the key doesn't exist.  For example, your form doesn't have
+an input field named 'foo', the following 2 lines of code are equivalent, and
+will create a field named 'foo':
+  form['foo'] = 'bar'
+or
+  form.add_field!('foo', 'bar')
+To make forms more hashlike, has_value?, and has_key? methods.
+
 == 0.6.2 (Bridget)
 
 Mechanize 0.6.2 (Bridget) is a fairly small bug fix release.  You can now

data/lib/mechanize.rb

@@ -200,12 +200,7 @@ class Mechanize
     when 'POST'
       post_form(uri, form) 
     when 'GET'
-      if uri.query.nil?
-        uri.query = WWW::Mechanize.build_query_string(form.build_query)
-      else
-        uri.query = uri.query + "&" +
-          WWW::Mechanize.build_query_string(form.build_query)
-      end
+      uri.query = WWW::Mechanize.build_query_string(form.build_query)
       get(uri)
     else
       raise "unsupported method: #{form.method.upcase}"
@@ -241,9 +236,8 @@ class Mechanize
 
   def to_absolute_uri(url, cur_page=current_page())
     url =  URI.parse(
-           URI.escape(
-           URI.unescape(url.to_s.strip)
-                     )) unless url.is_a? URI
+           URI.unescape(Util.html_unescape(url.to_s.strip)).gsub(/ /, '%20')
+                     ) unless url.is_a? URI
 
     # construct an absolute uri
     if url.relative?
@@ -287,7 +281,7 @@ class Mechanize
   def fetch_page(uri, request, cur_page=current_page(), request_data=[])
     raise "unsupported scheme" unless ['http', 'https'].include?(uri.scheme)
 
-    log.info("#{ request.class }: #{ uri.to_s }") if log
+    log.info("#{ request.class }: #{ request.path }") if log
 
     page = nil
 
@@ -404,9 +398,7 @@ class Mechanize
           return page
         when "301", "302"
           log.info("follow redirect to: #{ response['Location'] }") if log
-          abs_uri = to_absolute_uri(
-            URI.parse(
-              URI.escape(URI.unescape(response['Location'].to_s))), page)
+          abs_uri = to_absolute_uri(response['Location'].to_s, page)
           request = fetch_request(abs_uri)
           return fetch_page(abs_uri, request, page)
         else
@@ -435,6 +427,12 @@ class Mechanize
       @history = @history[@history.size - @max_history, @max_history] 
     end
   end
+
+  class Util
+    def self.html_unescape(s)
+      s.to_s.gsub(/&amp;/, "&").gsub(/&quot;/, '"').gsub(/&gt;/, ">").gsub(/&lt;/, "<")
+    end
+  end
 end
 
 end # module WWW

data/lib/mechanize/form.rb

@@ -32,7 +32,7 @@ module WWW
     
         @form_node.attributes ||= {}
         @method = (@form_node.attributes['method'] || 'GET').upcase
-        @action = @form_node.attributes['action'] 
+        @action = Util::html_unescape(@form_node.attributes['action'])
         @name = @form_node.attributes['name']
         @enctype = @form_node.attributes['enctype'] || 'application/x-www-form-urlencoded'
         @clicked_buttons = []
@@ -220,11 +220,31 @@ module WWW
         @mech = mech
       end
 
-      # Fetch the first field whose name is equal to field_name
+      # Returns whether or not the form contains a field with +field_name+
+      def has_field?(field_name)
+        ! fields.find { |f| f.name.eql? field_name }.nil?
+      end
+
+      alias :has_key? :has_field?
+
+      def has_value?(value)
+        ! fields.find { |f| f.value.eql? value }.nil?
+      end
+
+      def keys; fields.map { |f| f.name }; end
+
+      def values; fields.map { |f| f.value }; end
+
+      # Fetch the first field whose name is equal to +field_name+
       def field(field_name)
         fields.find { |f| f.name.eql? field_name }
       end
 
+      # Add a field with +field_name+ and +value+
+      def add_field!(field_name, value = nil)
+        fields << WWW::Mechanize::Field.new(field_name, value)
+      end
+
       # This method sets multiple fields on the form.  It takes a list of field
       # name, value pairs.  If there is more than one field found with the
       # same name, this method will set the first one found.  If you want to
@@ -250,7 +270,8 @@ module WWW
       # Fetch the value set in the input field 'name'
       #  puts form['name']
       def [](field_name)
-        field(field_name).value
+        f = field(field_name)
+        f && f.value
       end
 
       # Set the value of the first input field with the name passed in
@@ -258,7 +279,12 @@ module WWW
       # Set the value in the input field 'name' to "Aaron"
       #  form['name'] = 'Aaron'
       def []=(field_name, value)
-        field(field_name).value = value
+        f = field(field_name)
+        if f.nil?
+          add_field!(field_name, value)
+        else
+          f.value = value
+        end
       end
 
       # Treat form fields like accessors.

data/lib/mechanize/hpricot.rb

@@ -2,14 +2,7 @@ require 'hpricot'
 class Hpricot::Elem
   def all_text
     text = ''
-    children.each do |child|
-      if child.respond_to? :content
-        text << child.content
-      end
-      if child.respond_to? :all_text
-        text << child.all_text
-      end
-    end
+    traverse_text { |t| text << t.content }
     text
   end
 end

data/lib/mechanize/mech_version.rb

@@ -1,5 +1,5 @@
 module WWW
   class Mechanize
-    Version = '0.6.2'
+    Version = '0.6.3'
   end
 end

data/test/htdocs/empty_form.html

@@ -0,0 +1,6 @@
+<html>
+  <body>
+    <form>
+    </form>
+  </body>
+</html>

data/test/htdocs/tc_encoded_links.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <a href="/form_post?a=b&amp;b=c">test link</a>
+  </body>
+</html>

data/test/htdocs/tc_form_action.html

@@ -0,0 +1,48 @@
+<html>
+  <head><title>Page Title</title></head>
+  <body>
+    <h1>Post Form 1</h1>
+    <form name="post_form1" method="post" action="/form_post?a=b&amp;b=c">
+      <table>
+        <tr>
+          <td>First Name</td>
+          <td><input type="text" name="first_name" /></td>
+        </tr>
+      </table><br />
+      <input type="submit" value="Submit" />
+    </form>
+
+    <h1>Post Form 2</h1>
+    <form name="post_form2" method="get" action="/form_post?a=b&amp;b=c">
+      <table>
+        <tr>
+          <td>First Name</td>
+          <td><input type="text" name="first_name" /></td>
+        </tr>
+      </table><br />
+      <input type="submit" value="Submit" />
+    </form>
+
+    <h1>Post Form 3</h1>
+    <form name="post_form3" method="post" action="/form_post?a=b&b=c">
+      <table>
+        <tr>
+          <td>First Name</td>
+          <td><input type="text" name="first_name" /></td>
+        </tr>
+      </table><br />
+      <input type="submit" value="Submit" />
+    </form>
+
+    <h1>Post Form 4</h1>
+    <form name="post_form4" method="post" action="/form_post#1">
+      <table>
+        <tr>
+          <td>First Name</td>
+          <td><input type="text" name="first_name" /></td>
+        </tr>
+      </table><br />
+      <input type="submit" value="Submit" />
+    </form>
+  </body>
+</html>

data/test/tc_encoded_links.rb

@@ -0,0 +1,27 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'test/unit'
+require 'rubygems'
+require 'mechanize'
+require 'test_includes'
+
+class TestEncodedLinks < Test::Unit::TestCase
+  include TestMethods
+
+  def setup
+    @agent = WWW::Mechanize.new
+    @page = @agent.get("http://localhost:#{PORT}/tc_encoded_links.html")
+  end
+
+  def test_click_link
+    link = @page.links.first
+    assert_equal('/form_post?a=b&amp;b=c', link.href)
+    page = @agent.click(link)
+    assert_equal("http://localhost:#{PORT}/form_post?a=b&b=c", page.uri.to_s)
+  end
+
+  def test_hpricot_link
+    page = @agent.click(@page.search('a').first)
+    assert_equal("http://localhost:#{PORT}/form_post?a=b&b=c", page.uri.to_s)
+  end
+end

data/test/tc_form_action.rb

@@ -0,0 +1,52 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'test/unit'
+require 'rubygems'
+require 'mechanize'
+require 'test_includes'
+require 'logger'
+
+class TestFormAction < Test::Unit::TestCase
+  include TestMethods
+
+  def setup
+    @agent = WWW::Mechanize.new
+    @page  = @agent.get("http://localhost:#{PORT}/tc_form_action.html")
+  end
+
+  def test_post_encoded_action
+    form = @page.form('post_form1') { |f|
+      f.first_name = "Aaron"
+    }
+    assert_equal('/form_post?a=b&b=c', form.action)
+    page = form.submit
+    assert_equal("http://localhost:#{PORT}/form_post?a=b&b=c", page.uri.to_s)
+  end
+
+  def test_get_encoded_action
+    form = @page.form('post_form2') { |f|
+      f.first_name = "Aaron"
+    }
+    assert_equal('/form_post?a=b&b=c', form.action)
+    page = form.submit
+    assert_equal("http://localhost:#{PORT}/form_post?first_name=Aaron", page.uri.to_s)
+  end
+
+  def test_post_nonencoded_action
+    form = @page.form('post_form3') { |f|
+      f.first_name = "Aaron"
+    }
+    assert_equal('/form_post?a=b&b=c', form.action)
+    page = form.submit
+    assert_equal("http://localhost:#{PORT}/form_post?a=b&b=c", page.uri.to_s)
+  end
+
+  def test_post_pound_sign
+    form = @page.form('post_form4') { |f|
+      f.first_name = "Aaron"
+    }
+    assert_equal('/form_post#1', form.action)
+    page = form.submit
+    assert_equal("http://localhost:#{PORT}/form_post#1", page.uri.to_s)
+  end
+end

data/test/tc_form_as_hash.rb

@@ -0,0 +1,71 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'webrick'
+require 'test/unit'
+require 'rubygems'
+require 'mechanize'
+require 'test_includes'
+
+class TestFormHash < Test::Unit::TestCase
+  include TestMethods
+
+  def setup
+    @agent = WWW::Mechanize.new
+  end
+
+  def test_form_hash
+    page = @agent.get("http://localhost:#{PORT}/form_multival.html")
+    form = page.forms.name('post_form').first
+
+    assert_not_nil(form)
+    field_length = form.fields.length
+    assert_nil(form['intarweb'])
+    form['intarweb'] = 'Aaron'
+
+    assert_not_nil(form['intarweb'])
+    assert_equal(field_length + 1, form.fields.length)
+  end
+
+  def test_add_field_via_hash
+    page = @agent.get("http://localhost:#{PORT}/form_multival.html")
+    form = page.forms.name('post_form').first
+
+    assert_not_nil(form)
+    field_length = form.fields.length
+    assert_nil(form['intarweb'])
+    form['intarweb'] = 'Aaron'
+
+    assert_not_nil(form['intarweb'])
+    assert_equal(field_length + 1, form.fields.length)
+  end
+
+  def test_fields_as_hash
+    page = @agent.get("http://localhost:#{PORT}/form_multival.html")
+    form = page.forms.name('post_form').first
+
+    assert_not_nil(form)
+    assert_equal(2, form.fields.name('first').length)
+
+    form['first'] = 'Aaron'
+    assert_equal('Aaron', form['first'])
+    assert_equal('Aaron', form.fields.name('first').first.value)
+  end
+
+  def test_keys
+    page = @agent.get("http://localhost:#{PORT}/empty_form.html")
+    form = page.forms.first
+
+    assert_not_nil(form)
+    assert_equal(false, form.has_field?('name'))
+    assert_equal(false, form.has_value?('Aaron'))
+    assert_equal(0, form.keys.length)
+    assert_equal(0, form.values.length)
+    form['name'] = 'Aaron'
+    assert_equal(true, form.has_field?('name'))
+    assert_equal(true, form.has_value?('Aaron'))
+    assert_equal(1, form.keys.length)
+    assert_equal(['name'], form.keys)
+    assert_equal(1, form.values.length)
+    assert_equal(['Aaron'], form.values)
+  end
+end

data/test/tc_forms.rb

@@ -456,7 +456,7 @@ class FormsMechTest < Test::Unit::TestCase
     page = @agent.submit(get_form, get_form.buttons.first)
 
     # Check that the submitted fields exist
-    assert_equal(5, page.links.size, "Not enough links")
+    assert_equal(3, page.links.size, "Not enough links")
     assert_not_nil(
       page.links.find { |l| l.text == "likes ham:on" },
       "likes ham check box missing"
@@ -469,14 +469,6 @@ class FormsMechTest < Test::Unit::TestCase
       page.links.find { |l| l.text == "gender:male" },
       "gender field missing"
     )
-    assert_not_nil(
-      page.links.find { |l| l.text == "great day:yes" },
-      "great day field missing"
-    )
-    assert_not_nil(
-      page.links.find { |l| l.text == "one:two" },
-      "one field missing"
-    )
   end
 
   def test_field_addition
@@ -497,15 +489,26 @@ class FormsMechTest < Test::Unit::TestCase
     assert_equal('Aaron', form.first)
   end
 
-  def test_fields_as_hash
+  def test_add_field
     page = @agent.get("http://localhost:#{PORT}/form_multival.html")
     form = page.forms.name('post_form').first
 
     assert_not_nil(form)
-    assert_equal(2, form.fields.name('first').length)
+    number_of_fields = form.fields.length
 
-    form['first'] = 'Aaron'
-    assert_equal('Aaron', form['first'])
-    assert_equal('Aaron', form.fields.name('first').first.value)
+    f = form.add_field!('intarweb')
+    assert_not_nil(f)
+    assert_equal(number_of_fields + 1, form.fields.length)
+  end
+
+  def test_has_field
+    page = @agent.get("http://localhost:#{PORT}/form_multival.html")
+    form = page.forms.name('post_form').first
+
+    assert_not_nil(form)
+    assert_equal(false, form.has_field?('intarweb'))
+    f = form.add_field!('intarweb')
+    assert_not_nil(f)
+    assert_equal(true, form.has_field?('intarweb'))
   end
 end

data/test/tc_upload.rb

@@ -10,99 +10,94 @@ class UploadMechTest < Test::Unit::TestCase
 
   def setup
     @agent = WWW::Mechanize.new
+    @page = @agent.get("http://localhost:#{PORT}/file_upload.html")
   end
 
   def test_form_enctype
-    page = @agent.get("http://localhost:#{PORT}/file_upload.html")
-    assert_equal('multipart/form-data', page.forms[0].enctype)
+    assert_equal('multipart/form-data', @page.forms[0].enctype)
 
-    form = page.forms.first
+    form = @page.forms.first
     form.file_uploads.first.file_name = "README"
     form.file_uploads.first.mime_type = "text/plain"
     form.file_uploads.first.file_data = "Hello World\n\n"
 
-    page = @agent.submit(form)
+    @page = @agent.submit(form)
 
     assert_match(
       "Content-Disposition: form-data; name=\"userfile1\"; filename=\"README\"",
-      page.body
+      @page.body
     )
     assert_match(
       "Content-Disposition: form-data; name=\"name\"",
-      page.body
+      @page.body
     )
-    assert_match('Content-Type: text/plain', page.body)
-    assert_match('Hello World', page.body)
-    assert_match('foo[aaron]', page.body)
+    assert_match('Content-Type: text/plain', @page.body)
+    assert_match('Hello World', @page.body)
+    assert_match('foo[aaron]', @page.body)
   end
 
   def test_form_multipart
-    page = @agent.get("http://localhost:#{PORT}/file_upload.html")
-    assert_equal('multipart/form-data', page.forms[1].enctype)
+    assert_equal('multipart/form-data', @page.forms[1].enctype)
 
-    form = page.forms[1]
+    form = @page.forms[1]
     form.file_uploads.first.file_name = "README"
     form.file_uploads.first.mime_type = "text/plain"
     form.file_uploads.first.file_data = "Hello World\n\n"
 
-    page = @agent.submit(form)
+    @page = @agent.submit(form)
 
     assert_match(
       "Content-Disposition: form-data; name=\"green[eggs]\"; filename=\"README\"",
-      page.body
+      @page.body
     )
   end
 
   def test_form_read_file
-    page = @agent.get("http://localhost:#{PORT}/file_upload.html")
-    assert_equal('multipart/form-data', page.forms[1].enctype)
+    assert_equal('multipart/form-data', @page.forms[1].enctype)
 
-    form = page.forms[1]
+    form = @page.forms[1]
     form.file_uploads.first.file_name = "README"
 
-    page = @agent.submit(form)
+    @page = @agent.submit(form)
 
     contents = File.open("README", 'rb') { |f| f.read }
     assert_match(
       "Content-Disposition: form-data; name=\"green[eggs]\"; filename=\"README\"",
-      page.body
+      @page.body
     )
-    assert_match(contents, page.body)
+    assert_match(contents, @page.body)
   end
 
   def test_form_io_obj
-    page = @agent.get("http://localhost:#{PORT}/file_upload.html")
-    assert_equal('multipart/form-data', page.forms[1].enctype)
+    assert_equal('multipart/form-data', @page.forms[1].enctype)
 
-    form = page.forms[1]
+    form = @page.forms[1]
     form.file_uploads.first.file_name = "README"
     form.file_uploads.first.file_data = File.open("README", 'rb')
 
-    page = @agent.submit(form)
+    @page = @agent.submit(form)
 
     contents = File.open("README", 'rb') { |f| f.read }
     assert_match(
       "Content-Disposition: form-data; name=\"green[eggs]\"; filename=\"README\"",
-      page.body
+      @page.body
     )
-    assert_match(contents, page.body)
+    assert_match(contents, @page.body)
   end
 
   def test_submit_no_file
-    page = @agent.get("http://localhost:#{PORT}/file_upload.html")
-    form = page.forms.first
+    form = @page.forms.first
     form.fields.name('name').value = 'Aaron'
-    page = @agent.submit(form)
-    assert_match('Aaron', page.body)
+    @page = @agent.submit(form)
+    assert_match('Aaron', @page.body)
     assert_match(
       "Content-Disposition: form-data; name=\"userfile1\"; filename=\"\"",
-      page.body
+      @page.body
     )
   end
 
   def test_no_value
-    page = @agent.get("http://localhost:#{PORT}/file_upload.html")
-    form = page.form('value_test')
+    form = @page.form('value_test')
     assert_nil(form.file_uploads.first.value)
     assert_nil(form.file_uploads.first.file_name)
   end

data/test/ts_mech.rb

@@ -41,6 +41,7 @@ require 'tc_textarea'
 require 'tc_no_attributes'
 require 'tc_gzipping'
 require 'tc_referer'
+require 'tc_form_as_hash'
 #require 'tc_proxy'
 #require 'tc_ssl_server'
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: mechanize
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
-date: 2006-10-10 00:00:00 -07:00
+  version: 0.6.3
+date: 2006-11-05 00:00:00 -08:00
 summary: Mechanize provides automated web-browsing
 require_paths: 
   - lib
@@ -43,7 +43,10 @@ files:
   - test/tc_cookie_class.rb
   - test/tc_cookie_jar.rb
   - test/tc_cookies.rb
+  - test/tc_encoded_links.rb
   - test/tc_errors.rb
+  - test/tc_form_action.rb
+  - test/tc_form_as_hash.rb
   - test/tc_form_no_inputname.rb
   - test/tc_forms.rb
   - test/tc_frames.rb
@@ -80,6 +83,7 @@ files:
   - test/htdocs/alt_text.html
   - test/htdocs/bad_form_test.html
   - test/htdocs/button.jpg
+  - test/htdocs/empty_form.html
   - test/htdocs/file_upload.html
   - test/htdocs/find_link.html
   - test/htdocs/form_multi_select.html
@@ -100,6 +104,8 @@ files:
   - test/htdocs/no_title_test.html
   - test/htdocs/tc_bad_links.html
   - test/htdocs/tc_checkboxes.html
+  - test/htdocs/tc_encoded_links.html
+  - test/htdocs/tc_form_action.html
   - test/htdocs/tc_links.html
   - test/htdocs/tc_no_attributes.html
   - test/htdocs/tc_pretty_print.html