roxml 2.4.1 → 2.4.2

data/spec/examples/dashed_elements_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require example('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/post_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require example('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.time.should be_an_instance_of(DateTime) }
+  end
+end

data/spec/examples/twitter_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require example('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/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'pathname'
+
+module ROXML
+  SILENCE_XML_NAME_WARNING = true
+end
+
+DIR = Pathname.new(__FILE__).dirname
+require DIR.join('../lib/roxml').expand_path
+
+def example(name)
+  DIR.join("../examples/#{name}.rb").expand_path
+end
+
+def xml_for(name)
+  DIR.join("../examples/xml/#{name}.xml").expand_path
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/test/unit/definition_test.rb

@@ -0,0 +1,160 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class TestDefinition < Test::Unit::TestCase
+  def assert_hash(opts, kvp)
+    assert opts.hash?
+    assert !opts.array?
+    assert_equal kvp, {opts.hash.key.type => opts.hash.key.name,
+                       opts.hash.value.type => opts.hash.value.name}
+  end
+
+  def test_text_in_array_means_as_array_for_text
+    opts = ROXML::Definition.new(:authors, [:text])
+    assert opts.array?
+    assert_equal :text, opts.type
+  end
+
+  def test_attr_in_array_means_as_array_for_attr
+    opts = ROXML::Definition.new(:authors, [:attr])
+    assert opts.array?
+    assert_equal :attr, opts.type
+  end
+
+  def test_object_in_array_means_as_array_for_object
+    opts = ROXML::Definition.new(:authors, [Hash])
+    assert opts.array?
+    assert_equal Hash, opts.type
+  end
+
+  def test_content_is_a_recognized_type
+    assert ROXML::Definition.new(:author, :content).content?
+  end
+
+  def test_required
+    assert !ROXML::Definition.new(:author, :content).required?
+    assert ROXML::Definition.new(:author, :content, :required => true).required?
+    assert !ROXML::Definition.new(:author, :content, :required => false).required?
+  end
+
+  def test_required_conflicts_with_else
+    assert_raise ArgumentError do
+      ROXML::Definition.new(:author, :content, :required => true, :else => 'Johnny')
+    end
+    assert_nothing_raised do
+      ROXML::Definition.new(:author, :content, :required => false, :else => 'Johnny')
+    end
+  end
+
+  def test_hash_of_attrs
+    opts = ROXML::Definition.new(:attributes, {:attrs => [:name, :value]})
+    assert_hash(opts, :attr => 'name', :attr => 'value')
+  end
+
+  def test_hash_with_attr_key_and_text_val
+    opts = ROXML::Definition.new(:attributes, {:key => {:attr => :name},
+                                         :value => :value})
+    assert_hash(opts, :attr => 'name', :text => 'value')
+  end
+
+  def test_hash_with_string_class_for_type
+    opts = ROXML::Definition.new(:attributes, {:key => {String => 'name'},
+                                         :value => {String => 'value'}})
+    assert_hash(opts, :text => 'name', :text => 'value')
+  end
+
+  def test_hash_with_attr_key_and_content_val
+    opts = ROXML::Definition.new(:attributes, {:key => {:attr => :name},
+                                         :value => :content})
+    assert_hash(opts, :attr => 'name', :content => '')
+  end
+
+  def test_hash_with_options
+    opts = ROXML::Definition.new(:definitions, {:attrs => [:dt, :dd]},
+                           :in => :definitions)
+    assert_hash(opts, :attr => 'dt', :attr => 'dd')
+  end
+
+  def test_no_block_shorthand_means_no_block
+    assert ROXML::Definition.new(:count).blocks.empty?
+    assert ROXML::Definition.new(:count, :as => :intager).blocks.empty?
+    assert ROXML::Definition.new(:count, :as => :foat).blocks.empty?
+  end
+
+  def test_block_integer_shorthand
+    assert_equal 3, ROXML::Definition.new(:count, :as => Integer).blocks.first['3']
+  end
+
+  def test_block_float_shorthand
+    assert_equal 3.1, ROXML::Definition.new(:count, :as => Float).blocks.first['3.1']
+  end
+
+  def test_multiple_shorthands_raises
+    assert_raise ArgumentError do
+      ROXML::Definition.new(:count, :as => [Float, Integer])
+    end
+  end
+
+  def test_stacked_blocks
+    assert_equal 2, ROXML::Definition.new(:count, :as => Integer) {|val| val.to_i }.blocks.size
+    assert_equal 2, ROXML::Definition.new(:count, :as => Float) {|val| val.object_id }.blocks.size
+  end
+
+  def test_symbol_shorthands_are_deprecated
+    assert_deprecated do
+      ROXML::Definition.new(:junk, :as => :integer)
+    end
+    assert_deprecated do
+      ROXML::Definition.new(:junk, :as => :float)
+    end
+  end
+
+  def test_block_shorthand_supports_bool
+    assert_equal true, ROXML::Definition.new(:floatvalue, :as => :bool).blocks.first.call("1")
+    assert_equal [true, false, nil], ROXML::Definition.new(:floatvalue, :as => :bool).blocks.first.call(["TrUe", "0", "328"])
+  end
+
+  def test_block_shorthand_supports_integer
+    assert_equal nil, ROXML::Definition.new(:floatvalue, :as => Integer).blocks.first.call(" ")
+    assert_equal 792, ROXML::Definition.new(:floatvalue, :as => Integer).blocks.first.call("792")
+    assert_raise ArgumentError do
+      ROXML::Definition.new(:floatvalue, :as => Integer).blocks.first.call("792.13")
+    end
+    assert_equal [792, 12, 328], ROXML::Definition.new(:floatvalue, :as => Integer).blocks.first.call(["792", "12", "328"])
+  end
+
+  def test_block_shorthand_supports_float
+    assert_equal nil, ROXML::Definition.new(:floatvalue, :as => Float).blocks.first.call("  ")
+    assert_equal 792.13, ROXML::Definition.new(:floatvalue, :as => Float).blocks.first.call("792.13")
+    assert_equal 240.0, ROXML::Definition.new(:floatvalue, :as => Float).blocks.first.call("240")
+    assert_equal [792.13, 240.0, 3.14], ROXML::Definition.new(:floatvalue, :as => Float).blocks.first.call(["792.13", "240", "3.14"])
+  end
+
+  def test_block_shorthand_supports_time
+    assert_equal nil, ROXML::Definition.new(:floatvalue, :as => Time).blocks.first.call("  ")
+    assert_equal 31, ROXML::Definition.new(:datevalue, :as => Time).blocks.first.call("12:31am").min
+    assert_equal [31, 0, 59], ROXML::Definition.new(:datevalue, :as => Time).blocks.first.call(["12:31am", "3:00pm", "11:59pm"]).map(&:min)
+  end
+
+  def test_block_shorthand_supports_date
+    assert_equal nil, ROXML::Definition.new(:floatvalue, :as => Date).blocks.first.call("  ")
+    assert_equal "1970-09-03", ROXML::Definition.new(:datevalue, :as => Date).blocks.first.call("September 3rd, 1970").to_s
+    assert_equal ["1970-09-03", "1776-07-04"], ROXML::Definition.new(:datevalue, :as => Date).blocks.first.call(["September 3rd, 1970", "1776-07-04"]).map(&:to_s)
+  end
+
+  def test_block_shorthand_supports_datetime
+    assert_equal nil, ROXML::Definition.new(:floatvalue, :as => DateTime).blocks.first.call("  ")
+    assert_equal "1970-09-03T12:05:00+00:00", ROXML::Definition.new(:datevalue, :as => DateTime).blocks.first.call("12:05pm, September 3rd, 1970").to_s
+    assert_equal ["1970-09-03T12:05:00+00:00", "1700-05-22T15:00:00+00:00"], ROXML::Definition.new(:datevalue, :as => DateTime).blocks.first.call(["12:05pm, September 3rd, 1970", "3:00pm, May 22, 1700"]).map(&:to_s)
+  end
+
+  def test_name_explicit_indicates_whether_from_option_is_present
+    assert_equal true, ROXML::Definition.new(:element, :from => 'somewhere').name_explicit?
+    assert_equal false, ROXML::Definition.new(:element).name_explicit?
+  end
+
+  def test_xpath_in_is_formed_properly
+    opts = ROXML::Definition.new(:manufacturer, :in => './')
+    assert_equal "manufacturer", opts.name
+    assert_equal "./", opts.wrapper
+  end
+end

data/test/unit/inheritance_test.rb

@@ -1,5 +1,17 @@
 require File.join(File.dirname(__FILE__), '..', 'test_helper')
 
+class ParentWithNamespace
+  include ROXML
+  xml_namespace 'parent_namespace'
+end
+
+class ChildWithInheritedNamespace < ParentWithNamespace
+end
+
+class ChildWithOwnNamespace < ParentWithNamespace
+  xml_namespace 'child_namespace'
+end
+
 class InheritedBookWithDepth < Book
   xml_reader :depth, Measurement
 end
@@ -13,6 +25,7 @@ class TestInheritance < Test::Unit::TestCase
         <author>David Thomas, Andrew Hunt, Dave Thomas</author>
         <depth units="hundredths-meters">1130</depth>
         <publisher>Pragmattic Programmers</publisher>
+        <pagecount>500</pagecount>
       </book>
     }
 
