Class: Mechanize::PluggableParser

Inherits:
Object
  • Object
show all
Defined in:
lib/mechanize/pluggable_parsers.rb

Overview

Synopsis

This class is used to register and maintain pluggable parsers for Mechanize to use.

A Pluggable Parser is a parser that Mechanize uses for any particular content type. Mechanize will ask PluggableParser for the class it should initialize given any content type. This class allows users to register their own pluggable parsers, or modify existing pluggable parsers.

PluggableParser returns a Mechanize::File object for content types that it does not know how to handle. Mechanize::File provides basic functionality for any content type, so it is a good class to extend when building your own parsers.

Example

To create your own parser, just create a class that takes four parameters in the constructor. Here is an example of registering a pluggable parser that handles CSV files:

class CSVParser < Mechanize::File
  attr_reader :csv
  def initialize(uri=nil, response=nil, body=nil, code=nil)
    super(uri, response, body, code)
    @csv = CSV.parse(body)
  end
end
agent = Mechanize.new
agent.pluggable_parser.csv = CSVParser
agent.get('http://example.com/test.csv')  # => CSVParser

Now any page that returns the content type of ‘text/csv’ will initialize a CSVParser and return that object to the caller.

To register a pluggable parser for a content type that pluggable parser does not know about, just use the hash syntax:

agent.pluggable_parser['text/something'] = SomeClass

To set the default parser, just use the ‘defaut’ method:

agent.pluggable_parser.default = SomeClass

Now all unknown content types will be instances of SomeClass.

Constant Summary collapse

CONTENT_TYPES = 
{
  :html => 'text/html',
  :wap  => 'application/vnd.wap.xhtml+xml',
  :xhtml => 'application/xhtml+xml',
  :pdf  => 'application/pdf',
  :csv  => 'text/csv',
  :xml  => 'text/xml',
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PluggableParser

Returns a new instance of PluggableParser.



56
57
58
59
60
61
62
 
# File 'lib/mechanize/pluggable_parsers.rb', line 56

def initialize
  @parsers = { CONTENT_TYPES[:html]   => Page,
    CONTENT_TYPES[:xhtml]  => Page,
    CONTENT_TYPES[:wap]    => Page,
  }
  @default = File
end

Instance Attribute Details

#default ⇒ Object

Returns the value of attribute default.



54
55
56
 
# File 'lib/mechanize/pluggable_parsers.rb', line 54

def default
  @default
end

Instance Method Details

#[](content_type) ⇒ Object 



93
94
95
 
# File 'lib/mechanize/pluggable_parsers.rb', line 93

def [](content_type)
  @parsers[content_type]
end

#[]=(content_type, klass) ⇒ Object 



97
98
99
 
# File 'lib/mechanize/pluggable_parsers.rb', line 97

def []=(content_type, klass)
  @parsers[content_type] = klass
end

#csv=(klass) ⇒ Object 



85
86
87
 
# File 'lib/mechanize/pluggable_parsers.rb', line 85

def csv=(klass)
  register_parser(CONTENT_TYPES[:csv], klass)
end

#html=(klass) ⇒ Object 



72
73
74
75
 
# File 'lib/mechanize/pluggable_parsers.rb', line 72

def html=(klass)
  register_parser(CONTENT_TYPES[:html], klass)
  register_parser(CONTENT_TYPES[:xhtml], klass)
end

#parser(content_type) ⇒ Object 



64
65
66
 
# File 'lib/mechanize/pluggable_parsers.rb', line 64

def parser(content_type)
  content_type.nil? ? default : @parsers[content_type] || default
end

#pdf=(klass) ⇒ Object 



81
82
83
 
# File 'lib/mechanize/pluggable_parsers.rb', line 81

def pdf=(klass)
  register_parser(CONTENT_TYPES[:pdf], klass)
end

#register_parser(content_type, klass) ⇒ Object 



68
69
70
 
# File 'lib/mechanize/pluggable_parsers.rb', line 68

def register_parser(content_type, klass)
  @parsers[content_type] = klass
end

#xhtml=(klass) ⇒ Object 



77
78
79
 
# File 'lib/mechanize/pluggable_parsers.rb', line 77

def xhtml=(klass)
  register_parser(CONTENT_TYPES[:xhtml], klass)
end

#xml=(klass) ⇒ Object 



89
90
91
 
# File 'lib/mechanize/pluggable_parsers.rb', line 89

def xml=(klass)
  register_parser(CONTENT_TYPES[:xml], klass)
end