lzell-mapricot 0.0.1

data/History.txt

@@ -0,0 +1,3 @@
+== 0.0.1 2009-03-06
+
+First gem!

data/License.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Louis Zell <lzell11@gmail.com>
+
+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,118 @@
+== Mapricot
+
+Makes working with XML stupid easy.  XML to object mapper with an interface similar to ActiveRecord associations.
+
+
+== Install
+
+Do some stuff...
+
+== Usage
+
+Your classes should inherit from Mapricot::Base, which provides the class methods 
+* has_one(name, type, opts = {})
+* has_many(name, type, opts = {})
+* has_attribute(name)
+  
+When you instantiate a Mapricot::Base object, you can pass it a string of xml:
+  class MapMe < Mapricot::Base
+  end
+  
+  MapMe.new :xml => "<some_stuff>...</some_stuff>"
+
+Or you can pass it a url:
+  class MapMeToo < Mapricot::Base
+  end
+  
+  MapMeToo.new :url => "http://some_url"
+
+== Examples
+
+==== Super Simple
+
+  simple_xml = %(
+    <user>
+      <id>1</name>
+      <name>Bob</name>
+      <pet>cat</pet>
+      <pet>dog</pet>
+    </user>
+  )
+
+  class User < Mapricot::Base
+    has_one   :id,    :integer
+    has_one   :name,  :string
+    has_many  :pets,  :string
+  end
+
+  user = User.new(:xml => simple_xml)
+  puts user.id                # => 1
+  puts user.id.class          # => Fixnum
+  puts user.name              # => Bob
+  puts user.pets.class        # => Array
+  puts user.pets.join(", ")   # => cat, dog
+
+
+==== A little more realistic
+
+  xml = %(
+    <user>
+      <id>2</name>
+      <name>Sally</name>
+      <location code="ny123">
+        <city>New York</city>
+        <state>NY</state>
+      </location>
+      <hobby>
+        <description>Skiing</description>
+        <number_of_years>2</number_of_years>
+      </hobby>
+      <hobby>
+        <description>Hiking</description>
+        <number_of_years>3</number_of_years>
+      </hobby>
+    </user>
+  )
+
+
+  class User < Mapricot::Base
+    has_one   :id,        :integer
+    has_one   :name       # Tag type will default to :string
+    has_many  :pets
+    has_one   :location,  :xml
+    has_many  :hobbies,   :xml
+  end
+
+  class Location < Mapricot::Base
+    has_attribute :code
+    has_one       :city
+    has_one       :state
+  end
+
+  class Hobby < Mapricot::Base
+    has_one :description,     :string
+    has_one :number_of_years, :integer
+  end
+
+  user = User.new(:xml => xml)
+  puts user.name            # => Sally
+  puts user.pets.inspect    # => []
+  puts user.location.class  # => Location
+  puts user.location.city   # => New York
+  puts user.location.state  # => NY
+  puts user.location.code   # => ny123
+  puts user.hobbies.class         # => Array
+  puts user.hobbies.first.class   # => Hobby
+
+  user.hobbies.each do |hobby|
+    puts "#{hobby.description} for #{hobby.number_of_years} years"
+  end
+  # => Skiing for 2 years
+  # => Hiking for 3 years
+  
+== Credits
+
+All to why the luck stiff for Hpricot.
+
+
+Copyright (c) 2009 Lou Zell, released under the MIT license

data/examples/lastfm_api.rb

@@ -0,0 +1,41 @@
+# Get events in nyc with:
+# http://ws.audioscrobbler.com/2.0/?method=geo.getevents&city=new+york&api_key=YOUR_API_KEY_HERE
+
+# The point of this is to demonstrate mapping xml from a real api response.
+# The only difference is you instantiate with:
+# Response.new(:url => "http://someurl")
+# instead of:
+# Response.new(:xml => "some string of xml")
+
+# If you do not have an API key, see examples/lastfm_api_no_request.rb
+require '../lib/mapricot'
+
+class Response < Mapricot::Base
+  has_many :events,   :xml
+end
+
+class Event < Mapricot::Base
+  has_one :title
+  has_one :venue,   :xml
+end
+
+class Venue < Mapricot::Base
+  has_one :name
+  has_one :location, :xml
+end
+
+class Location < Mapricot::Base
+  has_one :city
+  has_one :country
+  has_one :street
+  has_one :postalcode,  :integer
+end
+
+response = Response.new(:url => "http://ws.audioscrobbler.com/2.0/?method=geo.getevents&city=new+york&api_key=#{YOUR_API_KEY_HERE}")
+
+response.events.each do |event|
+  puts "-------------"
+  puts event.title
+  puts event.venue.name
+  puts event.venue.location.city
+end

data/examples/lastfm_api_no_request.rb

@@ -0,0 +1,126 @@
+require '../lib/mapricot'
+
+
+last_fm_example = %(
+<?xml version="1.0" encoding="utf-8"?>
+<lfm status="ok">
+<events location="New York, United States" page="1" totalpages="92" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" total="917">
+<event>
+  <id>895664</id>
+  <title>Lydia</title>
+  <artists>
+    <artist>Lydia</artist>
+    <artist>Black Gold</artist>
+
+    <headliner>Lydia</headliner>
+  </artists>
+  <venue>
+    <name>Mercury Lounge</name>
+    <location>
+      <city>New York</city>
+      <country>United States</country>
+
+      <street>217 East Houston Street</street>
+      <postalcode>10002</postalcode>
+      <geo:point>
+         <geo:lat>40.722024</geo:lat>
+         <geo:long>-73.98682</geo:long>
+      </geo:point>
+              <timezone>EST</timezone>
+
+          </location>
+    <url>http://www.last.fm/venue/8899833</url>
+  </venue>
+  <startDate>Thu, 05 Mar 2009</startDate>
+  <startTime>18:30</startTime>
+  <description><![CDATA[<div class="bbcode">On Sale Fri 1/16 at Noon<br />
+21+<br />
+$10<br />
+Doors 6:30pm/ Show 7:30pm</div>]]></description>
+  <image size="small">http://userserve-ak.last.fm/serve/34/9158303.jpg</image>
+
+  <image size="medium">http://userserve-ak.last.fm/serve/64/9158303.jpg</image>
+  <image size="large">http://userserve-ak.last.fm/serve/126/9158303.jpg</image>
+   <attendance>7</attendance>
+   <reviews>0</reviews>
+   <tag>lastfm:event=895664</tag>  
+  <url>http://www.last.fm/event/895664</url>
+
+</event>
+<event>
+  <id>924763</id>
+  <title>Stars Like Fleas</title>
+  <artists>
+    <artist>Stars Like Fleas</artist>
+
+    <artist>Frances</artist>
+    <artist>twi the humble feather</artist>
+    <artist>La Strada</artist>
+    <headliner>Stars Like Fleas</headliner>
+  </artists>
+  <venue>
+    <name>Music Hall of Williamsburg</name>
+
+    <location>
+      <city>Brooklyn, NY</city>
+      <country>United States</country>
+      <street>66 North 6th Street</street>
+      <postalcode>11211</postalcode>
+      <geo:point>
+         <geo:lat>40.719308</geo:lat>
+
+         <geo:long>-73.961607</geo:long>
+      </geo:point>
+              <timezone>EST</timezone>
+          </location>
+    <url>http://www.last.fm/venue/8851989</url>
+  </venue>
+  <startDate>Thu, 05 Mar 2009</startDate>
+
+  <startTime>19:00</startTime>
+  <description><![CDATA[<div class="bbcode">Doors 7 p.m. / Show 8 p.m.<br />
+$10 advance / $12 day of show<br />
+18+<br />
+<br />
+On sale Wed. 2/4 at noon</div>]]></description>
+  <image size="small">http://userserve-ak.last.fm/serve/34/3598785.jpg</image>
+  <image size="medium">http://userserve-ak.last.fm/serve/64/3598785.jpg</image>
+  <image size="large">http://userserve-ak.last.fm/serve/126/3598785.jpg</image>
+   <attendance>1</attendance>
+
+   <reviews>0</reviews>
+   <tag>lastfm:event=924763</tag>  
+  <url>http://www.last.fm/event/924763</url>
+</event>
+</events></lfm>
+
+)
+
+
+class Response < Mapricot::Base
+  has_many :events, :xml
+end
+
+class Event < Mapricot::Base
+  has_one :id,              :integer
+  has_one :title,           :string
+  has_one :artist_group,    :xml,       :tag_name => "artists"
+  has_one :venue,           :xml
+end
+
+class ArtistGroup < Mapricot::Base
+  has_many  :artists,       :string
+  has_one   :headliner,     :string
+end
+
+class Venue < Mapricot::Base
+  has_one   :name,          :string
+end
+
+lfm = Response.new(:xml => last_fm_example)
+lfm.events.each do |event|
+  puts "-------------------------------"
+  puts event.title
+  puts event.artist_group.artists.inspect
+  puts event.venue.name
+end

data/examples/natural_inputs.rb

@@ -0,0 +1,22 @@
+# Coming soon!
+# class NaturalInputs < Mapricot
+#   has_one   :message, :string
+#   has_many  :occurrences, :xml
+# end
+#
+#
+# class Occurrence < Mapricot::Base
+#   has_one   :start_date
+#   has_one   :end_date
+#   has_one   :interval
+#   has_one   :day_of_week
+#   has_one   :week_of_month
+#   has_one   :start_time
+#   has_one   :end_time
+#   has_one   :date_of_month
+# end
+# 
+# 
+# n = NaturalInputs.new("http://localhost:3000/query?q=lunch+this+friday+with+maria")
+# puts n.message # => "lunch with maria"
+# puts n.occurrences.first.start_date # => "2009-01-16"

data/examples/readme_examples.rb

@@ -0,0 +1,82 @@
+require '../lib/mapricot'
+
+# super simple
+simple_xml = %(
+  <user>
+    <id>1</name>
+    <name>Bob</name>
+    <pet>cat</pet>
+    <pet>dog</pet>
+  </user>
+)
+
+class User < Mapricot::Base
+  has_one   :id,    :integer
+  has_one   :name,  :string
+  has_many  :pets,  :string
+end
+
+user = User.new(:xml => simple_xml)
+puts user.id                # => 1
+puts user.id.class          # => Fixnum
+puts user.name              # => Bob
+puts user.pets.class        # => Array
+puts user.pets.join(", ")   # => cat, dog
+
+puts "-------------------"
+
+# A little more realistic
+xml = %(
+  <user>
+    <id>2</name>
+    <name>Sally</name>
+    <location code="ny123">
+      <city>New York</city>
+      <state>NY</state>
+    </location>
+    <hobby>
+      <description>Skiing</description>
+      <number_of_years>2</number_of_years>
+    </hobby>
+    <hobby>
+      <description>Hiking</description>
+      <number_of_years>3</number_of_years>
+    </hobby>
+  </user>
+)
+
+
+class User < Mapricot::Base
+  has_one   :id,        :integer
+  has_one   :name       # Tag type will default to :string
+  has_many  :pets
+  has_one   :location,  :xml
+  has_many  :hobbies,   :xml
+end
+
+class Location < Mapricot::Base
+  has_attribute :code
+  has_one       :city
+  has_one       :state
+end
+
+class Hobby < Mapricot::Base
+  has_one :description,     :string
+  has_one :number_of_years, :integer
+end
+
+user = User.new(:xml => xml)
+puts user.name            # => Sally
+puts user.pets.inspect    # => []
+puts user.location.class  # => Location
+puts user.location.city   # => New York
+puts user.location.state  # => NY
+puts user.location.code   # => ny123
+puts user.hobbies.class         # => Array
+puts user.hobbies.first.class   # => Hobby
+
+user.hobbies.each do |hobby|
+  puts "#{hobby.description} for #{hobby.number_of_years} years"
+end
+# => Skiing for 2 years
+# => Hiking for 3 years

data/lib/mapricot.rb

@@ -0,0 +1,174 @@
+require 'open-uri'
+begin
+  require 'hpricot'
+rescue LoadError
+  require 'rubygems'
+  require 'hpricot'
+end
+# singularize, constantize, camelize, classify; doc here: http://api.rubyonrails.com/classes/Inflector.html
+require 'active_support/inflector'
+
+module Mapricot
+
+  # Inherit from base, e.g. class Animal < Mapricot::Base
+  # Use either a string of xml or a url to initialize
+  class Base
+    class << self
+      # @associations is used to initialize instance variables
+      # creates a new HasOneAssociation and appends it to the @associations list
+      def has_one(name, type = :string, opts = {})
+        ass = HasOneAssociation.new(name, type, opts)
+        self.name.match(/::/) && ass.namespace = self.name.match(/(.*)::[^:]+$/)[1]
+        associations << ass
+        class_eval "attr_reader :#{name}", __FILE__, __LINE__
+      end
+      # creates a new HasManyAssociation and appends it to the @associations list
+      def has_many(name, type = :string, opts = {})
+        ass = HasManyAssociation.new(name, type, opts)
+        self.name.match(/::/) && ass.namespace = self.name.match(/(.*)::[^:]+$/)[1]
+        associations << ass
+        class_eval "attr_reader :#{name}", __FILE__, __LINE__
+      end
+      def has_attribute(name)
+        attributes << name
+        class_eval "attr_reader :#{name}", __FILE__, __LINE__
+      end
+      def associations
+        @associations ||= []
+      end
+      def attributes
+        @attributes ||= []
+      end
+    end
+
+    # class SomeClass < Mapricot::Base; end;
+    # SomeClass.new :url => "http://some_url"
+    # SomeClass.new :xml => %(<hi></hi>)
+    def initialize(opts)
+      @xml = Hpricot::XML(open(opts[:url])) if opts[:url]
+      @xml = Hpricot::XML(opts[:xml]) if opts[:xml]
+      load_associations   
+      load_attributes
+    end
+    
+    # searches xml for a tag with association.name, sets association.value to the inner html of this tag and typecasts it
+    def load_has_one(has_one_association)
+      has_one_association.search(@xml)
+    end
+    
+    def load_has_many(has_many_association)
+      has_many_association.search(@xml)
+    end
+  
+    def load_associations
+      # loop through the class's instance variable @attributes, which holds all of our associations
+      association_list = self.class.instance_variable_get(:@associations)
+      association_list && association_list.each do |ass|
+        load_has_one(ass) if ass.is_a?(HasOneAssociation)
+        load_has_many(ass) if ass.is_a?(HasManyAssociation)
+        # set instance variables and create accessors for each
+        instance_variable_set("@#{ass.name}", ass.value)  
+      end
+    end
+    
+    def load_attributes
+      attr_list = self.class.instance_variable_get(:@attributes)
+      attr_list && attr_list.each do |att|
+        val = (@xml/self.class.name.downcase.match(/[^:]+$/)[0]).first.attributes[att.to_s]
+        instance_variable_set("@#{att}", val)
+      end
+    end
+  end
+  
+  # Abstract class; used to subclass HasOneAssociation and HasManyAssociation
+  class Association
+    VALID_TYPES = [:integer, :time, :xml, :string]
+
+    attr_accessor :name, :type, :value
+    attr_accessor :namespace
+    def initialize(name, type, opts = {})
+      raise "Don't instantiate me" if abstract_class?
+      @name, @type, @opts = name, type, opts
+      @namespace = nil
+    end
+  
+    def typecast
+      raise "association type is invalid" unless VALID_TYPES.include?(@type)
+      if [:integer, :time].include?(@type)
+        @value = self.send("typecast_#{@type}")
+      end
+    end
+    
+    def typecast_integer
+      @value.is_a?(Array) ? @value.collect {|v| v.to_i} : @value.to_i
+    end
+    
+    def typecast_time
+      if @value.is_a?(Array)
+        @value.collect {|v| Time.parse(v) }
+      else
+        Time.parse(@value)
+      end
+    end
+    
+    private
+    def abstract_class?
+      self.class == Association
+    end
+    
+    def singular_name
+      @name.to_s
+    end
+    
+    def class_from_name
+      # ok, first we have to find how the class that inherited from Mapricot::Base is namespaced
+      # the class will an @associations class instance var, that will hold an instance of 
+      if @namespace
+        "#{@namespace}::#{singular_name.classify}".constantize
+      else
+        singular_name.classify.constantize
+      end
+    end
+  end
+  
+  
+  class HasOneAssociation < Association
+    # searches xml for tag name, sets the inner xml as association value and typecasts it
+    def search(xml)
+      # if tag_name option was passed, use it:
+      element = (xml/"#{ @opts[:tag_name] || @name }").first      # class Hpricot::Elements
+      if element
+        if @type == :xml
+          @value = class_from_name.new(:xml => element.to_s)    # we want to include the tag, not just the inner_html
+        else
+          @value = element.inner_html
+        end
+        self.typecast
+      end
+    end
+  end
+  
+  
+  class HasManyAssociation < Association
+
+    def singular_name
+      # @name.to_s[0..-2]
+      "#{@name}".singularize
+    end
+    
+    # searches xml for all occurrences of self.singular_name, the inner xml from each tag is stored in an array and set as the association value
+    # finally, each element in the array is typecast
+    def search(xml)
+      @value = []
+      (xml/"#{@opts[:tag_name] || self.singular_name}").each do |tag|
+        if @type == :xml
+          @value << class_from_name.new(:xml => tag.to_s)  # a bit of recursion if the inner xml is more xml
+        else
+          @value << tag.inner_html   # in the case of a string, integer, etc.
+        end
+      end
+    end
+    
+  end
+
+end

data/mapricot.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name     = "mapricot"
+  s.version  = "0.0.1"
+  s.date     = "2009-03-06"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.summary  = "XML to object mapper"
+  s.email    = "lzell11@gmail.com"
+  s.homepage = ""
+	s.description = "Makes working with XML stupid easy.  XML to object mapper with an interface similar to ActiveRecord associations."
+  s.has_rdoc = true
+  s.authors  = ["Lou Zell"]
+  s.files    = ["README.rdoc", 
+      "History.txt",
+      "License.txt",
+      "mapricot.gemspec",
+      "examples/lastfm_api.rb",
+      "examples/lastfm_api_no_request.rb",
+      "examples/natural_inputs.rb",
+      "examples/readme_examples.rb",
+      "test/mapricot_tests.rb",
+      "test/mapricot_spec.rb",
+      "lib/mapricot.rb"]
+  s.require_paths = ["lib"]
+  s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--title", "Mapricot"]
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.add_dependency("hpricot")
+end
+

data/test/mapricot_spec.rb

@@ -0,0 +1,118 @@
+require '../lib/mapricot'
+require 'spec'
+
+# Using a Facebook example:
+XML = %(
+<?xml version="1.0" encoding="UTF-8"?>
+  <users_getInfo_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" list="true">
+    <user>
+      <uid>8055</uid>
+      <about_me>This field perpetuates the glorification of the ego. Also, it has a character limit.</about_me>
+      <activities>Here: facebook, etc. There: Glee Club, a capella, teaching.</activities>
+      <affiliations list="true">
+        <affiliation>
+          <nid>50453093</nid>
+          <name>Facebook Developers</name>
+          <type>work</type>
+          <status/>
+          <year/>
+        </affiliation>
+      </affiliations>
+      <birthday>November 3</birthday>
+      <books>The Brothers K, GEB, Ken Wilber, Zen and the Art, Fitzgerald, The Emporer's New Mind, The Wonderful Story of Henry Sugar</books>
+      <current_location>
+        <city>Palo Alto</city>
+        <state>CA</state>
+        <country>United States</country>
+        <zip>94303</zip>
+      </current_location> 
+    </user>
+  </users_getInfo_reponse>
+)
+
+
+class UsersGetInfoResponse < Mapricot::Base
+  has_many :users,    :xml
+end
+
+class User < Mapricot::Base
+  has_one :uid,               :integer
+  has_one :about_me,          :string
+  has_one :activities,        :string
+  has_one :affiliation_list,  :xml,     :tag_name => "affiliations"   # this is cumbersome, do something about this
+  has_one :birthday,          :string
+  has_one :current_location,  :xml
+end
+
+class AffiliationList < Mapricot::Base
+  has_many :affiliations,     :xml
+end
+
+class Affiliation < Mapricot::Base
+  has_one :nid,     :integer
+  has_one :name,    :string
+  has_one :type,    :string
+  has_one :status,  :string
+  has_one :year,    :integer
+end
+
+class CurrentLocation < Mapricot::Base
+  has_one :city,    :string
+  has_one :state,   :string
+  has_one :country, :string
+  has_one :zip,     :integer
+end
+
+
+describe UsersGetInfoResponse do 
+  before(:all) { @response = UsersGetInfoResponse.new(:xml => XML) }
+  
+  it "should respond to users" do 
+    @response.should respond_to(:users)
+  end
+  
+  it "should return an array of size 1 when sent users" do 
+    @response.users.class.should equal(Array)
+    @response.users.size.should equal(1)
+  end
+end
+
+describe "response.users.first" do 
+  before(:all) do 
+    response = UsersGetInfoResponse.new(:xml => XML)
+    @first_user = response.users.first
+  end
+  
+  it "should be of class User" do
+    @first_user.class.should equal(User)
+  end
+  
+  it "should respond to activities" do 
+    @first_user.should respond_to(:activities)
+    @first_user.activities.should == "Here: facebook, etc. There: Glee Club, a capella, teaching."
+  end
+  
+  it "should respond to current_location" do 
+    @first_user.should respond_to(:current_location)
+  end
+end
+
+
+describe "response.users.first.current_location" do 
+  before(:all) do 
+    response = UsersGetInfoResponse.new(:xml => XML)
+    @current_location = response.users.first.current_location
+  end
+  
+  it "should have class CurrentLocation" do 
+    @current_location.class.should equal(CurrentLocation)
+  end
+
+  it "should respond to city, state, country, and zip" do 
+    @current_location.city.should == 'Palo Alto'
+    @current_location.state.should == 'CA'
+    @current_location.country.should == 'United States'
+    @current_location.zip.should == 94303
+  end
+end
+

