acdc 0.2.5 → 0.5.0

data/README

@@ -9,22 +9,9 @@ This is a little XML-to-object-to-XML library that gets Dirty Deeds Done Dirt Ch
 * Take XML string objects and convert them to real Ruby objects from your library
 * Take real Ruby objects and convert them to XML strings
 * Declare XML elements/attributes easily and with type enforcement
-* Coerce objects to XML strings automatically (see JAIL_BREAK)
 
 == Usage
 
-=== Element
-
-A basic XML element is created with the use of the following constructor
-
-  require 'acdc'
-  elem = Element("Hells Bells")
-  puts elem.acdc
-  => "<Element>Hells Bells</Element>"
-  elem = Element("Hells Bells", {}, "BackInBlack")
-  puts elem.acdc
-  => "<BackInBlack>Hells Bells</BackInBlack>"
-
 === It's A Long Way To The Top, If You Want To Rock n Roll
 
 AcDc::Body assists you with declaring XML objects with ease. And #acdc makes
@@ -32,45 +19,30 @@ marshaling those objects from XML a breeze.
 
   require 'acdc'
   class TheJack < AcDc::Body
-    attribute :shes_got, "the jack"
-    element :big_balls
+    attribute :shes_got, String
+    element :big_balls, String
   end
-  rosie = TheJack.new(:big_balls => "I've got big balls")
-  puts rosie.big_balls
-  => "I've got big balls"
-  puts rosie.acdc
-  => "<TheJack shes_got="the jack"><BigBalls>I've got big balls</BigBalls></TheJack>"
-  who_made_who = acdc("<TheJack><BigBalls>Biggest Balls of them all</BigBalls></TheJack>")
-  puts who_made_who.class
-  => TheJack
-  puts who_made_who.big_balls
-  => "Biggest Balls of them all"
-
-=== JAIL_BREAK
-
-JAIL_BREAK will determine whether or not you need to explicitly coerce your
-objects to XML using Element#acdc or Body#acdc. It's may not be the smartest
-feature in the world, but we're gonna Ride On.
-
-==== Without JAIL_BREAK
 
-  require 'acdc'
-  XML_element = Element("TNT")
-  puts XML_element
-  => #<AcDc::Element:>
-  puts XML_element.acdc
-  => "<Element>TNT</Element>"
-
-==== With JAIL_BREAK
-
-  JAIL_BREAK = true
-  require 'acdc'
-  XML_element = Element("TNT")
-  puts XML_element
-  => "<Element>TNT</Element>"
+  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>"
 
 == Contact
 
 - Author:: Clint Hill clint.hill@h3osoftware.com
 - Home Page:: http://h3osoftware.com/acdc
-- GitHub:: git://github.com/clinth3o/acdc.git
+- GitHub:: git://github.com/clinth3o/acdc.git
+
+== Special Thanks
+
+I want to thank John Nunemaker for his HappyMapper gem. I stole quite a bit
+of code from that gem.
+http://railstips.org/2008/11/17/happymapper-making-xml-fun-again
+http://github.com/jnunemaker/happymapper/
+
+And if you might ask why not just use his library? Well - that's the acdc part
+of this story. He had the AC - I added the DC.

data/Rakefile

@@ -28,25 +28,24 @@ spec = Gem::Specification.new do |s|
      "lib/acdc.rb",
      "lib/acdc/attribute.rb",
      "lib/acdc/body.rb",
-     "lib/acdc/element.rb"
+     "lib/acdc/element.rb",
+     "lib/acdc/item.rb",
+     "lib/acdc/parse.rb"
   ]
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_runtime_dependency(%q<libxml-ruby>, [">= 1.1.3"])
       s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
-      s.add_runtime_dependency(%q<hpricot>, [">= 0.8"])
     else
-      s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_dependency(%q<libxml-ruby>, [">= 1.1.3"])
       s.add_dependency(%q<builder>, [">= 2.1.2"])
-      s.add_dependency(%q<hpricot>, [">= 0.8"])
     end
   else
-    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+    s.add_dependency(%q<libxml-ruby>, [">= 1.1.3"])
     s.add_dependency(%q<builder>, [">= 2.1.2"])
-    s.add_dependency(%q<hpricot>, [">= 0.8"])
   end
 end
 

data/lib/acdc/attribute.rb

@@ -1,20 +1,5 @@
 module AcDc
-  
-  # Attribute object used in Element and Body.
-  # Not often used outside of these.
-  class Attribute
-    
-    attr_accessor :name, :value
-    
-    def initialize(name,value)
-      @name = name
-      @value = value
-    end
-    
-    # Returns the values of this attribute in hash form
-    def to_hash
-      {@name => @value}
-    end
+  class Attribute < Item
     
   end
 end

