jnunemaker-happymapper 0.1.2

data/spec/happymapper_item_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe HappyMapper::Item do
+  
+  describe "new instance" do
+    before do
+      @attr = HappyMapper::Item.new(:foo, String, :tag => 'foobar')
+    end
+    
+    it "should accept a name" do
+      @attr.name.should == 'foo'
+    end
+    
+    it 'should accept a type' do
+      @attr.type.should == String
+    end
+    
+    it 'should accept :tag as an option' do
+      @attr.tag.should == 'foobar'
+    end
+    
+    it 'should provide #name' do
+      @attr.should respond_to(:name)
+    end
+    
+    it 'should provide #type' do
+      @attr.should respond_to(:type)
+    end
+  end
+  
+  describe "typecasting" do
+    it "should work with Strings" do
+      attribute = HappyMapper::Item.new(:foo, String)
+      [21, '21'].each do |a|
+        attribute.typecast(a).should == '21'
+      end
+    end
+    
+    it "should work with Integers" do
+      attribute = HappyMapper::Item.new(:foo, Integer)
+      [21, 21.0, '21'].each do |a|
+        attribute.typecast(a).should == 21
+      end
+    end
+    
+    it "should work with Floats" do
+      attribute = HappyMapper::Item.new(:foo, Float)
+      [21, 21.0, '21'].each do |a|
+        attribute.typecast(a).should == 21.0
+      end
+    end
+    
+    it "should work with Times" do
+      attribute = HappyMapper::Item.new(:foo, Time)
+      attribute.typecast('2000-01-01 01:01:01.123456').should == Time.local(2000, 1, 1, 1, 1, 1, 123456)
+    end
+    
+    it "should work with Dates" do
+      attribute = HappyMapper::Item.new(:foo, Date)
+      attribute.typecast('2000-01-01').should == Date.new(2000, 1, 1)
+    end
+    
+    it "should work with DateTimes" do
+      attribute = HappyMapper::Item.new(:foo, DateTime)
+      attribute.typecast('2000-01-01 00:00:00').should == DateTime.new(2000, 1, 1, 0, 0, 0)
+    end
+    
+    it "should work with Boolean" do
+      attribute = HappyMapper::Item.new(:foo, Boolean)
+      attribute.typecast('false').should == false
+    end
+  end
+end

data/spec/happymapper_spec.rb