@@ -24,7 +37,7 @@ class TestInheritance < Test::Unit::TestCase
     assert_equal 'The PickAxe', @b.title
     assert_equal 'Probably the best Ruby book out there', @b.description
     assert_equal 'David Thomas, Andrew Hunt, Dave Thomas', @b.author
-    assert_equal 0, @b.pages
+    assert_equal 500, @b.pages
   end
 
   def test_it_should_include_its_own_attributes
@@ -39,4 +52,12 @@ class TestInheritance < Test::Unit::TestCase
     book = InheritedBookWithDepth.from_xml(@book_xml)
     assert_equal "Pragmattic Programmers", book.publisher
   end
+
+  def test_it_should_inherit_namespace
+    assert_equal 'parent_namespace', ChildWithInheritedNamespace.roxml_namespace
+  end
+
+  def test_inherited_namespace_should_be_overridable
+    assert_equal 'child_namespace', ChildWithOwnNamespace.roxml_namespace
+  end
 end

data/test/unit/roxml_test.rb

@@ -25,7 +25,36 @@ class TestROXML < Test::Unit::TestCase
   def test_tag_refs_is_deprecated
     assert_deprecated do
       Class.new do
-        include ROXML
      end.tag_refs
+        include ROXML
+      end.tag_refs
+    end
+  end
+
+  def test_from_xml_should_support_pathnames
+    book = BookWithContributors.from_xml(Pathname.new(fixture_path(:book_with_contributors)))
+    expected_contributors = ["David Thomas","Andrew Hunt","Chad Fowler"]
+    assert_equal("Programming Ruby - 2nd Edition", book.title)
+    book.contributors.each do |contributor|
+      assert(expected_contributors.include?(contributor.name))
+    end
+  end
+
+  def test_from_xml_should_support_uris
+    uri = URI.parse("file://#{File.expand_path(File.expand_path(fixture_path(:book_with_contributors)))}")
+    book = BookWithContributors.from_xml(uri)
+    expected_contributors = ["David Thomas","Andrew Hunt","Chad Fowler"]
+    assert_equal("Programming Ruby - 2nd Edition", book.title)
+    book.contributors.each do |contributor|
+      assert(expected_contributors.include?(contributor.name))
+    end
+  end
+
+  def test_from_xml_should_support_files
+    book = BookWithContributors.from_xml(File.new(fixture_path(:book_with_contributors)))
+    expected_contributors = ["David Thomas","Andrew Hunt","Chad Fowler"]
+    assert_equal("Programming Ruby - 2nd Edition", book.title)
+    book.contributors.each do |contributor|
+      assert(expected_contributors.include?(contributor.name))
     end
   end
 end

