multisax 0.0.0.5 → 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,27 @@
+= ChangeLog
+
+== 0.0.1 (2013 Jul 8)
+- Added ChangeLog.
+- Added Ruby 1.8.7 support.
+  - Might work on lower version, but not guaranteed.
+  - JRuby etc's supports depend on "require successfulness".
+  - Nokogiri is supported up to 1.5.x on Ruby 1.8.x.
+- MultiSAX::Sax.parse supports IO.
+  - rexmlsax2's stringio support is limited on Ruby 1.8.x. Be careful.
+  - Unless you directly specifies it, usually rexmlstream is selected.
+- Added MultiSAX::Sax.parsefile().
+
+== 0.0.0.5 (2013 Jun 21)
+- Added a test case.
+
+== 0.0.0.4 (2013 Jun 15)
+- Provided rdoc.
+
+== 0.0.0.3 (2013 Jun 14)
+- Fixed @@parser getter.
+
+== 0.0.0.2 (2013 Jun 14)
+- Fixed Rakefile.
+
+== 0.0.0.1 (2013 Jun 14)
+- First release.

data/Gemfile

@@ -2,7 +2,11 @@ source "http://rubygems.org"
 
 group :optional do
 	gem 'libxml-ruby', :require=>nil
-	gem 'nokogiri', :require=>nil
+	if RUBY_VERSION<'1.9'
+		gem 'nokogiri', '~> 1.5.0', :require=>nil
+	else
+		gem 'nokogiri', :require=>nil
+	end
 	gem 'ox', :require=>nil
 end
 

data/Gemfile.lock

@@ -10,9 +10,7 @@ GEM
       rdoc
     json (1.8.0)
     libxml-ruby (2.6.0)
-    mini_portile (0.5.0)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
+    nokogiri (1.5.10)
     ox (2.0.3)
     rake (10.0.4)
     rdoc (4.0.1)

data/README.rdoc

@@ -1,5 +1,13 @@
 = multisax
 
+== Install
+* gem install multisax
+* Optional XML libraries:
+* gem install ox
+* gem install libxml-ruby
+* gem install nokogiri
+
+== Usage
 * Please check spec/multisax.spec as an example.
 * Complex usage:
     require 'multisax'
@@ -29,13 +37,7 @@
     }.new)
     listener.content.each{...}
 
-* Optional XML libraries:
-* gem install ox
-* gem install libxml-ruby
-* gem install nokogiri
-
 == Contributing to multisax
- 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -45,6 +47,5 @@
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 == Copyright
-
 Copyright (c) 2013 T. Yamada under Ruby License (2-clause BSDL or Artistic).
 See LICENSE.txt for further details.

data/Rakefile

