oxmlk 0.0.0 → 0.1.0

data/Rakefile

@@ -4,18 +4,20 @@ require 'rake'
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = "oxmlk"
+    gem.name = 'oxmlk'
     gem.summary = %Q{Object 2 XML kit for ruby}
     gem.description = %Q{OxMlk gives you a simple way to map you ruby objects to XML and then convert one to the other.}
-    gem.email = "hexorx@gmail.com"
-    gem.homepage = "http://github.com/hexorx/oxmlk"
-    gem.authors = ["Josh Robinson"]
-    gem.add_development_dependency "rspec"
+    gem.email = 'hexorx@gmail.com'
+    gem.homepage = 'http://github.com/hexorx/oxmlk'
+    gem.authors = ['Josh Robinson']
+    gem.add_development_dependency 'rspec'
+    gem.add_dependency 'libxml-ruby'
+    gem.add_dependency 'activesupport', '>= 2.1.0'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+  puts 'Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler'
 end
 
 require 'spec/rake/spectask'

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/examples/example.rb

@@ -0,0 +1,32 @@
+class Number
+  include OxMlk
+  
+  ox_tag :number
+  
+  ox_attr(:value, :from => :content)
+end
+
+class Email
+  include OxMlk
+  
+  ox_tag :email
+  
+  ox_attr(:value, :from => :content)
+end
+
+class Person
+  include OxMlk
+  
+  ox_tag :person
+  
+  ox_attr(:category, :from => :attr)
+  ox_attr(:two_attr, :from => '@attr2')
+  
+  ox_attr(:name)
+  ox_attr(:numbers, :as => [Number], :freeze => false)
+  ox_attr(:contacts, :as => [Number,Email], :freeze => true)
+  
+  def say_hello(xml)
+    'hello'
+  end
+end

data/examples/posts.rb

@@ -0,0 +1,9 @@
+class Response
+  include OxMlk
+  
+  ox_attr :user, :from => '@user'
+end
+
+class Post
+  include OxMlk
+end

data/examples/xml/example.xml

@@ -0,0 +1,14 @@
+<person category="meat_popsicle">
+  <name>Joe</name>
+  <number group="main">3035551212</number>
+  <number group="cell">3035551234</number>
+  <email group="home">test@example.com</email>
+  <friends>
+    <person>
+      <name>Bob</name>
+    </person>
+    <person>
+      <name>John</name>
+    </person>
+  </friends>
+</person>

data/examples/xml/posts.xml

