roxml 2.4.1 → 2.4.2

data/History.txt

@@ -1,3 +1,24 @@
+== 2.4.2 (January 31, 2009)
+
+* 1 major enhancement
+
+  * xml_namespace for declaring Class-level, inheritable default namespaces.
+
+* 4 minor enhancements
+
+  * add :as => Time, DateTime, and Date support
+  * support Pathname, IO and URI objects as #from_xml arguments
+  * :as => :bool now supports all capitalizations of 'true', 'false', 'yes', 'no', as well as '1' and '0'
+  * For basic types (:as => Integer, Float, Date, &c.), interpret empty strings just
+    as missing elements (by returning nil), rather than raising.  Raise behavior can be
+    accessed by supplying your own block or using the :required option.
+
+ * 3 bug fixes
+
+  * Arrays of attrs or elements :as => :bool weren't previously supported.  An oversight.
+  * Don't apply xml_convention if name is explicitly set
+  * Protect xpath operators : and / from modification via String#camelcase & such
+
 == 2.4.1 (January 28, 2009)
 
 * 3 minor enhancements

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2004-2008 by Ben Woosley, Zak Mandhro and Anders Engstrom
+Copyright (c) 2004-2009 by Ben Woosley, Zak Mandhro and Anders Engstrom
 
 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,

data/Manifest.txt

@@ -4,9 +4,20 @@ Manifest.txt
 README.rdoc
 Rakefile
 TODO
-html/index.html
-html/style.css
+config/website.yml
+examples/amazon.rb
+examples/current_weather.rb
+examples/dashed_elements.rb
+examples/posts.rb
+examples/twitter.rb
+examples/xml/amazon.xml
+examples/xml/current_weather.xml
+examples/xml/dashed_elements.xml
+examples/xml/posts.xml
+examples/xml/twitter.xml
 lib/roxml.rb
+lib/roxml/definition.rb
+lib/roxml/extensions.rb
 lib/roxml/extensions/active_support.rb
 lib/roxml/extensions/array.rb
 lib/roxml/extensions/array/conversions.rb
@@ -14,11 +25,20 @@ lib/roxml/extensions/deprecation.rb
 lib/roxml/extensions/string.rb
 lib/roxml/extensions/string/conversions.rb
 lib/roxml/extensions/string/iterators.rb
-lib/roxml/options.rb
+lib/roxml/hash_definition.rb
 lib/roxml/xml.rb
-lib/roxml/xml/libxml.rb
-lib/roxml/xml/rexml.rb
+lib/roxml/xml/parsers/libxml.rb
+lib/roxml/xml/parsers/rexml.rb
+lib/roxml/xml/references.rb
 roxml.gemspec
+spec/examples/amazon_spec.rb
+spec/examples/current_weather_spec.rb
+spec/examples/dashed_elements_spec.rb
+spec/examples/post_spec.rb
+spec/examples/twitter_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake
 tasks/test.rake
 test/bugs/rexml_bugs.rb
 test/fixtures/book_malformed.xml
@@ -56,9 +76,9 @@ test/mocks/mocks.rb
 test/release/dependencies_test.rb
 test/test_helper.rb
 test/unit/array_test.rb
+test/unit/definition_test.rb
 test/unit/freeze_test.rb
 test/unit/inheritance_test.rb
-test/unit/options_test.rb
 test/unit/overriden_output_test.rb
 test/unit/roxml_test.rb
 test/unit/string_test.rb
@@ -79,3 +99,4 @@ vendor/override_rake_task/README
 vendor/override_rake_task/init.rb
 vendor/override_rake_task/install.rb
 vendor/override_rake_task/lib/override_rake_task.rb
+website/index.html

data/Rakefile

@@ -1,7 +1,7 @@
 ENV['RUBY_FLAGS'] = '-W1'
 
 %w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.join(File.dirname(__FILE__), 'lib/roxml')
+require File.expand_path(File.dirname(__FILE__) + '/lib/roxml')
 
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
@@ -38,7 +38,7 @@ require 'newgem/tasks' # load /tasks/*.rake
 
 Dir['tasks/**/*.rake'].each { |t| load t }
 
