libxslt-ruby 0.7.0 → 0.8.0

data/doc/files/ext/libxslt/ruby_xslt_stylesheet_c.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jul 10 16:41:53 Mountain Daylight Time 2008</td>
+      <td>Tue Jul 15 15:49:01 Mountain Daylight Time 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/ext/libxslt/ruby_xslt_transform_context_c.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jul 10 16:43:51 Mountain Daylight Time 2008</td>
+      <td>Tue Jul 15 15:39:34 Mountain Daylight Time 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/{deprecated_rb.html → libxslt/deprecated_rb.html}

@@ -8,7 +8,7 @@
   <title>File: deprecated.rb</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
 
@@ -51,12 +51,12 @@
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/deprecated.rb
+      <td>lib/libxslt/deprecated.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jul 10 16:33:37 Mountain Daylight Time 2008</td>
+      <td>Tue Jul 15 15:48:02 Mountain Daylight Time 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/libxslt_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed Jul 09 23:12:35 Mountain Daylight Time 2008</td>
+      <td>Tue Jul 15 15:41:51 Mountain Daylight Time 2008</td>
     </tr>
     </table>
   </div>
@@ -74,8 +74,8 @@
 
       <div class="name-list">
       libxml&nbsp;&nbsp;
-      libxslt_ruby.so&nbsp;&nbsp;
-      deprecated&nbsp;&nbsp;
+      libxslt_ruby&nbsp;&nbsp;
+      libxslt/deprecated&nbsp;&nbsp;
       </div>
     </div>
 

data/doc/fr_class_index.html

@@ -20,9 +20,12 @@
 <div id="index">
   <h1 class="section-bar">Classes</h1>
   <div id="index-entries">
+    <a href="classes/LibXSLT.html">LibXSLT</a><br />
+    <a href="classes/LibXSLT/XSLT.html">LibXSLT::XSLT</a><br />
+    <a href="classes/LibXSLT/XSLT/Stylesheet.html">LibXSLT::XSLT::Stylesheet</a><br />
+    <a href="classes/LibXSLT/XSLT/TransformContext.html">LibXSLT::XSLT::TransformContext</a><br />
+    <a href="classes/LibXSLT/XSLTError.html">LibXSLT::XSLTError</a><br />
     <a href="classes/XSLT.html">XSLT</a><br />
-    <a href="classes/XSLT/Stylesheet.html">XSLT::Stylesheet</a><br />
-    <a href="classes/XSLT/TransformContext.html">XSLT::TransformContext</a><br />
   </div>
 </div>
 </body>

data/doc/fr_file_index.html

@@ -26,8 +26,8 @@
     <a href="files/ext/libxslt/libxslt_c.html">ext/libxslt/libxslt.c</a><br />
     <a href="files/ext/libxslt/ruby_xslt_stylesheet_c.html">ext/libxslt/ruby_xslt_stylesheet.c</a><br />
     <a href="files/ext/libxslt/ruby_xslt_transform_context_c.html">ext/libxslt/ruby_xslt_transform_context.c</a><br />
-    <a href="files/lib/deprecated_rb.html">lib/deprecated.rb</a><br />
     <a href="files/lib/libxslt_rb.html">lib/libxslt.rb</a><br />
+    <a href="files/lib/libxslt/deprecated_rb.html">lib/libxslt/deprecated.rb</a><br />
   </div>
 </div>
 </body>

data/doc/fr_method_index.html

@@ -20,8 +20,8 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/XSLT/Stylesheet.html#M000002">apply (XSLT::Stylesheet)</a><br />
-    <a href="classes/XSLT/Stylesheet.html#M000001">new (XSLT::Stylesheet)</a><br />
+    <a href="classes/LibXSLT/XSLT/Stylesheet.html#M000002">apply (LibXSLT::XSLT::Stylesheet)</a><br />
+    <a href="classes/LibXSLT/XSLT/Stylesheet.html#M000001">new (LibXSLT::XSLT::Stylesheet)</a><br />
   </div>
 </div>
 </body>

