libxml-ruby 2.5.0 → 2.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d223220c2ac2bc8aeecf2785092b229ec32d00ec
+  data.tar.gz: 5b822d3621a0d3129d22530bdfccb0374e6fe5b4
+SHA512:
+  metadata.gz: c179969f566e2a65c31ae9c8ceae5d3a9e96d95c8ee58efc1703e074f4f3fbf3921afa5c82557fece14c3a945b27fd4ee4290d426c507d23d526c22f411d204e
+  data.tar.gz: ae744217d7767fa8d49376d0cb2866b5365ca4fd05d49beb0dcc1e2818667a0b84f54249b50617dc9f0d3bb904b198d69c8668509b4fbe3411ec94deee38b1ac

data/HISTORY

@@ -1,5 +1,11 @@
 = Release History
 
+== 2.6.0 / 2013-02-16 Charlie Savage
+
+* Fix uninitialized constant LibXML::XML::Error::I18N (NameError) that occurred
+  with older versions of libxml.
+* Various updates/fixes to new XML::Writer class and update how flushing works (julp)
+
 == 2.5.0 / 2013-01-27 Charlie Savage
 
 * Compatibility with older versions for IO::write (rb_io_bufwrite is specific to ruby >= 1.9.3?)

data/ext/libxml/ruby_xml_encoding.h

