tconsole 1.1.0pre12 → 1.1.0

data/README.md

@@ -1,18 +1,24 @@
-tconsole
+TConsole
 ======
 
-tconsole is a testing console for Rails. It allows you to issue commands
+TConsole is a testing console for Rails. It allows you to issue commands
 concerning what tests to run, and see their test output. It's also got a
 helpful reload command for when your Rails environment needs to be
 restarted.
 
-tconsole has only been tested with Rails 3 with Ruby 1.9.3 and 1.8.7 with MiniTest as the testing framework (the Rails default) on a Mac, but in theory it should work with pretty much any Unixy operating system (tconsole uses fork a good bit).
+TConsole should work in pretty much any Unix environment and will work with apps running Ruby 1.8.7 and Ruby 1.9.3. It can be run on pretty much any test suite that uses MiniTest, including Rails test suites.
 
-Why use tconsole?
+See it in Action
 ------
+There's a quick screencast on Vimeo about TConsole's basic features: [Meet TConsole!](https://vimeo.com/37641415)
 
-* A large amount of time is wasted loading the Rails environment each time you run the Rails testing rake tasks. tconsole loads the environment when you start the console and whenever you reload the environment, but doesn't have to reload the environment for each test execution.
-* The Rails rake task syntax `bundle exec rake test:units TEST=test/unit/user_test.rb` can be pretty verbose when you're running specific tests. Yeah, there are tricks you can use to shorten things up, but still, that's crazy long. tconsole lets you just type `test/unit/user_test.rb` to get that specific test file to run. I'm working on fuzzy matching, too, so that you can just type 'user' and get the user test to run.
+Why use TConsole?
+------
+
+* A large amount of time is wasted loading the Rails environment each time you run the Rails testing rake tasks. TConsole loads the environment when you start the console and whenever you reload the environment, but doesn't have to reload the environment for each test execution.
+* The Rails rake task syntax `bundle exec rake test:units TEST=test/unit/user_test.rb` can be pretty verbose when you're running specific tests. Yeah, there are tricks you can use to shorten things up, but still, that's crazy long. tconsole lets you just type `test/unit/user_test.rb` to get that specific test file to run. With TConsole  you can just type `UserTest` and the test runs!
+* TConsole makes it dead simple to review how long your tests are taking to run and pinpoint your slowest running tests.
+* Re-running failed tests is as easy as typing `!failed` with TConsole.
 
 What about Spork?
 ------
@@ -20,21 +26,21 @@ What about Spork?
 
 What about rspec?
 ------
-I'm not sure if tconsole will ever support rspec or not. I love the idea
-of adding support for rspec, but I also don't use rspec all that often,
-so it likely wouldn't be very well tested. If enough people fuss at me,
-or if someone were willing to add and maintain rspec support I'd definitely be
-willing to merge it in, though.
+We've decided to focus on integrating with MiniTest as tightly as possible, rather than worrying about rspec support.
 
-Installing tconsole
+Installing TConsole
 ------
-	gem install tconsole
+    gem install tconsole
+
+Prereleases of TConsole come out pretty frequently. You can install the latest prerelease version with:
 
-Prereleases of tconsole come out pretty frequently. You can install the latest prerelease version with:
+    gem install tconsole --pre
+    
+If you're using bundler, you probably want to simply add TConsole to your Gemfile:
 
-	gem install tconsole --pre
+    gem "tconsole"
 
-How to use tconsole
+How to use TConsole
 ------
 In your shell of choice, cd into your Rails project's directory and then run `bundle exec tconsole` to fire up the console. You should see something like this:
 
@@ -66,23 +72,25 @@ Now that you're in the console, let's test out the `all` command! Running `all`
 
 If you want to focus in on a particular subset of your tests, like units, functionals, or integration, just enter that keyword:
 
-	> units
+    > units
 
-	> functionals
+    > functionals
 
-	> integration
+    > integration
 
 You can also specify to run all tests in a specific class:
 
-	> UserTest
+    > UserTest
 
-You can go one bit deeper and just run a particular test in that file as
+You can dig a bit deeper and just run a particular test in that file as
 well:
 
-	> UserTest#test_that_user_is_healthy
+    > UserTest#test_that_user_is_healthy
 
 You can list more than just one class or class and method to run, and
-tconsole will run them all.
+TConsole will run them all.
+
+    > UserTest InvoiceTest SubscriptionTest#test_that_renew_renews_the_subscription
 
 There are a few special ! commands that use data from past test runs. The `!failed` command will rerun the set of tests that failed during the last run:
 
@@ -107,7 +115,16 @@ improve slow tests:
 	0.001128s PostTest#test_post's_state_should_change_when_published
 	0.001056s PostTest#test_returning_only_published_posts
 	0.000923s PostTest#test_post_should_have_respond_to_published_appropriately
-	0.00077s PostTest#test_post_should_have_a_body
+	0.000770s PostTest#test_post_should_have_a_body
+
+You can turn on the Fail Fast feature to cause TConsole to stop running
+tests as soon as the first test fails. To enable fail fast simply enter:
+
+  > set fast on
+
+In the console. You can disable Fail Fast again with:
+
+  > set fast off
 
 If you update your environment, maybe by editing your Gemfile or changing one of your application's configuration files, you can use the `reload` command to reload the entire environment:
 
@@ -117,12 +134,66 @@ And then finally, you can run the `exit` command to quit:
 
 	> exit
 
+Configuration Files
+------
+
+TConsole attempts to load a .tconsole file in your home directory
+and in your project directory, in that order, to configure your preferred defaults for TConsole. In many situations you won't need to edit your TConsole configuration files to run TConsole, because it includes a sane set of defaults and attempts to auto-detect Rails applications. 
+
+Here's a commented example configuration file:
+
+``` ruby
+TConsole::Config.run do |config|
+  # Configures the directory where your tests are located
+  config.test_dir = "./test"
+
+  # Include paths that should be added to Ruby's load path
+  config.include_paths = ["./test", "./lib"]
+
+  # Paths that should be preloaded. You'll have to run the reload
+  # command to reload these paths in TConsole
+  config.preload_paths = ["./config/application"]
+
+  # File sets are the named sets of files that can be executed. A file
+  # set named "all" must be included.
+  config.file_sets => {
+    "all" => ["test/**/*_test.rb"],
+    "units" => ["test/units/**/*_test.rb"]
+  }
+
+  # Fail fast specifies whether or not tests should stop executing once
+  # the first failure occurs.
+  config.fail_fast = true
+
+  # Specifies code to be run before loading the environment
+  config.before_load do
+    ENV["RAILS_ENV"] ||= "test"
+  end
+
+  # Specifies code to be run after loading the environment
+  config.after_load do
+    ::Rails.application
+    ::Rails::Engine.class_eval do
+      def eager_load!
+        # turn off eager_loading
+      end
+    end
+  end
+
+  # Specifies code to be run before each test execution
+  config.before_test_run do
+    puts "I'm about to run!!!"
+  end
+end
+```
+
+
 Reporting Issues and Contributing
 ------
 
 Feel free to report issues in the issue tracker at https://github.com/commondream/tconsole/issues. Be sure to include the versions of Ruby, Rails, and your operating system. For bonus points, fork the project and send me a pull request with the fix for the issue you're seeing.
 
-tconsole is just a quick idea I had that I wanted to spike out, so there aren't any tests yet. Hopefully that will change in the near future!
+*How embarrassing?!?! A testing tool with no tests?* At first TConsole was just a bit of experimental code, so test coverage is light. I am working on improving that, though.
 
 License
 -----

data/lib/tconsole/minitest_handler.rb

@@ -181,9 +181,9 @@ module TConsole
             self.passes += 1
           end
 
-          results.failures << id unless result == "P"
+          results.failures << id unless result == "P" || result == "S"
 
-          if config.fail_fast && result != "P"
+          if config.fail_fast && result != "P" && result != "S"
             @failed_fast = true
           end
 

data/lib/tconsole/version.rb

@@ -1,3 +1,3 @@
 module TConsole
-  VERSION = "1.1.0pre12"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: tconsole
 version: !ruby/object:Gem::Version
-  version: 1.1.0pre12
-  prerelease: 5
+  version: 1.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Alan Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-27 00:00:00.000000000 Z
+date: 2012-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &70138167691280 !ruby/object:Gem::Requirement
+  requirement: &70183807578140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70138167691280
+  version_requirements: *70183807578140
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70138167690780 !ruby/object:Gem::Requirement
+  requirement: &70183807577640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 2.11.0
   type: :runtime
   prerelease: false
-  version_requirements: *70138167690780
+  version_requirements: *70183807577640
 description: ! "    tconsole allows Rails developers to easily and quickly run their
   tests as a whole or in subsets. It forks the testing processes from\n    a preloaded
   test environment to ensure that developers don't have to reload their entire Rails
@@ -78,9 +78,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: tconsole
 rubygems_version: 1.8.11