data/test/unit/xml_name_test.rb

@@ -128,4 +128,33 @@ class TestXMLName < Test::Unit::TestCase
       NamedChild.xml_name?
     end
   end
+
+  def test_xml_name_should_not_be_conventionalized_if_explicitly_set
+    reference = ROXML::XMLTextRef.new(ROXML::Definition.new(:name, :from => 'georss:name'), WrapModule::InstanceStandin.new)
+    assert_equal "georss:name", reference.name
+  end
+
+  def test_xml_name_not_screwed_up_by_xml_convention
+    reference = ROXML::XMLTextRef.new(ROXML::Definition.new(:name, :in => './'), WrapModule::InstanceStandin.new)
+    assert_equal "name value", reference.value_in(ROXML::XML::Parser.parse(%(
+      <Wrapper>
+         <MoreStuff>
+            <DeepWrapper>
+               <Name>name value</Name>
+            </DeepWrapper>
+         </MoreStuff>
+      </Wrapper>
+    )).root)
+  end
+end
+
+module WrapModule
+  class BaseClass
+    include ROXML
+    xml_convention :camelcase
+  end
+
+  class InstanceStandin < BaseClass
+    xml_reader :name, :in => './'
+  end
 end

data/test/unit/xml_namespace_test.rb

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), '..', 'test_helper')
 
-class TestXMLNamespaces < Test::Unit::TestCase
+class TestDefaultXMLNamespaces < Test::Unit::TestCase
   def setup
     @book = BookWithContributions.from_xml(fixture(:book_with_default_namespace))
   end
@@ -35,4 +35,41 @@ class TestXMLNamespaces < Test::Unit::TestCase
     assert_equal nil, xml.find_first('ns:node/subnode', 'ns:http://defaultnamespace.org')
     assert_equal "Another", xml.find_first('ns:node/ns:subnode', 'ns:http://defaultnamespace.org').content
   end
+end
+
+class NamespaceyObject
+  include ROXML
+  xml_namespace :aws
+
+  xml_reader :default_namespace
+  xml_reader :different_namespace, :from => 'different:namespace'
+  xml_reader :no_namespace, :from => 'no_namespace'
+end
+
+class TestXMLNamespaceDeclarations < Test::Unit::TestCase
+  def setup
+    @instance = NamespaceyObject.from_xml(%{
+      <aws:book xmlns:aws="http://www.aws.com/aws" xmlns:different="http://www.aws.com/different">
+        <aws:default_namespace>default_value</aws:default_namespace>
+        <different:namespace>different_value</different:namespace>
+        <no_namespace>no_value</no_namespace>
+      </aws:book>
+    })
+  end
+
+  def test_namespace_is_accessible
+    assert_equal "aws", @instance.class.roxml_namespace
+  end
+
+  def test_namespace_declaration_should_be_followed_on_attributes
+    assert_equal "default_value", @instance.default_namespace
+  end
+
+  def test_namespace_declaration_can_be_overriden_for_different_namespace_elements
+    assert_equal "different_value", @instance.different_namespace
+  end
+
+  def test_namespace_declaration_can_be_overriden_for_no_namespace_elements
+    assert_equal "no_value", @instance.no_namespace
+  end
 end