cbaclig-ar-extensions 0.9.2.1

data/ar-extensions.gemspec

@@ -0,0 +1,19 @@
+require 'rake'
+
+Gem::Specification.new do |s|
+  s.name = %q{ar-extensions}
+  s.version = "0.9.2"
+  s.date = %q{2009-04-20}
+  s.summary = %q{Extends ActiveRecord functionality.}
+  s.email = %q{zach.dennis@gmail.com}
+  s.homepage = %q{http://www.continuousthinking.com/tags/arext}
+  s.rubyforge_project = %q{arext}
+  s.description = %q{Extends ActiveRecord functionality by adding better finder/query support, as well as supporting mass data import, foreign key, CSV and temporary tables}
+  s.require_path = 'lib'
+  s.has_rdoc = true
+  s.authors = ["Zach Dennis", "Mark Van Holstyn", "Blythe Dunham"]
+  s.files = FileList[ 'init.rb', 'db/**/*', 'Rakefile', 'ChangeLog', 'README', 'config/**/*', 'lib/**/*.rb', 'test/**/*' ]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+  s.add_dependency(%q<activerecord>, [">= 2.1.2"])
+end

data/benchmarks/README

@@ -0,0 +1,32 @@
+To run the benchmarks, from within the benchmarks run:
+   ruby benchmark.rb [options]
+
+The following options are supported:
+  --adapter [String]   The database adapter to use. IE: mysql, postgresql, oracle
+             
+  --do-not-delete       By default all records in the benchmark tables will be deleted at the end of the benchmark. This flag indicates not to delete the benchmark data.
+  --num [Integer]      The number of objects to benchmark. (Required!)
+  --table-type [String]  The table type to test. This can be used multiple times. By default it is all table types.
+  --to-csv [String]      Print results in a CSV file format
+  --to-html [String]     Print results in HTML format (String filename must be supplied)
+
+See "ruby benchmark.rb -h" for the complete listing of options.
+
+EXAMPLES
+--------
+To output to html format:
+  ruby benchmark.rb --adapter=mysql --to-html=results.html
+
+To output to csv format:
+  ruby benchmark.rb --adapter=mysql --to-csv=results.csv
+
+LIMITATIONS
+-----------
+Currently MySQL is the only supported adapter to benchmark.
+
+AUTHOR
+------
+Zach Dennis
+zach.dennis@gmail.com
+http://www.continuousthinking.com
+

data/benchmarks/benchmark.rb

@@ -0,0 +1,61 @@
+require 'boot'
+
+# Parse the options passed in via the command line
+options = BenchmarkOptionParser.parse( ARGV )
+
+# The lib directory that houses the library files we need to benchmark
+LIB_DIR = File.expand_path(
+File.join( File.dirname( __FILE__ ), '..', 'lib' ) )
+
+# The support directory where we use to load our connections and models for the 
+# benchmarks.
+SUPPORT_DIR = File.expand_path( 
+  File.join( File.dirname( __FILE__ ), '..', 'tests' ) )
+
+# Load our library files
+Dir[ File.join( LIB_DIR, '**/*.rb' ) ].each{ |f| require f }
+
+# Load the database adapter
+db_adapter = options.adapter
+require File.join( SUPPORT_DIR, 'connections', "native_#{db_adapter}", 'connection' )
+
+# Load all generic models
+Dir[ File.join( SUPPORT_DIR, 'models/*.rb' ) ].each{ |f| require f }
+
+# Load database adapter specific models
+Dir[ File.join( SUPPORT_DIR, 'models', "#{db_adapter}/*.rb" ) ].each{|f| require f }
+
+# Load databse specific benchmarks
+require File.join( File.dirname( __FILE__ ), 'lib', "#{db_adapter}_benchmark" )
+
+# TODO implement method/table-type selection
+table_types = nil
+if options.benchmark_all_types
+  table_types = [ "all" ]
+else
+  table_types = options.table_types.keys
+end
+puts
+
+letter = options.adapter[0].chr
+clazz_str = letter.upcase + options.adapter[1..-1].downcase
+clazz = Object.const_get( clazz_str + "Benchmark" )
+
+benchmarks = []
+options.number_of_objects.each do |num|
+  benchmarks << (benchmark = clazz.new)
+  benchmark.send( "benchmark", table_types, num )
+end
+
+options.outputs.each do |output|
+  format = output.format.downcase
+  require File.join( File.dirname( __FILE__ ), 'lib', "output_to_#{format}" )
+  output_module = Object.const_get( "OutputTo#{format.upcase}" )
+  benchmarks.each do |benchmark|
+    output_module.output_results( output.filename, benchmark.results )
+  end
+end
+
+puts
+puts "Done with benchmark!"
+

data/benchmarks/boot.rb

@@ -0,0 +1,21 @@
+begin ; require 'rubygems' ; rescue LoadError ; end
+require 'active_record' # ActiveRecord loads the Benchmark library automatically
+require 'active_record/version'
+require 'fastercsv'
+require 'fileutils'
+require 'logger'
+
+# Files are loaded alphabetically. If this is a problem then manually specify the files
+# that need to be loaded here.
+Dir[ File.join( File.dirname( __FILE__ ), 'lib', '*.rb' ) ].sort.each{ |f| require f }
+
+Dir[ File.join( File.dirname( __FILE__ ), 'lib/active_record_base/*.rb' ) ].each{ |f| require f }
+Dir[ File.join( File.dirname( __FILE__ ), 'lib/adapters/*.rb' ) ].each{ |f| require f }
+
+ActiveRecord::Base.logger = Logger.new STDOUT
+
+
+
+
+
+

data/benchmarks/lib/base.rb

@@ -0,0 +1,121 @@
+class BenchmarkBase
+
+  attr_reader :results
+
+  # The main benchmark method dispatcher. This dispatches the benchmarks
+  # to actual benchmark_xxxx methods.
+  # 
+  # == PARAMETERS
+  #  * table_types - an array of table types to benchmark
+  #  * num - the number of record insertions to test
+  def benchmark( table_types, num )
+    array_of_cols_and_vals = build_array_of_cols_and_vals( num )
+    table_types.each do |table_type|
+      self.send( "benchmark_#{table_type}", array_of_cols_and_vals )
+    end
+  end
+
+  # Returns an OpenStruct which contains two attritues, +description+ and +tms+ after performing an
+  # actual benchmark.
+  #
+  # == PARAMETERS
+  #  * description - the description of the block that is getting benchmarked
+  #  * blk - the block of code to benchmark
+  #
+  # == RETURNS
+  # An OpenStruct object with the following attributes:
+  #   * description - the description of the benchmark ran
+  #   * tms - a Benchmark::Tms containing the results of the benchmark
+  def bm( description, &blk )
+    tms  = nil
+    puts "Benchmarking #{description}"
+    
+    begin
+      Benchmark.bm { |x| tms = x.report { blk.call } }
+      failed = false
+    rescue Exception => ex
+      failed = true
+    end
+    OpenStruct.new :description=>description, :tms=>tms, :failed=>failed
+  end
+  
+  # Given a model class (ie: Topic), and an array of columns and value sets
+  # this will perform all of the benchmarks necessary for this library.
+  # 
+  # == PARAMETERS
+  #  * model_clazz - the model class to benchmark (ie: Topic)
+  #  * array_of_cols_and_vals - an array of column identifiers and value sets
+  #
+  # == RETURNS
+  #  returns true
+  def bm_model( model_clazz, array_of_cols_and_vals )
+    cols,vals = array_of_cols_and_vals
+    num_inserts = vals.size
+
+    # add a new result group for this particular benchmark
+    group = []
+    @results << group
+
+    description = "#{model_clazz.name}.create (#{num_inserts})"
+    group << bm( description ) { 
+      vals.each do |values|
+        model_clazz.create create_hash_for_cols_and_vals( cols, values )
+      end  }
+
+    description = "#{model_clazz.name}.import (#{num_inserts}) With Validations"
+    group << bm( description ) { model_clazz.import cols, vals, :validate=>true }
+
+    description = "#{model_clazz.name}.import (#{num_inserts}) Without Validations"
+    group << bm( description ) { model_clazz.import cols, vals, :validate=>false }
+
+    true
+  end
+
+  # Returns a two element array composing of an array of columns and an array of
+  # value sets given the passed +num+.
+  #
+  # === What is a value set?
+  # A value set is an array of arrays. Each child array represents an array of value sets
+  # for a given row of data. 
+  #
+  # For example, say we wanted to represent an insertion of two records:
+  #   column_names = [ 'id', 'name', 'description' ]
+  #   record1 = [ 1, 'John Doe', 'A plumber' ]
+  #   record2 = [ 2, 'John Smith', 'A painter' ]
+  #   value_set [ record1, record2 ]
+  #
+  # == PARAMETER
+  #  * num - the number of records to create
+  def build_array_of_cols_and_vals( num )
+    cols = [ :my_name, :description ]
+    value_sets = []
+    num.times { |i| value_sets << [ "My Name #{i}", "My Description #{i}" ] }
+    [ cols, value_sets ]
+  end
+
+  # Returns a hash of column identifier to value mappings giving the passed in
+  # value array. 
+  #
+  # Example:
+  #   cols = [ 'id', 'name', 'description' ]
+  #   values = [ 1, 'John Doe', 'A plumber' ]
+  #   hsh = create_hash_for_cols_and_vals( cols, values )   
+  #   # hsh => { 'id'=>1, 'name'=>'John Doe', 'description'=>'A plumber' }
+  def create_hash_for_cols_and_vals( cols, vals )
+    h = {}
+    cols.zip( vals ){ |col,val| h[col] = val }
+    h
+  end
+
+  # Deletes all records from all ActiveRecord subclasses
+  def delete_all
+    ActiveRecord::Base.send( :subclasses ).each do |subclass|
+      subclass.delete_all if subclass.respond_to? :delete_all
+    end
+  end
+
+  def initialize   # :nodoc:
+    @results = []
+  end
+	
+end

data/benchmarks/lib/cli_parser.rb

@@ -0,0 +1,103 @@
+require 'optparse'
+require 'ostruct'
+
+# 
+# == PARAMETERS
+# * a - database adapter. ie: mysql, postgresql, oracle, etc.
+# * n - number of objects to test with. ie: 1, 100, 1000, etc.
+# * t - the table types to test. ie: myisam, innodb, memory, temporary, etc.
+#
+module BenchmarkOptionParser
+  BANNER = "Usage: ruby #{$0} [options]\nSee ruby #{$0} -h for more options."
+
+  def self.print_banner
+    puts BANNER
+  end
+  
+  def self.print_banner!
+    print_banner
+    exit
+  end
+  
+  def self.print_options( options )
+    puts "Benchmarking the following options:"
+    puts "\tDatabase adapter: #{options.adapter}"
+    puts "\tNumber of objects: #{options.number_of_objects}"
+    puts "\tTable types:"
+    print_valid_table_types( options, :prefix=>"\t\t" )
+  end
+  
+  # TODO IMPLEMENT THIS
+  def self.print_valid_table_types( options, hsh={:prefix=>''} )
+    if options.table_types.keys.size > 0
+      options.table_types.keys.sort.each{ |type| puts hsh[:prefix].to_s + type.to_s }
+    else
+      puts 'No table types defined.'
+    end
+  end
+  
+  def self.parse( args )
+    options = OpenStruct.new( 
+      :table_types => {}, 
+      :delete_on_finish => true,
+      :number_of_objects => [],
+      :outputs => [] )
+    
+    opts = OptionParser.new do |opts|
+      opts.banner = BANNER
+      
+      # parse the database adapter
+      opts.on( "a", "--adapter [String]", 
+        "The database adapter to use. IE: mysql, postgresql, oracle" ) do |arg|
+        options.adapter = arg
+      end
+      
+      # parse do_not_delete flag
+      opts.on( "d", "--do-not-delete", 
+        "By default all records in the benchmark tables will be deleted at the end of the benchmark. " +
+        "This flag indicates not to delete the benchmark data." ) do |arg|
+        options.delete_on_finish = false
+      end
+      
+      # parse the number of row objects to test
+      opts.on( "n", "--num [Integer]",
+        "The number of objects to benchmark." ) do |arg|
+        options.number_of_objects << arg.to_i
+      end
+      
+      # parse the table types to test
+      opts.on( "t", "--table-type [String]",
+        "The table type to test. This can be used multiple times." ) do |arg|
+        if arg =~ /^all$/
+          options.table_types['all'] = options.benchmark_all_types = true
+        else
+          options.table_types[arg] = true
+        end        
+      end
+
+      # print results in CSV format
+      opts.on( "--to-csv [String]", "Print results in a CSV file format" ) do |filename|
+        options.outputs << OpenStruct.new( :format=>'csv', :filename=>filename)
+      end
+
+      # print results in HTML format
+      opts.on( "--to-html [String]", "Print results in HTML format" ) do |filename|
+        options.outputs << OpenStruct.new( :format=>'html', :filename=>filename )
+      end
+    end #end opt.parse!
+
+    begin 
+      opts.parse!( args )
+      if options.table_types.size == 0
+        options.table_types['all'] = options.benchmark_all_types = true
+      end
+    rescue Exception => ex
+      print_banner!
+    end
+    
+    print_options( options )
+    
+    options
+  end
+
+end

data/benchmarks/lib/float.rb

@@ -0,0 +1,15 @@
+# Taken from http://www.programmingishard.com/posts/show/128
+# Posted by rbates
+class Float
+  def round_to(x)
+    (self * 10**x).round.to_f / 10**x
+  end
+
+  def ceil_to(x)
+    (self * 10**x).ceil.to_f / 10**x
+  end
+
+  def floor_to(x)
+    (self * 10**x).floor.to_f / 10**x
+  end
+end

data/benchmarks/lib/mysql_benchmark.rb

@@ -0,0 +1,27 @@
+class MysqlBenchmark < BenchmarkBase
+    
+  def benchmark_all( array_of_cols_and_vals )
+    methods = self.methods.find_all { |m| m =~ /benchmark_/ }
+    methods.delete_if{ |m| m =~ /benchmark_(all|model)/ }
+    methods.each { |method| self.send( method, array_of_cols_and_vals ) }
+  end
+  
+  def benchmark_myisam( array_of_cols_and_vals )
+    bm_model( TestMyISAM, array_of_cols_and_vals )
+  end
+    
+  def benchmark_innodb( array_of_cols_and_vals )
+    bm_model( TestInnoDb, array_of_cols_and_vals )
+  end
+  
+  def benchmark_memory( array_of_cols_and_vals )
+    bm_model( TestMemory, array_of_cols_and_vals )
+  end
+  
+  # TODO utilize this in the benchmark
+  def b1enchmark_temporary( array_of_cols_and_vals )
+    bm_model( TestTemporary, array_of_cols_and_vals )
+  end
+    
+end
+

data/benchmarks/lib/output_to_csv.rb

@@ -0,0 +1,18 @@
+require 'fastercsv'
+
+module OutputToCSV
+  def self.output_results( filename, results )
+    FasterCSV.open( filename, 'w' ) do |csv|
+      # Iterate over each result set, which contains many results
+      results.each do |result_set|
+        columns, times = [], []
+        result_set.each do |result| 
+          columns << result.description
+          times << result.tms.real
+        end
+        csv << columns
+        csv << times
+      end
+    end
+  end
+end

data/benchmarks/lib/output_to_html.rb

@@ -0,0 +1,69 @@
+require 'erb'
+
+module OutputToHTML
+
+TEMPLATE_HEADER =<<"EOT"
+  <div>
+    All times are rounded to the nearest thousandth for display purposes. Speedups next to each time are computed
+    before any rounding occurs. Also, all speedup calculations are computed by comparing a given time against
+    the very first column (which is always the default ActiveRecord::Base.create method.
+   </div>
+EOT
+
+TEMPLATE =<<"EOT"
+ <style>
+ td#benchmarkTitle {
+   border: 1px solid black;
+   padding: 2px;
+   font-size: 0.8em;
+   background-color: black;
+   color: white;
+ }
+ td#benchmarkCell {
+   border: 1px solid black;
+   padding: 2px;
+   font-size: 0.8em;
+ }
+ </style>
+   <table>
+     <tr>
+       <% columns.each do |col| %>
+         <td id="benchmarkTitle"><%= col %></td>
+       <% end %>
+     </tr>
+     <tr>
+       <% times.each do |time| %>
+         <td id="benchmarkCell"><%= time %></td>
+       <% end %>
+     </tr>
+     <tr><td>&nbsp;</td></tr>
+   </table>
+EOT
+
+  def self.output_results( filename, results )
+    html = ''
+    results.each do |result_set|
+      columns, times = [], []
+      result_set.each do |result|
+        columns << result.description
+        if result.failed
+          times << "failed"
+        else
+          time = result.tms.real.round_to( 3 )
+          speedup = ( result_set.first.tms.real / result.tms.real ).round 
+
+          if result == result_set.first
+            times << "#{time}"
+          else
+            times << "#{time} (#{speedup}x speedup)"
+          end
+        end
+      end
+
+      template = ERB.new( TEMPLATE, 0, "%<>")
+      html << template.result( binding )
+    end
+    
+    File.open( filename, 'w' ){ |file| file.write( TEMPLATE_HEADER + html ) }
+  end
+end