xml-magic 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+0.1.0
+  
+  * First release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008 CommonThread, LLC
+
+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

@@ -0,0 +1,22 @@
+xml-magic makes accessing xml objects more like any other ruby object
+
+== example
+
+require 'xml_magic'
+
+xml = <<XML
+<project title="XML Magic">
+  <description>Test description.</description>
+  <contact type="Project Manager">Anthony</contact>
+  <contact type="Worker Bee">Ben</contact>
+  <contact type="Designer Bee">Jason</contact>
+</project>
+XML
+
+project_info = CommonThread::XML::XmlMagic.new(xml)
+
+puts project_info[:title]
+puts project_info.description
+for contact in project_info.contact
+  puts "#{contact} the #{contact[:type]}"
+end

data/demo.rb

@@ -0,0 +1,18 @@
+require 'lib/common_thread/xml/xml_magic'
+
+xml = <<XML
+<project title="XML Magic">
+  <description>Test description.</description>
+  <contact type="Project Manager">Anthony</contact>
+  <contact type="Worker Bee">Ben</contact>
+  <contact type="Designer Bee">Jason</contact>
+</project>
+XML
+
+project_info = CommonThread::XML::XmlMagic.new(xml)
+
+puts project_info[:title]
+puts project_info.description
+for contact in project_info.contact
+  puts "#{contact} the #{contact[:type]}"
+end

data/lib/common_thread/xml/xml_magic.rb

@@ -0,0 +1,99 @@
+module CommonThread
+  module XML
+    # Class that makes accessing xml objects more like any other ruby object
+    # thanks to the magic of method missing
+    class XmlMagic
+      require 'rexml/document'
+      
+      def initialize(xml, namespace="")
+        if xml.class == REXML::Element or xml.class == Array
+          @element = xml
+        else
+          @xml = REXML::Document.new(xml)
+          @element = @xml.root
+        end
+        @namespace = namespace
+      end
+
+      def class(selection=nil)
+        evaluate("class", selection)
+      end
+
+      def each
+        @element.each {|e| yield CommonThread::XML::XmlMagic.new(e, @namespace)}
+      end
+
+      def id(selection=nil)
+        evaluate("id", selection)
+      end
+
+      def method_missing(method, selection=nil)
+        evaluate(method.to_s, selection)
+      end
+
+      def namespace=(namespace)
+        if namespace and namespace.length > 0
+          @namespace = namespace + ":"
+        else
+          @namespace = ""
+        end
+      end
+      
+      def to_s
+        if @element.class == Array
+          @element.collect{|e| e.text}.join
+        else
+          @element.text
+        end
+      end
+
+      def type(selection=nil)
+        evaluate("type", selection)
+      end
+
+      def [](index, count = nil)
+        if index.is_a?(Fixnum) or index.is_a?(Bignum) or index.is_a?(Integer) or index.is_a?(Range) 
+          if @element.is_a?(Array)
+            if count
+              CommonThread::XML::XmlMagic.new(@element[index, count], @namespace)
+            else
+              CommonThread::XML::XmlMagic.new(@element[index], @namespace)
+            end
+          else
+            nil
+          end
+        elsif index.is_a?(Symbol)
+          if @element.is_a?(Array)
+            if @element.empty?
+              nil
+            else
+              @element[0].attributes[index.to_s]
+            end
+          else
+            @element.attributes[index.to_s]
+          end
+        end
+      end
+
+      private
+      def evaluate(name, selection)
+        
+        if @element.is_a?(Array)
+          elements = @element[0].get_elements(@namespace + name)
+        else
+          elements = @element.get_elements(@namespace + name)
+        end
+        
+        if elements.empty?
+          nil
+        else
+          if selection == :count
+            elements.length
+          else
+            CommonThread::XML::XmlMagic.new(elements, @namespace)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xml_magic.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/common_thread/xml/xml_magic'

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/common_thread/xml/xml_magic'

data/test/test_xml_magic.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestXmlMagic < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_xml_magic
+    x = CommonThread::XML::XmlMagic.new('<project title="Sewer work"><media:content>This is the content.</media:content><type>New</type><contact name="Anthony">Anthony</contact><contact name="Ben">Ben</contact><contact name="Jason">Jason</contact><description>Test description.</description></project>')
+    assert_equal("Sewer work", x[:title])
+    assert_equal("New", x.type.to_s)
+    assert_equal("Anthony", x.contact[0][:name])
+    x.contact.each do |contact|
+      assert(contact[:name] != nil, "Attribute name should not be nil")
+      assert(contact[:phone] == nil, "Attribute phone should be nil")
+    end
+    assert_equal(3, x.contact(:count))
+    assert_equal("Test description.", x.description.to_s)
+    assert_equal("AnthonyBenJason", x.contact.to_s)
+    assert_equal(nil, x.note)
+    assert_equal(nil, x.content)
+    x.namespace = "media"
+    assert_equal("This is the content.", x.content.to_s)
+    x.namespace = ""
+    assert_equal(nil, x.content)    
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: xml-magic
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Anthony Crumley
+- Ben Wyrosdick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-05 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: xml-magic makes accessing xml objects more like any other ruby object
+email: anthony@commonthread.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- CHANGELOG
+- LICENSE
+- demo.rb
+- lib/xml_magic.rb
+- lib/common_thread/xml/xml_magic.rb
+- test/test_helper.rb
+- test/test_xml_magic.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/xml-magic/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: xml-magic
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: xml-magic makes accessing xml objects more like any other ruby object
+test_files: []
+