code_hunter 0.0.1 → 0.1.0

data/README.md

@@ -4,11 +4,45 @@ Hunt out weak spots in your rails application with 2 static metrics tools:
 * [Brakeman](https://github.com/presidentbeef/brakeman) - A static analysis security vulnerability scanner for Rails
 * [RailsBestPractices](https://github.com/railsbp/rails_best_practices) - A code metric tool for rails projects
 
+## Installation
+
+```
+$ gem install code_hunter
+```
+
 ## Usage
 ```
-$ ./bin/code_hunter --help
+$ code_hunter --help
 Usage: code_hunter [options]
-        --application-path=          (default: ./) rails application root path
+        --application-path=          (default:   ./) rails application root path
+        --format=                    (default: yaml) output format (yaml or json)
+
+$ code_hunter --application-path /path/to/rails/root
+...
+...
+---
+- :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
+
+$ 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}]
 ```
 
 ## Requirements

data/code_hunter.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "activesupport"
   gem.add_dependency "brakeman"
   gem.add_dependency "rails_best_practices"
+  gem.add_dependency "pendaxes", "0.2.1"
 
   gem.add_development_dependency "rspec", ">= 2.12.0"
   gem.add_development_dependency "simplecov"

data/lib/code_hunter.rb

@@ -4,6 +4,7 @@ require "code_hunter/version"
 require "code_hunter/option_parser"
 require "code_hunter/runner"
 require "code_hunter/renderer"
+require "code_hunter/pendaxes"
 require "code_hunter/brakeman"
 require "code_hunter/rails_best_practices"
 require "code_hunter/git_blamer"

data/lib/code_hunter/option_parser.rb

@@ -26,7 +26,7 @@ module CodeHunter
     end
 
     def options
-      @options ||= {}
+      @options ||= { :application_path => "./" }
     end
 
     private

data/lib/code_hunter/pendaxes.rb

@@ -0,0 +1,33 @@
+require "json"
+
+module CodeHunter
+  class Pendaxes
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def run
+      summarize(invoke)
+    end
+
+    private
+
+    def invoke
+      `pendaxes-oneshot #{options[:application_path]} --reporter json`
+    end
+
+    def summarize(json)
+      pendings = JSON.parse(json)["pendings"]
+      pendings.map do |pending|
+        {
+          :service => :pendaxes,
+          :path    => pending["example"]["file"],
+          :line    => pending["example"]["line"],
+          :message => pending["example"]["message"],
+        }
+      end
+    end
+  end
+end

data/lib/code_hunter/runner.rb

@@ -31,16 +31,16 @@ module CodeHunter
     private
 
     def services
-      [Brakeman, RailsBestPractices].map {|klass| klass.new(options) }
+      [
+        Pendaxes,
+        Brakeman,
+        RailsBestPractices,
+      ].map {|klass| klass.new(options) }
     end
 
     def run_with_application_path
-      Dir.chdir(application_path) { run_without_application_path }
+      Dir.chdir(options[:application_path]) { run_without_application_path }
     end
     alias_method_chain :run, :application_path
-
-    def application_path
-      options[:application_path] || "./"
-    end
   end
 end

data/lib/code_hunter/version.rb

@@ -1,3 +1,3 @@
 module CodeHunter
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/code_hunter/pendaxes_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+module CodeHunter
+  describe Pendaxes do
+    let(:instance) do
+      described_class.new(:application_path => "./")
+    end
+
+    before do
+      instance.stub(:` => result)
+    end
+
+    # Stub the result of pendaxes-oneshot command
+    let(:result) do
+      {
+        :pendings => [
+        :example  => {
+            :file    => "dir/filename.rb",
+            :line    => 1,
+            :message => "message",
+          },
+        ],
+      }.to_json
+    end
+
+    describe "#run" do
+      it "returns an Array of parsed pendings data" do
+        instance.run.should == [
+          {
+            :service => :pendaxes,
+            :path    => "dir/filename.rb",
+            :line    => 1,
+            :message => "message",
+          }
+        ]
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_hunter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
+date: 2013-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pendaxes
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,12 +144,14 @@ files:
 - lib/code_hunter/brakeman/summarizer.rb
 - lib/code_hunter/git_blamer.rb
 - lib/code_hunter/option_parser.rb
+- lib/code_hunter/pendaxes.rb
 - lib/code_hunter/rails_best_practices.rb
 - lib/code_hunter/rails_best_practices/invoker.rb
 - lib/code_hunter/rails_best_practices/summarizer.rb
 - lib/code_hunter/renderer.rb
 - lib/code_hunter/runner.rb
 - lib/code_hunter/version.rb
+- spec/code_hunter/pendaxes_spec.rb
 - spec/code_hunter/renderer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/r7kamura/code_hunter
@@ -161,5 +179,6 @@ signing_key:
 specification_version: 3
 summary: Code hunter
 test_files:
+- spec/code_hunter/pendaxes_spec.rb
 - spec/code_hunter/renderer_spec.rb
 - spec/spec_helper.rb