mechanize 2.0.1 → 2.1.pre.1

data/lib/mechanize/form/button.rb

@@ -1,9 +1,6 @@
-class Mechanize
-  class Form
-    # This class represents a Submit button in a form.
-    class Button < Field ; end
-    class Submit < Button; end
-    class Reset  < Button; end
-  end
+##
+# A Submit button in a Form
+
+class Mechanize::Form::Button < Mechanize::Form::Field
 end
 

data/lib/mechanize/form/check_box.rb

@@ -1,11 +1,12 @@
-class Mechanize
-  class Form
-    # This class represents a check box found in a Form.  To activate the
-    # CheckBox in the Form, set the checked method to true.
-    class CheckBox < RadioButton
-      def query_value
-        [[@name, @value || "on"]]
-      end
-    end
+##
+# This class represents a check box found in a Form.  To activate the CheckBox
+# in the Form, set the checked method to true.
+
+class Mechanize::Form::CheckBox < Mechanize::Form::RadioButton
+
+  def query_value
+    [[@name, @value || "on"]]
   end
+
 end
+

data/lib/mechanize/form/field.rb

@@ -1,44 +1,54 @@
-class Mechanize
-  class Form
-    # This class represents a field in a form.  It handles the following input
-    # tags found in a form:
-    # text, password, hidden, int, textarea
-    #
-    # To set the value of a field, just use the value method:
-    # field.value = "foo"
-    class Field
-      attr_accessor :name, :value, :node
-
-      def initialize node, value = node['value']
-        @node = node
-        @name = Util.html_unescape(node['name'])
-        @value = if value.is_a? String
-                   Util.html_unescape(value)
-                 else
-                   value
-                 end
-      end
-
-      def query_value
-        [[@name, @value || '']]
-      end
-
-      def <=> other
-        return 0 if self == other
-        return 1 if Hash === node
-        return -1 if Hash === other.node
-        node <=> other.node
-      end
-
-      # This method is a shortcut to get field's DOM id.
-      # Common usage: form.field_with(:dom_id => "foo")
-      def dom_id
-        node['id']
-      end
-    end
-
-    class Text     < Field; end
-    class Textarea < Field; end
-    class Hidden   < Field; end
+##
+# This class represents a field in a form.  It handles the following input
+# tags found in a form:
+#
+# * text
+# * password
+# * hidden
+# * int
+# * textarea
+# * keygen
+#
+# To set the value of a field, just use the value method:
+#
+#   field.value = "foo"
+
+class Mechanize::Form::Field
+  attr_accessor :name, :value, :node, :type
+
+  def initialize node, value = node['value']
+    @node = node
+    @name = Mechanize::Util.html_unescape(node['name'])
+    @value = if value.is_a? String
+               Mechanize::Util.html_unescape(value)
+             else
+               value
+             end
+
+    @type = node['type']
+  end
+
+  def query_value
+    [[@name, @value || '']]
+  end
+
+  def <=> other
+    return 0 if self == other
+    return 1 if Hash === node
+    return -1 if Hash === other.node
+    node <=> other.node
+  end
+
+  # This method is a shortcut to get field's DOM id.
+  # Common usage: form.field_with(:dom_id => "foo")
+  def dom_id
+    node['id']
+  end
+
+  # This method is a shortcut to get field's DOM id.
+  # Common usage: form.field_with(:dom_class => "foo")
+  def dom_class
+    node['class']
   end
 end
+

data/lib/mechanize/form/file_upload.rb

@@ -1,23 +1,21 @@
-class Mechanize
-  class Form
-    # This class represents a file upload field found in a form.  To use this
-    # class, set FileUpload#file_data= to the data of the file you want
-    # to upload and FileUpload#mime_type= to the appropriate mime type
-    # of the file.
-    # See the example in EXAMPLES[link://files/EXAMPLES_txt.html]
-    class FileUpload < Field
-      attr_accessor :file_name # File name
-      attr_accessor :mime_type # Mime Type (Optional)
+# This class represents a file upload field found in a form.  To use this
+# class, set FileUpload#file_data= to the data of the file you want to upload
+# and FileUpload#mime_type= to the appropriate mime type of the file.
+#
+# See the example in EXAMPLES
 
-      alias :file_data :value
-      alias :file_data= :value=
+class Mechanize::Form::FileUpload < Mechanize::Form::Field
+  attr_accessor :file_name # File name
+  attr_accessor :mime_type # Mime Type (Optional)
 
