ROXML 3.0.0

data/spec/examples/active_record_spec.rb

@@ -0,0 +1,40 @@
+require 'spec/spec_helper'
+require 'examples/rails'
+
+describe ROXML, "under ActiveRecord" do
+  before do
+    @route = Route.from_xml(xml_for('active_record'))
+  end
+
+  before(:all) do
+    FileUtils.rm(DB_PATH) if File.exists?(DB_PATH)
+  end
+
+  it "should be parsed" do
+    @route.should_not == nil
+    @route.should be_an_instance_of(Route)
+  end
+
+  describe "xml attributes" do
+    it "should extract xml attributes" do
+      @route.totalHg.should == "640"
+      @route.lonlatx.should == "357865"
+      @route.lonlaty.should == "271635"
+      @route.grcenter.should == "SH 71635 57865"
+      @route.totalMins.should == "235.75000000000003"
+      @route.totalDist.should == "11185.321521477119"
+    end
+  end
+
+  describe "xml sub-objects" do
+    it "should extract xml sub-objects" do
+      @route.should have(6).waypoints
+      @route.waypoints.each {|waypoint| waypoint.should be_an_instance_of(Waypoint)}
+    end
+    it "should be usable as a ActiveRecord object" do
+      Waypoint.count.should == 0
+      @route.save!
+      Waypoint.count.should == 6
+    end
+  end
+end

data/spec/examples/amazon_spec.rb

@@ -0,0 +1,54 @@
+require 'spec/spec_helper'
+require 'examples/amazon'
+
+describe PITA::ItemSearchResponse do
+  before do
+    @response = PITA::ItemSearchResponse.from_xml(xml_for('amazon'))
+  end
+
+  describe "#total_results" do
+    it "should be parsed as a number" do
+      @response.total_results.should > 0
+    end
+  end
+
+  describe "#total_pages" do
+    it "should be parsed as a number" do
+      @response.total_pages.should > 0
+    end
+  end
+
+  describe "#items" do
+    it "should return a collection of items" do
+      @response.items.should be_an_instance_of(Array)
+      @response.items.size.should > 0
+      @response.items.each {|item| item.should be_an_instance_of(PITA::Item) }
+    end
+
+    it "should have the some number less than or equal to #total_results" do
+      @response.items.size.should > 0
+      @response.items.size.should <= @response.total_results
+    end
+  end
+end
+
+describe PITA::Item do
+  before do
+    @items = PITA::ItemSearchResponse.from_xml(xml_for('amazon')).items
+  end
+
+  it "should extract asin" do
+    @items.each {|item| item.asin.should be_an_instance_of(String) }
+    @items.each {|item| item.asin.should_not be_empty }
+  end
+
+  it "should extract detail_page_url" do
+    @items.each {|item| item.detail_page_url.should be_an_instance_of(String) }
+    @items.each {|item| item.detail_page_url.should_not be_empty }
+  end
+
+  it "should extract manufacturer" do
+    @items.each {|item| item.manufacturer.should be_an_instance_of(String) }
+    @items.each {|item| item.manufacturer.should_not be_empty }
+  end
+end

data/spec/examples/current_weather_spec.rb

@@ -0,0 +1,37 @@
+require 'spec/spec_helper'
+require 'examples/current_weather'
+
+describe Weather do
+  before do
+    @weather = Weather.from_xml(xml_for('current_weather'))
+  end
+
+  it "should extract observations" do
+    @weather.observation.should be_an_instance_of(WeatherObservation)
+  end
+end
+
+describe WeatherObservation do
+  before do
+    @observation = Weather.from_xml(xml_for('current_weather')).observation
+  end
+
+  it "should extract temperature" do
+    @observation.temperature.should > 0
+  end
+
+  it "should extract feels_like" do
+    @observation.feels_like.should > 0
+  end
+
+  describe "#current_condition" do
+    it "should extract current_condition" do
+      @observation.current_condition.should_not be_empty
+    end
+
+    it "should extract icon attribute" do
+      pending "need to think options through for HappyMapper-style :attributes extensions"
+      @observation.current_condition.icon.should_not be_empty
+    end
+  end
+end

data/spec/examples/dashed_elements_spec.rb

@@ -0,0 +1,20 @@
+require 'spec/spec_helper'
+require 'examples/dashed_elements'
+
+describe GitHub::Commit do
+  before do
+    @commit = GitHub::Commit.from_xml(xml_for('dashed_elements'))
+  end
+
+  it "should extract committed date" do
+    @commit.committed_date.should be_an_instance_of(Date)
+  end
+
+  it "should extract url" do
+    @commit.url.should_not be_empty
+  end
+
+  it "should extract id" do
+    @commit.id.should_not be_empty
+  end
+end

data/spec/examples/library_spec.rb