-task :default => :test
+task :default => [:test, :spec]
 
 ## Provide the username used to upload website etc.
 #RubyForgeConfig = {

data/TODO

@@ -11,32 +11,53 @@ v 2.5
  * Ensure (perhaps optionally) that references are unambiguous. That is error/warn
    a singular specification has multiple possible node references
 
- * Ensure support for nodes which aren't merely children, which hang out deep
-   in the file, but are accessible via xpath
+ * Automatically use Date or DateTime for accessors ending in '_on' and '_at', respectively
+
+ * Add xml_in helper to share :in declarations between several attributes. E.g.:
+
+     xml_reader :count, :in => 'Attributes', :as => Integer
+     xml_reader :something_else, :in => 'Attributes', :as => Date
+
+  becomes:
+
+    xml_in 'Attributes' do |xml|
+      xml.reader  :count, :as => Integer
+      xml.reader  :something_else, :as => Date
+    end
+
+ * :self => true for sending method_missing to this attribute?
+
+ * :attributes extensions ala HappyMapper?
 
 v 3.0
  * remove deprecated functionality
 
- * Perhaps provide cleaner separation between the specification
-   of type vs its source in the XML.  For example,
+ * Clarify API via seperation of concerns.  :as for Type, :from and :in for location,
+   All other options as named options, e.g. :cdata => true rather than :as => :cdata.
+   A few not so great examples...:
 
-     xml_reader :count, :from => 'Count, :in => 'Attributes', :as => Integer
-     xml_reader :count, :attr => 'Count, :in => 'Attributes', :as => Integer
+     xml_reader :some_objce, MyObject
+     xml_reader :size, :attr, :as => Integer
+     xml_reader :count, :attr, :as => Integer
 
    become:
 
-     xml_reader :count, Integer, 'Atributes/Count'
-     xml_reader :count, Integer, 'Atributes/@Count'
+     xml_reader :some_object, :as => MyObject
+     xml_reader :count, :size, :as => Integer, :from => :attr
 
-   potentially backward-incompatible change.  Needs some thought...
+   This will significantly simplify the internals and will also cleanly split
+   element type, location, name and options, for a more predictable API.
 
- * Back with XmlSimple/FasterXmlSimple to minimize need for specifications
+   It also enables multiple declarations on a single call, ala attr_*
 
- * Use lazy evaluation to minimize parsing time for large files
+     xml_reader :count, :size, :number, :as => Integer, :from => :attr
 
-Potential:
+ * Commandeer #parse to use opposite #from_xml, but in an unrooted, collection-friendly fashion,
+   ala HappyMapper's parse
 
- * Add shorthand support to hash declaration
+ * Back with http://xml-object.rubyforge.org/doc/ to minimize need for specifications?
+
+ * Use lazy evaluation to minimize parsing time for large files
 
- * :as => :self for sending method_missing to this attribute
+ * Consider class_inheritable_attribute rather than superclass.try stuff.
 

data/config/website.yml

@@ -0,0 +1,2 @@
+host: empact@rubyforge.org
+remote_dir: /var/www/gforge-projects/roxml

data/examples/amazon.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+
+# The document `pita.xml` contains both a default namespace and the 'georss'
+# namespace (for the 'point' xml_reader).
+module PITA
+  class Base
+    include ROXML
+    xml_convention :camelcase
+  end
+
+  class Item < Base
+    xml_reader :asin, :from => 'ASIN'
+    xml_reader :detail_page_url, :from => 'DetailPageURL'
+    xml_reader :manufacturer, :in => './'
+    # this is the only xml_reader that exists in a different namespace, so it
+    # must be explicitly specified
+    xml_reader :point, :from => 'georss:point'
+  end
+
+  class ItemSearchResponse < Base
+    xml_reader :total_results, :as => Integer, :in => 'Items'
+    xml_reader :total_pages, :as => Integer, :in => 'Items'
+    xml_reader :items, [Item]
+  end
+end
+
+unless defined?(Spec)
+  item = PITA::ItemSearchResponse.from_xml(xml_for('amazon'))
+  item.items.each do |i|
+    puts i.asin, i.detail_page_url, i.manufacturer, ''
+  end
+end