@@ -13,6 +13,7 @@ VALUE rxml_new_cstr_len(const char* xstr, const int length, const char* xencodin
 
 #ifdef HAVE_RUBY_ENCODING_H
 rb_encoding* rxml_xml_encoding_to_rb_encoding(VALUE klass, xmlCharEncoding xmlEncoding);
+rb_encoding* rxml_figure_encoding(const char* xencoding);
 #endif
 
 #endif

data/ext/libxml/ruby_xml_version.h

@@ -1,9 +1,9 @@
 /* Don't nuke this block!  It is used for automatically updating the
  * versions below. VERSION = string formatting, VERNUM = numbered
  * version for inline testing: increment both or none at all.*/
-#define RUBY_LIBXML_VERSION  "2.5.0"
-#define RUBY_LIBXML_VERNUM   250
+#define RUBY_LIBXML_VERSION  "2.6.0"
+#define RUBY_LIBXML_VERNUM   260
 #define RUBY_LIBXML_VER_MAJ   2
-#define RUBY_LIBXML_VER_MIN   5
+#define RUBY_LIBXML_VER_MIN   6
 #define RUBY_LIBXML_VER_MIC   0
 #define RUBY_LIBXML_VER_PATCH 0

data/ext/libxml/ruby_xml_writer.c

@@ -15,8 +15,6 @@
 # include <libxml/xmlwriter.h>
 
 # include "ruby_libxml.h"
-# include "ruby_xml_io.h"
-# include "ruby_xml_document.h"
 # include "ruby_xml_writer.h"
 
 VALUE cXMLWriter;
@@ -31,6 +29,9 @@ typedef enum {
 
 typedef struct {
     VALUE output;
+# ifdef HAVE_RUBY_ENCODING_H
+    rb_encoding *encoding;
+# endif /* HAVE_RUBY_ENCODING_H */
     xmlBufferPtr buffer;
     xmlTextWriterPtr writer;
     rxmlw_output_type output_type;
@@ -122,6 +123,9 @@ xmlCharEncodingHandlerPtr xmlFindCharEncodingHandler(const char * name);
     rwo = ALLOC(rxml_writer_object);
     rwo->output = io;
     rwo->buffer = NULL;
+# ifdef HAVE_RUBY_ENCODING_H
+    rwo->encoding = NULL;
+# endif /* HAVE_RUBY_ENCODING_H */
     rwo->output_type = RXMLW_OUTPUT_IO;
     if (NULL == (out = xmlOutputBufferCreateIO(rxml_write_callback, NULL, (void *) io, NULL))) {
         rxml_raise(&xmlLastError);
@@ -147,6 +151,9 @@ static VALUE rxml_writer_file(VALUE klass, VALUE filename)
     rwo = ALLOC(rxml_writer_object);
     rwo->output = Qnil;
     rwo->buffer = NULL;
+# ifdef HAVE_RUBY_ENCODING_H
+    rwo->encoding = NULL;
+# endif /* HAVE_RUBY_ENCODING_H */
     rwo->output_type = RXMLW_OUTPUT_NONE;
     if (NULL == (rwo->writer = xmlNewTextWriterFilename(StringValueCStr(filename), 0))) {
         rxml_raise(&xmlLastError);
@@ -166,6 +173,9 @@ static VALUE rxml_writer_string(VALUE klass)
 
     rwo = ALLOC(rxml_writer_object);
     rwo->output = Qnil;
+# ifdef HAVE_RUBY_ENCODING_H
+    rwo->encoding = NULL;
+# endif /* HAVE_RUBY_ENCODING_H */
     rwo->output_type = RXMLW_OUTPUT_STRING;
     if (NULL == (rwo->buffer = xmlBufferCreate())) {
         rxml_raise(&xmlLastError);
@@ -191,6 +201,9 @@ static VALUE rxml_writer_doc(VALUE klass)
     rwo = ALLOC(rxml_writer_object);
     rwo->buffer = NULL;
     rwo->output = Qnil;
+# ifdef HAVE_RUBY_ENCODING_H
+    rwo->encoding = NULL;
+# endif /* HAVE_RUBY_ENCODING_H */
     rwo->output_type = RXMLW_OUTPUT_DOC;
     if (NULL == (rwo->writer = xmlNewTextWriterDoc(&doc, 0))) {
         rxml_raise(&xmlLastError);
@@ -203,19 +216,41 @@ static VALUE rxml_writer_doc(VALUE klass)
 /* ===== public instance methods ===== */
 
 /* call-seq:
- *    writer.flush -> (true|false)
+ *    writer.flush(empty? = true) -> (num|string)
  *
- * Flushes the output buffer.
+ * Flushes the output buffer. Returns the number of written bytes or
+ * the current content of the internal buffer for a in memory XML::Writer.
+ * If +empty?+ is +true+, and for a in memory XML::Writer, this internel
+ * buffer is empty.
  */
-static VALUE rxml_writer_flush(VALUE self)
+static VALUE rxml_writer_flush(int argc, VALUE *argv, VALUE self)
 {
     int ret;
+    VALUE empty;
     rxml_writer_object *rwo;
 
+    rb_scan_args(argc, argv, "01", &empty);
+
     rwo = rxml_textwriter_get(self);
-    ret = xmlTextWriterFlush(rwo->writer);
+    if (-1 == (ret = xmlTextWriterFlush(rwo->writer))) {
+        rxml_raise(&xmlLastError);
+    }
+    if (NULL != rwo->buffer) {
+        VALUE content;
 
-    return (-1 == ret ? Qfalse : Qtrue);
+# ifdef HAVE_RUBY_ENCODING_H
+        content = rb_external_str_new_with_enc(rwo->buffer->content, rwo->buffer->use, rwo->encoding);
+# else
+        content = rb_str_new(rwo->buffer->content, rwo->buffer->use);
+# endif /* HAVE_RUBY_ENCODING_H */
+        if (NIL_P(empty) || RTEST(empty)) { /* nil = default value = true */
+            xmlBufferEmpty(rwo->buffer);
+        }
+
+        return content;
+    } else {
+        return INT2NUM(ret);
+    }
 }
 
 /* call-seq:
@@ -232,6 +267,9 @@ static VALUE rxml_writer_result(VALUE self)
 
     ret = Qnil;
     rwo = rxml_textwriter_get(self);
+    if (-1 == (ret = xmlTextWriterFlush(rwo->writer))) {
+        rxml_raise(&xmlLastError);
+    }
     switch (rwo->output_type) {
         case RXMLW_OUTPUT_DOC:
             ret = rwo->output;
@@ -264,7 +302,7 @@ static VALUE numeric_rxml_writer_void(VALUE obj, int (*fn)(xmlTextWriterPtr))
 }
 
 # define numeric_rxml_writer_string(/*VALUE*/ obj, /*VALUE*/ name_or_content, /*int (**/fn/*)(xmlTextWriterPtr, const xmlChar *)*/) \
-    numeric_rxml_writer_va_strings(obj, Qnil, 1, fn, name_or_content)
+    numeric_rxml_writer_va_strings(obj, Qundef, 1, fn, name_or_content)
 
 /**
  * This is quite ugly but thanks to libxml2 coding style, all xmlTextWriter*
@@ -304,7 +342,7 @@ static VALUE numeric_rxml_writer_va_strings(VALUE obj, VALUE pe, size_t strings_
     }
     va_end(ap);
 
-    if (NIL_P(pe)) {
+    if (Qundef == pe) {
         switch (strings_count) {
             case 0:
                 ret = fn(rwo->writer);
@@ -449,7 +487,7 @@ static VALUE rxml_writer_write_element(int argc, VALUE *argv, VALUE self)
         }
         return rxml_writer_end_element(self);
     } else {
-        return numeric_rxml_writer_va_strings(self, Qnil, 2, xmlTextWriterWriteElement, name, content);
+        return numeric_rxml_writer_va_strings(self, Qundef, 2, xmlTextWriterWriteElement, name, content);
     }
 }
 
@@ -483,7 +521,7 @@ static VALUE rxml_writer_write_element_ns(int argc, VALUE *argv, VALUE self)
         }
         return rxml_writer_end_element(self);
     } else {
-        return numeric_rxml_writer_va_strings(self, Qnil, 4, xmlTextWriterWriteElementNS, prefix, name, namespaceURI, content);
+        return numeric_rxml_writer_va_strings(self, Qundef, 4, xmlTextWriterWriteElementNS, prefix, name, namespaceURI, content);
     }
 }
 
@@ -495,7 +533,7 @@ static VALUE rxml_writer_write_element_ns(int argc, VALUE *argv, VALUE self)
  */
 static VALUE rxml_writer_write_attribute(VALUE self, VALUE name, VALUE content)
 {
-    return numeric_rxml_writer_va_strings(self, Qnil, 2, xmlTextWriterWriteAttribute, name, content);
+    return numeric_rxml_writer_va_strings(self, Qundef, 2, xmlTextWriterWriteAttribute, name, content);
 }
 
 /* call-seq:
@@ -518,7 +556,7 @@ static VALUE rxml_writer_write_attribute_ns(int argc, VALUE *argv, VALUE self)
 
     rb_scan_args(argc, argv, "22", &prefix, &name, &namespaceURI, &content);
 
-    return numeric_rxml_writer_va_strings(self, Qnil, 4, xmlTextWriterWriteAttributeNS, prefix, name, namespaceURI, content);
+    return numeric_rxml_writer_va_strings(self, Qundef, 4, xmlTextWriterWriteAttributeNS, prefix, name, namespaceURI, content);
 }
 
 /* call-seq:
@@ -529,7 +567,7 @@ static VALUE rxml_writer_write_attribute_ns(int argc, VALUE *argv, VALUE self)
  */
 static VALUE rxml_writer_write_pi(VALUE self, VALUE target, VALUE content)
 {
-    return numeric_rxml_writer_va_strings(self, Qnil, 2, xmlTextWriterWritePI, target, content);
+    return numeric_rxml_writer_va_strings(self, Qundef, 2, xmlTextWriterWritePI, target, content);
 }
 
 /* ===== public start/end interface ===== */
@@ -584,7 +622,7 @@ static VALUE rxml_writer_start_attribute_ns(int argc, VALUE *argv, VALUE self)
 
     rb_scan_args(argc, argv, "21", &prefix, &name, &namespaceURI);
 
-    return numeric_rxml_writer_va_strings(self, Qnil, 3, xmlTextWriterStartAttributeNS, prefix, name, namespaceURI);
+    return numeric_rxml_writer_va_strings(self, Qundef, 3, xmlTextWriterStartAttributeNS, prefix, name, namespaceURI);
 }
 
 /* call-seq:
@@ -647,7 +685,7 @@ static VALUE rxml_writer_start_element_ns(int argc, VALUE *argv, VALUE self)
 
     rb_scan_args(argc, argv, "21", &prefix, &name, &namespaceURI);
 
-    return numeric_rxml_writer_va_strings(self, Qnil, 3, xmlTextWriterStartElementNS, prefix, name, namespaceURI);
+    return numeric_rxml_writer_va_strings(self, Qundef, 3, xmlTextWriterStartElementNS, prefix, name, namespaceURI);
 }
 
 /* call-seq:
@@ -731,6 +769,9 @@ static VALUE rxml_writer_start_document(int argc, VALUE *argv, VALUE self)
         }
     }
     rwo = rxml_textwriter_get(self);
+# ifdef HAVE_RUBY_ENCODING_H
+    rwo->encoding = rxml_figure_encoding(xencoding);
+# endif /* !HAVE_RUBY_ENCODING_H */
     ret = xmlTextWriterStartDocument(rwo->writer, NULL, xencoding, xstandalone);
 
     return (-1 == ret ? Qfalse : Qtrue);
@@ -777,7 +818,7 @@ static VALUE rxml_writer_start_dtd(int argc, VALUE *argv, VALUE self)
 
     rb_scan_args(argc, argv, "12", &name, &pubid, &sysid);
 
-    return numeric_rxml_writer_va_strings(self, Qnil, 3, xmlTextWriterStartDTD, name, pubid, sysid);
+    return numeric_rxml_writer_va_strings(self, Qundef, 3, xmlTextWriterStartDTD, name, pubid, sysid);
 }
 
 /* call-seq:
@@ -882,7 +923,7 @@ static VALUE rxml_writer_write_dtd(int argc, VALUE *argv, VALUE self)
 
     rb_scan_args(argc, argv, "13", &name, &pubid, &sysid, &subset);
 
-    return numeric_rxml_writer_va_strings(self, Qnil, 4, xmlTextWriterWriteDTD, name, pubid, sysid, subset);
+    return numeric_rxml_writer_va_strings(self, Qundef, 4, xmlTextWriterWriteDTD, name, pubid, sysid, subset);
 }
 
 /* call-seq:
@@ -894,7 +935,7 @@ static VALUE rxml_writer_write_dtd(int argc, VALUE *argv, VALUE self)
  */
 static VALUE rxml_writer_write_dtd_attlist(VALUE self, VALUE name, VALUE content)
 {
-    return numeric_rxml_writer_va_strings(self, Qnil, 2, xmlTextWriterWriteDTDAttlist, name, content);
+    return numeric_rxml_writer_va_strings(self, Qundef, 2, xmlTextWriterWriteDTDAttlist, name, content);
 }
 
 /* call-seq:
@@ -906,7 +947,7 @@ static VALUE rxml_writer_write_dtd_attlist(VALUE self, VALUE name, VALUE content
  */
 static VALUE rxml_writer_write_dtd_element(VALUE self, VALUE name, VALUE content)
 {
-    return numeric_rxml_writer_va_strings(self, Qnil, 2, xmlTextWriterWriteDTDElement, name, content);
+    return numeric_rxml_writer_va_strings(self, Qundef, 2, xmlTextWriterWriteDTDElement, name, content);
 }
 
 /* call-seq:
@@ -943,7 +984,7 @@ static VALUE rxml_writer_write_dtd_external_entity(VALUE self, VALUE name, VALUE
  */
 static VALUE rxml_writer_write_dtd_external_entity_contents(VALUE self, VALUE pubid, VALUE sysid, VALUE ndataid)
 {
-    return numeric_rxml_writer_va_strings(self, Qnil, 3, xmlTextWriterWriteDTDExternalEntityContents, pubid, sysid, ndataid);
+    return numeric_rxml_writer_va_strings(self, Qundef, 3, xmlTextWriterWriteDTDExternalEntityContents, pubid, sysid, ndataid);
 }
 
 /* call-seq:
@@ -969,7 +1010,7 @@ static VALUE rxml_writer_write_dtd_internal_entity(VALUE self, VALUE name, VALUE
  */
 static VALUE rxml_writer_write_dtd_notation(VALUE self, VALUE name, VALUE pubid, VALUE sysid)
 {
-    return numeric_rxml_writer_va_strings(self, Qnil, 3, xmlTextWriterWriteDTDNotation, name, pubid, sysid);
+    return numeric_rxml_writer_va_strings(self, Qundef, 3, xmlTextWriterWriteDTDNotation, name, pubid, sysid);
 }
 
 # if LIBXML_VERSION >= 20900
@@ -1017,7 +1058,7 @@ void rxml_init_writer(void)
 # if LIBXML_VERSION >= 20900
     rb_define_method(cXMLWriter, "set_quote_char", rxml_writer_set_quote_char, 1);
 # endif  /* LIBXML_VERSION >= 20900 */
-    rb_define_method(cXMLWriter, "flush", rxml_writer_flush, 0);
+    rb_define_method(cXMLWriter, "flush", rxml_writer_flush, -1);
     rb_define_method(cXMLWriter, "start_dtd", rxml_writer_start_dtd, -1);
     rb_define_method(cXMLWriter, "start_dtd_entity", rxml_writer_start_dtd_entity, -1);
     rb_define_method(cXMLWriter, "start_dtd_attlist", rxml_writer_start_dtd_attlist, 1);
@@ -1067,6 +1108,8 @@ void rxml_init_writer(void)
     rb_define_method(cXMLWriter, "write_pi", rxml_writer_write_pi, 2);
 
     rb_define_method(cXMLWriter, "result", rxml_writer_result, 0);
+
+    rb_undef_method(CLASS_OF(cXMLWriter), "new");
 }
 
 #endif /* LIBXML_WRITER_ENABLED */

data/lib/libxml/error.rb

@@ -3,20 +3,24 @@
 module LibXML
   module XML
     class Error
-
-      DOMAIN_CODE_MAP =Hash.new.tap do |map|
-        ([:NO_ERROR, :PARSER, :TREE, :NAMESPACE, :DTD, :HTML, :MEMORY, :OUTPUT, :IO, :FTP, :HTTP, :XINCLUDE, :XPATH, :XPOINTER, :REGEXP, :DATATYPE, :SCHEMASP, :SCHEMASV, :RELAXNGP, :RELAXNGV, :CATALOG, :C14N, :XSLT, :VALID, :CHECK, :WRITER, :MODULE, :I18N, :SCHEMATRONV]
-         ).each do |code|
-          map[const_get(code)] = code.to_s.gsub(/XML_ERR_/, '')
+      # Create mapping from domain constant value to keys
+      DOMAIN_CODE_MAP = [:NO_ERROR, :PARSER, :TREE, :NAMESPACE, :DTD, :HTML, :MEMORY,
+                         :OUTPUT, :IO, :FTP, :HTTP, :XINCLUDE, :XPATH, :XPOINTER, :REGEXP,
+                         :DATATYPE, :SCHEMASP, :SCHEMASV, :RELAXNGP, :RELAXNGV, :CATALOG,
+                         :C14N, :XSLT, :VALID, :CHECK, :WRITER, :MODULE, :I18N, :SCHEMATRONV].inject(Hash.new) do |hash, code|
+        if const_defined?(code)
+          hash[const_get(code)] = code.to_s
         end
+        hash
       end
 
+      # Create mapping from domain constant value to keys
       ERROR_CODE_MAP = Hash.new.tap do |map|
         (constants -
          DOMAIN_CODE_MAP.values - #Domains
          [:NONE, :WARNING, :ERROR, :FATAL] # Levels
          ).each do |code|
-          map[const_get(code)] = code.to_s.gsub(/XML_ERR_/, '')
+          map[const_get(code)] = code.to_s
         end
       end
       

data/test/tc_writer.rb

@@ -404,6 +404,28 @@ class TestWriter < Test::Unit::TestCase
     end
   end
 
+  def test_flush
+    writer = XML::Writer.string
+    assert(writer.start_document)
+    assert_equal(writer.flush.strip!, '<?xml version="1.0"?>')
+    assert(writer.start_element 'foo')
+    assert(writer.end_element)
+    assert(writer.end_document)
+    writer.flush false
+    assert_equal(writer.result.strip, '<foo/>')
+  end
+
+  def test_nil_pe_issue
+    expected = '<!DOCTYPE html [<!ENTITY special.pre "br | span | bdo | map"><!ENTITY special "%special.pre; | object | img">]>'
+
+    writer = XML::Writer.string
+    dtd writer, 'html' do
+      assert(writer.write_dtd_internal_entity 'special.pre', 'br | span | bdo | map', nil)
+      assert(writer.write_dtd_internal_entity 'special', '%special.pre; | object | img', nil)
+    end
+    assert_equal(writer.result, expected)
+  end
+
   private
 
   def document(writer, options = {})
@@ -416,7 +438,6 @@ class TestWriter < Test::Unit::TestCase
     assert(writer.start_dtd name, pubid, sysid)
     yield if block_given?
     assert(writer.end_dtd)
-    writer.flush
   end
 
   def element(writer, localname)

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libxml-ruby
 version: !ruby/object:Gem::Version
-  version: 2.5.0
-  prerelease: 
+  version: 2.6.0
 platform: ruby
 authors:
 - Ross Bamform
@@ -15,29 +14,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanna_guado
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    The Libxml-Ruby project provides Ruby language bindings for the
-  GNOME\n    Libxml2 XML toolkit. It is free software, released under the MIT License.\n
-  \   Libxml-ruby's primary advantage over REXML is performance - if speed\n    is
-  your need, these are good libraries to consider, as demonstrated\n    by the informal
-  benchmark below.\n"
+description: |2
+      The Libxml-Ruby project provides Ruby language bindings for the GNOME
+      Libxml2 XML toolkit. It is free software, released under the MIT License.
+      Libxml-ruby's primary advantage over REXML is performance - if speed
+      is your need, these are good libraries to consider, as demonstrated
+      by the informal benchmark below.
 email: 
 executables: []
 extensions:
@@ -260,27 +258,26 @@ files:
 - test/test_suite.rb
 homepage: http://xml4r.github.com/libxml-ruby
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby Bindings for LibXML2
 test_files:
 - test/tc_attr.rb