xmlscan 0.3.0prec → 0.3.0

data/README.rdoc

@@ -44,6 +44,20 @@ a core part of a library providing such features.
 
 XMLscan contains htmlscan, an HTML parser.
 
+== New Scanner Translater Feature with 0.3.0
+
+Created for a use case in Wagn (http://wagn.org)
+
+The fragment is pretty much the whole parsing as used in Wagn:
+
+   pairs = XMLScan::XMLProcessor.process(io, {:key=>:name, :element=>:card,
+                     :substitute=>":transclude|{{:name}}", :extras=>[:type]})
+
+The 'io' object is directly passed from the request.body in a XML POST action.
+
+ref: https://github.com/GerryG/wagn/commit/46e57dfd88cde45d33fe7f167d5803ab819ceef3#commitcomment-1012403
+
+See the tests cases in test/integration for some examples.
 
 === Character encodings
 
@@ -58,6 +72,9 @@ Shift_JIS, or UTF-8.
 UTF-16 is not supported directly. You should convert it into
 UTF-8 before parsing.
 
+Character encoding needs more work with 0.3.0+.  The character maps were
+taken out in favor of \p{} RE classes in ruby, but it needs attention still.
+
 === XML Namespaces
 
 XML Namespaces have been already implemented in
@@ -89,13 +106,21 @@ Raised when an XML document violates an validity constraint.
 
 
 XMLScan::Visitor
+
 Mix-in for receiving the result of parsing an XML document.
 Each parser included in xmlscan parses an XML document from
 the beginning, and calls each specific method of given instance of
 XMLScan::Visitor for each syntactic element, such as a tag.
 It is ensured that these calls is in order of the appearance
 in the document from the beginning.
+
+Changes: The scanner/parser now sends some additional arguments with
+each event, primarily the original string that was parsed for the even, but
+also a hash of attributes for stag_end.  This supports scanning for
+replacement of some elements very simple.
+
 Methods:
+
 Without special notice, the following methods do nothing by
 default.
 
@@ -107,6 +132,7 @@ a production. By default, this method raises
 XMLScan::ParseError exception. If no exception is
 raised and this method returns normally, the parser recovers
 the error and continues to parse.
+
 XMLScan::Visitor#wellformed_error(msg)
 
 Called when the parser meets an well-formedness constraint
@@ -114,6 +140,7 @@ violation. By default, this method raises
 XMLScan::NotWellFormedError exception. If no exception
 is raised and this method returns normally, the parser recovers
 the error and continues to parse.
+
 XMLScan::Visitor#valid_error(msg)
 
 Called when the parser meets validity constraint
@@ -123,18 +150,23 @@ is raised and this method returns normally, the parser recovers
 the error and continues to parse.
 FYI, current version of xmlscan includes no validating XML
 processor. This method is reserved for future versions.
+
 XMLScan::Visitor#warning(msg)
 
 Called when the parser meets a non-error but unrecommended
 thing or a syntax which xmlscan is not able to parse.
+
 XMLScan::Visitor#on_start_document
 
 Called just before the parser starts parsing an XML document.
+
 After this method is called, corresponding
 XMLScan::Visitor#on_end_document method is always called.
+
 XMLScan::Visitor#on_end_document
 
 Called after the parser reaches the end of an XML document.
+
 XMLScan::Visitor#on_xmldecl
 XMLScan::Visitor#on_xmldecl_version(str)
 XMLScan::Visitor#on_xmldecl_encoding(str)
@@ -154,50 +186,63 @@ Called when the parser meets an XML declaration.
           3: on_xmldecl_encoding    ("euc-jp")
           4: on_xmldecl_standalone  ("yes")
           5: on_xmldecl_end
+
 When an XML declaration is found, both on_xmldecl and
 on_xmldecl_end method are always called. Any other methods
 are called only when the corresponding syntaxes are found.
+
 When a declaration except version, encoding, and standalone
 is found in an XML declaration, on_xmldecl_other method is
 called. Since such a declaration is not permitted, note that
 the parser always calls XMLScan::Visitor#parse_error method
 before calling on_xmldecl_other method.
+
 XMLScan::Visitor#on_doctype(root, pubid, sysid)
 
 Called when the parser meets a document type declaration.
+
 document                            argument
 --------------------------------------------------------------
  1: <!DOCTYPE foo>                      ('foo', nil,   nil)
  2: <!DOCTYPE foo SYSTEM "bar">         ('foo', nil,   'bar')
  3: <!DOCTYPE foo PUBLIC "bar">         ('foo', 'bar',  nil )
  4: <!DOCTYPE foo PUBLIC "bar" "baz">   ('foo', 'bar', 'baz')
+
 XMLScan::Visitor#on_prolog_space(str)
 
 Called when the parser meets whitespaces in prolog.
+
 XMLScan::Visitor#on_comment(str)
 
 Called when the parser meets a comment.
+
 XMLScan::Visitor#on_pi(target, pi)
 
 Called when the parser meets a processing instruction.
+
 XMLScan::Visitor#on_chardata(str)
 
 Called when the parser meets character data.
+
 XMLScan::Visitor#on_cdata(str)
 
 Called when the parser meets a CDATA section.
+
 XMLScan::Visitor#on_entityref(ref)
 
 Called when the parser meets a general entity reference
 in a place except an attribute value.
+
 XMLScan::Visitor#on_charref(code)
 XMLScan::Visitor#on_charref_hex(code)
 
 Called when the parser meets a character reference
 in a place except an attribute value.
+
 When the character code is represented by decimals,
 on_charref is called. When by hexadecimals, on_charref_hex
 is called. code is an integer.
+
 XMLScan::Visitor#on_stag(name)
 XMLScan::Visitor#on_attribute(name)
 XMLScan::Visitor#on_attr_value(str)
@@ -226,19 +271,24 @@ Called when the parser meets an XML declaration.
   9: on_stag_end            ('hoge')
       or
      on_stag_end_empty      ('hoge')
+
 When a start tag is found, both on_stag and corresponding
 either on_stag_end or on_stag_end_empty method are always
 called. Any other methods are called only when at least one
 attribute is found in the start tag.
+
 When an attribute is found, both on_attribute and
 on_attribute_end method are always called. If the attribute
 value is empty, only these two methods are called.
+
 When the parser meets a general entity reference in an
 attribute value, it calls on_attr_entityref method.
+
 When the parser meets a character reference in an attribute
 value, it calls either on_charref or on_charref_hex method.
 If the tag is an empty element tag, on_stag_end_empty method
 is called instead of on_stag_end method.
+
 XMLScan::Visitor#on_etag(name)
 
 Called when the parser meets an end tag.
@@ -246,6 +296,7 @@ Called when the parser meets an end tag.
 XMLScan::XMLScanner
 The scanner which tokenizes an XML document and recognize tags,
 and so on.
+
 The conformance of XMLScan::XMLScanner to the specification
 is described in another document.
 SuperClass:
@@ -259,29 +310,33 @@ XMLScan::XMLScanner.new(visitor[, option ...])
 Creates an instance. visitor is a instance of
 XMLScan::Visitor and receives the result of parsing
 from the XMLScan::Scanner object.
+
 You can specify one of more option as a string or symbol.
+
 XMLScan::Scanner's options are as follows:
 
 'strict_char'
 
 This option is enabled after
 require 'xmlscan/xmlchar'.
+
 XMLScan::Scanner checks whether an XML document includes
 an illegal character. The performance decreases sharply.
 
 
-
 Methods:
 
 XMLScan::XMLScanner#kcode= arg
 
 Sets CES. Available values for code are same as $KCODE
 except nil. If code is nil, $KCODE decides the CES.
+
 XMLScan::XMLScanner#kcode
 
 Returns CES. The format of the return value is same as
 Regexp#kcode. If this method returns nil, it represents that
 $KCODE decides the CES.
+
 XMLScan::XMLScanner#parse(source)
 
 Parses source as an XML document. source must be
@@ -289,9 +344,12 @@ a string, an array of strings, or an object which responds to
 gets method which behaves same as IO#gets does.
 
 XMLScan::XMLParser
+
 The non-validating XML parser.
+
 The conformance of XMLScan::XMLParser to the specification
 is described in another document.
+
 SuperClass:
 
 XMLScan::XMLScanner
@@ -308,7 +366,6 @@ XMLScan::Visitor#on_stag
 After calling this method, XMLScan::Parser always call
 corresponding XMLScan::Visitor#on_etag method.
 
-
 In addition, if you never intend error recovery, method calls
 which must not be occurred in a well-formed XML document are
 all suppressed.

data/VERSION

@@ -1 +1 @@
-0.3.0prec
+0.3.0

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: xmlscan
 version: !ruby/object:Gem::Version
-  version: 0.3.0prec
-  prerelease: 5
+  version: 0.3.0
+  prerelease: 
 platform: ruby
 authors:
 - UENO Katsuhiro <katsu@blue.sky.or.jp>
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-17 00:00:00.000000000 Z
+date: 2012-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &9706320 !ruby/object:Gem::Requirement
+  requirement: &5315060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *9706320
+  version_requirements: *5315060
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &9705800 !ruby/object:Gem::Requirement
+  requirement: &5313840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *9705800
+  version_requirements: *5313840
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &9705220 !ruby/object:Gem::Requirement
+  requirement: &5312600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *9705220
+  version_requirements: *5312600
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &9704580 !ruby/object:Gem::Requirement
+  requirement: &5310620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *9704580
+  version_requirements: *5310620
 description: The fastest XML parser written in 100% pure Ruby.
 email: gerryg@inbox.com
 executables: []
@@ -96,13 +96,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4206592949743860129
+      hash: 21734141110843515
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.15