data/ext/libxslt/libxslt.c

@@ -5,40 +5,42 @@
 #include "libxslt.h"
 #include "libxml/xmlversion.h"
 
+VALUE cLibXSLT;
 VALUE cXSLT;
-VALUE eXMLXSLTStylesheetRequireParsedDoc;
-
-/*
- * Document-class: XSLT
- * 
- * The libxslt gem provides Ruby language bindings for GNOME's Libxslt
- * toolkit. It is free software, released under the MIT License.
- *
- * Using the bindings is straightforward:
- *
+VALUE eXSLTError;
+
+/*
+ * Document-class: LibXSLT::XSLT
+ * 
+ * The libxslt gem provides Ruby language bindings for GNOME's Libxslt
+ * toolkit. It is free software, released under the MIT License.
+ *
+ * Using the bindings is straightforward:
+ *
  *  stylesheet_doc = XML::Document.file('stylesheet_file')
  *  stylesheet = XSLT::Stylesheet.new(stylesheet_doc)
  *
  *  xml_doc = XML::Document.file('xml_file')
  *  result = stylesheet.apply(xml_doc)
- * 
- *
-*/
+ * 
+ *
+*/
 
 #ifdef RDOC_NEVER_DEFINED
-  cXSLT = rb_define_module("XSLT");
+  cLibXSLT = rb_define_module("XSLT");
 #endif
 
 
