dreamcat4-libxml-bindings 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 dreamcat4
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,53 @@
+= libxml-bindings
+
+This introduction text is taken from http://thebogles.com/blog/an-hpricot-style-interface-to-libxml#,
+credit to Phil Bogle.
+
+== Convenience functions
+
+You can call to_xml_doc on any string to convert it into an XML::Document:
+
+	>> s = '<foo id="1"><author>p. bogle</author><bar>content</bar><bar>cont2</bar></foo>'
+	>> root = s.to_xml_doc.root
+
+The at() method returns the first Node matching the given xpath:
+
+	>> root.at("author")
+	=> <author>p. bogle</author>
+
+The search() method returns a list of Nodes matching the given xpath:
+
+	>> root.search("bar")
+	=> [<bar>content</bar>, <bar>content2</bar>]
+
+search() can also be called with a block to iterate through each of the matching nodes:
+
+	>>  root.search("bar") do |bar| puts bar.xpath; end
+	/foo/bar[1]
+	/foo/bar[2]
+
+== Namespace helpers
+
+The handling of default namespaces in libxml-ruby is awkward because you have to remember to pass along an array of namespace strings to every find() method call, and because you have to repeat yourself about the href of the default namespace.
+
+The helpers add a register_default_namespace function that makes this simpler.
+
+Suppose you had XML like the following
+
+	<?xml version="1.0" encoding="UTF-8"?>
+	<feed xmlns="http://www.w3.org/2005/Atom"
+	        xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/"
+	        xmlns:gContact="http://schemas.google.com/contact/2008\"
+	        xmlns:gd="http://schemas.google.com/g/2005">
+	  <title type=\"text\">Phil Bogle's Contacts</title>
+	   ...
+	</feed>
+
+Then you could say the following and have it work as expected:
+
+	root.register_default_namespace("atom")
+	root.search("atom:title")
+
+== Copyright
+
+Copyright (c) 2009 dreamcat4. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "libxml-bindings"
+    gem.summary = %Q{Dreamcat4's bindings for libxml-ruby. In development. This gem will provide convenience functions for both reading and writing XML in ruby. Implemented as wrapper for underlying libxml2 / SAX. Aims are to be faster (very much) and simpler (little bit) than hpricot. This project is a continuation / extension of libxml_helper.rb by Phil Bogle.}
+    gem.email = "dreamcat4@gmail.com"
+    gem.homepage = "http://github.com/dreamcat4/libxml-bindings"
+    gem.authors = ["dreamcat4"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "libxml-bindings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 0
+:major: 0

data/lib/libxml_bindings.rb

@@ -0,0 +1,90 @@
+require "xml/libxml"
+
+class XML::Node
+  ##
+  # Open up XML::Node from libxml and add convenience methods inspired
+  # by hpricot.
+  # (http://code.whytheluckystiff.net/hpricot/wiki/HpricotBasics)
+  # Also:
+  #  * provide better handling of default namespaces
+  # an array of default namespaces to past into
+  attr_accessor :default_namespaces
+  
+  # find the child node with the given xpath
+  def at(xpath)
+    self.find_first(xpath)
+  end
+
+  # find the array of child nodes matching the given xpath
+  def search(xpath)
+    results = self.find(xpath).to_a
+    if block_given?
+      results.each do |result|
+        yield result
+      end
+    end
+    return results
+  end
+
+  # alias for search
+  def /(xpath)
+    search(xpath)
+  end
+  # return the inner contents of this node as a string
+  def inner_xml
+    child.to_s
+  end
+  
+  # alias for inner_xml
+  def inner_html
+    inner_xml
+  end
+  
+  # return this node and its contents as an xml string
+  def to_xml
+    self.to_s
+  end
+
+  # alias for path
+  def xpath
+    self.path
+  end
+  
+  # provide a name for the default namespace
+  def register_default_namespace(name)
+    self.namespace.each do |n|
+      if n.to_s == nil
+        register_namespace("#{name}:#{n.href}")
+        return
+      end
+    end
+    raise "No default namespace found"
+  end
+  
+  # register a namespace, of the form "foo:http://example.com/ns"
+  def register_namespace(name_and_href)
+    (@default_namespaces ||= []) <<name_and_href
+  end
+  
+  def find_with_default_ns(xpath_expr, namespace=nil)
+    find_base(xpath_expr, namespace || default_namespaces)
+  end
+  
+  def find_first_with_default_ns(xpath_expr, namespace=nil)
+    find_first_base(xpath_expr, namespace || default_namespaces)
+  end
+  
+  alias_method :find_base, :find unless method_defined?(:find_base)
+  alias_method :find, :find_with_default_ns
+  alias_method :find_first_base, :find_first unless method_defined?(:find_first_base)
+  alias_method :find_first, :find_first_with_default_ns
+
+end
+
+class String
+  def to_libxml_doc
+    xp = XML::Parser.new
+    xp.string = self
+    return xp.parse
+  end
+end

data/test/libxml_bindings_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class LibxmlBindingsTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'libxml_bindings'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: dreamcat4-libxml-bindings
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- dreamcat4
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dreamcat4@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/libxml_bindings.rb
+- test/libxml_bindings_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/dreamcat4/libxml-bindings
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Dreamcat4's bindings for libxml-ruby. In development. This gem will provide convenience functions for both reading and writing XML in ruby. Implemented as wrapper for underlying libxml2 / SAX. Aims are to be faster (very much) and simpler (little bit) than hpricot. This project is a continuation / extension of libxml_helper.rb by Phil Bogle.
+test_files: 
+- test/libxml_bindings_test.rb
+- test/test_helper.rb