xml_resource 1.0.0 → 2.0.0

data/README.md

@@ -1,2 +1,64 @@
 xml_resource
-============
+============
+
+Turn XML into Ruby objects
+
+Install
+-------
+
+In your Gemfile:
+
+```ruby
+gem 'xml_resource', '~> 2.0.0'
+```
+
+Use
+---
+
+```ruby
+xml = %q{
+<library>
+  <books>
+    <book>
+      <name>The Tempest</name>
+      <author>William Shakespeare</author>
+      <firstpublished>Nov 1, 1611</firstpublished>
+    </book>
+    <book>
+      <name>Moby-Dick</name>
+      <author>Herman Melville</author>
+      <firstpublished>Oct 18, 1851</firstpublished>
+    </book>
+  </books>
+  <hours>
+    <from>08:00 AM</from>
+    <till>06:00 PM</till>
+  </hours>
+</library>
+}
+
+class Library < XmlResource::Base
+  has_collection :books
+
+  has_attribute :open_from, :xpath => 'hours/from'
+  has_attribute :open_till, :xpath => 'hours/till'
+end
+
+class Book < XmlResource::Base
+  has_attribute :name
+  has_attribute :author
+  has_attribute :published, :type => :date, :xpath => 'firstpublished'
+end
+
+library = Library.from_xml(xml)
+=> #<Library:0x00000100dcf7e8 @attributes={"open_from"=>"08:00 AM", "open_till"=>"06:00 PM"}, @books=[#<Book:0x00000100dd1778 @attributes={"name"=>"The Tempest", "author"=>"William Shakespeare", "published"=>Tue, 01 Nov 1611}>, #<Book:0x00000100dcfbd0 @attributes={"name"=>"Moby-Dick", "author"=>"Herman Melville", "published"=>Sat, 18 Oct 1851}>]>
+
+library.open_from
+=> "08:00 AM"
+
+book = library.books.first
+=> #<Book:0x00000100dd1778 @attributes={"name"=>"The Tempest", "author"=>"William Shakespeare", "published"=>Tue, 01 Nov 1611}>
+
+book.published
+=> Tue, 01 Nov 1611
+```

data/lib/xml_resource/base.rb

@@ -1,5 +1,7 @@
 module XmlResource
   class Base
+    TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE', 'on', 'ON'].to_set
+    
     class_attribute :attributes, :collections, :objects, :root_path
     self.attributes = {}
     self.collections = {}
@@ -45,7 +47,7 @@ module XmlResource
       end
     
       def root
-        self.root_path || "/#{self.basename.underscore}"
+        self.root_path || "./#{self.basename.underscore}"
       end
     
       def root=(root)
@@ -95,7 +97,7 @@ module XmlResource
       [:attribute, :object, :collection].each do |method_name|
         define_method "#{method_name}_xpath" do |name|
           options = send(method_name.to_s.pluralize)
-          options[name] && options[name][:xpath] or "/#{name}"
+          options[name] && options[name][:xpath] or "./#{name}"
         end
       end
 
@@ -124,7 +126,7 @@ module XmlResource
         when :string    then value
         when :integer   then value.to_i
         when :float     then value.to_f
-        when :boolean   then !!value
+        when :boolean   then cast_to_boolean(value)
         when :decimal   then BigDecimal.new(value)
         when :date      then Date.parse(value)
         when :datetime  then DateTime.parse(value)
@@ -133,10 +135,18 @@ module XmlResource
         end
       end
 
+      def cast_to_boolean(value)
+        if value.is_a?(String) && value.blank?
+          nil
+        else
+          TRUE_VALUES.include?(value)
+        end
+      end
+
       def parse(xml_or_string)
         case xml_or_string
-        when Hpricot::Elem, Hpricot::Elements then xml_or_string
-        when String then Hpricot.XML(xml_or_string).root
+        when Nokogiri::XML::Node, Nokogiri::XML::NodeSet then xml_or_string
+        when String then Nokogiri.XML(xml_or_string).root
         else
           raise XmlResource::ParseError, "cannot parse #{xml_or_string.inspect}"
         end 

data/lib/xml_resource/version.rb

@@ -1,3 +1,3 @@
 module XmlResource
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/xml_resource.rb

@@ -1,4 +1,4 @@
 require 'active_support/core_ext'
-require 'hpricot'
+require 'nokogiri'
 require 'xml_resource/version'
 require 'xml_resource/base'

data/test/cases/xml_resource_test.rb

@@ -49,6 +49,10 @@ class XmlResourceTest < ActiveSupport::TestCase
     assert_raise(XmlResource::ParseError) { Order.collection_from_xml({}) }
   end
   
+  test 'Boolean attributes' do
+    assert_equal [true, false, true], orders.map { |o| o.finished }
+  end
+  
   private
   
   def orders

data/test/data/orders.xml

@@ -1,6 +1,7 @@
 <someroot>
   <order>
     <id>1</id>
+    <finished>true</finished>
     <info>
       <foo type="bar">A</foo>
       <date>2012-08-27</date>
@@ -25,6 +26,7 @@
   
   <order>
     <id>2</id>
+    <finished>false</finished>
     <info>
       <foo type="non">blubb</foo>
       <foo type="bar">B</foo>
@@ -53,6 +55,7 @@
   
   <order>
     <id>3</id>
+    <finished>true</finished>
     <info>
       <foo type="non">wah</foo>
       <foo type="bar">C</foo>

data/test/models/order.rb

@@ -1,11 +1,12 @@
 class Order < XmlResource::Base
   has_attribute :id, :type => :integer
-  has_attribute :date, :type => :date, :xpath => '/info/date'
-  has_attribute :foobar, :xpath => '/info/foo[@type="bar"]'
+  has_attribute :date, :type => :date, :xpath => 'info/date'
+  has_attribute :foobar, :xpath => 'info/foo[@type="bar"]'
+  has_attribute :finished, :type => :boolean
   has_attribute :shipping_cost, :type => :decimal
-  
+
   has_object :customer, :class_name => "Contact"
   has_object :contact
   
-  has_collection :items, :class_name => "Item", :xpath => '/items'
+  has_collection :items, :class_name => "Item", :xpath => 'items'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xml_resource
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2151918380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2151918380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: hpricot
-  requirement: &2151917700 !ruby/object:Gem::Requirement
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151917700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &2151917100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,8 +53,13 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151917100
-description: ''
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'xml_resource is '
 email:
 - mtgrosser@gmx.net
 executables: []
@@ -63,7 +78,7 @@ files:
 - test/models/item.rb
 - test/models/order.rb
 - test/test_helper.rb
-homepage: http://rubygems.org/gems/xml_resource
+homepage: http://github.com/mtgrosser/xml_resource
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -83,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Turn XML into Ruby objects