clifton_lib 0.0.1

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clifton_lib.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    clifton_lib (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.2.2)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  clifton_lib!
+  rake

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Marc Clifton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marc Clifton
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# CliftonLib
+
+This is a collection of useful functionality that I require for various projects that I'm working on.
+
+In version 0.0.1, I've implemented several XML helper classes, similar to .NET's XmlDocument, to facilitate the
+creation and serialization of XML.  In this version, the support is bare bones but sufficient for what I need done.
+
+Why do this?
+
+All the implementations for XML support that I've seen in Ruby utilize the "method missing" feature, so that markup is written in a DSL manner.  For example:
+
+doc.product = 'Apples'
+
+will yield something like:
+
+<product>Apples</product>
+
+I have several issues with this:
+
+1. It isn't object oriented.
+2. It assumes you know the element and attribute names, which isn't convenient when generating XML dynamically from other data sources
+3. It leverages "method missing", which affects performance and creates an internal DSL which isn't necessary.
+4. Frequently, the parameters are passed as hashes, which I find particularly evil in Ruby as they don't document what the valid parameter-hashes are via function parameters.
+
+Instead, I want to base XML document generation (and eventually parsing) on Microsoft's implementation of the XmlDocument class in .NET:
+
+http://msdn.microsoft.com/en-us/library/system.xml.xmldocument.aspx
+
+This implementation:
+
+1. Is a decent object-oriented solution for creating XML documents
+2. Inherently supports dynamic XML generation
+3. Isn't DSL-ish.
+
+## 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
+that is an unintended consequence of the last line executed in the function.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clifton_lib'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clifton_lib
+
+## Usage
+
+XML Serialization Example:
+
+```ruby
+require 'test/unit'
+require 'clifton_lib/xml/xml_document'
+require 'clifton_lib/xml/xml_declaration_node'
+require 'clifton_lib/xml/xml_text_writer'
+
+include CliftonXml
+
+def test_serialization
+  xdoc = XmlDocument.new()
+  decl_node = xdoc.create_xml_declaration('1.0', 'UTF-8')
+  xdoc.append_child(decl_node)
+
+  products = xdoc.create_element('Products')
+  xdoc.append_child(products)
+
+  product1 = xdoc.create_element('Product')
+  id_attr1 = xdoc.create_attribute('ID')
+  name_attr1 = xdoc.create_attribute('Name')
+  id_attr1.value = '1'
+  name_attr1.value = 'Apples'
+  product1.append_attribute(id_attr1)
+  product1.append_attribute(name_attr1)
+  product1.inner_text = 'foobar'
+
+  product2 = xdoc.create_element('Product')
+  id_attr2 = xdoc.create_attribute('ID')
+  name_attr2 = xdoc.create_attribute('Name')
+  id_attr2.value = '2'
+  name_attr2.value = 'Oranges'
+  product2.append_attribute(id_attr2)
+  product2.append_attribute(name_attr2)
+
+  products.append_child(product1)
+  products.append_child(product2)
+
+  tw = XmlTextWriter.new()
+  tw.formatting = :indented
+  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
+```
+
+The result looks like:
+
+```XML
+<Products>
+  <Product ID="1" Name="Apples">foobar</Product>
+  <Product ID="2" Name="Oranges" />
+</Products>
+```
+
+For further examples, see the xml_document_tests.rb file.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/clifton_lib.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clifton_lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clifton_lib"
+  spec.version       = CliftonLib::VERSION
+  spec.authors       = ["Marc Clifton"]
+  spec.email         = ["marc.clifton@gmail.com"]
+  spec.description   = %q{A collection of useful helper classes, initially a set of classes to support creation and serialization of XML.}
+  spec.summary       = %q{Collection of useful helper classes.}
+  spec.homepage      = "https://github.com/cliftonm/clifton_lib"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/clifton_lib.rb

@@ -0,0 +1,17 @@
+require "clifton_lib/version"
+
+module CliftonLib
+end
+
+
+=begin
+
+To build this:
+
+from RubyMine, Tools -> Gem -> Build Gem
+
+Locally install the gem:
+
+C:\rails-gems\clifton_lib>gem install .\clifton_lib-0.0.1.gem
+
+=end

