multi_xml 0.2.0 → 0.2.1

data/.gitignore

@@ -1,5 +1,10 @@
 *.gem
+*.rbc
+.DS_Store
 .bundle
+.yardoc
+Gemfile.lock
 coverage/*
+doc/*
+log/*
 pkg/*
-rdoc/*

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--protected
+--markup markdown
+-
+LICENSE.mkd

data/README.mkd

@@ -0,0 +1,84 @@
+MultiXML
+========
+A generic swappable back-end for XML parsing
+
+Installation
+------------
+    $ [sudo] gem install multi_xml
+
+Documentation
+-------------
+<http://rdoc.info/gems/multi_xml>
+
+Usage Examples
+--------------
+Lots of Ruby libraries utilize XML parsing in some form, and everyone has their favorite XML library.
+In order to best support multiple XML parsers and libraries, <tt>multi_xml</tt> is a general-purpose
+swappable XML backend library. You use it like so:
+
+    require 'multi_xml'
+
+    MultiXml.parser = :libxml
+    MultiXml.parser = MultiXml::Parsers::Libxml # Same as above
+    MultiXml.parse('<tag>This is the contents</tag>') # Parsed using LibXML
+
+    MultiXml.parser = :nokogiri
+    MultiXml.parser = MultiXml::Parsers::Nokogiri # Same as above
+    MultiXml.parse('<tag>This is the contents</tag>') # Parsed using Nokogiri
+
+    MultiXml.parser = :rexml
+    MultiXml.parser = MultiXml::Parsers::Rexml # Same as above
+    MultiXml.parse('<tag>This is the contents</tag>') # Parsed using REXML
+
+The <tt>parser</tt> setter takes either a symbol or a class (to allow for custom XML parsers) that
+responds to <tt>.parse</tt> at the class level.
+
+MultiXML tries to have intelligent defaulting. That is, if you have any of the supported parsers
+already loaded, it will utilize them before attempting to load any. When loading, libraries are
+ordered by speed: first LibXML, then Nokogiri, then REXML.
+
+Contributing
+------------
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues](http://github.com/sferik/multi_xml/issues)
+* by reviewing patches
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](http://github.com/sferik/multi_xml/issues) to track bugs and
+features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. Ideally, a bug report should include a pull request with failing specs.
+
+Submitting a Pull Request
+-------------------------
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+Inspiration
+-----------
+MultiXML was inspired by [MultiJSON](http://github.com/intridea/multi_json/).
+
+Copyright
+---------
+Copyright (c) 2010 Erik Michaels-Ober.
+See [LICENSE](https://github.com/sferik/multi_xml/blob/master/LICENSE.mkd) for details.

data/Rakefile

@@ -1,29 +1,21 @@
 require 'bundler'
-Bundler.setup
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-namespace :spec do
-  desc "Run all examples using rcov"
-  RSpec::Core::RakeTask.new :rcov => :cleanup_rcov_files do |t|
-    t.rcov = true
-    t.rcov_opts =  %[-Ilib -Ispec --exclude "gems/*,features"]
-    t.rcov_opts << %[--text-report --sort coverage]
-  end
-end
-
-task :cleanup_rcov_files do
-  rm_rf 'coverage'
-end
-
+task :test => :spec
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "multi_xml #{MultiXml::VERSION}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--no-private',
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
+  end
 end

data/lib/multi_xml.rb

@@ -75,13 +75,13 @@ module MultiXml
     # * <tt>:rexml</tt>
     def parser=(new_parser)
       case new_parser
-        when String, Symbol
-          require "multi_xml/parsers/#{new_parser.to_s.downcase}"
-          @parser = MultiXml::Parsers.const_get("#{new_parser.to_s.split('_').map{|s| s.capitalize}.join('')}")
-        when Class, Module
-          @parser = new_parser
-        else
-          raise "Did not recognize your parser specification. Please specify either a symbol or a class."
+      when String, Symbol
+        require "multi_xml/parsers/#{new_parser.to_s.downcase}"
+        @parser = MultiXml::Parsers.const_get("#{new_parser.to_s.split('_').map{|s| s.capitalize}.join('')}")
+      when Class, Module
+        @parser = new_parser
+      else
+        raise "Did not recognize your parser specification. Please specify either a symbol or a class."
       end
     end
 

data/lib/multi_xml/core_extensions.rb

@@ -4,7 +4,7 @@ class Object #:nodoc:
   # @example [].blank?         #=>  true
   # @example [1].blank?        #=>  false
   # @example [nil].blank?      #=>  false
-  # 
+  #
   # Returns true if the object is nil or empty (if applicable)
   def blank?
     nil? || (respond_to?(:empty?) && empty?)
@@ -13,7 +13,7 @@ end
 
 class Numeric #:nodoc:
   # @return <TrueClass, FalseClass>
-  # 
+  #
   # Numerics can't be blank
   def blank?
     false
@@ -22,7 +22,7 @@ end
 
 class NilClass #:nodoc:
   # @return <TrueClass, FalseClass>
-  # 
+  #
   # Nils are always blank
   def blank?
     true
@@ -31,8 +31,8 @@ end
 
 class TrueClass #:nodoc:
   # @return <TrueClass, FalseClass>
-  # 
-  # True is not blank.  
+  #
+  # True is not blank.
   def blank?
     false
   end
@@ -49,9 +49,9 @@ class String #:nodoc:
   # @example "".blank?         #=>  true
   # @example "     ".blank?    #=>  true
   # @example " hey ho ".blank? #=>  false
-  # 
+  #
   # @return <TrueClass, FalseClass>
-  # 
+  #
   # Strips out whitespace then tests if the string is empty.
   def blank?
     strip.empty?

data/lib/multi_xml/parsers/libxml.rb

@@ -2,12 +2,11 @@ require 'libxml' unless defined?(LibXML)
 
 module MultiXml
   module Parsers
-    # Use LibXML to parse XML.
     module Libxml #:nodoc:
       extend self
       def parse_error; ::LibXML::XML::Error; end
 
-      # Parse an XML Document string or IO into a simple hash using libxml.
+      # Parse an XML Document string or IO into a simple hash using LibXML.
       # xml::
       #   XML Document string or IO to parse
       def parse(xml)

data/lib/multi_xml/parsers/nokogiri.rb

@@ -2,12 +2,11 @@ require 'nokogiri' unless defined?(Nokogiri)
 
 module MultiXml
   module Parsers
-    # Use Nokogiri to parse XML.
     module Nokogiri #:nodoc:
       extend self
       def parse_error; ::Nokogiri::XML::SyntaxError; end
 
-      # Parse an XML Document string or IO into a simple hash using libxml / nokogiri.
+      # Parse an XML Document string or IO into a simple hash using Nokogiri.
       # xml::
       #   XML Document string or IO to parse
       def parse(xml)

data/lib/multi_xml/parsers/rexml.rb

@@ -2,14 +2,13 @@ require 'rexml/document' unless defined?(REXML::Document)
 
 module MultiXml
   module Parsers
-    # Use REXML to parse XML.
     module Rexml #:nodoc:
       extend self
       def parse_error; ::REXML::ParseException; end
 
       CONTENT_ROOT = '__content__'.freeze unless defined?(CONTENT_ROOT)
 
-      # Parse an XML Document string or IO into a simple hash
+      # Parse an XML Document string or IO into a simple hash using REXML
       #
       # xml::
       #   XML Document string or IO to parse

data/lib/multi_xml/version.rb

@@ -1,3 +1,3 @@
 module MultiXml
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/multi_xml.gemspec

@@ -1,25 +1,28 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "multi_xml/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'multi_xml/version'
 
 Gem::Specification.new do |s|
-  s.add_development_dependency("bundler", "~> 1.0")
-  s.add_development_dependency("libxml-ruby", "~> 1.1")
-  s.add_development_dependency("nokogiri", "~> 1.4")
-  s.add_development_dependency("rake", "~> 0.8")
-  s.add_development_dependency("rcov", "~> 0.9")
-  s.add_development_dependency("rspec", "~> 2.0")
-  s.name        = "multi_xml"
+  s.add_development_dependency('bundler', '~> 1.0')
+  s.add_development_dependency('libxml-ruby', '~> 1.1')
+  s.add_development_dependency('maruku', '~> 0.6')
+  s.add_development_dependency('nokogiri', '~> 1.4')
+  s.add_development_dependency('rake', '~> 0.8')
+  s.add_development_dependency('rspec', '~> 2.4')
+  s.add_development_dependency('simplecov', '~> 0.3')
+  s.add_development_dependency('yard', '~> 0.6')
+  s.add_development_dependency('ZenTest', '~> 4.4')
+  s.name        = 'multi_xml'
   s.version     = MultiXml::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Erik Michaels-Ober"]
-  s.email       = ["sferik@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/multi_xml"
+  s.email       = ['sferik@gmail.com']
+  s.homepage    = 'http://rubygems.org/gems/multi_xml'
   s.summary     = %q{A generic swappable back-end for XML parsing}
   s.description = %q{A gem to provide swappable XML backends utilizing LibXML, Nokogiri, or REXML.}
-  s.rubyforge_project = "multi_xml"
+  s.rubyforge_project = 'multi_xml'
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 end

data/spec/multi_xml_spec.rb

@@ -1,14 +1,14 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-class MockDecoder
-  def self.parse(xml)
-    '<tag>This is the contents</tag>'
-  end
-end
+class MockDecoder; end
 
 describe "MultiXml" do
   context "Parsers" do
     it "should default to the best available gem" do
+      pending
+      MultiXml.parser.name.should == 'MultiXml::Parsers::Rexml'
+      require 'nokogiri'
+      MultiXml.parser.name.should == 'MultiXml::Parsers::Nokogiri'
       require 'libxml'
       MultiXml.parser.name.should == 'MultiXml::Parsers::Libxml'
     end
@@ -127,6 +127,58 @@ describe "MultiXml" do
             end
           end
 
+          context "when value is true" do
+            before do
+              pending
+              @xml = '<tag>true</tag>'
+            end
+
+            it "should return true" do
+              MultiXml.parse(@xml)['tag'].should be_true
+            end
+          end
+
+          context "when value is false" do
+            before do
+              pending
+              @xml = '<tag>false</tag>'
+            end
+
+            it "should return false" do
+              MultiXml.parse(@xml)['tag'].should be_false
+            end
+          end
+
+          context "when key is id" do
+            before do
+              pending
+              @xml = '<id>1</id>'
+            end
+
+            it "should return a Fixnum" do
+              MultiXml.parse(@xml)['id'].should be_a(Fixnum)
+            end
+
+            it "should return the correct number" do
+              MultiXml.parse(@xml)['id'].should == 1
+            end
+          end
+
+          context "when key contains _id" do
+            before do
+              pending
+              @xml = '<tag_id>1</tag_id>'
+            end
+
+            it "should return a Fixnum" do
+              MultiXml.parse(@xml)['tag_id'].should be_a(Fixnum)
+            end
+
+            it "should return the correct number" do
+              MultiXml.parse(@xml)['tag_id'].should == 1
+            end
+          end
+
           context "with an attribute type=\"boolean\"" do
             %w(true false).each do |boolean|
               context "when #{boolean}" do

data/spec/spec_helper.rb

@@ -1,11 +1,8 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'multi_xml'
-require 'rspec/core'
-require 'rubygems'
-begin
-  require 'bundler'
-  Bundler.setup
-rescue LoadError
-  $stderr.puts "Bundler (or a dependency) not available."
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Libraries', 'lib'
 end
+
+require File.expand_path('../../lib/multi_xml', __FILE__)
+
+require 'rspec'

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: multi_xml
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors: 
 - Erik Michaels-Ober
@@ -15,99 +10,108 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-22 00:00:00 -07:00
+date: 2011-02-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
         version: "1.0"
   type: :development
-  prerelease: false
-  name: bundler
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 1
         version: "1.1"
   type: :development
-  prerelease: false
-  name: libxml-ruby
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: maruku
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
-        version: "1.4"
+        version: "0.6"
   type: :development
-  prerelease: false
-  name: nokogiri
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 8
-        version: "0.8"
+        version: "1.4"
   type: :development
-  prerelease: false
-  name: rake
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+        version: "0.8"
   type: :development
-  prerelease: false
-  name: rcov
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+        version: "2.4"
   type: :development
-  prerelease: false
-  name: rspec
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.3"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "4.4"
+  type: :development
+  version_requirements: *id009
 description: A gem to provide swappable XML backends utilizing LibXML, Nokogiri, or REXML.
 email: 
 - sferik@gmail.com
@@ -118,12 +122,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gemtest
 - .gitignore
 - .rspec
+- .yardopts
 - Gemfile
-- Gemfile.lock
-- LICENSE
-- README.rdoc
+- LICENSE.mkd
+- README.mkd
 - Rakefile
 - lib/multi_xml.rb
 - lib/multi_xml/core_extensions.rb
@@ -148,23 +153,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: multi_xml
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A generic swappable back-end for XML parsing

data/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: .
-  specs:
-    multi_xml (0.2.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.2)
-    libxml-ruby (1.1.4)
-    nokogiri (1.4.3.1)
-    rake (0.8.7)
-    rcov (0.9.9)
-    rspec (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-      rspec-mocks (~> 2.0.1)
-    rspec-core (2.0.1)
-    rspec-expectations (2.0.1)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0)
-  libxml-ruby (~> 1.1)
-  multi_xml!
-  nokogiri (~> 1.4)
-  rake (~> 0.8)
-  rcov (~> 0.9)
-  rspec (~> 2.0)

data/README.rdoc

@@ -1,33 +0,0 @@
-= MultiXML
-==== A generic swappable back-end for XML parsing
-
-Lots of Ruby libraries utilize XML parsing in some form, and everyone has their favorite XML library. In order to best support multiple XML parsers and libraries, <tt>multi_xml</tt> is a general-purpose swappable XML backend library. You use it like so:
-
-  require 'multi_xml'
-  
-  MultiXml.parser = :nokogiri
-  MultiXml.parse('<tag>This is the contents</tag>') # parsed using Nokogiri
-  
-  MultiXml.parser = :rexml
-  MultiXml.parser = MultiJson::Parser::Rexml # equivalent to previous line
-  MultiXml.parse('<tag>This is the contents</tag>') # parsed using REXML
-
-The <tt>parser</tt> setter takes either a symbol or a class (to allow for custom XML parsers) that responds to <tt>.parse</tt> at the class level.
-
-MultiXML tries to have intelligent defaulting. That is, if you have any of the supported parsers already loaded, it will utilize them before attempting to load any. When loading, libraries are ordered by speed. First LibXML, then Nokogiri, then REXML.
-
-== Inspiration
-
-MultiXML was inspired by MultiJSON[http://github.com/intridea/multi_json/].
-
-== Submitting Patches
-
-1. Fork the project.
-2. Commit your feature or bug fix.
-3. Add tests for it. This is important so it doesn't break in the future.
-4. Do not mess with gemspec, version, or history. (If you want to have your own version, that's fine, but please do so in a separate commit.)
-5. Submit a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Erik Michaels-Ober. See LICENSE for details.