tdd 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c337dcf125a3795f242b37328ed90725a2a657d0
-  data.tar.gz: 7c856ba470d40519c294892f3e688dd9b4bb506f
+  metadata.gz: 863069f0064d687d78e650b01f33d0419a297c7f
+  data.tar.gz: 63b348bc4c11460cf2d65506bfa4dbda3deec025
 SHA512:
-  metadata.gz: 1c921d3932a72fec950705e48aa0f089269b8b08bf3eb7eb8fe75cd140afcf1319ce34140e0dfb928ad7cd2fdd7ba4970ec8ecc62154b61dbf1cd71dbc432abb
-  data.tar.gz: 959cdfc6dde23e9fc68b6d6a127435b0c2aad458bed0adc35c53b380d9e0afa11fa2e33bfdbbd30f29f227523ad4e02501d1b6ac0c80af53330d7561c5016bad
+  metadata.gz: 5ca2dd2d3c6d6bd07cfe6f4e9a58711b8836cc359d7c7cb699be21f0320233c6b57a7d01d3a0b227cb12b0c00a32d17224905627dbac08766ff9435cc6db0c39
+  data.tar.gz: 29db08f5c4ca3dffcf0b14b76ef208e111738b2c14fffd1f63db059fc12ae138a5e1d8c316d199d8f10ffbaa79a7b0d29b340b137f75dfe64a436dd284e87cdc

data/README.md