data/lib/clifton_lib/version.rb

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

data/lib/clifton_lib/xml/xml_attribute.rb

@@ -0,0 +1,19 @@
+require "clifton_lib/version"
+
+module CliftonXml
+  class XmlAttribute
+    attr_accessor :name
+    attr_accessor :value
+
+    # XmlAttribute.new() {@name = [name]; @value = [value]}
+    def initialize(&block)
+      # this can use the form {@<attr> = <value>}
+      # allow for default constructor.
+      instance_eval(&block) unless block.nil?
+      # yield self if block_given?
+      # this requires the form {|inst| inst.<attr> = <value>}
+
+      self
+    end
+  end
+end

data/lib/clifton_lib/xml/xml_declaration_node.rb

@@ -0,0 +1,16 @@
+require "clifton_lib/version"
+require "clifton_lib/xml/xml_attribute"
+require "clifton_lib/xml/xml_node"
+
+module CliftonXml
+  class XmlDeclarationNode < XmlNode
+
+    # XmlDeclarationNode.new() {... attribute initialization ... }
+    def initialize(&block)
+      super()
+      instance_eval(&block) unless block.nil?
+
+      self
+    end
+  end
+end

data/lib/clifton_lib/xml/xml_document.rb

@@ -0,0 +1,136 @@
+require "clifton_lib/version"
+require "clifton_lib/xml/xml_attribute"
+require "clifton_lib/xml/xml_element"
+require "clifton_lib/xml/xml_node"
+require "clifton_lib/xml/xml_declaration_node"
+
+module CliftonXml
+  class XmlDocument < XmlNode
+
+    # XmlDocument.new()
+    def initialize
+      super()
+    end
+
+    # XmlDeclarationNode create_xml_declaration(string version, string encoding)
+    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
+
+    # XmlAttribute create_attribute(string name)
+    def create_attribute(name)
+      attr = XmlAttribute.new() {@name = name}
+
+      attr
+    end
+
+    # XmlElement create_element(string name)
+    def create_element(name)
+      elem = XmlElement.new() {@name = name}
+
+      elem
+    end
+
+    def document_element()
+      # TODO
+    end
+
+    def document_type()
+      # TODO
+    end
+
+    # void save(XmlTextWriter writer)
+    def save(writer)
+      write_nodes(writer, @child_nodes)
+
+      nil
+    end
+
+    private
+
+    # void write_nodes(XmlTextWriter writer, XmlNodes[] nodes)
+    def write_nodes(writer, nodes)
+      nodes.each_with_index do |node, idx|
+        # write xml declaration if it exists.
+        # TODO: Should throw somewhere if this isn't the first node.
+        if node.is_a?(XmlDeclarationNode)
+          writer.write('<?xml')
+          write_attributes(writer, node)
+          writer.write('?>')
+          writer.new_line()
+        else
+          # begin element tag and attributes
+          writer.write('<' + node.name)
+          write_attributes(writer, node)
+
+          # if inner text, write it out now.
+          if node.inner_text
+            writer.write('>' + node.inner_text)
+            writer.write('</' + node.name + '>')
+            crlf_if_more_nodes(writer, nodes, idx)
+          else
+          # Children are allowed only if there is no inner text.
+            if node.has_child_nodes()
+              # close element tag, indent, and recurse.
+              writer.write('>')
+              writer.indent()
+              writer.new_line()
+              write_nodes(writer, node.child_nodes)
+              writer.outdent()
+              writer.new_line()
+              # close the element
+              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('/>')
+              crlf_if_more_nodes(writer, nodes, idx)
+            end
+          end
+        end
+      end
+
+      nil
+    end
+
+    # Write the attribute collection for a node.
+    # void write_attributes(XmlTextWriter writer, XmlNode node)
+    def write_attributes(writer, node)
+      if node.attributes.count > 0
+        # stuff them into an array of strings
+        attrs = []
+
+        node.attributes.each do |attr|
+          attrs << attr.name + '="' + attr.value + '"'
+        end
+
+        # separate them with a space
+        attr_str = attrs.join(' ')
+
+        # requires a leading space as well to separate from the element name.
+        writer.write(' ' + attr_str)
+        end
+
+      nil
+    end
+
+    # bool more_nodes(XmlNodes[] nodes, int idx)
+    def more_nodes(nodes, idx)
+      idx + 1 < nodes.count
+    end
+
+    # void crlf_if_more_nodes(XmlTextWriter writer, XmlNodes[] nodes, int idx)
+    def crlf_if_more_nodes(writer, nodes, idx)
+      if more_nodes(nodes, idx)
+        writer.new_line()
+      end
+
+      nil
+    end
+  end
+end

data/lib/clifton_lib/xml/xml_element.rb

@@ -0,0 +1,32 @@
+require "clifton_lib/version"
+require "clifton_lib/xml/xml_node"
+
+module CliftonXml
+  class XmlElement < XmlNode
+
+    # XmlElement.new()
+    def initialize(&block)
+      super()
+      instance_eval(&block) unless block.nil?
+
+      self
+    end
+
+    # void append_attributes(XmlAttribute attr)
+    def append_attribute(attr)
+      @attributes << attr
+
+      nil
+    end
+
+    # XmlElement previous_sibling()
+    def previous_sibling()
+      # TODO
+    end
+
+    # XmlElement next_sibling()
+    def next_sibling()
+      # TODO
+    end
+  end
+end

data/lib/clifton_lib/xml/xml_node.rb

@@ -0,0 +1,35 @@
+require "clifton_lib/version"
+
+module CliftonXml
+  class XmlNode
+    attr_accessor :name
+    attr_accessor :inner_text
+    attr_accessor :parent_node    # Annoying rubyism -- if in the class itself, property must be read/writeable.
+    attr_reader :attributes
+    attr_reader :child_nodes
+
+    # XmlNode.new()
+    def initialize()
+      @attributes = []
+      @child_nodes = []
+      @parent_node = nil
+      @name = nil
+      @inner_text = nil
+
+      self
+    end
+
+    # bool has_child_nodes()
+    def has_child_nodes()
+      @child_nodes.count > 0
+    end
+
+    # void append_child(XmlNode node)
+    def append_child(node)
+      @child_nodes << node
+      node.parent_node = self
+
+      nil
+    end
+  end
+end

data/lib/clifton_lib/xml/xml_text_writer.rb

@@ -0,0 +1,55 @@
+require "clifton_lib/version"
+
+module CliftonXml
+  # For the moment, simply builds a string locally.
+  # TODO: Implement streams, passing in an output stream to the constructor, like a StringWriter or FileWriter stream.
+  class XmlTextWriter
+    attr_accessor :formatting
+    attr_reader :output
+
+    # XmlTextWriter.new()
+    def initialize()
+      @output = ''
+      @indent = 0
+      @formatting = :none
+    end
+
+    # void write(string str)
+    def write(str)
+      @output << str
+
+      nil
+    end
+
+    # void new_line()
+    def new_line()
+      if @formatting == :indented
+        @output << "\r\n"
+        @output << indentation(@indent)
+      end
+
+      nil
+    end
+
+    # void indent()
+    def indent()
+      @indent = @indent + 2
+
+      nil
+    end
+
+    # void outdent()
+    def outdent()
+      @indent = @indent - 2
+
+      nil
+    end
+
+    private
+
+    # string indentation(int amt)
+    def indentation(amt)
+      ' ' * amt
+    end
+  end
+end

data/test/xml_document_tests.rb

@@ -0,0 +1,109 @@
+require 'test/unit'
+require 'clifton_lib/xml/xml_document'
+require 'clifton_lib/xml/xml_declaration_node'
+require 'clifton_lib/xml/xml_text_writer'
+
+include CliftonXml
+
+class XmlDocumentTests < Test::Unit::TestCase
+  # Create a document and verify that no child nodes and attributes exist.
+  def test_create_node
+    xdoc = XmlDocument.new()
+    assert_equal xdoc.child_nodes.count, 0
+    assert_equal xdoc.attributes.count, 0
+  end
+
+  # Create an XML declaration header and verify the attribute and node counts.
+  def test_xml_declaration
+    xdoc = XmlDocument.new()
+    node = xdoc.create_xml_declaration('1.0', 'UTF-8')
+    assert_equal node.attributes.count, 2
+    xdoc.append_child(node)
+    assert_equal xdoc.child_nodes.count, 1
+    assert_equal xdoc.attributes.count, 0
+  end
+
+  # Create a document with one root and two children.
+  def test_element_creation
+    xdoc = XmlDocument.new()
+    products = xdoc.create_element('Products')
+    xdoc.append_child(products)
+
+    product1 = xdoc.create_element('Product')
+    product2 = xdoc.create_element('Product')
+
+    products.append_child(product1)
+    products.append_child(product2)
+
+    assert_equal xdoc.child_nodes.count, 1
+    assert_equal xdoc.child_nodes[0].child_nodes.count, 2
+  end
+
+  # Create a document with one root, two children, and two attributes for each child.
+  def test_element_attributes
+    xdoc = XmlDocument.new()
+    products = xdoc.create_element('Products')
+    xdoc.append_child(products)
+
+    product1 = xdoc.create_element('Product')
+    id_attr1 = xdoc.create_attribute('ID')
+    name_attr1 = xdoc.create_attribute('Name')
+    id_attr1.value = '1'
+    name_attr1.value = 'Apples'
+    product1.append_attribute(id_attr1)
+    product1.append_attribute(name_attr1)
+
+    product2 = xdoc.create_element('Product')
+    id_attr2 = xdoc.create_attribute('ID')
+    name_attr2 = xdoc.create_attribute('Name')
+    id_attr2.value = '2'
+    name_attr2.value = 'Oranges'
+    product2.append_attribute(id_attr1)
+    product2.append_attribute(name_attr1)
+
+    products.append_child(product1)
+    products.append_child(product2)
+
+    assert_equal xdoc.child_nodes.count, 1
+    assert_equal xdoc.child_nodes[0].child_nodes.count, 2
+    assert_equal xdoc.child_nodes[0].child_nodes[0].attributes.count, 2
+    assert_equal xdoc.child_nodes[0].child_nodes[1].attributes.count, 2
+  end
+
+  # test the serialization of a simple structure with an inner element having inner text.
+  def test_serialization
+    xdoc = XmlDocument.new()
+    decl_node = xdoc.create_xml_declaration('1.0', 'UTF-8')
+    xdoc.append_child(decl_node)
+
+    products = xdoc.create_element('Products')
+    xdoc.append_child(products)
+
+    product1 = xdoc.create_element('Product')
+    id_attr1 = xdoc.create_attribute('ID')
+    name_attr1 = xdoc.create_attribute('Name')
+    id_attr1.value = '1'
+    name_attr1.value = 'Apples'
+    product1.append_attribute(id_attr1)
+    product1.append_attribute(name_attr1)
+    product1.inner_text = 'foobar'
+
+    product2 = xdoc.create_element('Product')
+    id_attr2 = xdoc.create_attribute('ID')
+    name_attr2 = xdoc.create_attribute('Name')
+    id_attr2.value = '2'
+    name_attr2.value = 'Oranges'
+    product2.append_attribute(id_attr2)
+    product2.append_attribute(name_attr2)
+
+    products.append_child(product1)
+    products.append_child(product2)
+
+    tw = XmlTextWriter.new()
+    tw.formatting = :indented
+    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
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: clifton_lib
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marc Clifton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &26145264 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *26145264
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &26144784 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *26144784
+description: A collection of useful helper classes, initially a set of classes to
+  support creation and serialization of XML.
+email:
+- marc.clifton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- clifton_lib.gemspec
+- lib/clifton_lib.rb
+- lib/clifton_lib/version.rb
+- lib/clifton_lib/xml/xml_attribute.rb
+- lib/clifton_lib/xml/xml_declaration_node.rb
+- lib/clifton_lib/xml/xml_document.rb
+- lib/clifton_lib/xml/xml_element.rb
+- lib/clifton_lib/xml/xml_node.rb
+- lib/clifton_lib/xml/xml_text_writer.rb
+- test/xml_document_tests.rb
+homepage: https://github.com/cliftonm/clifton_lib
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Collection of useful helper classes.
+test_files:
+- test/xml_document_tests.rb