data/examples/current_weather.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+
+class Base
+  include ROXML
+  xml_convention :dasherize
+  xml_namespace 'aws'
+end
+
+class WeatherObservation < Base
+  xml_name 'ob'
+  xml_reader :temperature, :as => Float, :from => 'aws:temp'
+  xml_reader :feels_like, :as => Integer
+  xml_reader :current_condition #, :attributes => {:icon => String} # pending
+end
+
+class Weather < Base
+  xml_reader :observation, WeatherObservation, :required => true
+end
+
+unless defined?(Spec)
+  current_weather = Weather.from_xml(xml_for('current_weather')).observation
+  puts "temperature: #{current_weather.temperature}"
+  puts "feels_like: #{current_weather.feels_like}"
+  puts "current_condition: #{current_weather.current_condition}"
+# puts "current_condition.icon: #{current_weather.current_condition.icon}"  # pending
+end

data/examples/dashed_elements.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+
+module GitHub
+  class Commit
+    include ROXML
+    xml_convention :dasherize
+
+    xml_reader :url
+    xml_reader :tree
+    xml_reader :message
+    xml_reader :id
+    xml_reader :committed_date, :as => Date
+  end
+end
+
+unless defined?(Spec)
+  commit = GitHub::Commit.from_xml(xml_for('dashed_elements'))
+  puts commit.committed_date, commit.url, commit.id, ''
+end

data/examples/posts.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+
+class Post
+  include ROXML
+  
+  xml_reader :href, :attr
+  xml_reader :hash, :attr
+  xml_reader :description, :attr
+  xml_reader :tag, :attr
+  xml_reader :time, :attr, :as => DateTime
+  xml_reader :others, :attr, :as => Integer
+  xml_reader :extended, :attr
+end
+
+class Posts
+  include ROXML
+
+  xml_reader :posts, [Post]
+end
+
+unless defined?(Spec)
+  posts = Posts.from_xml(xml_for('posts'))
+  posts.posts.each do |post|
+    puts post.description, post.href, post.extended, ''
+  end
+end

data/examples/twitter.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+require 'time'
+
+class User
+  include ROXML
+  
+  xml_reader :id, :as => Integer
+  xml_reader :name
+  xml_reader :screen_name
+  xml_reader :location
+  xml_reader :description
+  xml_reader :profile_image_url
+  xml_reader :url
+  xml_reader :protected?
+  xml_reader :followers_count, :as => Integer
+end
+
+class Status
+  include ROXML
+  
+  xml_reader :id, :as => Integer
+  xml_reader :text
+	xml_reader :created_at, :as => Time
+	xml_reader :source
+	xml_reader :truncated?
+	xml_reader :in_reply_to_status_id, :as => Integer
+	xml_reader :in_reply_to_user_id, :as => Integer
+	xml_reader :favorited?
+	xml_reader :user, User
+end
+
+class Statuses
+  include ROXML
+
+  xml_reader :statuses, [Status]
+end

data/examples/xml/amazon.xml