@@ -4,53 +4,69 @@ tdd
 [![Gem Version](https://badge.fury.io/rb/tdd.png)](http://badge.fury.io/rb/tdd) 
 [![Code Climate](https://codeclimate.com/github/ubermajestix/tdd.png)](https://codeclimate.com/github/ubermajestix/tdd)
 
-Watch files and run test/unit or rspec tests when those files change.
-
-Is it awesome?
---------------
-Yes.
-
+####A simple command line tool for running tests when files change. 
+#####Yes, it is awesome. :red_circle: :green_heart: :repeat:
 
 Examples
 --------
 
-Use with test/unit:
+###Test::Unit
 
     $ tdd test/unit/some_unit_test.rb
 
-Use with rspec:
+###RSpec
 
     $ tdd spec/some_spec.rb
     # Run all specs
     $ tdd spec
 
-Use with rake:
+###Rake
 
     $ tdd rake test:functional
     $ tdd rake spec
 
-You can pass arguments you would normally pass to `ruby -Itest` or `rspec`
+###Pass framework specific arguments
+You can pass arguments you would normally pass to `ruby -Itest` or `rspec`, note the double-dash "--".
   
     $ tdd -- test/unit/some_unit_test.rb -n /some_test_name/
     $ tdd -- spec/some_spec.rb:42 --fail-fast
 
-By default, tdd will watch files in app, lib, config, test, and spec
-directories, if they exist, and run your test command if any file being
-watched changes.
-
-You can specify which files to watch (note the double dashes `--`
+###Globs by default
+By default, tdd will search for similarly named files to your test to watch. tdd will look for `some_unit.rb` 
+in your project and watch it for changes, along with the test file.
+    
+    $ tdd -- test/unit/some_unit.rb
+    Running: ruby -Itest test/unit/some_unit_test.rb
+    Watching:
+    /Users/ubermajestix/some_project/lib/some_unit.rb
+    /Users/ubermajestix/some_project/lib/modules/plugins/stuff/some_unit.rb
+    /Users/ubermajestix/some_project/test/unit/some_unit_test.rb
+
+###All of the files
+Run tdd in the "all" mode to watch all files in app, lib, config, test, and spec
+directories, if they exist. The double-dash "--" seperates tdd's modes from the testing command.
+
+    $ tdd all -- test/unit/some_unit_test.rb
+    Running: ruby -Itest test/unit/some_unit_test.rb
+    Watching 3417 files in app/ lib/ config/ test/ spec/
+
+###Some of the files
+You can specify which files to watch, again, note the double-dash "--"
 separating the files to watch from the test file and options):
 
-    $ tdd lib/some_unit.rb config/setup.rb -- test/unit/some_unit.rb -n/some_test_name/
+    $ tdd lib/some_unit.rb config/setup.rb -- test/unit/some_unit_test.rb -n/some_test_name/
+###Wildcard the files
+You can use wildcards in any of the watched filepaths:
 
-You can tell it to find a similarly named file to your test to watch
-with glob mode:
+    $ tdd lib/other_class.rb app/models/*class.rb -- test/unit/some_class_test.rb -n/some_test_name/
 
-    $ tdd glob -- test/unit/some_unit_test.rb
+###Respects gitignore
+By default tdd ignores any files ignored by git, either through the local .gitignore 
+file or the global ~/.gitignore_global . You can turn this off by passing --gitignore=false:
 
-This will look for `some_unit.rb` in your project and watch it for changes,
-along with the test file.
+    $ tdd --gitignore=false some_file.rb -- test/unit/some_unit.rb -n/some_test_name/
 
+###Weird Rails specific mode
 In a Rails project you can ask tdd to watch view and controller files
 related to a functional or controller test:
 
@@ -59,6 +75,13 @@ related to a functional or controller test:
 will watch all view files in app/views/users, the users_controller and the
 test file for changes.
 
+###Now with more Growl
+Supports Growl notifs. To enable, pass in --growl like so:
+
+    $ tdd controller --growl -- spec/controllers/users_controller_spec.rb
+
+In Growl's preferences you can enable/disable both 'passed' and 'failed' notifs.
+
 Isn't this what Guard does?
 ---------------------------
 Yeah, but its more flexible. I found myself wanting to use rspec's
@@ -67,9 +90,15 @@ I tdd'd a class. With Guard, I would have to change the Guardfile to
 use different command line options for rspec. Maybe there's a way to
 solve this now, but in general Guard is just too much overhead for me.
 
-This library heavily borrows from rego by Ara Howard. Its a really
+This library heavily borrows from [rego by Ara Howard](http://github.com/ahoward/rego). Its a really
 useful tool and I used it to watch project files and run tests when they
 changed. But bouncing between projects that use test/unit and
 rspec several times a day there was still overhead in typing out the
 list of files to watch and the full test command for rego to work.
+Thus, tdd was born. 
+
+Contributors
+----
+* [ubermajestix](http://ubermajestix.com)
+* [Dave Sims](https://github.com/davesims)
 

data/bin/tdd

@@ -1,6 +1,7 @@
 #! /usr/bin/env ruby
 
 require 'tdd'
+require 'ruby_gntp'
 
 # The majority of this file has been adapted from Ara Howard's rego gem.
 # You can find the source here: http://github.com/ahoward/rego.
@@ -49,6 +50,11 @@ command if any file being watched changes.
     /Users/ubermajestix/work/awesome_app/test/unit/some_class_test.rb
     ##########################################
 
+tdd also ignores, by default, any files ignored by git, either through the local .gitignore 
+file or the global ~/.gitignore_global. You can turn this off by passing --gitignore=false:
+
+    $ tdd --gitignore=false some_file.rb -- test/unit/some_unit.rb -n/some_test_name/
+
 You can specify additional files to watch (note the double dashes `--`
 separating the files to watch from the test file and options):
 
@@ -61,6 +67,16 @@ separating the files to watch from the test file and options):
     /Users/ubermajestix/work/awesome_app/test/unit/some_class_test.rb
     ##########################################
 
+You can use wildcards in any of the watched filepaths:
+
+    $ tdd lib/other_class.rb app/models/*class.rb -- test/unit/some_class_test.rb -n/some_test_name/
+    Running: ruby -I test test/unit/some_class_test.rb -n/some_test_name/
+    Watching:
+    /Users/ubermajestix/work/awesome_app/app/models/some_class.rb
+    /Users/ubermajestix/work/awesome_app/app/models/some_other_class.rb
+    /Users/ubermajestix/work/awesome_app/app/models/some_nifty_class.rb
+    /Users/ubermajestix/work/awesome_app/app/models/some_hoopy_class.rb
+    ##########################################
 
 In a Rails project you can ask tdd to watch view and controller files
 related to a functional or controller test:
@@ -76,37 +92,99 @@ related to a functional or controller test:
     /Users/ubermajestix/work/awesome_rails_app/spec/controllers/users_controller_spec.rb
     ##########################################
 
+Supports Growl notifs. To enable, pass in --growl like so:
 
+    $ tdd controller --growl -- spec/controllers/users_controller_spec.rb
+
+In Growl's preferences you can enable/disable both 'passed' and 'failed' notifs.
   __
 
+  option('growl'){
+    default false
+    cast :boolean
+    description "Send growl notifications for finished tests."
+  }
+
+  option('gitignore'){
+    argument :required
+    default true
+    cast :boolean
+    description "Don't watch files/dirs if they are ignored by git. Defaults to true."
+  }
+
   def run
     print_usage_and_exit if ARGV.empty?
+    parse_options
     parse_the_command_line
     print_a_summary_of_watched_files
+    register_growl if @use_growl
     loop_watching_files_and_running_commands
   end
 
+  def register_growl
+    @growl = GNTP.new("tdd")
+    @growl.register({
+      :notifications => [
+        { :name => "passed", :enabled => true, },
+        { :name => "failed", :enabled => true, }
+      ]
+    })
+  end
+
   def print_usage_and_exit
     puts usage['examples']
     exit 1
   end
 
+  def parse_options
+    @gitignore = params['gitignore'].value
+    @use_growl = params['growl'].value
+    ARGV.delete_if{|arg| arg =~ /--gitignore.*|--growl.*/}
+  end
+
   def parse_the_command_line
     @paths, @command = Tdd::CommandLineParser.parse
     @paths = %w[.] if @paths.empty?
+    expand_all_file_paths_in_array(@paths)
+    
+    if @gitignore
+      say("ignoring gitignore files...", :color => :yellow)
+      @paths = @paths - git_ignored
+    end
+  end
 
-    @paths.map!{|path| test(?d, path) ? [path, Dir.glob(File.join(path, '**/**'))] : path}
-    @paths.flatten!
-    @paths.compact!
-    @paths.uniq!
-    @paths.map! do |path|
+  def git_ignored
+    @all_git_ignored ||= %w(~/.gitignore_global .gitignore).reduce([]) do |all_ignored, file| 
+      if File.exists?(file = File.expand_path(file))
+        all_ignored += Pathname.new(file).read.split("\n").reject{|i| i =~ /^#.*|(^\s*$)/}
+      end
+      all_ignored
+    end
+    expand_all_file_paths_in_array(@all_git_ignored)
+  end
+
+  def expand_all_file_paths_in_array(paths)
+    paths.map! do |path| 
+      if test(?d, path) 
+        [path, Dir.glob(File.join(path, '**/**'))] 
+      elsif path =~ /\*/
+        Dir.glob(path)
+      else
+        path
+      end
+    end
+    paths.flatten!
+    paths.compact!
+    paths.uniq!
+    paths.map! do |path|
       begin
         Pathname.new(path).realpath.to_s
       rescue Object
         nil
       end
     end
-    @paths.compact!
+    paths.compact!
+    paths
   end
 
   def print_a_summary_of_watched_files
@@ -121,6 +199,17 @@ related to a functional or controller test:
     end
   end
 
+  def growl(name, title, text, sticky = false)
+    if @growl 
+      @growl.notify({
+        :name  => name,
+        :title => title,
+        :text  => text,
+        :sticky => sticky,
+      })
+    end
+  end
+
   def loop_watching_files_and_running_commands
     directories = []
     files = []
@@ -154,13 +243,17 @@ related to a functional or controller test:
       say("# starting test run #{ n } @ #{ Time.now.strftime('%H:%M:%S') } - #{ @command }", :color => :magenta)
       say("# #{files.size > 1 ? 'files' : 'file'} changed: #{files.join(', ')}", :color => :magenta) if files && files.any?
       puts
-      tests_pass = system(@command)
-      puts
+      tests_out = `#{@command}`  
+      tests_pass = $?.success?
+      puts tests_out 
+
       say("# finished test run #{ n } @ #{ Time.now.strftime('%H:%M:%S') } - #{ $?.exitstatus }", :color => :yellow)
       if tests_pass
         system("command -v blink1-tool > /dev/null && blink1-tool -d0 --rgb 0,255,0 --blink 3 > /dev/null &")
+        growl("passed", "tdd - Tests Passed", tests_out)
       else
         system("command -v blink1-tool > /dev/null && blink1-tool -d0 --rgb 255,0,0 --blink 3 > /dev/null &")
+        growl("failed", "tdd - Tests Failed", tests_out, true)
       end
       puts
       n.succ!

data/lib/tdd/version.rb

@@ -1,3 +1,3 @@
 module Tdd
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

data/tdd.gemspec

@@ -14,7 +14,9 @@ Gem::Specification.new do |gem|
   gem.name          = "tdd"
   gem.require_paths = ["lib"]
   gem.version       = Tdd::VERSION
+  
 
   gem.add_runtime_dependency "main", "~> 5.0"
   gem.add_runtime_dependency "rb-fsevent", "~> 0.9"
+  gem.add_runtime_dependency "ruby_gntp"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdd
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Tyler Montgomery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: main
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Fire up that tdd loop
 email:
 - tyler.a.montgomery@gmail.com