clifton_lib 0.0.1 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clifton_lib (0.0.1)
+    clifton_lib (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -32,6 +32,14 @@ This implementation:
 2. Inherently supports dynamic XML generation
 3. Isn't DSL-ish.
 
+## Revisions
+
+0.0.5 - Added support to disallow a closing tag for HTML5 compatibility.  For example, <img> is valid, <img></img> is seen as a stray ending tag.
+0.0.4 - Added support to disallow self-closing tags for HTML5 compatibility.  For example, <div>...</div> is valid, </div> is not.
+0.0.3 - Added support for valueless attributes.  Example: <nav class="top-bar" data-topbar/>
+0.0.2 - Additional internal properties for associating the XmlDocument to elements and XmlElement to attributes.
+0.0.1 - Initial version.
+
 ## A note about the code
 
 You'll find that I do certain things, like explicitly return nil when the function isn't intended to return anything.  This avoids accidental usage of a return from a function where

data/lib/clifton_lib/version.rb

@@ -1,3 +1,3 @@
 module CliftonLib
-  VERSION = "0.0.1"
+  VERSION = "0.0.5"
 end

data/lib/clifton_lib/xml/xml_attribute.rb

@@ -4,11 +4,14 @@ module CliftonXml
   class XmlAttribute
     attr_accessor :name
     attr_accessor :value
+    attr_accessor :xml_document
+    attr_accessor :xml_element
 
     # XmlAttribute.new() {@name = [name]; @value = [value]}
     def initialize(&block)
       # this can use the form {@<attr> = <value>}
       # allow for default constructor.
+      @xml_document = nil
       instance_eval(&block) unless block.nil?
       # yield self if block_given?
       # this requires the form {|inst| inst.<attr> = <value>}

data/lib/clifton_lib/xml/xml_document.rb

@@ -13,29 +13,45 @@ module CliftonXml
     end
 
     # XmlDeclarationNode create_xml_declaration(string version, string encoding)
+    # Returns a node that will appear at the beginning of the document as:
+    # <?xml version="[ver]" encoding="[enc]" ?>
+    # The node must still be added to the parent (root) node with XmlNode#append_child.
     def create_xml_declaration(version, encoding)
       declNode = XmlDeclarationNode.new() {
         @attributes << XmlAttribute.new() {@name='version'; @value=version}
         @attributes << XmlAttribute.new() {@name='encoding'; @value=encoding}
       }
 
-      declNode
-    end
+      declNode.xml_document = self
 
-    # XmlAttribute create_attribute(string name)
-    def create_attribute(name)
-      attr = XmlAttribute.new() {@name = name}
-
-      attr
+      declNode
     end
 
     # XmlElement create_element(string name)
+    # Return an XmlElement.  Append to the desired node with XmlNode#append_child.
     def create_element(name)
-      elem = XmlElement.new() {@name = name}
+      elem = XmlElement.new() {
+        @name = name
+      }
+
+      elem.xml_document = self
 
       elem
     end
 
+    # XmlAttribute create_attribute(string name, string val = '')
+    # Returns an XmlAttribute.  Append to the desired element with XmlElement#append_attribute.
+    def create_attribute(name, value = '')
+      attr = XmlAttribute.new() {
+        @name = name
+        @value = value
+      }
+
+      attr.xml_document = self
+
+      attr
+    end
+
     def document_element()
       # TODO
     end
@@ -45,6 +61,7 @@ module CliftonXml
     end
 
     # void save(XmlTextWriter writer)
+    # Writes the XML tree to the string buffer in XmlTextWriter.
     def save(writer)
       write_nodes(writer, @child_nodes)
 
@@ -87,8 +104,17 @@ module CliftonXml
               writer.write('</' + node.name + '>')
               crlf_if_more_nodes(writer, nodes, idx)
             else
-              # if no children and no inner text, use the abbreviated closing tag token.
-              writer.write('/>')
+              # if no children and no inner text, use the abbreviated closing tag token unless no closing tag is required and unless self closing tags are not allowed.
+              if node.html_closing_tag
+                if writer.allow_self_closing_tags
+                  writer.write('/>')
+                else
+                  writer.write('></' + node.name + '>')
+                end
+              else
+                writer.write('>')
+              end
+
               crlf_if_more_nodes(writer, nodes, idx)
             end
           end
@@ -106,7 +132,13 @@ module CliftonXml
         attrs = []
 
         node.attributes.each do |attr|
+          # special case:
+          # example: <nav class="top-bar" data-topbar>
+          if attr.value.nil?
+            attrs << attr.name
+          else
           attrs << attr.name + '="' + attr.value + '"'
+          end
         end
 
         # separate them with a space

data/lib/clifton_lib/xml/xml_element.rb

@@ -15,6 +15,7 @@ module CliftonXml
     # void append_attributes(XmlAttribute attr)
     def append_attribute(attr)
       @attributes << attr
+      attr.xml_element = self
 
       nil
     end

data/lib/clifton_lib/xml/xml_node.rb

@@ -5,6 +5,8 @@ module CliftonXml
     attr_accessor :name
     attr_accessor :inner_text
     attr_accessor :parent_node    # Annoying rubyism -- if in the class itself, property must be read/writeable.
+    attr_accessor :xml_document
+    attr_accessor :html_closing_tag    # Certain HTML closing tags are seen as "stray" if the exist, so we don't emit them if this is set to false.
     attr_reader :attributes
     attr_reader :child_nodes
 
@@ -15,6 +17,8 @@ module CliftonXml
       @parent_node = nil
       @name = nil
       @inner_text = nil
+      @xml_document = nil
+      @html_closing_tag = true
 
       self
     end

data/lib/clifton_lib/xml/xml_text_writer.rb

@@ -5,6 +5,7 @@ module CliftonXml
   # TODO: Implement streams, passing in an output stream to the constructor, like a StringWriter or FileWriter stream.
   class XmlTextWriter
     attr_accessor :formatting
+    attr_accessor :allow_self_closing_tags
     attr_reader :output
 
     # XmlTextWriter.new()
@@ -12,6 +13,7 @@ module CliftonXml
       @output = ''
       @indent = 0
       @formatting = :none
+      @allow_self_closing_tags = true       # HTML5 compatibility, set to false.
     end
 
     # void write(string str)

data/test/xml_document_tests.rb

@@ -104,6 +104,71 @@ class XmlDocumentTests < Test::Unit::TestCase
     xdoc.save(tw)
     output = tw.output
     assert_equal %Q|<?xml version="1.0" encoding="UTF-8"?>\r\n<Products>\r\n  <Product ID="1" Name="Apples">foobar</Product>\r\n  <Product ID="2" Name="Oranges"/>\r\n</Products>|, output
-    end
   end
 
+  def test_properties
+    xdoc = XmlDocument.new()
+    decl_node = xdoc.create_xml_declaration('1.0', 'UTF-8')
+
+    # decl node is assigned the xml_document.
+    assert_equal xdoc, decl_node.xml_document
+
+    # element is assigned the xml_document.
+    elem = xdoc.create_element('Element')
+    assert_equal xdoc, elem.xml_document
+
+    # element is assigned the parent.
+    xdoc.append_child(elem)
+    assert_equal xdoc, elem.parent_node
+
+    # attribute is assigned the xml document.
+    attr = xdoc.create_attribute('Attribute')
+    assert_equal xdoc, attr.xml_document
+
+    # attribute is assigned the owning element.
+    elem.append_attribute(attr)
+    assert_equal elem, attr.xml_element
+  end
+
+  def test_attribute_without_value
+    # special case:
+    # example: <nav class="top-bar" data-topbar>
+    xdoc = XmlDocument.new()
+    elem = xdoc.create_element('Element')
+    xdoc.append_child(elem)
+    attr = xdoc.create_attribute('Attribute', nil)
+    elem.append_attribute(attr)
+    tw = XmlTextWriter.new()
+    tw.formatting = :indented
+    xdoc.save(tw)
+    output = tw.output
+    assert_equal %Q|<Element Attribute/>|, output
+  end
+
+  def test_no_self_closing_tags
+    xdoc = XmlDocument.new()
+    elem = xdoc.create_element('Element')
+    xdoc.append_child(elem)
+    tw = XmlTextWriter.new()
+    tw.allow_self_closing_tags = false
+    tw.formatting = :indented
+    xdoc.save(tw)
+    output = tw.output
+    assert_equal %Q|<Element></Element>|, output
+
+  end
+
+  def test_no_closing_tag
+    xdoc = XmlDocument.new()
+    elem = xdoc.create_element('img')
+    elem.html_closing_tag = false
+    xdoc.append_child(elem)
+    tw = XmlTextWriter.new()
+    tw.allow_self_closing_tags = false
+    tw.formatting = :indented
+    xdoc.save(tw)
+    output = tw.output
+    assert_equal %Q|<img>|, output
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clifton_lib
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &26145264 !ruby/object:Gem::Requirement
+  requirement: &25447320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *26145264
+  version_requirements: *25447320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &26144784 !ruby/object:Gem::Requirement
+  requirement: &25447068 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *26144784
+  version_requirements: *25447068
 description: A collection of useful helper classes, initially a set of classes to
   support creation and serialization of XML.
 email: