ROXML 3.0.0

data/Rakefile

@@ -0,0 +1,95 @@
+require 'rake'
+
+ENV['RUBY_FLAGS'] = '-W1'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = 'ROXML'
+  gem.rubyforge_project = "roxml"
+  gem.summary = "Ruby Object to XML mapping library"
+  gem.description = <<EOF
+ROXML is a Ruby library designed to make it easier for Ruby developers to work with XML.
+Using simple annotations, it enables Ruby classes to be mapped to XML. ROXML takes care
+of the marshalling and unmarshalling of mapped attributes so that developers can focus on
+building first-class Ruby classes. As a result, ROXML simplifies the development of
+RESTful applications, Web Services, and XML-RPC.
+EOF
+  gem.email = "ben.woosley@gmail.com"
+  gem.homepage = "http://roxml.rubyforge.org"
+  gem.authors = ["Ben Woosley", "Zak Mandhro", "Anders Engstrom", "Russ Olsen"]
+
+  gem.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
+
+  gem.add_dependency 'activesupport', '>= 2.1.0'
+  gem.add_dependency 'nokogiri', '>= 1.3.3'
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sqlite3-ruby", '>= 1.2.4'
+  gem.add_development_dependency "activerecord", '>= 2.2.2'
+end
+Jeweler::GemcutterTasks.new
+Jeweler::RubyforgeTasks.new do |rubyforge|
+  rubyforge.doc_task = "rdoc"
+end
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:test, :spec]
+task :all => [:libxml, :nokogiri]
+task :libxml => ['test:libxml', 'spec:libxml']
+task :nokogiri => ['test:nokogiri', 'spec:nokogiri']
+
+# $hoe = Hoe.new('roxml', ROXML::VERSION) do |p|
+#   p.changes              = File.read("History.txt").split(/^==/)[1].strip
+# 
+#   p.test_globs = 'test/unit/*_test.rb'
+#   p.clean_globs |= %w[**/.DS_Store tmp *.log]
+#   path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+#   p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+#   p.rsync_args = '-av --delete --ignore-errors'
+# end
+
+## Provide the username used to upload website etc.
+#RubyForgeConfig = {
+#  :unix_name=>"roxml",
+#  :user_name=>"zakmandhro"
+#}
+
+#Rake::RDocTask.new do |rd|
+#  rd.rdoc_dir = "doc"
+#  rd.rdoc_files.include('MIT-LICENSE', 'README.rdoc', "lib/**/*.rb")
+#  rd.options << '--main' << 'README.rdoc' << '--title' << 'ROXML Documentation'
+#end
+#
+#desc "Publish Ruby on Rails plug-in on RubyForge"
+#task :release_plugin=>:rails_plugin do |task|
+#  pub = Rake::SshDirPublisher.new("#{RubyForgeConfig[:user_name]}@rubyforge.org",
+#      "/var/www/gforge-projects/#{RubyForgeConfig[:unix_name]}",
+#      "pkg/rails_plugin")
+#  pub.upload()
+#end
+#
+#desc "Publish and plugin site on RubyForge"
+#task :publish do |task|
+#  pub = Rake::RubyForgePublisher.new(RubyForgeConfig[:unix_name], RubyForgeConfig[:user_name])
+#  pub.upload()
+#end
+#
+#desc "Create the ZIP package"
+#Rake::PackageTask.new(spec.name, spec.version) do |p|
+#  p.need_zip = true
+#  p.package_files = FileList[
+#    "lib/**/*.rb", "*.txt", "README.rdoc", "Rakefile",
+#    "rake/**/*","test/**/*.rb", "test/**/*.xml", "html/**/*"]
+#end
+#
+#task :package=>:rdoc
+#task :rdoc=>:test
+#
+#desc "Create a RubyGem project"
+#Rake::GemPackageTask.new(spec).define
+#
+#desc "Clobber generated files"
+#task :clobber=>[:clobber_package, :clobber_rdoc]

data/TODO

@@ -0,0 +1,39 @@
+Planned:
+
+v 3.1
+
+  * Add xml_namespaces to allow declaration of distinct prefx/url namespace pairs
+
+  * Consider class_inheritable_attribute rather than superclass.try stuff.
+
+  * Do some benchmarking
+
+  * Back with http://xml-object.rubyforge.org/doc/ to minimize need for specifications?
+
+  * Commandeer #parse to use opposite #from_xml, but in an unrooted, collection-friendly fashion,
+   ala HappyMapper's parse
+
+v 3.x
+
+  * :self => true for sending method_missing to this attribute?
+
+  * :attributes extensions ala HappyMapper?
+
+  * Add xml_attrs 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_attrs :in => 'Attributes' do |xml|
+      xml.reader  :count, :as => Integer
+      xml.reader  :something_else, :as => Date
+    end
+
+  * Ensure (perhaps optionally) that references are unambiguous. That is error/warn
+   a singular specification has multiple possible node references
+
+  * Use lazy evaluation to minimize parsing time for large files
+
+

data/VERSION

@@ -0,0 +1 @@
+3.0.0

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,35 @@
+#!/usr/bin/env ruby
+require '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 => 'ItemAttributes'
+    # this is the only xml_reader that exists in a different namespace, so it
+    # must be explicitly specified
+    xml_reader :point, :namespace => 'georss'
+  end
+
+  class ItemSearchResponse < Base
+    xml_reader :total_results, :as => Integer, :in => 'Items'
+    xml_reader :total_pages, :as => Integer, :in => 'Items'
+    xml_reader :items, :as => [Item]
+  end
+end
+
+unless defined?(Spec)
+  response = PITA::ItemSearchResponse.from_xml(xml_for('amazon'))
+  p response.total_results
+  p response.total_pages 
+  response.items.each do |i|
+    puts i.asin, i.detail_page_url, i.manufacturer, i.point, ''
+  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, :as => 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/library.rb

@@ -0,0 +1,40 @@
+class Publisher
+  include ROXML
+
+  xml_accessor :name
+  
+  def initialize(name = nil)
+    @name = name
+  end
+  
+  def ==(other)
+    name == other.name
+  end
+  
+  # other important functionality
+end
+
+class Novel
+  include ROXML
+
+  xml_accessor :isbn, :from => "@ISBN" # attribute with name 'ISBN'
+  xml_accessor :title
+  xml_accessor :description, :cdata => true  # text node with cdata protection
+  xml_accessor :author
+  xml_accessor :publisher, :as => Publisher # singular object reference for illustrative purposes.
+  
+  def ==(other)
+    self.class.roxml_attrs.map(&:accessor).all? {|attr| send(attr) == other.send(attr) }
+  end
+end
+
+class Library
+  include ROXML
+
+  xml_accessor :name, :from => "NAME", :cdata => true
+  xml_accessor :novels, :as => [Novel] # by default roxml searches for books for in <novel> children, then, if none are present, in ./novels/novel children
+  
+  def ==(other)
+    name == other.name && novels == other.novels
+  end
+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, :from => :attr
+  xml_reader :hash, :from => :attr
+  xml_reader :description, :from => :attr
+  xml_reader :tag, :from => :attr
+  xml_reader :created_at, :from => '@time'
+  xml_reader :others, :from => :attr, :as => Integer
+  xml_reader :extended, :from => :attr
+end
+
+class Posts
+  include ROXML
+
+  xml_reader :posts, :as => [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/rails.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+require 'spec/spec_helper'
+require 'sqlite3'
+require 'activerecord'
+
+DB_PATH = 'spec/examples/rails.sqlite3'
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => DB_PATH
+)
+
+class Waypoint < ActiveRecord::Base
+  include ROXML
+
+  belongs_to :route
+
+  xml_attr :isLeg
+  xml_attr :lonlatx
+  xml_attr :lonlaty
+  xml_attr :gridReference
+  xml_attr :ascent
+  xml_attr :descent
+  xml_attr :distance
+  xml_attr :bearing
+  xml_attr :timemins
+end
+
+class Route < ActiveRecord::Base
+  include ROXML
+
+  has_many :waypoints
+
+  xml_attr :title
+  xml_attr :totalDist
+  xml_attr :totalMins
+  xml_attr :totalHg
+  xml_attr :lonlatx
+  xml_attr :lonlaty
+  xml_attr :grcenter
+
+  xml_attr :waypoints, :as => [Waypoint], :in => "waypoints"
+end
+
+# do a quick pseudo migration.  This should only get executed on the first run
+if !Waypoint.table_exists?
+  ActiveRecord::Base.connection.create_table(:waypoints) do |t|
+    t.column :route_id, :integer
+    t.column :isLeg, :string
+    t.column :lonlatx, :string
+    t.column :lonlaty, :string
+    t.column :gridReference, :string
+    t.column :ascent, :string
+    t.column :descent, :string
+    t.column :distance, :string
+    t.column :bearing, :string
+    t.column :timeMins, :string
+  end
+end
+
+if !Route.table_exists?
+  ActiveRecord::Base.connection.create_table(:routes) do |t|
+    t.column :title, :string
+    t.column :totalDist, :string
+    t.column :totalMins, :string
+    t.column :totalHg, :string
+    t.column :lonlatx, :string
+    t.column :lonlaty, :string
+    t.column :grcenter, :string
+  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 # This defaults to :as => DateTime, due to the '_at'
+	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, :as => User
+end
+
+class Statuses
+  include ROXML
+
+  xml_reader :statuses, :as => [Status]
+end

