blythedunham-ar_test_runner 0.1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Blythe Dunham snowgiraffe.com
+
+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/Manifest

@@ -0,0 +1,12 @@
+ar_test_runner.gemspec
+bin/ar_test_runner
+gem_install.rb
+init.rb
+lib/ar_test_runner.rb
+lib/ar_test_runner_includes.rb
+Manifest
+MIT-LICENSE
+Rakefile
+README.rdoc
+tasks/ar_test_runner_tasks.rake
+uninstall.rb

data/README.rdoc

@@ -0,0 +1,77 @@
+= ArTestRunner
+Run the ActiveRecord test suite with your gem/module/plugin loaded. Choose the ActiveRecord version and database.
+
+== Install
+Install as either a gem or a plugin.
+=== Gem
+  gem sources -a http://gems.github.com
+  sudo gem install blythedunham-ar_test_runner
+
+=== Plugin
+  script/plugin install git://github.com/blythedunham/ar_test_runner
+
+== Run
+Run either of these from the RAILS_ROOT of your application
+
+=== ar_test_runner
+
+Run all plugins and lib files against sqlite for app version
+  ar_test_runner DB=sqlite
+
+Test 2.3.2 with <tt>rails_devs_for_data_integrity</tt> plugin loaded on mysql (default)
+  ar_test_runner PLUGIN=rails_devs_for_data_integrity AR_DIR=/Library/Ruby/Gems/1.8/gems/activerecord-2.3.2
+
+If installed as a gem, the executable is copied to your bin. With a plugin, you should invoke the file directly
+  vendor/plugins/ar_test_runner/bin/ar_test_runner
+
+=== Rake task
+Run all plugins and lib files against sqlite for app version
+  rake test:activerecord:sqlite
+
+Test 2.3.2 with <tt>rails_devs_for_data_integrity</tt> plugin loaded on mysql
+  rake test:activerecord:mysql PLUGIN=rails_devs_for_data_integrity AR_DIR=/Library/Ruby/Gems/1.8/gems/activerecord-2.3.2
+
+With a plugin, rake tasks will automatically appear. If installed as a gem, please require 'ar_test_runner' in the Rakefile
+  require 'ar_test_runner'
+
+=== Parameters
+* <tt>AR_DIR</tt> - ActiveRecord directory. Works with frozen rails directories and gem locations. Defaults to the apps version of ActiveRecord
+* <tt>PLUGIN</tt> - specify a plugin to use
+* <tt>FILE</tt> - files to load separated with commas. Create a file that requires everything you need loaded for super detailed configurations. Relative and full paths are fine.
+* <tt>REQUIRE</tt> - like FILE but does not expand the path. Use for gems and requiring file that are not relative to RAILS_ROOT</tt>.
+* <tt>SKIP</tt> - list of directories or file names separated by commas to exclude.
+* <tt>DRY_RUN</tt> - prints out list of files to loaded but does not run the tests
+* <tt>AR_RUN_DEFAULT</tt> - set to true to include all files in the lib directory and plugins. These are run when <tt>REQUIRE</tt>,<tt>FILE</tt>, and <tt>PLUGIN</tt> is not specified
+* <tt>DB</tt> - specify the db name (ex: +sqlite+ or +mysql+) with +DB+ when using this with +ar_test_runner+ ruby script. The database is specified in the task when run as a rake task. Example: <tt> rake test:activerecord:mysql</tt>
+
+
+If <tt>REQUIRE</tt>,<tt>FILE</tt>, and <tt>PLUGIN</tt> are not specified, or <tt>AR_RUN_DEFAULT</tt> is set, all plugins(<tt>vendor/plugins/**/init.rb</tt>) and lib files(<tt>lib/*.rb</tt>) are loaded. Use <tt>SKIP</tt> to exclude directories. Plugins referencing <tt>ActionController</tt> are automatically disabled.
+
+=== Examples
+
+<b>Run default</b> 
+Run (plugins and libs) on postgre
+  rake activerecord:test:postgresql
+
+<b>Skip</b>
+Load everything in lib and all of the plugins but skip <tt>smsonrails</tt> using a frozen version of 2.2.2
+  rake test:activerecord:sqlite3 AR_DIR=/Users/blythedunham/projects/arversions/AR2.2.2/vendor/rails/activerecord SKIP=smsonrails
+
+<b>Custom File </b>
+If there are a lot of files to load, or for super custom requires, create a file and require everything there. Will use which ever version of <tt>ActiveRecord</tt> your app uses (loaded in <tt>config/boot.rb</tt>)
+
+<tt>ar_requires.rb</tt>
+might look like:
+  require File.dirname(__FILE__) + '../../models/awesome.rb'
+  require 'supergemthing'
+
+Then run it:
+  rake activerecord:test:mysql FILES=config/ar_regression_requires.rb
+
+== Developers
+* Blythe Dunham http://snowgiraffe.com
+
+== Homepage
+* Project Site: http://github.com/blythedunham/ar_test_runner
+
+Copyright (c) 2009 Blythe Dunham, released under the MIT license

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'echoe'
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ar_test_runner plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the ar_regress_test plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ArTestRunner'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Install the application"
+task :install do
+  ruby "gem_install.rb"
+end
+
+Echoe.new('ar_test_runner', '0.1.1') do |p|
+  p.description    = "Run ActiveRecord core regression tests with your code/gem/plugin/module loaded"
+  p.url            = "http://github.com/blythedunham/ar_test_runner"
+  p.author         = "Blythe Dunham"
+  p.email          = "blythe@snowgiraffe.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/ar_test_runner.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar_test_runner}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Blythe Dunham"]
+  s.date = %q{2009-05-15}
+  s.default_executable = %q{ar_test_runner}
+  s.description = %q{Run ActiveRecord core regression tests with your code/gem/plugin/module loaded}
+  s.email = %q{blythe@snowgiraffe.com}
+  s.executables = ["ar_test_runner"]
+  s.extra_rdoc_files = ["bin/ar_test_runner", "lib/ar_test_runner.rb", "lib/ar_test_runner_includes.rb", "README.rdoc", "tasks/ar_test_runner_tasks.rake"]
+  s.files = ["ar_test_runner.gemspec", "bin/ar_test_runner", "gem_install.rb", "init.rb", "lib/ar_test_runner.rb", "lib/ar_test_runner_includes.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "tasks/ar_test_runner_tasks.rake", "uninstall.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/blythedunham/ar_test_runner}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ar_test_runner", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ar_test_runner}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Run ActiveRecord core regression tests with your code/gem/plugin/module loaded}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/bin/ar_test_runner

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require 'config/boot'
+ENV['AR_RUN_CMD'] = 'true'
+begin
+  puts "SET ENV1"
+  require 'ar_test_runner'
+rescue LoadError => exc
+  puts "SET ENV2"
+  file = File.dirname(__FILE__)+'/../lib/ar_test_runner.rb'
+  if File.exists?(file)
+    require file 
+  else
+    puts "Cannot load ar_test_runner. Is the gem or plugin installed?"
+    exit
+  end
+end
+
+puts "SET ENV"
+
+
+ArTestRunner.run!

data/gem_install.rb

@@ -0,0 +1,92 @@
+puts "INSTALL RUNNING"
+
+if false
+require 'rbconfig'
+require 'find'
+require 'ftools'
+
+include Config
+
+$ruby = CONFIG['ruby_install_name']
+
+##
+# Install a binary file. We patch in on the way through to
+# insert a #! line. If this is a Unix install, we name
+# the command (for example) 'ar_test_runner' and let the shebang line
+# handle running it. Under windows, we add a '.rb' extension
+# and let file associations to their stuff
+#
+
+def installBIN(from, opfile)
+
+  tmp_dir = nil
+  for t in [".", "/tmp", "c:/temp", $bindir]
+    stat = File.stat(t) rescue next
+    if stat.directory? and stat.writable?
+      tmp_dir = t
+      break
+    end
+  end
+
+  fail "Cannot find a temporary directory" unless tmp_dir
+  tmp_file = File.join(tmp_dir, "_tmp")
+    
+  File.open(from) do |ip|
+    File.open(tmp_file, "w") do |op|
+      ruby = File.join($realbindir, $ruby)
+      op.puts "#!#{ruby} -w"
+      op.write ip.read
+    end
+  end
+
+  opfile += ".rb" if CONFIG["target_os"] =~ /mswin/i
+  File::install(tmp_file, File.join($bindir, opfile), 0755, true)
+  File::unlink(tmp_file)
+end
+
+$sitedir = CONFIG["sitelibdir"]
+unless $sitedir
+  version = CONFIG["MAJOR"]+"."+CONFIG["MINOR"]
+  $libdir = File.join(CONFIG["libdir"], "ruby", version)
+  $sitedir = $:.find {|x| x =~ /site_ruby/}
+  if !$sitedir
+    $sitedir = File.join($libdir, "site_ruby")
+  elsif $sitedir !~ Regexp.quote(version)
+    $sitedir = File.join($sitedir, version)
+  end
+end
+
+$bindir =  CONFIG["bindir"]
+
+$realbindir = $bindir
+
+bindir = CONFIG["bindir"]
+if (destdir = ENV['DESTDIR'])
+  $bindir  = destdir + $bindir
+  $sitedir = destdir + $sitedir
+  
+  File::makedirs($bindir)
+  File::makedirs($sitedir)
+end
+
+ar_test_runner_dest = File.join($sitedir, "ar_test_runner")
+File::makedirs(ar_test_runner_dest, true)
+File::chmod(0755, ar_test_runner_dest)
+
+# The library files
+
+files = Dir.chdir('lib') { Dir['**/*.rb'] }
+
+for fn in files
+  fn_dir = File.dirname(fn)
+  target_dir = File.join($sitedir, fn_dir)
+  if ! File.exist?(target_dir)
+    File.makedirs(target_dir)
+  end
+  File::install(File.join('lib', fn), File.join($sitedir, fn), 0644, true)
+end
+
+# and the executable
+
+installBIN("bin/ar_test_runner", "ar_test_runner")
+end

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/lib/ar_test_runner.rb

@@ -0,0 +1,190 @@
+
+class ArTestRunner
+  
+  attr_reader :auto_skip
+  
+  unless defined? ADAPTERS
+    ADAPTERS = %w( mysql postgresql sqlite sqlite3 firebird db2 oracle sybase openbase frontbase jdbcmysql jdbcpostgresql jdbcsqlite3 jdbcderby jdbch2 jdbchsqldb )
+    REQUIRE_ALL_GLOB= %w(vendor/plugins/*/init.rb lib/*.rb)
+    DEFAULT_REQUIRES = [File.expand_path(File.join(File.dirname(__FILE__), 'ar_test_runner_includes.rb'))]
+  end
+  
+  #run the whole thing
+  def self.run!
+    new.run
+  end
+  
+  # Run the unit tests
+  def run
+    old_dir, old_env = Dir.pwd, ENV['RUBYOPT']
+    print_info
+    return true if ENV['DRY_RUN'] == 'true'
+    
+    Dir.chdir( activerecord_dir )
+    ENV['RUBYOPT'] = required_files.collect{ |f| "-r#{f}" }.join(' ')#"-r rubygems -ractiverecord.rb -r#{init_file}"
+    load File.join( activerecord_dir, "Rakefile" )
+    Rake::Task[ "test_#{adapter}" ].invoke
+    Dir.chdir( old_dir )
+    ENV['RUBYOPT'] = old_env
+  end
+  
+  #a list of files to require run running the ActiveRecord test suite
+  def required_files
+    return @required_files unless @required_files.nil?
+    @required_files = DEFAULT_REQUIRES.dup
+    @required_files.concat(requires)
+    @required_files.concat(plugins)
+    @required_files.concat(expanded_files)
+    @required_files.concat(default_app_files) if use_all_app_files?
+    skip_files!(@required_files)
+    @required_files
+  end
+  
+  # the database adapter to use
+  def adapter
+    @adapter ||= begin
+      adpt = ENV['DB']||'mysql'
+      error_and_exit("Database type not supported #{@adapter}") unless ADAPTERS.include?(adpt)
+      adpt
+    end
+  end
+  
+  # The default activerecord directory used by the app (in LOADPATH)
+  def default_activerecord_dir
+    @default_activerecord_dir ||= if (activerecord_lib_dir = $LOAD_PATH.detect {|f| f =~ /activerecord/})
+      File.expand_path(File.dirname(activerecord_lib_dir))
+    end
+  end
+
+  # Get the activerecord from AR_DIR or default to app's LOADPATH
+  # ENV['AR_DIR'] should be set
+  def activerecord_dir
+    @activerecord_dir ||= begin
+      ar_dir = (ENV['AR_DIR']||= default_activerecord_dir)
+      error_and_exit "Pass in the path to ActiveRecord. Eg: AR_DIR=/Library/Ruby/Gems/1.8/gems/activerecord-2.3.2" if ar_dir.nil?
+      error_and_exit "Invalid ActiveRecord directory: #{ar_dir}" unless File.directory?(ar_dir)
+      ar_dir
+    end
+  end
+
+  # list of files to include absolute or relative to RAILS_ROOT
+  # an expression sent to Dir.glob is ok
+  # FILE=config/ar_test_runner_init.rb,model/*.rb
+  #
+  # Create a file like ar_test_runner_init.rb and include custom files
+  #   require 'mygem'
+  #   require '../../blah.rb'
+  def expanded_files
+    @expanded_files ||= split_file_names('FILE').inject([]) do |files, file|
+      files.concat Dir.glob(file)
+      files
+    end
+  end
+  
+  # list of comma delimited plugins (relative to RAILS_ROOT) to include
+  #  PLUGIN=smsonrails
+  def plugins
+    @plugins ||= split_file_names 'PLUGIN' do |p| 
+      File.join('vendor/plugins', p, 'init.rb')
+    end
+  end
+  
+  # list of strings to require. Similar to FILES but
+  # does not expand the path. Use with gems
+  #   REQUIRE=mygem/gem, gemsuper
+  def requires
+    @requires ||= split_input 'REQUIRE'
+  end
+  # list of file names and dirs to skip over
+  def skipped_files
+    @skipped_files ||= split_input 'SKIP'
+  end
+
+  # Gather the default files
+  def default_app_files
+    @default_app_files ||= REQUIRE_ALL_GLOB.inject([]) do |list, files| 
+      list.concat Dir.glob(files).collect{ |f| File.expand_path(f) }
+      list
+    end
+  end
+  
+  # update orig_files to skip the files we want to exclude
+  # Note: this is not the best way. Loads this under the context of 
+  # the activerecord version of the app
+  def skip_files!(orig_files)
+    return orig_files if skipped_files.empty? && !use_all_app_files? 
+
+    #include activerecord
+    require File.join(activerecord_dir, 'lib', 'activerecord.rb')
+
+    #load each file now to see if it fails.
+    orig_files.collect! { |f| require_file?(f) ? f : nil }.compact!
+  end
+  
+  def use_all_app_files?
+    if ENV['AR_RUN_DEFAULT'].nil?
+      ENV['AR_RUN_DEFAULT'] = (plugins.empty? && requires.empty? && expanded_files.empty?).to_s
+    end
+    ENV['AR_RUN_DEFAULT']
+  end
+  
+  protected
+  
+  # Return true if the file should be required.
+  # The file is not skipped and can be loaded (required now)
+  def require_file?(file_name)
+    return false if skip_file?(file_name)
+    require file_name unless skip_validation?
+    true
+  rescue NameError => exc
+    error_and_exit(exc.to_s) unless exc.to_s == 'uninitialized constant ActionController'
+    @auto_skip ||= []
+    @auto_skip << file_name
+    false
+  end
+
+  # Skip the file if it matches skipped_files (SKIP)
+  def skip_file?(file_name)
+    skipped_files.detect {|sf| file_name =~ Regexp.new("/#{sf}($|/)") }
+  end
+  
+  def skip_validation?
+    ENV['SKIP_VALIDATION'] == 'true'
+  end
+  
+  #splite the comma delimited input
+  def split_input(parameter, &block)
+    args = ENV[parameter] ? ENV[parameter].split(/,\s*/) : []
+    args.collect!{|a| yield a } if block
+    args
+  end
+  
+  #split the comma delimited input into expanded file names
+  def split_file_names(parameter, &block)
+    split_input(parameter) do |f|
+      f = yield f if block
+      error_and_exit("File does not exist: #{f}") unless File.exists?(f)
+      File.expand_path f
+    end
+  end
+  
+  # Print the error and exit
+  def error_and_exit(msg)
+    STDERR.puts "ERROR: #{msg}"
+    exit
+  end
+
+  def print_list(msg, file_list)
+    STDOUT.puts "#{msg}:\n  #{ [file_list].flatten.join("\n  ") }" unless file_list.nil? || file_list == ''
+  end
+  
+  def print_info
+    print_list 'Adapter', adapter
+    print_list 'ActiveRecord Directory', activerecord_dir
+    print_list 'Loaded Files', required_files
+    print_list 'Skipped Files', skipped_files
+    print_list 'Automatically Skipped Files (references ActionController)', auto_skip
+  end
+end
+
+load "#{File.dirname(__FILE__)}/../tasks/ar_test_runner_tasks.rake" unless ENV['AR_RUN_CMD'] == 'true'

data/lib/ar_test_runner_includes.rb

@@ -0,0 +1,17 @@
+ar_dir_name = File.basename(ENV['AR_DIR'])
+
+# If we are inside a gem, activesupport is located back a directory
+  # with the version name. Add this to the LOAD_PATH
+  # Example: ../activesupport-2.3.2
+if (match = ar_dir_name.match(/activerecord-([\d\.]*)$/)) && match[1]
+  ext = match[1]
+  dirs = %w(active_support active_record).each do |f|
+    dir = f.gsub('_', '') + '-' + ext
+    $LOAD_PATH << File.join(ENV['AR_DIR'], '..', dir , 'lib')
+    file = File.join(ENV['AR_DIR'], '..', dir , 'lib', f)
+    #require file
+  end
+end
+  
+#always require active_record
+require 'active_record'

data/tasks/ar_test_runner_tasks.rake

@@ -0,0 +1,19 @@
+
+unless defined?(ArTestRunner)
+  require File.join(File.dirname(__FILE__), '..', 'lib', 'ar_test_runner')
+end
+
+
+# define a rake task for each adapter
+#  rake test:activerecord:mysql
+namespace :test do  
+  namespace :activerecord do
+    ArTestRunner::ADAPTERS.each do |adapter|
+      desc "runs ActiveRecord regression unit tests for #{adapter}"
+      task adapter.to_sym do |t|
+        ENV['DB'] = adapter
+        ArTestRunner.run!
+      end
+    end
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: blythedunham-ar_test_runner
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Blythe Dunham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-15 00:00:00 -07:00
+default_executable: ar_test_runner
+dependencies: []
+
+description: Run ActiveRecord core regression tests with your code/gem/plugin/module loaded
+email: blythe@snowgiraffe.com
+executables: 
+- ar_test_runner
+extensions: []
+
+extra_rdoc_files: 
+- bin/ar_test_runner
+- lib/ar_test_runner.rb
+- lib/ar_test_runner_includes.rb
+- README.rdoc
+- tasks/ar_test_runner_tasks.rake
+files: 
+- ar_test_runner.gemspec
+- bin/ar_test_runner
+- gem_install.rb
+- init.rb
+- lib/ar_test_runner.rb
+- lib/ar_test_runner_includes.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- tasks/ar_test_runner_tasks.rake
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/blythedunham/ar_test_runner
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Ar_test_runner
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: ar_test_runner
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Run ActiveRecord core regression tests with your code/gem/plugin/module loaded
+test_files: []
+