tenderlove-mechanize 0.9.3.20090623142847 → 0.9.3.20090911221705

data/lib/mechanize/form/button.rb

@@ -0,0 +1,9 @@
+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
+end
+

data/lib/mechanize/form/check_box.rb

@@ -0,0 +1,11 @@
+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
+  end
+end

data/lib/mechanize/form/field.rb

@@ -0,0 +1,30 @@
+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
+
+      def initialize(name, value)
+        @name = Util.html_unescape(name)
+        @value = if value.is_a? String
+                   Util.html_unescape(value)
+                 else
+                   value
+                 end
+      end
+
+      def query_value
+        [[@name, @value || '']]
+      end
+    end
+
+    class Text     < Field; end
+    class Textarea < Field; end
+    class Hidden   < Field; end
+  end
+end

data/lib/mechanize/form/file_upload.rb

@@ -0,0 +1,22 @@
+class Mechanize
+  class Form
+    # This class represents a file upload field found in a form.  To use this
+    # class, set WWW::FileUpload#file_data= to the data of the file you want
+    # to upload and WWW::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)
+
+      alias :file_data :value
+      alias :file_data= :value=
+
+        def initialize(name, file_name)
+          @file_name = Util.html_unescape(file_name)
+          @file_data = nil
+          super(name, @file_data)
+        end
+    end
+  end
+end

data/lib/mechanize/form/image_button.rb

@@ -0,0 +1,21 @@
+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
+
+      def initialize(name, value)
+        @x = nil
+        @y = nil
+        super(name, value)
+      end
+
+      def query_value
+        super <<
+          [@name + ".x", (@x || 0).to_s] <<
+          [@name + ".y", (@y || 0).to_s]
+      end
+    end
+  end
+end

data/lib/mechanize/form/multi_select_list.rb

@@ -0,0 +1,67 @@
+class Mechanize
+  class Form
+    # 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']
+    # Single values are still supported, so these two are the same:
+    #  list.value = ['one']
+    #  list.value = 'one'
+    class MultiSelectList < Field
+      attr_accessor :options
+
+      def initialize(name, node)
+        value = []
+        @options = []
+
+        # parse
+        node.search('option').each do |n|
+          option = Option.new(n, self)
+          @options << option
+        end
+        super(name, value)
+      end
+
+      def query_value
+        value ? value.collect { |v| [name, v] } : ''
+      end
+
+      # Select no options
+      def select_none
+        @value = []
+        options.each { |o| o.untick }
+      end
+
+      # Select all options
+      def select_all
+        @value = []
+        options.each { |o| o.tick }
+      end
+
+      # Get a list of all selected options
+      def selected_options
+        @options.find_all { |o| o.selected? }
+      end
+
+      def value=(values)
+        select_none
+        [values].flatten.each do |value|
+          option = options.find { |o| o.value == value }
+          if option.nil?
+            @value.push(value)
+          else
+            option.select
+          end
+        end
+      end
+
+      def value
+        value = []
+        value.push(*@value)
+        value.push(*selected_options.collect { |o| o.value })
+        value
+      end
+    end
+  end
+end

data/lib/mechanize/form/option.rb

@@ -0,0 +1,49 @@
+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
+  end
+end

data/lib/mechanize/form/radio_button.rb

@@ -0,0 +1,49 @@
+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(name, value, checked, form, node)
+        @checked = checked
+        @form    = form
+        @node    = node
+        super(name, value)
+      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
+    end
+  end
+end

data/lib/mechanize/form/select_list.rb

@@ -0,0 +1,43 @@
+class Mechanize
+  class Form
+    # This class represents a select list or drop down box in a Form.  Set the
+    # value for the list by calling SelectList#value=.  SelectList contains a
+    # list of Option that were found.  After finding the correct option, set
+    # the select lists value to the option value:
+    #  selectlist.value = selectlist.options.first.value
+    # Options can also be selected by "clicking" or selecting them.  See Option
+    class SelectList < MultiSelectList
+      def initialize(name, node)
+        super(name, node)
+        if selected_options.length > 1
+          selected_options.reverse[1..selected_options.length].each do |o|
+            o.unselect
+          end
+        end
+      end
+
+      def value
+        value = super
+        if value.length > 0
+          value.last
+        elsif @options.length > 0
+          @options.first.value
+        else
+          nil
+        end
+      end
+
+      def value=(new)
+        if new != new.to_s and new.respond_to? :first
+          super([new.first])
+        else
+          super([new.to_s])
+        end
+      end
+
+      def query_value
+        value ? [[name, value]] : nil
+      end
+    end
+  end
+end