data/examples/xml/active_record.xml

@@ -0,0 +1,70 @@
+<route>
+<totalDist>11185.321521477119</totalDist>
+<totalHg>640</totalHg>
+<totalMins>235.75000000000003</totalMins>
+<lonlatx>357865</lonlatx>
+<lonlaty>271635</lonlaty>
+<grcenter>SH 71635 57865</grcenter>
+<waypoints>
+     <waypoint>
+         <isLeg>false</isLeg>
+         <lonlatx>357290</lonlatx>
+         <lonlaty>271650</lonlaty>
+         <gridReference>SH 71650 57290</gridReference>
+         <ascent>81</ascent>
+         <descent>220</descent>
+         <distance>0</distance>
+         <bearing>0</bearing>
+     </waypoint>
+     <waypoint>
+         <isLeg>false</isLeg>
+         <lonlatx>357260</lonlatx>
+         <lonlaty>274600</lonlaty>
+         <gridReference>SH 74600 57260</gridReference>
+         <ascent>275</ascent>
+         <descent>48</descent>
+         <distance>2950.152538429157</distance>
+         <bearing>91</bearing>
+     </waypoint>
+     <waypoint>
+         <isLeg>false</isLeg>
+         <lonlatx>359160</lonlatx>
+         <lonlaty>273330</lonlaty>
+         <gridReference>SH 73330 59160</gridReference>
+         <ascent>73</ascent>
+         <descent>170</descent>
+         <distance>2285.3664913969487</distance>
+         <bearing>326</bearing>
+     </waypoint>
+     <waypoint>
+         <isLeg>false</isLeg>
+         <lonlatx>359170</lonlatx>
+         <lonlaty>270050</lonlaty>
+         <gridReference>SH 70050 59170</gridReference>
+         <ascent>182</ascent>
+         <descent>172</descent>
+         <distance>3280.015243867016</distance>
+         <bearing>270</bearing>
+     </waypoint>
+     <waypoint>
+         <isLeg>false</isLeg>
+         <lonlatx>357470</lonlatx>
+         <lonlaty>269740</lonlaty>
+         <gridReference>SH 69740 57470</gridReference>
+         <ascent>29</ascent>
+         <descent>107</descent>
+         <distance>1728.0335644888382</distance>
+         <bearing>190</bearing>
+     </waypoint>
+     <waypoint>
+         <isLeg>false</isLeg>
+         <lonlatx>356840</lonlatx>
+         <lonlaty>270440</lonlaty>
+         <gridReference>SH 70440 56840</gridReference>
+         <ascent>640</ascent>
+         <descent>717</descent>
+         <distance>941.7536832951597</distance>
+         <bearing>132</bearing>
+     </waypoint>
+</waypoints>
+</route>