@@ -0,0 +1,23 @@
+<posts user="jnunemaker" tag="ruby"> 
+  <post href="http://roxml.rubyforge.org/" hash="19bba2ab667be03a19f67fb67dc56917" description="ROXML - Ruby Object to XML Mapping Library" tag="ruby xml gems mapping" time="2008-08-09T05:24:20Z" others="56" extended="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."/> 
+  <post href="http://code.google.com/p/sparrow/" hash="1df8a7cb9e8960992556518c0ea0d146" description="sparrow - Google Code" tag="ruby sparrow memcache queue" time="2008-08-06T15:07:24Z" others="115" extended="Sparrow is a really fast lightweight queue written in Ruby that speaks memcache. That means you can use Sparrow with any memcached client library (Ruby or otherwise)."/> 
+  <post href="http://code.google.com/p/query-reviewer/" hash="963187e8bf350ae42e21eee13a2bef07" description="query-reviewer - Google Code" tag="rails ruby railstips plugins database optimization" time="2008-08-04T21:50:14Z" others="180" extended="This rails plugin not only runs &quot;EXPLAIN&quot; before each of your select queries in development, but provides a small DIV in the rendered output of each page with the summary of query warnings that it analyzed."/> 
+  <post href="http://dev.zeraweb.com/introducing-functor" hash="2cdd545934bd37ae6f4829c51b3041c5" description="dev.zeraweb.com: Introducing Functor" tag="ruby methods gems railstips" time="2008-08-04T21:46:47Z" others="61" extended="Really cool ruby lib for overloading method definitions. I can think of a few places this would be handy."/> 
+  <post href="http://prawn.majesticseacreature.com/" hash="92764e019de7553b4cd38017e42e4aaa" description="prawn.majesticseacreature.com" tag="pdf ruby railstips" time="2008-08-04T21:26:20Z" others="237" extended="pure ruby pdf generation library."/> 
+  <post href="http://meme-rocket.com/2006/09/28/ruby-moduleinclude-at-odds-with-duck-typing/" hash="4ce96c7c237161819e9625737c22b462" description="Bill Burcham’s memeRocket   ::  Ruby Module#include at Odds with Duck Typing." tag="ruby railstips enumerable comparable" time="2008-08-03T16:09:24Z" others="3" extended="How to build your own enumerable and comparable objects in ruby. This article is old but just came across it and found it handy."/> 
+  <post href="http://bl.ogtastic.com/archives/2008/7" hash="6bebd138c037d7d7c88a7046ca03f671" description="The right way to do something you should never do" tag="juggernaut observers rails flash ruby" time="2008-08-03T03:50:58Z" others="0" extended="Example of how to use juggernaut with an observer."/> 
+  <post href="http://ncavig.com/blog/?page_id=8" hash="55450d103d6e2dd609b203ad133d751f" description="Nic’s Notions » Juggernaut Tutorials" tag="juggernaut rails ruby flash plugins server chat" time="2008-08-03T02:26:39Z" others="30" extended="Several juggernaut tutorials."/> 
+  <post href="http://blog.labnotes.org/2008/05/05/distributed-twitter-client-in-20-lines-of-code/" hash="7c2a36292db109b144036a02eb3f46b7" description="Labnotes » Distributed Twitter Client in 20 lines of code" tag="xmpp ruby jabber xmpp4r" time="2008-08-01T18:16:23Z" others="18" extended="Cool little snippet of xmpp goodness to check your buddies status messages."/> 
+  <post href="http://labs.reevoo.com/plugins/beanstalk-messaging" hash="d100c10208acbf5e954320a5577838d9" description="reevoolabs - Beanstalk Messaging" tag="railstips messaging queue rails ruby" time="2008-07-28T02:57:00Z" others="33" extended="Good write up on beanstalk"/> 
+  <post href="http://www.slideshare.net/guest807bb2/rubyfringe?src=embed" hash="c3dc3b940dbe25e39737240b4e1ab071" description="Rockstar Memcached" tag="memcached performance caching ruby rails railstips" time="2008-07-28T02:30:50Z" others="11" extended="Killer presentation on memcached by Tobi of Shopify."/> 
+  <post href="http://www.igvita.com/2008/07/22/unix-signals-for-live-debugging/" hash="288054a38d870b15bdf060ed5c6b2a2e" description="Unix Signals for Live Debugging - igvita.com" tag="ruby signals unix debugging signal railstips" time="2008-07-27T04:53:00Z" others="86" extended="I've known how to kill processes and such but never quite understood kill. Ilya Grigorik explains not only how to send those signals but how to use them in your scripts to change the way they behave on the fly. Very cool."/> 
+  <post href="http://www.rubyinside.com/redcloth-4-released-962.html" hash="b3db9b84940ce550e26a560b83eb2f66" description="RedCloth 4.0 Released: 40x Faster Textile Rendering" tag="textile ruby gems railstips" time="2008-07-27T04:42:29Z" others="20" extended="Redcloth gets some serious love. It's now much faster. Sweet!"/> 
+  <post href="http://code.google.com/p/rubycas-server/" hash="b532ea5933e4eba76c44823e17fecd31" description="rubycas-server - Google Code" tag="sso authentication cas ruby" time="2008-07-22T17:04:09Z" others="132" extended="RubyCAS-Server provides a single sign-on solution for web applications, implementing the server-end of JA-SIG's CAS protocol."/> 
+  <post href="http://reinh.com/blog/2008/07/14/a-thinking-mans-sphinx.html" hash="033d72ac54d8c722618383e0e2aa18ff" description="ReinH — A Thinking Man's Sphinx" tag="rails railstips sphinx search ruby" time="2008-07-17T19:34:59Z" others="142" extended="A guide to the two sphynx plugins: ultrasphynx and thinksphynx and why you should choose one or the other."/> 
+  <post href="http://www.rubyinside.com/ruby-xml-crisis-over-libxml-0-8-0-released-955.html" hash="70490d9786f09db5ba5f7904f88d304c" description="libxml-ruby 0.8.0 Released: Ruby Gets Fast, Reliable XML Processing At Last" tag="libxml xml ruby gems" time="2008-07-17T18:22:23Z" others="55" extended="lib xml gets an update and now it's really fast."/> 
+  <post href="http://github.com/RISCfuture/autumn/tree/master" hash="9b47db4bf59da2009642f4084e3113a2" description="autumn at master — GitHub" tag="irc ruby gems" time="2008-07-17T18:20:19Z" others="18" extended="Easy, fresh, feature-rich IRC bots in Ruby"/> 
+  <post href="http://groups.google.com/group/datamapper/browse_thread/thread/d33fbb20e41fad04" hash="4403898c92b37788f002ad6d79a66b68" description="New Finder Syntax (before 1.0) -" tag="railstips ruby datamapper" time="2008-07-05T20:42:27Z" others="1" extended="really cool idea for conditions in datamapper. even if you don't use datamapper, read this as it's sweet."/> 
+  <post href="http://codeclimber.blogspot.com/2008/06/using-ruby-for-imap-with-gmail.html" hash="33bbf2492beac5fbf1fc167014060067" description="CodeClimber: using Ruby for IMAP with Gmail" tag="email gems gmail google imap rails railstips ruby" time="2008-07-05T20:06:47Z" others="118" extended="how to check gmail using ruby's IMAP libraries. the key is to use the login method instead of the authenticate one."/> 
+  <post href="http://xullicious.blogspot.com/2008/07/updated-curb-multi-interface-patch.html" hash="f95dcc012bdc13bc26bace3ceed10656" description="Xul for thought: Updated curb multi interface patch" tag="curl ruby http" time="2008-07-03T21:52:45Z" others="1" extended="Really cool multi curl stuff to rapidly hit urls."/> 
+</posts> 
+<!-- fe04.api.del.ac4.yahoo.net uncompressed/chunked Sat Aug  9 00:20:11 PDT 2008 -->

data/lib/oxmlk/description.rb

@@ -1,5 +1,126 @@
 module OxMlk
+
   class Description
+    PROCESSORS = {
+      :elem => {
+        :value => proc {|x| x.content rescue nil},
+        Integer => proc {|x| x.content.to_i rescue nil},
+        Float => proc {|x| x.content.to_f rescue nil}
+      },
+      :attribute => {
+        :value => proc {|x| x.value rescue nil} 
+      }
+    }
     
+    attr_reader :xpath
+
+    def initialize(name,o={},&block)
+      @froze = o.delete(:freeze)
+      @from = o.delete(:from)
+      @as = o.delete(:as)
+      @wrapper = o.delete(:wrapper)
+      @name = name.to_s
+      
+      @is_attribute = computed_is_attribute
+      @processors = [coputed_processor, block].compact
+      @xpath = computed_xpath
+    end
+    
+    def accessor
+      @accessor ||= @name.intern
+    end
+    
+    def setter
+      :"#{accessor}="
+    end
+    
+    def instance_variable
+      :"@#{accessor}"
+    end
+    
+    def froze?
+      @froze ||= false
+    end
+    
+    def writable?
+      !froze?
+    end
+    
+    def attribute?
+      @is_attribute ||= false
+    end
+    
+    def elem?
+      !attribute?
+    end
+    
+    def ox_type
+      elem? ? :elem : :attribute
+    end
+    
+    def collection?
+      @as.is_a?(Array)
+    end
+    
+    def ox_object?
+      return false if [*@as].empty?
+      [*@as].all? {|x| x.respond_to?(:from_xml)}
+    end
+    
+    def process(node,instance)
+      @processors.inject(node) do |memo,processor|
+        case processor
+        when Proc
+          processor.call(memo)
+        when Symbol
+          instance.send(processor,memo)
+        else
+          processor.from_xml(memo)
+        end
+      end
+    end
+    
+    def from_xml(data,instance)
+      xml = XML::Node.from(data)
+      nodes = xml.find(@xpath)
+      return nil if nodes.first.nil?
+      return process(nodes.first,instance) unless collection?
+      (nodes).map {|n| process(n,instance)}
+    end
+    
+  protected
+  
+    def computed_xpath
+      wrap case @from
+      when nil
+        if ox_object?
+          [*@as].map(&:ox_tag).join('|')
+        elsif collection?
+          @name.to_s.singularize
+        else
+          @name.to_s
+        end
+      when String
+        @from
+      when :attr
+        "@#{accessor}"
+      when :content
+        '.'
+      end
+    end
+    
+    def computed_is_attribute
+      @from.to_s[0,1] == '@' || @from == :attr
+    end
+    
+    def coputed_processor
+      return proc {|x| Hash[*@as.map{|o| [o.ox_tag,o]}.flatten][x.name].from_xml(x) } if collection? && ox_object?
+      processor = [*@as].first || :value
+      PROCESSORS[ox_type][processor] || processor
+    end
+    
+    def wrap(xpath=nil)
+      [@wrapper,xpath].compact.join('/')
+    end
   end
 end

