jnunemaker-happymapper 0.1.2

data/History.txt

@@ -0,0 +1,8 @@
+== 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.txt

@@ -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.txt

@@ -0,0 +1,39 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+TODO.txt
+config/hoe.rb
+config/requirements.rb
+examples/amazon.rb
+examples/post.rb
+examples/twitter.rb
+happymapper.gemspec
+lib/happymapper.rb
+lib/happymapper/attribute.rb
+lib/happymapper/element.rb
+lib/happymapper/item.rb
+lib/happymapper/version.rb
+lib/libxml_ext/libxml_helper.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/fixtures/pita.xml
+spec/fixtures/posts.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
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+website/css/common.css
+website/index.html

data/README.txt

@@ -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,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/TODO.txt

@@ -0,0 +1,2 @@
+* doesn't do xml namespaces really (does work with default namespace though)
+* switch gem management to echoe as i did with httparty

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'happymapper/version'
+
+AUTHOR = 'John Nunemaker'  # can also be an array of Authors
+EMAIL = "nunemaker@gmail.com"
+DESCRIPTION = "object to xml mapping library"
+GEM_NAME = 'happymapper' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'happymapper' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['libxml-ruby', '>= 0.8.3']
+]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = HappyMapper::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'happymapper documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/examples/amazon.rb

@@ -0,0 +1,29 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'happymapper')
+
+file_contents = File.read(dir + '/../spec/fixtures/pita.xml')
+
+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
+  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, :use_default_namespace => true)
+item.items.each do |i|
+  puts i.asin, i.detail_page_url, i.manufacturer, ''
+end

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.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Nunemaker"]
+  s.date = %q{2008-12-12}
+  s.description = %q{object to xml mapping library}
+  s.email = ["nunemaker@gmail.com"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "TODO.txt"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "Rakefile", "TODO.txt", "config/hoe.rb", "config/requirements.rb", "examples/amazon.rb", "examples/post.rb", "examples/twitter.rb", "happymapper.gemspec", "lib/happymapper.rb", "lib/happymapper/attribute.rb", "lib/happymapper/element.rb", "lib/happymapper/item.rb", "lib/happymapper/version.rb", "lib/libxml_ext/libxml_helper.rb", "script/console", "script/destroy", "script/generate", "script/txt2html", "setup.rb", "spec/fixtures/pita.xml", "spec/fixtures/posts.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", "tasks/deployment.rake", "tasks/environment.rake", "tasks/rspec.rake", "tasks/website.rake", "website/css/common.css", "website/index.html"]
+  s.has_rdoc = true
+  s.homepage = %q{http://happymapper.rubyforge.org}
+  s.post_install_message = %q{}
+  s.rdoc_options = ["--main", "README.txt"]
+  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_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/lib/happymapper/attribute.rb

@@ -0,0 +1,3 @@
+module HappyMapper
+  class Attribute < Item; end
+end

data/lib/happymapper/element.rb

@@ -0,0 +1,3 @@
+module HappyMapper
+  class Element < Item; end
+end

data/lib/happymapper/item.rb

@@ -0,0 +1,86 @@
+module HappyMapper
+  class Item
+    attr_accessor :type, :tag, :options
+    attr_reader :name
+    
+    Types = [String, Float, Time, Date, DateTime, Integer, Boolean]
+    
+    # options:
+    #   :deep   =>  Boolean False to only parse element's children, True to include
+    #               grandchildren and all others down the chain (// in expath)
+    #   :single =>  Boolean False if object should be collection, True for single object
+    def initialize(name, type, o={})
+      self.name, self.type, self.tag = name, type, o.delete(:tag) || name.to_s
+      self.options = {:single => false, :deep => false}.merge(o)
+      @xml_type = self.class.to_s.split('::').last.downcase
+    end
+    
+    def name=(new_name)
+      @name = new_name.to_s
+    end
+        
+    def from_xml_node(node, namespace=nil)
+      if primitive?
+        typecast(value_from_xml_node(node, namespace))
+      else
+        use_default_namespace = !namespace.nil?
+        type.parse(node, options.merge(:use_default_namespace => use_default_namespace))
+      end
+    end
+    
+    def primitive?
+      Types.include?(type)
+    end
+    
+    def element?
+      @xml_type == 'element'
+    end
+    
+    def attribute?
+      !element?
+    end
+    
+    def typecast(value)
+      return value if value.kind_of?(type) || value.nil?
+      begin        
+        if    type == String    then value.to_s
+        elsif type == Float     then value.to_f
+        elsif type == Time      then Time.parse(value.to_s)
+        elsif type == Date      then Date.parse(value.to_s)
+        elsif type == DateTime  then DateTime.parse(value.to_s)
+        elsif type == Boolean   then ['true', 't', '1'].include?(value.to_s.downcase)
+        elsif type == Integer
+          # ganked from datamapper
+          value_to_i = value.to_i
+          if value_to_i == 0 && value != '0'
+            value_to_s = value.to_s
+            begin
+              Integer(value_to_s =~ /^(\d+)/ ? $1 : value_to_s)
+            rescue ArgumentError
+              nil
+            end
+          else
+            value_to_i
+          end
+        else
+          value
+        end
+      rescue
+        value
+      end
+    end
+    
+    private      
+      def value_from_xml_node(node, namespace=nil)        
+        node.register_default_namespace(namespace.chop) if namespace
+        
+        if element?
+          depth = options[:deep] ? './/' : ''
+          result = node.find_first("#{depth}#{namespace}#{tag}")
+          result ? result.content : nil
+        else
+          node[tag]
+        end
+      end
+  end
+end

data/lib/happymapper/version.rb

@@ -0,0 +1,9 @@
+module HappyMapper
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/happymapper.rb

@@ -0,0 +1,123 @@
+dir = File.dirname(__FILE__)
+$:.unshift(dir) unless $:.include?(dir) || $:.include?(File.expand_path(dir))
+
+require 'date'
+require 'time'
+require 'rubygems'
+
+gem 'libxml-ruby', '>= 0.8.3'
+require 'xml'
+require 'libxml_ext/libxml_helper'
+
+
+class Boolean; end
+
+module HappyMapper
+  
+  def self.included(base)
+    base.instance_variable_set("@attributes", {})
+    base.instance_variable_set("@elements", {})
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def attribute(name, type, options={})
+      attribute = Attribute.new(name, type, options)
+      @attributes[to_s] ||= []
+      @attributes[to_s] << attribute
+      create_accessor(attribute.name)
+    end
+    
+    def attributes
+      @attributes[to_s] || []
+    end
+    
+    def element(name, type, options={})
+      element = Element.new(name, type, options)
+      @elements[to_s] ||= []
+      @elements[to_s] << element
+      create_accessor(element.name)
+    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
+    
+    def tag(new_tag_name)
+      @tag_name = new_tag_name.to_s
+    end
+    
+    def get_tag_name
+      @tag_name ||= to_s.downcase
+    end
+    
+    def parse(xml, o={})
+      options = {
+        :single => false,
+        :use_default_namespace => false,
+      }.merge(o)
+      
+      namespace = "default_ns:" if options[:use_default_namespace]
+      doc = xml.is_a?(LibXML::XML::Node) ? xml : xml.to_libxml_doc
+      
+      nodes = if namespace
+        node = doc.respond_to?(:root) ? doc.root : doc
+        node.register_default_namespace(namespace.chop)
+        node.find("#{namespace}#{get_tag_name}")
+      else
+        doc.find(get_tag_name)
+      end
+      
+      collection = create_collection(nodes, namespace)
+      
+      # per http://libxml.rubyforge.org/rdoc/classes/LibXML/XML/Document.html#M000354
+      nodes = nil
+      GC.start
+      
+      options[:single] ? collection.first : collection
+    end
+    
+    private
+      def create_collection(nodes, namespace=nil)
+        nodes.inject([]) do |acc, el|
+          obj = new
+          attributes.each { |attr| obj.send("#{attr.name}=", attr.from_xml_node(el)) }
+          elements.each   { |elem| obj.send("#{elem.name}=", elem.from_xml_node(el, namespace)) }
+          acc << obj
+        end
+      end
+      
+      def create_getter(name)
+        class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}
+            @#{name}
+          end
+        EOS
+      end
+
+      def create_setter(name)
+        class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}=(value)
+            @#{name} = value
+          end
+        EOS
+      end
+
+      def create_accessor(name)
+        create_getter(name)
+        create_setter(name)
+      end
+  end
+end
+
+require 'happymapper/item'
+require 'happymapper/attribute'
+require 'happymapper/element'