@@ -0,0 +1,216 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+class Post
+  include HappyMapper
+  
+  attribute :href, String
+  attribute :hash, String
+  attribute :description, String
+  attribute :tag, String
+  attribute :time, Time
+  attribute :others, Integer
+  attribute :extended, String
+end
+
+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
+
+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
+
+describe HappyMapper do
+  
+  describe "being included into another class" do
+    before do
+      Foo.instance_variable_set("@attributes", {})
+      Foo.instance_variable_set("@elements", {})
+    end
+    class Foo; include HappyMapper end
+    
+    it "should set attributes to an array" do
+      Foo.attributes.should == []
+    end
+    
+    it "should set @elements to a hash" do
+      Foo.elements.should == []
+    end
+    
+    it "should allow adding an attribute" do
+      lambda {
+        Foo.attribute :name, String
+      }.should change(Foo, :attributes)
+    end
+    
+    it "should be able to get all attributes in array" do
+      Foo.attribute :name, String
+      Foo.attributes.size.should == 1
+    end
+    
+    it "should allow adding an element" do
+      lambda {
+        Foo.element :name, String
+      }.should change(Foo, :elements)
+    end
+    
+    it "should be able to get all elements in array" do
+      Foo.element(:name, String)
+      Foo.elements.size.should == 1
+    end
+    
+    it "should allow has one association" do
+      Foo.has_one(:user, User)
+      element = Foo.elements.first
+      element.name.should == 'user'
+      element.type.should == User
+      element.options[:single] = true
+    end
+    
+    it "should allow has many association" do
+      Foo.has_many(:users, User)
+      element = Foo.elements.first
+      element.name.should == 'users'
+      element.type.should == User
+      element.options[:single] = false
+    end
+    
+    it "should default tag name to class" do
+      Foo.get_tag_name.should == 'foo'
+    end
+    
+    it "should allow setting tag name" do
+      Foo.tag('FooBar')
+      Foo.get_tag_name.should == 'FooBar'
+    end
+    
+    it "should provide #parse" do
+      Foo.should respond_to(:parse)
+    end
+  end
+  
+  describe "#attributes" do
+    it "should only return attributes for the current class" do
+      Post.attributes.size.should == 7
+      Status.attributes.size.should == 0
+    end
+  end
+  
+  describe "#elements" do
+    it "should only return elements for the current class" do
+      Post.elements.size.should == 0
+      Status.elements.size.should == 9
+    end
+  end
+  
+  describe "#parse (with xml attributes mapping to ruby attributes)" do
+    before do
+      @posts = Post.parse(File.read(File.dirname(__FILE__) + '/fixtures/posts.xml'))
+    end
+    
+    it "should get the correct number of elements" do
+      @posts.size.should == 20
+    end
+    
+    it "should properly create objects" do
+      first = @posts.first
+      first.href.should == 'http://roxml.rubyforge.org/'
+      first.hash.should == '19bba2ab667be03a19f67fb67dc56917'
+      first.description.should == 'ROXML - Ruby Object to XML Mapping Library'
+      first.tag.should == 'ruby xml gems mapping'
+      first.time.should == Time.utc(2008, 8, 9, 5, 24, 20)
+      first.others.should == 56
+      first.extended.should == '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 custom-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.'
+    end
+  end
+  
+  describe "#parse (with xml elements mapping to ruby attributes)" do
+    before do
+      @statuses = Status.parse(File.read(File.dirname(__FILE__) + '/fixtures/statuses.xml'))
+    end
+    
+    it "should get the correct number of elements" do
+      @statuses.size.should == 20
+    end
+    
+    it "should properly create objects" do
+      first = @statuses.first
+      first.id.should == 882281424
+      first.created_at.should == Time.utc(2008, 8, 9, 5, 38, 12)
+      first.source.should == 'web'
+      first.truncated.should be_false
+      first.in_reply_to_status_id.should == 1234
+      first.in_reply_to_user_id.should == 12345
+      first.favorited.should be_false
+      first.user.id.should == 4243
+      first.user.name.should == 'John Nunemaker'
+      first.user.screen_name.should == 'jnunemaker'
+      first.user.location.should == 'Mishawaka, IN, US'
+      first.user.description.should == 'Loves his wife, ruby, notre dame football and iu basketball'
+      first.user.profile_image_url.should == 'http://s3.amazonaws.com/twitter_production/profile_images/53781608/Photo_75_normal.jpg'
+      first.user.url.should == 'http://addictedtonew.com'
+      first.user.protected.should be_false
+      first.user.followers_count.should == 486
+    end
+  end
+  
+  # TODO: someone please get xml with namespaces working, kthxbai
+  describe "#parse (with xml that has namespace)" do
+    before do
+      file_contents = File.read(File.dirname(__FILE__) + '/fixtures/pita.xml')
+      @items = PITA::Items.parse(file_contents, :single => true, :use_default_namespace => true)
+    end
+    
+    it "should properly create objects" do
+      @items.total_results.should == 22
+      @items.total_pages.should == 3
+      first  = @items.items[0]
+      second = @items.items[1]
+      first.asin.should == '0321480791'
+      first.detail_page_url.should == 'http://www.amazon.com/gp/redirect.html%3FASIN=0321480791%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0321480791%253FSubscriptionId=dontbeaswoosh'
+      first.manufacturer.should == 'Addison-Wesley Professional'
+      second.asin.should == '047022388X'
+      second.manufacturer.should == 'Wrox'
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'happymapper')

data/tasks/deployment.rake

@@ -0,0 +1,43 @@
+desc 'Preps the gem for a new release'
+task :prepare do
+  require 'rio'
+  Rake::Task['manifest:refresh'].invoke
+  gemspec = %x[rake debug_gem]
+  lines = gemspec.split("\n")
+  rio('happymapper.gemspec') < lines[1, lines.length-1].join("\n")
+end
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_upload, :publish_docs]

data/website/css/common.css