data/lib/acdc/body.rb

@@ -1,205 +1,10 @@
 module AcDc
-  class Body 
-    
-    attr_accessor :attributes, :elements, :sequence
-    
-    # Populates the attributes and elements declared for this object.
-    #@option values [Hash] :attributes Hash list of attributes to populate
-    #@example Filling the values and attributes
-    # class ThunderStruck < Body
-    #   attribute :thunder
-    #   element :lightning
-    # end
-    # kaboom = ThunderStruck.new({:attributes => {:thunder => "boom"}, :lightning => "crash"})
-    def initialize(values = {})
-      @attributes ||= {}
-      @elements ||= {}
-      @sequence = values[:sequence] || 0
-      # catch default values for attributes
-      unless self.class.declared_attributes.values.all?{|val| val.nil?}
-        self.class.declared_attributes.each do |key,val|
-          attributes.update(key => Attribute(key,val)) unless val.nil?
-        end
-      end
-      # now set initialized attribute values
-      if values.has_key?(:attributes)
-        values.delete(:attributes).each do |key,val|
-          if self.class.declared_attributes.has_key?(key)
-            attributes.update(key => Attribute(key,val)) 
-          end
-        end
-      end
-      # and finally set values
-      values.each do |key,val|
-        if self.class.declared_elements.has_key?(key)
-          type = options_for(key)[:type]
-          validate(type,key,val)
-          if type and type.ancestors.include?(Body)
-            elements.update(key => type.new(val.to_hash.merge(:sequence => options_for(key)[:sequence]))) 
-          elsif type
-            # if it's an Element we want the value (avoids recursive value)
-            value = (val.respond_to?(:value)) ? val.value : val
-            elements.update(key => type.new(value, options_for(key)))
-          else
-            elements.update(key => Element(val, options_for(key)))
-          end
-        end
-      end
+  class Body
+    def self.inherited(child)
+      child.instance_variable_set("@attributes", {})
+      child.instance_variable_set("@elements",{})
     end
-    
-    # Converts object to XML
-    def acdc
-      xml = Builder::XmlMarkup.new
-      attrs = attributes.inject({}){|acc,attr| acc.update(attr[1].to_hash)}
-      xml.tag!(tag_name,attrs){ |body|
-        elements.sort{|a,b| a[1].sequence <=> b[1].sequence}.each do |key, elem|
-          body << elem.acdc
-        end
-      }
-      xml.target!
-    end
-    
-    # Calls #acdc then matches
-    def match(pattern)
-      acdc.match(pattern)
-    end
-    
-    def to_hash
-      elements
-    end
-    
-    # The name to use for the tag
-    def tag_name
-      self.class.to_s.split("::").last
-    end
-    
-    def method_missing(method_id, *args, &block)
-      key = method_id.to_s.gsub(/\=/,"").to_sym
-      if elements.has_key?(key) or attributes.has_key?(key)
-        (method_id.to_s.match(/\=$/)) ? write(method_id, *args, &block) : read(method_id)
-      else
-        super
-      end
-    end
-
-    class << self
-      def inherited(child)
-        child.instance_variable_set('@declared_elements', @declared_elements)
-        child.instance_variable_set('@declared_attributes', @declared_attributes)
-        child.instance_variable_set('@element_sequence', @element_sequence)
-      end
-      
-      # Declare an Element for this Body
-      # Sequence of elements (XML Schema sequence) is taken care of by the order
-      # the elements are declared in the class definition.
-      #@param [Symbol] name A name to assign the Element (tag name)
-      #@param [Class] type A type to use for the element (use this for type enforcement)
-      #@option options [Boolean] :single False if object is a collection
-      #@option options [String] :tag String determining the name to use in the XML tag
-      def element(*options)
-        name = options.first
-        type = options.second || nil unless options.second.is_a?(Hash)
-        opts = options.extract_options!
-        opts.merge!(:tag => name) if opts[:tag].nil?
-        declared_elements.update(name => opts.merge(:type => type, :sequence => next_sequence))
-      end
-      
-      # Declare an attribute for this Body
-      def attribute(name, value = nil)
-        declared_attributes.update(name => value)
-      end
-      
-      # Returns the Hash list of Elements declared
-      def declared_elements 
-        @elements ||= {}
-        @declared_elements ||= @elements[to_s] ||= {}
-      end
-      
-      # Returns a Hash list of Attributes declared
-      def declared_attributes 
-        @attributes ||= {}
-        @declared_attributes ||= @attributes[to_s] ||= {}
-      end
-      
-      # Converts the XML to a Class object found in the library
-      def acdc(xml)
-        doc = Hpricot.XML(xml)
-        klass = doc.root.name.constantize
-        attributes = doc.root.attributes.inject({}){|acc,attr| acc.update(attr[0].to_sym => attr[1])}
-        values = doc.root.children.inject({}) do |acc, node|
-          name = node.name.underscore.to_sym
-          value = value_from_node(node)
-          attrs = node.attributes
-          acc.merge!({name => value, :attributes => attrs})
-        end
-        klass.new(values.merge(:attributes => attributes))
-      end
-      
-      private
-        def value_from_node(node)
-          if node.respond_to?(:children) and node.children
-            values = node.children.collect do |child|
-              return child.inner_text if child.text?
-              instantiate(child)
-            end      
-            (values.size == 1) ? values.first : values    
-          end
-        end
-      
-        def instantiate(node)
-          name = node.name
-          attrs = node.attributes
-          klass = name.constantize
-          klass.new(value_from_node(node), :attributes => attrs)
-        end
-        
-        def next_sequence
-          @element_sequence ||= 0
-          @element_sequence = @element_sequence +=1
-        end
-    end
-    
-    private
-    
-      def validate(type, key, val)
-        if type
-          if val.respond_to?(:each)
-            val.each {|v| raise ArgumentError.new("#{val.class} type is invalid. #{self.class} #{key} requires #{type}.") unless v.is_a?(type)}
-          else
-             unless val.is_a?(type)
-                raise ArgumentError.new("#{val.class} type is invalid. #{self.class} #{key} requires #{type}.")
-              end
-          end
-        end
-      end
-      
-      def options_for(key)
-        self.class.declared_elements[key]
-      end
-      
-      def read(method_id)
-        if elements.has_key?(method_id)
-          elements[method_id]
-        else
-          attributes[method_id].value
-        end
-      end
-    
-      def write(method_id, *args, &block)
-        key = method_id.to_s.gsub(/\=$/,"").to_sym
-        if elements.has_key?(key)
-          type = options_for(key)[:type]
-          if type and type.ancestors.include?(Body)
-            elements.update(key => type.new(args.first.to_hash, options_for(key)))
-          elsif type
-            elements.update(key => type.new(args.first, options_for(key)))
-          else
-            elements.update(key => Element(args.first, options_for(key)))
-          end
-        else
-          attributes.update(key => Attribute(key,args.first))
-        end
-      end
-
+    extend(ClassMethods)
+    extend(Parsing)
   end
 end

