single_test 0.3.0

data/README.markdown

@@ -0,0 +1,49 @@
+Runs a single test/spec via rake.
+
+USAGE
+=====
+As Rails plugin:
+    script/plugin install git://github.com/grosser/single_test.git
+
+As Gem:
+  sudo gem install single_test
+
+  # in your Rakefile
+  require 'single_test'
+  SingleTest.load_tasks
+
+
+###Single test/spec
+    rake spec:user          #run spec/model/user_spec.rb (searches for user*_spec.rb)
+    rake test:users_c       #run test/functional/users_controller_test.rb
+    rake spec:admin/users_c #run spec/controllers/admin/users_controller_spec.rb
+    rake test:u*hel         #run test/helpers/user_helper_test.rb (searches for u*hel*_test.rb)
+
+###Single test-case/example
+    rake spec:user:token    #run the first spec in user_spec.rb that matches /token/
+    rake test:user:token    #run all tests in user_test.rb that match /token/
+
+###Spec-server
+    rake spec:user X=       #run test on spec_sever (if one is running...), very fast for quick failure pin-pointing
+
+###All one by one
+    rake spec:one_by_one    #run each spec/test one by one, to find tests that fail when ran
+    rake test:one_by_one    #on their own or produce strange output
+
+###For last mofified file
+    rake test:last
+    rake spec:last
+
+TIPS
+====
+ - if `script/spec` is missing, if will use just `spec` for specs (which solves some issues)
+
+TODO
+====
+ - make test:last more clever e.g. lib -> try spec + spec/lib
+
+AUTHOR
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...  

data/Rakefile

@@ -0,0 +1,21 @@
+task :default do |t|
+  options = "--colour"
+  files = FileList['spec/**/*_spec.rb'].map{|f| f.sub(%r{^spec/},'') }
+  exit system("cd spec && spec #{options} #{files}") ? 0 : 1
+end
+
+begin
+  require 'jeweler'
+  project_name = 'single_test'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.summary = "Rake tasks to invoke single tests/specs with rakish syntax"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/single_test.rb

