oxmlk 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/examples/example.rb

@@ -3,6 +3,7 @@ class Number
   
   ox_tag :number
   
+  ox_attr :group, :from => :attr
   ox_attr(:value, :from => :content)
 end
 
@@ -11,6 +12,7 @@ class Email
   
   ox_tag :email
   
+  ox_attr :group, :from => :attr
   ox_attr(:value, :from => :content)
 end
 
@@ -20,11 +22,11 @@ class Person
   ox_tag :person
   
   ox_attr(:category, :from => :attr)
-  ox_attr(:two_attr, :from => '@attr2')
+  ox_attr(:alt, :from => '@alt')
   
   ox_attr(:name)
-  ox_attr(:numbers, :as => [Number], :freeze => false)
   ox_attr(:contacts, :as => [Number,Email], :freeze => true)
+  ox_attr(:friends, :as => [Person], :in => :friends, :freeze => false)
   
   def say_hello(xml)
     'hello'

data/examples/xml/example.xml

@@ -1,4 +1,4 @@
-<person category="meat_popsicle">
+<person category="meat_popsicle" alt="human">
   <name>Joe</name>
   <number group="main">3035551212</number>
   <number group="cell">3035551234</number>

data/lib/oxmlk.rb

@@ -6,11 +6,19 @@ require 'activesupport'
 module OxMlk
   
   def self.included(base)
-    base.extend ClassMethods
+    base.class_eval do
+      include InstanceMethods
+      extend ClassMethods
+    end
+  end
+  
+  module InstanceMethods
+    def to_xml
+      self.class.to_xml(self)
+    end
   end
   
   module ClassMethods
-    
     def ox_attrs
       @ox_attrs ||= []
     end
@@ -21,9 +29,26 @@ module OxMlk
       attr new_attr.accessor, new_attr.writable?
     end
     
+    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
+    
+    def xml_array(data)
+      [ ox_tag, 
+        ox_elems.map {|x| x.to_xml(data)}.flatten,
+        ox_attributes.map {|x| x.to_xml(data)} ]
+    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
@@ -38,16 +63,8 @@ module OxMlk
       ox
     end
     
-    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
+    def to_xml(data)
+      XML::Node.build(*xml_array(data))
     end
     
   end

data/lib/oxmlk/description.rb

@@ -18,7 +18,8 @@ module OxMlk
       @froze = o.delete(:freeze)
       @from = o.delete(:from)
       @as = o.delete(:as)
-      @wrapper = o.delete(:wrapper)
+      @in = o.delete(:in)
+      @tag = o.delete(:tag)
       @name = name.to_s
       
       @is_attribute = computed_is_attribute
@@ -62,6 +63,10 @@ module OxMlk
       @as.is_a?(Array)
     end
     
+    def content?
+      @from == :content || @from == '.'
+    end
+    
     def ox_object?
       return false if [*@as].empty?
       [*@as].all? {|x| x.respond_to?(:from_xml)}
@@ -88,6 +93,24 @@ module OxMlk
       (nodes).map {|n| process(n,instance)}
     end
     
+    def to_xml(data)
+      value = data.send(accessor)
+      
+      return [] if value.nil?
+      return [accessor.to_s,value.to_s] if attribute?
+      
+      nodes = [*value].map do |node|
+        if node.respond_to?(:to_xml)
+          node.to_xml
+        elsif content?
+          XML::Node.new_text(node.to_s)
+        else
+          XML::Node.new(accessor, node.to_s)
+        end
+      end
+      @in ? XML::Node.build(@in, nodes) : nodes
+    end
+    
   protected
   
     def computed_xpath
@@ -120,7 +143,7 @@ module OxMlk
     end
     
     def wrap(xpath=nil)
-      [@wrapper,xpath].compact.join('/')
+      [@in,xpath].compact.join('/')
     end
   end
 end

data/lib/oxmlk/xml.rb

@@ -26,6 +26,13 @@ module OxMlk
           raise 'Invalid XML data'
         end
       end
+      
+      def self.build(name,nodes=[],attributes={})
+        node = new(name)
+        nodes.each {|n| node << n}
+        attributes.each {|x| node[x.first.to_s] = x.last.to_s unless x.last.to_s.blank?}
+        node
+      end
     end
   end
 end

