Empact-roxml 2.4.0 → 2.4.1

data/History.txt

@@ -1,3 +1,13 @@
+== 2.4.1 (January 28, 2009)
+
+* 3 minor enhancements
+
+  * remove dependency on 'extensions' gem, as we weren't using it much and it
+    was causing problems for some
+  * deprecate the 'xml' declaration in favor of the more explicit 'xml_reference'
+    declaration.  Reorder params to make for cleaner 3.0 transition.
+  * deprecate '#tag_name' in favor of 'self.class.tag_name', as it's a class-specific value
+
 == 2.4.0 (January 15, 2009)
 
 * 1 major enhancement

data/Rakefile

@@ -9,11 +9,10 @@ $hoe = Hoe.new('roxml', ROXML::VERSION) do |p|
   p.author = ["Ben Woosley", "Zak Mandhro", "Anders Engstrom", "Russ Olsen"]
   p.email = "ben.woosley@gmail.com"
   p.url = "http://roxml.rubyforge.org"
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.changes              = File.read("History.txt").split(/^==/)[1].strip
   p.rubyforge_name       = p.name
   p.extra_deps         = [
-   ['activesupport','>= 2.1.0'],
-   ['extensions', '>= 0.6.0']
+   ['activesupport','>= 2.1.0']
   ]
   p.extra_dev_deps = [
     ['newgem', ">= #{::Newgem::VERSION}"]

data/lib/roxml.rb

@@ -3,7 +3,7 @@
 end
 
 module ROXML # :nodoc:
-  VERSION = '2.4.0'
+  VERSION = '2.4.1'
 
   def self.included(base) # :nodoc:
     base.extend ClassMethods::Accessors,
@@ -18,11 +18,12 @@ module ROXML # :nodoc:
 
   module InstanceMethods # :nodoc:
     # Instance method equivalents of the Class method accessors
-    module Accessors
+    module Accessors # :nodoc:all
       # Provides access to ROXML::ClassMethods::Accessors::tag_name directly from an instance of a ROXML class
       def tag_name
         self.class.tag_name
       end
+      deprecate :tag_name => 'use class.tag_name instead'
 
       # Provides access to ROXML::ClassMethods::Accessors::tag_refs directly from an instance of a ROXML class
       def tag_refs
@@ -72,7 +73,7 @@ module ROXML # :nodoc:
     module Conversions
       # Returns a LibXML::XML::Node or a REXML::Element representing this object
       def to_xml(name = nil)
-        returning XML::Node.new_element(name || tag_name) do |root|
+        returning XML::Node.new_element(name || self.class.tag_name) do |root|
           self.class.roxml_attrs.each do |attr|
             ref = attr.to_ref(self)
             v = ref.to_xml
@@ -232,7 +233,7 @@ module ROXML # :nodoc:
       #
       # Example:
       #  class Book
-      #    xml :author, false, :text => 'Author'
+      #    xml_reader :author, :text => 'Author'
       #    xml_accessor :description, :text, :as => :cdata
       #    xml_reader :title
       #  end
@@ -415,19 +416,24 @@ module ROXML # :nodoc:
       # [:required] If true, throws RequiredElementMissing when the element isn't present
       # [:frozen] If true, all results are frozen (using #freeze) at parse-time.
       #
-      def xml(sym, writable = false, type_and_or_opts = :text, opts = nil, &block)
+      def xml_reference(writable, sym, type_and_or_opts = :text, opts = nil, &block)
         opts = Opts.new(sym, *[type_and_or_opts, opts].compact, &block)
 
         add_accessor(opts, writable)
       end
 
+      def xml(sym, writable = false, type_and_or_opts = :text, opts = nil, &block) #:nodoc:
+        xml_reference(writable, sym, type_and_or_opts, opts, &block)
+      end
+      deprecate :xml => :xml_reference
+
       # Declares a read-only xml reference. See xml for details.
       #
       # Note that while xml_reader does not create a setter for this attribute,
       # its value can be modified indirectly via methods.  For more complete
       # protection, consider the :frozen option.
       def xml_reader(sym, type_and_or_opts = :text, opts = nil, &block)
-        xml sym, false, type_and_or_opts, opts, &block
+        xml_reference false, sym, type_and_or_opts, opts, &block
       end
 
       # Declares a writable xml reference. See xml for details.
@@ -436,11 +442,11 @@ module ROXML # :nodoc:
       # you can use the :frozen option to prevent its value from being
       # modified indirectly via methods.
       def xml_accessor(sym, type_and_or_opts = :text, opts = nil, &block)
-        xml sym, true, type_and_or_opts, opts, &block
+        xml_reference true, sym, type_and_or_opts, opts, &block
       end
 
       # This method is deprecated, please use xml_initialize instead
-      def xml_construct(*args)
+      def xml_construct(*args) # :nodoc:
         present_tags = tag_refs_without_deprecation.map(&:accessor)
         missing_tags = args - present_tags
         unless missing_tags.empty?
@@ -513,7 +519,7 @@ module ROXML # :nodoc:
         (@roxml_attrs + (superclass.try(:roxml_attrs) || [])).freeze
       end
 
-      def tag_refs
+      def tag_refs # :nodoc:
         roxml_attrs.map {|a| a.to_ref(nil) }
       end
       deprecate :tag_refs => :roxml_attrs
@@ -556,7 +562,7 @@ module ROXML # :nodoc:
       end
 
       # Deprecated in favor of #from_xml
-      def parse(data)
+      def parse(data) # :nodoc:
         from_xml(data)
       end
       deprecate :parse => :from_xml

data/lib/roxml/extensions/active_support.rb

@@ -21,9 +21,6 @@ class String
   undef_method :to_xs if method_defined?(:to_xs)
 end
 
-require 'extensions/enumerable'
-require 'extensions/array'
-
 class Module #:nodoc:
   include ActiveSupport::CoreExtensions::Module if ActiveSupport::CoreExtensions.const_defined? :Module
 end

data/lib/roxml/extensions/array/conversions.rb

@@ -1,6 +1,6 @@
 module ROXML
   module CoreExtensions
-    module Array #:nodoc:
+    module Array #:nodoc:all
       module Conversions
         # Translates an array into a hash, where each element of the array is
         # an array with 2 elements:
@@ -15,7 +15,7 @@ module ROXML
             result
           end
           hash.each_pair do |k, v|
-            hash[k] = v.only if v.one?
+            hash[k] = v.first if v.one?
           end
           hash
         end

data/lib/roxml/extensions/string/iterators.rb

@@ -1,6 +1,6 @@
 module ROXML
   module CoreExtensions
-    module String #:nodoc:
+    module String #:nodoc:all
       module Iterators
         # Allows you to iterate over and modify the sub-strings between _separator_.  Returns the joined result of the modification.
         def between(separator, &block)

data/lib/roxml/options.rb

@@ -43,7 +43,7 @@ module ROXML
     def to_hash_args(args, type, name)
       args = [args] unless args.is_a? Array
 
-      if args.one? && !(args.only.keys & HASH_KEYS).empty?
+      if args.one? && !(args.first.keys & HASH_KEYS).empty?
         opts = {type => name}
         if type == :content
           opts[:type] = :text
@@ -245,14 +245,15 @@ module ROXML
       types = (@opts.keys & TYPE_KEYS)
       # type arg
       if args.one? && types.empty?
-        if args.only.is_a? Array
+        type = args.first
+        if type.is_a? Array
           @opts[:as] << :array
-          return args.only.only
-        elsif args.only.is_a? Hash
-          @opts[:hash] = args.only
+          return type.first
+        elsif type.is_a? Hash
+          @opts[:hash] = type
           return :hash
         else
-          return args.only
+          return type
         end
       end
 
@@ -263,8 +264,8 @@ module ROXML
 
       # type options
       if types.one?
-        @opts[:from] = @opts.delete(types.only)
-        types.only
+        @opts[:from] = @opts.delete(types.first)
+        types.first
       elsif types.empty?
         :text
       else

data/roxml.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roxml}
-  s.version = "2.4.0"
+  s.version = "2.4.1"
 
   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-15}