-        def initialize node, file_name
-          @file_name = Util.html_unescape(file_name)
-          @file_data = nil
-          @node      = node
-          super(node, @file_data)
-        end
-    end
+  alias :file_data :value
+  alias :file_data= :value=
+
+  def initialize node, file_name
+    @file_name = Mechanize::Util.html_unescape(file_name)
+    @file_data = nil
+    @node      = node
+    super(node, @file_data)
   end
 end
+

data/lib/mechanize/form/hidden.rb

@@ -0,0 +1,3 @@
+class Mechanize::Form::Hidden < Mechanize::Form::Field
+end
+

data/lib/mechanize/form/image_button.rb

@@ -1,20 +1,19 @@
-class Mechanize
-  class Form
-    # This class represents an image button in a form.  Use the x and y methods
-    # to set the x and y positions for where the mouse "clicked".
-    class ImageButton < Button
-      attr_accessor :x, :y
+##
+# This class represents an image button in a form.  Use the x and y methods to
+# set the x and y positions for where the mouse "clicked".
 
-      def initialize *args
-        @x = nil
-        @y = nil
-        super
-      end
+class Mechanize::Form::ImageButton < Mechanize::Form::Button
+  attr_accessor :x, :y
 
-      def query_value
-        [["#{@name}.x", (@x || 0).to_s],
-         ["#{@name}.y", (@y || 0).to_s]]
-      end
-    end
+  def initialize *args
+    @x = nil
+    @y = nil
+    super
+  end
+
+  def query_value
+    [["#{@name}.x", (@x || 0).to_s],
+     ["#{@name}.y", (@y || 0).to_s]]
   end
 end
+

data/lib/mechanize/form/keygen.rb

@@ -0,0 +1,34 @@
+##
+# This class represents a keygen (public / private key generator) found in a
+# Form. The field will automatically generate a key pair and compute its own
+# value to match the challenge. Call key to access the public/private key
+# pair.
+
+class Mechanize::Form::Keygen < Mechanize::Form::Field
+  # The challenge for this <keygen>.
+  attr_reader :challenge
+
+  # The key associated with this <keygen> tag.
+  attr_reader :key
+
+  def initialize(node, value = nil)
+    super
+    @challenge = node['challenge']
+
+    @spki = OpenSSL::Netscape::SPKI.new
+    @spki.challenge = @challenge
+
+    @key = nil
+    generate_key if value.nil? || value.empty?
+  end
+
+  # Generates a key pair and sets the field's value.
+  def generate_key(key_size = 2048)
+    # Spec at http://dev.w3.org/html5/spec/Overview.html#the-keygen-element
+    @key = OpenSSL::PKey::RSA.new key_size
+    @spki.public_key = @key.public_key
+    @spki.sign @key, OpenSSL::Digest::MD5.new
+    self.value = @spki.to_pem
+  end
+end
+

data/lib/mechanize/form/multi_select_list.rb

@@ -1,15 +1,18 @@
+##
 # This class represents a select list where multiple values can be selected.
 # MultiSelectList#value= accepts an array, and those values are used as
 # values for the select list.  For example, to select multiple values,
 # simply do this:
 #
-#  list.value = ['one', 'two']
+#   list.value = ['one', 'two']
 #
 # Single values are still supported, so these two are the same:
 #
-#  list.value = ['one']
-#  list.value = 'one'
+#   list.value = ['one']
+#   list.value = 'one'
+
 class Mechanize::Form::MultiSelectList < Mechanize::Form::Field
+
   extend Mechanize::ElementMatcher
 
   attr_accessor :options
@@ -20,20 +23,28 @@ class Mechanize::Form::MultiSelectList < Mechanize::Form::Field
 
     # parse
     node.search('option').each do |n|
-      option = Mechanize::Form::Option.new(n, self)
-      @options << option
+      @options << Mechanize::Form::Option.new(n, self)
     end
-    super(node, value)
+
+    super node, value
   end
 
   ##
+  # :method: option_with
+  #
   # Find one option on this select list with +criteria+
+  #
   # Example:
+  #
   #   select_list.option_with(:value => '1').value = 'foo'
 
   ##
+  # :method: options_with
+  #
   # Find all options on this select list with +criteria+
+  #
   # Example:
+  #
   #   select_list.options_with(:value => /1|2/).each do |field|
   #     field.value = '20'
   #   end
@@ -41,7 +52,7 @@ class Mechanize::Form::MultiSelectList < Mechanize::Form::Field
   elements_with :option
 
   def query_value
-    value ? value.collect { |v| [name, v] } : ''
+    value ? value.map { |v| [name, v] } : ''
   end
 
   # Select no options
@@ -75,8 +86,8 @@ class Mechanize::Form::MultiSelectList < Mechanize::Form::Field
 
   def value
     value = []