data/lib/acdc/element.rb

@@ -1,82 +1,5 @@
 module AcDc
-  
-  # Basic XML Element
-  class Element
-    
-    attr_accessor :value, :tag, :attributes, :options
-    
-    # Constructor with the following:
-    #@param [Object] value Any value to place in the tags
-    #@option options [Boolean] :single False if object is a collection 
-    #@option options [String] :tag A tag name to use if not Element
-    def initialize(value=nil, options={})
-      @tag = options[:tag] ||= self.class.to_s.split("::").last
-      @value = value
-      @options = options
-      @attributes = options.delete(:attributes)
-    end
-    
-    # Converts the object to XML
-    def acdc
-      xml = Builder::XmlMarkup.new
-      if value.nil?
-        xml.tag!(tag_content)
-      else
-        has_many? ? render_many(xml) : xml.tag!(tag_content) {|elem| elem << content}
-      end
-      xml.target!
-    end
-    
-    # Calls #acdc then matches
-    def match(pattern)
-      acdc.match(pattern)
-    end
-    
-    # True if object has a collection of values
-    def has_many?
-      options.has_key?(:single) and !options[:single] and value.size > 1
-    end
-    
-    # The name to use for the tag
-    def tag_name 
-      tag.to_s
-    end
-    
-    # Overridden to compare the values and not the whole object
-    def eql?(other)
-      return false if other.nil?
-      return false unless other.kind_of?(self.class)
-      value.eql?(other.value)
-    end
-    
-    def sequence
-      @options[:sequence]
-    end
-    
-    private
-      def tag_content
-        (attributes.nil? or attributes.empty?) ? tag_name : [tag_name,attributes]
-      end
-      
-      def content
-        if has_many?
-          value.inject(""){|xml,val| xml << (val.is_a?(Element) ? val.acdc : val.to_s)}
-        else
-          value.respond_to?(:acdc) ? value.acdc : value.to_s
-        end
-      end
-      
-      def render_many(xml)
-        if value.respond_to?(:each)
-          xml.tag!(tag_content){|elem|
-            value.each{|val| 
-              raise Exception.new("Can't render non-Element multiple times.") unless val.respond_to?(:acdc)
-              elem << val.acdc
-            }
-          }
-        else
-          xml.tag!(tag_content) {|elem| elem << content}
-        end
-      end
+  class Element < Item
+   
   end
 end

