roxml 3.1.5 → 3.1.6

data/History.txt

@@ -1,3 +1,14 @@
+== 3.1.6 (September 9, 2010)
+
+* bug fix
+
+  * load active_support in a way that is compatible with 2.x and 3.x
+    (fixes gh issue #27)
+  * change the way we monkey patch Nokogiri to leave the original
+    behaviour of the search() method unchanged (fixes gh issue #16)
+  * Unofficial release by James Healy, empact has stepped back from maintaining
+    roxml
+
 == 3.1.5 (December 18, 2009)
 
 * bug fix
@@ -340,4 +351,4 @@
 
 == 1.1 (September 24, 2006)
 
-* Initial design & development [Zak Mandhro & Anders Engstrom]
+* Initial design & development [Zak Mandhro & Anders Engstrom]

data/README.rdoc

@@ -2,7 +2,7 @@ ROXML Ruby Object to XML mapping library.
 
 For more information visit:
 
-    http://roxml.rubyforge.org/rdoc/
+    http://rdoc.info/projects/Empact/roxml
     http://empact.github.com/roxml/
     http://rubyforge.org/projects/roxml/
 
@@ -10,6 +10,15 @@ Please submit bugs here:
 
     http://github.com/Empact/roxml/issues
 
+
+=ROXML is of, by, and for all of us
+
+I've taken a lead role on ROXML these past months, but unfortunately I, Ben Woosley (Empact), am unable to continue to maintain ROXML at this time, as it no longer aligns with my other interests & efforts.  While I would very much like to fix the bugs listed on the github issues page, I'm simply not the person to do it, given my other concerns.
+
+But don't be mistaken, the library covers most cases very well, and is on the better-tested side of the spectrum (some 353 examples, all green as of this writing).
+
+If you run into a problem with ROXML, *please* take advantage of those tests, and github, by rolling up your sleeves and making a fix!  Your fellow programmers, myself included, will appreciate you for it.
+
 =Quick Start Guide
 
 This is a short usage example. See ROXML::ClassMethods::Declarations and packaged test cases for more information.
@@ -50,7 +59,15 @@ To create a library and put a number of books in it we could run the following c
 
 To save this information to an XML file:
 
-  doc = ROXML::XML::Document.new
+  doc = Nokogiri::XML::Document.new
+  doc.root = lib.to_xml
+  open("library.xml", 'w') do |file|
+    file << doc.serialize
+  end
+
+or
+
+  doc = LibXML::XML::Document.new
   doc.root = lib.to_xml
   doc.save("library.xml")
 

data/Rakefile

@@ -25,7 +25,7 @@ EOF
   gem.add_dependency 'activesupport', '>= 2.3.0'
   gem.add_dependency 'nokogiri', '>= 1.3.3'
 
-  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec", '>= 2.0.0'
   gem.add_development_dependency "sqlite3-ruby", '>= 1.2.4'
   gem.add_development_dependency "activerecord", '>= 2.2.2'
 end
@@ -56,30 +56,28 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 desc "Run specs"
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec' << 'examples'
-  spec.spec_opts = ['--options', "spec/spec.opts"]
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts = '-Ilib -Ispec -Iexamples'
+  # spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
 namespace :spec do
   [:libxml, :nokogiri].each do |parser|
     desc "Spec ROXML under the #{parser} parser"
-    Spec::Rake::SpecTask.new(parser) do |spec|
-      spec.libs << 'lib' << 'spec' << 'examples'
-      spec.spec_opts = ['--options=spec/spec.opts']
-      spec.spec_files = ["spec/support/#{parser}.rb"] + FileList['spec/**/*_spec.rb']
+    RSpec::Core::RakeTask.new(parser) do |spec|
+      spec.ruby_opts = '-Ilib -Ispec -Iexamples'
+      # spec.spec_files = ["spec/support/#{parser}.rb"] + FileList['spec/**/*_spec.rb']
     end
   end
 end
 
 desc "Run specs with rcov"
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
+  spec.ruby_opts = '-Ilib -Ispec -Iexamples'
+  # spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
 require 'rake/testtask'

data/VERSION

@@ -1 +1 @@
-3.1.5
+3.1.6

data/examples/amazon.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require 'spec/spec_helper'
+require_relative './../spec/spec_helper'
 
 # The document `pita.xml` contains both a default namespace and the 'georss'
 # namespace (for the 'point' xml_reader).

data/examples/current_weather.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+require_relative './../spec/spec_helper'
 
 class Base
   include ROXML

data/examples/dashed_elements.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+require_relative './../spec/spec_helper'
 
 module GitHub
   class Commit

data/examples/posts.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+require_relative './../spec/spec_helper'
 
 class Post
   include ROXML

data/examples/rails.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require 'spec/spec_helper'
+require_relative './../spec/spec_helper'
 require 'sqlite3'
 require 'active_record'
 

data/examples/twitter.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+require_relative './../spec/spec_helper'
 require 'time'
 
 class User

data/lib/roxml.rb

@@ -1,5 +1,12 @@
 require 'uri'
+
 require 'active_support'
+require 'active_support/inflector/inflections'
+require 'active_support/core_ext/object/duplicable'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string/starts_ends_with'
 
 require 'roxml/definition'
 require 'roxml/xml'
@@ -23,7 +30,7 @@ module ROXML # :nodoc:
     def to_xml(params = {})
       params.reverse_merge!(:name => self.class.tag_name, :namespace => self.class.roxml_namespace)
       params[:namespace] = nil if ['*', 'xmlns'].include?(params[:namespace])
-      XML::Node.create([params[:namespace], params[:name]].compact.join(':')).tap do |root|
+      XML.new_node([params[:namespace], params[:name]].compact.join(':')).tap do |root|
         refs = (self.roxml_references.present? \
           ? self.roxml_references \
           : self.class.roxml_attrs.map {|attr| attr.to_ref(self) })

data/lib/roxml/definition.rb

@@ -55,16 +55,17 @@ module ROXML
       elsif opts[:from] == :attr
         @sought_type = :attr
         opts[:from] = nil
-      elsif opts[:from] == :name
+      elsif opts[:from] == :namespace
         opts[:from] = '*'
+        @sought_type = :namespace
       elsif opts[:from].to_s.starts_with?('@')
         @sought_type = :attr
         opts[:from].sub!('@', '')
       end
 
-      @attr_name = accessor.to_s.chomp('?')
-      @name = (opts[:from] || @attr_name).to_s
+      @name = @attr_name = accessor.to_s.chomp('?')
       @name = @name.singularize if hash? || array?
+      @name = (opts[:from] || @name).to_s
       if hash? && (hash.key.name? || hash.value.name?)
         @name = '*'
       end
@@ -112,6 +113,7 @@ module ROXML
       case sought_type
       when :attr          then XMLAttributeRef
       when :text          then XMLTextRef
+      when :namespace     then XMLNameSpaceRef
       when HashDefinition then XMLHashRef
       when Symbol         then raise ArgumentError, "Invalid type argument #{sought_type}"
       else                     XMLObjectRef
@@ -212,7 +214,7 @@ module ROXML
         as = (block ? :bool_combined : :bool_standalone)
       end
       as = self.class.block_shorthands.fetch(as) do
-        unless as.respond_to?(:from_xml) || (as.respond_to?(:first) && as.first.respond_to?(:from_xml)) || (as.is_a?(Hash) && !(as.keys & [:key, :value]).empty?)
+        unless (as == :text) || as.respond_to?(:from_xml) || (as.respond_to?(:first) && as.first.respond_to?(:from_xml)) || (as.is_a?(Hash) && !(as.keys & [:key, :value]).empty?)
           raise ArgumentError, "Invalid :as argument #{as}" unless as.nil?
         end
         nil

data/lib/roxml/xml.rb

@@ -23,13 +23,13 @@ module ROXML
         when XML::Document
           data.root
         when File, IO
-          Parser.parse_io(data).root
+          XML.parse_io(data).root
         else
           if (defined?(URI) && data.is_a?(URI::Generic)) ||
              (defined?(Pathname) && data.is_a?(Pathname))
-            Parser.parse_file(data.to_s).root
+            XML.parse_file(data.to_s).root
           else
-            Parser.parse(data).root
+            XML.parse_string(data).root
           end
         end
       end

data/lib/roxml/xml/parsers/libxml.rb

@@ -1,15 +1,56 @@
 require 'libxml'
-require 'cgi'
 
 module ROXML
   module XML # :nodoc:all
+
+    class << self
+      def set_attribute(node, name, value)
+        node.attributes[name] = value
+      end
+
+      def set_content(node, content)
+        node.content = content.gsub('&', '&amp;')
+      end
+
+      def new_node(name)
+        LibXML::XML::Node.new(name)
+      end
+
+      def add_node(parent, name)
+        add_child(parent, new_node(name))
+      end
+
+      def add_cdata(parent, content)
+        add_child(parent, LibXML::XML::Node.new_cdata(content))
+      end
+
+      def add_child(parent, child)
+        parent << child
+        child
+      end
+
+      def parse_string(str_data)
+        LibXML::XML::Parser.string(str_data).parse
+      end
+
+      def parse_file(path)
+        LibXML::XML::Parser.file(path).parse
+      end
+
+      def parse_io(stream)
+        LibXML::XML::Parser.io(stream).parse
+      end
+
+      def save_doc(doc, path)
+        doc.save(path)
+      end
+    end
+
     Document = LibXML::XML::Document
     Node = LibXML::XML::Node
-    Parser = LibXML::XML::Parser
-    Error = LibXML::XML::Error
 
     module NamespacedSearch
-      def search(xpath, roxml_namespaces = {})
+      def roxml_search(xpath, roxml_namespaces = {})
         if namespaces.default
           roxml_namespaces = {:xmlns => namespaces.default.href}.merge(roxml_namespaces)
         end
@@ -19,17 +60,6 @@ module ROXML
           find(xpath)
         end
       end
-
-    private
-      def namespaced(xpath)
-        xpath.split('/').map do |component|
-          if component =~ /\w+/ && !component.include?(':') && !component.starts_with?('@')
-            "xmlns:#{component}"
-          else
-            component
-          end
-        end.join('/')
-      end
     end
 
     class Document
@@ -47,45 +77,9 @@ module ROXML
     class Node
       include NamespacedSearch
 
-      class << self
-        def new_with_entity_escaping(name, content = nil, namespace = nil)
-          new_without_entity_escaping(name, content && CGI.escapeHTML(content), namespace)
-        end
-        alias_method_chain :new, :entity_escaping
-
-        alias :create :new
-      end
-
       def default_namespace
         doc.default_namespace
       end
-
-      def add_child(child)
-        # libxml 1.1.3 changed child_add from returning child to returning self
-        self << child
-        child
-      end
-
-      alias_method :set_libxml_content, :content=
-      def content=(string)
-        set_libxml_content(string.gsub('&', '&amp;'))
-      end
-    end
-
-    class Parser
-      class << self
-        def parse(str_data)
-          string(str_data).parse
-        end
-
-        def parse_file(path)
-          file(path).parse
-        end
-
-        def parse_io(stream)
-          io(stream).parse
-        end
-      end
     end
   end
-end
+end

data/lib/roxml/xml/parsers/nokogiri.rb

@@ -2,35 +2,58 @@ require 'nokogiri'
 
 module ROXML
   module XML # :nodoc:all
-    Document = Nokogiri::XML::Document
-    Element = Nokogiri::XML::Element
-    Node = Nokogiri::XML::Node
 
-    module Error; end
+    class << self
+      def set_attribute(node, name, value)
+        node[name] = value
+      end
 
-    class Parser
-      class << self
-        def parse(string)
-          Nokogiri::XML(string)
-        end
+      def set_content(node, content)
+        node.content = content
+      end
 
-        def parse_file(path) #:nodoc:
-          path = path.sub('file:', '') if path.starts_with?('file:')
-          parse(open(path))
-        end
+      def new_node(name)
+        Nokogiri::XML::Node.new(name, Document.new)
+      end
 
-        def parse_io(stream) #:nodoc:
-          parse(stream)
-        end
+      def add_node(parent, name)
+        add_child(parent, Nokogiri::XML::Node.new(name, parent.document))
       end
-    end
 
-    class Document
-      def save(path)
+      def add_cdata(parent, content)
+        parent.add_child(Nokogiri::XML::CDATA.new(parent.document, content))
+      end
+
+      def add_child(parent, child)
+        parent.add_child(child)
+      end
+
+      def parse_string(string)
+        Nokogiri::XML(string)
+      end
+
+      def parse_file(path)
+        path = path.sub('file:', '') if path.starts_with?('file:')
+        parse_io(open(path))
+      end
+
+      def parse_io(stream)
+        Nokogiri::XML(stream)
+      end
+
+      def save_doc(doc, path)
         open(path, 'w') do |file|
-          file << serialize
+          file << doc.serialize
         end
       end
+    end
+
+    Document = Nokogiri::XML::Document
+    Element = Nokogiri::XML::Element
+    Node = Nokogiri::XML::Node
+
+    class Document
+      alias :roxml_search :search
 
       def default_namespace
         'xmlns' if root.namespaces['xmlns']
@@ -38,13 +61,9 @@ module ROXML
     end
 
     module NodeExtensions
-      def search(xpath, roxml_namespaces = {})
+      def roxml_search(xpath, roxml_namespaces = {})
         xpath = "./#{xpath}"
-        (roxml_namespaces.present? ? super(xpath, roxml_namespaces) : super(xpath)).map {|i| i }
-      end
-
-      def attributes
-        self
+        (roxml_namespaces.present? ? search(xpath, roxml_namespaces) : search(xpath))
       end
 
       def default_namespace
@@ -54,24 +73,10 @@ module ROXML
 
     class Element
       include NodeExtensions
-
-      def empty?
-        children.empty?
-      end
     end
 
     class Node
-      class << self
-        def new_cdata(content)
-          Nokogiri::XML::CDATA.new(Document.new, content)
-        end
-
-        def create(name)
-          new(name, Document.new)
-        end
-      end
       include NodeExtensions
-      alias :remove! :remove
     end
   end
-end
+end