lzell-mapricot 0.0.1 → 0.0.2.1

data/History.txt

@@ -1,3 +1,15 @@
 == 0.0.1 2009-03-06
 
-First gem!
+First gem!
+
+== 0.0.2 2009-03-17
+
+Nokogiri and Libxml support.
+
+Select the parser to use by setting Mapricot.parser as follows:
+
+Mapricot.parser = :nokogiri
+Mapricot.parser = :libxml
+Mapricot.parser = :hpricot
+
+Hpricot will be used by default

data/README.rdoc

@@ -5,7 +5,7 @@ Makes working with XML stupid easy.  XML to object mapper with an interface simi
 
 == Install
 
-Do some stuff...
+sudo gem install lzell-mapricot
 
 == Usage
 
@@ -20,16 +20,15 @@ When you instantiate a Mapricot::Base object, you can pass it a string of xml:
   
   MapMe.new :xml => "<some_stuff>...</some_stuff>"
 
-Or you can pass it a url:
-  class MapMeToo < Mapricot::Base
-  end
+Or a url:
   
-  MapMeToo.new :url => "http://some_url"
+  MapMe.new :url => "http://some_url"
 
 == Examples
 
 ==== Super Simple
-
+  require 'mapricot'
+  
   simple_xml = %(
     <user>
       <id>1</name>
@@ -54,7 +53,8 @@ Or you can pass it a url:
 
 
 ==== A little more realistic
-
+  require 'mapricot'
+  
   xml = %(
     <user>
       <id>2</name>
@@ -110,9 +110,10 @@ Or you can pass it a url:
   # => Skiing for 2 years
   # => Hiking for 3 years
   
+  
 == Credits
 
-All to why the luck stiff for Hpricot.
+Named after why the luck stiff's Hpricot, which made this possible.
 
 
 Copyright (c) 2009 Lou Zell, released under the MIT license

data/benchmark/benchmarks.rb

@@ -0,0 +1,127 @@
+require File.expand_path(File.dirname(__FILE__) + "/../lib/mapricot")
+require 'benchmark'
+
+last_fm_example = %(<?xml version="1.0" encoding="utf-8"?>
+<events>
+<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>
+              <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>
+              <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>
+
+)
+
+
+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)
+
+
+n = 200
+Benchmark.bm do |x|
+  x.report {
+    Mapricot.parser = :hpricot;
+    n.times { lfm = Response.new(:xml => last_fm_example) }
+  }
+  x.report {
+    Mapricot.parser = :libxml; 
+    n.times { lfm = Response.new(:xml => last_fm_example) }
+  }
+  x.report {
+    Mapricot.parser = :nokogiri; 
+    n.times { lfm = Response.new(:xml => last_fm_example) }
+  }
+  
+end

data/{test/mapricot_spec.rb → examples/facebook_api.rb}

@@ -1,10 +1,13 @@
-require '../lib/mapricot'
-require 'spec'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/mapricot")
 
-# 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">
+# Using a Facebook example
+# This xml is taken straight from here: http://wiki.developers.facebook.com/index.php/Users.getInfo
+# Note, libxml does not like this for some reason:
+# <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">
+# So 'xmlns="http://api.facebook.com/1.0/"' has been stripped from tag
+# Because of this, for real requests we will have to use hpricot or nokogiri
+FACEBOOK_XML = %(<?xml version="1.0" encoding="UTF-8"?>
+  <users_getInfo_response 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>
@@ -27,7 +30,7 @@ XML = %(
         <zip>94303</zip>
       </current_location> 
     </user>
-  </users_getInfo_reponse>
+  </users_getInfo_response>
 )
 
 
@@ -64,55 +67,19 @@ class CurrentLocation < Mapricot::Base
 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
+response = UsersGetInfoResponse.new(:xml => FACEBOOK_XML)
+puts response.users.class # => Array
+puts response.users.size # => 1
 
+user = response.users.first
 
-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
+puts user.uid # => 8055
+puts user.activities # => "Here: facebook, etc. There: Glee Club, a capella, teaching."
+puts user.current_location.city # => "Palo Alto"
+puts user.current_location.state # => "CA"
+puts user.current_location.country # => "United States"
+puts user.current_location.zip  # => 94303
 
+# need to remove redundancy here:
+puts user.affiliation_list.affiliations.first.name   # => "Facebook Developers"
+puts user.affiliation_list.affiliations.first.nid   # => 50453093  

data/examples/lastfm_api.rb

@@ -8,7 +8,7 @@
 # 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'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/mapricot")
 
 class Response < Mapricot::Base
   has_many :events,   :xml

data/examples/lastfm_api_no_request.rb

@@ -1,4 +1,4 @@
-require '../lib/mapricot'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/mapricot")
 
 
 last_fm_example = %(

data/examples/readme_examples.rb

@@ -1,4 +1,4 @@
-require '../lib/mapricot'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/mapricot")
 
 # super simple
 simple_xml = %(

data/examples/xml_with_attributes.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + "/../lib/mapricot")
+
+
+xml = %(
+<response>
+  <user id="32" name="Bob"></user>
+  <user id="33" name="Sally"></user>
+</response>
+)
+
+
+class Response < Mapricot::Base
+  has_many :users, :xml
+end
+
+class User < Mapricot::Base
+  has_attribute :id
+  has_attribute :name
+end
+
+response = Response.new(:xml => xml)
+
+response.users.each do |user|
+  puts user.name
+  puts user.id
+end

data/lib/abstract_doc.rb

@@ -0,0 +1,121 @@
+require 'open-uri'
+require 'rubygems'
+# gem 'hpricot', '=0.6.164'
+require 'hpricot'
+require 'libxml'
+require 'nokogiri'
+
+
+module Mapricot
+  @parser = :hpricot
+  class << self; attr_accessor :parser; end
+  
+  # AbstractDoc should be able to find tags, get inner tag content. Find all tags (return an array)
+  # I think I will also need AbstractNode
+
+  class AbstractDoc
+
+    def self.from_url(url)
+      adoc = new
+      adoc.url = url
+      adoc
+    end
+
+    def self.from_string(string)
+      adoc = new
+      adoc.string = string
+      adoc
+    end
+
+    def url=(url)
+      if Mapricot.parser == :libxml
+        @udoc = LibXML::XML::Parser.file(url).parse
+      elsif Mapricot.parser == :hpricot
+        @udoc = Hpricot::XML(open(url))
+      elsif Mapricot.paser == :nokogiri
+        @udoc = Nokogiri::HTML(open(url))
+      end
+    end
+
+    def string=(string)
+      if Mapricot.parser == :libxml
+        @udoc = LibXML::XML::Parser.string(string).parse
+      elsif Mapricot.parser == :hpricot
+        @udoc = Hpricot::XML(string)
+      elsif Mapricot.parser == :nokogiri
+        @udoc = Nokogiri::XML(string)
+      end
+    end
+
+
+    def find(tagname)
+      if Mapricot.parser == :libxml
+        AbstractNodeList.new(@udoc.find("//#{tagname}"))  # hmm...
+      elsif Mapricot.parser == :hpricot
+        # AbstractNodeList.new(@udoc/tagname)
+        AbstractNodeList.new(@udoc/"//#{tagname}")
+      elsif Mapricot.parser == :nokogiri
+        AbstractNodeList.new(@udoc.search(tagname))
+        # AbstractNodeList.new(@udoc.xpath("//#{tagname}"))
+      end
+    end
+    
+  end
+  
+  
+  
+  class AbstractNodeList
+    include Enumerable
+    
+    def initialize(node_list)
+      @unode_list = node_list
+    end
+
+    def each(&block)
+      @unode_list.each {|unode| yield(AbstractNode.new(unode))}
+    end
+
+    def [](i)
+      @unode_list[i]
+    end
+    
+    def first
+      AbstractNode.new(@unode_list.first)
+    end
+    
+    def empty?
+      @unode_list.empty?
+    end
+  end
+  
+
+  class AbstractNode
+    attr_reader :unode
+
+    def initialize(unode) 
+      @unode = unode        # unresolved node
+    end
+    
+    def to_s
+      @unode.to_s
+    end
+    
+    def attributes
+      if Mapricot.parser != :nokogiri
+        @unode.attributes
+      else
+        atts = {}
+        @unode.attributes.each {|k,v| atts[k] = v.value}
+        atts
+      end
+    end
+    
+    def contents
+      if Mapricot.parser == :libxml || Mapricot.parser == :nokogiri
+        @unode.content
+      else
+        @unode.inner_html
+      end
+    end
+  end
+end