data/lib/acdc/item.rb

@@ -0,0 +1,144 @@
+module AcDc
+  class Item 
+    
+    Types = [String, Float, Time, Date, DateTime, Integer, Boolean]
+    attr_accessor :name, :type, :tag, :options, :namespace
+    
+    def initialize(name, type, options={})
+      @name = name.to_s
+      @type = type
+      @tag = options.delete(:tag) || name.to_s
+      @options = options
+      @xml_type = self.class.to_s.split('::').last.downcase
+    end
+    
+    def method_name
+      @method_name ||= name.tr('-','_')
+    end
+    
+    def constant
+      @constant ||= constantize(type)
+    end
+    
+    def element?
+      @xml_type == 'element'
+    end
+    
+    def attribute?
+      !element?
+    end
+    
+    def value_from_xml(node, namespace)
+      if primitive?
+        find(node, namespace) do |n|
+          value = n.respond_to?(:content) ? n.content : n.to_s
+          typecast(value)
+        end
+      else
+        constant.parse(node, options)
+      end
+    end
+    
+    def primitive?
+      Types.include?(constant)
+    end
+    
+    def xpath(namespace = self.namespace)
+      xpath  = ''
+      xpath += "#{DEFAULT_NAMESPACE}:" if namespace
+      xpath += tag
+      xpath
+    end
+    
+    private
+      def constantize(type)
+        if type.is_a?(String)
+          names = type.split('::')
+          constant = Object
+          names.each do |name|
+            constant =  constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+          end
+          constant
+        else
+          type
+        end
+      end
+      
+      def find(node, namespace, &block)
+        if options[:namespace] == false
+          namespace = nil
+        elsif options[:namespace]
+          # from an element definition
+          namespace = "#{DEFAULT_NAMESPACE}:#{options[:namespace]}"
+        elsif self.namespace
+          # this node has a custom namespace (that is present in the doc)
+          namespace = "#{DEFAULT_NAMESPACE}:#{self.namespace}"
+        end
+        
+        if element?
+          if(options[:single].nil? || options[:single])
+            result = node.find_first(xpath(namespace), namespace)
+          else
+            result = node.find(xpath(namespace))
+          end
+         
+          if result
+            if(options[:single].nil? || options[:single])
+              value = yield(result)
+            else
+              value = []
+              result.each do |res|
+                value << yield(res)
+              end
+            end
+            if options[:attributes].is_a?(Hash)
+              result.attributes.each do |xml_attribute|
+                if attribute_options = options[:attributes][xml_attribute.name.to_sym]
+                  attribute_value = Attribute.new(xml_attribute.name.to_sym, *attribute_options).from_xml_node(result, namespace)
+                  result.instance_eval <<-EOV
+                    def value.#{xml_attribute.name}
+                      #{attribute_value.inspect}
+                    end
+                  EOV
+                end
+              end
+            end
+            value
+          else
+            nil
+          end
+        else
+          yield(node[tag])
+        end
+      end
+      
+      def typecast(value)
+        return value if value.kind_of?(constant) || value.nil?
+        begin        
+          if    constant == String    then value.to_s
+          elsif constant == Float     then value.to_f
+          elsif constant == Time      then Time.parse(value.to_s)
+          elsif constant == Date      then Date.parse(value.to_s)
+          elsif constant == DateTime  then DateTime.parse(value.to_s)
+          elsif constant == Boolean   then ['true', 't', '1'].include?(value.to_s.downcase)
+          elsif constant == Integer
+            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
+  end
+end

data/lib/acdc/parse.rb

@@ -0,0 +1,65 @@
+module AcDc
+  module Parsing
+    
+    def acdc(xml, options={})
+      
+      if xml.is_a?(XML::Node)
+        node = xml
+      else
+        if xml.is_a?(XML::Document)
+          node = xml.root
+        else
+          node = XML::Parser.string(xml).parse.root
+        end
+      end
+      
+      klass = constantize(node.name)
+      
+      root = node.name.downcase == klass.tag_name
+      
+      namespace = node.namespaces.default
+      namespace = "#{DEFAULT_NAMESPACE}:#{namespace}" if namespace
+      
+      xpath = root ? '/' : './/'
+      xpath += "#{DEFAULT_NAMESPACE}:" if namespace
+      xpath += node.name
+      
+      nodes = node.find(xpath, Array(namespace))
+      
+      collection = nodes.collect do |n|
+        obj = klass.new
+        klass.attributes.each do |attr|
+          obj.send("#{attr.method_name}=", attr.value_from_xml(n, namespace))
+        end
+        klass.elements.each do |elem|
+          obj.send("#{elem.method_name}=", elem.value_from_xml(n, namespace))
+        end
+        obj
+      end
+      
+      nodes = nil
+      
+      if options[:single] || root
+        collection.first
+      else
+        collection
+      end
+    end
+    
+    private
+      
+      def constantize(type)
+        if type.is_a?(String)
+          names = type.split('::')
+          constant = Object
+          names.each do |name|
+            constant = const_defined?(name) ? const_get(name) : const_missing(name)
+          end
+          constant
+        else
+          type
+        end
+      end
+    
+  end
+end

