teius 0.0.2 → 0.1.0

data/ext/Makefile

@@ -0,0 +1,138 @@
+
+SHELL = /bin/sh
+
+#### Start of system configuration section. ####
+
+srcdir = .
+topdir = d:/msys/local/lib/ruby/1.8/i386-mingw32
+hdrdir = $(topdir)
+VPATH = $(srcdir);$(topdir);$(hdrdir)
+
+DESTDIR = d:
+prefix = $(DESTDIR)/msys/local
+exec_prefix = $(DESTDIR)/msys/local
+sitedir = $(prefix)/lib/ruby/site_ruby
+rubylibdir = $(libdir)/ruby/$(ruby_version)
+archdir = $(rubylibdir)/$(arch)
+sbindir = $(exec_prefix)/sbin
+datadir = $(prefix)/share
+includedir = $(prefix)/include
+infodir = $(prefix)/info
+sysconfdir = $(prefix)/etc
+mandir = $(prefix)/man
+libdir = $(DESTDIR)/msys/local/lib
+sharedstatedir = $(prefix)/com
+oldincludedir = $(DESTDIR)/usr/include
+sitearchdir = $(sitelibdir)/$(sitearch)
+bindir = $(exec_prefix)/bin
+localstatedir = $(prefix)/var
+sitelibdir = $(sitedir)/$(ruby_version)
+libexecdir = $(exec_prefix)/libexec
+
+CC = gcc
+LIBRUBY = lib$(LIBRUBY_SO).a
+LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
+LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME)
+LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static
+
+CFLAGS   =  -g -O2  
+CPPFLAGS = -I. -I$(topdir) -I$(hdrdir) -I$(srcdir)  -Id:/msys/local/include/libxml2 
+CXXFLAGS = $(CFLAGS) 
+DLDFLAGS =   -Wl,--enable-auto-import,--export-all 
+LDSHARED = gcc -shared -s
+AR = ar
+EXEEXT = .exe
+
+RUBY_INSTALL_NAME = ruby
+RUBY_SO_NAME = msvcrt-ruby18
+arch = i386-mingw32
+sitearch = i386-msvcrt
+ruby_version = 1.8
+ruby = d:/msys/local/bin/ruby
+RUBY = $(ruby)
+RM = rm -f
+MAKEDIRS = mkdir -p
+INSTALL = /bin/install -c
+INSTALL_PROG = $(INSTALL) -m 0755
+INSTALL_DATA = $(INSTALL) -m 644
+COPY = cp
+
+#### End of system configuration section. ####
+
+preload = 
+
+libpath = d:/msys/local/lib $(libdir)
+LIBPATH =  -L"d:/msys/local/lib" -L"$(libdir)"
+DEFFILE = 
+
+CLEANFILES = 
+DISTCLEANFILES = 
+
+extout = 
+extout_prefix = 
+target_prefix = 
+LOCAL_LIBS = 
+LIBS = $(LIBRUBYARG_SHARED) -lxml2  -lwsock32  
+SRCS = teius.c
+OBJS = teius.o
+TARGET = teius
+DLLIB = $(TARGET).so
+STATIC_LIB = 
+
+RUBYCOMMONDIR = $(sitedir)$(target_prefix)
+RUBYLIBDIR    = $(sitelibdir)$(target_prefix)
+RUBYARCHDIR   = $(sitearchdir)$(target_prefix)
+
+TARGET_SO     = $(DLLIB)
+CLEANLIBS     = $(TARGET).so $(TARGET).il? $(TARGET).tds $(TARGET).map
+CLEANOBJS     = *.o *.a *.s[ol] *.pdb *.exp *.bak
+
+all:		$(DLLIB)
+static:		$(STATIC_LIB)
+
+clean:
+		@-$(RM) $(CLEANLIBS:/=\) $(CLEANOBJS:/=\) $(CLEANFILES:/=\)
+
+distclean:	clean
+		@-$(RM) Makefile extconf.h conftest.* mkmf.log
+		@-$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES:/=\)
+
+realclean:	distclean
+install: install-so install-rb
+
+install-so: $(RUBYARCHDIR)
+install-so: $(RUBYARCHDIR)/$(DLLIB)
+$(RUBYARCHDIR)/$(DLLIB): $(DLLIB)
+	$(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR)
+install-rb: pre-install-rb install-rb-default
+install-rb-default: pre-install-rb-default
+pre-install-rb: Makefile
+pre-install-rb-default: Makefile
+$(RUBYARCHDIR):
+	$(MAKEDIRS) $@
+
+site-install: site-install-so site-install-rb
+site-install-so: install-so
+site-install-rb: install-rb
+
+.SUFFIXES: .c .m .cc .cxx .cpp .o
+
+.cc.o:
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) -c $<
+
+.cxx.o:
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) -c $<
+
+.cpp.o:
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) -c $<
+
+.c.o:
+	$(CC) $(CFLAGS) $(CPPFLAGS) -c $<
+
+$(DLLIB): $(OBJS)
+	@-$(RM) $@
+	$(LDSHARED) $(DLDFLAGS) $(LIBPATH) -o $@ $(OBJS) $(LOCAL_LIBS) $(LIBS)
+
+
+
+$(OBJS): ruby.h defines.h