@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2005-10-05" xmlns:georss="http://www.georss.org/georss">
+	<OperationRequest>
+		<HTTPHeaders>
+			<Header Name="UserAgent">
+			</Header>
+		</HTTPHeaders>
+		<RequestId>16WRJBVEM155Q026KCV1</RequestId>
+		<Arguments>
+			<Argument Name="SearchIndex" Value="Books"></Argument>
+			<Argument Name="Service" Value="AWSECommerceService"></Argument>
+			<Argument Name="Title" Value="Ruby on Rails"></Argument>
+			<Argument Name="Operation" Value="ItemSearch"></Argument>
+			<Argument Name="AWSAccessKeyId" Value="dontbeaswoosh"></Argument>
+		</Arguments>
+		<RequestProcessingTime>0.064924955368042</RequestProcessingTime>
+	</OperationRequest>
+	<Items>
+		<Request>
+			<IsValid>True</IsValid>
+			<ItemSearchRequest>
+				<SearchIndex>Books</SearchIndex>
+				<Title>Ruby on Rails</Title>
+			</ItemSearchRequest>
+		</Request>
+		<TotalResults>22</TotalResults>
+		<TotalPages>3</TotalPages>
+		<Item>
+			<ASIN>0321480791</ASIN>
+			<georss:point>38.5351715088 -121.7948684692</georss:point>
+		<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=0321480791%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0321480791%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Michael Hartl</Author>
+				<Author>Aurelius Prochazka</Author>
+				<Manufacturer>Addison-Wesley Professional</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>RailsSpace: Building a Social Networking Website with Ruby on Rails (Addison-Wesley Professional Ruby Series)</Title>
+			</ItemAttributes>
+		</Item>
+		<Item>
+			<ASIN>047022388X</ASIN>
+			<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=047022388X%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/047022388X%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Noel Rappin</Author>
+				<Manufacturer>Wrox</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>Professional Ruby on Rails</Title>
+			</ItemAttributes>
+		</Item>
+		<Item>
+			<ASIN>1590598814</ASIN>
+			<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=1590598814%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/1590598814%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Ola Bini</Author>
+				<Manufacturer>Apress</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>Practical JRuby on Rails Web 2.0 Projects: Bringing Ruby on Rails to Java</Title>
+			</ItemAttributes>
+		</Item>
+		<Item>
+			<ASIN>0596101325</ASIN>
+			<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=0596101325%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0596101325%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Bruce Tate</Author>
+				<Author>Curt Hibbs</Author>
+				<Manufacturer>O'Reilly Media, Inc.</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>Ruby on Rails: Up and Running</Title>
+			</ItemAttributes>
+		</Item>
+		<Item>
+			<ASIN>0470081201</ASIN>
+			<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=0470081201%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0470081201%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Barry Burd</Author>
+				<Manufacturer>For Dummies</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>Ruby on Rails For Dummies (For Dummies (Computer/Tech))</Title>
+			</ItemAttributes>
+		</Item>
+		<Item>
+			<ASIN>0975841955</ASIN>
+			<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=0975841955%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0975841955%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Patrick Lenz</Author>
+				<Manufacturer>SitePoint</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>Build Your Own Ruby on Rails Web Applications</Title>
+			</ItemAttributes>
+		</Item>
+		<Item>
+			<ASIN>0470069155</ASIN>
+			<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=0470069155%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0470069155%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Steve,  Ph.D. Holzner</Author>
+				<Manufacturer>Wrox</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>Beginning Ruby on Rails (Wrox Beginning Guides)</Title>
+			</ItemAttributes>
+		</Item>
+		<Item>
+			<ASIN>1590597362</ASIN>
+			<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=1590597362%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/1590597362%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Christian Hellsten</Author>
+				<Author>Jarkko Laine</Author>
+				<Manufacturer>Apress</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>Beginning Ruby on Rails E-Commerce: From Novice to Professional (Rails)</Title>
+			</ItemAttributes>
+		</Item>
+		<Item>
+			<ASIN>1590597524</ASIN>
+			<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=1590597524%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/1590597524%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Justin Williams</Author>
+				<Manufacturer>friends of ED</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>Rails Solutions: Ruby on Rails Made Easy (Solutions)</Title>
+			</ItemAttributes>
+		</Item>
+		<Item>
+			<ASIN>0321517067</ASIN>
+			<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=0321517067%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0321517067%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
+			<ItemAttributes>
+				<Author>Aurelius Prochazka</Author>
+				<Manufacturer>Addison-Wesley Professional</Manufacturer>
+				<ProductGroup>Book</ProductGroup>
+				<Title>RailsSpace Ruby on Rails Tutorial (Video Training) (LiveLessons)</Title>
+			</ItemAttributes>
+		</Item>
+	</Items>
+</ItemSearchResponse>