guard-brakeman 0.1.8 → 0.2.0

data/README.md

@@ -46,8 +46,10 @@ Please read the [Guard documentation](http://github.com/guard/guard#readme) for
 ### List of available options
 
 ```ruby
-:notifications => false # display Growl notifications, defaults to true
-:run_on_start  => true  # run all checks on startup, defaults to false
+:notifications  => false # display Growl notifications, defaults to true
+:run_on_start   => true  # run all checks on startup, defaults to false
+:min_confidence => 3     # only alert on warnings above a threshold, defaults to 1
+:chatty         => true  # notify on ALL changes.  Defaults to false, only new or fixed warnings trigger a Growl
 ```
 
 ## Brakeman configuration

data/lib/guard/brakeman.rb

@@ -11,9 +11,23 @@ module Guard
   class Brakeman < Guard
     def initialize(watchers = [], options = { })
       super
+
+      if options[:skip_checks]
+        options[:skip_checks] = options[:skip_checks].map do |val| 
+          # mimic Brakeman::set_options behavior
+          val[0,5] == "Check" ? val : "Check" << val
+        end
+      end
+
+      # chatty implies notifications
+      options[:notifications] = true if options[:chatty]
+
+      # TODO mixing the use of this attr, good to match?  Bad to couple?
       @options = {
           :notifications => true,
-          :run_on_start => false
+          :run_on_start => false,
+          :chatty => false,
+          :min_confidence => 1
       }.update(options)
     end
 
@@ -22,11 +36,15 @@ module Guard
     # @raise [:task_has_failed] when stop has failed
     #
     def start
-      scanner_opts = ::Brakeman::set_options(:app_path => '.')
+      scanner_opts = ::Brakeman::set_options({:app_path => '.'}.merge(@options))
       @scanner = ::Brakeman::Scanner.new(scanner_opts)
       @tracker = @scanner.process
 
-      run_all if @options[:run_on_start]
+      if @options[:run_on_start]
+        run_all 
+      elsif @options[:chatty]
+        Notifier.notify("Brakeman is ready to work!", :title => "Brakeman started", :image => :pending)
+      end
     end
 
     # Gets called when all checks should be run.
@@ -48,7 +66,7 @@ module Guard
     def run_on_change(paths)
       return run_all unless @tracker.checks
 
-      UI.info "rescanning #{paths}, running all checks"
+      UI.info "\n\nrescanning #{paths}, running all checks"
       report = ::Brakeman::rescan(@tracker, paths)
       print_changed(report)
       throw :task_has_failed if report.any_warnings?
@@ -59,41 +77,68 @@ module Guard
     def print_failed report
       UI.info "\n------ brakeman warnings --------\n"
 
-      icon = report.all_warnings.count > 0 ? :success : :pending
+      icon = report.all_warnings.count > 0 ? :failed : :success
+
+      all_warnings = reject_below_threshold(report.all_warnings)
 
-      Notifier.notify("#{report.all_warnings.count} brakeman findings", :title => "Brakeman results", :image => icon) if @options[:notifications]
-      puts report.all_warnings.sort_by { |w| w.confidence }
+      puts all_warnings.sort_by { |w| w.confidence }
+
+      if @options[:chatty] && all_warnings.any?
+        Notifier.notify("#{all_warnings.count} brakeman findings", :title => "Full Brakeman results", :image => icon) 
+      end
     end
 
     def print_changed report
       UI.info "\n------ brakeman warnings --------\n"
       
       message = ""
+      should_alert = false
 
-      unless report.fixed_warnings.empty?
-        message += "#{report.fixed_warnings.length} fixed warning(s)\n"
+      fixed_warnings = reject_below_threshold(report.fixed_warnings)
+      if fixed_warnings.any?
         icon = :success
-        UI.info(UI.send(:color, message, 'green')) # janky
-        puts report.fixed_warnings.sort_by { |w| w.confidence }
+        results_notification = "#{fixed_warnings.length} fixed warning(s)\n"
+        UI.info(UI.send(:color, results_notification, 'green')) # janky
+
+        should_alert = true 
+        message += results_notification
+
+        puts fixed_warnings.sort_by { |w| w.confidence }
         puts
       end
 
-      unless report.new_warnings.empty?
-        message += "#{report.new_warnings.length} new warning(s)\n"
+      new_warnings = reject_below_threshold(report.new_warnings)
+      if new_warnings.any?
+        new_warning_message = "#{new_warnings.length} new warning(s)\n"
+        UI.error new_warning_message
+        message += new_warning_message
+
+        should_alert = true
         icon = :failed
-        UI.error message
-        puts report.new_warnings.sort_by { |w| w.confidence }
+
+        puts new_warnings.sort_by { |w| w.confidence }
         puts
       end
 
-      unless report.existing_warnings.empty?
+      existing_warnings = reject_below_threshold(report.existing_warnings)
+      if existing_warnings.any?
+        should_alert = true if @options[:chatty]
         icon ||= :pending
-        message += "#{report.existing_warnings.length} previous warning(s)\n"
-        UI.warning message
-        puts report.existing_warnings.sort_by { |w| w.confidence }
+        
+        existing_warning_message = "#{existing_warnings.length} previous warning(s)\n"
+        UI.warning existing_warning_message
+        message += existing_warning_message
+
+        puts existing_warnings.sort_by { |w| w.confidence }
+      end
+
+      if @options[:notifications] && should_alert
+        Notifier.notify(message.chomp, :title => "Brakeman results", :image => icon) 
       end
+    end
 
-      Notifier.notify(message.chomp, :title => "Brakeman results", :image => icon) if @options[:notifications]
+    def reject_below_threshold(warnings)
+      warnings.reject {|w| w.confidence > (3 - @options[:min_confidence].to_i)}
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard-brakeman
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 8
-  version: 0.1.8
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Neil Matatall
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-01 00:00:00 -08:00
+date: 2012-02-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,38 +50,6 @@ dependencies:
         version: 1.2.2
   type: :runtime
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: guard-rspec
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 0
-        - 3
-        - 1
-        version: 0.3.1
-  type: :development
-  version_requirements: *id004
 description: Guard::Brakeman automatically scans your Rails app for vulnerabilities
 email: 
 - neil@matatall.com
@@ -128,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: guard-brakeman
-rubygems_version: 1.6.2
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: Guard gem for Brakeman