data/ext/teius.c

@@ -6,12 +6,14 @@
 
 static VALUE cParseError;
 static VALUE cXpathError;
-static VALUE cElementNotFound;
+static VALUE cNodeNotFound;
+static VALUE cNodeNotUnique;
 static VALUE cNode;
 static VALUE cDocument;
 static ID    sRequired;
 static ID    sFirst;
 static ID    sAll;
+static ID    sUnique;
 
 static void doc_free(void *p) {
   xmlFreeDoc(p);
@@ -62,24 +64,24 @@ static VALUE node_find(int argc, VALUE *argv, VALUE self) {
   rb_scan_args(argc, argv, "21", &rType, &rXpath, &rOptions);
   int required = 0;
   if (argc == 3) {
-    VALUE rRequired = rb_hash_aref(rOptions, sRequired);
-    required = rRequired != Qnil;
+    VALUE rRequired = rb_hash_aref(rOptions, ID2SYM(sRequired));
+    required = rRequired != Qnil && rRequired != Qfalse;
   }
 
   xmlNodePtr node = NULL;
   Data_Get_Struct(self, xmlNode, node);
   xmlDocPtr doc = node->doc;
 
-	xmlXPathContextPtr context;
-	xmlXPathObjectPtr result;
+  xmlXPathContextPtr context;
+  xmlXPathObjectPtr result;
 
-	context = xmlXPathNewContext(doc);
+  context = xmlXPathNewContext(doc);
   context->node = node;
 
   char *xpath = StringValuePtr(rXpath);
   result  = xmlXPathEvalExpression(xpath, context);
   if (result == NULL) {
-		xmlErrorPtr	err = xmlGetLastError();
+    xmlErrorPtr  err = xmlGetLastError();
     xmlXPathFreeContext(context);
     rb_raise(cXpathError, "Couldn't evaluate xpath [%s]: %s",
       xpath, err->message);
@@ -88,19 +90,24 @@ static VALUE node_find(int argc, VALUE *argv, VALUE self) {
   xmlNodeSetPtr node_set = result->nodesetval;
   int size = node_set != NULL ? node_set->nodeNr : 0;
 
+  ID type = SYM2ID(rType);
   if (size == 0 && required) {
     xmlXPathFreeObject(result);
     xmlXPathFreeContext(context);
-    rb_raise(cElementNotFound, "No such element in %s: %s", node->name, xpath);
+    rb_raise(cNodeNotFound, "No such node in %s: %s", node->name, xpath);
+  } else if (size > 1 && type == sUnique) {
+    xmlXPathFreeObject(result);
+    xmlXPathFreeContext(context);
+    rb_raise(cNodeNotUnique, "node at path %s from %s is not unique", 
+      xpath, node->name);
   }
 
   VALUE rResult;
-  ID type = SYM2ID(rType);
-  if (type == sFirst) {      /* Just return first node */
+  if (type == sFirst || type == sUnique) {      /* Just return first node */
     if (size == 0) {
       rResult = Qnil;
     } else {
-  	  rResult = Data_Wrap_Struct(cNode, 0, 0, node_set->nodeTab[0]);      
+      rResult = Data_Wrap_Struct(cNode, 0, 0, node_set->nodeTab[0]);      
     }
   } else if (type == sAll) { /* Return ruby array of all nodes */
     int i;
@@ -108,15 +115,15 @@ static VALUE node_find(int argc, VALUE *argv, VALUE self) {
     for (i=0; i < size; i++) {
       xmlNodePtr cur_node = node_set->nodeTab[i];
 
-      /* Create LibxmlElement and store it in arr */
+      /* Create Node and store it in arr */
       VALUE rNode = Data_Wrap_Struct(cNode, 0, 0, cur_node);
       rb_ary_store(arr, i, rNode);
     }
-    rResult = arr;
+    rResult = arr;    
   } else {
     xmlXPathFreeObject(result);
     xmlXPathFreeContext(context);
-    rb_raise(rb_eArgError, "Unknown type: :%s (should be :first or :all)", 
+    rb_raise(rb_eArgError, "Unknown type: :%s (should be :first, :unique or :all)", 
       rb_id2name(type));
   }
 
@@ -132,18 +139,56 @@ static VALUE node_name(VALUE self) {
   return rb_str_new2(node->name);
 }
 
+static VALUE node_xpath(VALUE self) {
+  xmlNodePtr node = NULL;
+  Data_Get_Struct(self, xmlNode, node);
+  return rb_str_new2(xmlGetNodePath(node));
+}
+
+static VALUE node_pointer(VALUE self) {
+  xmlNodePtr node = NULL;
+  Data_Get_Struct(self, xmlNode, node);
+  return INT2NUM((int)node);
+}
+
 static VALUE parse_file(VALUE self, VALUE rFilename) {
-	xmlDocPtr doc = xmlReadFile(StringValuePtr(rFilename), NULL, 0);
+  xmlDocPtr doc = xmlReadFile(StringValuePtr(rFilename), NULL, 0);
   if (doc == NULL) {
-		xmlErrorPtr	err = xmlGetLastError();
-		rb_raise(cParseError, "could not parse file %s: %s", 
-			StringValuePtr(rFilename), err->message);
+    xmlErrorPtr  err = xmlGetLastError();
+    rb_raise(cParseError, "could not parse file %s: %s", 
+      StringValuePtr(rFilename), err->message);
   }
 
-	/* Load new document */
-	VALUE rDoc = Data_Wrap_Struct(cDocument, 0, doc_free, doc);
+  /* Load new document */
+  VALUE rDoc = Data_Wrap_Struct(cDocument, 0, doc_free, doc);
 
-	return rDoc;
+  return rDoc;
+}
+
+static VALUE parse_string(VALUE self, VALUE rDocString) {
+  xmlDocPtr doc = xmlReadDoc(StringValuePtr(rDocString), NULL, NULL, 0);
+  if (doc == NULL) {
+    xmlErrorPtr  err = xmlGetLastError();
+    rb_raise(cParseError, "could not parse string: %s", err->message);
+  }
+
+  /* Load new document */
+  VALUE rDoc = Data_Wrap_Struct(cDocument, 0, doc_free, doc);
+
+  return rDoc;
+}
+
+static VALUE document_to_s(VALUE self, VALUE rDocString) {
+  xmlDocPtr  doc  = NULL;
+  xmlChar *mem;
+  int size;
+  
+  Data_Get_Struct(self, xmlDoc, doc);
+  xmlDocDumpMemory(doc, &mem, &size);
+  VALUE rStr = rb_str_new2(mem);
+  xmlFree(mem);
+  
+  return rStr;
 }
 
 void Init_teius() {
@@ -153,25 +198,32 @@ void Init_teius() {
   sRequired = rb_intern("required");
   sFirst    = rb_intern("first");
   sAll      = rb_intern("all");
+  sUnique   = rb_intern("unique");
 
   /* Modules */
   VALUE mTeius = rb_define_module("Teius");
 
   /* Exceptions */
-	cParseError = rb_define_class_under(mTeius, "ParseError", rb_eStandardError);
-	cXpathError = rb_define_class_under(mTeius, "XpathError", rb_eStandardError);
-	cElementNotFound = rb_define_class_under(mTeius, 
-    "ElementNotFound", rb_eStandardError);
-
-  /* LibxmlElement */
-	cNode = rb_define_class_under(mTeius, "Node", rb_cObject);
-	rb_define_method(cNode, "value",	node_value, 0);	
-	rb_define_method(cNode, "document",	node_document, 0);	
-	rb_define_method(cNode, "attributes",	node_attributes, 0);	
-	rb_define_method(cNode, "find",	node_find, -1);	
-	rb_define_method(cNode, "name",	node_name, 0);	
-  
-  /* LibxmlDocument */
+  cParseError = rb_define_class_under(mTeius, "ParseError", rb_eStandardError);
+  cXpathError = rb_define_class_under(mTeius, "XpathError", rb_eStandardError);
+  cNodeNotFound = rb_define_class_under(mTeius, 
+    "NodeNotFound", rb_eStandardError);
+  cNodeNotUnique = rb_define_class_under(mTeius, 
+    "NodeNotUnique", rb_eStandardError);
+
+  /* Node */
+  cNode = rb_define_class_under(mTeius, "Node", rb_cObject);
+  rb_define_method(cNode, "value",  node_value, 0);  
+  rb_define_method(cNode, "document",  node_document, 0);  
+  rb_define_method(cNode, "attributes",  node_attributes, 0);  
+  rb_define_method(cNode, "find",  node_find, -1);  
+  rb_define_method(cNode, "name",  node_name, 0);  
+  rb_define_method(cNode, "xpath",  node_xpath, 0);  
+  rb_define_method(cNode, "pointer",  node_pointer, 0);  
+
+  /* Document */
   cDocument = rb_define_class_under(mTeius, "Document", cNode);
-	rb_define_singleton_method(cDocument, "parse_file",	parse_file, 1);	
+  rb_define_singleton_method(cDocument, "parse_file",  parse_file, 1);  
+  rb_define_singleton_method(cDocument, "parse_string",  parse_string, 1);  
+  rb_define_method(cNode, "to_s",  document_to_s, 0);  
 }

data/lib/teius.rb

@@ -0,0 +1,35 @@
+require 'teius.so'
+
+module Teius
+  class Node
+    def fetch(xpath)
+      node = find(:unique, xpath, :required => true)
+      return node ? node.value : nil
+    end
+    
+    def ==(other)
+      self.pointer == other.pointer
+    end
+
+    def eql?(other)
+      self.pointer == other.pointer
+    end
+    
+    def hash
+      self.pointer
+    end
+    
+    def parent
+      self.find :first, '..'
+    end
+    
+    def siblings
+      self.find :all, 'preceding-sibling::*|following-sibling::*'
+    end
+    
+    def children
+      self.find :all, 'child::*'
+    end
+    
+  end
+end

data/test/teius_test.rb

@@ -1,6 +1,4 @@
-$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib')
-require 'rubygems'
-# need require_gem?
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'test/unit'
 require 'teius'
 
@@ -80,5 +78,61 @@ class TeiusTest < Test::Unit::TestCase
     assert_equal 'en-US', atts['language']
     assert_equal 8, atts.length    
   end
+  
+  def test_unique_find
+    el = @doc.find :unique, '/sports-content/sports-metadata/sports-title'
+    assert_equal 'Score Update: Chicago vs. Green Bay (Final)', el.value
+    assert_raise(NodeNotUnique) { @doc.find :unique, '//sports-content-code' }
+    assert_nil @doc.find(:unique, '/bogus')
+    assert_raise(NodeNotFound) { @doc.find :unique, '/bogus', { :required => true } }
+  end
+
+  def test_fetch
+    assert_equal 'Score Update: Chicago vs. Green Bay (Final)', 
+      @doc.fetch('/sports-content/sports-metadata/sports-title')
+  end
 
+  def test_equality
+    n1 = @doc.find :first, '//team[1]'
+    assert_not_nil n1
+    n2 = @doc.find :first, '/sports-content/sports-event/team[1]'
+    assert_not_nil n2
+    assert_equal n1, n2
+  end
+
+  def test_hash
+    n1 = @doc.find :first, '//team[1]'
+    assert_not_nil n1
+    n2 = @doc.find :first, '/sports-content/sports-event/team[1]'
+    assert n1.eql?(n2)
+    hash = Hash.new
+    hash[n1] = 'test'
+    assert_equal 'test', hash[n2]
+  end
+  
+  def test_parse_string
+    doc = Document.parse_string '<library><book /></library>'
+    book = doc.find :first, '//book'
+    assert_not_nil book
+  end
+  
+  def test_xpath
+    n1 = @doc.find :first, '//team[1]'
+    n2 = @doc.find :first, '/sports-content/sports-event/team[1]'
+    assert_equal '/sports-content/sports-event/team[1]', n1.xpath
+    assert_equal n1, n2
+  end
+  
+  def test_to_s
+    txt = @doc.to_s
+    assert_match /<\?xml version=/, txt
+    assert_match /Chicago 3 for 11 yards/, txt    
+  end
+  
+  def test_siblings
+    e = @doc.find :first, '//sports-content-code[5]'
+    sibs = e.siblings
+    assert_equal 9, sibs.size
+  end
+  
 end

metadata

@@ -1,10 +1,10 @@
-!ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification 
 rubygems_version: 0.8.11
 specification_version: 1
 name: teius
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2006-03-06 00:00:00 +02:00
+  version: 0.1.0
+date: 2006-05-05 00:00:00 +02:00
 summary: Light-weight Ruby API to LibXML.
 require_paths: 
 - lib
@@ -29,7 +29,12 @@ authors:
 - Joshua Harvey
 files: 
 - ext/extconf.rb
+- ext/Makefile
 - ext/teius.c
+- ext/teius.o
+- ext/teius.so
+- lib/teius.rb
+- lib/teius.so
 - test/teius_test.rb
 - xml/xt.3608774-update-mid-event.xml
 - xml/xt.3608787-update-post-event.xml