@@ -0,0 +1,104 @@
+require 'rake'
+
+module SingleTest
+  extend self
+  CMD_LINE_MATCHER = /^(spec|test)\:.*(\:.*)?$/
+  SEARCH_ORDER =  {
+    'test'=> %w(unit functional integration *),
+    'spec'=> %w(models controllers views helpers *),
+  }
+
+  def load_tasks
+    tasks = File.join(File.dirname(__FILE__), '..', 'tasks')
+    load File.join(tasks, 'single_test.rake')
+  end
+
+  def run_last(type)
+    path = "app"
+    last = last_modified_file(path,:ext=>'.rb')
+    test = last.sub('app/',"#{type}/").sub('.rb',"_#{type}.rb")
+    if File.exist?(test)
+      run_test(type, test)
+    else
+      puts "could not find #{test}"
+    end
+  end
+
+  def all_tests(type)
+    FileList["#{type}/**/*_#{type}.rb"].reject{|file|File.directory?(file)}
+  end
+
+  def run_one_by_one(type)
+    tests = all_tests(type)
+    puts "Running #{tests.size} #{type}s"
+    tests.sort.each do |file|
+      puts "Running #{file}"
+      run_test(type, file)
+      puts ''
+    end
+  end
+
+  def run_from_cli(call)
+    type, file, test_name = parse_cli(call)
+    file = find_test_file(type,file)
+    return unless file
+
+    #when spec, convert test_name regex to actual test_name
+    if type == 'spec' && test_name
+      test_name = find_example_in_spec(file, test_name) || test_name
+    end
+
+    #run the file
+    puts "running: #{file}"
+    ENV['RAILS_ENV'] = 'test' #current EVN['RAILS_ENV'] is 'development', and will also exist in all called commands
+    run_test(type, file, test_name)
+  end
+
+  # spec:user:blah --> [spec,user,blah]
+  def parse_cli(call)
+    raise "you should not have gotten here..." unless call =~ CMD_LINE_MATCHER
+    arguments = call.split(":",3)
+    [
+      arguments[0], #type
+      arguments[1], #file name
+      arguments[2].to_s.strip.empty? ? nil : arguments[2] #test name
+    ]
+  end
+
+  def find_test_file(type,file_name)
+    ["","**/"].each do |depth| # find in lower folders first
+      ['','*'].each do |exactness| # find exact matches first
+        SEARCH_ORDER[type].each do |folder|
+          base = "#{type}/#{folder}/#{depth}#{file_name}"
+          # without wildcard no search is performed -> ?rb
+          found = FileList["#{base}#{exactness}_#{type}?rb"].first
+          return found if found
+        end
+      end
+    end
+    nil
+  end
+
+  def find_example_in_spec(file, test_name)
+    File.readlines(file).each do |line|
+      return $2 if line =~ /.*it\s*(["'])(.*#{test_name}.*)\1\s*do/
+    end
+    nil
+  end
+
+  def run_test(type, file, test_name=nil)
+    case type.to_s
+    when 'test' then sh "ruby -Ilib:test #{file} -n /#{test_name}/"
+    when 'spec' then sh "export RAILS_ENV=test ; #{spec_executable} -O spec/spec.opts #{file}" + (test_name ? %Q( -e "#{test_name.sub('"',"\\\"")}") : '') + (ENV['X'] ? " -X" : "")
+    else raise "Unknown: #{type}"
+    end
+  end
+
+  def spec_executable
+    File.exist?("script/spec") ? "script/spec" : "spec"
+  end
+
+  def last_modified_file(dir, options={})
+    Dir["#{dir}/**/*#{options[:ext]}"].sort_by { |p| File.mtime(p) }.last
+  end
+end

data/single_test.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{single_test}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-12-13}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/single_test.rb",
+     "single_test.gemspec",
+     "spec/example_finder_test.txt",
+     "spec/single_test_spec.rb",
+     "spec/spec_helper.rb",
+     "tasks/single_test.rake"
+  ]
+  s.homepage = %q{http://github.com/grosser/single_test}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rake tasks to invoke single tests/specs with rakish syntax}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/single_test_spec.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
+    else
+    end
+  else
+  end
+end
+

data/spec/example_finder_test.txt

@@ -0,0 +1,7 @@
+it "example 1" do
+  something_be_here
+end
+
+it    'example "2"'   do
+  wtf(yes)
+end

data/spec/single_test_spec.rb

@@ -0,0 +1,166 @@
+require "spec_helper"
+require 'single_test'
+
+describe SingleTest do
+  describe :parse_cli do
+    it "finds the type spec" do
+      SingleTest.parse_cli('spec:something')[0].should == 'spec'
+    end
+
+    it "finds the type test" do
+      SingleTest.parse_cli('test:something:else')[0].should == 'test'
+    end
+
+    it "does not find another type" do
+      lambda{SingleTest.parse_cli('oops:something:else')}.should raise_error
+    end
+
+    it "parses the file name" do
+      SingleTest.parse_cli('test:something:else')[1].should == 'something'
+    end
+
+    it "parses the test name" do
+      SingleTest.parse_cli('test:something:else')[2].should == 'else'
+    end
+
+    it "parses missing test name as nil" do
+      SingleTest.parse_cli('test:something')[2].should be_nil
+    end
+
+    it "parses empty test name as nil" do
+      SingleTest.parse_cli('test:something:  ')[2].should be_nil
+    end
+
+    it "does not split test name further" do
+      SingleTest.parse_cli('test:something:else:oh:no')[2].should == 'else:oh:no'
+    end
+  end
+
+  describe :find_test_file do
+    def make_file(path)
+      folder = File.dirname(path)
+      `mkdir -p #{folder}` unless File.exist?(folder)
+      `touch #{path}`
+      raise unless File.exist?(path)
+    end
+
+    before do
+      `rm -rf spec`
+    end
+
+    it "finds exact matches first" do
+      make_file 'spec/mixins/xxx_spec.rb'
+      make_file 'spec/controllers/xxx_controller_spec.rb'
+      SingleTest.find_test_file('spec','xxx').should == 'spec/mixins/xxx_spec.rb'
+    end
+
+    it "finds lower files first" do
+      make_file 'spec/mixins/xxx_spec.rb'
+      make_file 'spec/mixins/xxx/xxx_spec.rb'
+      SingleTest.find_test_file('spec','xxx').should == 'spec/mixins/xxx_spec.rb'
+    end
+
+    it "finds models before controllers" do
+      make_file 'spec/models/xxx_spec.rb'
+      make_file 'spec/controllers/xxx_controller_spec.rb'
+      SingleTest.find_test_file('spec','xx').should == 'spec/models/xxx_spec.rb'
+    end
+
+    it "finds with paths" do
+      make_file 'spec/controllers/admin/xxx_controller_spec.rb'
+      SingleTest.find_test_file('spec','ad*/xx').should == 'spec/controllers/admin/xxx_controller_spec.rb'
+    end
+  end
+
+  describe :find_example_in_spec do
+    examples_file = File.join(File.dirname(__FILE__),'example_finder_test.txt')
+
+    it "finds a complete statement" do
+      SingleTest.find_example_in_spec(examples_file,'example 1').should == 'example 1'
+    end
+
+    it "finds a partial statement" do
+      SingleTest.find_example_in_spec(examples_file,'mple 1').should == 'example 1'
+    end
+
+    it "finds in strangely formatted files" do
+      SingleTest.find_example_in_spec(examples_file,'2').should == 'example "2"'
+    end
+
+    it "returns nil for unfound examples" do
+      SingleTest.find_example_in_spec(examples_file,'not here').should == nil
+    end
+  end
+
+  describe :run_last do
+    before do
+      `mkdir app` unless File.exist?('app')
+      `touch app/yyy.rb`
+      `touch app/xxx.rb`
+      `mkdir spec` unless File.exist?('spec')
+      `touch spec/xxx_spec.rb`
+      `touch spec/yyy_spec.rb`
+    end
+
+    it "runs the last test" do
+      SingleTest.should_receive(:run_test).with(:spec, "spec/yyy_spec.rb")
+      SingleTest.run_last(:spec)
+    end
+
+    it "runs another file when timestamps change" do
+      `touch -t 12312359 #{SPEC_ROOT}/app/yyy.rb` # last minute in current year, spec will fail on new years eve :D
+      SingleTest.should_receive(:run_test).with(:spec, "spec/yyy_spec.rb")
+      SingleTest.run_last(:spec)
+    end
+  end
+
+  describe :run_test do
+    after :all do
+      ENV['X']=nil
+    end
+
+    it "fails when type is not spec/test" do
+      lambda{SingleTest.run_test('x','y')}.should raise_error
+    end
+
+    it "runs whole tests" do
+      SingleTest.should_receive(:sh).with('ruby -Ilib:test xxx -n //')
+      SingleTest.run_test('test','xxx')
+    end
+
+    it "runs single tests on their own" do
+      SingleTest.should_receive(:sh).with('ruby -Ilib:test xxx -n /yyy/')
+      SingleTest.run_test('test', 'xxx', 'yyy')
+    end
+
+    it "runs whole specs without -e" do
+      SingleTest.should_receive(:sh).with('export RAILS_ENV=test ; script/spec -O spec/spec.opts xxx')
+      SingleTest.run_test('spec','xxx')
+    end
+
+    it "runs single specs through -e" do
+      SingleTest.should_receive(:sh).with('export RAILS_ENV=test ; script/spec -O spec/spec.opts xxx -e "yyy"')
+      SingleTest.run_test('spec','xxx', 'yyy')
+    end
+
+    it "runs single specs through -e with -X" do
+      ENV['X']=''
+      SingleTest.should_receive(:sh).with('export RAILS_ENV=test ; script/spec -O spec/spec.opts xxx -e "yyy" -X')
+      SingleTest.run_test('spec','xxx', 'yyy')
+    end
+
+    it "runs quoted specs though -e" do
+      SingleTest.should_receive(:sh).with(%Q(export RAILS_ENV=test ; script/spec -O spec/spec.opts xxx -e "y\\\"yy" -X))
+      SingleTest.run_test('spec','xxx', 'y"yy')
+
+    end
+  end
+
+  describe :load_tasks do
+    it "can load em" do
+      (Rake::Task['spec:one_by_one'] rescue nil).should == nil
+      SingleTest.load_tasks
+      Rake::Task['spec:one_by_one'].should_not == nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# ---- requirements
+SPEC_ROOT = File.dirname(__FILE__)
+$LOAD_PATH << File.expand_path("../lib", SPEC_ROOT)
+
+# ---- rspec
+Spec::Runner.configure do |config|
+  config.before do
+    `mkdir -p #{SPEC_ROOT}/script`
+    `touch #{SPEC_ROOT}/script/spec`
+  end
+  config.after do
+    `rm -rf #{SPEC_ROOT}/script`
+    `rm -rf #{SPEC_ROOT}/app`
+    `rm -rf #{SPEC_ROOT}/spec`
+  end
+end

data/tasks/single_test.rake

@@ -0,0 +1,21 @@
+#matches SingleTest::CMD_LINE_MATCHER --- test/spec:file[:method]
+rule /^(spec|test)\:.*(\:.*)?$/ do |t|
+  require File.join(File.dirname(__FILE__),'..','lib','single_test')
+  SingleTest.run_from_cli(t.name)
+end
+
+[:spec, :test].each do |type|
+  namespace type do
+    desc "Runs each #{type} one by one and displays its results -> see which #{type}s fail on their own"
+    task :one_by_one do
+      require File.join(File.dirname(__FILE__),'..','lib','single_test')
+      SingleTest.run_one_by_one(type)
+    end
+
+    desc "run #{type} for last modified file in app folder"
+    task :last do
+      require File.join(File.dirname(__FILE__),'..','lib','single_test')
+      SingleTest.run_last(type)
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: single_test
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-13 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- lib/single_test.rb
+- single_test.gemspec
+- spec/example_finder_test.txt
+- spec/single_test_spec.rb
+- spec/spec_helper.rb
+- tasks/single_test.rake
+has_rdoc: true
+homepage: http://github.com/grosser/single_test
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rake tasks to invoke single tests/specs with rakish syntax
+test_files: 
+- spec/spec_helper.rb
+- spec/single_test_spec.rb