data/oxmlk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oxmlk}
-  s.version = "0.1.0"
+  s.version = "0.2.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-24}
+  s.date = %q{2009-08-26}
   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 = [

data/spec/description_spec.rb

@@ -9,7 +9,7 @@ describe OxMlk::Description do
     @klass = Person
   end
   
-  describe 'xpath' do
+  describe '#xpath' do
     it 'should be name by default' do
       @desc = OxMlk::Description.new(:name)
       @desc.xpath.should == 'name'
@@ -45,34 +45,34 @@ describe OxMlk::Description do
       @desc.xpath.should == 'number|person'
     end
     
-    it 'should add wrapper + / to xpath if wrapper is passed' do
-      @desc = OxMlk::Description.new(:person, :wrapper => :friends)
+    it 'should add in + / to xpath if :in is passed' do
+      @desc = OxMlk::Description.new(:person, :in => :friends)
       @desc.xpath.should == 'friends/person'
     end
   end
   
-  describe 'accessor' do
+  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
+  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
+  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
+  describe '#writable?' do
     it 'should be true by default' do
       @desc = OxMlk::Description.new(:name)
       @desc.writable?.should be_true
@@ -89,7 +89,7 @@ describe OxMlk::Description do
     end
   end
   
-  describe 'attribute?' do
+  describe '#attribute?' do
     it 'should be true if :from starts with @' do
       @desc = OxMlk::Description.new(:name, :from => '@name')
       @desc.attribute?.should be_true
@@ -101,7 +101,7 @@ describe OxMlk::Description do
     end
   end
   
-  describe 'elem?' do
+  describe '#elem?' do
     it 'should be true if attribute? is false' do
       @desc = OxMlk::Description.new(:name)
       @desc.elem?.should be_true
@@ -113,7 +113,7 @@ describe OxMlk::Description do
     end
   end
   
-  describe 'ox_type' do
+  describe '#ox_type' do
     it 'should be :elem if elem? is true' do
       @desc = OxMlk::Description.new(:name)
       @desc.ox_type.should == :elem
@@ -125,7 +125,7 @@ describe OxMlk::Description do
     end
   end
   
-  describe 'collection?' do
+  describe '#collection?' do
     it 'should be true if :as is an Array' do
       @desc = OxMlk::Description.new(:name, :as => [])
       @desc.collection?.should be_true
@@ -137,7 +137,7 @@ describe OxMlk::Description do
     end
   end
   
-  describe 'ox_object?' do
+  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
@@ -159,7 +159,29 @@ describe OxMlk::Description do
     end
   end
   
-  describe 'from_xml' do
+  describe '#content?' do
+    it 'should return true if :from is :content' do
+      @desc = OxMlk::Description.new(:number, :from => :content)
+      @desc.content?.should be_true
+    end
+    
+    it 'should return true if :from is "."' do
+      @desc = OxMlk::Description.new(:number, :from => '.')
+      @desc.content?.should be_true
+    end
+    
+    it 'should return false if :from is nil' do
+      @desc = OxMlk::Description.new(:number)
+      @desc.content?.should be_false
+    end
+    
+    it 'should return false if :from is string other than "."' do
+      @desc = OxMlk::Description.new(:number, :from => 'hi')
+      @desc.content?.should be_false
+    end
+  end
+  
+  describe '#from_xml' do
     
     it 'should accept xml argument' do
       @desc = OxMlk::Description.new(:name)
@@ -218,4 +240,22 @@ describe OxMlk::Description do
       @desc.from_xml(@xml, @klass.new).first.should be_a(Number)
     end
   end
+  
+  describe '#to_xml' do
+    before(:all) do
+      @ox = Person.from_xml(@xml)
+      @attr = Person.ox_attributes.first
+      @elem = Person.ox_elems.first
+    end
+    
+    it 'should return an Array of Strings if it is an attribute' do
+      @attr.to_xml(@ox).should be_a(Array)
+      @attr.to_xml(@ox).first.should be_a(String)
+    end
+    
+    it 'should return an Array of nodes if it is an elem' do
+      @elem.to_xml(@ox).should be_a(Array)
+      @elem.to_xml(@ox).first.should be_a(OxMlk::XML::Node)
+    end
+  end
 end

data/spec/oxmlk_spec.rb

@@ -1,37 +1,53 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe OxMlk do
+describe OxMlk::InstanceMethods do
   
   before(:all) do
     require example(:example)
-    @klass = Person
+    @xml = xml_for(:example)
+    @ox = Person.from_xml(@xml)
   end
   
-  describe 'being included into another class' do
-    it 'should set ox_attrs to an array' do
-      @klass.ox_attrs.should be_a(Array)
+  describe '#to_xml' do
+    before(:all) do
+      @oxml = @ox.to_xml
+      @doc = OxMlk::XML::Document.new
+      @doc.root = @oxml
     end
     
-    it 'should add an ox_attr method' do
-      @klass.should respond_to(:ox_attr)
+    it 'should return a XML::Node' do
+      @oxml.should be_a(OxMlk::XML::Node)
     end
     
-    it 'should add a from_xml method' do
-      @klass.should respond_to(:from_xml)
+    it 'should set name to Class.ox_tag' do
+      @oxml.name.should == 'person'
     end
-
-    it 'should add an ox_attributes method' do
-      @klass.should respond_to(:ox_attributes)
+    
+    it 'should set elements' do
+      @oxml.children.map(&:name).should == ['name','number','number','email','friends']
+    end
+    
+    it 'should set content to text node' do
+      @oxml.find_first('number').child.should be_text
     end
     
-    it 'should add an ox_elems method' do
-      @klass.should respond_to(:ox_elems)
+    it 'should set attributes' do
+      @oxml['category'].should == 'meat_popsicle'
+      @oxml['alt'].should == 'human'
     end
     
-    it 'should add a tag_name method' do
-      @klass.should respond_to(:ox_tag)
+    it 'should produce same xml as created it' do
+      @oxml.to_s.should == OxMlk::XML::Node.from(@xml).to_s
     end
   end
+end
+
+describe OxMlk::ClassMethods do
+  
+  before(:all) do
+    require example(:example)
+    @klass = Person
+  end
   
   describe '#ox_attr' do
     it 'should add an OxMlk::Description to the class' do
@@ -46,12 +62,12 @@ describe OxMlk do
       @klass.new.should respond_to(:name=)
     end
 
-    it 'should add a writter method when :freeze => false' do
-      @klass.new.should respond_to(:numbers=)
+    it 'should add not a writter method when :freeze => true' do
+      @klass.new.should_not respond_to(:contacts=)
     end
   
-    it 'should not add a writter method when :freeze => true' do
-      @klass.new.should_not respond_to(:contacts=)
+    it 'should add a writter method when :freeze => false' do
+      @klass.new.should respond_to(:friends=)
     end
   end
     
@@ -79,13 +95,13 @@ describe OxMlk do
         @example.category.should == 'meat_popsicle'
       end
       
-      it 'should fetch numbers' do
-        @example.numbers.map(&:value).should == ['3035551212','3035551234']
-      end
-      
       it 'should fetch contacts' do
         @example.contacts.map(&:value).should == ['3035551212','3035551234','test@example.com']
       end
+      
+      it 'should fetch friends' do
+        @example.friends.map(&:name).should == ['Bob','John']
+      end
     end
   end
   

data/spec/xml_spec.rb

@@ -36,5 +36,29 @@ describe OxMlk::XML::Node, '#from' do
     data = File.open(@xml).read
     OxMlk::XML::Node.from(data).should be_a(OxMlk::XML::Node)
   end
+end
+
+describe OxMlk::XML::Node, '#build' do
+  before(:all) do
+    @node = OxMlk::XML::Node
+    @nodes = [@node.new('one'),@node.new('two'),@node.new('three')]
+    @attributes = [[1,2],[3,4]]
+    @args = ['name',@nodes,@attributes]
+  end
+  
+  it 'should return a new node' do
+    @node.build(*@args).should be_a(@node)
+  end
   
+  it 'should set its name to the first argument' do
+    @node.build(*@args).name.should == 'name'
+  end
+  
+  it 'should set its children to second argument' do
+    @node.build(*@args).children.should == @nodes
+  end
+  
+  it 'should set its attributes to the third argument' do
+    @node.build(*@args).should be_attributes
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: oxmlk
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Josh Robinson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-24 00:00:00 -06:00
+date: 2009-08-26 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency