ROXML 3.0.0

data/lib/roxml/xml/references.rb

@@ -0,0 +1,297 @@
+module ROXML
+  class RequiredElementMissing < Exception # :nodoc:
+  end
+  
+  #
+  # Internal base class that represents an XML - Class binding.
+  #
+  class XMLRef # :nodoc:
+    delegate :required?, :array?, :blocks, :accessor, :default, :wrapper, :to => :opts
+
+    def initialize(opts, instance)
+      @opts = opts
+      @instance = instance
+    end
+
+    def to_xml(instance)
+      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
+      namespacify(name)
+    end
+
+    def value_in(xml)
+      xml = XML::Node.from(xml)
+      value = fetch_value(xml)
+      value = default if value.nil?
+
+      freeze(apply_blocks(value))
+    end
+
+  private
+    attr_reader :opts
+
+    def conventionize(what)
+      convention ||= @instance.class.respond_to?(:roxml_naming_convention) && @instance.class.roxml_naming_convention
+      if !what.blank? && convention.respond_to?(:call)
+        URI.unescape(convention.call(URI.escape(what, /\/|::/)))
+      else
+        what
+      end
+    end
+
+    def namespacify(what)
+      return "#{opts.namespace}:#{what}" if opts.namespace
+
+      namespace = @instance.class.roxml_namespace || @default_namespace
+      if namespace && what.present? && !what.include?(':') && (opts.namespace != false)
+        "#{namespace}:#{what}"
+      else
+        what
+      end
+    end
+
+    def apply_blocks(val)
+      begin
+        blocks.inject(val) {|val, block| block.call(val) }
+      rescue Exception => ex
+        raise ex, "#{accessor}: #{ex.message}"
+      end
+    end
+
+    def freeze(val)
+      if opts.frozen?
+        val.each(&:freeze) if val.is_a?(Enumerable)
+        val.freeze
+      else
+        val
+      end
+    end
+
+    def xpath
+      opts.wrapper ? "#{namespacify(opts.wrapper)}/#{xpath_name}" : xpath_name.to_s
+    end
+
+    def auto_xpath
+      "#{namespacify(conventionize(opts.name.pluralize))}/#{xpath_name}" if array?
+    end
+
+    def several?
+      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.add_child(XML::Node.create(wrapper.to_s))
+    end
+
+    def nodes_in(xml)
+      @default_namespace = xml.default_namespace
+      vals = xml.search(xpath, @instance.class.roxml_namespaces)
+
+      if several? && vals.empty? && !wrapper && auto_xpath
+        vals = xml.search(auto_xpath, @instance.class.roxml_namespaces)
+        @auto_vals = !vals.empty?
+      end
+
+      if vals.empty?
+        raise RequiredElementMissing, "#{name} from #{xml} for #{accessor}" if required?
+        default
+      elsif several?
+        vals.map do |val|
+          yield val
+        end
+      else
+        yield(vals.first)
+      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
+    end
+
+    def fetch_value(xml)
+      nodes_in(xml) do |node|
+        node.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.add_child(XML::Node.create(name)), v)
+        end
+      else
+        add(xml.add_child(XML::Node.create(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 |node|
+          node.content.strip
+        end
+      end
+    end
+
+    def add(dest, value)
+      if cdata?
+        dest.add_child(XML::Node.new_cdata(value.to_s))
+      else
+        dest.content = value.to_s
+      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
+
+    def several?
+      true
+    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.add_child(XML::Node.create(hash.wrapper))
+        @key.update_xml(node, k)
+        @value.update_xml(node, v)
+      end
+    end
+
+    def fetch_value(xml)
+      nodes_in(xml) do |node|
+        [@key.value_in(node), @value.value_in(node)]
+      end
+    end
+
+    def apply_blocks(vals)
+      unless blocks.empty?
+        vals.collect! do |kvp|
+          super(kvp)
+        end
+      end
+      to_hash(vals) if vals
+    end
+
+    def freeze(vals)
+      if opts.frozen?
+        vals.each_pair{|k, v| k.freeze; v.freeze }
+        vals.freeze
+      else
+        vals
+      end
+    end
+
+    def to_hash(array)
+      hash = array.inject({}) do |result, (k, v)|
+        result[k] ||= []
+        result[k] << v
+        result
+      end
+      hash.each_pair do |k, v|
+        hash[k] = v.first if v.size == 1
+      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.add_child(v.to_xml(name))
+        end
+      elsif value.is_a?(ROXML)
+        xml.add_child(value.to_xml(name))
+      else
+        node = XML::Node.create(name)
+        node.content = value.to_xml
+        xml.add_child(node)
+      end
+    end
+
+    def fetch_value(xml)
+      nodes_in(xml) do |node|
+        if type.respond_to? :from_xml
+          type.from_xml(node)
+        else
+          type.new(node)
+        end
+      end
+    end
+  end
+end

data/roxml.gemspec

@@ -0,0 +1,201 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{roxml}
+  s.version = "3.0.0"
+
+  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-10-16}
+  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",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".gitmodules",
+     "History.txt",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "config/website.yml",
+     "examples/amazon.rb",
+     "examples/current_weather.rb",
+     "examples/dashed_elements.rb",
+     "examples/library.rb",
+     "examples/posts.rb",
+     "examples/rails.rb",
+     "examples/twitter.rb",
+     "examples/xml/active_record.xml",
+     "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/hash_definition.rb",
+     "lib/roxml/xml.rb",
+     "lib/roxml/xml/parsers/libxml.rb",
+     "lib/roxml/xml/parsers/nokogiri.rb",
+     "lib/roxml/xml/references.rb",
+     "roxml.gemspec",
+     "spec/definition_spec.rb",
+     "spec/examples/active_record_spec.rb",
+     "spec/examples/amazon_spec.rb",
+     "spec/examples/current_weather_spec.rb",
+     "spec/examples/dashed_elements_spec.rb",
+     "spec/examples/library_spec.rb",
+     "spec/examples/post_spec.rb",
+     "spec/examples/twitter_spec.rb",
+     "spec/roxml_spec.rb",
+     "spec/shared_specs.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/support/libxml.rb",
+     "spec/support/nokogiri.rb",
+     "spec/xml/attributes_spec.rb",
+     "spec/xml/namespace_spec.rb",
+     "spec/xml/namespaces_spec.rb",
+     "spec/xml/parser_spec.rb",
+     "tasks/rdoc.rake",
+     "tasks/rspec.rake",
+     "tasks/test.rake",
+     "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/support/fixtures.rb",
+     "test/test_helper.rb",
+     "test/unit/definition_test.rb",
+     "test/unit/deprecations_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_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",
+     "website/index.html"
+  ]
+  s.homepage = %q{http://roxml.rubyforge.org}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ROXML}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby Object to XML mapping library}
+  s.test_files = [
+    "spec/definition_spec.rb",
+     "spec/examples/active_record_spec.rb",
+     "spec/examples/amazon_spec.rb",
+     "spec/examples/current_weather_spec.rb",
+     "spec/examples/dashed_elements_spec.rb",
+     "spec/examples/library_spec.rb",
+     "spec/examples/post_spec.rb",
+     "spec/examples/twitter_spec.rb",
+     "spec/roxml_spec.rb",
+     "spec/shared_specs.rb",
+     "spec/spec_helper.rb",
+     "spec/support/libxml.rb",
+     "spec/support/nokogiri.rb",
+     "spec/xml/attributes_spec.rb",
+     "spec/xml/namespace_spec.rb",
+     "spec/xml/namespaces_spec.rb",
+     "spec/xml/parser_spec.rb",
+     "test/mocks/dictionaries.rb",
+     "test/mocks/mocks.rb",
+     "test/support/fixtures.rb",
+     "test/test_helper.rb",
+     "test/unit/definition_test.rb",
+     "test/unit/deprecations_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_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",
+     "examples/amazon.rb",
+     "examples/current_weather.rb",
+     "examples/dashed_elements.rb",
+     "examples/library.rb",
+     "examples/posts.rb",
+     "examples/rails.rb",
+     "examples/twitter.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1.0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.3.3"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.2.4"])
+      s.add_development_dependency(%q<activerecord>, [">= 2.2.2"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.1.0"])
+      s.add_dependency(%q<nokogiri>, [">= 1.3.3"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.4"])
+      s.add_dependency(%q<activerecord>, [">= 2.2.2"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.1.0"])
+    s.add_dependency(%q<nokogiri>, [">= 1.3.3"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.4"])
+    s.add_dependency(%q<activerecord>, [">= 2.2.2"])
+  end
+end