clinth3o-acdc 0.1.0

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,178 @@
+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
+  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        = %w( LICENSE README Rakefile ) + Dir["{spec,lib,doc}/**/*"]
+  s.add_dependency "activesupport"
+  s.add_dependency "builder"
+  s.add_dependency "hpricot"
+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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: clinth3o-acdc
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Clint Hill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 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: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: This is a little xml-to-object-to-xml library that gets Dirty Deeds Done Dirt Cheap.
+email: clint.hill@h3osoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- Rakefile
+has_rdoc: false
+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: 2
+summary: AC/DC by h3o(software)
+test_files: []
+