roxml 2.3.2 → 2.4.0

data/History.txt

@@ -0,0 +1,145 @@
+== 2.4.0 (January 15, 2009)
+
+* 1 major enhancement
+
+  * Add xml_convention to enable easy defaulting to common naming formats, such as camel-case and
+    underscored [Ben Woosley]
+
+* 6 minor enhancements
+
+  * Add :frozen option for freezing values on parse [Ben Woosley]
+  * Attempt to minimize node creation by better matching wrappers [Ben Woosley]
+  * Preserve hash values where a single key maps to multiple values, return them as an array rather
+    any single one of them at random (as in group_by rather than index_by) [Ben Woosley]
+  * Deprecate #xml_name? as it's only used for triggering the xml_name warning [Ben Woosley]
+  * REXML parser ignores whitespace, which doesn't matter to us anyway [Ben Woosley]
+  * xml_name is inherited by default [Ben Woosley]
+
+* 2 bug fixes
+
+  * Don't detect objects which define their own empty? as being absent for the purposes
+    of :default and :required [Ben Woosley]
+  * Sub-objects pick up their parent's attributes, even if they're added after
+    the child's use [Ben Woosley]
+
+== 2.3.2 (December 11, 2008)
+
+* Fix that both false and nil values were excluded from to_xml output, when only nil values should be [Ben Woosley]
+
+== 2.3.1 (December 9, 2008)
+
+* Add missing dependencies to extensions/enumerable and Symbol.to_proc,
+  which are as-yet inexplicably pre-included on my system... [Ben Woosley, Per Melin]
+
+== 2.3 (December 7, 2008)
+
+* Fix a bug in the application of blocks to array types [Ben Woosley]
+
+* Objects now inherit xml attributes from their parents, as they should [Ben Woosley, Per Melin]
+
+* Add #xml_initialize, which is called at the end of #from_xml, after the xml attributes
+  are set. Deprecate the half-baked xml_construct in it's favor. [Ben Woosley]
+
+* Fix a bug in the handling of empty Hash types [Ben Woosley]
+
+* Implement automatic bool-ification when the accessor name ends with ?. [Ben Woosley]
+
+* Add missing dependency ActiveSupport [Ben Woosley]
+
+* Remove support for installing as a rails plugin [Ben Woosley]
+
+* Fix a bug where xml_construct was using the refs' names rather than their accessor names for comparison [Ben Woosley]
+
+* Significantly reduce our footprint by selectively including smaller parts of ActiveSupport and Extensions.
+  This avoids problems such as the conflict between ActiveSupport's #to_json and the JSON gem's #to_json.
+  Thanks to Per Melin for reporting this problem. [Ben Woosley]
+
+* Rationalize sub-element xml naming by enforcing the following precedence for the containing xml of an object:
+  :from of parent, xml_name of child, parent's accessor name.  The previous fallback did not include xml_name.
+  This new behavior is more consistent, explicit, predictable, and DRY, but it is a breaking change, so a warning
+  is printed to alert others of this behavior change. ROXML::SILENCE_XML_NAME_WARNING may be used to deactivate this
+  warning. [Ben Woosley, James W. Thompson, Delynn Berry]
+
+== 2.2 (November 2, 2008)
+
+* fix gem dependencies [James Healy]
+
+* Add block shorthands for Float and Integer, which precede the block argume if present [Ben Woosley]
+
+* Add :required option to throw on absence [Ben Woosley]
+
+* Deprecate the non-specific #parse in favor of #from_xml [Ben Woosley]
+
+* Fix a bug whereby the default value was carrying over information from one object to another [James Healy, Ben Woosley]
+
+* Fix support for :in on :attr elements [Ben Woosley]
+
+* Deprecate Array#to_h in favor of Array#to_hash [Ben Woosley]
+
+* Deprecate Object#to_latin and Object#to_utf in favor of the same methods on String [Ben Woosley]
+
+== 2.1 (October 3, 2008)
+
+* rake test now uses the default parser selection [Ben Woosley]
+
+* Added rcov code coverage for tests [Anders Engström]
+
+* Accommodate that libxml requires you to name the default namespace when available [Ben Woosley]
+
+* Enable optional selection of a parser through the early definition of ROXML::XML_PARSER
+  [Ben Woosley]
+
+* Enable fallback to the REXML parser if LibXML is unavailable [Ben Woosley]
+
+== 2.0 (September 20, 2008)
+
+* :text_content becomes simply :content, and is joined by :name  [Ben Woosley]
+
+* Allow hash mapping from node names and contents: [Ben Woosley]
+
+  xml_reader :name, {:key => :name,
+                     :value => :content}, :in => 'container'
+
+* Allow supplying a default via the :else option [Ben Woosley]
+
+* Allow hash mapping of text and attr elements: [Ben Woosley]
+
+  xml_reader :name, {:key => {:text => 'key_name'},
+                     :value => {:attr => 'attr_name'}}, :in => 'container'
+
+* Allow 'xml_reader :name, [Type]' as an alternative to 'xml_reader :name, Type, :as => :array'
+  [Ben Woosley]
+
+* Allow attaching a block for manipulating a value on fetch: [Ben Woosley]
+
+  xml_accessor :count, :attr => 'my_int' do |val|
+    Integer(val)
+  end
+
+* Collapse xml_attr, xml_text and xml_object into a single api: xml, patterned after the standard
+  attr, and offer xml_reader and xml_accessor as well.  Remove the :readonly arg in the process
+  [Ben Woosley]
+
+* Attach string extensions (#to_latin, #to_utf) to Object rather than String, so we don't have to
+  call #to_s first every time [Ben Woosley]
+
+* Allow a ROXML object to call its constructor on initialization with the xml_construct function
+  [Ben Woosley]
+
+* Use symbols (e.g. :text_content) rather than TAG_CONSTANTS (e.g. TEXT_CONTENT) for readability
+  [Ben Woosley]
+
+* Use named arguments (e.g. :as, :in) rather than positional for clarity,
+  position-independence, and invisible exclusion [Ben Woosley]
+
+* Split out rails_plugin_package_task_gem [Ben Woosley]
+
+* Increase testing significantly, particularly on new functionality & to_xml [Ben Woosley]
+
+== 1.2 (October 10, 2007)
+
+* Fix a bug such that the TEXT_CONTENT tag is no longer also READ_ONLY [Russ Olsen]
+
+== 1.1 (September 24, 2006)
+
+* Initial design & development [Zak Mandhro & Anders Engstrom]

data/Manifest.txt

@@ -0,0 +1,81 @@
+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

data/Rakefile

@@ -1,100 +1,90 @@
-# Rake libraries used
-require "rubygems"
-require "rake/rdoctask"
-require "rake/contrib/rubyforgepublisher"
-require "rake/contrib/publisher"
-require 'rake/gempackagetask'
-require 'rake/testtask'
-
-# load settings
-spec = eval(IO.read("roxml.gemspec"))
-
-# Provide the username used to upload website etc.
-RubyForgeConfig = {
-  :unix_name=>"roxml",
-  :user_name=>"zakmandhro"
-}
-
-task :default => :test
-
-Rake::RDocTask.new do |rd|
-  rd.rdoc_dir = "doc"
-  rd.rdoc_files.include('MIT-LICENSE', 'README.rdoc', "lib/**/*.rb")
-  rd.options << '--main' << 'README.rdoc' << '--title' << 'ROXML Documentation'
+ENV['RUBY_FLAGS'] = '-W1'
+
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.join(File.dirname(__FILE__), 'lib/roxml')
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$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.rubyforge_name       = p.name.upcase
+  p.extra_deps         = [
+   ['activesupport','>= 2.1.0'],
+   ['extensions', '>= 0.6.0']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.summary = "Ruby Object to XML mapping library"
+  p.description = <<EOF
+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.
+EOF
+
+  p.test_globs = 'test/unit/*_test.rb'
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
 end
 
-desc "Publish Ruby on Rails plug-in on RubyForge"
-task :release_plugin=>:rails_plugin do |task|
-  pub = Rake::SshDirPublisher.new("#{RubyForgeConfig[:user_name]}@rubyforge.org",
-      "/var/www/gforge-projects/#{RubyForgeConfig[:unix_name]}",
-      "pkg/rails_plugin")
-  pub.upload()
-end
+require 'newgem/tasks' # load /tasks/*.rake
 
-desc "Publish and plugin site on RubyForge"
-task :publish do |task|
-  pub = Rake::RubyForgePublisher.new(RubyForgeConfig[:unix_name], RubyForgeConfig[:user_name])
-  pub.upload()
-end
-
-desc "Install the gem"
-task :install => [:package] do
-  sh %{sudo gem install pkg/#{spec.name}-#{spec.version}}
-end
-
-Rake::TestTask.new(:bugs) do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/bugs/*_bugs.rb']
-  t.verbose = true
-end
+Dir['tasks/**/*.rake'].each { |t| load t }
 
-@test_files = 'test/unit/*_test.rb'
-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 @test_files
-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[@test_files]}"
-  end
-end
-
-desc "Create the ZIP package"
-Rake::PackageTask.new(spec.name, spec.version) do |p|
-  p.need_zip = true
-  p.package_files = FileList[
-    "lib/**/*.rb", "*.txt", "README.rdoc", "Rakefile",
-    "rake/**/*","test/**/*.rb", "test/**/*.xml", "html/**/*"]
-end
-
-task :package=>:rdoc
-task :rdoc=>:test
-
-desc "Create a RubyGem project"
-Rake::GemPackageTask.new(spec).define
+task :default => :test
 
-desc "Clobber generated files"
-task :clobber=>[:clobber_package, :clobber_rdoc]
+## Provide the username used to upload website etc.
+#RubyForgeConfig = {
+#  :unix_name=>"roxml",
+#  :user_name=>"zakmandhro"
+#}
+
+#Rake::RDocTask.new do |rd|
+#  rd.rdoc_dir = "doc"
+#  rd.rdoc_files.include('MIT-LICENSE', 'README.rdoc', "lib/**/*.rb")
+#  rd.options << '--main' << 'README.rdoc' << '--title' << 'ROXML Documentation'
+#end
+#
+#desc "Publish Ruby on Rails plug-in on RubyForge"
+#task :release_plugin=>:rails_plugin do |task|
+#  pub = Rake::SshDirPublisher.new("#{RubyForgeConfig[:user_name]}@rubyforge.org",
+#      "/var/www/gforge-projects/#{RubyForgeConfig[:unix_name]}",
+#      "pkg/rails_plugin")
+#  pub.upload()
+#end
+#
+#desc "Publish and plugin site on RubyForge"
+#task :publish do |task|
+#  pub = Rake::RubyForgePublisher.new(RubyForgeConfig[:unix_name], RubyForgeConfig[:user_name])
+#  pub.upload()
+#end
+#
+#desc "Install the gem"
+#task :install => [:package] do
+#  sh %{sudo gem install pkg/#{spec.name}-#{spec.version}}
+#end
+
+#desc "Create the ZIP package"
+#Rake::PackageTask.new(spec.name, spec.version) do |p|
+#  p.need_zip = true
+#  p.package_files = FileList[
+#    "lib/**/*.rb", "*.txt", "README.rdoc", "Rakefile",
+#    "rake/**/*","test/**/*.rb", "test/**/*.xml", "html/**/*"]
+#end
+#
+#task :package=>:rdoc
+#task :rdoc=>:test
+#
+#desc "Create a RubyGem project"
+#Rake::GemPackageTask.new(spec).define
+#
+#desc "Clobber generated files"
+#task :clobber=>[:clobber_package, :clobber_rdoc]

data/TODO

@@ -0,0 +1,42 @@
+Planned:
+
+v 2.5
+ * Test out compatibility with ActiveRecord such that it's easy
+   to have both xml & database-sourced objects
+
+ * provide an overridable extension point for the #to_xml-ing of
+   values.  This would enable easy accommodation of non-standard formats.
+   For example, formatting a number with leading zeros.
+
+ * Ensure (perhaps optionally) that references are unambiguous. That is error/warn
+   a singular specification has multiple possible node references
+
+ * Ensure support for nodes which aren't merely children, which hang out deep
+   in the file, but are accessible via xpath
+
+v 3.0
+ * remove deprecated functionality
+
+ * Perhaps provide cleaner separation between the specification
+   of type vs its source in the XML.  For example,
+
+     xml_reader :count, :from => 'Count, :in => 'Attributes', :as => Integer
+     xml_reader :count, :attr => 'Count, :in => 'Attributes', :as => Integer
+
+   become:
+
+     xml_reader :count, Integer, 'Atributes/Count'
+     xml_reader :count, Integer, 'Atributes/@Count'
+
+   potentially backward-incompatible change.  Needs some thought...
+
+ * Back with XmlSimple/FasterXmlSimple to minimize need for specifications
+
+ * Use lazy evaluation to minimize parsing time for large files
+
+Potential:
+
+ * Add shorthand support to hash declaration
+
+ * :as => :self for sending method_missing to this attribute
+