jimmyz-happymapper 0.3.1

data/History

@@ -0,0 +1,62 @@
+== 0.3.1
+* 1 minor tweak
+	* Added to_xml and namespace_url code to the family_tree.rb example
+
+== 0.3.0
+* 5 major enhancements, 2 minor enhancements, 1 bug fixes
+  * to_xml methods attach namespaces to the root element and add the namespaces to the elements (if a namespace_url is specified) 
+	* Modified namespace method to accept a hash {'prefix' => 'http://example.com/v1'} OR 'prefix'
+	* Added namespace_url method to set and read a full namespace URL. This adds much better stability in case prefixes change.
+	* Added to_xml method to HappyMapper Module to serialize objects to string
+	* Added to_xml_node method to HappyMapper Module to serialize objects to LibXML::XML::Node 
+	* Full support for creating happymapper elements from scratch. has_many instance vars default to []
+	* Support for has_many with a primitive type (String, Boolean, etc.)
+	* fix for issue #8: http://jnunemaker.lighthouseapp.com/projects/20014-happy-mapper/tickets/8
+
+== 0.2.2
+* 2 minor tweaks
+  * removed GC.start (libxml recommended this) as setting nodes to nil should be enough, specs run 3-4x faster (Brandon Keepers)
+  * renamed get_tag_name to tag_name (Brandon Keepers)
+  * removed libxml helpers as they are no longer needed
+  
+== 0.2.1
+* 1 minor fix, 3 major enhancements
+  * fixed warnings about using XML::Parser (mojodna)
+  * Improved namespace support, now handles multiple namespaces and allows namespaces to be set item wide or on a per element basis (mojodna)
+  * Auto detect root nodes (mojodna)
+  * Type coercion (mojodna)
+  
+== 0.2.0
+* 1 major enhancement, 2 minor ehancements
+  * Automatic handling of namespaces (part by Robert Lowrey and rest by John Nunemaker)
+  * Added :root option to tag method. This allows setting an object as the root element, which sets xpath to use / and sets single to true
+  * Now defaulting tag names for classes in modules to last constant downcased
+  
+== 0.1.7 2009-01-29
+* 1 minor enhancement
+  * Support dashes in elements (Josh Nichols)
+  
+== 0.1.6 2009-01-17
+* 1 minor enhancement:
+  * added support for nested collection elements (Justin Marney)
+
+== 0.1.5 2009-01-05
+* 1 major enhancement:
+  * Updated to latest version of libxml-ruby (lightningdb)
+  
+== 0.1.4 2009-01-05
+* 1 major enhancement:
+  * Fixed parsing when the object is the root node. (Garret Alfert)
+
+== 0.1.3 2008-12-31
+* 1 major enhancement:
+  * Added parsing of attributes of elements that are also mapped, see current_weather.rb for example (jeremyf)
+
+== 0.1.2 2008-12-12
+* 1 major enhancement:
+  * Fixed that :deep only worked for first item (dvrensk)
+  
+== 0.1.0 2008-11-16
+
+* 1 major enhancement:
+  * Initial release

data/License

@@ -0,0 +1,20 @@
+Copyright (c) 2008 John Nunemaker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,40 @@
+examples/amazon.rb
+examples/current_weather.rb
+examples/dashed_elements.rb
+examples/family_tree.rb
+examples/post.rb
+examples/twitter.rb
+happymapper.gemspec
+History
+lib/happymapper/attribute.rb
+lib/happymapper/element.rb
+lib/happymapper/item.rb
+lib/happymapper/version.rb
+lib/happymapper.rb
+License
+Manifest
+Rakefile
+README
+spec/fixtures/address.xml
+spec/fixtures/commit.xml
+spec/fixtures/current_weather.xml
+spec/fixtures/family_tree.xml
+spec/fixtures/multiple_namespaces.xml
+spec/fixtures/partial_posts.xml
+spec/fixtures/pita.xml
+spec/fixtures/posts.xml
+spec/fixtures/product_default_namespace.xml
+spec/fixtures/product_no_namespace.xml
+spec/fixtures/product_single_namespace.xml
+spec/fixtures/radar.xml
+spec/fixtures/statuses.xml
+spec/happymapper_attribute_spec.rb
+spec/happymapper_element_spec.rb
+spec/happymapper_item_spec.rb
+spec/happymapper_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/xml_helper.rb
+TODO
+website/css/common.css
+website/index.html