data/lib/libxml_ext/libxml_helper.rb

@@ -0,0 +1,93 @@
+require "xml/libxml"
+ 
+class XML::Node
+  ##
+  # Open up XML::Node from libxml and add convenience methods inspired
+  # by hpricot.
+  # (http://code.whytheluckystiff.net/hpricot/wiki/HpricotBasics)
+  # Also:
+  #  * provide better handling of default namespaces
+ 
+  # an array of default namespaces to past into
+  attr_accessor :default_namespaces
+ 
+  # find the child node with the given xpath
+  def at(xpath)
+    self.find_first(xpath)
+  end
+ 
+  # find the array of child nodes matching the given xpath
+  def search(xpath)
+    results = self.find(xpath).to_a
+    if block_given?
+      results.each do |result|
+        yield result
+      end
+    end
+    return results
+  end
+ 
+  # alias for search
+  def /(xpath)
+    search(xpath)
+  end
+ 
+  # return the inner contents of this node as a string
+  def inner_xml
+    child.to_s
+  end
+ 
+  # alias for inner_xml
+ def inner_html
+    inner_xml
+  end
+ 
+  # return this node and its contents as an xml string
+  def to_xml
+    self.to_s
+  end
+ 
+  # alias for path
+  def xpath
+    self.path
+  end
+ 
+  # provide a name for the default namespace
+  def register_default_namespace(name)
+    default_namespace = namespace.detect { |n| n.to_s == nil }
+    
+    if default_namespace
+      register_namespace("#{name}:#{default_namespace.href}")
+    else
+      raise "No default namespace found"
+    end
+  end
+ 
+  # register a namespace, of the form "foo:http://example.com/ns"
+  def register_namespace(name_and_href)
+    (@default_namespaces ||= []) << name_and_href
+  end
+ 
+  def find_with_default_ns(xpath_expr, namespace=nil)
+    find_base(xpath_expr, namespace || default_namespaces)
+  end
+ 
+  def find_first_with_default_ns(xpath_expr, namespace=nil)
+    find_first_base(xpath_expr, namespace || default_namespaces)
+  end
+ 
+ 
+  alias_method :find_base, :find unless method_defined?(:find_base)
+  alias_method :find, :find_with_default_ns
+ 
+  alias_method :find_first_base, :find_first unless method_defined?(:find_first_base)
+  alias_method :find_first, :find_first_with_default_ns
+end
+ 
+class String
+  def to_libxml_doc
+    xp = XML::Parser.new
+    xp.string = self
+    return xp.parse
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/happymapper.rb'}"
+puts "Loading happymapper gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)