@@ -45,7 +45,8 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "multisax #{version}"
   rdoc.main = 'README.rdoc'
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('LICENSE*')
+  rdoc.rdoc_files.include('README.*')
+  rdoc.rdoc_files.include('LICENSE.*')
+  rdoc.rdoc_files.include('CHANGELOG.*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.0.0.5
+0.0.1

data/lib/multisax.rb

@@ -25,13 +25,18 @@ module MultiSAX
 			list.each{|e_module|
 				case e_module
 					when :ox
+						#next if RUBY_VERSION<'1.9'
 						begin
 							require 'ox'
 							require 'stringio' #this should be standard module.
 						rescue LoadError;next end
 						@@parser=e_module
 						methods=Ox::Sax.private_instance_methods(false)-Class.private_instance_methods(false)
-						methods-=[:value,:attr_value]
+						if methods[0].is_a?(String) #Hack for 1.8.x
+							methods-=['value','attr_value']
+						else
+							methods-=[:value,:attr_value]
+						end
 						@@saxmodule=Module.new{
 							methods.each{|e|define_method(e){|*a|}}
 						}
@@ -42,12 +47,18 @@ module MultiSAX
 						rescue LoadError;next end
 						@@parser=e_module;break
 					when :nokogiri
+						#nokogiri 1.5.x are supported on Ruby 1.8.7.
+						#next if RUBY_VERSION<'1.9'
 						begin
 							require 'nokogiri'
 						rescue LoadError;next end
 						@@parser=e_module
 						methods=Nokogiri::XML::SAX::Document.instance_methods(false)-Class.instance_methods(false)
-						methods-=[:start_element_namespace,:end_element_namespace]
+						if methods[0].is_a?(String) #Hack for 1.8.x
+							methods-=['start_element_namespace','end_element_namespace']
+						else
+							methods-=[:start_element_namespace,:end_element_namespace]
+						end
 						@@saxmodule=Module.new{
 							methods.each{|e|define_method(e){|*a|}}
 						}
@@ -75,30 +86,19 @@ module MultiSAX
 		# Returns which module is actually chosen.
 		def self.parser() @@parser end
 
-		#--
-		#def initialize(listener)
-		#++
-
-		# The main parsing method.
-		# Listener can be Class.new{include MultiSAX::Callbacks}.new. Returns the listener after SAX is applied.
-		# If you have not called open(), this will call it using default value (all libraries).
-		#  SAX's listeners are usually modified destructively.
-		#  So instances shouldn't be provided.
-		def self.parse(body,listener)
-			#self.class.open if !@@parser
-			self.open if !@@parser
-			raise "Failed to open SAX library. REXML, which is a standard Ruby module, might be also corrupted." if !@@parser
-			@listener=listener
-
-			#Here comes method mapping.
+		private
+		#(private) Patches listener to accept library-specific APIs.
+		def self.method_mapping(listener)
+			#raise "MultiSAX::Sax open first" if !@@parser
 			case @@parser
 				when :ox
-					@listener.instance_eval{
+					listener.instance_eval{
 						extend @@saxmodule
+						@saxwrapper_tag=nil
 						@saxwrapper_attr=[]
 						def start_element(tag)
 							# I hope provided Listener's sax_tag_start will NOT be used elsewhere.
-							alias :attrs_done :attrs_done_normal
+							#alias :attrs_done :attrs_done_normal
 							@saxwrapper_tag=tag
 							@saxwrapper_attr=[]
 						end
@@ -122,7 +122,10 @@ module MultiSAX
 						def attrs_done_normal
 							sax_tag_start(@saxwrapper_tag.to_s,@saxwrapper_attr)
 						end
-						alias :attrs_done :attrs_done_xmldecl
+						#alias :attrs_done :attrs_done_xmldecl
+						def attrs_done
+							@saxwrapper_tag ? attrs_done_normal : attrs_done_xmldecl
+						end
 						def end_element(tag) sax_tag_end(tag.to_s) end
 						alias :cdata :sax_cdata
 						alias :text :sax_text
@@ -132,7 +135,7 @@ module MultiSAX
 						alias :comment :sax_comment
 					}
 				when :libxml
-					@listener.instance_eval{
+					listener.instance_eval{
 						extend LibXML::XML::SaxParser::Callbacks
 						alias :on_start_element :sax_tag_start
 						alias :on_end_element :sax_tag_end
@@ -142,7 +145,7 @@ module MultiSAX
 						#alias :xmldecl :sax_xmldecl
 					}
 				when :nokogiri
-					@listener.instance_eval{
+					listener.instance_eval{
 						extend @@saxmodule
 						alias :start_element_namespace :sax_start_element_namespace
 						alias :start_element :sax_tag_start
@@ -154,7 +157,7 @@ module MultiSAX
 						alias :xmldecl :sax_xmldecl
 					}
 				when :rexmlstream
-					@listener.instance_eval{
+					listener.instance_eval{
 						extend REXML::StreamListener
 						alias :tag_start :sax_tag_start
 						alias :tag_end :sax_tag_end
@@ -164,7 +167,7 @@ module MultiSAX
 						alias :xmldecl :sax_xmldecl
 					}
 				when :rexmlsax2
-					@listener.instance_eval{
+					listener.instance_eval{
 						extend REXML::SAX2Listener
 						def start_element(uri,tag,qname,attrs) sax_tag_start(tag,attrs) end
 						def end_element(uri,tag,qname) sax_tag_end(tag) end
@@ -174,18 +177,53 @@ module MultiSAX
 						alias :xmldecl :sax_xmldecl
 					}
 			end
-		#end
-		#def parse(body)
-			#Here comes parsing mapping.
-			case @@parser
-				when :ox          then Ox.sax_parse(@listener,StringIO.new(body),:convert_special=>true)
-				when :libxml      then parser=LibXML::XML::SaxParser.string(body);parser.callbacks=@listener;parser.parse
-				when :nokogiri    then parser=Nokogiri::XML::SAX::Parser.new(@listener);parser.parse(body)
-				when :rexmlstream then REXML::Parsers::StreamParser.new(body,@listener).parse
-				when :rexmlsax2   then parser=REXML::Parsers::SAX2Parser.new(body);parser.listen(@listener);parser.parse
+			listener
+		end
+
+		public
+		# The main parsing method.
+		# Listener can be Class.new{include MultiSAX::Callbacks}.new. Returns the listener after SAX is applied.
+		# If you have not called open(), this will call it using default value (all libraries).
+		#  From 0.0.1, source can be IO as well as String.
+		#  SAX's listeners are usually modified destructively.
+		#  So instances shouldn't be provided.
+		def self.parse(source,listener)
+			self.open if !@@parser
+			raise "Failed to open SAX library. REXML, which is a standard Ruby module, might be also corrupted." if !@@parser
+			@listener=listener
+			self.method_mapping(@listener)
+			if source.is_a?(String)
+				case @@parser
+					when :ox          then Ox.sax_parse(@listener,StringIO.new(source),:convert_special=>true)
+					when :libxml      then parser=LibXML::XML::SaxParser.string(source);parser.callbacks=@listener;parser.parse
+					when :nokogiri    then parser=Nokogiri::XML::SAX::Parser.new(@listener);parser.parse(source)
+					when :rexmlstream then REXML::Parsers::StreamParser.new(source,@listener).parse
+					when :rexmlsax2   then parser=REXML::Parsers::SAX2Parser.new(source);parser.listen(@listener);parser.parse
+				end
+			else
+				case @@parser
+					when :ox          then Ox.sax_parse(@listener,source,:convert_special=>true)
+					when :libxml      then parser=LibXML::XML::SaxParser.io(source);parser.callbacks=@listener;parser.parse
+					when :nokogiri    then parser=Nokogiri::XML::SAX::Parser.new(@listener);parser.parse(source)
+					when :rexmlstream then REXML::Parsers::StreamParser.new(source,@listener).parse
+					when :rexmlsax2   then parser=REXML::Parsers::SAX2Parser.new(source);parser.listen(@listener);parser.parse
+				end
 			end
 			@listener
 		end
+
+		# Parses file as XML. Error handling might be changed in the future.
+		def self.parsefile(filename,listener)
+			#begin
+				return nil unless FileTest::readable?(filename)
+				File.open(filename,'rb'){|f|
+					self.parse(f,listener)
+				}
+			#rescue
+			#	return nil
+			#end
+			@listener
+		end
 	end
 
 	# MultiSAX callbacks.

data/multisax.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "multisax"
-  s.version = "0.0.0.5"
+  s.version = "0.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["cielavenir"]
-  s.date = "2013-06-21"
+  s.date = "2013-07-08"
   s.description = "Ruby Gem to handle multiple SAX libraries: ox/libxml/nokogiri/rexml"
   s.email = "cielartisan@gmail.com"
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    "CHANGELOG.rdoc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

data/spec/multisax_spec.rb

@@ -25,39 +25,72 @@ input_xml=<<"EOM"
 EOM
 answer=['hello','sax','world','sax','hello']
 
-describe "Multisax" do
-	it "unknown" do
+describe "MultiSAX::Sax.parse (String)" do
+	it "fails on :unknown" do
 		MultiSAX::Sax.reset
 		MultiSAX::Sax.open(:unknown).should be_false
 	end
-	it "rexmlstream" do
+	it ":rexmlstream" do
 		MultiSAX::Sax.reset
 		MultiSAX::Sax.open(:rexmlstream)
 		MultiSAX::Sax.parser.should eq :rexmlstream
 		MultiSAX::Sax.parse(input_xml,MultiSAXTester.new).result.should eq answer
 	end
-	it "rexmlsax2" do
+	it ":rexmlsax2" do
 		MultiSAX::Sax.reset
 		MultiSAX::Sax.open(:rexmlsax2)
 		MultiSAX::Sax.parser.should eq :rexmlsax2
 		MultiSAX::Sax.parse(input_xml,MultiSAXTester.new).result.should eq answer
 	end
-	it "ox" do
+	it ":ox" do
 		MultiSAX::Sax.reset
 		MultiSAX::Sax.open(:ox)
 		MultiSAX::Sax.parser.should eq :ox
 		MultiSAX::Sax.parse(input_xml,MultiSAXTester.new).result.should eq answer
 	end
-	it "libxml" do
+	it ":libxml" do
 		MultiSAX::Sax.reset
 		MultiSAX::Sax.open(:libxml)
 		MultiSAX::Sax.parser.should eq :libxml
 		MultiSAX::Sax.parse(input_xml,MultiSAXTester.new).result.should eq answer
 	end
-	it "nokogiri" do
+	it ":nokogiri" do
 		MultiSAX::Sax.reset
 		MultiSAX::Sax.open(:nokogiri)
 		MultiSAX::Sax.parser.should eq :nokogiri
 		MultiSAX::Sax.parse(input_xml,MultiSAXTester.new).result.should eq answer
 	end
 end
+
+describe "MultiSAX::Sax.parse (IO)" do
+	it ":rexmlstream" do
+		MultiSAX::Sax.reset
+		MultiSAX::Sax.open(:rexmlstream)
+		MultiSAX::Sax.parser.should eq :rexmlstream
+		MultiSAX::Sax.parse(StringIO.new(input_xml),MultiSAXTester.new).result.should eq answer
+	end
+	it ":rexmlsax2" do
+		MultiSAX::Sax.reset
+		MultiSAX::Sax.open(:rexmlsax2)
+		MultiSAX::Sax.parser.should eq :rexmlsax2
+		MultiSAX::Sax.parse(StringIO.new(input_xml),MultiSAXTester.new).result.should eq answer
+	end
+	it ":ox" do
+		MultiSAX::Sax.reset
+		MultiSAX::Sax.open(:ox)
+		MultiSAX::Sax.parser.should eq :ox
+		MultiSAX::Sax.parse(StringIO.new(input_xml),MultiSAXTester.new).result.should eq answer
+	end
+	it ":libxml" do
+		MultiSAX::Sax.reset
+		MultiSAX::Sax.open(:libxml)
+		MultiSAX::Sax.parser.should eq :libxml
+		MultiSAX::Sax.parse(StringIO.new(input_xml),MultiSAXTester.new).result.should eq answer
+	end
+	it ":nokogiri" do
+		MultiSAX::Sax.reset
+		MultiSAX::Sax.open(:nokogiri)
+		MultiSAX::Sax.parser.should eq :nokogiri
+		MultiSAX::Sax.parse(StringIO.new(input_xml),MultiSAXTester.new).result.should eq answer
+	end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,19 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
+require 'stringio'
 require 'multisax'
 
+if RUBY_VERSION<'1.9' #gee, StringIO needs to be hacked.
+	class StringIO
+		def stat
+			Class.new{
+				def pipe?() return false end
+			}.new
+		end
+	end
+end
+
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multisax
 version: !ruby/object:Gem::Version
-  version: 0.0.0.5
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -85,6 +85,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -110,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -417005702890450070
+      hash: 3842720625323194338
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: