roxml 2.4.1 → 2.4.2

data/lib/roxml/xml/{libxml.rb → parsers/libxml.rb}

@@ -8,11 +8,15 @@ module ROXML
 
     module NamespacedSearch
       def search(xpath)
-        if default_namespace && !xpath.include?(':')
-          find(namespaced(xpath),
-               in_default_namespace(default_namespace.href))
-        else
-          find(xpath)
+        begin
+          if default_namespace && !xpath.include?(':')
+            find(namespaced(xpath),
+                 in_default_namespace(default_namespace.href))
+          else
+            find(xpath)
+          end
+        rescue Exception => ex
+          raise ex, xpath
         end
       end
 
@@ -57,6 +61,10 @@ module ROXML
         def parse_file(path)
           file(path).parse
         end
+
+        def parse_io(stream)
+          io(stream).parse
+        end
       end
     end
   end

data/lib/roxml/xml/{rexml.rb → parsers/rexml.rb}

@@ -20,7 +20,11 @@ module ROXML
       alias_attribute :content, :text
 
       def search(xpath)
-        REXML::XPath.match(self, xpath)
+        begin
+          REXML::XPath.match(self, xpath)
+        rescue Exception => ex
+          raise ex, xpath
+        end
       end
 
       def child_add(element)
@@ -38,14 +42,19 @@ module ROXML
 
     class Parser
       class << self
-        def parse(string)
-          REXML::Document.new(string, :ignore_whitespace_nodes => :all)
+        def parse(source)
+          REXML::Document.new(source, :ignore_whitespace_nodes => :all)
         end
 
-        def parse_file(path)
+        def parse_file(path) #:nodoc:
+          path = path.sub('file:', '') if path.starts_with?('file:')
           parse(open(path))
         end
 
+        def parse_io(path) #:nodoc:
+          parse(path)
+        end
+
         def register_error_handler(&block)
         end
       end

data/lib/roxml/xml/references.rb

@@ -0,0 +1,290 @@
+module ROXML
+  class RequiredElementMissing < Exception # :nodoc:
+  end
+  
+  #
+  # Internal base class that represents an XML - Class binding.
+  #
+  class XMLRef # :nodoc:
+    delegate :required?, :array?, :blocks, :accessor, :variable_name, :default, :to => :opts
+
+    def initialize(opts, instance)
+      @opts = opts
+      @instance = instance
+    end
+
+    def to_xml
+      val = @instance.__send__(accessor)
+      opts.to_xml.respond_to?(:call) ? opts.to_xml.call(val) : val
+    end
+
+    def update_xml(xml, value)
+      returning wrap(xml) do |xml|
+        write_xml(xml, value)
+      end
+    end
+
+    def name
+      opts.name_explicit? ? opts.name : conventionize(opts.name)
+    end
+
+    def xpath_name
+      if !opts.name_explicit? && namespace = @instance.class.roxml_namespace
+        "#{namespace}:#{name}"
+      else
+        name
+      end
+    end
+
+    def default
+      @default ||= @opts.default || (@opts.array? ? Array.new : nil)
+      @default.duplicable? ? @default.dup : @default
+    end
+
+    def value_in(xml)
+      value = fetch_value(xml)
+      freeze(apply_blocks(value))
+    end
+
+  private
+    attr_reader :opts
+
+    def conventionize(what)
+      if !what.blank? && @instance.try(:class).try(:roxml_naming_convention).respond_to?(:call)
+        require 'uri'
+        URI.unescape(@instance.class.roxml_naming_convention.call(URI.escape(what, /\/|::/)))
+      else
+        what
+      end
+    end
+
+    def wrapper
+      conventionize(opts.wrapper)
+    end
+
+    def apply_blocks(val)
+      begin
+        blocks.apply_to(val)
+      rescue Exception => ex
+        raise ex, "#{accessor}: #{ex.message}"
+      end
+    end
+
+    def freeze(val)
+      if opts.freeze?
+        val.each(&:freeze) if val.is_a?(Enumerable)
+        val.freeze
+      else
+        val
+      end
+    end
+
+    def xpath
+      wrapper ? "#{wrapper}/#{xpath_name}" : xpath_name.to_s
+    end
+
+    def auto_xpath
+      "#{conventionize(opts.name.pluralize)}/#{xpath_name}" if array?
+    end
+
+    def wrap(xml)
+      return xml if !wrapper || xml.name == wrapper
+      if child = xml.children.find {|c| c.name == wrapper }
+       return child
+      end
+      xml.child_add(XML::Node.new_element(wrapper))
+    end
+
+    def nodes_in(xml)
+      vals = xml.search(xpath)
+
+      if (opts.hash? || opts.array?) && vals.empty? && !wrapper && auto_xpath
+        vals = xml.search(auto_xpath)
+        @auto_vals = !vals.empty?
+      end
+
+      if vals.empty?
+        raise RequiredElementMissing, "#{name} from #{xml} for #{accessor}" if required?
+        default
+      else
+        yield(vals)
+      end
+    end
+  end
+
+  # Interal class representing an XML attribute binding
+  #
+  # In context:
+  #  <element attribute="XMLAttributeRef">
+  #   XMLTextRef
+  #  </element>
+  class XMLAttributeRef < XMLRef # :nodoc:
+  private
+    # Updates the attribute in the given XML block to
+    # the value provided.
+    def write_xml(xml, value)
+      xml.attributes[name] = value.to_s.to_utf
+    end
+
+    def fetch_value(xml)
+      nodes_in(xml) do |nodes|
+        nodes.first.value
+      end
+    end
+
+    def xpath_name
+      "@#{name}"
+    end
+  end
+
+  # Interal class representing XML content text binding
+  #
+  # In context:
+  #  <element attribute="XMLAttributeRef">
+  #   XMLTextRef
+  #  </element>
+  class XMLTextRef < XMLRef # :nodoc:
+    delegate :cdata?, :content?, :name?, :to => :opts
+
+  private
+    # Updates the text in the given _xml_ block to
+    # the _value_ provided.
+    def write_xml(xml, value)
+      if content?
+        add(xml, value)
+      elsif name?
+        xml.name = value
+      elsif array?
+        value.each do |v|
+          add(xml.child_add(XML::Node.new_element(name)), v)
+        end
+      else
+        add(xml.child_add(XML::Node.new_element(name)), value)
+      end
+    end
+
+    def fetch_value(xml)
+      if content? || name?
+        value =
+          if content?
+            xml.content.to_s.strip
+          elsif name?
+            xml.name
+          end
+
+        if value.empty?
+          raise RequiredElementMissing, "#{name} from #{xml} for #{accessor}" if required?
+          default
+        else
+          value
+        end
+      else
+        nodes_in(xml) do |nodes|
+          if array?
+            nodes.collect do |e|
+              e.content.strip.to_latin
+            end
+          else
+            nodes.first.content
+          end
+        end
+      end
+    end
+
+    def add(dest, value)
+      if cdata?
+        dest.child_add(XML::Node.new_cdata(value.to_s.to_utf))
+      else
+        dest.content = value.to_s.to_utf
+      end
+    end
+  end
+
+  class XMLHashRef < XMLTextRef # :nodoc:
+    delegate :hash, :to => :opts
+
+    def initialize(opts, inst)
+      super(opts, inst)
+      @key = opts.hash.key.to_ref(inst)
+      @value = opts.hash.value.to_ref(inst)
+    end
+
+  private
+    # Updates the composed XML object in the given XML block to
+    # the value provided.
+    def write_xml(xml, value)
+      value.each_pair do |k, v|
+        node = xml.child_add(XML::Node.new_element(hash.wrapper))
+        @key.update_xml(node, k)
+        @value.update_xml(node, v)
+      end
+    end
+
+    def fetch_value(xml)
+      nodes_in(xml) do |nodes|
+        nodes.collect do |e|
+          [@key.value_in(e), @value.value_in(e)]
+        end
+      end
+    end
+
+    def apply_blocks(vals)
+      unless blocks.empty?
+        vals.collect! do |kvp|
+          super(kvp)
+        end
+      end
+      vals.to_hash if vals
+    end
+
+    def freeze(vals)
+      if opts.freeze?
+        vals.each_pair{|k, v| k.freeze; v.freeze }
+        vals.freeze
+      else
+        vals
+      end
+    end
+  end
+
+  class XMLObjectRef < XMLTextRef # :nodoc:
+    delegate :type, :to => :opts
+
+  private
+    # Updates the composed XML object in the given XML block to
+    # the value provided.
+    def write_xml(xml, value)
+      if array?
+        value.each do |v|
+          xml.child_add(v.to_xml(name))
+        end
+      elsif value.is_a?(ROXML)
+        xml.child_add(value.to_xml(name))
+      else
+        node = XML::Node.new_element(name)
+        node.content = value.to_xml
+        xml.child_add(node)
+      end
+    end
+
+    def fetch_value(xml)
+      nodes_in(xml) do |nodes|
+        unless array?
+          instantiate(nodes.first)
+        else
+          nodes.collect do |e|
+            instantiate(e)
+          end
+        end
+      end
+    end
+
+    def instantiate(elem)
+      if type.respond_to? :from_xml
+        type.from_xml(elem)
+      else
+        type.new(elem)
+      end
+    end
+  end
+end