@@ -0,0 +1,47 @@
+@media screen, projection {
+	/*
+	Copyright (c) 2007, Yahoo! Inc. All rights reserved.
+	Code licensed under the BSD License:
+	http://developer.yahoo.net/yui/license.txt
+	version: 2.2.0
+	*/
+	body {font:13px arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small;}table {font-size:inherit;font:100%;}select, input, textarea {font:99% arial,helvetica,clean,sans-serif;}pre, code {font:115% monospace;*font-size:100%;}body * {line-height:1.22em;}
+	body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,form,fieldset,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}/*ol,ul {list-style:none;}*/caption,th {text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym {border:0;}
+	/* end of yahoo reset and fonts */
+	
+	body 										{color:#333; background:#4b1a1a; line-height:1.3;}
+	p												{margin:0 0 20px;}
+	a												{color:#4b1a1a;}
+	a:hover									{text-decoration:none;}
+	strong									{font-weight:bold;}
+	em											{font-style:italics;}
+	h1,h2,h3,h4,h5,h6				{font-weight:bold;}
+	h1											{font-size:197%; margin:30px 0; color:#4b1a1a;}
+	h2											{font-size:174%; margin:20px 0; color:#b8111a;}
+	h3											{font-size:152%; margin:10px 0;}
+	h4											{font-size:129%; margin:10px 0;}
+	pre 										{background:#eee; margin:0 0 20px; padding:20px; border:1px solid #ccc; font-size:100%; overflow:auto;}
+	code										{font-size:100%; margin:0; padding:0;}
+	ul, ol									{margin:10px 0 10px 25px;}
+	ol li										{margin:0 0 10px;}
+
+
+
+
+
+	div#wrapper 							{background:#fff; width:560px; margin:0 auto; padding:20px; border:10px solid #bc8c46; border-width:0 10px;}
+	div#header								{position:relative; border-bottom:1px dotted; margin:0 0 10px; padding:0 0 10px;}
+	div#header p							{margin:0; padding:0;}
+	div#header h1							{margin:0; padding:0;}
+	ul#nav										{position:absolute; top:0; right:0; list-style:none; margin:0; padding:0;}
+	ul#nav li									{display:inline; padding:0 0 0 5px;}
+	ul#nav li a								{}
+	div#content								{}
+	div#footer								{margin:40px 0 0; border-top:1px dotted; padding:10px 0 0;}
+
+
+
+
+
+
+}

data/website/index.html

@@ -0,0 +1,98 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 
+<head> 
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> 
+	<title>HappyMapper by John Nunemaker</title> 
+	<link rel="stylesheet" href="css/common.css" type="text/css" /> 
+</head> 
+<body> 
+ 
+<div id="wrapper"> 
+	<div id="header"> 
+		<h1>HappyMapper</h1> 
+		<p>Object to xml mapping library.</p> 
+		
+		<ul id="nav">
+			<li><a href="rdoc/">Docs</a></li> 
+			<li><a href="http://github.com/jnunemaker/happymapper">Github</a></li>
+			<li><a href="http://jnunemaker.lighthouseapp.com/projects/20014-happy-mapper/overview">Lighthouse</a></li>
+			<li><a href="http://rubyforge.org/projects/happymapper/">Rubyforge</a></li> 
+		</ul> 
+	</div> 
+	
+	<div id="content"> 
+		<h2>Install</h2> 
+		<pre><code>$ sudo gem install happymapper</code></pre> 
+		
+		<h2>Examples</h2>
+		
+		<h3>Given the following xml:</h3>
+<pre><code>&lt;statuses type="array"> 
+  &lt;status> 
+    &lt;created_at>Sat Aug 09 05:38:12 +0000 2008&lt;/created_at> 
+    &lt;id>882281424&lt;/id> 
+    &lt;text>I so just thought the guy lighting the Olympic torch was falling when he began to run on the wall. Wow that would have been catastrophic.&lt;/text> 
+    &lt;source>web&lt;/source> 
+    &lt;truncated>false&lt;/truncated> 
+    &lt;in_reply_to_status_id>1234&lt;/in_reply_to_status_id> 
+    &lt;in_reply_to_user_id>12345&lt;/in_reply_to_user_id> 
+    &lt;favorited>&lt;/favorited> 
+    &lt;user> 
+      &lt;id>4243&lt;/id> 
+      &lt;name>John Nunemaker&lt;/name> 
+      &lt;screen_name>jnunemaker&lt;/screen_name> 
+      &lt;location>Mishawaka, IN, US&lt;/location> 
+      &lt;description>Loves his wife, ruby, notre dame football and iu basketball&lt;/description> 
+      &lt;profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/53781608/Photo_75_normal.jpg&lt;/profile_image_url> 
+      &lt;url>http://addictedtonew.com&lt;/url> 
+      &lt;protected>false&lt;/protected> 
+      &lt;followers_count>486&lt;/followers_count> 
+    &lt;/user> 
+  &lt;/status>
+&lt;/statuses></code></pre>
+
+<h3>You could have the following objects:</h3>
+
+<pre><code>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</code></pre>		
+		
+		<h2>Support</h2> 
+		<p>Conversations welcome in the <a href="http://groups.google.com/group/happymapper">google group</a> and bugs/features over at <a href="http://jnunemaker.lighthouseapp.com/projects/20014-happy-mapper/overview">Lightouse</a>.</p> 
+	</div> 
+ 
+	<div id="footer"> 
+		<p>Created by <a href="http://addictedtonew.com/about/">John Nunemaker</a></p> 
+	</div> 
+</div>  
+</body> 
+</html>

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: jnunemaker-happymapper
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: object to xml mapping library
+email: 
+- nunemaker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+- TODO.txt
+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
+has_rdoc: true
+homepage: http://happymapper.rubyforge.org
+post_install_message: ""
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: happymapper
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: object to xml mapping library
+test_files: []
+