test_console 0.0.6 → 0.0.7

data/README.rdoc

@@ -1,3 +1,9 @@
 = TestConsole
 
-This project rocks and uses MIT-LICENSE.
+Interactive console for running TestUnit tests against a Rails application.
+
+Please note : This console was written specifically to aid with testing a specific application and so has only been tested in a small number of environments.  Please report any issues via the [Github issues](https://github.com/adamphillips/test_console/issues) page.
+
+For more information see
+
+https://github.com/adamphillips/test_console

data/lib/action_view/resolver.rb

@@ -1,6 +1,10 @@
-# This sets ActionView to use our custom test when checking whether to cache view templates
+# In order to be able to run our tests with cache_classes enabled, we need to be able to control when our views are reloaded.
+# Otherwise view changes won't take effect in our console
+# This sets ActionView to use our custom test when checking whether to cache view templates meaning that we can use this function to expire the view cache as necessary.
 module ActionView
   class Resolver
+
+    # Wether to cache view templates
     def caching?
       @caching = TestConsole.views_changed?
     end

data/lib/test_console/config.rb

@@ -3,11 +3,20 @@ module TestConsole
     yield Config
   end
 
+  # Returns an array of commands for the specfied function.
+  # Valid commands are:
+  #
+  #   :run
+  #   :rerun
+  #   :quit
+  #   :help
+  #
   def self.commands(type)
     command = "#{type}_commands".to_sym # Deliberately not to_s-ing to avoid :
     TestConsole::Config.send(command) if TestConsole::Config.respond_to?(command)
   end
 
+  # Configuration options for the test console.
   module Config
 
     # Folders to watch
@@ -23,6 +32,9 @@ module TestConsole
     mattr_accessor :stop_folders
     @@stop_folders = ['test/fixtures', 'config/environments']
 
+    # These folders are dropped from class paths when determining a class from a filename
+    mattr_accessor :drop_folders
+    @@drop_folders = ['test', 'unit', 'functional', 'helpers', 'integration']
 
     # CLI Commands
     #
@@ -62,11 +74,11 @@ module TestConsole
     @@backtrace_local_color = @@error_color
     @@backtrace_gem_color = :magenta
 
-    # Fail
+    # Failed test runs
     mattr_accessor :fail_color
     @@fail_color = :magenta
 
-    # Success
+    # Successful test runs
     mattr_accessor :success_color
     @@success_color = :green
 

data/lib/test_console/output.rb

@@ -9,6 +9,14 @@ module TestConsole
     # =================
     # Functions to format and display output
 
+    # Writes content out to the terminal
+    # Use Hirb to format tables.
+    # Can specify a color using one of the defined color constants
+    #
+    # Examples
+    #
+    #   out 'some_text', :blue  # Prints out the text in blue
+    #
     def out(text, text_color=nil, *opts)
       extend Hirb::Console
       text = text.to_a if text.kind_of? ActiveRecord::Base
@@ -24,6 +32,8 @@ module TestConsole
       end
     end
 
+    # Puts out an error.
+    # The error is written to STDERR and colored in the error color.
     def error(message, backtrace=nil)
       STDERR.puts color(message, error_color)
       backtrace.each {|line| line_color = (line[0..1] == '/') ? backtrace_local_color : backtrace_gem_color; STDERR.puts color(line, line_color)} unless backtrace.nil? || backtrace.empty?
@@ -37,6 +47,7 @@ module TestConsole
       end
     end
 
+    # Outputs a summary of the results
     def print_result_summary(result, time_taken=0)
       if result.failure_count == 0 && result.error_count == 0
         final_color = success_color

data/lib/test_console/runner.rb

@@ -3,8 +3,16 @@ module TestConsole
     include TestConsole::Colors
     include TestConsole::Config
 
-    # Checks that the specified path is valid
-    # If so it creates a test suite from the path and runs it
+    # Checks that the specified path is valid.
+    # If so it creates a test suite from the path and runs it.
+    # If a filter is passed as a string or regex, individual test names are filtered by the expression.
+    #
+    # Examples:
+    #
+    #   run './unit'                           # Run every test in the unit folder
+    #   run './unit/a_model_test.rb'           # Run the specific test file
+    #   run './unit', 'update'                 # Run every test in the unit folder that has update in the test name
+    #   run './unit/a_model_test.rb' /update/i # Run every test in specified file whose name contains a case-insensitve version of 'update'
     def run path, filter=nil
       begin
         unless path && !path.empty?
@@ -36,6 +44,14 @@ module TestConsole
     end
 
     # Reruns previous failures or errors
+    # Can either just run errors or failures
+    #
+    # Examples:
+    #
+    #   rerun           # Rerun everything
+    #   rerun :errors   # Rerun errors
+    #   rerun :failures # Rerun failures
+    #
     def rerun type=nil
       return false unless @last_run_path
 
@@ -66,6 +82,7 @@ module TestConsole
     end
 
     # Runs a defined suite of tests
+    # Outputs the results
     def run_suite(suite)
       @abort = false
       @running = true
@@ -107,6 +124,8 @@ module TestConsole
       @last_run_time = Time.now
     end
 
+    # If there is a test suite running, the run is aborted
+    # Otherwise the console is killed
     def abort
       (@running) ? @abort = true : die
     end

data/lib/test_console/utility.rb

@@ -4,9 +4,17 @@ module TestConsole
       base.extend(ClassMethods)
     end
 
+    # Returns an array of class components from a filename
+    #
+    # Common folder names are dropped from the array to avoid confusion.
+    #
+    # Examples:
+    #
+    #   class_from_filename module/controller        # ['Module', 'Controller']
+    #   class_from_filename unit/module/controller   # ['Module', 'Controller']
+    #   class_from_filename parent/module/controller # ['Parent', 'Module', 'Controller']
+    #
     module ClassMethods
-      ## Returns an array of class components from a filename
-      ## eg for module/controller => ['Module', 'Controller']
       def class_from_filename(filename)
         segs = filename.split('/')
         segs.delete ''
@@ -14,13 +22,20 @@ module TestConsole
         segs.last.gsub!('.rb', '')
 
         # drop the test folder
-        segs = segs[1..-1] while segs[0] == 'test'
-        segs = segs[1..-1] while ['unit', 'functional', 'helpers', 'integration'].include?(segs[0])
+        segs = segs[1..-1] while TestConsole.drop_folders.include?(segs[0])
         ret = segs.map {|seg| seg.camelize}
 
         return ret
       end
 
+      # Returns boolean as to wether the specified constant is defined.
+      #
+      # Examples:
+      #
+      #   const_defined? 'String' # true
+      #   const_defined? 'WierdClass' # false
+      #   const_defined? ['ActiveRecord', 'Base'] # true (assuming Active Record is installed)
+      #
       def const_defined?(klass)
         klass = [klass] unless klass.kind_of? Array
         klass.inject(Object) do |context, scope|
@@ -32,6 +47,13 @@ module TestConsole
         end
       end
 
+      # Returns the specified class.
+      #
+      # Examples:
+      #
+      #   const_get 'String'                      # String
+      #   const_get ['ActiveRecord', 'Base']      # ActiveRecord::Base
+      #
       def const_get(klass)
         klass = [klass] unless klass.kind_of? Array
         klass.inject(Object) do |context, scope|
@@ -39,6 +61,13 @@ module TestConsole
         end
       end
 
+      # Removes the specified class.
+      #
+      # Examples:
+      #
+      #   const_get 'String'                      # String
+      #   const_get ['ActiveRecord', 'Base']      # ActiveRecord::Base
+      #
       def const_remove(klass)
         klass = [klass] unless klass.kind_of? Array
         if klass.length > 1

data/lib/test_console/version.rb

@@ -1,3 +1,3 @@
 module TestConsole
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/test/dummy/log/test.log

@@ -1738,3 +1738,40 @@ Connecting to database specified by database.yml
    (0.0ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: test_console
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Adam Phillips