data/roxml.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roxml}
-  s.version = "2.4.1"
+  s.version = "2.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Woosley", "Zak Mandhro", "Anders Engstrom", "Russ Olsen"]
-  s.date = %q{2009-01-28}
+  s.date = %q{2009-01-31}
   s.description = %q{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.}
   s.email = %q{ben.woosley@gmail.com}
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
-  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "TODO", "html/index.html", "html/style.css", "lib/roxml.rb", "lib/roxml/extensions/active_support.rb", "lib/roxml/extensions/array.rb", "lib/roxml/extensions/array/conversions.rb", "lib/roxml/extensions/deprecation.rb", "lib/roxml/extensions/string.rb", "lib/roxml/extensions/string/conversions.rb", "lib/roxml/extensions/string/iterators.rb", "lib/roxml/options.rb", "lib/roxml/xml.rb", "lib/roxml/xml/libxml.rb", "lib/roxml/xml/rexml.rb", "roxml.gemspec", "tasks/test.rake", "test/bugs/rexml_bugs.rb", "test/fixtures/book_malformed.xml", "test/fixtures/book_pair.xml", "test/fixtures/book_text_with_attribute.xml", "test/fixtures/book_valid.xml", "test/fixtures/book_with_authors.xml", "test/fixtures/book_with_contributions.xml", "test/fixtures/book_with_contributors.xml", "test/fixtures/book_with_contributors_attrs.xml", "test/fixtures/book_with_default_namespace.xml", "test/fixtures/book_with_depth.xml", "test/fixtures/book_with_octal_pages.xml", "test/fixtures/book_with_publisher.xml", "test/fixtures/book_with_wrapped_attr.xml", "test/fixtures/dictionary_of_attr_name_clashes.xml", "test/fixtures/dictionary_of_attrs.xml", "test/fixtures/dictionary_of_guarded_names.xml", "test/fixtures/dictionary_of_mixeds.xml", "test/fixtures/dictionary_of_name_clashes.xml", "test/fixtures/dictionary_of_names.xml", "test/fixtures/dictionary_of_texts.xml", "test/fixtures/library.xml", "test/fixtures/library_uppercase.xml", "test/fixtures/muffins.xml", "test/fixtures/nameless_ageless_youth.xml", "test/fixtures/node_with_attr_name_conflicts.xml", "test/fixtures/node_with_name_conflicts.xml", "test/fixtures/numerology.xml", "test/fixtures/person.xml", "test/fixtures/person_with_guarded_mothers.xml", "test/fixtures/person_with_mothers.xml", "test/mocks/dictionaries.rb", "test/mocks/mocks.rb", "test/release/dependencies_test.rb", "test/test_helper.rb", "test/unit/array_test.rb", "test/unit/freeze_test.rb", "test/unit/inheritance_test.rb", "test/unit/options_test.rb", "test/unit/overriden_output_test.rb", "test/unit/roxml_test.rb", "test/unit/string_test.rb", "test/unit/to_xml_test.rb", "test/unit/xml_attribute_test.rb", "test/unit/xml_block_test.rb", "test/unit/xml_bool_test.rb", "test/unit/xml_construct_test.rb", "test/unit/xml_convention_test.rb", "test/unit/xml_hash_test.rb", "test/unit/xml_initialize_test.rb", "test/unit/xml_name_test.rb", "test/unit/xml_namespace_test.rb", "test/unit/xml_object_test.rb", "test/unit/xml_required_test.rb", "test/unit/xml_text_test.rb", "vendor/override_rake_task/README", "vendor/override_rake_task/init.rb", "vendor/override_rake_task/install.rb", "vendor/override_rake_task/lib/override_rake_task.rb"]
+  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "TODO", "config/website.yml", "examples/amazon.rb", "examples/current_weather.rb", "examples/dashed_elements.rb", "examples/posts.rb", "examples/twitter.rb", "examples/xml/amazon.xml", "examples/xml/current_weather.xml", "examples/xml/dashed_elements.xml", "examples/xml/posts.xml", "examples/xml/twitter.xml", "lib/roxml.rb", "lib/roxml/definition.rb", "lib/roxml/extensions.rb", "lib/roxml/extensions/active_support.rb", "lib/roxml/extensions/array.rb", "lib/roxml/extensions/array/conversions.rb", "lib/roxml/extensions/deprecation.rb", "lib/roxml/extensions/string.rb", "lib/roxml/extensions/string/conversions.rb", "lib/roxml/extensions/string/iterators.rb", "lib/roxml/hash_definition.rb", "lib/roxml/xml.rb", "lib/roxml/xml/parsers/libxml.rb", "lib/roxml/xml/parsers/rexml.rb", "lib/roxml/xml/references.rb", "roxml.gemspec", "spec/examples/amazon_spec.rb", "spec/examples/current_weather_spec.rb", "spec/examples/dashed_elements_spec.rb", "spec/examples/post_spec.rb", "spec/examples/twitter_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake", "tasks/test.rake", "test/bugs/rexml_bugs.rb", "test/fixtures/book_malformed.xml", "test/fixtures/book_pair.xml", "test/fixtures/book_text_with_attribute.xml", "test/fixtures/book_valid.xml", "test/fixtures/book_with_authors.xml", "test/fixtures/book_with_contributions.xml", "test/fixtures/book_with_contributors.xml", "test/fixtures/book_with_contributors_attrs.xml", "test/fixtures/book_with_default_namespace.xml", "test/fixtures/book_with_depth.xml", "test/fixtures/book_with_octal_pages.xml", "test/fixtures/book_with_publisher.xml", "test/fixtures/book_with_wrapped_attr.xml", "test/fixtures/dictionary_of_attr_name_clashes.xml", "test/fixtures/dictionary_of_attrs.xml", "test/fixtures/dictionary_of_guarded_names.xml", "test/fixtures/dictionary_of_mixeds.xml", "test/fixtures/dictionary_of_name_clashes.xml", "test/fixtures/dictionary_of_names.xml", "test/fixtures/dictionary_of_texts.xml", "test/fixtures/library.xml", "test/fixtures/library_uppercase.xml", "test/fixtures/muffins.xml", "test/fixtures/nameless_ageless_youth.xml", "test/fixtures/node_with_attr_name_conflicts.xml", "test/fixtures/node_with_name_conflicts.xml", "test/fixtures/numerology.xml", "test/fixtures/person.xml", "test/fixtures/person_with_guarded_mothers.xml", "test/fixtures/person_with_mothers.xml", "test/mocks/dictionaries.rb", "test/mocks/mocks.rb", "test/release/dependencies_test.rb", "test/test_helper.rb", "test/unit/array_test.rb", "test/unit/definition_test.rb", "test/unit/freeze_test.rb", "test/unit/inheritance_test.rb", "test/unit/overriden_output_test.rb", "test/unit/roxml_test.rb", "test/unit/string_test.rb", "test/unit/to_xml_test.rb", "test/unit/xml_attribute_test.rb", "test/unit/xml_block_test.rb", "test/unit/xml_bool_test.rb", "test/unit/xml_construct_test.rb", "test/unit/xml_convention_test.rb", "test/unit/xml_hash_test.rb", "test/unit/xml_initialize_test.rb", "test/unit/xml_name_test.rb", "test/unit/xml_namespace_test.rb", "test/unit/xml_object_test.rb", "test/unit/xml_required_test.rb", "test/unit/xml_text_test.rb", "vendor/override_rake_task/README", "vendor/override_rake_task/init.rb", "vendor/override_rake_task/install.rb", "vendor/override_rake_task/lib/override_rake_task.rb", "website/index.html"]
   s.has_rdoc = true
   s.homepage = %q{http://roxml.rubyforge.org}
   s.rdoc_options = ["--main", "README.rdoc"]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{roxml}
   s.rubygems_version = %q{1.3.1.xported}
   s.summary = %q{Ruby Object to XML mapping library}
-  s.test_files = ["test/unit/freeze_test.rb", "test/unit/array_test.rb", "test/unit/xml_convention_test.rb", "test/unit/xml_object_test.rb", "test/unit/xml_required_test.rb", "test/unit/xml_bool_test.rb", "test/unit/roxml_test.rb", "test/unit/xml_name_test.rb", "test/unit/xml_construct_test.rb", "test/unit/options_test.rb", "test/unit/string_test.rb", "test/unit/xml_namespace_test.rb", "test/unit/xml_text_test.rb", "test/unit/overriden_output_test.rb", "test/unit/xml_block_test.rb", "test/unit/xml_attribute_test.rb", "test/unit/inheritance_test.rb", "test/unit/xml_initialize_test.rb", "test/unit/xml_hash_test.rb", "test/unit/to_xml_test.rb"]
+  s.test_files = ["test/unit/freeze_test.rb", "test/unit/array_test.rb", "test/unit/xml_convention_test.rb", "test/unit/xml_object_test.rb", "test/unit/xml_required_test.rb", "test/unit/xml_bool_test.rb", "test/unit/roxml_test.rb", "test/unit/xml_name_test.rb", "test/unit/definition_test.rb", "test/unit/xml_construct_test.rb", "test/unit/string_test.rb", "test/unit/xml_namespace_test.rb", "test/unit/xml_text_test.rb", "test/unit/overriden_output_test.rb", "test/unit/xml_block_test.rb", "test/unit/xml_attribute_test.rb", "test/unit/inheritance_test.rb", "test/unit/xml_initialize_test.rb", "test/unit/xml_hash_test.rb", "test/unit/to_xml_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/spec/examples/amazon_spec.rb

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