data/lib/oxmlk/xml.rb

@@ -0,0 +1,31 @@
+require 'libxml'
+require 'pathname'
+require 'cgi'
+
+module OxMlk
+  module XML
+    Document = LibXML::XML::Document
+    Node = LibXML::XML::Node
+    Parser = LibXML::XML::Parser
+    Error = LibXML::XML::Error
+    
+    class Node
+      def self.from(data)
+        case data
+        when XML::Document
+          data.root
+        when XML::Node
+          data
+        when File
+          XML::Parser.io(data).parse.root
+        when Pathname, URI
+          XML::Parser.file(data.to_s).parse.root
+        when String
+          XML::Parser.string(data).parse.root
+        else
+          raise 'Invalid XML data'
+        end
+      end
+    end
+  end
+end

data/lib/oxmlk.rb

@@ -1,30 +1,55 @@
 dir = File.dirname(__FILE__)
+require File.join(dir, 'oxmlk/xml')
 require File.join(dir, 'oxmlk/description')
+require 'activesupport'
 
 module OxMlk
   
   def self.included(base)
-    base.class_eval do
-      include InstanceMethods
-      extend ClassMethods
-    end
-  end
-  
-  module InstanceMethods
+    base.extend ClassMethods
   end
   
   module ClassMethods
+    
     def ox_attrs
       @ox_attrs ||= []
     end
     
-    def ox_attr(name)
-      ox_attrs << name
+    def ox_attr(name,o={})
+      new_attr =  Description.new(name, o)
+      ox_attrs << new_attr
+      attr new_attr.accessor, new_attr.writable?
+    end
+    
+    def from_xml(data)
+      xml = XML::Node.from(data)
+      p [xml.name, ox_tag]
+      raise 'invalid XML' unless xml.name == ox_tag
+      
+      ox = new
+      ox_attrs.each do |a|
+        value = a.from_xml(xml,ox)
+        if ox.respond_to?(a.setter)
+          ox.send(a.setter,value)
+        else
+          ox.instance_variable_set(a.instance_variable,value)
+        end
+      end
+      ox
     end
     
