teius 0.5 → 0.12

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+Gem::manage_gems
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+task :default => ['test']
+
+spec = Gem::Specification.new do |s|
+  s.name = %q{teius}
+  # Note: use symbols, not constants for node type
+  s.version = "0.12"
+  s.date = %q{2006-07-27}
+  s.summary = %q{Light-weight Ruby API to LibXML.}
+  s.email = %q{joshmh@gmail.com}
+  s.homepage = %q{http://teius.rubyforge.org}
+  s.rubyforge_project = %q{teius}
+  s.description = %q{Teius is a very lightweight Ruby API around the LibXML C library. The idea is to use a syntax reminiscent of Ruby On Rails' find method to quickly process information from an XML document.}
+  s.require_paths = [ 'lib' ]
+  s.autorequire = %q{teius}
+  s.has_rdoc = false
+  s.authors = ["Joshua Harvey"]
+  s.files = FileList[ '{test,xml,doc}/**/*', 'ext/*.rb', 'ext/*.c', 'lib/*.rb', 
+    'Rakefile' ].to_a
+  s.test_file = 'test/teius_test.rb'
+  s.platform = Gem::Platform::RUBY
+  s.extensions = [ 'ext/extconf.rb' ]
+#  s.rdoc_options = ["--main", "README"]
+#  s.extra_rdoc_files = ["README"]
+end
+
+win_spec = spec.clone
+win_spec.platform = %q{mswin32}
+win_spec.files = FileList["{ext,lib,test,xml,doc,dll}/**/*"].to_a
+win_spec.extensions = nil
+win_spec.require_paths << 'dll'
+
+Rake::GemPackageTask.new(spec) do |pkg|
+	pkg.need_zip = false
+	pkg.need_tar = true
+end
+
+Rake::GemPackageTask.new(win_spec) do |pkg|
+	pkg.need_zip = true
+	pkg.need_tar = false
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*.rb']
+  t.libs = ['../lib','..']
+  t.ruby_opts = ['-xtest']
+  t.verbose = true
+end

data/ext/extconf.rb

@@ -1,7 +1,51 @@
 require 'mkmf'
 
-dir_config('libxml', '/usr/include/libxml', '/usr/lib');
-dir_config('libxslt', '/usr/include', '/usr/lib');
+def crash(str)
+  printf(" extconf failure: %s\n", str)
+  exit 1
+end
+
+dir_config('xml2');
+unless (have_library('xml2', 'xmlParseDoc') or
+        find_library('xml2', '/opt/lib', '/usr/local/lib', '/usr/lib')) and 
+       (have_header('libxml/xmlversion.h') or
+        find_header('libxml/xmlversion.h', 
+                    '/opt/include/libxml2', 
+                    '/usr/local/include/libxml2',
+                    '/usr/include/libxml',
+                    '/usr/include/libxml2'))
+  crash(<<EOL)
+need libxml2.
+
+        Install the library or try one of the following options to extconf.rb:
+
+        --with-xml2-dir=/path/to/libxml2
+        --with-xml2-lib=/path/to/libxml2/lib
+        --with-xml2-include=/path/to/libxml2/include
+EOL
+end
+
+dir_config('libxslt');
+unless (have_library('xslt', 'xsltApplyStylesheet') or
+        find_library('xslt', '/opt/lib', '/usr/local/lib', '/usr/lib')) and 
+       (have_header('libxslt/xslt.h') or
+        find_header('libxslt/xslt.h', 
+                    '/opt/include/libxslt', 
+                    '/usr/local/include/libxslt',
+                    '/usr/include/libxslt'))
+  crash(<<EOL)
+need libxslt.
+
+        Install the library or try one of the following options to extconf.rb:
+
+        --with-xslt-dir=/path/to/libxslt
+        --with-xslt-lib=/path/to/libxslt/lib
+        --with-xslt-include=/path/to/libxslt/include
+EOL
+end
+
 have_library('xml2', 'xmlReadFile')
 have_library('xslt', 'xsltParseStylesheetFile')
-create_makefile("teius")
+
+$CFLAGS << ' ' << $INCFLAGS
+create_makefile('teius')

data/ext/teius.c

@@ -35,7 +35,7 @@ static VALUE node_value(VALUE self) {
   Data_Get_Struct(self, xmlNode, node);
 
   xmlChar *val = xmlNodeGetContent(node);  
-  VALUE rVal = rb_str_new2(val);
+  VALUE rVal = rb_str_new2((char *)val);
   xmlFree(val);
 
   return rVal;
@@ -59,9 +59,9 @@ static VALUE node_attributes(VALUE self) {
   xmlAttrPtr attrs = node->properties;
   VALUE rHash = rb_hash_new();
   while (attrs != NULL) {
-    VALUE rName = rb_str_new2(attrs->name);
+    VALUE rName = rb_str_new2((char *)attrs->name);
     xmlChar *val = xmlNodeGetContent(attrs->children);    
-    VALUE rVal = rb_str_new2(val);
+    VALUE rVal = rb_str_new2((char *)val);
     rb_hash_aset(rHash, rName, rVal);    
     xmlFree(val);
     attrs = attrs->next;
@@ -90,7 +90,7 @@ static VALUE node_find(int argc, VALUE *argv, VALUE self) {
   context->node = node;
 
   char *xpath = StringValuePtr(rXpath);
-  result  = xmlXPathEvalExpression(xpath, context);
+  result  = xmlXPathEvalExpression((xmlChar *)xpath, context);
   if (result == NULL) {
     xmlErrorPtr  err = xmlGetLastError();
     xmlXPathFreeContext(context);
@@ -147,13 +147,42 @@ static VALUE node_find(int argc, VALUE *argv, VALUE self) {
 static VALUE node_name(VALUE self) {
   xmlNodePtr node = NULL;
   Data_Get_Struct(self, xmlNode, node);
-  return rb_str_new2(node->name);
+  return rb_str_new2((char *)node->name);
 }
 
 static VALUE node_xpath(VALUE self) {
   xmlNodePtr node = NULL;
   Data_Get_Struct(self, xmlNode, node);
-  return rb_str_new2(xmlGetNodePath(node));
+  return rb_str_new2((char *)xmlGetNodePath(node));
+}
+
+static VALUE node_type(VALUE self) {
+  xmlNodePtr node = NULL;
+  Data_Get_Struct(self, xmlNode, node);
+    
+  switch (node->type) {
+  case 1:  return ID2SYM(rb_intern("element"));  
+  case 2:  return ID2SYM(rb_intern("attribute"));  
+  case 3:  return ID2SYM(rb_intern("text"));  
+  case 4:  return ID2SYM(rb_intern("cdata_section"));  
+  case 5:  return ID2SYM(rb_intern("entity_ref"));  
+  case 6:  return ID2SYM(rb_intern("entity"));  
+  case 7:  return ID2SYM(rb_intern("pi"));  
+  case 8:  return ID2SYM(rb_intern("comment"));  
+  case 9:  return ID2SYM(rb_intern("document"));  
+  case 10: return ID2SYM(rb_intern("document_type"));  
+  case 11: return ID2SYM(rb_intern("document_fragment"));  
+  case 12: return ID2SYM(rb_intern("notation"));  
+  case 13: return ID2SYM(rb_intern("html_document"));  
+  case 14: return ID2SYM(rb_intern("dtd"));  
+  case 15: return ID2SYM(rb_intern("element_declaration"));  
+  case 16: return ID2SYM(rb_intern("attribute_declaration"));  
+  case 17: return ID2SYM(rb_intern("entity_declaration"));  
+  case 18: return ID2SYM(rb_intern("namespace_declaration"));  
+  case 19: return ID2SYM(rb_intern("xinclude_start"));  
+  case 20: return ID2SYM(rb_intern("xinclude_end"));  
+  case 21: return ID2SYM(rb_intern("docb_document"));  
+  }
 }
 
 static VALUE node_pointer(VALUE self) {
@@ -180,12 +209,27 @@ static VALUE node_content(VALUE self) {
   buf = xmlBufferCreate();
   size = xmlNodeDump(buf, node->doc, node, 0, 1);
   mem  = xmlBufferContent(buf);
-  VALUE rStr = rb_str_new2(mem);
+  VALUE rStr = rb_str_new2((char *)mem);
   xmlBufferFree(buf);
   
   return rStr;
 }
 
+static VALUE node_children(VALUE self) {
+  xmlNodePtr node = NULL;
+  xmlNodePtr cur_child = NULL;
+  
+  Data_Get_Struct(self, xmlNode, node);
+  
+  VALUE rArr = rb_ary_new();
+  for (cur_child = node->children;	cur_child != NULL; cur_child = cur_child->next) {
+    VALUE rNode = Data_Wrap_Struct(cNode, 0, 0, cur_child);
+    rb_ary_push(rArr, rNode);
+  }
+  
+  return rArr;
+}
+
 static VALUE document_parse_file(VALUE self, VALUE rFilename) {
   xmlDocPtr doc = xmlReadFile(StringValuePtr(rFilename), NULL, 0);
   if (doc == NULL) {
@@ -195,20 +239,20 @@ static VALUE document_parse_file(VALUE self, VALUE rFilename) {
   }
 
   /* Load new document */
-  VALUE rDoc = Data_Wrap_Struct(cDocument, 0, doc_free, doc);
+  VALUE rDoc = Data_Wrap_Struct(self, 0, doc_free, doc);
 
   return rDoc;
 }
 
 static VALUE document_parse_string(VALUE self, VALUE rDocString) {
-  xmlDocPtr doc = xmlReadDoc(StringValuePtr(rDocString), NULL, NULL, 0);
+  xmlDocPtr doc = xmlReadDoc((xmlChar *)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);
+  VALUE rDoc = Data_Wrap_Struct(self, 0, doc_free, doc);
 
   return rDoc;
 }
@@ -220,7 +264,7 @@ static VALUE document_to_s(VALUE self) {
   
   Data_Get_Struct(self, xmlDoc, doc);
   xmlDocDumpMemory(doc, &mem, &size);
-  VALUE rStr = rb_str_new2(mem);
+  VALUE rStr = rb_str_new2((char *)mem);
   xmlFree(mem);
   
   return rStr;
@@ -244,7 +288,7 @@ static void stylesheet_free(void *p) {
 }
 
 static VALUE stylesheet_parse_file(VALUE self, VALUE rFilename) {
-  xsltStylesheetPtr xsl = xsltParseStylesheetFile(StringValuePtr(rFilename));
+  xsltStylesheetPtr xsl = xsltParseStylesheetFile((xmlChar *)StringValuePtr(rFilename));
   if (xsl == NULL) {
     xmlErrorPtr  err = xmlGetLastError();
     rb_raise(cParseError, "could not parse file %s: %s", 
@@ -252,11 +296,23 @@ static VALUE stylesheet_parse_file(VALUE self, VALUE rFilename) {
   }
 
   /* Load new document */
-  VALUE rStylesheet = Data_Wrap_Struct(cStylesheet, 0, stylesheet_free, xsl);
+  VALUE rStylesheet = Data_Wrap_Struct(self, 0, stylesheet_free, xsl);
 
   return rStylesheet;
 }
 
+static VALUE stylesheet_output_method(VALUE self) {
+  xsltStylesheetPtr stylesheet = NULL;
+  
+  Data_Get_Struct(self, xsltStylesheet, stylesheet);
+  if (stylesheet->method == NULL) {
+    return Qnil;
+  } else {
+    VALUE rStr = rb_str_new2((char *)stylesheet->method);
+    return rStr;
+  }
+}
+
 static VALUE stylesheet_apply(VALUE self, VALUE rDocument) {
   xsltStylesheetPtr stylesheet = NULL;
   xmlDocPtr  doc = NULL, res = NULL;
@@ -304,7 +360,7 @@ static VALUE stylesheet_save_to_string(VALUE self, VALUE rResult) {
     rb_raise(rb_eStandardError, "could not save stylesheet result to string: %s", 
       err->message);
   }
-  VALUE rStr = rb_str_new2(mem);
+  VALUE rStr = rb_str_new2((char *)mem);
   xmlFree(mem);
   
   return rStr;
@@ -341,9 +397,11 @@ void Init_teius() {
   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, "type",  node_type, 0);  
   rb_define_method(cNode, "pointer",  node_pointer, 0);  
   rb_define_method(cNode, "line",  node_line, 0);  
   rb_define_method(cNode, "content",  node_content, 0);  
+  rb_define_method(cNode, "children",  node_children, 0);  
 
   /* Document */
   cDocument = rb_define_class_under(mTeius, "Document", cNode);
@@ -353,8 +411,9 @@ void Init_teius() {
   rb_define_method(cDocument, "root", document_root, 0);  
   
   /* XSL Stylesheet */
-  cStylesheet = rb_define_class_under(mTeius, "Stylesheet", cNode);
+  cStylesheet = rb_define_class_under(mTeius, "Stylesheet", rb_cObject);
   rb_define_singleton_method(cStylesheet, "parse_file",  stylesheet_parse_file, 1);  
+  rb_define_method(cStylesheet, "output_method", stylesheet_output_method, 0);  
   rb_define_method(cStylesheet, "apply", stylesheet_apply, 1);  
   rb_define_method(cStylesheet, "save_to_string", stylesheet_save_to_string, 1);  
   rb_define_method(cStylesheet, "save_to_file", stylesheet_save_to_file, 2);  

data/lib/teius.rb

@@ -1,6 +1,9 @@
-require File.join(File.dirname(__FILE__), '..', 'ext', 'teius.so')
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..', 'ext')
+require 'teius.so'
 
 module Teius
+    
   class Document
   
     def self.content(xml)
@@ -43,11 +46,7 @@ module Teius
     def siblings
       self.find :all, 'preceding-sibling::*|following-sibling::*'
     end
-    
-    def children
-      self.find :all, 'child::*'
-    end
-    
+        
     def to_s
       "#{name}:#{line}"
     end

data/test/teius_test.rb

@@ -6,6 +6,9 @@ require 'tempfile'
 class TeiusTest < Test::Unit::TestCase
   include Teius
 
+  class SubTeius < Document
+  end
+  
   def setup    
     @xml_dir = File.join(File.dirname(__FILE__), '..', 'xml')
     @doc = Document.parse_file File.join(@xml_dir, 
@@ -26,7 +29,13 @@ class TeiusTest < Test::Unit::TestCase
     assert_equal 'xt.3608787-update-post-event', el.value
     assert_equal 'doc-id', el.name
   end
-
+  
+  def test_inheritance
+    doc = SubTeius.parse_file File.join(@xml_dir, 
+      'xt.3608787-update-post-event.xml')
+    assert_kind_of SubTeius, doc
+  end
+  
   def test_relative_paths
     meta = @doc.find :first, '/sports-content/sports-metadata'
     assert_not_nil meta
@@ -135,6 +144,12 @@ class TeiusTest < Test::Unit::TestCase
     sibs = e.siblings
     assert_equal 9, sibs.size
   end
+
+  def test_children
+    e = @doc.find :first, '//sports-content-codes'
+    children = e.children
+    assert_equal 10, children.size
+  end
   
   def test_xslt
     current_dir = File.dirname(__FILE__)
@@ -142,10 +157,17 @@ class TeiusTest < Test::Unit::TestCase
     xsl_path = File.join(current_dir, 'test.xsl')
     doc = Document.parse_file test_doc_path
     xsl = Stylesheet.parse_file xsl_path
+    assert_equal 'xml', xsl.output_method
     assert_no_match %r{menu}, doc.to_s
     assert_match %r{menu}, xsl.transform(doc)
   end
   
+  def test_bogus_xslt
+    assert_raise(ParseError) {
+      xsl = Stylesheet.parse_file 'bogus'
+    }
+  end
+
   def test_xslt_write_to_file
     current_dir = File.dirname(__FILE__)
     test_doc_path = File.join(current_dir, 'input.xml')
@@ -193,4 +215,17 @@ class TeiusTest < Test::Unit::TestCase
     assert_equal "<library>\n  <book/>\n</library>", content
   end
   
+  def test_node_type
+    node = @doc.find :first, '//team-metadata'
+    assert_equal :element, node.type  
+    assert_equal :document, @doc.type
+  end
+  
+  def test_text_node
+    title = @doc.find :first, '/sports-content/sports-metadata/sports-title'      
+    text = title.children.first
+    assert_equal :text, text.type
+    assert_equal "Score Update: Chicago vs. Green Bay (Final)", text.value
+  end
+  
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: teius
 version: !ruby/object:Gem::Version 
-  version: "0.5"
-date: 2006-06-28 00:00:00 +03:00
+  version: "0.12"
+date: 2006-07-27 00:00:00 +03:00
 summary: Light-weight Ruby API to LibXML.
 require_paths: 
 - lib
@@ -26,6 +26,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Joshua Harvey
 files: 
@@ -38,6 +39,7 @@ files:
 - ext/extconf.rb
 - ext/teius.c
 - lib/teius.rb
+- Rakefile
 test_files: 
 - test/teius_test.rb
 rdoc_options: []