data/test/mapricot_tests.rb

@@ -0,0 +1,109 @@
+require '../lib/mapricot'
+require 'test/unit'
+
+
+# -------------------------- Test Example 1 of README.txt ------------------ #
+SIMPLE_USER_XML = %(
+  <user>
+    <id>1</name>
+    <name>Bob</name>
+    <pet>cat</pet>
+    <pet>dog</pet>
+  </user>
+)
+
+class SimpleUser < Mapricot::Base
+  has_one   :id,    :integer
+  has_one   :name,  :string
+  has_many  :pets,  :string
+end
+
+
+class TestSimpleUser < Test::Unit::TestCase
+  def setup
+    @simple_user = SimpleUser.new(:xml => SIMPLE_USER_XML)
+  end
+  
+  def test_everything
+    assert_equal @simple_user.id,   1
+    assert_equal @simple_user.name, "Bob"
+    assert_equal @simple_user.pets, ["cat", "dog"]
+  end
+end
+# -------------------------------------------------------------------------- #
+
+
+
+
+
+# -------------------------- Test Example 2 of README.txt ------------------ #
+USER_XML = %(
+  <user>
+    <id>2</name>
+    <name>Sally</name>
+    <location code="ny123">
+      <city>New York</city>
+      <state>NY</state>
+    </location>
+    <hobby>
+      <description>Skiing</description>
+      <number_of_years>2</number_of_years>
+    </hobby>
+    <hobby>
+      <description>Hiking</description>
+      <number_of_years>3</number_of_years>
+    </hobby>
+  </user>
+)
+
+
+class User < Mapricot::Base
+  has_one   :id,        :integer
+  has_one   :name       # Tag type will default to :string
+  has_many  :pets
+  has_one   :location,  :xml
+  has_many  :hobbies,   :xml
+end
+
+class Location < Mapricot::Base
+  has_attribute :code
+  has_one       :city
+  has_one       :state
+end
+
+class Hobby < Mapricot::Base
+  has_one :description,     :string
+  has_one :number_of_years, :integer
+end
+
+class TestUser < Test::Unit::TestCase
+  def setup
+    @user = User.new(:xml => USER_XML)
+  end
+  
+  def test_id_and_name
+    assert_equal @user.id,    2
+    assert_equal @user.name,  "Sally"
+  end
+  
+  def test_location
+    assert        @user.location.is_a?(Location)
+    assert_equal  @user.location.city,   "New York"
+    assert_equal  @user.location.state,  "NY"
+    assert_equal  @user.location.code,   "ny123"
+  end
+  
+  def test_hobbies
+    assert        @user.hobbies.is_a?(Array)
+    assert_equal  @user.hobbies.size,                2
+    assert_equal  @user.hobbies[0].description,      "Skiing"
+    assert_equal  @user.hobbies[0].number_of_years,  2
+    assert_equal  @user.hobbies[1].description,      "Hiking"
+    assert_equal  @user.hobbies[1].number_of_years,  3
+  end
+  
+  def test_pets
+    assert(@user.pets.empty?) # Sally has no pets
+  end
+end  
+# -------------------------------------------------------------------------- #

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: lzell-mapricot
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lou Zell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Makes working with XML stupid easy.  XML to object mapper with an interface similar to ActiveRecord associations.
+email: lzell11@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- History.txt
+- License.txt
+- mapricot.gemspec
+- examples/lastfm_api.rb
+- examples/lastfm_api_no_request.rb
+- examples/natural_inputs.rb
+- examples/readme_examples.rb
+- test/mapricot_tests.rb
+- test/mapricot_spec.rb
+- lib/mapricot.rb
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --title
+- Mapricot
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: XML to object mapper
+test_files: []
+