assert 2.2.0 → 2.3.0

data/README.md

@@ -194,7 +194,60 @@ end
 Using the CLI:
 
 ```sh
-$ assert [-t|--halt|--no-halt]
+$ assert [-t|--halt-on-fail|--no-halt-on-fail]
+```
+
+### Changed Only
+
+By default, Assert loads every test file in the path(s) it is given and runs the tests in those files.  At times it is convenient to only run certain test files while you are actively developing on a feature.  Assert can detect which test files have changes and only load those files:
+
+In user/local settings file:
+
+```ruby
+Assert.configure do |config|
+  config.changed_only true  # not recommended - use the CLI with the `-c` flag
+end
+```
+
+Using the CLI:
+
+```sh
+$ assert [-c|--changed-only|--no-changed-only]
+```
+
+#### Changed Test File Detection
+
+The changed files are detected using two git commands by default:
+
+```sh
+git diff --no-ext-diff --name-only        # changed files
+git ls-files --others --exclude-standard  # added files
+```
+
+The git cmds have ` -- #{test_paths}` appended to them to scope their results to just the test paths specified by the CLI and are run together using ` && `.
+
+This, of course, assumes you are working in a git repository.  If you are not or you want to use custom logic to determine the changed files, configure a custom proc.  The proc should take a single parameter which is an array of test paths specified by the CLI.
+
+```ruby
+Assert.configure do |config|
+  config.changed_files do |test_paths|
+    `git diff --name-only master -- #{test_paths.join(' ')}`.split("\n")  # or whatever
+  end
+end
+```
+
+If you just want to disable this feature completely:
+
+```ruby
+Assert.configure do |config|
+
+  # run nothing if the `-c` flag is given
+  config.changed_files{ |test_paths| [] }
+
+  # run all test paths if the `-c` flag is given
+  config.changed_files{ |test_paths| test_paths }
+
+end
 ```
 
 ## Viewing Test Results
@@ -330,4 +383,4 @@ If submitting a Pull Request, please:
 
 One note: please respect that Assert itself is intended to be the flexible, base-level, framework-type logic that should change little if at all.  Pull requests for niche functionality or personal testing philosphy stuff will likely not be accepted.
 
-If you wish to extend Assert for your niche purpose/desire/philosophy, please do so in it's own gem (preferrably named `assert-<whatever>`) that uses Assert as a dependency.  When you do, tell us about it and we'll add to this README with a short description.
+If you wish to extend Assert for your niche purpose/desire/philosophy, please do so in it's own gem (preferrably named `assert-<whatever>`) that uses Assert as a dependency.  When you do, tell us about it and we'll add it to this README with a short description.

data/lib/assert.rb

@@ -45,8 +45,9 @@ module Assert
       end
     end
 
-    settings :view, :suite, :runner, :test_dir, :test_helper
-    settings :runner_seed, :capture_output, :halt_on_fail, :debug
+    settings :view, :suite, :runner, :test_dir, :test_helper, :changed_files
+    settings :runner_seed, :capture_output, :halt_on_fail, :changed_only
+    settings :debug
 
     def initialize
       @view   = Assert::View::DefaultView.new($stdout)
@@ -55,10 +56,22 @@ module Assert
       @test_dir    = "test"
       @test_helper = "helper.rb"
 
-      # default settings
+      # use git, by default, to determine which files have changes
+      @changed_files = proc do |test_paths|
+        cmds = [
+          "git diff --no-ext-diff --name-only",       # changed files
+          "git ls-files --others --exclude-standard"  # added files
+        ]
+        cmd = cmds.map{ |c| "#{c} -- #{test_paths.join(' ')}" }.join(' && ')
+        puts "  `#{cmd}`" if Assert.config.debug
+        `#{cmd}`.split("\n")
+      end
+
+      # default option values
       @runner_seed    = begin; srand; srand % 0xFFFF; end.to_i
-      @capture_output = true
+      @capture_output = false
       @halt_on_fail   = true
+      @changed_only   = false
       @debug          = false
     end
 

data/lib/assert/assert_runner.rb

@@ -46,10 +46,25 @@ module Assert
     private
 
     def test_files(test_paths)
+      file_paths = if Assert.config.changed_only
+        changed_test_files(test_paths)
+      else
+        globbed_test_files(test_paths)
+      end
+
+      file_paths.select{ |p| is_test_file?(p) }.sort
+    end
+
+    def changed_test_files(test_paths)
+      puts "Loading only changed files:" if Assert.config.debug
+      globbed_test_files(Assert.config.changed_files.call(test_paths))
+    end
+
+    def globbed_test_files(test_paths)
       test_paths.inject(Set.new) do |paths, path|
         p = File.expand_path(path, Dir.pwd)
         paths += Dir.glob("#{p}*") + Dir.glob("#{p}*/**/*")
-      end.select{ |p| is_test_file?(p) }.sort
+      end
     end
 
     def is_test_file?(path)

data/lib/assert/cli.rb

@@ -21,6 +21,9 @@ module Assert
         option 'halt_on_fail', 'halt a test when it fails', {
           :abbrev => 't'
         }
+        option 'changed_only', 'only run test files with changes', {
+          :abbrev => 'c'
+        }
         # show loaded test files, cli err backtraces, etc
         option 'debug', 'run in debug mode'
       end

data/lib/assert/version.rb

@@ -1,3 +1,3 @@
 module Assert
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/test/unit/assert_tests.rb

@@ -30,9 +30,9 @@ module Assert
     desc "the Assert Config singleton"
     subject { Config }
 
-    should have_imeths :suite, :view, :runner, :test_dir, :test_helper
-    should have_imeths :runner_seed, :capture_output, :halt_on_fail, :debug
-    should have_imeths :apply
+    should have_imeths :suite, :view, :runner, :test_dir, :test_helper, :changed_files
+    should have_imeths :runner_seed, :capture_output, :halt_on_fail, :changed_only
+    should have_imeths :debug, :apply
 
     should "default the view, suite, and runner" do
       assert_kind_of Assert::View::DefaultView, subject.view

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: assert
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 2
-  - 2
+  - 3
   - 0
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-03 00:00:00 Z
+date: 2013-07-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ansi