data/README

@@ -0,0 +1,26 @@
+= happymapper
+
+== DESCRIPTION:
+
+Object to xml mapping library. I have included examples to help get you going. The specs
+should also point you in the right direction.
+
+== FEATURES:
+
+* Easy to define xml attributes and elements for an object
+* Fast because it uses libxml-ruby under the hood
+* Automatic conversion of xml to defined objects
+
+== SYNOPSIS:
+
+See examples directory in the gem to get a feel for how it works.
+
+== INSTALL:
+
+* add github to your sources if you haven't gem sources -a http://gems.github.com
+* sudo gem install jnunemaker-happymapper
+* sudo gem install happymapper (when rubyforge approves and i release there)
+
+== TICKETS:
+
+http://jnunemaker.lighthouseapp.com/projects/20014-happy-mapper/overview

data/Rakefile

@@ -0,0 +1,43 @@
+ProjectName = 'happymapper'
+WebsitePath = "jnunemaker@rubyforge.org:/var/www/gforge-projects/#{ProjectName}"
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'spec/rake/spectask'
+require "lib/#{ProjectName}/version"
+
+Echoe.new(ProjectName, HappyMapper::Version) do |p|
+  p.description     = "object to xml mapping library"
+  p.install_message = "May you have many happy mappings!"
+  p.url             = "http://#{ProjectName}.rubyforge.org"
+  p.author          = "John Nunemaker"
+  p.email           = "nunemaker@gmail.com"
+  p.extra_deps      = [['libxml-ruby', '= 0.9.8']]
+  p.need_tar_gz     = false
+  p.docs_host       = WebsitePath
+end
+
+desc 'Upload website files to rubyforge'
+task :website do
+  sh %{rsync -av website/ #{WebsitePath}}
+  Rake::Task['website_docs'].invoke
+end
+
+task :website_docs do
+  Rake::Task['redocs'].invoke
+  sh %{rsync -av doc/ #{WebsitePath}/docs}
+end
+
+desc 'Preps the gem for a new release'
+task :prepare do
+  %w[manifest build_gemspec].each do |task|
+    Rake::Task[task].invoke
+  end
+end
+
+Rake::Task[:default].prerequisites.clear
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/examples/amazon.rb

@@ -0,0 +1,34 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'happymapper')
+
+file_contents = File.read(dir + '/../spec/fixtures/pita.xml')
+
+# The document `pita.xml` contains both a default namespace and the 'georss'
+# namespace (for the 'point' element).
+module PITA
+  class Item
+    include HappyMapper
+    
+    tag 'Item' # if you put class in module you need tag
+    element :asin, String, :tag => 'ASIN'
+    element :detail_page_url, String, :tag => 'DetailPageURL'
+    element :manufacturer, String, :tag => 'Manufacturer', :deep => true
+    # this is the only element that exists in a different namespace, so it
+    # must be explicitly specified
+    element :point, String, :tag => 'point', :namespace => 'georss'
+  end
+
+  class Items
+    include HappyMapper
+    
+    tag 'Items' # if you put class in module you need tag
+    element :total_results, Integer, :tag => 'TotalResults'
+    element :total_pages, Integer, :tag => 'TotalPages'
+    has_many :items, Item
+  end
+end
+
+item = PITA::Items.parse(file_contents, :single => true)
+item.items.each do |i|
+  puts i.asin, i.detail_page_url, i.manufacturer, ''
+end

data/examples/current_weather.rb

@@ -0,0 +1,21 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'happymapper')
+
+file_contents = File.read(dir + '/../spec/fixtures/current_weather.xml')
+
+class CurrentWeather
+  include HappyMapper
+  
+  tag 'ob'
+  namespace 'aws'
+  element :temperature, Integer, :tag => 'temp'
+  element :feels_like, Integer, :tag => 'feels-like'
+  element :current_condition, String, :tag => 'current-condition', :attributes => {:icon => String}
+end
+
+CurrentWeather.parse(file_contents).each do |current_weather|
+  puts "temperature: #{current_weather.temperature}"
+  puts "feels_like: #{current_weather.feels_like}"
+  puts "current_condition: #{current_weather.current_condition}"
+  puts "current_condition.icon: #{current_weather.current_condition.icon}"
+end

data/examples/dashed_elements.rb

@@ -0,0 +1,20 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'happymapper')
+
+file_contents = File.read(dir + '/../spec/fixtures/commit.xml')
+
+module GitHub
+  class Commit
+    include HappyMapper
+
+    tag "commit"
+    element :url, String
+    element :tree, String
+    element :message, String
+    element :id, String
+    element :'committed-date', Date
+  end
+end
+
+commit = GitHub::Commit.parse(file_contents)
+puts commit.committed_date, commit.url, commit.id

data/examples/family_tree.rb

@@ -0,0 +1,55 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'happymapper')
+
+file_contents = File.read(dir + '/../spec/fixtures/family_tree.xml')
+
+module FamilySearch
+  class AlternateIds
+    include HappyMapper
+    
+    tag 'alternateIds'
+    namespace 'fsapi-v1' => 'http://api.familysearch.org/v1'
+    has_many :ids, String, :tag => 'id'
+  end
+  
+  class Information
+    include HappyMapper
+    
+    namespace 'fsapi-v1' => 'http://api.familysearch.org/v1'
+    has_one :alternateIds, AlternateIds
+  end
+  
+  class Person
+    include HappyMapper
+    
+    namespace_url 'http://api.familysearch.org/familytree/v1'
+    attribute :version, String
+    attribute :modified, Time
+    attribute :id, String
+    has_one :information, Information
+  end
+  
+  class Persons
+    include HappyMapper
+    
+    namespace_url 'http://api.familysearch.org/familytree/v1'
+    has_many :person, Person
+  end
+  
+  class FamilyTree
+    include HappyMapper
+    
+    tag 'familytree'
+    namespace_url 'http://api.familysearch.org/familytree/v1'
+    attribute :version, String
+    attribute :status_message, String, :tag => 'statusMessage'
+    attribute :status_code, String, :tag => 'statusCode'
+    has_one :persons, Persons
+  end
+end
+
+familytree = FamilySearch::FamilyTree.parse(file_contents)
+familytree.persons.person.each do |p|
+  puts p.id, p.information.alternateIds.ids, ''
+end
+puts familytree.to_xml

data/examples/post.rb

@@ -0,0 +1,19 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'happymapper')
+
+file_contents = File.read(dir + '/../spec/fixtures/posts.xml')
+
+class Post
+  include HappyMapper
+  
+  attribute :href, String
+  attribute :hash, String
+  attribute :description, String
+  attribute :tag, String
+  attribute :time, DateTime
+  attribute :others, Integer
+  attribute :extended, String
+end
+
+posts = Post.parse(file_contents)
+posts.each { |post| puts post.description, post.href, post.extended, '' }

data/examples/twitter.rb

@@ -0,0 +1,37 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'happymapper')
+
+file_contents = File.read(dir + '/../spec/fixtures/statuses.xml')
+
+class User
+  include HappyMapper
+  
+  element :id, Integer
+  element :name, String
+  element :screen_name, String
+  element :location, String
+  element :description, String
+  element :profile_image_url, String
+  element :url, String
+  element :protected, Boolean
+  element :followers_count, Integer
+end
+
+class Status
+  include HappyMapper
+  
+  element :id, Integer
+  element :text, String
+	element :created_at, Time
+	element :source, String
+	element :truncated, Boolean
+	element :in_reply_to_status_id, Integer
+	element :in_reply_to_user_id, Integer
+	element :favorited, Boolean
+	has_one :user, User
+end
+
+statuses = Status.parse(file_contents)
+statuses.each do |status|
+  puts status.user.name, status.user.screen_name, status.text, status.source, ''
+end

data/happymapper.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{happymapper}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Nunemaker"]
+  s.date = %q{2009-02-19}
+  s.description = %q{object to xml mapping library}
+  s.email = %q{nunemaker@gmail.com}
+  s.extra_rdoc_files = ["lib/happymapper/attribute.rb", "lib/happymapper/element.rb", "lib/happymapper/item.rb", "lib/happymapper/version.rb", "lib/happymapper.rb", "README", "TODO"]
+  s.files = ["examples/amazon.rb", "examples/current_weather.rb", "examples/dashed_elements.rb", "examples/family_tree.rb", "examples/post.rb", "examples/twitter.rb", "happymapper.gemspec", "History", "lib/happymapper/attribute.rb", "lib/happymapper/element.rb", "lib/happymapper/item.rb", "lib/happymapper/version.rb", "lib/happymapper.rb", "License", "Manifest", "Rakefile", "README", "spec/fixtures/address.xml", "spec/fixtures/commit.xml", "spec/fixtures/current_weather.xml", "spec/fixtures/family_tree.xml", "spec/fixtures/multiple_namespaces.xml", "spec/fixtures/partial_posts.xml", "spec/fixtures/pita.xml", "spec/fixtures/posts.xml", "spec/fixtures/product_default_namespace.xml", "spec/fixtures/product_no_namespace.xml", "spec/fixtures/product_single_namespace.xml", "spec/fixtures/radar.xml", "spec/fixtures/statuses.xml", "spec/happymapper_attribute_spec.rb", "spec/happymapper_element_spec.rb", "spec/happymapper_item_spec.rb", "spec/happymapper_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/xml_helper.rb", "TODO", "website/css/common.css", "website/index.html"]
+  s.has_rdoc = true
+  s.homepage = %q{http://happymapper.rubyforge.org}
+  s.post_install_message = %q{May you have many happy mappings!}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Happymapper", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{happymapper}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{object to xml mapping library}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<libxml-ruby>, ["= 0.9.8"])
+    else
+      s.add_dependency(%q<libxml-ruby>, ["= 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<libxml-ruby>, ["= 0.9.8"])
+  end
+end

data/lib/happymapper.rb

@@ -0,0 +1,191 @@
+dir = File.dirname(__FILE__)
+$:.unshift(dir) unless $:.include?(dir) || $:.include?(File.expand_path(dir))
+
+require 'date'
+require 'time'
+require 'rubygems'
+gem 'libxml-ruby', '= 0.9.8'
+require 'xml'
+
+class Boolean; end
+
+module HappyMapper
+
+  DEFAULT_NS = "happymapper"
+
+  def self.included(base)
+    base.instance_variable_set("@attributes", {})
+    base.instance_variable_set("@elements", {})
+    base.extend ClassMethods
+  end
+  
+  def to_xml
+    node = to_xml_node
+    node.to_s
+  end
+  
+  def to_xml_node(root_node = nil)
+    node = XML::Node.new(self.class.tag_name)
+    root_node ||= node
+    if self.class.namespace_url
+      if root_node
+        namespace_object = root_node.namespaces.find_by_href(self.class.namespace_url)
+        namespace_object ||= XML::Namespace.new root_node, self.class.namespace, self.class.namespace_url
+        node.namespaces.namespace = namespace_object
+      end
+    else
+      nil
+    end
+    self.class.elements.each do |e|
+      if e.options[:single] == false
+        self.send("#{e.method_name}").each do |array_element|
+          node << e.to_xml_node(array_element,root_node)
+        end
+      else
+        node << e.to_xml_node(self.send("#{e.method_name}"),root_node)
+      end
+    end
+    self.class.attributes.each do |a|
+      attribute_value = self.send("#{a.method_name}")
+      node.attributes[a.tag] = attribute_value.to_s unless attribute_value.nil? 
+    end
+    node
+  end
+
+  module ClassMethods
+    def attribute(name, type, options={})
+      attribute = Attribute.new(name, type, options)
+      @attributes[to_s] ||= []
+      @attributes[to_s] << attribute
+      attr_accessor attribute.method_name.intern
+    end
+
+    def attributes
+      @attributes[to_s] || []
+    end
+
+    def element(name, type, options={})
+      options = {:namespace => @namespace}.merge(options)
+      element = Element.new(name, type, options)
+      @elements[to_s] ||= []
+      @elements[to_s] << element
+      attr_accessor element.method_name.intern
+      
+      # set the default value of a collection instance variable to [] instead of nil
+      if options[:single] == false
+        module_eval <<-eof
+          def #{element.method_name}
+            @#{element.method_name} ||= []
+          end
+        eof
+      end
+    end
+
+    def elements
+      @elements[to_s] || []
+    end
+
+    def has_one(name, type, options={})
+      element name, type, {:single => true}.merge(options)
+    end
+
+    def has_many(name, type, options={})
+      element name, type, {:single => false}.merge(options)
+    end
+
+    # Specify a namespace if a node and all its children are all namespaced
+    # elements. This is simpler than passing the :namespace option to each
+    # defined element.
+    #
+    # namespace can either be a string for the prefix or a hash with 'prefix' => 'url'
+    def namespace(namespace = nil)
+      if namespace
+        if namespace.is_a? Hash
+          namespace.each_pair do |k,v|
+            @namespace = k.to_s
+            @namespace_url = v
+          end
+        else  
+          @namespace = namespace 
+        end
+      end
+      @namespace
+    end
+    
+    def namespace_url(url = nil)
+      @namespace_url = url if url
+      @namespace_url
+    end
+
+    def tag(new_tag_name)
+      @tag_name = new_tag_name.to_s
+    end
+
+    def tag_name
+      @tag_name ||= to_s.split('::')[-1].downcase
+    end
+
+    def parse(xml, options = {})
+      # locally scoped copy of namespace for this parse run
+      namespace = @namespace
+
+      if xml.is_a?(XML::Node)
+        node = xml
+      else
+        if xml.is_a?(XML::Document)
+          node = xml.root
+        else
+          node = XML::Parser.string(xml).parse.root
+        end
+
+        root = node.name == tag_name
+      end
+
+      # This is the entry point into the parsing pipeline, so the default
+      # namespace prefix registered here will propagate down
+      namespaces = node.namespaces
+      if @namespace_url && namespaces.default.href != @namespace_url
+        namespace = namespaces.find_by_href(@namespace_url).prefix
+      elsif namespaces && namespaces.default
+        # don't assign the default_prefix if it has already been assigned
+        namespaces.default_prefix = DEFAULT_NS unless namespaces.find_by_prefix(DEFAULT_NS)
+        namespace ||= DEFAULT_NS
+      end
+
+      xpath = root ? '/' : './/'
+      xpath += "#{namespace}:" if namespace
+      xpath += tag_name
+      # puts "parse: #{xpath}"
+
+      nodes = node.find(xpath)
+      collection = nodes.collect do |n|
+        obj = new
+
+        attributes.each do |attr|
+          obj.send("#{attr.method_name}=",
+                    attr.from_xml_node(n, namespace))
+        end
+
+        elements.each do |elem|
+          obj.send("#{elem.method_name}=",
+                    elem.from_xml_node(n, namespace))
+        end
+
+        obj
+      end
+
+      # per http://libxml.rubyforge.org/rdoc/classes/LibXML/XML/Document.html#M000354
+      nodes = nil
+
+      if options[:single] || root
+        collection.first
+      else
+        collection
+      end
+    end
+  end
+end
+
+require 'happymapper/item'
+require 'happymapper/attribute'
+require 'happymapper/element'