bakkdoor-srxml 0.0.4 → 0.1.0

data/README

@@ -6,6 +6,7 @@ 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.
 If you simply want to create an xml file without the need for extra fancy formatting, SRXML could just be the deal for you!
 
+Oh, by the way. It also supports html-output now.
 
 =========================
 LICENSE:
@@ -19,8 +20,9 @@ Play with it as much as you like, fork it and put the changes here back on githu
 ==================================
 Short Example (from examble.rb):
 ==================================
-   
-  require "sr_xml"
+  
+  require "rubygems"
+  require "srxml"
 
   xml = SRXML::XML.new
 
@@ -48,6 +50,32 @@ Which will then give you something like this:
   <something_else>yo!</something_else>
   </project>
   </projects>
+
+==================================
+Simple HTML generation:
+==================================
+
+SRXML now also supports html-output:
+  
+  require "rubygems"
+  require "srxml"
+  
+  html = SRXML::XML.new :xml => false, :html => true  # this will automatically set SRXML into 'html-mode',
+                                                      # knowing for example, that certain tags are single (no end tag) 
+  html.html{
+    html.head{
+      html.title "my title"
+    }
+    html.body{
+      html.div(:style => "padding:10em; font-size: 140%"){
+        "hello, world!"
+      }
+    }
+  }
+  
+  puts html.to_s
+
+Will output the expected html-output. 
   
 For more examples take a look in the example-files.
   

data/examples/example.rb

@@ -1,4 +1,4 @@
-require "srxml"
+require "../lib/srxml"
 
 @projects = []
 

data/examples/example2.rb

@@ -1,4 +1,4 @@
-require "srxml"
+require "../lib/srxml"
 
 @projects = []
 

data/lib/srxml.rb

@@ -1,55 +1,55 @@
 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
+  
+  # <tt>BlankSlate</tt> 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.
   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
+  # 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>
   class XML < BlankSlate
     
-    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 '<>'
+    @@html_singles = [:br, :hr, :img, :input, :meta, :param, :link, :base, :embed, :dd, :dt]
+    
+    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 '<>'
+    
+    def self.html_singles
+      @@html_singles
+    end
     
-=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
+    # 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
     def initialize(options = {})
       @xml_tag = options[:xml].nil? ? true : options[:xml]
       @sep = options[:sep] || "<>"
@@ -59,17 +59,17 @@ module SRXML
       if @xml_tag
         @output = ["<?xml version=\"1.0\" encoding=\"UTF-8\"?>#{@sep}"]
       else
+        if options[:html]
+          @singles += @@html_singles
+        end
         @output = []
       end
     end
     
-    
-=begin rdoc
-  This method is used to create the xml-ouput based on the called methods on the XML-object.
-=end
+    # This method is used to create the xml-ouput based on the called methods on the XML-object.
     def method_missing(method_name, *args)
       @output << "<#{method_name}"
-    
+      
       attributes = []
       value = ""
     
@@ -102,20 +102,19 @@ module SRXML
     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
+    # 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)
     def to_s(option = :non_formatted)
+      @output = @output.select{|x| x.class == String}
       if option == :formatted
         # format here with newline etc.
-        @output.select{|x| x.class == String}.join("").gsub(@sep, "\n")
+        @output.join("").gsub(@sep, "\n")
       elsif option == :keep_sep
         @output.join("")
       else
-        @output.select{|x| x.class == String}.join("").gsub(@sep, "")
+        @output.join("").gsub(@sep, "")
       end
     end
   

data/test/fixtures/friends.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><friends><friend><name>Thomas</name><age>20</age></friend><friend><name>Jessie</name><age>21</age></friend><friend><name>Joe</name><age>22</age></friend><friend><name>Sandra</name><age>19</age></friend><friend><name>Chris</name><age>25</age></friend></friends>

data/test/fixtures/inner_string.html.xml

@@ -0,0 +1 @@
+<html><head><title>Title</title></head><body><div>OkiDoki</div></body></html>

data/test/test_helper.rb

@@ -1,5 +1,7 @@
 module TestHelper
-  def fixture(name)
-    File.open("test/fixtures/#{name}.xml", "r").read
+  def fixture(name, opts = {})
+    opts[:xml] = opts[:xml].nil? ? true : opts[:xml]
+    ending = opts[:xml] ? ".xml" : ""
+    File.open("test/fixtures/#{name}#{ending}", "r").read
   end
 end

data/test/test_srxml.rb

@@ -64,4 +64,33 @@ class TestSRXML < Test::Unit::TestCase
     
     assert_equal(fixture("inner_string.html"), xml.to_s)
   end
+  
+  def test_html_singles
+    html = SRXML::XML.new :xml => false, :html => true
+    assert_equal(SRXML::XML.html_singles, html.singles)
+  end
+  
+  
+  def test_html_output
+    html = SRXML::XML.new :xml => false, :html => true
+    
+    html.html{
+      html.head{
+        html.title "hello, world!"
+        html.link :rel => "bla", :href => "http://localhost/whatever", :title => "something here!"
+      }
+      html.body{
+        html.div(:style => "padding: 10em; font-size: 150%"){
+          html.p "hey, whats up"
+          html.br
+          html.p{
+            "nothing much, i guess!"
+          }
+        }
+      }
+    }
+    
+    assert_equal(fixture("test_html_output.html", :xml => false), html.to_s)
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bakkdoor-srxml
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Christopher Bertels
@@ -29,12 +29,15 @@ files:
 - examples/example.xml
 - examples/example2.rb
 - examples/example2.xml
+- test/fixtures/friends.xml
 - test/fixtures/friends_formatted.xml
+- test/fixtures/inner_string.html.xml
 - test/fixtures/projects.xml
 - test/fixtures/projects_formatted.xml
+- test/fixtures/test_output_html
 - test/test_helper.rb
 - test/test_srxml.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/bakkdoor/srxml
 post_install_message: 
 rdoc_options: 
@@ -64,3 +67,9 @@ summary: Simple Ruby XML Generator
 test_files: 
 - test/test_helper.rb
 - test/test_srxml.rb
+- test/fixtures/friends.xml
+- test/fixtures/friends_formatted.xml
+- test/fixtures/inner_string.html.xml
+- test/fixtures/projects.xml
+- test/fixtures/projects_formatted.xml
+- test/fixtures/test_output_html