+  s.date = %q{2009-01-28}
   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/rspec.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"]
+  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.has_rdoc = true
   s.homepage = %q{http://roxml.rubyforge.org}
   s.rdoc_options = ["--main", "README.rdoc"]
@@ -26,18 +26,15 @@ Gem::Specification.new do |s|
 
     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<extensions>, [">= 0.6.0"])
       s.add_development_dependency(%q<newgem>, [">= 1.2.3"])
       s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.1.0"])
-      s.add_dependency(%q<extensions>, [">= 0.6.0"])
       s.add_dependency(%q<newgem>, [">= 1.2.3"])
       s.add_dependency(%q<hoe>, [">= 1.8.0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 2.1.0"])
-    s.add_dependency(%q<extensions>, [">= 0.6.0"])
     s.add_dependency(%q<newgem>, [">= 1.2.3"])
     s.add_dependency(%q<hoe>, [">= 1.8.0"])
   end

data/tasks/test.rake

@@ -0,0 +1,42 @@
+# We need to override hoe's test task in order to support separate REXML & LibXML testing
+require  File.join(File.dirname(__FILE__), '../vendor/override_rake_task/lib/override_rake_task')
+
+Rake::TestTask.new(:bugs) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/bugs/*_bugs.rb']
+  t.verbose = true
+end
+
+remove_task :test
+desc "Test ROXML using the default parser selection behavior"
+task :test do
+  module ROXML
+    SILENCE_XML_NAME_WARNING = true
+  end
+  require 'lib/roxml'
+  require 'rake/runtest'
+  Rake.run_tests $hoe.test_globs
+end
+
+namespace :test do
+  desc "Test ROXML under the LibXML parser"
+  task :libxml do
+    module ROXML
+      XML_PARSER = 'libxml'
+    end
+    Rake::Task["test"].invoke
+  end
+
+  desc "Test ROXML under the REXML parser"
+  task :rexml do
+    module ROXML
+      XML_PARSER = 'rexml'
+    end
+    Rake::Task["test"].invoke
+  end
+
+  desc "Runs tests under RCOV"
+  task :rcov do
+    system "rcov -T --no-html -x '^/'  #{FileList[$hoe.test_globs]}"
+  end
+end

data/test/mocks/mocks.rb

@@ -215,7 +215,7 @@ end
 class LibraryWithBooksOfUnderivableName
   include ROXML
 
-  xml :name, true
+  xml_reference true, :name
   xml_reader :novels, NamelessBook, :as => :array
 end
 

data/test/test_helper.rb

@@ -15,7 +15,7 @@ def fixture_path(name)
 end
 
 def to_xml_test(*names)
-  names = names.only if names.one? && names.only.is_a?(Hash)
+  names = names.first if names.one? && names.first.is_a?(Hash)
   names.each do |name, xml_name|
     xml_name ||= name
 

data/test/unit/options_test.rb

@@ -81,13 +81,13 @@ class TestOptions < Test::Unit::TestCase
   end
 
   def test_block_integer_shorthand
-    assert_equal 3, ROXML::Opts.new(:count, :as => :integer).blocks.only['3']
-    assert_equal 3, ROXML::Opts.new(:count, :as => Integer).blocks.only['3']
+    assert_equal 3, ROXML::Opts.new(:count, :as => :integer).blocks.first['3']
+    assert_equal 3, ROXML::Opts.new(:count, :as => Integer).blocks.first['3']
   end
 
   def test_block_float_shorthand
-    assert_equal 3.1, ROXML::Opts.new(:count, :as => :float).blocks.only['3.1']
-    assert_equal 3.1, ROXML::Opts.new(:count, :as => Float).blocks.only['3.1']
+    assert_equal 3.1, ROXML::Opts.new(:count, :as => :float).blocks.first['3.1']
+    assert_equal 3.1, ROXML::Opts.new(:count, :as => Float).blocks.first['3.1']
   end
 
   def test_multiple_shorthands_raises

data/test/unit/xml_name_test.rb

@@ -88,7 +88,7 @@ class TestXMLName < Test::Unit::TestCase
   def test_named_books_picked_up
     named = Library.from_xml(fixture(:library))
     assert named.books
-    assert_equal :book, named.books.first.tag_name
+    assert_equal :book, named.books.first.class.tag_name
   end
 
   def test_nameless_books_missing
@@ -101,25 +101,25 @@ class TestXMLName < Test::Unit::TestCase
 
     dict = DictionaryOfTexts.from_xml(fixture(:dictionary_of_texts))
 
-    assert_equal :dictionary, dict.tag_name
+    assert_equal :dictionary, dict.class.tag_name
   end
 
   def test_tag_refs
-    assert_equal 'definition', DictionaryOfTexts.tag_refs_without_deprecation.only.name
-    assert_equal 'word', DictionaryOfTexts.tag_refs_without_deprecation.only.hash.key.name
-    assert_equal 'meaning', DictionaryOfTexts.tag_refs_without_deprecation.only.hash.value.name
+    assert_equal 'definition', DictionaryOfTexts.tag_refs_without_deprecation.first.name
+    assert_equal 'word', DictionaryOfTexts.tag_refs_without_deprecation.first.hash.key.name
+    assert_equal 'meaning', DictionaryOfTexts.tag_refs_without_deprecation.first.hash.value.name
 
     dict = DictionaryOfTexts.from_xml(fixture(:dictionary_of_texts))
 
-    assert_equal 'definition', dict.tag_refs_without_deprecation.only.name
-    assert_equal 'word', dict.tag_refs_without_deprecation.only.hash.key.name
-    assert_equal 'meaning', dict.tag_refs_without_deprecation.only.hash.value.name
+    assert_equal 'definition', dict.tag_refs_without_deprecation.first.name
+    assert_equal 'word', dict.tag_refs_without_deprecation.first.hash.key.name
+    assert_equal 'meaning', dict.tag_refs_without_deprecation.first.hash.value.name
   end
 
   def test_roxml_attrs
-    assert_equal 'definition', DictionaryOfTexts.roxml_attrs.only.name
-    assert_equal 'word', DictionaryOfTexts.roxml_attrs.only.hash.key.name
-    assert_equal 'meaning', DictionaryOfTexts.roxml_attrs.only.hash.value.name
+    assert_equal 'definition', DictionaryOfTexts.roxml_attrs.first.name
+    assert_equal 'word', DictionaryOfTexts.roxml_attrs.first.hash.key.name
+    assert_equal 'meaning', DictionaryOfTexts.roxml_attrs.first.hash.value.name
   end
 
   def test_xml_name_query_is_deprecated

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Empact-roxml
 version: !ruby/object:Gem::Version 
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors: 
 - Ben Woosley
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-15 00:00:00 -08:00
+date: 2009-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,15 +24,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.1.0
     version: 
-- !ruby/object:Gem::Dependency 
-  name: extensions
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.6.0
-    version: 
 - !ruby/object:Gem::Dependency 
   name: newgem
   version_requirement: 
@@ -83,7 +74,7 @@ files:
 - lib/roxml/xml/libxml.rb
 - lib/roxml/xml/rexml.rb
 - roxml.gemspec
-- tasks/rspec.rake
+- tasks/test.rake
 - test/bugs/rexml_bugs.rb
 - test/fixtures/book_malformed.xml
 - test/fixtures/book_pair.xml
@@ -139,6 +130,10 @@ files:
 - 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
 has_rdoc: true
 homepage: http://roxml.rubyforge.org
 post_install_message: