Class WWW::Mechanize::PluggableParser
In: lib/www/mechanize/pluggable_parsers.rb
Parent: Object
Mechanize\n[lib/www/mechanize.rb\nlib/www/mechanize/content_type_error.rb\nlib/www/mechanize/cookie.rb\nlib/www/mechanize/cookie_jar.rb\nlib/www/mechanize/file.rb\nlib/www/mechanize/file_saver.rb\nlib/www/mechanize/form.rb\nlib/www/mechanize/form/button.rb\nlib/www/mechanize/form/check_box.rb\nlib/www/mechanize/form/field.rb\nlib/www/mechanize/form/file_upload.rb\nlib/www/mechanize/form/image_button.rb\nlib/www/mechanize/form/multi_select_list.rb\nlib/www/mechanize/form/option.rb\nlib/www/mechanize/form/radio_button.rb\nlib/www/mechanize/form/select_list.rb\nlib/www/mechanize/headers.rb\nlib/www/mechanize/history.rb\nlib/www/mechanize/list.rb\nlib/www/mechanize/monkey_patch.rb\nlib/www/mechanize/page.rb\nlib/www/mechanize/page/base.rb\nlib/www/mechanize/page/frame.rb\nlib/www/mechanize/page/link.rb\nlib/www/mechanize/page/meta.rb\nlib/www/mechanize/pluggable_parsers.rb\nlib/www/mechanize/response_code_error.rb\nlib/www/mechanize/unsupported_scheme_error.rb] lib/www/mechanize.rb WWW dot/m_32_0.png

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 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.

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 < 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.

Methods

[]   []=   csv=   html=   new   parser   pdf=   register_parser   xml=  

Constants

CONTENT_TYPES = { :html => 'text/html', :pdf => 'application/pdf', :csv => 'text/csv', :xml => 'text/xml', }

Attributes

default  [RW] 

Public Class methods

[Source]

    # File lib/www/mechanize/pluggable_parsers.rb, line 55
55:       def initialize
56:         @parsers = { CONTENT_TYPES[:html] => Page }
57:         @default = File
58:       end

Public Instance methods

[Source]

    # File lib/www/mechanize/pluggable_parsers.rb, line 84
84:       def [](content_type)
85:         @parsers[content_type]
86:       end

[Source]

    # File lib/www/mechanize/pluggable_parsers.rb, line 88
88:       def []=(content_type, klass)
89:         @parsers[content_type] = klass
90:       end

[Source]

    # File lib/www/mechanize/pluggable_parsers.rb, line 76
76:       def csv=(klass)
77:         register_parser(CONTENT_TYPES[:csv], klass)
78:       end

[Source]

    # File lib/www/mechanize/pluggable_parsers.rb, line 68
68:       def html=(klass)
69:         register_parser(CONTENT_TYPES[:html], klass)
70:       end

[Source]

    # File lib/www/mechanize/pluggable_parsers.rb, line 60
60:       def parser(content_type)
61:         content_type.nil? ? default : @parsers[content_type] || default
62:       end

[Source]

    # File lib/www/mechanize/pluggable_parsers.rb, line 72
72:       def pdf=(klass)
73:         register_parser(CONTENT_TYPES[:pdf], klass)
74:       end

[Source]

    # File lib/www/mechanize/pluggable_parsers.rb, line 64
64:       def register_parser(content_type, klass)
65:         @parsers[content_type] = klass
66:       end

[Source]

    # File lib/www/mechanize/pluggable_parsers.rb, line 80
80:       def xml=(klass)
81:         register_parser(CONTENT_TYPES[:xml], klass)
82:       end

[Validate]