demolisher 0.4.0 → 0.5.0

data/README.rdoc

@@ -8,7 +8,6 @@ You can install using any of the following methods
 
   $ gem install demolisher
   $ gem install demolisher -s http://gemcutter.org
-  $ gem install geoffgarside-demolisher -s http://gems.github.com
 
 the first two should always be stable, the latter github one should be stable but there are no guarantees.
 
@@ -54,6 +53,56 @@ and we should get the result of
   this person is active
   Randy Waterhouse: randy@example.com
 
+== Namespaces
+
+There is now rudimentary support for XML namespaced documents. The caveat is that if you are using a document with any XML namespaced elements you must access all elements via a namespace prefix.
+
+As an example we have this document
+
+  <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+    <soap:Body>
+      <getManufacturerNamesResponse xmlns="http://services.somewhere.com">
+        <IDAndNameList xmlns="http://services.somewhere.com">
+          <ns1:IdAndName xmlns:ns1="http://domain.somewhere.com">
+            14-Demolisher
+          </ns1:IdAndName>
+        </IDAndNameList>
+      </getManufacturerNamesResponse>
+    </soap:Body>
+  </soap:Envelope>
+
+some of the elements define their default namespace, +getManufacturerNamesResponse+ and +IDAndNameList+ so are not prefixed. When accessing these elements they will need to be prefixed.
+
+Additionally the list of namespaces need to known ahead of parse time. For the above document the list of namespaces is
+
+1. http://schemas.xmlsoap.org/soap/envelope/ as soap
+2. http://services.somewhere.com
+3. http://domain.somewhere.com as ns1
+
+as namespace two has no prefix, its a default namespace, we will assign it one when creating the hash of namespaces.
+
+  namespaces = {
+    'soap' => "http://schemas.xmlsoap.org/soap/envelope/",
+    'ns0' => "http://services.somewhere.com",
+    'ns1' => "http://domain.somewhere.com" }
+
+this hash of namespaces is then passed to Demolisher
+
+  xml = Demolisher.demolish('soap.xml', namespaces)
+  xml.soap :Envelope do
+    xml.soap :Body do
+      xml.ns0 :getManufacturerNamesResponse do
+        xml.ns0 :IDAndNameList do
+          puts xml.ns1(:IdAndName).strip
+        end
+      end
+    end
+  end
+
+the result of this will be
+
+  14-Demolisher
+
 == Copyright
 
 Copyright (c) 2009 Geoff Garside. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/demolisher.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{demolisher}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Geoff Garside"]
-  s.date = %q{2009-12-31}
+  s.date = %q{2010-05-18}
   s.email = %q{geoff@geoffgarside.co.uk}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "demolisher.gemspec",
      "lib/demolisher.rb",
      "test/demolisher_test.rb",
+     "test/ns.xml",
      "test/test.xml",
      "test/test_helper.rb"
   ]
@@ -32,7 +33,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{demolisher}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Gem for extracting information from XML files, think Builder but backwards}
   s.test_files = [
     "test/demolisher_test.rb",

data/lib/demolisher.rb

@@ -2,9 +2,9 @@ require 'xml'
 
 module Demolisher
   # Demolish an XML file or XML::Parser object.
-  def self.demolish(file_or_xml_parser)
+  def self.demolish(file_or_xml_parser, namespace_list = nil)
     file_or_xml_parser = new_parser(file_or_xml_parser) if file_or_xml_parser.kind_of?(String)
-    node = Node.new(file_or_xml_parser.parse, true)
+    node = Node.new(file_or_xml_parser.parse, namespace_list, true)
 
     yield node if block_given?
     node
@@ -26,9 +26,10 @@ module Demolisher
     # Creates a new Node object.
     #
     # If the node is not the root node then the secondargument needs to be false.
-    def initialize(xml, is_root = true)
+    def initialize(xml, namespaces = nil, is_root = true)
       @nodes = [xml]
       @nodes.unshift(nil) unless is_root
+      @namespaces = namespaces
     end
 
     # Access an attribute of the current node.
@@ -62,7 +63,7 @@ module Demolisher
     #       looks like a boolean. Otherwise return text content
     #     Otherwise return a new Node instance
     def method_missing(meth, *args, &block) # :nodoc:
-      xpath = @nodes.last.find(element_from_symbol(meth))
+      xpath = xpath_for_element(meth.to_s, args.shift)
       return nil if xpath.empty?
 
       if block_given?
@@ -88,7 +89,7 @@ module Demolisher
             content
           end
         else
-          self.class.new(node, false)
+          self.class.new(node, @namespaces, false)
         end
       end
     end
@@ -98,9 +99,13 @@ module Demolisher
       @nodes.last.content.strip
     end
 
+    def xpath_for_element(el_or_ns, el_for_ns = nil)
+      @nodes.last.find(element_from_symbol(el_or_ns, el_for_ns), @namespaces)
+    end
+
     # Transforms a symbol into a XML element path.
-    def element_from_symbol(sym) # :nodoc:
-      "#{is_root_node? ? '/' : nil}#{sym.to_s.gsub(/[^a-z0-9_]/i, '')}"
+    def element_from_symbol(el_or_ns,el_for_ns = nil) # :nodoc:
+      "#{is_root_node? ? '/' : nil}#{el_or_ns.gsub(/[^a-z0-9_]/i, '')}#{el_for_ns && el_for_ns.inspect}"
     end
 
     # Indicates if the current node is the root of the XML document.

data/test/demolisher_test.rb

@@ -61,4 +61,26 @@ EOXML
       assert_equal 'Geoff', @demolisher.hi.there
     end
   end
+  context "Demolished XML file with Namespaces" do
+    setup do
+      @id_and_name = ''
+      @namespaces = {'soap' => "http://schemas.xmlsoap.org/soap/envelope/",
+        'ns0' => "http://services.somewhere.com",
+        'ns1' => "http://domain.somewhere.com" }
+      Demolisher.demolish(File.dirname(__FILE__) +'/ns.xml', @namespaces) do |xml|
+        xml.soap :Envelope do
+          xml.soap :Body do
+            xml.ns0 :getManufacturerNamesResponse do
+              xml.ns0 :IDAndNameList do
+                @id_and_name = xml.ns1(:IdAndName).strip
+              end
+            end
+          end
+        end
+      end
+    end
+    should "get '14-Demolisher' from XML file" do
+      assert_equal '14-Demolisher', @id_and_name
+    end
+  end
 end

data/test/ns.xml

@@ -0,0 +1,11 @@
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <getManufacturerNamesResponse xmlns="http://services.somewhere.com">
+      <IDAndNameList xmlns="http://services.somewhere.com">
+        <ns1:IdAndName xmlns:ns1="http://domain.somewhere.com">
+          14-Demolisher
+        </ns1:IdAndName>
+      </IDAndNameList>
+    </getManufacturerNamesResponse>
+  </soap:Body>
+</soap:Envelope>

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: demolisher
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Geoff Garside
@@ -9,19 +14,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-31 00:00:00 +00:00
+date: 2010-05-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: libxml-ruby
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 3
         version: 1.1.3
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: geoff@geoffgarside.co.uk
 executables: []
@@ -41,6 +50,7 @@ files:
 - demolisher.gemspec
 - lib/demolisher.rb
 - test/demolisher_test.rb
+- test/ns.xml
 - test/test.xml
 - test/test_helper.rb
 has_rdoc: true
@@ -56,18 +66,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: demolisher
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Gem for extracting information from XML files, think Builder but backwards