-    def tag_name
-      @tag_name ||= to_s.split('::')[-1].downcase
+    def ox_attributes
+      ox_attrs.select {|x| x.attribute?}
     end
+    
+    def ox_elems
+      ox_attrs.select {|x| x.elem?}
+    end
+    
+    def ox_tag(tag=false)
+      @ox_tag ||= (tag || self).to_s
+    end
+    
   end
   
 end

data/oxmlk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oxmlk}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Robinson"]
-  s.date = %q{2009-08-20}
+  s.date = %q{2009-08-24}
   s.description = %q{OxMlk gives you a simple way to map you ruby objects to XML and then convert one to the other.}
   s.email = %q{hexorx@gmail.com}
   s.extra_rdoc_files = [
@@ -23,12 +23,19 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "examples/example.rb",
+     "examples/posts.rb",
+     "examples/xml/example.xml",
+     "examples/xml/posts.xml",
      "lib/oxmlk.rb",
      "lib/oxmlk/description.rb",
+     "lib/oxmlk/xml.rb",
      "oxmlk.gemspec",
+     "spec/description_spec.rb",
      "spec/oxmlk_spec.rb",
      "spec/spec.opts",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/xml_spec.rb"
   ]
   s.homepage = %q{http://github.com/hexorx/oxmlk}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -36,8 +43,12 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.3}
   s.summary = %q{Object 2 XML kit for ruby}
   s.test_files = [
-    "spec/oxmlk_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/description_spec.rb",
+     "spec/oxmlk_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/xml_spec.rb",
+     "examples/example.rb",
+     "examples/posts.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -46,10 +57,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<libxml-ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1.0"])
     else
       s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<libxml-ruby>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 2.1.0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<libxml-ruby>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 2.1.0"])
   end
 end

data/spec/description_spec.rb

@@ -0,0 +1,221 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe OxMlk::Description do
+  
+  before(:all) do
+    require example(:example)
+    
+    @xml = OxMlk::XML::Node.from(xml_for(:example))
+    @klass = Person
+  end
+  
+  describe 'xpath' do
+    it 'should be name by default' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.xpath.should == 'name'
+    end
+    
+    it 'should be the string if :from is a string' do
+      @desc = OxMlk::Description.new(:name, :from => 'String')
+      @desc.xpath.should == 'String'
+    end
+    
+    it 'should be @+accessor if :from is :attr' do
+      @desc = OxMlk::Description.new(:name, :from => :attr)
+      @desc.xpath.should == '@name'
+    end
+    
+    it 'should be . if :from is :content' do
+      @desc = OxMlk::Description.new(:name, :from => :content)
+      @desc.xpath.should == '.'
+    end
+    
+    it 'should be singular if plural name and is a collection' do
+      @desc = OxMlk::Description.new(:numbers, :as => [])
+      @desc.xpath.should == 'number'
+    end
+    
+    it 'should be ox_tag if :as is a ox_object' do
+      @desc = OxMlk::Description.new(:digits, :as => Number)
+      @desc.xpath.should == 'number'
+    end
+    
+    it 'should be list of ox_tag if :as is an array of ox_objects' do
+      @desc = OxMlk::Description.new(:digits, :as => [Number,Person])
+      @desc.xpath.should == 'number|person'
+    end
+    
+    it 'should add wrapper + / to xpath if wrapper is passed' do
+      @desc = OxMlk::Description.new(:person, :wrapper => :friends)
+      @desc.xpath.should == 'friends/person'
+    end
+  end
+  
+  describe 'accessor' do
+    it 'should be attr name as Symbol' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.accessor.should == :name
+    end
+  end
+  
+  describe 'setter' do
+    it 'should be accessor with = on the end' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.setter.should == :'name='
+    end
+  end
+  
+  describe 'instance_variable' do
+    it 'should be accessor with @ on the front' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.instance_variable.should == :'@name'
+    end
+  end
+  
+  describe 'writable?' do
+    it 'should be true by default' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.writable?.should be_true
+    end
+    
+    it 'should be true if :freeze is false' do
+      @desc = OxMlk::Description.new(:name, :freeze => false)
+      @desc.writable?.should be_true
+    end
+    
+    it 'should be false if :freeze is true' do
+      @desc = OxMlk::Description.new(:name, :freeze => true)
+      @desc.writable?.should be_false
+    end
+  end
+  
+  describe 'attribute?' do
+    it 'should be true if :from starts with @' do
+      @desc = OxMlk::Description.new(:name, :from => '@name')
+      @desc.attribute?.should be_true
+    end
+    
+    it 'should be true if :from is :attribute' do
+      @desc = OxMlk::Description.new(:name, :from => :attr)
+      @desc.attribute?.should be_true
+    end
+  end
+  
+  describe 'elem?' do
+    it 'should be true if attribute? is false' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.elem?.should be_true
+    end
+    
+    it 'should be false if attribute? is true' do
+      @desc = OxMlk::Description.new(:name, :from => :attr)
+      @desc.elem?.should be_false
+    end
+  end
+  
+  describe 'ox_type' do
+    it 'should be :elem if elem? is true' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.ox_type.should == :elem
+    end
+    
+    it 'should be :attribute if attribute? is true' do
+      @desc = OxMlk::Description.new(:name, :from => :attr)
+      @desc.ox_type.should == :attribute
+    end
+  end
+  
+  describe 'collection?' do
+    it 'should be true if :as is an Array' do
+      @desc = OxMlk::Description.new(:name, :as => [])
+      @desc.collection?.should be_true
+    end
+    
+    it 'should be false if :as is not Array' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.collection?.should be_false
+    end
+  end
+  
+  describe 'ox_object?' do
+    it 'should be true if :as responds to from_xml' do
+      @desc = OxMlk::Description.new(:number, :as => Person)
+      @desc.ox_object?.should be_true
+    end
+    
+    it 'should be true if :as is an array of objects that respond to from_xml' do
+      @desc = OxMlk::Description.new(:number, :as => [Person,Number])
+      @desc.ox_object?.should be_true
+    end
+    
+    it 'should be false if :as does not responds to from_xml' do
+      @desc = OxMlk::Description.new(:number, :as => 1)
+      @desc.ox_object?.should be_false
+    end
+    
+    it 'should be false if any of the items in :as array do not respond to from_xml' do
+      @desc = OxMlk::Description.new(:number, :as => [Person,Number,1])
+      @desc.ox_object?.should be_false
+    end
+  end
+  
+  describe 'from_xml' do
+    
+    it 'should accept xml argument' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.from_xml(@xml, @klass.new).should be_a(String)
+    end
+    
+    it 'should return an array if :as is an array' do
+      @desc = OxMlk::Description.new(:name, :as => [])
+      @desc.from_xml(@xml, @klass.new).should be_an(Array)
+    end
+    
+    it 'should return a String if :as is :value' do
+      @desc = OxMlk::Description.new(:name, :as => :value)
+      @desc.from_xml(@xml, @klass.new).should be_an(String)
+    end
+    
+    it 'should return a String if :as is nil' do
+      @desc = OxMlk::Description.new(:name)
+      @desc.from_xml(@xml, @klass.new).should be_an(String)
+    end
+    
+    it 'should return an Integer if :as is Integer' do
+      @desc = OxMlk::Description.new(:name, :as => Integer)
+      @desc.from_xml(@xml, @klass.new).should be_an(Integer)
+    end
+    
+    it 'should return an Float if :as is Float' do
+      @desc = OxMlk::Description.new(:name, :as => Float)
+      @desc.from_xml(@xml, @klass.new).should be_an(Float)
+    end
+    
+    it 'should return an Array of Integers if :as is [Integer]' do
+      @desc = OxMlk::Description.new(:name, :as => [Integer])
+      @desc.from_xml(@xml, @klass.new).each do |x|
+        x.should be_an(Integer)
+      end
+    end
+    
+    it 'should run procs passed to :as' do
+      @desc = OxMlk::Description.new(:name, :as => proc {|x| 'hi'})
+      @desc.from_xml(@xml, @klass.new).should == 'hi'
+    end
+    
+    it 'should run method when symbol is passed to :as' do
+      @desc = OxMlk::Description.new(:name, :as => :say_hello)
+      @desc.from_xml(@xml, @klass.new).should == 'hello'
+    end
+    
+    it 'should return an OxMlk object if one is passed to :as' do
+      @desc = OxMlk::Description.new(:number, :as => Number)
+      @desc.from_xml(@xml, @klass.new).should be_a(Number)
+    end
+    
+    it 'should match class to ox_tag if array of ox_objects is passed to :as' do
+      @desc = OxMlk::Description.new(:contact, :as => [Number,Email])
+      @desc.from_xml(@xml, @klass.new).first.should be_a(Number)
+    end
+  end
+end

data/spec/oxmlk_spec.rb

@@ -2,46 +2,103 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe OxMlk do
   
-  describe "being included into another class" do
-    before do
-      @klass = Class.new do
-        include OxMlk
-        
-        def self.to_s
-          'fubar'
-        end
-      end
+  before(:all) do
+    require example(:example)
+    @klass = Person
+  end
+  
+  describe 'being included into another class' do
+    it 'should set ox_attrs to an array' do
+      @klass.ox_attrs.should be_a(Array)
+    end
+    
+    it 'should add an ox_attr method' do
+      @klass.should respond_to(:ox_attr)
     end
     
-    it "should set ox_attrs to an array" do
-      @klass.ox_attrs.should == []
+    it 'should add a from_xml method' do
+      @klass.should respond_to(:from_xml)
+    end
+
+    it 'should add an ox_attributes method' do
+      @klass.should respond_to(:ox_attributes)
     end
     
-    it "should allow adding an ox_attr" do
-      @klass.ox_attr(:name)
-      @klass.ox_attrs.size.should == 1
+    it 'should add an ox_elems method' do
+      @klass.should respond_to(:ox_elems)
     end
     
-    it "should default tag name to lowercase class" do
-      @klass.tag_name.should == 'fubar'
+    it 'should add a tag_name method' do
+      @klass.should respond_to(:ox_tag)
+    end
+  end
+  
+  describe '#ox_attr' do
+    it 'should add an OxMlk::Description to the class' do
+      @klass.ox_attrs.first.should be_a(OxMlk::Description)
     end
+  
+    it 'should add a reader method' do
+      @klass.new.should respond_to(:name)
+    end
+  
+    it 'should add a writter method by default' do
+      @klass.new.should respond_to(:name=)
+    end
+
+    it 'should add a writter method when :freeze => false' do
+      @klass.new.should respond_to(:numbers=)
+    end
+  
+    it 'should not add a writter method when :freeze => true' do
+      @klass.new.should_not respond_to(:contacts=)
+    end
+  end
+    
+  describe '#from_xml' do
     
-    it "should default tag name of class in modules to the last constant lowercase" do
-      module Fu
-        class Bar
-          include OxMlk
-        end
+    it 'should return an instance of class' do
+      @klass.from_xml('<person/>').should be_a(@klass)
+    end
+    
+    it 'should error on mismatched tag' do
+      proc { @klass.from_xml('<Person/>') }.should raise_error
+    end
+    
+    describe 'example' do
+      before(:all) do
+        @xml = xml_for(:example)
+        @example = Person.from_xml(@xml)
+      end
+      
+      it 'should fetch name' do
+        @example.name.should == 'Joe'
+      end
+      
+      it 'should fetch category' do
+        @example.category.should == 'meat_popsicle'
+      end
+      
+      it 'should fetch numbers' do
+        @example.numbers.map(&:value).should == ['3035551212','3035551234']
       end
       
-      Fu::Bar.tag_name.should == 'bar'
+      it 'should fetch contacts' do
+        @example.contacts.map(&:value).should == ['3035551212','3035551234','test@example.com']
+      end
     end
-    
   end
   
-end
-
-describe OxMlk::Description do
-  describe 'being initiated' do
-    it 'should do something'
+  describe '#ox_attributes' do
+    it 'should return a list of attributes' do
+      @klass.ox_attributes.size.should == 2
+    end
+  end
+  
+  describe '#ox_elems' do
+    it 'should return a list of elements' do
+      @klass.ox_elems.size.should == 3
+    end
   end
 end
+

data/spec/spec_helper.rb

@@ -1,9 +1,21 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
 require 'oxmlk'
 require 'spec'
 require 'spec/autorun'
+require 'pathname'
 
 Spec::Runner.configure do |config|
   
 end
+
+DIR = Pathname.new(__FILE__ + '../..').expand_path.dirname
+
+def example(name)
+  DIR.join("examples/#{name}.rb")
+end
+
+def xml_for(name)
+  DIR.join("examples/xml/#{name}.xml")
+end

data/spec/xml_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe OxMlk::XML::Node, '#from' do
+  before(:all) do
+    @xml = xml_for(:posts)
+  end
+  
+  it 'should parse an XML::Document' do
+    data = OxMlk::XML::Document.new
+    node = OxMlk::XML::Node.new(:name)
+    data.root = node
+    OxMlk::XML::Node.from(data).should be_a(OxMlk::XML::Node)
+  end
+  
+  it 'should parse an XML::Node' do
+    data = OxMlk::XML::Node.new(:name)
+    OxMlk::XML::Node.from(data).should be_a(OxMlk::XML::Node)
+  end
+  
+  it 'should parse a File' do
+    data = File.new(@xml)
+    OxMlk::XML::Node.from(data).should be_a(OxMlk::XML::Node)
+  end
+  
+  it 'should parse a Path' do
+    data = Pathname.new(@xml)
+    OxMlk::XML::Node.from(data).should be_a(OxMlk::XML::Node)
+  end
+  
+  it 'should parse a URI' do
+    data = URI.parse("file:////#{File.expand_path(File.expand_path(@xml))}")
+    OxMlk::XML::Node.from(data).should be_a(OxMlk::XML::Node)
+  end
+  
+  it 'should parse a String' do
+    data = File.open(@xml).read
+    OxMlk::XML::Node.from(data).should be_a(OxMlk::XML::Node)
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: oxmlk
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Josh Robinson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-20 00:00:00 -06:00
+date: 2009-08-24 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
 description: OxMlk gives you a simple way to map you ruby objects to XML and then convert one to the other.
 email: hexorx@gmail.com
 executables: []
@@ -38,12 +58,19 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/example.rb
+- examples/posts.rb
+- examples/xml/example.xml
+- examples/xml/posts.xml
 - lib/oxmlk.rb
 - lib/oxmlk/description.rb
+- lib/oxmlk/xml.rb
 - oxmlk.gemspec
+- spec/description_spec.rb
 - spec/oxmlk_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/xml_spec.rb
 has_rdoc: true
 homepage: http://github.com/hexorx/oxmlk
 licenses: []
@@ -73,5 +100,9 @@ signing_key:
 specification_version: 3
 summary: Object 2 XML kit for ruby
 test_files: 
+- spec/description_spec.rb
 - spec/oxmlk_spec.rb
 - spec/spec_helper.rb
+- spec/xml_spec.rb
+- examples/example.rb
+- examples/posts.rb