-    value.push(*@value)
-    value.push(*selected_options.collect { |o| o.value })
+    value.concat @value
+    value.concat selected_options.map { |o| o.value }
     value
   end
 

data/lib/mechanize/form/option.rb

@@ -1,49 +1,50 @@
-class Mechanize
-  class Form
-    # This class contains option an option found within SelectList.  A
-    # SelectList can have many Option classes associated with it.  An option
-    # can be selected by calling Option#tick, or Option#click.  For example,
-    # select the first option in a list:
-    #  select_list.first.tick
-    class Option
-      attr_reader :value, :selected, :text, :select_list
-
-      alias :to_s :value
-      alias :selected? :selected
-
-      def initialize(node, select_list)
-        @text     = node.inner_text
-        @value    = Util.html_unescape(node['value'] || node.inner_text)
-        @selected = node.has_attribute? 'selected'
-        @select_list = select_list # The select list this option belongs to
-      end
-
-      # Select this option
-      def select
-        unselect_peers
-        @selected = true
-      end
-
-      # Unselect this option
-      def unselect
-        @selected = false
-      end
-
-      alias :tick   :select
-      alias :untick :unselect
-
-      # Toggle the selection value of this option
-      def click
-        unselect_peers
-        @selected = !@selected
-      end
-
-      private
-      def unselect_peers
-        if @select_list.instance_of? SelectList
-          @select_list.select_none
-        end
-      end
-    end
+##
+# This class contains an option found within SelectList.  A SelectList can
+# have many Option classes associated with it.  An option can be selected by
+# calling Option#tick, or Option#click.
+#
+# To select the first option in a list:
+#
+#   select_list.first.tick
+
+class Mechanize::Form::Option
+  attr_reader :value, :selected, :text, :select_list
+
+  alias :to_s :value
+  alias :selected? :selected
+
+  def initialize(node, select_list)
+    @text     = node.inner_text
+    @value    = Mechanize::Util.html_unescape(node['value'] || node.inner_text)
+    @selected = node.has_attribute? 'selected'
+    @select_list = select_list # The select list this option belongs to
+  end
+
+  # Select this option
+  def select
+    unselect_peers
+    @selected = true
+  end
+
+  # Unselect this option
+  def unselect
+    @selected = false
+  end
+
+  alias :tick   :select
+  alias :untick :unselect
+
+  # Toggle the selection value of this option
+  def click
+    unselect_peers
+    @selected = !@selected
+  end
+
+  private
+  def unselect_peers
+    return unless Mechanize::Form::SelectList === @select_list
+
+    @select_list.select_none
   end
 end
+

data/lib/mechanize/form/radio_button.rb

@@ -1,48 +1,55 @@
-class Mechanize
-  class Form
-    # This class represents a radio button found in a Form.  To activate the
-    # RadioButton in the Form, set the checked method to true.
-    class RadioButton < Field
-      attr_accessor :checked
-
-      def initialize node, form
-        @checked = !!node['checked']
-        @form    = form
-        super(node)
-      end
-
-      def check
-        uncheck_peers
-        @checked = true
-      end
-
-      def uncheck
-        @checked = false
-      end
-
-      def click
-        checked ? uncheck : check
-      end
-
-      def label
-        (id = self['id']) && @form.page.labels_hash[id] || nil
-      end
-
-      def text
-        label.text rescue nil
-      end
-
-      def [](key)
-        @node[key]
-      end
-
-      private
-      def uncheck_peers
-        @form.radiobuttons_with(:name => name).each do |b|
-          next if b.value == value
-          b.uncheck
-        end
-      end
+##
+# This class represents a radio button found in a Form.  To activate the
+# RadioButton in the Form, set the checked method to true.
+
+class Mechanize::Form::RadioButton < Mechanize::Form::Field
+  attr_accessor :checked
+
+  def initialize node, form
+    @checked = !!node['checked']
+    @form    = form
+    super(node)
+  end
+
+  def check
+    uncheck_peers
+    @checked = true
+  end
+
+  alias checked? checked
+
+  def uncheck
+    @checked = false
+  end
+
+  def click
+    checked ? uncheck : check
+  end
+
+  def label
+    (id = self['id']) && @form.page.labels_hash[id] || nil
+  end
+
+  def text
+    label.text rescue nil
+  end
+
+  def [](key)
+    @node[key]
+  end
+
+  def pretty_print_instance_variables # :nodoc:
+    [:@checked, :@name, :@value]
+  end
+
+  private
+
+  def uncheck_peers
+    @form.radiobuttons_with(:name => name).each do |b|
+      next if b.value == value
+      b.uncheck
     end
   end
+
 end
+