code_hunter 0.1.3 → 0.1.4

data/README.md

@@ -49,5 +49,16 @@ $ code_hunter --application-path /path/to/rails/root --format json
 [{"service":"brakeman","line":8,"path":"config/routes.rb","message":"All public methods in controllers are available as actions in routes.rb near line 8","sha1":"81887a2fb6efaa9dae59425ce7537c7905516ed0","author":"Ryo Nakamura","email":"r7kamura@gmail.com","modified_at":1357783853},{"service":"rails_best_practices","line":9,"path":"config/routes.rb","message":"restrict auto-generated routes examples (only: [])","sha1":"81887a2fb6efaa9dae59425ce7537c7905516ed0","author":"Ryo Nakamura","email":"r7kamura@gmail.com","modified_at":1357783853}]
 ```
 
+### Ignore
+If you want to ignore some warnings, write `# ignore` annotation as code comment.  
+If the detected line hits `/#\s*ignore/i`, it is ignored.
+
+```ruby
+danger_but_necessary_code # ignore
+danger_but_necessary_code # IGNORE
+danger_but_necessary_code # Ignore for some reason
+```
+
+
 ## Requirements
 * Ruby >= 1.9

data/lib/code_hunter.rb

@@ -8,3 +8,4 @@ require "code_hunter/pendaxes"
 require "code_hunter/brakeman"
 require "code_hunter/rails_best_practices"
 require "code_hunter/git_blamer"
+require "code_hunter/warning"

data/lib/code_hunter/runner.rb

@@ -12,20 +12,15 @@ module CodeHunter
 
     def run
       warnings = collect_warnings
-      warnings = merge_git_metadata(warnings)
-      output   = Renderer.render(warnings, :format => options[:format])
-      puts output
+      warnings = warnings.select(&:has_git_metadata?)
+      warnings = warnings.reject(&:ignore?)
+      puts Renderer.render(warnings.map(&:to_hash), :format => options[:format])
     end
 
     def collect_warnings
-      services.map(&:run).compact.inject([], :+)
-    end
-
-    def merge_git_metadata(warnings)
-      warnings.map do |warning|
-        metadata = GitBlamer.new(warning).blame or next
-        warning.merge(metadata)
-      end.compact
+      services.map(&:run).compact.inject([], :+).map do |attributes|
+        Warning.new(attributes)
+      end
     end
 
     private

data/lib/code_hunter/version.rb

@@ -1,3 +1,3 @@
 module CodeHunter
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/code_hunter/warning.rb

@@ -0,0 +1,87 @@
+module CodeHunter
+  class Warning
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def to_hash
+      {
+        :line        => line,
+        :message     => message,
+        :path        => path,
+        :service     => service,
+        :url         => url,
+        :sha1        => sha1,
+        :author      => author,
+        :email       => email,
+        :modified_at => modified_at,
+      }
+    end
+
+    def line
+      @attributes[:line]
+    end
+
+    def message
+      @attributes[:message]
+    end
+
+    def path
+      @attributes[:path]
+    end
+
+    def service
+      @attributes[:service]
+    end
+
+    def url
+      @attributes[:url]
+    end
+
+    def sha1
+      @git_metadata[:sha1]
+    end
+
+    def author
+      @git_metadata[:author]
+    end
+
+    def email
+      @git_metadata[:email]
+    end
+
+    def modified_at
+      @git_metadata[:modified_at]
+    end
+
+    # Fetch @git_metadata only once.
+    def git_metadata
+      case @git_metadata
+      when nil
+        @git_metadata = GitBlamer.new(@attributes).blame || false
+      when false
+        nil
+      else
+        @git_metadata
+      end
+    end
+
+    def has_git_metadata?
+      !!git_metadata
+    end
+
+    def ignore?
+      path && line && has_ignore_annotation?
+    end
+
+    private
+
+    def has_ignore_annotation?
+      line_content =~ /#\s*ignore/i
+    end
+
+    def line_content
+      File.readlines(path)[line - 1]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_hunter
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-15 00:00:00.000000000 Z
+date: 2013-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -151,6 +151,7 @@ files:
 - lib/code_hunter/renderer.rb
 - lib/code_hunter/runner.rb
 - lib/code_hunter/version.rb
+- lib/code_hunter/warning.rb
 - spec/code_hunter/pendaxes_spec.rb
 - spec/code_hunter/renderer_spec.rb
 - spec/code_hunter/runner_spec.rb