Object
This class encapsulates a form parsed out of an HTML page. Each type of input fields available in a form can be accessed through this object. See GlobalForm for more methods.
Find a form and print out its fields
form = page.forms.first # => Mechanize::Form form.fields.each { |f| puts f.name }
Set the input field 'name' to "Aaron"
form['name'] = 'Aaron' puts form['name']
# File lib/mechanize/form.rb, line 35 def initialize(node, mech=nil, page=nil) @enctype = node['enctype'] || 'application/x-www-form-urlencoded' @form_node = node @action = Util.html_unescape(node['action']) @method = (node['method'] || 'GET').upcase @name = node['name'] @clicked_buttons = [] @page = page @mech = mech parse end
Fetch the value of the first input field with the name passed in
Fetch the value set in the input field 'name'
puts form['name']
# File lib/mechanize/form.rb, line 120 def [](field_name) f = field(field_name) f && f.value end
Set the value of the first input field with the name passed in
Set the value in the input field 'name' to "Aaron"
form['name'] = 'Aaron'
# File lib/mechanize/form.rb, line 129 def []=(field_name, value) f = field(field_name) if f.nil? add_field!(field_name, value) else f.value = value end end
Add a field with field_name and value
# File lib/mechanize/form.rb, line 85 def add_field!(field_name, value = nil) fields << Field.new({'name' => field_name}, value) end
This method builds an array of arrays that represent the query parameters to be used with this form. The return value can then be used to create a query string for this form.
# File lib/mechanize/form.rb, line 177 def build_query(buttons = []) query = [] (fields + checkboxes).sort.each do |f| case f when Form::CheckBox if f.checked qval = proc_query(f) query.push(*qval) end when Form::Field qval = proc_query(f) query.push(*qval) end end radio_groups = {} radiobuttons.each do |f| fname = from_native_charset(f.name) radio_groups[fname] ||= [] radio_groups[fname] << f end # take one radio button from each group radio_groups.each_value do |g| checked = g.select {|f| f.checked} if checked.size == 1 f = checked.first qval = proc_query(f) query.push(*qval) elsif checked.size > 1 raise "multiple radiobuttons are checked in the same group!" end end @clicked_buttons.each { |b| qval = proc_query(b) query.push(*qval) } query end
Find one checkbox that matches criteria Example:
form.checkbox_with(:name => /woo/).check
# File lib/mechanize/form.rb, line 321
Find all checkboxes that match criteria Example:
form.checkboxes_with(:name => /woo/).each do |field| field.check end
# File lib/mechanize/form.rb, line 330
Removes all fields with name field_name.
# File lib/mechanize/form.rb, line 246 def delete_field!(field_name) @fields.delete_if{ |f| f.name == field_name} end
This method is a shortcut to get form's DOM id. Common usage:
page.form_with(:dom_id => "foorm")
Note that you can also use :id to get to this method:
page.form_with(:id => "foorm")
# File lib/mechanize/form.rb, line 80 def dom_id form_node['id'] end
Find one field that matches criteria Example:
form.field_with(:id => "exact_field_id").value = 'hello'
# File lib/mechanize/form.rb, line 257
Find all fields that match criteria Example:
form.fields_with(:value => /foo/).each do |field| field.value = 'hello!' end
# File lib/mechanize/form.rb, line 266
Find one file upload field that matches criteria Example:
form.file_upload_with(:file_name => /picture/).value = 'foo'
# File lib/mechanize/form.rb, line 289
Find all file upload fields that match criteria Example:
form.file_uploads_with(:file_name => /picutre/).each do |field| field.value = 'foo!' end
# File lib/mechanize/form.rb, line 298
Returns whether or not the form contains a field with field_name
# File lib/mechanize/form.rb, line 49 def has_field?(field_name) ! fields.find { |f| f.name.eql? field_name }.nil? end
# File lib/mechanize/form.rb, line 55 def has_value?(value) ! fields.find { |f| f.value.eql? value }.nil? end
# File lib/mechanize/form.rb, line 59 def keys; fields.map { |f| f.name }; end
Treat form fields like accessors.
# File lib/mechanize/form.rb, line 139 def method_missing(id,*args) method = id.to_s.gsub(/=$/, '') if field(method) return field(method).value if args.empty? return field(method).value = args[0] end super end
This method calculates the request data to be sent back to the server for this form, depending on if this is a regular post, get, or a multi-part post,
# File lib/mechanize/form.rb, line 229 def request_data query_params = build_query() case @enctype.downcase when /^multipart\/form-data/ boundary = rand_string(20) @enctype = "multipart/form-data; boundary=#{boundary}" params = [] query_params.each { |k,v| params << param_to_multipart(k, v) unless k.nil? } @file_uploads.each { |f| params << file_to_multipart(f) } params.collect { |p| "--#{boundary}\r\n#{p.respond_to?(:force_encoding) ? p.force_encoding('ASCII-8BIT') : p}" }.join('') + "--#{boundary}--\r\n" else Mechanize::Util.build_query_string(query_params) end end
# File lib/mechanize/form.rb, line 64 def resets ; @resets ||= buttons.select { |f| f.class == Reset }; 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 set the value of a duplicate field, use a value which is a Hash with the key as the index in to the form. The index is zero based. For example, to set the second field named 'foo', you could do the following:
form.set_fields( :foo => { 1 => 'bar' } )
# File lib/mechanize/form.rb, line 97 def set_fields(fields = {}) fields.each do |k,v| case v when Hash v.each do |index, value| self.fields_with(:name => k.to_s).[](index).value = value end else value = nil index = 0 [v].flatten.each do |val| index = val.to_i unless value.nil? value = val if value.nil? end self.fields_with(:name => k.to_s).[](index).value = value end end end
Submit this form with the button passed in
# File lib/mechanize/form.rb, line 149 def submit button=nil, headers = {} @mech.submit(self, button, headers) end
# File lib/mechanize/form.rb, line 63 def submits ; @submits ||= buttons.select { |f| f.class == Submit }; end
# File lib/mechanize/form.rb, line 71 def text_field?(field_name) !! texts.find{|f| f.name == field_name}; end
# File lib/mechanize/form.rb, line 73 def textarea_field?(field_name) !!textareas.find{|f| f.name == field_name}; end
# File lib/mechanize/form.rb, line 67 def textareas; @textareas ||= fields.select { |f| f.class == Textarea }; end
Generated with the Darkfish Rdoc Generator 2.