acdc 0.2.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2009 Clint Hill - h3o(software)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,76 @@
+= AC/DC - h3o(software)
+
+== For Those About To Rock
+
+This is a little XML-to-object-to-XML library that gets Dirty Deeds Done Dirt Cheap. 
+
+== Features
+
+* 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
+marshaling those objects from XML a breeze.
+
+  require 'acdc'
+  class TheJack < AcDc::Body
+    attribute :shes_got, "the jack"
+    element :big_balls
+  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>"
+
+== Contact
+
+- Author:: Clint Hill clint.hill@h3osoftware.com
+- Home Page:: http://h3osoftware.com/acdc
+- GitHub:: git://github.com/clinth3o/acdc.git

data/Rakefile

@@ -0,0 +1,201 @@
+require 'rake'
+require 'rake/clean'                       
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'fileutils'
+require 'yard'
+include FileUtils
+require File.join(File.dirname(__FILE__),"lib","acdc")
+include AcDc
+
+spec = Gem::Specification.new do |s|
+  s.name = "acdc"
+  s.version = AcDc::VERSION.join(".")
+  s.platform = Gem::Platform::RUBY
+  s.author = "Clint Hill"
+  s.email = "clint.hill@h3osoftware.com"
+  s.homepage = "http://h3osoftware.com/acdc"
+  s.summary = "AC/DC by h3o(software)"
+  s.description = <<-EOF
+    This is a little xml-to-object-to-xml library that gets Dirty Deeds Done Dirt Cheap. 
+  EOF
+  s.rubyforge_project = "acdc"
+  s.require_path = "lib"
+  s.files = [
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "lib/acdc.rb",
+     "lib/acdc/attribute.rb",
+     "lib/acdc/body.rb",
+     "lib/acdc/element.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<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<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<builder>, [">= 2.1.2"])
+    s.add_dependency(%q<hpricot>, [">= 0.8"])
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |package|
+ package.gem_spec = spec
+end
+
+
+
+##############################################################################
+# rSpec
+##############################################################################
+desc 'Run all specs and rcov'
+task :spec => ["spec:default"]
+namespace :spec do
+  Spec::Rake::SpecTask.new('default') do |t|
+      t.spec_opts = ["--format", "specdoc", "--colour"]
+      t.spec_files = Dir['spec/**/*_spec.rb'].sort
+      t.libs = ['lib','lib/acdc'] 
+  end
+end
+
+##############################################################################
+# Documentation
+##############################################################################
+task :doc => ["doc:yardoc"]
+namespace :doc do
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ['-odoc/yardoc', '-rREADME', '-mtextile'] # optional
+  end
+end
+
+#############################################################################
+# Stats
+#############################################################################
+STATS_DIRECTORIES = [
+  %w(AcDc       lib/acdc),
+  %w(Specs      spec)
+].collect { |name, dir| [ name, "#{Dir.pwd}/#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+
+desc "Report code statistics (KLOCs, etc) from the application"
+task :stats do
+  CodeStatistics.new(*STATS_DIRECTORIES).to_s
+end
+
+class CodeStatistics #:nodoc:
+
+  TEST_TYPES = %w(Specs)
+
+  def initialize(*pairs)
+    @pairs      = pairs
+    @statistics = calculate_statistics
+    @total      = calculate_total if pairs.length > 1
+  end
+
+  def to_s
+    print_header
+    @pairs.each { |pair| print_line(pair.first, @statistics[pair.first]) }
+    print_splitter
+  
+    if @total
+      print_line("Total", @total)
+      print_splitter
+    end
+
+    print_code_test_stats
+  end
+
+  private
+    def calculate_statistics
+      @pairs.inject({}) { |stats, pair| stats[pair.first] = calculate_directory_statistics(pair.last); stats }
+    end
+
+    def calculate_directory_statistics(directory, pattern = /.*\.rb$/)
+      stats = { "lines" => 0, "codelines" => 0, "classes" => 0, "methods" => 0 }
+
+      Dir.foreach(directory) do |file_name| 
+        if File.stat(directory + "/" + file_name).directory? and (/^\./ !~ file_name)
+          newstats = calculate_directory_statistics(directory + "/" + file_name, pattern)
+          stats.each { |k, v| stats[k] += newstats[k] }
+        end
+
+        next unless file_name =~ pattern
+
+        f = File.open(directory + "/" + file_name)
+
+        while line = f.gets
+          stats["lines"]     += 1
+          stats["classes"]   += 1 if line =~ /class [A-Z]/
+          stats["methods"]   += 1 if line =~ /def [a-z]/
+          stats["codelines"] += 1 unless line =~ /^\s*$/ || line =~ /^\s*#/
+        end
+      end
+
+      stats
+    end
+
+    def calculate_total
+      total = { "lines" => 0, "codelines" => 0, "classes" => 0, "methods" => 0 }
+      @statistics.each_value { |pair| pair.each { |k, v| total[k] += v } }
+      total
+    end
+
+    def calculate_code
+      code_loc = 0
+      @statistics.each { |k, v| code_loc += v['codelines'] unless TEST_TYPES.include? k }
+      code_loc
+    end
+
+    def calculate_tests
+      test_loc = 0
+      @statistics.each { |k, v| test_loc += v['codelines'] if TEST_TYPES.include? k }
+      test_loc
+    end
+
+    def print_header
+      print_splitter
+      puts "| Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |"
+      print_splitter
+    end
+
+    def print_splitter
+      puts "+----------------------+-------+-------+---------+---------+-----+-------+"
+    end
+
+    def print_line(name, statistics)
+      m_over_c   = (statistics["methods"] / statistics["classes"])   rescue m_over_c = 0
+      loc_over_m = (statistics["codelines"] / statistics["methods"]) - 2 rescue loc_over_m = 0
+
+      start = if TEST_TYPES.include? name
+        "| #{name.ljust(20)} "
+      else
+        "| #{name.ljust(20)} " 
+      end
+
+      puts start + 
+           "| #{statistics["lines"].to_s.rjust(5)} " +
+           "| #{statistics["codelines"].to_s.rjust(5)} " +
+           "| #{statistics["classes"].to_s.rjust(7)} " +
+           "| #{statistics["methods"].to_s.rjust(7)} " +
+           "| #{m_over_c.to_s.rjust(3)} " +
+           "| #{loc_over_m.to_s.rjust(5)} |"
+    end
+
+    def print_code_test_stats
+      code  = calculate_code
+      tests = calculate_tests
+
+      puts "  Code LOC: #{code}     Test LOC: #{tests}     Code to Test Ratio: 1:#{sprintf("%.1f", tests.to_f/code)}"
+      puts ""
+    end
+end

data/lib/acdc.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+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")
+
+module AcDc
+  
+  VERSION = [0,2,2] unless defined?(AcDc::VERSION)
+  
+  if defined?(JAIL_BREAK)
+    Element.class_eval{ alias :to_s :acdc }
+    Body.class_eval{ alias :to_s :acdc }
+  end
+  
+end
+
+# Will construct a AcDc::Element classs
+def Element(value, options = {})
+  AcDc::Element.new(value,options)
+end
+
+# Will construct a AcDc::Attribute class
+def Attribute(name,value)
+  AcDc::Attribute.new(name,value)
+end
+
+# Will convert the XML to a class found in the library
+def acdc(xml)
+  AcDc::Body.acdc(xml)
+end
+

data/lib/acdc/attribute.rb

@@ -0,0 +1,20 @@
+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
+    
+  end
+end

data/lib/acdc/body.rb

@@ -0,0 +1,190 @@
+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]
+          if type
+            if val.respond_to?(:each)
+              val.each {|v| raise ArgumentError.new("Type is invalid") unless v.is_a?(type)}
+            else
+              raise ArgumentError.new("Type is invalid") unless val.is_a?(type)
+            end
+            if type.ancestors.include?(Body)
+              elements.update(key => type.new(val.to_hash.merge(:sequence => options_for(key)[:sequence]))) 
+            else
+              elements.update(key => type.new(val, options_for(key)))
+            end
+          else
+            elements.update(key => Element(val, options_for(key)))
+          end
+        end
+      end
+    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 (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 options_for(key)
+        self.class.declared_elements[key]
+      end
+      
+      def read(method_id)
+        if elements.has_key?(method_id)
+          elements[method_id].value
+        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)
+          elements.update(key => Element(args.first, options_for(key)))
+        else
+          attributes.update(key => Attribute(key,args.first))
+        end
+      end
+
+  end
+end

data/lib/acdc/element.rb

@@ -0,0 +1,82 @@
+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
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: acdc
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Clint Hill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !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: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/acdc.rb
+- lib/acdc/attribute.rb
+- lib/acdc/body.rb
+- lib/acdc/element.rb
+has_rdoc: true
+homepage: http://h3osoftware.com/acdc
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: acdc
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: AC/DC by h3o(software)
+test_files: []
+