@@ -0,0 +1,46 @@
+require 'spec/spec_helper'
+require 'examples/library'
+
+describe Library do
+  before :all do
+    book = Novel.new
+    book.isbn = "0201710897"
+    book.title = "The PickAxe"
+    book.description = "Best Ruby book out there!"
+    book.author = "David Thomas, Andrew Hunt, Dave Thomas"
+    book.publisher = Publisher.new('Addison Wesley Longman, Inc.')
+
+    @lib = Library.new
+    @lib.name = "Favorite Books"
+    @lib.novels = [book]
+  end
+
+  describe "#to_xml" do
+    it "should contain the expected information" do
+      @lib.to_xml.to_s.should == ROXML::XML::Parser.parse(%{<library><NAME><![CDATA[Favorite Books]]></NAME><novel ISBN='0201710897'><title>The PickAxe</title><description><![CDATA[Best Ruby book out there!]]></description><author>David Thomas, Andrew Hunt, Dave Thomas</author><publisher><name>Addison Wesley Longman, Inc.</name></publisher></novel></library>}).root.to_s
+    end
+
+    context "when written to a file" do
+      before :all do
+        @path = "spec/examples/library.xml"
+        @doc = ROXML::XML::Document.new
+        @doc.root = @lib.to_xml
+        @doc.save(@path)
+      end
+
+     after :all do
+       FileUtils.rm @path
+     end
+
+     it "should be contain the expected xml" do
+        ROXML::XML::Parser.parse(File.read(@path)).to_s.should == ROXML::XML::Parser.parse(%{<?xml version="1.0"?><library><NAME><![CDATA[Favorite Books]]></NAME><novel ISBN='0201710897'><title>The PickAxe</title><description><![CDATA[Best Ruby book out there!]]></description><author>David Thomas, Andrew Hunt, Dave Thomas</author><publisher><name>Addison Wesley Longman, Inc.</name></publisher></novel></library>}).to_s
+      end
+
+      it "should be re-parsable via .from_xml" do
+        File.open("spec/examples/library.xml") do |file|
+          Library.from_xml(file).should == @lib
+        end
+      end
+    end
+  end
+end

data/spec/examples/post_spec.rb

@@ -0,0 +1,24 @@
+require 'spec/spec_helper'
+require 'examples/posts'
+
+describe Post do
+  before do
+    @posts = Posts.from_xml(xml_for('posts')).posts
+  end
+
+  it "should extract description" do
+    @posts.each {|post| post.description.should_not be_empty }
+  end
+
+  it "should extract href" do
+    @posts.each {|post| post.href.should_not be_empty }
+  end
+
+  it "should extract extended" do
+    @posts.each {|post| post.extended.should_not be_empty }
+  end
+
+  it "should extract time" do
+    @posts.each {|post| post.created_at.should be_an_instance_of(DateTime) }
+  end
+end

data/spec/examples/twitter_spec.rb

@@ -0,0 +1,32 @@
+require 'spec/spec_helper'
+require 'examples/twitter'
+
+describe Statuses do
+  describe Status do
+    before do
+      @statuses = Statuses.from_xml(xml_for('twitter')).statuses
+    end
+
+    it "should extract text" do
+      @statuses.each {|status| status.text.should_not be_empty }
+    end
+
+    it "should extract source" do
+      @statuses.each {|status| status.source.should_not be_empty }
+    end
+
+    describe User do
+      before do
+        @users = @statuses.map(&:user)
+      end
+
+      it "should extract name" do
+        @users.each {|user| user.name.should == "John Nunemaker" }
+      end
+
+      it "should extract screen_name" do
+        @users.each {|user| user.screen_name.should == "jnunemaker" }
+      end
+    end
+  end
+end

data/spec/roxml_spec.rb

@@ -0,0 +1,372 @@
+require 'spec/spec_helper'
+
+describe ROXML, "#from_xml" do
+  describe "from_xml call", :shared => true do
+    it "should fetch values" do
+      book = BookWithContributors.from_xml(@path)
+      book.title.should == "Programming Ruby - 2nd Edition"
+      book.contributors.map(&:name).should == ["David Thomas","Andrew Hunt","Chad Fowler"]
+    end
+  end
+
+  context "called with PathName" do
+    before do
+      @path = Pathname.new(fixture_path(:book_with_contributors))
+    end
+    it_should_behave_like "from_xml call"
+  end
+
+  context "called with File" do
+    before do
+      @path = File.new(fixture_path(:book_with_contributors))
+    end
+    it_should_behave_like "from_xml call"
+  end
+
+  context "called with URI" do
+    before do
+      require 'uri'
+      @path = URI.parse("file://#{File.expand_path(File.expand_path(fixture_path(:book_with_contributors)))}")
+    end
+    it_should_behave_like "from_xml call"
+  end
+end
+
+describe ROXML, "#xml" do
+  class DescriptionReadonly
+    include ROXML
+
+    xml_reader :writable, :from => :content
+    xml_reader :readonly, :from => :content, :frozen => true
+  end
+
+  class Contributor
+    include ROXML
+
+    xml_reader :role, :from => :attr
+    xml_reader :name
+  end
+
+  class BookWithContributions
+    include ROXML
+
+    xml_name :book
+    xml_reader :isbn, :from => :attr
+    xml_reader :title
+    xml_reader :description, :as => DescriptionReadonly
+    xml_reader :contributions, :as => [Contributor], :from => 'contributor', :in => "contributions"
+  end
+
+  class BookWithContributionsReadonly
+    include ROXML
+
+    xml_name :book
+    xml_reader :isbn, :from => :attr, :frozen => true
+    xml_reader :title, :frozen => true
+    xml_reader :description, :as => DescriptionReadonly, :frozen => true
+    xml_reader :contributions, :as => [Contributor], :from => 'contributor', :in => "contributions", :frozen => true
+  end
+
+  before do
+    @writable = BookWithContributions.from_xml(fixture(:book_with_contributions))
+    @readonly = BookWithContributionsReadonly.from_xml(fixture(:book_with_contributions))
+  end
+
+  it "should raise on duplicate accessor name" do
+    proc do
+      Class.new do
+        include ROXML
+
+        xml_reader :id
+        xml_accessor :id
+      end
+    end.should raise_error(RuntimeError)
+  end
+
+  class OctalInteger
+    def self.from_xml(val)
+      new(Integer(val.content))
+    end
+
+    def initialize(value)
+      @val = value
+    end
+
+    def ==(other)
+      @val == other
+    end
+
+    def to_xml
+      sprintf("%#o", @val)
+    end
+  end
+
+  describe "overriding output" do
+    class BookWithOctalPages
+      include ROXML
+
+      xml_accessor :pages_with_as, :as => Integer, :to_xml => proc {|val| sprintf("%#o", val) }, :required => true
+      xml_accessor :pages_with_type, :as => OctalInteger, :required => true
+    end
+
+    #      to_xml_test :book_with_octal_pages
+
+    describe "with :to_xml option" do
+      it "should output with to_xml filtering"
+    end
+
+    describe "with #to_xml on the object" do
+      it "should output with to_xml filtering"
+    end
+  end
+
+  describe "overriding input" do
+    before do
+      @book_with_octal_pages_xml = %{
+        <book>
+          <pages>0357</pages>
+        </book>
+      }
+
+      @expected_pages = 239
+    end
+
+    describe "with :as block shorthand" do
+      class BookWithOctalPagesBlockShorthand
+        include ROXML
+
+        xml_accessor :pages, :as => Integer, :required => true
+      end
+
+      it "should apply filtering on input" do
+        book = BookWithOctalPagesBlockShorthand.from_xml(@book_with_octal_pages_xml)
+        book.pages.should == @expected_pages
+      end
+    end
+
+    describe "with #from_xml defined on the object" do
+      class BookWithOctalPagesType
+        include ROXML
+
+        xml_accessor :pages, :as => OctalInteger, :required => true
+      end
+
+      it "should apply filtering on input" do
+        book = BookWithOctalPagesType.from_xml(@book_with_octal_pages_xml)
+        book.pages.should == @expected_pages
+      end
+    end
+  end
+
+  describe "attribute reference" do
+    before do
+      @frozen = @readonly.isbn
+      @unfrozen = @writable.isbn
+    end
+
+    it_should_behave_like "freezable xml reference"
+  end
+
+  describe "text reference" do
+    before do
+      @frozen = @readonly.title
+      @unfrozen = @writable.title
+    end
+
+    it_should_behave_like "freezable xml reference"
+  end
+
+  describe "object reference" do
+    before do
+      @frozen = @readonly.description
+      @unfrozen = @writable.description
+    end
+
+    it_should_behave_like "freezable xml reference"
+
+    describe "indirect reference via an object" do
+      it "does not inherit the frozen status from its parent" do
+        @frozen.writable.frozen?.should be_false
+        @frozen.readonly.frozen?.should be_true
+
+        @unfrozen.writable.frozen?.should be_false
+        @unfrozen.readonly.frozen?.should be_true
+      end
+    end
+  end
+
+  describe "array reference" do
+    before do
+      @frozen = @readonly.contributions
+      @unfrozen = @writable.contributions
+    end
+
+    it_should_behave_like "freezable xml reference"
+
+    it "should apply :frozen to the constituent elements" do
+      @frozen.all?(&:frozen?).should be_true
+      @unfrozen.any?(&:frozen?).should be_false
+    end
+
+    context "no elements are present in root, no :in is specified" do
+      class BookWithContributors
+        include ROXML
+
+        xml_name :book
+        xml_reader :isbn, :from => :attr
+        xml_reader :title
+        xml_reader :description
+        xml_reader :contributors, :as => [Contributor]
+      end
+
+      it "should look for elements :in the plural of name" do
+        book = BookWithContributors.from_xml(%{
+          <book isbn="0974514055">
+            <contributors>
+              <contributor role="author"><name>David Thomas</name></contributor>
+              <contributor role="supporting author"><name>Andrew Hunt</name></contributor>
+              <contributor role="supporting author"><name>Chad Fowler</name></contributor>
+            </contributors>
+          </book>
+        })
+        book.contributors.map(&:name).sort.should == ["David Thomas","Andrew Hunt","Chad Fowler"].sort
+      end
+    end
+  end
+
+  describe "hash reference" do
+    class DictionaryOfGuardedNames
+      include ROXML
+
+      xml_name :dictionary
+      xml_reader :definitions, :as => {:key => :name,
+                                :value => :content}, :in => :definitions
+    end
+
+    class DictionaryOfGuardedNamesReadonly
+      include ROXML
+
+      xml_name :dictionary
+      xml_reader :definitions, :as => {:key => :name,
+                                :value => :content}, :in => :definitions, :frozen => true
+    end
+
+    before do
+      @frozen = DictionaryOfGuardedNamesReadonly.from_xml(fixture(:dictionary_of_guarded_names)).definitions
+      @unfrozen = DictionaryOfGuardedNames.from_xml(fixture(:dictionary_of_guarded_names)).definitions
+    end
+
+    it_should_behave_like "freezable xml reference"
+
+    it "should have frozen keys, as with all hashes" do
+      @frozen.keys.all?(&:frozen?).should be_true
+      @unfrozen.keys.all?(&:frozen?).should be_true
+    end
+
+    it "should apply :frozen to the constituent values" do
+      @frozen.values.all?(&:frozen?).should be_true
+      @unfrozen.values.any?(&:frozen?).should be_false
+    end
+  end
+end
+
+describe ROXML, "inheritance" do
+  class Book
+    include ROXML
+
+    xml_accessor :isbn, :from => '@ISBN'
+    xml_reader :title
+    xml_reader :description, :cdata => true
+    xml_reader :author
+    xml_accessor :pages, :from => 'pagecount', :as => Integer
+  end
+
+  class Measurement
+    include ROXML
+
+    xml_reader :units, :from => :attr
+    xml_reader :value, :from => :content, :as => Float
+
+    def initialize(value = 0, units = 'pixels')
+      @value = Float(value)
+      @units = units.to_s
+      normalize_hundredths
+    end
+
+    def to_s
+      "#{value} #{units}"
+    end
+
+    def ==(other)
+      other.units == @units && other.value == @value
+    end
+
+  private
+    def after_parse
+      normalize_hundredths
+    end
+
+    def normalize_hundredths
+      if @units.starts_with? 'hundredths-'
+        @value /= 100
+        @units = @units.split('hundredths-')[1]
+      end
+    end
+  end
+
+  class InheritedBookWithDepth < Book
+    xml_reader :depth, :as => Measurement
+  end
+
+  before do
+    @book_xml =  %{
+      <book ISBN="0201710897">
+        <title>The PickAxe</title>
+        <description><![CDATA[Probably the best Ruby book out there]]></description>
+        <author>David Thomas, Andrew Hunt, Dave Thomas</author>
+        <depth units="hundredths-meters">1130</depth>
+        <publisher>Pragmattic Programmers</publisher>
+      </book>
+    }
+
+    @parent = Book.from_xml(@book_xml)
+    @child = InheritedBookWithDepth.from_xml(@book_xml)
+  end
+
+  describe "parent" do
+    it "should include its attributes" do
+      @child.isbn.should == "0201710897"
+      @child.title.should == "The PickAxe"
+      @child.description.should == "Probably the best Ruby book out there"
+      @child.author.should == 'David Thomas, Andrew Hunt, Dave Thomas'
+      @child.pages.should == nil
+    end
+    
+    it "should not include its child's attributes" do
+      @parent.should_not respond_to(:depth)
+    end
+  end
+  
+  describe "child" do
+    it "should include its parent's attributes" do
+      @child.isbn.should == @parent.isbn
+      @child.title.should == @parent.title
+      @child.description.should == @parent.description
+      @child.author.should == @parent.author
+      @child.pages.should == @parent.pages
+    end
+
+    it "should include its attributes" do
+      @child.depth.to_s.should == '11.3 meters'
+    end
+
+    it "should include parent's attributes added after declaration" do
+      Book.class_eval do
+        xml_reader :publisher, :required => true
+      end
+
+      book = InheritedBookWithDepth.from_xml(@book_xml)
+      book.publisher.should == "Pragmattic Programmers"
+    end
+  end
+end