-#if defined(_WIN32)
-__declspec(dllexport) 
-#endif
+#if defined(_WIN32)
+__declspec(dllexport) 
+#endif
 
 void
 Init_libxslt_ruby(void) {
   LIBXML_TEST_VERSION;
   
-  cXSLT = rb_define_module("XSLT");
+  cLibXSLT = rb_define_module("LibXSLT");
+  cXSLT = rb_define_module_under(cLibXSLT, "XSLT");
 
   rb_define_const(cXSLT, "MAX_DEPTH", INT2NUM(xsltMaxDepth));
   rb_define_const(cXSLT, "MAX_SORT", INT2NUM(XSLT_MAX_SORT));
@@ -55,6 +57,8 @@ Init_libxslt_ruby(void) {
   rb_define_const(cXSLT, "NAMESPACE_XT", rb_str_new2((const char*)XSLT_XT_NAMESPACE));
   rb_define_const(cXSLT, "NAMESPACE_XALAN", rb_str_new2((const char*)XSLT_XALAN_NAMESPACE));
 
+  eXSLTError = rb_define_class_under(cLibXSLT, "XSLTError", rb_eRuntimeError);
+
   ruby_init_xslt_stylesheet();
   ruby_init_xslt_transform_context();
 }

data/ext/libxslt/libxslt.h

@@ -21,14 +21,12 @@
 
 #include "version.h"
 
-#define RUBY_LIBXSLT_SRC_TYPE_NULL    0
-#define RUBY_LIBXSLT_SRC_TYPE_FILE    1
-
-extern VALUE cXSLT;
-extern VALUE eXMLXSLTStylesheetRequireParsedDoc;
-
 #if ((RUBY_LIBXML_VER_MAJ != RUBY_LIBXSLT_VER_MAJ) || (RUBY_LIBXML_VER_MIN != RUBY_LIBXSLT_VER_MIN))
 #error "Incompatible LibXML-Ruby headers - please install same major/micro version"
 #endif
 
+extern VALUE cLibXSLT;
+extern VALUE cXSLT;
+extern VALUE eXSLTError;
+
 #endif

data/ext/libxslt/ruby_xslt_stylesheet.c

@@ -5,15 +5,14 @@
 #include "libxslt.h"
 #include "ruby_xslt_stylesheet.h"
 
-/*
- * Document-class: XSLT::Stylesheet
- * 
- * The XSLT::Stylesheet represents a XSL stylesheet that
- * can be used to transform an XML document.  For usage information
- * refer to XSLT::Stylesheet#apply
- *
-*/
-
+/*
+ * Document-class: LibXSLT::XSLT::Stylesheet
+ * 
+ * The XSLT::Stylesheet represents a XSL stylesheet that
+ * can be used to transform an XML document.  For usage information
+ * refer to XSLT::Stylesheet#apply
+ *
+*/
 
 VALUE cXSLTStylesheet;
 
@@ -23,9 +22,9 @@ ruby_xslt_stylesheet_document_klass() {
   return rb_const_get(mXML, rb_intern("Document"));
 }
 
-
 void
 ruby_xslt_stylesheet_free(xsltStylesheetPtr xstylesheet) {
+
   xsltFreeStylesheet(xstylesheet);
 }
 
@@ -40,7 +39,10 @@ ruby_xslt_stylesheet_alloc(VALUE klass) {
 /* call-seq:
  *    XSLT::Stylesheet.new(document) -> XSLT::Stylesheet
  * 
- * Creates a new XSLT stylesheet based on the provided document.
+ * Creates a new XSLT stylesheet based on the specified document.
+ * For memory management reasons, a copy of the specified document
+ * will be made, so its best to create a single copy of a stylesheet
+ * and use it multiple times.
  *
  *  stylesheet_doc = XML::Document.file('stylesheet_file')
  *  stylesheet = XSLT::Stylesheet.new(stylesheet_doc)
@@ -48,13 +50,28 @@ ruby_xslt_stylesheet_alloc(VALUE klass) {
  */
 VALUE
 ruby_xslt_stylesheet_initialize(VALUE self, VALUE document) {
-  ruby_xml_document_t *rdocument;
-
-  if (!rb_obj_is_kind_of(document, ruby_xslt_stylesheet_document_klass()))
-    rb_raise(rb_eTypeError, "Must pass in an XML::Document instance.");
-    
-  Data_Get_Struct(document, ruby_xml_document_t, rdocument);
-  DATA_PTR(self) = xsltParseStylesheetDoc(rdocument->doc);
+  ruby_xml_document_t *rdocument;
+  xmlDocPtr xcopy;
+  xsltStylesheetPtr xstylesheet;
+
+  if (!rb_obj_is_kind_of(document, ruby_xslt_stylesheet_document_klass()))
+    rb_raise(rb_eTypeError, "Must pass in an XML::Document instance.");
+    
+  /* NOTE!! Since the stylesheet own the specified document, the easiest 
+  *  thing to do from a memory standpoint is too copy it and not expose
+  *  the copy to Ruby.  The other solution is expose a memory management
+  *  API on the document object for taking ownership of the document
+  *  and specifying when it has been freed.  Then the document class
+  *  has to be updated to always check and see if the document is 
+  *  still valid.  That's all doable, but seems like a pain, so 
+  *  just copy the document for now. */
+  Data_Get_Struct(document, ruby_xml_document_t, rdocument);
+  xcopy = xmlCopyDoc(rdocument->doc, 1);
+  xstylesheet = xsltParseStylesheetDoc(xcopy);
+  xstylesheet->_private = (void *)self;
+  DATA_PTR(self) = xstylesheet;
+  
+  /* Save a reference to the document as an attribute accessable to ruby*/
   return self;
 }
 
@@ -71,9 +88,9 @@ ruby_xslt_coerce_params(VALUE params) {
   for (i=0; i<length; i++) {
     VALUE str = rb_String(RARRAY(params)->ptr[i]);
     int strLen = RSTRING(str)->len;
-    result[i] = ALLOC_N(char, strLen + 1);
-    memset(result[i], 0, strLen + 1);
-    strncpy(result[i], RSTRING(str)->ptr, strLen);
+    result[i] = ALLOC_N(char, strLen + 1);
+    memset(result[i], 0, strLen + 1);
+    strncpy(result[i], RSTRING(str)->ptr, strLen);
   }
   
   /* Null terminate the array - need to empty elements */
@@ -91,10 +108,8 @@ ruby_xslt_coerce_params(VALUE params) {
  * This method may be invoked multiple times.
  *
  * Params:
- * 
- * document = An instance of an XML::Document
- * params = An optional hash table that specifies the values
- *          for xsl:param values embedded in the stylesheet.
+ * *  document - An instance of an XML::Document
+ * *  params - An optional hash table that specifies the values for xsl:param values embedded in the stylesheet.
  *
  * Example:
  * 
@@ -107,33 +122,36 @@ ruby_xslt_coerce_params(VALUE params) {
  */
 VALUE
 ruby_xslt_stylesheet_apply(int argc, VALUE *argv, VALUE self) {
-  ruby_xml_document_t *rdocument;
-  xsltStylesheetPtr xstylesheet;
+  ruby_xml_document_t *rdocument;
+  xsltStylesheetPtr xstylesheet;
   xmlDocPtr result;
   VALUE document;
   VALUE params;
   int i;
   
   char** pParams;
-
-  if (argc > 2 || argc < 1)
-    rb_raise(rb_eArgError, "wrong number of arguments (need 1 or 2)");
-    
+
+  if (argc > 2 || argc < 1)
+    rb_raise(rb_eArgError, "wrong number of arguments (need 1 or 2)");
+    
   document = argv[0];
   
-  if (!rb_obj_is_kind_of(document, ruby_xslt_stylesheet_document_klass()))
-    rb_raise(rb_eTypeError, "Must pass in an XML::Document instance.");
+  if (!rb_obj_is_kind_of(document, ruby_xslt_stylesheet_document_klass()))
+    rb_raise(rb_eTypeError, "Must pass in an XML::Document instance.");
 
   /* Make sure params is a flat array */
   params = (argc == 2 ? argv[1]: Qnil);
   params = rb_Array(params);
-  rb_funcall(params, rb_intern("flatten!"), 0);
-  pParams = ruby_xslt_coerce_params(params);
-  
-  Data_Get_Struct(document, ruby_xml_document_t, rdocument);
-  Data_Get_Struct(self, xsltStylesheet, xstylesheet);
+  rb_funcall(params, rb_intern("flatten!"), 0);
+  pParams = ruby_xslt_coerce_params(params);
   
-  result = xsltApplyStylesheet(xstylesheet, rdocument->doc, pParams);
+  Data_Get_Struct(document, ruby_xml_document_t, rdocument);
+  Data_Get_Struct(self, xsltStylesheet, xstylesheet);
+  
+  result = xsltApplyStylesheet(xstylesheet, rdocument->doc, (const char**)pParams);
+  
+  if (!result)
+    rb_raise(eXSLTError, "Transformation failed");
   
   /* Free allocated array of *chars.  Note we don't have to
      free the last array item since its set to NULL. */
@@ -247,8 +265,8 @@ ruby_xslt_stylesheet_print(int argc, VALUE *argv, VALUE self) {
 
 
 #ifdef RDOC_NEVER_DEFINED
-  cXSLT = rb_define_module("XSLT");
-  cXSLTStylesheet = rb_define_class_under(cXSLT, "Stylesheet", rb_cObject);
+  cLibXSLT = rb_define_module("LibXSLT");
+  cXSLT = rb_define_module_under(cLibXSLT, "XSLT");
 #endif
 
 void

data/ext/libxslt/ruby_xslt_transform_context.c

@@ -6,7 +6,7 @@
 #include "ruby_xslt_transform_context.h"
 
 
-/* :nodoc: */
+/* :nodoc: */
 
 VALUE cXSLTTransformContext;
 
@@ -53,8 +53,8 @@ ruby_xslt_transform_context_new3(VALUE xslt) {
 }
 
 #ifdef RDOC_NEVER_DEFINED
-  cXSLT = rb_define_module("XSLT");
-  cXSLTTransformContext = rb_define_class_under(cXSLT, "TransformContext", rb_cObject);
+  cLibXSLT = rb_define_module("LibXSLT");
+  cXSLT = rb_define_module_under(cLibXSLT, "XSLT");
 #endif
 
 void

data/ext/libxslt/version.h

@@ -1,5 +1,5 @@
-#define RUBY_LIBXSLT_VERSION  "0.7.0"
+#define RUBY_LIBXSLT_VERSION  "0.8.0"
 #define RUBY_LIBXSLT_VERNUM   0
 #define RUBY_LIBXSLT_VER_MAJ  0
-#define RUBY_LIBXSLT_VER_MIN  7
+#define RUBY_LIBXSLT_VER_MIN  8
 #define RUBY_LIBXSLT_VER_MIC  0

data/lib/libxslt.rb

@@ -1,3 +1,9 @@
 require 'libxml'
-require 'libxslt_ruby.so'
-require 'deprecated'
+require 'libxslt_ruby'
+require 'libxslt/deprecated'
+
+# Map the LibXSLT module into the XSLT module for both backwards
+# compatibility and ease of use.
+module XSLT
+  include LibXSLT::XSLT
+end

data/lib/libxslt/deprecated.rb

@@ -0,0 +1,66 @@
+# :enddoc:
+# These classes provide provide backwards compatibility with 
+# versions of libxslt-ruby prior to version 0.7.0
+
+module XML 
+  module XSLT 
+    MAX_DEPTH            = LibXSLT::XSLT::MAX_DEPTH
+    MAX_SORT             = LibXSLT::XSLT::MAX_SORT
+    ENGINE_VERSION       = LibXSLT::XSLT::ENGINE_VERSION
+    LIBXSLT_VERSION      = LibXSLT::XSLT::LIBXSLT_VERSION
+    LIBXML_VERSION       = LibXSLT::XSLT::LIBXML_VERSION
+    XSLT_NAMESPACE       = LibXSLT::XSLT::XSLT_NAMESPACE
+    DEFAULT_VENDOR       = LibXSLT::XSLT::DEFAULT_VENDOR
+    DEFAULT_VERSION      = LibXSLT::XSLT::DEFAULT_VERSION
+    DEFAULT_URL          = LibXSLT::XSLT::DEFAULT_URL
+    NAMESPACE_LIBXSLT    = LibXSLT::XSLT::NAMESPACE_LIBXSLT
+    NAMESPACE_NORM_SAXON = LibXSLT::XSLT::NAMESPACE_NORM_SAXON
+    NAMESPACE_SAXON      = LibXSLT::XSLT::NAMESPACE_SAXON
+    NAMESPACE_XT         = LibXSLT::XSLT::NAMESPACE_XT
+    NAMESPACE_XALAN      = LibXSLT::XSLT::NAMESPACE_XALAN
+    
+    def self.new
+      Stylesheet.new(nil)
+    end
+    
+    def self.file(filename)
+      doc = XML::Document.file(filename)
+      stylesheet = LibXSLT::XSLT::Stylesheet.new(doc)
+      
+      result = Stylesheet.new(stylesheet)
+      result.filename = filename
+      result
+    end
+    
+    class Stylesheet
+      attr_accessor :doc, :filename
+      
+      def initialize(stylesheet)
+        @stylesheet = stylesheet
+      end
+      
+      def filename=(value)
+        @doc = XML::Document.file(value)
+        @filename = value
+      end
+      
+      def parse
+        self
+      end
+      
+      def apply
+        @result = @stylesheet.apply(@doc)
+      end
+      
+      def save(filename)
+        raise(ArgumentError) unless @result
+        @result.save(filename)
+      end
+      
+      def print(filename)
+        raise(ArgumentError) unless @result
+      end
+    end
+  end
+end
+