data/lib/mechanize/headers.rb

@@ -0,0 +1,11 @@
+class Mechanize
+  class Headers < Hash
+    def [](key)
+      super(key.downcase)
+    end
+    def []=(key, value)
+      super(key.downcase, value)
+    end
+  end
+end
+

data/lib/mechanize/history.rb

@@ -0,0 +1,65 @@
+class Mechanize
+  ##
+  # This class manages history for your mechanize object.
+  class History < Array
+    attr_accessor :max_size
+
+    def initialize(max_size = nil)
+      @max_size       = max_size
+      @history_index  = {}
+    end
+
+    def initialize_copy(orig)
+      super
+      @history_index = orig.instance_variable_get(:@history_index).dup
+    end
+
+    def push(page, uri = nil)
+      super(page)
+      @history_index[(uri ? uri : page.uri).to_s] = page
+      if @max_size && self.length > @max_size
+        while self.length > @max_size
+          self.shift
+        end
+      end
+      self
+    end
+    alias :<< :push
+
+    def visited?(url)
+      ! visited_page(url).nil?
+    end
+
+    def visited_page(url)
+      @history_index[(url.respond_to?(:uri) ? url.uri : url).to_s]
+    end
+
+    def clear
+      @history_index.clear
+      super
+    end
+
+    def shift
+      return nil if length == 0
+      page    = self[0]
+      self[0] = nil
+      super
+      remove_from_index(page)
+      page
+    end
+
+    def pop
+      return nil if length == 0
+      page = super
+      remove_from_index(page)
+      page
+    end
+
+    private
+    def remove_from_index(page)
+      @history_index.each do |k,v|
+        @history_index.delete(k) if v == page
+      end
+    end
+  end
+end

data/lib/mechanize/inspect.rb

@@ -0,0 +1,88 @@
+require 'pp'
+
+# :stopdoc:
+class Mechanize
+  def pretty_print(q)
+    q.object_group(self) {
+      q.breakable
+      q.pp cookie_jar
+      q.breakable
+      q.pp current_page
+    }
+  end
+
+  class Page
+    def pretty_print(q)
+      q.object_group(self) {
+        q.breakable
+        q.group(1, '{url', '}') {q.breakable; q.pp uri }
+        q.breakable
+        q.group(1, '{meta', '}') {
+          meta.each { |link| q.breakable; q.pp link }
+        }
+        q.breakable
+        q.group(1, '{title', '}') { q.breakable; q.pp title }
+        q.breakable
+        q.group(1, '{iframes', '}') {
+          iframes.each { |link| q.breakable; q.pp link }
+        }
+        q.breakable
+        q.group(1, '{frames', '}') {
+          frames.each { |link| q.breakable; q.pp link }
+        }
+        q.breakable
+        q.group(1, '{links', '}') {
+          links.each { |link| q.breakable; q.pp link }
+        }
+        q.breakable
+        q.group(1, '{forms', '}') {
+          forms.each { |form| q.breakable; q.pp form }
+        }
+      }
+    end
+
+    class Link
+      def pretty_print(q)
+        q.object_group(self) {
+          q.breakable; q.pp text
+          q.breakable; q.pp href
+        }
+      end
+    end
+  end
+
+  class Form
+    def pretty_print(q)
+      q.object_group(self) {
+        q.breakable; q.group(1, '{name', '}') { q.breakable; q.pp name }
+        q.breakable; q.group(1, '{method', '}') { q.breakable; q.pp method }
+        q.breakable; q.group(1, '{action', '}') { q.breakable; q.pp action }
+        q.breakable; q.group(1, '{fields', '}') {
+          fields.each do |field|
+            q.breakable
+            q.pp field
+          end
+        }
+        q.breakable; q.group(1, '{radiobuttons', '}') {
+          radiobuttons.each { |b| q.breakable; q.pp b }
+        }
+        q.breakable; q.group(1, '{checkboxes', '}') {
+          checkboxes.each { |b| q.breakable; q.pp b }
+        }
+        q.breakable; q.group(1, '{file_uploads', '}') {
+          file_uploads.each { |b| q.breakable; q.pp b }
+        }
+        q.breakable; q.group(1, '{buttons', '}') {
+          buttons.each { |b| q.breakable; q.pp b }
+        }
+      }
+    end
+
+    class RadioButton
+      def pretty_print_instance_variables
+        [:@checked, :@name, :@value]
+      end
+    end
+  end
+end
+# :startdoc: