genx4r 0.04 → 0.05

data/CHANGES

@@ -1,7 +1,19 @@
+[ Changes for 0.05 - Nov 25, 2004 ]
+
+* Added GenX::Builder, which works much like Jim Weirich's Builder
+  library, but filters the output through GenX, so you get the benefit
+  of sanity checking.
+
+* Fixed some bugs in the element, namespace, and attribute declaration
+  code that could have resulted in spurious errors when there was nothing
+  wrong.
+
 [ Changes for 0.04 - Oct 1, 2004 ]
 
 * Ruby 1.6.8 compatability.  Really.  I mean it this time.  Sigh.
+
 * Update to latest genx, fixes a memory leak in genxDispose.
+
 * Added a gemspec for RubyGems installation.
 
 [ Changes for 0.03 - Jul 11, 2004 ]

data/ext/genx4r/genx4r.c

@@ -19,7 +19,7 @@
  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  */
 
-/* $Id: genx4r.c 278 2004-07-26 13:09:20Z rooneg $ */
+/* $Id: genx4r.c 494 2004-11-25 15:21:41Z rooneg $ */
 
 #include "ruby.h"
 
@@ -400,26 +400,12 @@ writer_new (VALUE klass)
 static VALUE
 writer_declare_namespace (int argc, VALUE *argv, VALUE self)
 {
-  VALUE uri, prefix;
+  VALUE uri, prefix = 0;
+  genxStatus st = 0;
   genxNamespace ns;
-  genxStatus st;
   genxWriter w;
 
-  switch (argc)
-    {
-    case 1:
-      uri = argv[0];
-      prefix = 0;
-      break;
-
-    case 2:
-      uri = argv[0];
-      prefix = argv[1];
-      break;
-
-    default:
-      rb_raise (rb_eRuntimeError, "invalid arguments");
-    }
+  rb_scan_args (argc, argv, "11", &uri, &prefix);
 
   Check_Type (uri, T_STRING);
   if (prefix)
@@ -433,7 +419,7 @@ writer_declare_namespace (int argc, VALUE *argv, VALUE self)
                              &st);
 
   if (st)
-    rb_raise (rb_cGenXException, "%s", genxLastErrorMessage (w));
+    rb_raise (rb_cGenXException, "%s", genxGetErrorMessage (w, st));
 
   return Data_Wrap_Struct (rb_cGenXNamespace, NULL, NULL, ns);
 }
@@ -442,8 +428,8 @@ static VALUE
 writer_declare_element (int argc, VALUE *argv, VALUE self)
 {
   genxNamespace ns = 0;
+  genxStatus st = 0;
   genxElement elem;
-  genxStatus st;
   genxWriter w;
   VALUE name;
 
@@ -472,7 +458,7 @@ writer_declare_element (int argc, VALUE *argv, VALUE self)
 
   elem = genxDeclareElement (w, ns, RSTRING (name)->ptr, &st);
   if (st)
-    rb_raise (rb_cGenXException, "%s", genxLastErrorMessage (w));
+    rb_raise (rb_cGenXException, "%s", genxGetErrorMessage (w, st));
 
   return Data_Wrap_Struct (rb_cGenXElement, NULL, NULL, elem);
 }
@@ -482,7 +468,7 @@ writer_declare_attribute (int argc, VALUE *argv, VALUE self)
 {
   genxNamespace ns = 0;
   genxAttribute attr;
-  genxStatus st;
+  genxStatus st = 0;
   genxWriter w;
   VALUE name;
 
@@ -511,7 +497,7 @@ writer_declare_attribute (int argc, VALUE *argv, VALUE self)
 
   attr = genxDeclareAttribute (w, ns, RSTRING (name)->ptr, &st);
   if (st)
-    rb_raise (rb_cGenXException, "%s", genxLastErrorMessage (w));
+    rb_raise (rb_cGenXException, "%s", genxGetErrorMessage (w, st));
 
   return Data_Wrap_Struct (rb_cGenXAttribute, NULL, NULL, attr);
 }

data/genx4r.gemspec

@@ -1,12 +1,14 @@
 require 'rubygems'
 
 spec = Gem::Specification.new do |s|
-  s.name = 'genx4r'
-  s.version = '0.04'
+  s.name    = 'genx4r'
+  s.version = '0.05'
+
   s.summary = <<-EOF
     GenX4r is a Ruby wrapper around the GenX library, which allows you to
     programatically generate correct, cannonical XML output.
   EOF
+
   s.description = <<-EOF
     GenX4r is a Ruby wrapper around the GenX library, which allows you to
     programatically generate correct, cannonical XML output.
@@ -16,14 +18,16 @@ spec = Gem::Specification.new do |s|
 
   s.extensions << "ext/genx4r/extconf.rb"
 
-  s.require_path = 'lib'                         # Use these for libraries.
+  s.require_path = 'lib'
+
   s.autorequire = 'genx4r'
 
   s.has_rdoc = false
-  s.test_suite_file = "test/basics.rb"
 
-  s.author = "Garrett Rooney"
-  s.email = "rooneg@electricjellyfish.net"
-  s.homepage = "http://genx4r.rubyforge.org"
+  s.test_files = Dir.glob('test/*.rb')
+
+  s.author            = "Garrett Rooney"
+  s.email             = "rooneg@electricjellyfish.net"
+  s.homepage          = "http://genx4r.rubyforge.org"
   s.rubyforge_project = "genx4r"
 end

data/lib/genx4r/builder.rb

@@ -0,0 +1,123 @@
+require 'genx4r'
+
+# $Id: builder.rb 449 2004-10-02 20:15:49Z rooneg $
+
+module GenX
+  class Blank
+    instance_methods.each do |m|
+      undef_method m unless m =~ /^(__|instance_eval)/
+    end
+  end
+
+  class Builder < Blank
+    def initialize(writer)
+      @writer = writer
+
+      @elements   = {}
+      @attributes = {}
+      @namespaces = {}
+
+      @indent = 2
+      @level  = 0
+    end
+
+    def method_missing(sym, *args, &block)
+      text  = nil
+      attrs = nil
+
+      args.each do |arg|
+        case arg
+        when Hash
+          attrs ||= {}
+          attrs.merge!(arg)
+        else
+          text ||= ''
+          text << arg.to_s
+        end
+      end
+
+      _cache_element(sym)
+      _cache_attrs(attrs) unless attrs.nil?
+
+      if block
+        raise ArgumentError, 'can\'t have both text and block' unless text.nil?
+        _indent
+        @writer.element(@elements[sym]) do
+          _write_attrs(attrs) unless attrs.nil?
+          _write_contents(block)
+        end
+        _newline
+      else
+        _indent
+        @writer.element(@elements[sym]) do
+          _write_attrs(attrs) unless attrs.nil?
+          @writer.text(text)  unless text.nil?
+        end
+        _newline
+      end
+    end
+
+    def _write_contents(block)
+      begin
+        @level += 1
+        _newline
+        block.call(self)
+      ensure
+        @level -= 1
+        _indent
+      end
+    end
+
+    def _write_attrs(attrs)
+      attrs.each_key do |attr|
+        @writer.attribute(@attributes[attr], attrs[attr])
+      end
+    end
+
+    def _cache_attrs(attrs)
+      attrs.each_key do |attr|
+        unless @attributes.has_key?(attr)
+          @attributes[attr] = @writer.declare_attribute(attr.to_s)
+        end
+      end
+    end
+
+    def _cache_element(sym)
+      unless @elements.has_key?(sym.to_s)
+        @elements[sym] = @writer.declare_element(sym.to_s)
+      end
+    end
+
+    def _newline
+      unless @indent == 0 || @level == 0
+        @writer.text("\n")
+      end
+    end
+
+    def _indent
+      unless @indent == 0 || @level == 0
+        @writer.text(" " * (@indent * @level))
+      end
+    end
+
+    def _begin_doc(io)
+      @writer.begin_document(io)
+    end
+
+    def _end_doc
+      @writer.end_document
+    end
+  end
+
+  class Writer
+    def builder(io, &block)
+      b = Builder.new(self)
+      begin
+        b._begin_doc(io)
+        block.call(b)
+      ensure
+        b._end_doc
+      end
+    end
+  end
+end

data/test/builder.rb

@@ -0,0 +1,49 @@
+require 'test/unit'
+
+$LOAD_PATH.unshift('ext/genx4r')
+$LOAD_PATH.unshift('lib')
+
+require 'genx4r/builder'
+
+# $Id: builder.rb 493 2004-11-25 15:17:36Z rooneg $
+
+class BuilderTest < Test::Unit::TestCase
+  def test_basics
+    w = GenX::Writer.new()
+
+    s = ''
+
+    w.builder(s) do |b|
+      b.foo
+    end
+
+    assert s == '<foo></foo>'
+
+    s = ''
+
+    w.builder(s) do |b|
+      b.foo('bar')
+    end
+
+    assert s == '<foo>bar</foo>'
+
+    s = ''
+
+    w.builder(s) do |b|
+      b.foo do
+        b.bar('baz')
+        b.baz('zot', 'foo' => 'bar')
+        b.zim
+      end
+    end
+
+    # the \n is just so this works with the here doc...
+    assert (s + "\n")  == <<EOF
+<foo>
+  <bar>baz</bar>
+  <baz foo="bar">zot</baz>
+  <zim></zim>
+</foo>
+EOF
+  end
+end

data/test/declare.rb

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift('ext/genx4r')
 
 require 'genx4r'
 
-# $Id: declare.rb 268 2004-07-10 00:33:11Z rooneg $
+# $Id: declare.rb 491 2004-11-25 03:26:54Z rooneg $
 
 class DeclareTest < Test::Unit::TestCase
   def init_writer
@@ -55,5 +55,9 @@ class DeclareTest < Test::Unit::TestCase
 
     assert io.string == "<bar:blah xmlns:bar=\"http://foo.com/bar\"" + 
                         " bar:zot=\"zang\"></bar:blah>"
+
+    assert_raise(ArgumentError) do
+      w.declare_namespace
+    end
   end
 end

metadata

@@ -3,16 +3,18 @@ rubygems_version: 0.8.1
 specification_version: 1
 name: genx4r
 version: !ruby/object:Gem::Version 
-  version: "0.04"
-date: 2004-10-01
-summary: "GenX4r is a Ruby wrapper around the GenX library, which allows you to programatically generate correct, cannonical XML output."
+  version: "0.05"
+date: 2004-11-25
+summary: "GenX4r is a Ruby wrapper around the GenX library, which allows you to
+  programatically generate correct, cannonical XML output."
 require_paths: 
   - lib
 author: Garrett Rooney
 email: rooneg@electricjellyfish.net
 homepage: http://genx4r.rubyforge.org
 rubyforge_project: genx4r
-description: "GenX4r is a Ruby wrapper around the GenX library, which allows you to programatically generate correct, cannonical XML output."
+description: "GenX4r is a Ruby wrapper around the GenX library, which allows you to
+  programatically generate correct, cannonical XML output."
 autorequire: genx4r
 default_executable: 
 bindir: bin
@@ -26,26 +28,33 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
   version: 
 platform: ruby
 files: 
-  - CHANGES
+  - test
   - ext
-  - genx4r.gemspec
+  - lib
   - LICENSE
-  - README
   - setup.rb
-  - test
   - TODO
+  - CHANGES
+  - README
+  - genx4r.gemspec
+  - test/non-io.rb
+  - test/declare.rb
+  - test/basics.rb
+  - test/builder.rb
   - ext/genx4r
   - ext/genx4r/charProps.c
-  - ext/genx4r/extconf.rb
   - ext/genx4r/genx.c
+  - ext/genx4r/MANIFEST
   - ext/genx4r/genx.h
+  - ext/genx4r/extconf.rb
   - ext/genx4r/genx4r.c
-  - ext/genx4r/MANIFEST
-  - test/basics.rb
-  - test/declare.rb
-  - test/non-io.rb
+  - lib/genx4r
+  - lib/genx4r/builder.rb
 test_files: 
+  - test/non-io.rb
+  - test/declare.rb
   - test/basics.rb
+  - test/builder.rb
 rdoc_options: []
 extra_rdoc_files: []
 executables: []