data/lib/acdc.rb

@@ -1,35 +1,69 @@
+require 'date'
+require 'time'
 require 'rubygems'
+gem 'libxml-ruby', '= 1.1.3'
+require 'xml'
+gem 'builder'
 require 'builder'
-require 'activesupport'
-require 'hpricot'
-                                          
-require File.join(File.dirname(__FILE__),"acdc","attribute")
-require File.join(File.dirname(__FILE__),"acdc","element")
-require File.join(File.dirname(__FILE__),"acdc","body")
+
+class Boolean; end
 
 module AcDc
   
-  VERSION = [0,2,5] unless defined?(AcDc::VERSION)
+  DEFAULT_NAMESPACE = "example" unless defined?(AcDc::DEFAULT_NAMESPACE)
+  VERSION = [0,5,0] unless defined?(AcDc::VERSION)
   
   if defined?(JAIL_BREAK)
-    Element.class_eval{ alias :to_s :acdc }
-    Body.class_eval{ alias :to_s :acdc }
+    puts "AcDc is live -- Dirty Deeds!"
   end
-  
-end
 
-# Will construct a AcDc::Element classs
-def Element(value, options = {})
-  AcDc::Element.new(value,options)
-end
+  def self.included(base)
+    base.instance_variable_set("@attributes",{})
+    base.instance_variable_set("@elements",{})
+    base.extend(ClassMethods)
+    base.extend(Parsing)
+  end
+  
+  module ClassMethods
+    
+    def attributes
+      @attributes[to_s] || []
+    end
 
-# Will construct a AcDc::Attribute class
-def Attribute(name,value)
-  AcDc::Attribute.new(name,value)
-end
+    def elements
+      @elements[to_s] || []
+    end  
+    
+    def attribute(name, type, options={})
+      attribute = Attribute.new(name,type,options)
+      @attributes[to_s] ||= []
+      @attributes[to_s] << attribute
+      attr_accessor attribute.method_name.intern
+    end
+    
+    def element(name, type, options={})
+      element = Element.new(name,type,options)
+      @elements[to_s] ||= []
+      @elements[to_s] << element
+      attr_accessor element.method_name.intern
+    end
+    
+    def tag_name(name = nil)
+      @tag_name = name.to_s if name
+      @tag_name ||= to_s.split('::')[-1].downcase
+    end
 
-# Will convert the XML to a class found in the library
-def acdc(xml)
-  AcDc::Body.acdc(xml)
+    def namespace(namespace = nil)
+      @namespace = namespace if namespace
+      @namespace
+    end
+    
+  end
+  
 end
-
+require File.join(File.dirname(__FILE__), 'acdc/build')
+require File.join(File.dirname(__FILE__), 'acdc/parse')
+require File.join(File.dirname(__FILE__), 'acdc/item')
+require File.join(File.dirname(__FILE__), 'acdc/attribute')
+require File.join(File.dirname(__FILE__), 'acdc/element')
+require File.join(File.dirname(__FILE__), 'acdc/body')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acdc
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.5.0
 platform: ruby
 authors: 
 - Clint Hill
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-03 00:00:00 -07:00
+date: 2009-11-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: libxml-ruby
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.2
+        version: 1.1.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -32,16 +32,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.1.2
     version: 
-- !ruby/object:Gem::Dependency 
-  name: hpricot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.8"
-    version: 
 description: "    This is a little xml-to-object-to-xml library that gets Dirty Deeds Done Dirt Cheap. \n"
 email: clint.hill@h3osoftware.com
 executables: []
@@ -58,6 +48,8 @@ files:
 - lib/acdc/attribute.rb
 - lib/acdc/body.rb
 - lib/acdc/element.rb
+- lib/acdc/item.rb
+- lib/acdc/parse.rb
 has_rdoc: true
 homepage: http://h3osoftware.com/acdc
 licenses: []