acdc 0.7.3 → 0.7.4

data/README

@@ -17,20 +17,99 @@ This is a little XML-to-object-to-XML library that gets Dirty Deeds Done Dirt Ch
 AcDc::Body assists you with declaring XML objects with ease. And #acdc makes
 marshaling those objects from XML a breeze.
 
+==== Simple Data Model 
+
+This example will go over a simple Address data model and all of the ways you could use it.
+
+  require 'rubygems'
   require 'acdc'
-  class TheJack < AcDc::Body
-    attribute :shes_got, String
-    element :big_balls, String
+
+  class Address < AcDc::Body
+    attribute :type, String, :tag => "Type"
   end
 
-  jack = acdc("<thejack shes_got='big-balls'><big_balls>I've got big balls</big_balls></thejack>")
-  puts jack.shes_got
-  => "big-balls"
-  puts jack.big_balls
-  => "I've got big balls"
-  puts jack.acdc
-  => "<?xml version='1.0' encoding='UTF-8'?><thejack shes_got='big-balls'><big_balls>I've got big balls</big_balls></thejack>"
+  puts Address.new.acdc
+  #=> <?xml version="1.0" encoding="UTF-8"?><address Type=""></address>
+
+First thing to point out is the #attribute class method that allows you to specify
+the name of the method (:type) the type of the data (String) and the XML tag ("Type").
+
+You can also do this with #element. 
+
+  class Address < AcDc::Body
+    attribute :type, String, :tag => "Type"
+    element :street, String, :tag => "Street"
+  end
+
+  puts Address.new.acdc
+  #=> <?xml version="1.0" encoding="UTF-8"?><address Type=""><Street/></address>
+
+The :tag parameter is optional. The reason it's demonstrated here is simply to capitalize
+the attribute/element tag. You could :tag any element/attribute with another name for rendering.
+By default AcDc will output XML in lowercase. 
+
+  class Address < AcDc::Body
+    attribute :type, String
+    element :street, String
+  end
+
+  puts Address.new.acdc
+  #=> <?xml version="1.0" encoding="UTF-8"?><address type=""><street/></address>
+
+You could also specify a custom type for the second parameter. In the following example the
+Street element will be created as a custom type.
+
+  class Street < AcDc::Body
+    element :line_1, String
+  end
+
+  class Address < AcDc::Body
+    attribute :type, String
+    element :street, Street
+  end
+
+  add = Address.new
+  add.street = Street.new
+  add.street.line_1 = "1234 Somewhere"
+
+  puts add.acdc
+  #=> <?xml version="1.0" encoding="UTF-8"?><address type=""><street><line_1>1234 Somewhere</line_1></street></address>
+
+AcDc will also recognize collections of elements. You can do this with the :single
+parameter. Here is an example:
+
+  class Street < AcDc::Body
+     element :line_1, String
+  end
+  
+  class Address < AcDc::Body
+    attribute :type, String
+    element :streets, Street, :single => false
+  end
+
+  add = Address.new
+  street1 = Street.new
+  street2 = Street.new
+  street1.line_1 = "1234 Somewhere"
+  street2.line_1 = "5678 Somwhere Else"
+  add.streets = [street1,street2]
+  puts add.acdc
+  #=> <?xml version="1.0" encoding="UTF-8"?><address type=""><street><line_1>1234 Somewhere</line_1></street><street><line_1>5678 Somwhere Else</line_1></street></address>
+
+The final example is the Dc part - Xml to Object. The following example uses the Street and Address
+classes above and the #acdc method to derive the objects from the XML string.
 
+  addy = acdc <<EOF
+  <?xml version="1.0" encoding="UTF-8"?>
+  <address type="">
+  <street><line_1>1234 Somewhere</line_1></street>
+  <street><line_1>5678 Somwhere Else</line_1></street>
+  </address>
+  EOF
+  
+  puts addy.inspect
+  #<Address:0x3342f8 @type="", @streets=[#<Street:0x32abb8 @line_1="1234 Somewhere">, #<Street:0x329290 @line_1="5678 Somwhere Else">]>
+  
 == Contact
 
 - Author:: Clint Hill clint.hill@h3osoftware.com

data/lib/acdc.rb

@@ -11,7 +11,7 @@ class Boolean; end
 module AcDc
   
   DEFAULT_NAMESPACE = "acdc"
-  VERSION = [0,7,3]
+  VERSION = [0,7,4]
   
   def self.parseable_constants
     @parseables ||= []

data/lib/acdc/build.rb

@@ -6,7 +6,7 @@ module AcDc
     def acdc(root = true)
       xml = Builder::XmlMarkup.new
       attrs = self.class.attributes.inject({}){ |acc,attr| 
-        acc.update(attr.method_name => send(attr.method_name.to_sym))
+        acc.update(attr.tag => send(attr.method_name.to_sym))
       }
       attrs.update(:xmlns => self.class.namespace) if self.class.namespace
       xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8" if root
@@ -14,10 +14,20 @@ module AcDc
         self.class.elements.each do |elem|
           value = send(elem.method_name.to_sym)
           if value
-            if elem.primitive?
-              body.tag! elem.tag, value 
+            if elem.single?
+              if elem.primitive?
+                body.tag! elem.tag, value 
+              else
+                body << value.acdc(false)
+              end
             else
-              body << value.acdc(false)
+              value.each { |v|
+                if v.kind_of?(AcDc::Body)
+                  body << v.acdc(false)
+                else
+                  body.tag! elem.tag, v
+                end
+              }
             end
           else
             body.tag! elem.tag if elem.renderable?

data/lib/acdc/item.rb

@@ -28,6 +28,10 @@ module AcDc
       @constant ||= constantize(type)
     end
     
+    def single?
+      options[:single].nil? || options[:single]
+    end
+    
     def element?
       @xml_type == 'element'
     end
@@ -84,7 +88,7 @@ module AcDc
           namespace = "#{DEFAULT_NAMESPACE}:#{self.namespace}"
         end
         if element?
-          if(options[:single].nil? || options[:single])
+          if(single?)
             
             result = node.find_first(xpath(namespace), namespace)
 
@@ -106,7 +110,7 @@ module AcDc
             result = node.find(xpath(namespace))
           end
           if result
-            if(options[:single].nil? || options[:single])
+            if(single?)
               value = yield(result)
             else
               value = []

data/lib/acdc/mapping.rb

@@ -49,13 +49,10 @@ module AcDc
       
       private
         def make_accessor(item)
-          safe_name = item.name.tr('-','_') 
-          # I find this to be brittle because of other libraries ability
-          # to add methods the way we do. Leaving for now - however
-          # there has to be a better way to isolate the method name 
-          # from our own @elements/@attributes 
-          if instance_methods.include?(safe_name)
-            name = "#{item.element? ? "element_" : "attribute_"}#{safe_name}"
+          in_elems = elements.find{|e| e.name == item.name and e != item}
+          in_attrs = attributes.find{|a| a.name == item.name and a != item}
+          if in_elems or in_attrs
+            name = "#{item.element? ? "element_" : "attribute_"}#{item.name}"
             item.name = name
           end
           attr_accessor item.method_name.intern

data/lib/acdc/parse.rb

@@ -11,7 +11,7 @@ module AcDc
           node = XML::Parser.string(xml).parse.root
         end
       end
-      klass = AcDc.parseable_constants.detect{ |const|
+      klass = AcDc.parseable_constants.find{ |const|
         const.name.downcase =~ /#{node.name.downcase}/ || const.tag_name == node.name
       }
       if klass.nil?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acdc
 version: !ruby/object:Gem::Version 
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors: 
 - Clint Hill
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-10 00:00:00 -07:00
+date: 2010-01-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,6 +78,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: acdc 0.7.3
+summary: acdc 0.7.4
 test_files: []