Class | WWW::Mechanize::PluggableParser |
In: |
lib/www/mechanize/pluggable_parsers.rb
|
Parent: | Object |
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 WWW::Mechanize::File object for content types that it does not know how to handle. WWW::Mechanize::File provides basic functionality for any content type, so it is a good class to extend when building your own parsers.
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 < WWW::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 = WWW::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.
CONTENT_TYPES | = | { :html => 'text/html', :wap => 'application/vnd.wap.xhtml+xml', :xhtml => 'application/xhtml+xml', :pdf => 'application/pdf', :csv => 'text/csv', :xml => 'text/xml', } |
default | [RW] |
# File lib/www/mechanize/pluggable_parsers.rb, line 57 57: def initialize 58: @parsers = { CONTENT_TYPES[:html] => Page, 59: CONTENT_TYPES[:xhtml] => Page, 60: CONTENT_TYPES[:wap] => Page, 61: } 62: @default = File 63: end
# File lib/www/mechanize/pluggable_parsers.rb, line 94 94: def [](content_type) 95: @parsers[content_type] 96: end
# File lib/www/mechanize/pluggable_parsers.rb, line 98 98: def []=(content_type, klass) 99: @parsers[content_type] = klass 100: end
# File lib/www/mechanize/pluggable_parsers.rb, line 86 86: def csv=(klass) 87: register_parser(CONTENT_TYPES[:csv], klass) 88: end
# File lib/www/mechanize/pluggable_parsers.rb, line 73 73: def html=(klass) 74: register_parser(CONTENT_TYPES[:html], klass) 75: register_parser(CONTENT_TYPES[:xhtml], klass) 76: end
# File lib/www/mechanize/pluggable_parsers.rb, line 65 65: def parser(content_type) 66: content_type.nil? ? default : @parsers[content_type] || default 67: end
# File lib/www/mechanize/pluggable_parsers.rb, line 82 82: def pdf=(klass) 83: register_parser(CONTENT_TYPES[:pdf], klass) 84: end
# File lib/www/mechanize/pluggable_parsers.rb, line 69 69: def register_parser(content_type, klass) 70: @parsers[content_type] = klass 71: end
# File lib/www/mechanize/pluggable_parsers.rb, line 78 78: def xhtml=(klass) 79: register_parser(CONTENT_TYPES[:xhtml], klass) 80: end