guard-brakeman 0.5.0 → 0.5.1

data/README.md

@@ -27,7 +27,7 @@ $ guard init brakeman
 
 ## Use sublime Text 2?
 
-Check out [sublime_guard](https://github.com/cyphactor/sublime_guard)!  It gives you control Guard without leaving the editor.  This is even more powerful with Growl notifications.  Enter distraction-free mode and never leave! 
+Check out [sublime_guard](https://github.com/cyphactor/sublime_guard)!  It gives you control Guard without leaving the editor.  This is even more powerful with Growl notifications.  Enter distraction-free mode and never leave!
 
 ## Usage
 
@@ -85,7 +85,6 @@ Pull requests are very welcome! Please try to follow these simple rules if appli
 
 * Please create a topic branch for every separate change you make.
 * Make sure your patches are well tested.
-* Update the [Yard](http://yardoc.org/) documentation.
 * Update the README.
 * Update the CHANGELOG for noteworthy changes.
 * Please **do not change** the version number.

data/lib/guard/brakeman.rb

@@ -12,8 +12,10 @@ module Guard
     def initialize(watchers = [], options = { })
       super
 
+      ::Brakeman.instance_variable_set(:@quiet, options[:quiet])
+
       if options[:skip_checks]
-        options[:skip_checks] = options[:skip_checks].map do |val| 
+        options[:skip_checks] = options[:skip_checks].map do |val|
           # mimic Brakeman::set_options behavior
           val[0,5] == "Check" ? val : "Check" << val
         end
@@ -24,10 +26,10 @@ module Guard
 
       # TODO mixing the use of this attr, good to match?  Bad to couple?
       @options = {
-          :notifications => true,
-          :run_on_start => false,
-          :chatty => false,
-          :min_confidence => 1
+        :notifications => true,
+        :run_on_start => false,
+        :chatty => false,
+        :min_confidence => 1
       }.update(options)
     end
 
@@ -38,11 +40,10 @@ module Guard
     def start
       @scanner_opts = ::Brakeman::set_options({:app_path => '.'}.merge(@options))
       @options.merge!(@scanner_opts)
-      
       @tracker = ::Brakeman::Scanner.new(@scanner_opts).process
 
       if @options[:run_on_start]
-        run_all 
+        run_all
       elsif @options[:chatty]
         ::Guard::Notifier.notify("Brakeman is ready to work!", :title => "Brakeman started", :image => :pending)
       end
@@ -53,7 +54,6 @@ module Guard
     # @raise [:task_has_failed] when stop has failed
     #
     def run_all
-      UI.info 'running all'
       @tracker.run_checks
       print_failed(@tracker.checks)
       throw :task_has_failed if @tracker.checks.all_warnings.any?
@@ -82,71 +82,76 @@ module Guard
 
       all_warnings = report.all_warnings
 
-      puts all_warnings.sort_by { |w| w.confidence }
-
       message = "#{all_warnings.count} brakeman findings"
 
       if @options[:output_files]
         write_report
-        message += "\nResults written to #{@options[:output_files]}" 
+        message += "\nResults written to #{@options[:output_files]}"
       end
 
       if @options[:chatty] && all_warnings.any?
-        ::Guard::Notifier.notify(message, :title => "Full Brakeman results", :image => icon) 
+        ::Guard::Notifier.notify(message, :title => "Full Brakeman results", :image => icon)
       end
+
+      info(message, 'yellow')
+      warning_info(all_warnings.sort_by { |w| w.confidence })
     end
 
     def print_changed report
       UI.info "\n------ brakeman warnings --------\n"
-      
-      message = ""
+
+      message = []
       should_alert = false
 
       fixed_warnings = report.fixed_warnings
       if fixed_warnings.any?
-        icon = :success
         results_notification = pluralize(fixed_warnings.length,  "fixed warning")
-        UI.info(UI.send(:color, results_notification, 'green')) # janky
-
-        should_alert = true 
-        message += results_notification
+        info(results_notification, 'green')
+        warning_info(fixed_warnings.sort_by { |w| w.confidence })
 
-        puts fixed_warnings.sort_by { |w| w.confidence }
-        puts ""
+        message << results_notification
+        should_alert = true
+        icon = :success
       end
 
       new_warnings = report.new_warnings
       if new_warnings.any?
         new_warning_message = pluralize(new_warnings.length,  "new warning")
-        UI.info(UI.send(:color, new_warning_message, 'red')) # janky
+        info(new_warning_message, 'red')
+        warning_info(new_warnings.sort_by { |w| w.confidence })
 
-        message += new_warning_message
+        message << new_warning_message
         should_alert = true
         icon = :failed
-
-        puts new_warnings.sort_by { |w| w.confidence }
-        puts ""
       end
 
       existing_warnings = report.existing_warnings
       if existing_warnings.any?
-        should_alert = true if @options[:chatty]
-        icon ||= :pending
-        
         existing_warning_message = pluralize(existing_warnings.length, "previous warning")
-        UI.warning existing_warning_message
-        message += existing_warning_message
+        info(existing_warning_message, 'yellow')
+        warning_info(existing_warnings.sort_by { |w| w.confidence })
 
-        puts existing_warnings.sort_by { |w| w.confidence }
+        message << existing_warning_message
+        should_alert = true if @options[:chatty]
+        icon ||= :pending
       end
 
       if @options[:output_files]
         write_report
-        message += "\nResults written to #{@options[:output_files]}" 
+        message << "\nResults written to #{@options[:output_files]}"
+      end
+
+      title = case icon
+      when :success
+        pluralize(fixed_warnings.length, "Warning") + " fixed."
+      when :pending
+        pluralize(existing_warnings.length, "Warning") + " left to fix."
+      when :failed
+        pluralize(new_warnings.length, "Warning") + " introduced."
       end
 
       if @options[:notifications] && should_alert
-        ::Guard::Notifier.notify(message.chomp, :title => "Brakeman results", :image => icon) 
+        ::Guard::Notifier.notify(message.join(", ").chomp, :title => title, :image => icon)
       end
     end
 
@@ -158,9 +163,41 @@ module Guard
       end
     end
 
-    # stolen from rails
+    # stolen from ActiveSupport
     def pluralize(count, singular, plural = nil)
       "#{count || 0} " + ((count == 1 || count =~ /^1(\.0+)?$/) ? singular : (plural || singular.pluralize))
     end
+
+    def info(message, color = :white)
+      UI.info(UI.send(:color, message, color))
+    end
+
+    def warning_info(warnings, color = :white)
+      warnings.each do |warning|
+        info(decorate_warning(warning))
+      end
+    end
+
+    def decorate_warning(warning)
+      color = case warning.confidence
+      when 0
+        :red
+      when 1
+        :yellow
+      when 2
+        :white
+      end
+
+      output =  UI.send(:color, ::Brakeman::Warning::TEXT_CONFIDENCE[warning.confidence], color)
+      output << " - #{warning.warning_type} - #{warning.message}"
+      output << " near line #{warning.line}" if warning.line
+      if warning.file
+        # fix this ish or wait for brakeman to be fixed
+        filename = warning.file.gsub(@options[:app_path], '')
+        output << " in #{filename}"
+      end
+      output << ": #{warning.format_code}" if warning.code
+      output
+    end
   end
 end

data/lib/guard/brakeman/templates/Guardfile

@@ -1,4 +1,4 @@
-guard 'brakeman' do
+guard 'brakeman', :run_on_start => true do
   watch(%r{^app/.+\.(erb|haml|rhtml|rb)$})
   watch(%r{^config/.+\.rb$})
   watch(%r{^lib/.+\.rb$})

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard-brakeman
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Neil Matatall
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-22 00:00:00 Z
+date: 2012-10-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: guard
@@ -40,14 +40,14 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 11
         segments: 
         - 1
-        - 5
-        - 3
-        version: 1.5.3
+        - 7
+        - 0
+        version: 1.7.0
   type: :runtime
   version_requirements: *id002
 description: Guard::Brakeman automatically scans your Rails app for vulnerabilities
@@ -70,7 +70,7 @@ post_install_message:
 rdoc_options: 
 - --charset=UTF-8
 - --main=README.md
-- --exclude='(lib|test|spec)|(Gem|Guard|Rake)file'
+- --exclude='(test|spec)|(Gem|Guard|Rake)file'
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement