bakkdoor-srxml 0.0.2 → 0.0.3

data/README

@@ -1,5 +1,6 @@
 =========================
 SRXML - Simple Ruby XML
+Created by Christopher Bertels (bakkdoor@flasht.de / http://github.com/bakkdoor/)
 =========================
   
 SRXML is a very (super, if you will!) lightweight xml generator for Ruby. No big magic here, it simply uses method_missing to create the tags. There is some plan to make it more useful. For Example being able to parse existing files etc. but there are probably better libraries to do that.

data/Rakefile

@@ -12,4 +12,12 @@ rt = Rake::TestTask.new("test_units") do |t|
   t.libs << "test/unit"
   t.pattern = "test/test_*.rb"
   t.verbose = true
+end
+
+desc "create rdoc in /doc"
+rd = Rake::RDocTask.new("doc") do |rd|
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/*.rb")
+  rd.options << "--all"
+  rd.rdoc_dir = "rdoc"
 end

data/lib/srxml.rb

@@ -1,26 +1,72 @@
 module SRXML
-
+  
+=begin rdoc
+  BlankSlate class. Has nearly no methods, except for anything among the regex
+  (__*, instance_eval, inspect).
+  Is used by the XML class, since we want to use method_missing to create the xml-output.
+  Having fewer methods predefined is good, since we want as few nameclashes as possible.
+=end
   class BlankSlate
     instance_methods.each { |m| undef_method m unless m =~ /^(__|instance_eval|inspect)/ }
   end
 
-
+  
+=begin rdoc
+  Main class. Use it to create the xml-output.
+    For example:
+      xml = SRXML::XML.new :xml => false
+      xml.people{
+        xml.person{
+          xml.name "Todd"
+        }
+        xml.person{
+          xml.name "Mary"
+        }
+      }
+      
+      puts xml.to_s :formatted
+      
+    Will give you:
+      <people>
+      <person>
+      <name>Todd</name>
+      </person>
+      <person>
+      <name>Mary</name>
+      </person
+      </people>
+=end
   class XML < BlankSlate
     
-    attr_reader :xml_tag, :sep
+    attr_accessor :singles  # defines tags, which don't have a closing-tag (e.g. <br/>)
+    attr_reader   :xml_tag  # indicates, if xml-tag is used (should be false for html-mode, for example) 
+    attr_reader   :sep      # holds a seperator-string, indicating, where a newline (for formatted-output) should be placed
+                            # if not specified, its default value is '<>'
     
+=begin rdoc
+  Constructor. Takes a options-hash.
+  Valid options are:
+    :xml => true/false  # indicates if xml-tag should be used at top of xml-output
+    :sep => "<>"        # custom specified seperator-string; '<>' if not set
+    :singles => []      # custom specified list of single-tags (no closing tag), e.g. '<br/>' in html
+=end
     def initialize(options = {})
-      @xml_tag = options[:xml_tag].nil? ? true : options[:xml_tag]
+      @xml_tag = options[:xml].nil? ? true : options[:xml]
       @sep = options[:sep] || "<>"
       
+      @singles = options[:singles] || [] # if not specified, there are no single-tags
+      
       if @xml_tag
-        @output = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>#{@sep}"
+        @output = ["<?xml version=\"1.0\" encoding=\"UTF-8\"?>#{@sep}"]
       else
-        @output = ""
+        @output = []
       end
     end
     
-      
+    
+=begin rdoc
+  This method is used to create the xml-ouput based on the called methods on the XML-object.
+=end
     def method_missing(method_name, *args)
       @output << "<#{method_name}"
     
@@ -31,6 +77,7 @@ module SRXML
         if a.class != Hash
           value = a 
         else
+          # shove all key-value-pairs in as attributes to the xml-tag
           a.keys.sort_by{|k| k.to_s}.each do |key|
             attributes << " #{key}=\"#{a[key]}\""
           end
@@ -40,28 +87,35 @@ module SRXML
       attributes.each do |a|
         @output << a
       end
-    
-      @output << ">#{value}"
+      @output << ">"
+      @output << "#{value}" unless @singles.include?(method_name)
     
       if block_given?
         @output << @sep
-        yield
+        @output << yield
       end
-    
-      @output << "</#{method_name}>"
-      @output << @sep
       
-      return self
+      unless @singles.include?(method_name)
+        @output << "</#{method_name}>"
+        @output << @sep
+      end
     end
     
+    
+=begin rdoc
+  Returns the xml-output string created by using the xml-object.
+  Default-output is non_formatted. Optional output-styles are:
+    :formatted    # will put newlines in the correct places
+    :keep_sep     # will leave seperator-string in place (probably non-valid xml then - mainly for debug purposes)
+=end
     def to_s(option = :non_formatted)
       if option == :formatted
         # format here with newline etc.
-        @output.gsub(@sep, "\n")
+        @output.select{|x| x.class == String}.join("").gsub(@sep, "\n")
       elsif option == :keep_sep
-        @output
+        @output.join("")
       else
-        @output.gsub(@sep, "")
+        @output.select{|x| x.class == String}.join("").gsub(@sep, "")
       end
     end
   

data/test/test_srxml.rb

@@ -47,4 +47,21 @@ class TestSRXML < Test::Unit::TestCase
     assert_equal(fixture(:friends), xml.to_s)
     assert_equal(fixture(:friends_formatted), xml.to_s(:formatted))
   end
+  
+  def test_inner_string_output_and_no_xml_tag
+    xml = SRXML::XML.new :xml => false
+    
+    xml.html{
+      xml.head{
+        xml.title "Title"
+      }
+      xml.body{
+        xml.div{
+          "OkiDoki"
+        }
+      }
+    }
+    
+    assert_equal(fixture("inner_string.html"), xml.to_s)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bakkdoor-srxml
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Christopher Bertels
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-01 00:00:00 -07:00
+date: 2008-09-02 00:00:00 -07:00
 default_executable: 
 dependencies: []