xml_resource 2.0.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39d686a14bc85492ab2c14febba48aa87f4f6886
-  data.tar.gz: ac9700fdf9aaeebf0c33dcf7a9afb6af044942b0
+  metadata.gz: 49c8c1c5f8723060db353908111209349586cabd
+  data.tar.gz: fa85add787dd73c08c2119efb09e852c3186c1d7
 SHA512:
-  metadata.gz: d58ea3703ec35453f365641d47537d6d2ceba5637453d7f54355d2985fc29a14d7609690ca833937fde57a96c1a7dc335d62d563efbd4166281fd1e1d207081a
-  data.tar.gz: e154eeeaac55e95cb6ea58c51003fa01144b6e4780af092fa231acfea99cf9d2b4ce98f1620be79c641456169f22b1f8d3748c51aa636c5fa577dba681e67e59
+  metadata.gz: 654917f32e7acff9e9e36b59b7790beb3062d504568cb662211cb1528587303d1c92aba0cf502c9deb05fcf738721b633e8d0c9552b0c4dd1aa69c74ad133863
+  data.tar.gz: dc1ca45a9f0a90cf6a25d87d0e4f4965fe06eedfb93aac4e7dd4ac09038ca03cb95edbdb4e7d4851b507f286c3d6b85dd5c6e02f1a8e2c2ce749b31f9774b475

data/README.md

@@ -9,7 +9,7 @@ Install
 In your Gemfile:
 
 ```ruby
-gem 'xml_resource', '~> 2.0.0'
+gem 'xml_resource', '~> 3.0.0'
 ```
 
 Use
@@ -37,14 +37,18 @@ xml = %q{
 </library>
 }
 
-class Library < XmlResource::Base
+class Library
+  include XmlResource::Model
+  
   has_collection :books
 
   has_attribute :open_from, :xpath => 'hours/from'
   has_attribute :open_till, :xpath => 'hours/till'
 end
 
-class Book < XmlResource::Base
+class Book
+  include XmlResource::Model
+  
   has_attribute :name
   has_attribute :author
   has_attribute :published, :type => :date, :xpath => 'firstpublished'

data/lib/xml_resource/errors.rb

@@ -0,0 +1,2 @@
+class XmlResource::ParseError < StandardError; end
+class XmlResource::TypeCastError < StandardError; end

data/lib/xml_resource/{base.rb → model.rb}

@@ -1,18 +1,20 @@
 module XmlResource
-  class Base
+  module Model
     TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE', 'on', 'ON'].to_set
     
-    class_attribute :attributes, :collections, :objects, :root_path, :remove_namespaces, :inflection
-    self.attributes = {}
-    self.collections = {}
-    self.objects = {}
-    self.inflection = :underscore
-  
-    class XmlResource::ParseError < StandardError; end
-    class XmlResource::TypeCastError < StandardError; end
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        class_attribute :attributes, :collections, :objects, :root_path, :remove_namespaces, :inflection
+        self.attributes = {}
+        self.collections = {}
+        self.objects = {}
+        self.inflection = :underscore
+      end
+    end
   
-    class << self
-    
+    module ClassMethods
+      
       def from_xml(xml_or_string, default_attrs = {})
         xml_or_string and xml = parse(xml_or_string) or return
         attrs = {}
@@ -26,17 +28,18 @@ module XmlResource
             attrs[name] = value
           end
         end
+        instance = new(attrs.reject { |k, v| v.nil? }.reverse_merge(default_attrs))
         self.objects.each do |name, options|
           if xpath = object_xpath(name)
-            attrs[name] = object_class(name).from_xml(xml.at(xpath))
+            instance.public_send("#{name}=", object_class(name).from_xml(xml.at(xpath)))
           end
         end
         self.collections.each do |name, options|
           if xpath = collection_xpath(name)
-            attrs[name] = collection_class(name).collection_from_xml(xml.at(xpath))
+            instance.public_send("#{name}=", collection_class(name).collection_from_xml(xml.at(xpath)))
           end
         end
-        new attrs.reject { |k, v| v.nil? }.reverse_merge(default_attrs)
+        instance
       end
     
       def collection_from_xml(xml_or_string, default_attrs = {})
@@ -64,7 +67,7 @@ module XmlResource
       protected
     
       def has_attribute(name, options = {})
-        self.attributes = attributes.merge(name.to_sym => options.symbolize_keys!)
+        self.attributes = attributes.merge(name.to_sym => options.symbolize_keys)
         attribute_accessor_method name
       end
     
@@ -74,12 +77,12 @@ module XmlResource
       end
     
       def has_object(name, options = {})
-        self.objects = objects.merge(name.to_sym => options.symbolize_keys!)
+        self.objects = objects.merge(name.to_sym => options.symbolize_keys)
         attr_accessor name
       end
     
       def has_collection(name, options = {})
-        self.collections = collections.merge(name.to_sym => options.symbolize_keys!)
+        self.collections = collections.merge(name.to_sym => options.symbolize_keys)
         define_method "#{name}" do
           instance_variable_get("@#{name}") or instance_variable_set("@#{name}", [])
         end
@@ -174,7 +177,8 @@ module XmlResource
     end
   
     def initialize(attrs = {})
-      self.attributes = attrs
+      self.attributes = attrs if attrs
+      super()
     end
 
     def valid?
@@ -182,7 +186,9 @@ module XmlResource
     end
   
     def attributes=(attrs)
-      attrs.each { |name, value| send "#{name}=", value }
+      attrs.each do |attr, value|
+        self.public_send("#{attr}=", value)
+      end
     end
   
     def attributes

data/lib/xml_resource/version.rb

@@ -1,3 +1,3 @@
 module XmlResource
-  VERSION = '2.0.5'
+  VERSION = '3.0.0'
 end

data/lib/xml_resource.rb

@@ -1,4 +1,7 @@
+require 'active_support'
 require 'active_support/core_ext'
 require 'nokogiri'
+
 require 'xml_resource/version'
-require 'xml_resource/base'
+require 'xml_resource/errors'
+require 'xml_resource/model'

data/test/models/camelid.rb

@@ -0,0 +1,5 @@
+class Camelid
+  include XmlResource::Model
+  
+  has_attribute :humps, type: :integer
+end

data/test/models/contact.rb

@@ -1,4 +1,6 @@
-class Contact < XmlResource::Base
+class Contact
+  include XmlResource::Model
+  
   has_attributes :first_name, :last_name, :type => :string
   
   def name

data/test/models/elephant.rb

@@ -1,4 +1,6 @@
-class Elephant < XmlResource::Base
+class Elephant
+  include XmlResource::Model
+  
   self.inflection = :upcase
   
   has_attribute :color

data/test/models/gadget.rb

@@ -0,0 +1,13 @@
+class Gadget
+  include XmlResource::Model  
+  
+  attr_reader :name
+  
+  has_attribute :magic
+  
+  def initialize(name, attrs = {})
+    raise ArgumentError, 'Name is required' if name.blank?
+    @name = name
+    super(attrs)
+  end
+end

data/test/models/item.rb

@@ -1,4 +1,6 @@
-class Item < XmlResource::Base
+class Item
+  include XmlResource::Model
+  
   self.root = 'i'
   
   has_attribute :quantity, :type => :float

data/test/models/order.rb

@@ -1,4 +1,6 @@
-class Order < XmlResource::Base
+class Order
+  include XmlResource::Model
+  
   has_attribute :id, :type => :integer
   has_attribute :date, :type => :date, :xpath => 'info/date'
   has_attribute :foobar, :xpath => 'info/foo[@type="bar"]'

data/test/models/shark.rb

@@ -1,4 +1,6 @@
-class Shark < XmlResource::Base
+class Shark
+  include XmlResource::Model
+    
   self.inflection = :dasherize
   
   has_attribute :shark_color

data/test/test_helper.rb

@@ -23,9 +23,21 @@ end
 require 'rubygems'
 require 'bundler/setup'
 Bundler.require(:default)
-require 'test/unit'
 require 'byebug'
 
+require 'active_support/testing/autorun'
+require 'active_support/test_case'
+
+ActiveSupport::TestCase.test_order = :random if ActiveSupport::TestCase.respond_to?(:test_order=)
+
 require 'xml_resource'
 
-Pathname.glob(Pathname.new(__FILE__).dirname.join('models').join('*.rb')).each { |model| require model.to_s.sub(/\.rb\z/, '') }
+require_relative 'models/camelid'
+require_relative 'models/camel'
+require_relative 'models/contact'
+require_relative 'models/dromedary'
+require_relative 'models/elephant'
+require_relative 'models/item'
+require_relative 'models/order'
+require_relative 'models/shark'
+require_relative 'models/gadget'

data/test/{cases/xml_resource_test.rb → xml_resource_test.rb}

@@ -1,8 +1,4 @@
-# encoding: utf-8
-
-require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
-
-require 'xml_resource'
+require_relative 'test_helper'
 
 class XmlResourceTest < ActiveSupport::TestCase
 
@@ -12,24 +8,24 @@ class XmlResourceTest < ActiveSupport::TestCase
   end    
   
   test 'Instantiation of attributes' do
-    assert_equal 3, orders.size
-    assert_equal [1, 2, 3], orders.map(&:id)
-    assert_equal %w(A B C), orders.map(&:foobar)
-    assert_equal %w(2012-08-27 2012-08-26 2012-08-25).map(&:to_date), orders.map(&:date)
-    assert_equal [12.99, 10, -12.99], orders.map(&:shipping_cost)
-    assert_equal [BigDecimal], orders.map(&:shipping_cost).map(&:class).uniq
+    assert_equal 3, @orders.size
+    assert_equal [1, 2, 3], @orders.map(&:id)
+    assert_equal %w(A B C), @orders.map(&:foobar)
+    assert_equal %w(2012-08-27 2012-08-26 2012-08-25).map(&:to_date), @orders.map(&:date)
+    assert_equal [12.99, 10, -12.99], @orders.map(&:shipping_cost)
+    assert_equal [BigDecimal], @orders.map(&:shipping_cost).map(&:class).uniq
     assert_equal [:quantity, :name], Item.attribute_names
   end
   
   test 'Instantiation of objects' do
-    assert_equal "Mister Spock", orders.first.customer.name
-    assert_equal "Käptn Kirk", orders.second.customer.name
-    assert_equal nil, orders.third.customer
-    assert_equal ['E F', 'A B', 'C D'], orders.map(&:contact).map(&:name)
+    assert_equal "Mister Spock", @orders.first.customer.name
+    assert_equal "Käptn Kirk", @orders.second.customer.name
+    assert_equal nil, @orders.third.customer
+    assert_equal ['E F', 'A B', 'C D'], @orders.map(&:contact).map(&:name)
   end
   
   test 'Instantiation of collections' do
-    items = orders.map(&:items)
+    items = @orders.map(&:items)
     assert_equal [1, 2, 3], items.map(&:size)
     assert_equal [[3], [3, 2], [3, 2, 1]], items.map { |ary| ary.map(&:quantity) }
     assert_equal [%w(1Three), %w(2Three 2Two), %w(3Three 3Two 3One)], items.map { |ary| ary.map(&:name) }
@@ -42,7 +38,7 @@ class XmlResourceTest < ActiveSupport::TestCase
   end
   
   test 'Validation method' do
-    assert_equal true, orders.first.valid?
+    assert_equal true, @orders.first.valid?
   end
   
   test 'Invalid data raises error' do
@@ -50,7 +46,7 @@ class XmlResourceTest < ActiveSupport::TestCase
   end
   
   test 'Boolean attributes' do
-    assert_equal [true, false, true], orders.map { |o| o.finished }
+    assert_equal [true, false, true], @orders.map { |o| o.finished }
   end
   
   test 'Inflections' do
@@ -74,14 +70,21 @@ class XmlResourceTest < ActiveSupport::TestCase
     assert_equal [1, 3], dromedaries.map(&:humps)
   end
   
-  private
-  
-  def orders
-    @orders
+  test 'Custom constructor' do
+    assert_nothing_raised do
+      gadget = Gadget.new('foo', magic: 5)
+      assert_equal 5, gadget.magic
+      assert_equal 'foo', gadget.name
+    end
+    assert_raise ArgumentError do
+      gadget = Gadget.new(nil, magic: 6)
+    end
   end
   
+  private
+  
   def load_xml(name)
-    File.read(File.expand_path(File.dirname(__FILE__) + "/../data/#{name}.xml"))
+    File.read(File.expand_path(File.join(File.dirname(__FILE__), 'data', "#{name}.xml")))
   end
   
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: xml_resource
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Matthias Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Create object trees out of XML documents
@@ -59,24 +59,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/xml_resource/base.rb
-- lib/xml_resource/version.rb
-- lib/xml_resource.rb
 - MIT-LICENSE
-- Rakefile
 - README.md
-- test/cases/xml_resource_test.rb
+- Rakefile
+- lib/xml_resource.rb
+- lib/xml_resource/errors.rb
+- lib/xml_resource/model.rb
+- lib/xml_resource/version.rb
 - test/data/inflection.xml
 - test/data/orders.xml
-- test/models/00_camelid.rb
 - test/models/camel.rb
+- test/models/camelid.rb
 - test/models/contact.rb
 - test/models/dromedary.rb
 - test/models/elephant.rb
+- test/models/gadget.rb
 - test/models/item.rb
 - test/models/order.rb
 - test/models/shark.rb
 - test/test_helper.rb
+- test/xml_resource_test.rb
 homepage: http://github.com/mtgrosser/xml_resource
 licenses:
 - MIT
@@ -87,30 +89,31 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Turn XML into Ruby objects
 test_files:
-- test/cases/xml_resource_test.rb
 - test/data/inflection.xml
 - test/data/orders.xml
-- test/models/00_camelid.rb
 - test/models/camel.rb
+- test/models/camelid.rb
 - test/models/contact.rb
 - test/models/dromedary.rb
 - test/models/elephant.rb
+- test/models/gadget.rb
 - test/models/item.rb
 - test/models/order.rb
 - test/models/shark.rb
 - test/test_helper.rb
+- test/xml_resource_test.rb

data/test/models/00_camelid.rb

@@ -1,3 +0,0 @@
-class Camelid < XmlResource::Base
-  has_attribute :humps, type: :integer
-end