simple-xml 1.0.0

data/README.md

@@ -0,0 +1,22 @@
+# SimpleXML
+
+A simple add on to rexml to parse xml data simply by converting them to a hash.
+That hash can than easily be passed to model objects to validate etc.
+
+Example usage:
+
+```ruby
+doc = REXML::Document.new(%Q{
+     <?xml version="1.0"?>
+     <address>
+       <country iso_code="de" nationality="deutsch">Deutschland</country>
+       <zip_code>76135</zip_code>
+       <city>Karlsruhe</city>
+       <street>
+         <name_and_number>Ernst-Frey-Str. 10</name_and_number>
+       </street>
+     </address>
+   }
+doc.simplify("/address") #=> { :country => "Deutschland", :zip_code => "76135", :city => "Karlsruhe", :street => { :name_and_number => "Ernst-Frey-Str. 10" } }
+doc.simplify_attributes("/address/country") #=> { :iso_code => "de", :nationality => "deutsch" }
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/simple_xml.rb

@@ -0,0 +1,7 @@
+require "rexml/document"
+require "rexml/xpath"
+require File.join(File.dirname(__FILE__), "simple_xml", "simplifyer")
+
+class REXML::Element
+  include SimpleXML::Simplifyer
+end

data/lib/simple_xml/simplifyer.rb

@@ -0,0 +1,90 @@
+module SimpleXML
+  # Extension to the element class of rexml to make working with simple xml
+  # documents more easy and intuitive. Therefor it uses the combination of hashes
+  # and the rexml XPath implementation.
+  # @example Usage with a simple document
+  #   doc = REXML::Document.new(%Q{
+  #     <?xml version="1.0"?>
+  #     <address>
+  #       <country iso_code="de" nationality="deutsch">Deutschland</country>
+  #       <zip_code>76135</zip_code>
+  #       <city>Karlsruhe</city>
+  #       <street>
+  #         <name_and_number>Ernst-Frey-Str. 10</name_and_number>
+  #       </street>
+  #     </address>
+  #   }
+  #   doc.simplify("/address") #=> { :country => "Deutschland", :zip_code => "76135", :city => "Karlsruhe", :street => { :name_and_number => "Ernst-Frey-Str. 10" } }
+  #   doc.simplify_attributes("/address/country") #=> { :iso_code => "de", :nationality => "deutsch" }
+  # 
+  module Simplifyer
+    # Simplifies the current element or an xpath to a subelement to a hash.
+    # @param [String] xpath an optional xpath for an element to convert
+    # @return [Hash, NilClass] nil if the xpath didn't match to a node or a hash otherwise.
+    #   If elements have the same name they will be merged into an array.
+    def simplify(xpath = nil)
+      if xpath
+        if element = REXML::XPath.first(self, xpath)
+          element.simplify
+        else
+          nil
+        end
+      else
+        # just convert the elements if there are some
+        if contains_no_text_elements?
+          tree = {} # the subtree
+          last_name = nil # helper for detecting duplicate element names
+          self.each do |element|
+            # we ignore all text elements that are in between the elements
+            if element.is_a? REXML::Element
+              name = element.name.to_sym
+              if last_name == name
+                # create an array if there is more than one element with
+                # the same name
+                tree[name] = [tree[name]] unless tree[name].is_a?(Array)
+                tree[name] += [element.simplify]
+              else
+                # create a simple element (key - value) in the hash
+                tree[name] = element.simplify
+                last_name = name
+              end
+            end
+          end
+          tree
+        else
+          # if there is just text left the text elements will be used
+          self.text
+        end
+      end
+    end
+  
+    # Simplifies the current element attributes or an xpath to subelement
+    # attributes to a hash.
+    # @param [String] xpath an optional xpath for an element to convert
+    # @return [Hash, NilClass] nil if the xpath didn't match to a node or a hash otherwise.
+    def simplify_attributes(xpath = nil)
+      if xpath
+        if element = REXML::XPath.first(self, xpath)
+          element.simplify_attributes
+        else
+          nil
+        end
+      else
+        hash = {}
+        attributes.each { |key, value| hash[key.to_sym] = value }
+        hash
+      end    
+    end
+  
+  private
+  
+    # Checks if the sub element has any other elements than text elements.
+    # @returns [Boolean] ture if there is at least one REXML::Element
+    def contains_no_text_elements?
+      children.each do |element| 
+        return true if element.is_a? REXML::Element
+      end
+      false
+    end
+  end
+end

data/lib/simple_xml/version.rb

@@ -0,0 +1,3 @@
+module SimpleXML
+  VERSION = '1.0.0'
+end

data/simple-xml.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push('lib')
+require "simple_xml/version"
+
+Gem::Specification.new do |s|
+  s.name     = "simple-xml"
+  s.version  = SimpleXML::VERSION.dup
+  s.date     = "2011-11-21"
+  s.summary  = "Some helpers for REXML::Element to create hashes from xml easily"
+  s.email    = "vilandgr+simplexml@googlemail.com"
+  s.homepage = "https://github.com/threez/simple-xml"
+  s.authors  = ['Vincent Landgraf']
+  
+  s.description = "Some helpers for REXML::Element to create hashes from xml easily."
+  
+  dependencies = [
+    [:development, "rspec", "~> 2.1"],
+  ]
+  
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  ## Make sure you can build the gem on older versions of RubyGems too:
+  s.rubygems_version = "1.8.10"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+  
+  dependencies.each do |type, name, version|
+    if s.respond_to?("add_#{type}_dependency")
+      s.send("add_#{type}_dependency", name, version)
+    else
+      s.add_dependency(name, version)
+    end
+  end
+end

data/spec/simple_xml_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe REXML::Element do
+  before(:each) do
+    @doc = REXML::Document.new(%Q{
+      <?xml version="1.0"?>
+      <user>
+        <address>
+          <country iso_code="de" nationality="deutsch">Deutschland</country>
+          <zip_code>76135</zip_code>
+          <city>Karlsruhe</city>
+          <street>
+            <name_and_number>Ernst-Frey-Str. 10</name_and_number>
+          </street>
+        </address>
+        <phones>
+          <phone type="MOBILE">
+            <country>+49</country>
+            <provider>171</provider>
+            <number>20333232</number>
+          </phone>
+          <phone type="HOME">+494534520085285</phone>
+          <phone type="WORK">+494534523453453</phone>
+        </phones>
+      </user>
+    })
+  end
+  
+  it "should be possible not fail if the node doesn't exists" do
+    @doc.simplify("/user/no-element").should == nil
+  end
+  
+  it "should be possible to call on root element without a xpath" do
+    @doc.simplify.should == {
+      :user => {
+        :address => {
+          :country => "Deutschland",
+          :zip_code => "76135",
+          :city => "Karlsruhe",
+          :street => {
+            :name_and_number => "Ernst-Frey-Str. 10"
+          }
+        },
+        :phones => {
+          :phone => [ 
+            { :number => "20333232", :provider => "171", :country => "+49" }, 
+            "+494534520085285",
+            "+494534523453453"
+          ]
+        }
+      }
+    }
+  end
+  
+  it "should be possible to" do
+    @doc.simplify("/user").should == {
+      :address => {
+        :country => "Deutschland",
+        :zip_code => "76135",
+        :city => "Karlsruhe",
+        :street => {
+          :name_and_number => "Ernst-Frey-Str. 10"
+        }
+      },
+      :phones => {
+        :phone => [ 
+          { :number => "20333232", :provider => "171", :country => "+49" }, 
+          "+494534520085285",
+          "+494534523453453"
+        ]
+      }
+    }
+  end
+  
+  it "should be possible to request for attributes of a not existing node" do
+    @doc.simplify_attributes("/test").should == nil
+  end
+  
+  it "should be possible to request for existing attributes" do
+    @doc.simplify_attributes("/user/phones/phone[1]").should == {
+      :type => "MOBILE"
+    }
+    @doc.simplify_attributes("/user/phones/phone[2]").should == {
+      :type => "HOME"
+    }
+    @doc.simplify_attributes("/user/address/country").should == {
+      :iso_code => "de",
+      :nationality => "deutsch"
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "rspec"
+require File.join(File.dirname(__FILE__), "..", "lib", "simple_xml")

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: simple-xml
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+  - Vincent Landgraf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-21 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: "2.1"
+    type: :development
+    version_requirements: *id001
+description: Some helpers for REXML::Element to create hashes from xml easily.
+email: vilandgr+simplexml@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - Rakefile
+  - README.md
+  - simple-xml.gemspec
+  - lib/simple_xml.rb
+  - lib/simple_xml/simplifyer.rb
+  - lib/simple_xml/version.rb
+  - spec/simple_xml_spec.rb
+  - spec/spec_helper.rb
+homepage: https://github.com/threez/simple-xml
+licenses: []
+
+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.9
+signing_key: 
+specification_version: 3
+summary: Some helpers for REXML::Element to create hashes from xml easily
+test_files: 
+  - spec/simple_xml_spec.rb
+  - spec/spec_helper.rb