soundcheck 0.2.1 → 0.2.2

data/README.markdown

@@ -1,32 +1,42 @@
 A smarter way to run your tests
 ===============================
 
-This gem started as a Ruby version of 'script/test' from [Destroy All Software's
-screencast number 10](http://destroyallsoftware.com/screencasts/catalog/fast-tests-with-and-without-rails).
+Soundcheck is a universal test runner. It automatically detects what testing
+frameworks you use, and how to run your tests. You can pass it a filename,
+and it'll run just those tests.
 
-The basic idea is that sometimes it's not necessary to run rspec through bundler,
-and it's possible to save a whole bunch of time off your test runs if it isn't. This script
-will attempt to determine whether you want the entire Gemfile required and ready, by looking
-whether you reference `spec_helper`. For Rails applications, this is reasonable, because if
-you require that file, you'll probably need all of Rails loaded. If you don't (as you can
-often do when running a spec for something you put in `Rails.root.join("lib")`), it'll execute
-"rspec $0", otherwise it'll execute "bundle exec rspec $0".
+One benefit of this is that you can set your editor to simply run `soundcheck
+$filename`, and soundcheck will figure out how to run that test.
+
+Soundcheck will also try to run your tests as fast as possible.
 
 ## Is Soundcheck not working for your project?
 
-Feel free to submit a pull request that adds only a fixture and RSpec testcase which describes the situation in which it fails. If you can fix it yourself, then great, but I'll happily accept patches that add more project styles which Soundcheck currently can't handle.
+Feel free to submit a pull request that adds only a fixture and RSpec testcase
+which describes the situation in which it fails. If you can fix it yourself,
+then great, but I'll happily accept patches that add more project styles which
+Soundcheck currently can't handle.
 
 ## Contributing to Soundcheck
  
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it
 * Fork the project
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to
+  have your own version, or is otherwise necessary, that is fine, but please
+  isolate to its own commit so I can cherry-pick around it.
 
 ## Copyright
 
 Copyright (c) 2011 Marten Veldthuis. See LICENSE.txt for further details.
 
+This gem started as a Ruby version of Gary Bernhardt's 'script/test' from
+[Destroy All Software's screencast number 10][1].
+
+[1]: http://destroyallsoftware.com/screencasts/catalog/fast-tests-with-and-without-rails

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/bin/soundcheck

@@ -14,6 +14,10 @@ option_parser = OptionParser.new do |opts|
     options[:trace] = true
   end
 
+  opts.on("-v", "--verbose", "Shows debug information about language/test-framework detection") do
+    options[:verbose] = true
+  end
+
   opts.on("--help", "Show this info") do
     puts opts
     exit
@@ -21,11 +25,16 @@ option_parser = OptionParser.new do |opts|
 end
 
 option_parser.parse!(ARGV)
+soundcheck = Soundcheck.new(ARGV[0], options)
+
 begin
-  cmd = Soundcheck.new(ARGV[0], options).command_to_run
+  cmd = soundcheck.command_to_run
   puts cmd
   exec cmd
 rescue Project::UnknownLanguage
   puts "Error: Cannot detect the programming language for this project."
   exit 1
+rescue Project::UnknownFramework
+  puts "Error: Cannot detect the test framework for this project."
+  exit 1
 end

data/features/soundcheck.feature

@@ -9,7 +9,13 @@ Feature: Soundcheck
   Scenario: Unknown languages
     Given the "null-project" fixture
     When I run "soundcheck"
-    Then I should see "Cannot detect the programming language for this project."
+    Then I should see "Cannot detect the programming language for this project"
+    And it should have failed
+
+  Scenario: Unknown frameworks
+    Given the "ruby-unknown-framework" fixture
+    When I run "soundcheck"
+    Then I should see "Cannot detect the test framework for this project"
     And it should have failed
 
   Scenario: Ruby and RSpec

data/fixtures/ruby-cutest/Rakefile

@@ -0,0 +1,7 @@
+require "cutest"
+
+task :test do
+  Cutest.run(Dir["test/*.rb"])
+end
+
+task :default => :test

data/lib/soundcheck/frameworks.rb

@@ -46,7 +46,7 @@ module Frameworks
     def filter(*args)
       filter_with(args, {
         :is_spec_file   => /_spec\.rb$/,
-        :is_in_spec_dir => /spec/,
+        :is_in_spec_dir => /^spec/,
         :is_dir         => lambda {|arg| project.has_dir?(arg) }
       })
     end
@@ -94,6 +94,27 @@ module Frameworks
     end
   end
 
+  class RubyCutest
+    include Frameworks::Base
+
+    def present?
+      project.has_file?("Rakefile") and project.file_contents("Rakefile") =~ /Cutest\.run/
+    end
+
+    def filter(*args)
+      filter_with(args, {
+        :is_in_test_dir => /^test\//
+      })
+    end
+
+    def command(*args)
+      args = (args.empty? ? ["test/*.rb"] : filter(*args))
+      return nil if args.empty?
+
+      "cutest #{args.join(" ")}".strip
+    end
+  end
+
   class Expresso
     include Frameworks::Base
 

data/lib/soundcheck/languages.rb

@@ -26,7 +26,7 @@ module Languages
     include Base
     
     def known_frameworks
-      [ Frameworks::RSpec, Frameworks::Cucumber ]
+      [ Frameworks::RSpec, Frameworks::Cucumber, Frameworks::RubyCutest ]
     end
   end
 

data/lib/soundcheck/project.rb

@@ -3,6 +3,8 @@ require 'soundcheck/languages'
 
 class Project
   class UnknownLanguage < StandardError; end
+  class UnknownFramework < StandardError; end
+
   attr_accessor :root
 
   def initialize(root)
@@ -25,17 +27,37 @@ class Project
     paths.any? { |path| has_file?(path) }
   end
 
+  def file_contents(filename)
+    File.read(File.expand_path(File.join(root, filename)))
+  end
+
   def language
-    return Languages::Ruby.new(self)   if has_file?("Gemfile")
-    return Languages::Ruby.new(self)   if has_file?("spec/*.rb")
-    return Languages::NodeJS.new(self) if has_file?("package.json")
-    raise UnknownLanguage
+    case
+    when has_file?("Gemfile")
+      logger.debug "You have a Gemfile, so I think this is Ruby."
+      return Languages::Ruby.new(self) 
+    when has_file?("Rakefile")
+      logger.debug "You have a Rakefile, so I think this is Ruby."
+      return Languages::Ruby.new(self) 
+    when has_file?("*.gemspec")
+      logger.debug "You have a gemspec, so I think this is Ruby."
+      return Languages::Ruby.new(self) 
+    when has_file?("package.json")
+      logger.debug "You have a package.json, so I think this is NodeJS."
+      return Languages::NodeJS.new(self) 
+    else
+      raise UnknownLanguage
+    end
   end
   
   def frameworks
-    language.frameworks.map do |framework_class|
+    detected_frameworks = language.frameworks.map do |framework_class|
       framework_class.new(self)
     end
+    logger.debug "Detected your frameworks: #{detected_frameworks}"
+
+    raise UnknownFramework if detected_frameworks.empty?
+    return detected_frameworks
   end
 
   def execute(command)

data/lib/soundcheck.rb

@@ -10,24 +10,16 @@ class Soundcheck
     self.project = Project.new(Dir.pwd)
     self.path = path
     self.options = options
+
+    logger.level = Logger::DEBUG if options[:verbose]
+    logger.debug "Debug logging enabled."
   end
 
   def command_to_run
-    commands = []
     project.frameworks.each do |framework|
       framework.options = options
       command = framework.command(*path)
-      commands << command if command
+      return command if command
     end
-    commands.first
-  end
-
-  def requires_spec_helper?
-    `grep -r 'spec_helper' #{@path}`
-    $?.exitstatus == 0 # matched
-  end
-
-  def has_gemfile?
-    File.exist?("Gemfile")
   end
 end

data/soundcheck.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "soundcheck"
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marten Veldthuis"]
@@ -41,12 +41,17 @@ Gem::Specification.new do |s|
     "fixtures/ruby-cucumber-rspec/spec/with_spec_helper_spec.rb",
     "fixtures/ruby-cucumber-rspec/spec/without_spec_helper_spec.rb",
     "fixtures/ruby-cucumber/features/cucumber.feature",
+    "fixtures/ruby-cutest/Rakefile",
+    "fixtures/ruby-cutest/test/foo.rb",
+    "fixtures/ruby-rspec-exception/Rakefile",
     "fixtures/ruby-rspec-exception/spec/spec_helper.rb",
     "fixtures/ruby-rspec-exception/spec/with_spec_helper_spec.rb",
     "fixtures/ruby-rspec-exception/spec/without_spec_helper_spec.rb",
+    "fixtures/ruby-rspec/Rakefile",
     "fixtures/ruby-rspec/spec/spec_helper.rb",
     "fixtures/ruby-rspec/spec/with_spec_helper_spec.rb",
     "fixtures/ruby-rspec/spec/without_spec_helper_spec.rb",
+    "fixtures/ruby-unknown-framework/Gemfile",
     "lib/soundcheck.rb",
     "lib/soundcheck/frameworks.rb",
     "lib/soundcheck/languages.rb",
@@ -56,6 +61,7 @@ Gem::Specification.new do |s|
     "spec/soundcheck/frameworks/cucumber_spec.rb",
     "spec/soundcheck/frameworks/expresso_spec.rb",
     "spec/soundcheck/frameworks/rspec_spec.rb",
+    "spec/soundcheck/frameworks/ruby_cutest_spec.rb",
     "spec/soundcheck/frameworks_spec.rb",
     "spec/soundcheck/languages_spec.rb",
     "spec/soundcheck/project_spec.rb",

data/spec/soundcheck/frameworks/ruby_cutest_spec.rb

@@ -0,0 +1,44 @@
+require_relative '../../spec_helper'
+require 'soundcheck/project'
+require 'soundcheck/frameworks'
+
+describe "Frameworks" do
+  let(:project) { Project.new(fixture("null-project")) }
+
+  describe "Ruby Cutest" do
+    # This is for the Ruby library called Cutest,
+    # not the C Unit Testing library called CuTest
+    #
+    # https://github.com/djanowski/cutest
+    
+    let(:framework) { Frameworks::RubyCutest.new(project) }
+
+    it "should find the rspec framework" do
+      project.stub!(:root => fixture("ruby-cutest"))
+      framework.present?.should be_true
+    end
+    
+    it "should not find when not there" do
+      framework.present?.should be_false
+    end
+
+    it "should work with no args" do
+      framework.command().should == "cutest test/*.rb"
+    end
+
+    it "should not do anything when args contain no cutest files" do
+      framework.command("features/a.feature").should == nil
+    end
+
+    it "should work with args" do
+      cmd = framework.command("test/a.rb", "test/b.rb")
+      cmd.should == "cutest test/a.rb test/b.rb"
+    end
+
+    it "should filter invalid non-cutest args" do
+      cmd = framework.command("test/a.rb", "features/a.feature")
+      cmd.should == "cutest test/a.rb"
+    end
+  end
+end
+

data/spec/soundcheck/project_spec.rb

@@ -19,8 +19,8 @@ describe Project do
   it "should ask the language to determine the frameworks used" do
     project = Project.new(stub)
     language = stub
-    language.should_receive(:frameworks).and_return([])
-    project.stub!(:language => language)
+    language.should_receive(:frameworks).and_return([stub.as_null_object])
+    project.stub(:language => language)
     project.frameworks
   end
 end

data/spec/soundcheck_spec.rb

@@ -23,10 +23,6 @@ describe "Soundcheck" do
           cmd_for.should == "bundle exec rspec spec"
         end
 
-        it "should run only fast specs" do
-          cmd_for("spec", fast: true).should == "rspec spec/without_spec_helper_spec.rb"
-        end
-
         it "should return 'bundle exec rspec spec/with_spec_helper_spec.rb'" do
           cmd_for('spec/with_spec_helper_spec.rb').should == "bundle exec rspec spec/with_spec_helper_spec.rb"
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soundcheck
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &13400120 !ruby/object:Gem::Requirement
+  requirement: &8641460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *13400120
+  version_requirements: *8641460
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13398020 !ruby/object:Gem::Requirement
+  requirement: &8640200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13398020
+  version_requirements: *8640200
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &13397100 !ruby/object:Gem::Requirement
+  requirement: &8656340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *13397100
+  version_requirements: *8656340
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &13396180 !ruby/object:Gem::Requirement
+  requirement: &8655680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13396180
+  version_requirements: *8655680
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &13394460 !ruby/object:Gem::Requirement
+  requirement: &8654740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13394460
+  version_requirements: *8654740
 description: Soundcheck tries to figure out what kind of project you're working on,
   what test file you're trying to run, and what the fastest way is to run that.
 email: marten@veldthuis.com
@@ -99,12 +99,17 @@ files:
 - fixtures/ruby-cucumber-rspec/spec/with_spec_helper_spec.rb
 - fixtures/ruby-cucumber-rspec/spec/without_spec_helper_spec.rb
 - fixtures/ruby-cucumber/features/cucumber.feature
+- fixtures/ruby-cutest/Rakefile
+- fixtures/ruby-cutest/test/foo.rb
+- fixtures/ruby-rspec-exception/Rakefile
 - fixtures/ruby-rspec-exception/spec/spec_helper.rb
 - fixtures/ruby-rspec-exception/spec/with_spec_helper_spec.rb
 - fixtures/ruby-rspec-exception/spec/without_spec_helper_spec.rb
+- fixtures/ruby-rspec/Rakefile
 - fixtures/ruby-rspec/spec/spec_helper.rb
 - fixtures/ruby-rspec/spec/with_spec_helper_spec.rb
 - fixtures/ruby-rspec/spec/without_spec_helper_spec.rb
+- fixtures/ruby-unknown-framework/Gemfile
 - lib/soundcheck.rb
 - lib/soundcheck/frameworks.rb
 - lib/soundcheck/languages.rb
@@ -114,6 +119,7 @@ files:
 - spec/soundcheck/frameworks/cucumber_spec.rb
 - spec/soundcheck/frameworks/expresso_spec.rb
 - spec/soundcheck/frameworks/rspec_spec.rb
+- spec/soundcheck/frameworks/ruby_cutest_spec.rb
 - spec/soundcheck/frameworks_spec.rb
 - spec/soundcheck/languages_spec.rb
 - spec/soundcheck/project_spec.rb
@@ -134,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 280549212228534180
+      hash: -2863149779894878725
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: