demolisher 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Geoff Garside
+
+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.rdoc

@@ -0,0 +1,48 @@
+= demolisher
+
+Works in a similar fashion to Builder but is instead used for extracting information from XML files rather than building them.
+
+== Example
+
+Given the simple XML example file below
+
+  <addressbook>
+    <person>
+      <firstname>Enoch</firstname>
+      <lastname>Root</lastname>
+      <contact>
+        <phone>01234 567 8900</phone>
+        <email>enoch@example.com</email>
+      </contact>
+      <active>YES</active>
+    </person>
+    <person>
+      <firstname>Randy</firstname>
+      <lastname>Waterhouse</lastname>
+      <contact>
+        <phone>01234 567 8901</phone>
+        <email>randy@example.com</email>
+      </contact>
+      <active>NO</active>
+    </person>
+  </addressbook>
+
+we can parse it with
+
+  xml = Demolisher.demolish('addressbook.xml')
+  xml.addressbook do
+    xml.person do
+      puts "#{xml.firstname} #{xml.lastname}: #{xml.contact.email}"
+      puts "this person is active" if xml.active?
+    end
+  end
+
+and we should get the result of
+
+  Enoch Root: enoch@example.com
+  this person is active
+  Randy Waterhouse: randy@example.com
+
+== Copyright
+
+Copyright (c) 2009 Geoff Garside. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "demolisher"
+    gem.summary = %Q{Gem for extracting information from XML files, think Builder but backwards}
+    gem.email = "geoff@geoffgarside.co.uk"
+    gem.homepage = "http://github.com/geoffgarside/demolisher"
+    gem.authors = ["Geoff Garside"]
+    gem.rubyforge_project = 'demolisher'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency('libxml-ruby', '>= 1.1.3')
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "demolisher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/demolisher.gemspec

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{demolisher}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Geoff Garside"]
+  s.date = %q{2009-06-09}
+  s.email = %q{geoff@geoffgarside.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "demolisher.gemspec",
+     "lib/demolisher.rb",
+     "test/demolisher_test.rb",
+     "test/test.xml",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/geoffgarside/demolisher}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{demolisher}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Gem for extracting information from XML files, think Builder but backwards}
+  s.test_files = [
+    "test/demolisher_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<libxml-ruby>, [">= 1.1.3"])
+    else
+      s.add_dependency(%q<libxml-ruby>, [">= 1.1.3"])
+    end
+  else
+    s.add_dependency(%q<libxml-ruby>, [">= 1.1.3"])
+  end
+end

data/lib/demolisher.rb

@@ -0,0 +1,73 @@
+require 'xml'
+
+module Demolisher
+  # Demolish an XML file or XML::Parser object.
+  def self.demolish(file_or_xml_parser)
+    file_or_xml_parser = XML::Parser.file(file_or_xml_parser) if file_or_xml_parser.kind_of?(String)
+    node = Node.new(file_or_xml_parser.parse, true)
+
+    yield node if block_given?
+    node
+  end
+  class Node
+    # Creates a new Node object. If the node is not the root node then
+    # the second argument needs to be false.
+    def initialize(xml, is_root = true)
+      @nodes = [xml]
+      @nodes.unshift(nil) unless is_root
+    end
+    # Access an attribute of the current node
+    # Example:
+    #   <addressbook>
+    #     <person rel="friend">
+    #       <firstname>Steve</firstname>
+    #     </person>
+    #   </addressbook>
+    # 
+    #   xml.addressbook do
+    #     xml.person do
+    #       puts "#{xml.firstname} is a #{xml['rel']}"  #=> "Steve is a friend"
+    #     end
+    #   end
+    # 
+    def [](attr_name)
+      @nodes.last.attributes[attr_name]
+    end
+    def method_missing(meth, *args, &block) # :nodoc:
+      xpath = @nodes.last.find(element_from_symbol(meth))
+      return nil if xpath.empty?
+
+      if block_given?
+        xpath.each do |node|
+          @nodes.push(node)
+          yield
+          @nodes.pop
+        end
+      else
+        node = xpath.first
+
+        if node.find('text()').length == 1
+          content = node.find('text()').first.content
+          case meth.to_s
+          when /\?$/
+            !! Regexp.new(/(t(rue)?|y(es)?|1)/i).match(content)
+          else
+            content
+          end
+        else
+          self.class.new(node, false)
+        end
+      end
+    end
+    def to_s # :nodoc:
+      @nodes.last.content.strip
+    end
+    def element_from_symbol(sym) # :nodoc:
+      "#{is_root_node? ? '/' : nil}#{sym.to_s.gsub(/[^a-z0-9_]/i, '')}"
+    end
+    # Indicates if the current node is the root of the XML document
+    def is_root_node?
+      @nodes.size == 1
+    end
+  end
+end

data/test/demolisher_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+class DemolisherTest < Test::Unit::TestCase
+  context "Demolished XML file" do
+    setup do
+      @people = Array.new
+      Demolisher.demolish(File.dirname(__FILE__) +'/test.xml') do |xml|
+        xml.addressbook do
+          xml.person do
+            @people << {:firstname => xml.firstname, :lastname => xml.lastname,
+              :active => xml.active?, :email => xml.contact.email}
+          end
+        end
+      end
+    end
+    context "first extracted person" do
+      setup do
+        @person = @people[0]
+      end
+      should "have extracted firstname" do
+        assert_equal 'Enoch', @person[:firstname]
+      end
+      should "have extracted lastname" do
+        assert_equal 'Root', @person[:lastname]
+      end
+      should "have extracted true active status" do
+        assert @person[:active]
+      end
+      should "have extracted email" do
+        assert_equal 'enoch@example.com', @person[:email]
+      end
+    end
+    context "second extracted person" do
+      setup do
+        @person = @people[1]
+      end
+      should "have extracted firstname" do
+        assert_equal 'Randy', @person[:firstname]
+      end
+      should "have extracted lastname" do
+        assert_equal 'Waterhouse', @person[:lastname]
+      end
+      should "have extracted false active status" do
+        assert !@person[:active]
+      end
+      should "have extracted email" do
+        assert_equal 'randy@example.com', @person[:email]
+      end
+    end
+  end
+end

data/test/test.xml

@@ -0,0 +1,20 @@
+<addressbook>
+  <person>
+    <firstname>Enoch</firstname>
+    <lastname>Root</lastname>
+    <contact>
+      <phone>01234 567 8900</phone>
+      <email>enoch@example.com</email>
+    </contact>
+    <active>YES</active>
+  </person>
+  <person>
+    <firstname>Randy</firstname>
+    <lastname>Waterhouse</lastname>
+    <contact>
+      <phone>01234 567 8901</phone>
+      <email>randy@example.com</email>
+    </contact>
+    <active>NO</active>
+  </person>
+</addressbook>

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'demolisher'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: demolisher
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Geoff Garside
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-09 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 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+description: 
+email: geoff@geoffgarside.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- demolisher.gemspec
+- lib/demolisher.rb
+- test/demolisher_test.rb
+- test/test.xml
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/geoffgarside/demolisher
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: demolisher
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Gem for extracting information from XML files, think Builder but backwards
+test_files: 
+- test/demolisher_test.rb
+- test/test_helper.rb