tconsole 0.0.1.pre → 0.0.2.pre

data/README.md

@@ -0,0 +1,80 @@
+tconsole
+======
+
+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 with MiniTest as the testing framework (the Rails default) on a Mac. This is super mega alpha at this point, so your mileage may vary. I'd love to hear how it works for you, though!
+
+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. I'm working on fuzzy matching, too, so that you can just type 'user' and get the user test to run.
+
+What about Spork?
+------
+Spork's really cool, but I've always felt like using DRb and having extra consoles open feels a bit heavy for what I want to do. Beyond that, I couldn't ever figure out how to get Spork to work with test/unit, and since me and DHH are the only two people who still use test/unit someone's got to carry the torch for test/unit awesomeness. Really, though, if Spork's your cup of tea, stop reading this and use what you like.
+
+Installing tconsole
+------
+	gem install tconsole --pre
+
+How to use tconsole
+------
+In your shell of choice, cd into your Rails project's directory and then run the `tconsole` command to fire up the console. You should see something like this:
+
+	tconsole
+	
+	Loading your Rails environment...
+	Environment loaded in 7.160264s.
+	
+	> 
+	
+Now that you're in the console, let's test out the all command! Running all from the console runs all of your unit, functional, and integration tests:
+
+	> all
+	Running tests...
+	
+	Run options: 
+
+	# Running tests:
+
+	....................................................................................
+	
+	Finished tests in 6.054574s, 6.4999 tests/s, 10.5822 assertions/s.
+
+	39 tests, 45 assertions, 0 failures, 0 errors, 0 skips
+
+	Test time (including load): 82.806741s
+	
+	> 
+	
+If you want to focus in on a particular subset of your tests, like units, functionals, or integration, just enter that keyword:
+
+	> units
+         
+	> functionals
+         
+	> integration
+         
+You can also focus in on just the tests in a given filename by entering a test file name into tconsole:
+
+	> test/unit/user_test.rb
+	
+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:
+
+	> reload
+	
+And then finally, you can run the `exit` command to quit:
+
+	> exit
+	
+Reporting Issues and Contributing
+------
+
+Feel free to report issues in the issue tracker at https://github.com/commondream/tconsole/issues. 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!

data/bin/tconsole

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require "tconsole"
+require File.join(File.dirname(__FILE__), "..", "lib", "tconsole")
 
 TConsole::Runner.run

data/lib/tconsole.rb

@@ -8,54 +8,62 @@ module TConsole
     # Spawns a new environment. Looks at the results of the environment to determine whether to stop or
     # keep running
     def self.run
+
+      stty_save = `stty -g`.chomp
+
+      # We're only going to handle interrupts on the inner process
+      trap("SIGINT", "IGNORE");
       running = true
 
       while running
-        read, write = IO.pipe
         pid = fork do
-          response = run_environment(write)
-          write.puts [Marshal.dump(response)].pack("m")
+          exit run_environment ? 0 : 1
         end
-        write.close
 
-        response = read.read
-        Process.wait2(pid)
-        running = Marshal.load(response.unpack("m")[0])
-        read.close
+        pid, status = Process.wait2(pid)
+        running = false if status.exitstatus != 0
       end
 
       puts
       puts "Exiting. Bye!"
+      system("stty", stty_save);
     end
 
     # Starts our Rails environment and listens for console commands
     # Returns true if we should keep running or false if we need to exit
-    def self.run_environment(write)
+    def self.run_environment
+
+      trap("SIGINT", "SYSTEM_DEFAULT");
 
       puts
       puts "Loading Rails environment..."
       time = Benchmark.realtime do
-        # Ruby environment loading is shamelessly borrowed from spork
-        ENV["RAILS_ENV"] ||= "test"
-        $:.unshift("./test")
-
-        require "./config/application"
-        ::Rails.application
+        begin
+          # Ruby environment loading is shamelessly borrowed from spork
+          ENV["RAILS_ENV"] ||= "test"
+          $:.unshift("./test")
+
+          require 'rake'
+          Rake.application.init
+          Rake.application.load_rakefile
+          Rake.application.invoke_task("test:prepare")
+        rescue Exception => e
+          puts "Error: Loading your environment failed."
+          puts "    #{e.message}"
+          return false
+        end
       end
 
       puts "Environment loaded in #{time}s."
       puts
 
-      # Store the state of the terminal
-      stty_save = `stty -g`.chomp
-      #trap('INT') { system('stty', stty_save); exit }
-
-
       while line = Readline.readline('> ', true)
         if line == "exit"
           return false
         elsif line == "reload"
           return true
+        elsif line == "help"
+          help
         elsif line == "units"
           run_tests(["test/unit/**/*_test.rb"])
         elsif line == "functionals"
@@ -68,6 +76,8 @@ module TConsole
           run_tests([line])
         end
       end
+
+      return false
     end
 
     # Taks an array of globs and loads all of the files in the globs
@@ -75,6 +85,7 @@ module TConsole
     def self.run_tests(globs)
       time = Benchmark.realtime do
         pid = fork do
+
           puts "Running tests..."
           puts
 
@@ -95,5 +106,20 @@ module TConsole
       puts "Test time (including load): #{time}s"
       puts
     end
+
+    # Prints a list of available commands
+    def self.help
+      puts
+      puts "Available commands:"
+      puts
+      puts "all          # Run all test types (units, functionals, integration)"
+      puts "units        # Run unit tests"
+      puts "functionals  # Run functional tests"
+      puts "integration  # Run integration tests"
+      puts "[filename]   # Run the tests contained in the given file"
+      puts "reload       # Reload your Rails environment"
+      puts "exit         # Exit the console"
+      puts
+    end
   end
 end

data/lib/tconsole/version.rb

@@ -1,3 +1,3 @@
 module TConsole
-  VERSION = "0.0.1.pre"
+  VERSION = "0.0.2.pre"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tconsole
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.2.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-09 00:00:00.000000000 Z
+date: 2011-12-11 00:00:00.000000000 Z
 dependencies: []
 description: tconsole gives you a helpful console for running Rails tests
 email:
@@ -21,8 +21,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
-- TODO
 - bin/tconsole
 - lib/tconsole.rb
 - lib/tconsole/version.rb

data/TODO

@@ -1,3 +0,0 @@
-* Add help command
-* Add ability to profile tests
-* Figure out why ^c isn't working