rake_check 0.1.8 → 0.1.9

data/config/rails_best_practices.yml

@@ -0,0 +1,37 @@
+AddModelVirtualAttributeCheck: { }
+AlwaysAddDbIndexCheck: { }
+DryBundlerInCapistranoCheck: { }
+HashSyntaxCheck: { only_symbol: false, only_string: false }
+IsolateSeedDataCheck: { }
+KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }
+LongLineCheck: { max_line_length: 100 }
+MoveCodeIntoControllerCheck: { }
+MoveCodeIntoHelperCheck: { array_count: 3 }
+MoveCodeIntoModelCheck: { use_count: 2 }
+MoveFinderToNamedScopeCheck: { }
+MoveModelLogicIntoModelCheck: { use_count: 4 }
+NeedlessDeepNestingCheck: { nested_count: 2 }
+NotUseDefaultRouteCheck: { }
+NotUseTimeAgoInWordsCheck: { }
+OveruseRouteCustomizationsCheck: { customize_count: 3 }
+ProtectMassAssignmentCheck: { }
+RemoveEmptyHelpersCheck: { }
+RemoveTabCheck: { }
+RemoveTrailingWhitespaceCheck: { }
+RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
+RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
+RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
+ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
+ReplaceInstanceVariableWithLocalVariableCheck: { }
+RestrictAutoGeneratedRoutesCheck: { }
+SimplifyRenderInControllersCheck: { }
+SimplifyRenderInViewsCheck: { }
+UseBeforeFilterCheck: { customize_count: 2 }
+UseModelAssociationCheck: { }
+UseMultipartAlternativeAsContentTypeOfEmailCheck: { }
+UseParenthesesInMethodDefCheck: { }
+UseObserverCheck: { }
+UseQueryAttributeCheck: { }
+UseSayWithTimeInMigrationsCheck: { }
+UseScopeAccessCheck: { }

data/lib/rake_check/brakeman_checker.rb

@@ -13,11 +13,11 @@ class BrakemanChecker
   # @author dmasur
   def result
     begin
-      @tracker = Brakeman.run `pwd`.strip
-    rescue
+      @tracker = Brakeman.run(File.dirname(__FILE__) + '/../../../')
+    rescue SystemExit
       "Brakeman not found"
     end
-    {:type => :brakeman, :check_output => output, :status => status}
+    { type: :brakeman, check_output: output, status: status }
   end
 
   private
@@ -26,7 +26,7 @@ class BrakemanChecker
     #
     # @return [String] colored Coverage
     # @author dmasur
-    def color_count count
+    def color_count(count)
       case count
       when 0 then count.to_s.green
       else count.to_s.red
@@ -42,7 +42,7 @@ class BrakemanChecker
       if @tracker.nil?
         return 'N/A'
       else
-        "#{color_count @tracker.checks.warnings.count} Warnings"./app/views/admin/pages/index.html.haml
+        "#{color_count @tracker.checks.warnings.count} Warnings"
       end
     end
 

data/lib/rake_check/cane_checker.rb

@@ -15,7 +15,7 @@ class CaneChecker
     rescue Errno::ENOENT
       "Cane not found"
     end
-    { :type => :cane, :check_output => @shell_output, :status => status }
+    { type: :cane, check_output: @shell_output, status: status }
   end
 
   private

data/lib/rake_check/cucumber_checker.rb

@@ -15,7 +15,7 @@ class CucumberChecker
     rescue Errno::ENOENT
       "Cucumber not found"
     end
-    {:type => :cucumber, :check_output => output, :status => status}
+    { type: :cucumber, check_output: output, status: status }
   end
 
   private
@@ -27,7 +27,8 @@ class CucumberChecker
     # @author dmasur
     def status
       if @shell_output.include? 'scenarios'
-        match_data = /\d+ scenarios \((\d+) failed, \d+ passed\)/.match(@shell_output)
+        regexp = /\d+ scenarios \((\d+) failed, \d+ passed\)/
+        match_data = regexp.match(@shell_output)
         if match_data
           failed_scenarios = match_data[1]
           "#{failed_scenarios} failed scenarios".red

data/lib/rake_check/rbp_checker.rb

@@ -15,7 +15,7 @@ class RbpChecker
     rescue Errno::ENOENT
       "Rails best practices not found"
     end
-    {:type => :rbp, :check_output => output, :status => status}
+    { type: :rbp, check_output: output, status: status }
   end
 
   private

data/lib/rake_check/reek_checker.rb

@@ -16,9 +16,10 @@ class ReekChecker
     rescue Errno::ENOENT
       "Reek not found"
     end
-    @shell_output = @shell_output.split("\n").
-      delete_if{|line| line.include?('already initialized constant') }.join("\n")
-    {:type => :reek, :check_output => output, :status => status}
+    @shell_output = @shell_output.split("\n").delete_if do |line|
+      line.include?('already initialized constant')
+    end.join("\n")
+    { type: :reek, check_output: output, status: status }
   end
 
   private

data/lib/rake_check/rspec_checker.rb

@@ -9,13 +9,13 @@ class RspecChecker
   #
   # @return [Hash] Checkresult
   # @author dmasur
-  def result directory="spec"
+  def result(directory="spec")
     @shell_output = begin
       `export COVERAGE=true; rspec #{directory}; export COVERAGE=`
     rescue Errno::ENOENT
       "RSpec not found"
     end
-    {:type => directory, :status => status + code_coverage, :check_output => output}
+    { type: directory, status: status + code_coverage, check_output: output }
   end
 
   private

data/lib/rake_check/tasks/check.rake

@@ -11,7 +11,7 @@ require 'rake_check/brakeman_checker'
 #
 # @param [String] string The string to print
 # @author dmasur
-def puts_unless_empty string
+def puts_unless_empty(string)
   puts string unless string.empty?
 end
 
@@ -20,7 +20,7 @@ end
 #
 # @param [Array / Hash] results Array of Results or Hashresult
 # @author dmasur
-def print_check_result results
+def print_check_result(results)
   print_outputs results
   print_summary results
 end
@@ -29,7 +29,7 @@ end
 # Print Outputs of each result
 #
 # @author dmasur
-def print_outputs results
+def print_outputs(results)
   results.each do |result|
     puts_unless_empty result[:check_output]
   end
@@ -39,11 +39,11 @@ end
 # Print Summary of all Outputs
 #
 # @author dmasur
-def print_summary results
+def print_summary(results)
   result = results.map do |result|
-    "#{result[:type]} #{result[:status]}"
+    "#{result[:type]}§#{result[:status]}"
   end
-  puts `echo "#{result.join("\n")}" | column -t`
+  puts `echo "#{result.join("\n")}" | column -t -s§`
 end
 
 desc "Check all Metric tools"

data/lib/rake_check/version.rb

@@ -3,5 +3,5 @@ module RakeCheck
   # The Version Constant
   #
   # @author dmasur
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/lib/rake_check/yard_checker.rb

@@ -15,7 +15,7 @@ class YardChecker
     rescue Errno::ENOENT
       "Yardoc not found"
     end
-    {:type => :yard, :check_output => output, :status => status}
+    { type: :yard, check_output: output, status: status }
   end
 
   private

data/spec/lib/rake_check/brakeman_checker_spec.rb

@@ -1,40 +1,25 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../../lib/rake_check/brakeman_checker')
 
 describe BrakemanChecker do
+  let(:tracker) { stub("Tracker", checks: stub("Checks", warnings: [])) }
   it "gives N/A on no Rails Apps" do
-    subject.stub('`' => '')
     subject.result.should == { type: :brakeman, check_output: '', status: 'N/A' }
   end
-  it "gives N/A on Error" do
-    subject.stub('`' => 'Error')
-    subject.result.should == { type: :brakeman, check_output: 'Error', status: 'Parse Error' }
-  end
   it "gives OK with no Errors" do
-    shell_output = File.read(File.expand_path(File.dirname(__FILE__) +
-                                              '/../../files/brakeman_ok.json'))
-    subject.stub('`' => shell_output)
+    Brakeman.should_receive(:run).and_return tracker
+    subject.stub(:`)
     subject.result.should == { type: :brakeman,
                                check_output: '',
-                               status: "\e[32m0\e[0m Warnings, \e[32m0\e[0m Errors" }
+                               status: "\e[32m0\e[0m Warnings" }
   end
   describe "Code Coverage" do
-    it "is red with errors" do
-      shell_output = File.read(File.expand_path(File.dirname(__FILE__) +
-                                                '/../../files/brakeman_error.json'))
-      subject.stub('`' => shell_output)
-      output = 'unterminated string meets end of file. near line 13:' +
-        ' "" While processing /path/to/app/controllers/admin/admins_controller.rb'
-      subject.result.should == { type: :brakeman,
-                                 check_output: output,
-                                 status: "\e[32m0\e[0m Warnings, \e[31m1\e[0m Errors" }
-    end
     it "is red with warnings" do
-      shell_output = File.read(File.expand_path(File.dirname(__FILE__) +
-                                                '/../../files/brakeman_warning.json'))
-      subject.stub('`' => shell_output)
+      tracker.checks.stub(warnings: [stub("Warning")])
+      tracker.stub(report: "Report")
+      Brakeman.should_receive(:run).and_return tracker
       subject.result.should == { type: :brakeman,
-                                 check_output: 'Possible SQL injection',
-                                 status: "\e[31m1\e[0m Warnings, \e[32m0\e[0m Errors" }
+                                 check_output: 'Report',
+                                 status: "\e[31m1\e[0m Warnings" }
     end
   end
 end

data/spec/lib/rake_check/cane_checker_spec.rb

@@ -2,18 +2,18 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../lib/rake_check/cane
 
 describe CaneChecker do
   it "gives N/A on Error" do
-    subject.stub('`' => 'Error')
+    subject.stub(:` => 'Error')
     subject.result.should == { type: :cane, check_output: 'Error', status: 'N/A' }
   end
   it "gives OK with no Errors" do
-    subject.stub('`' => '')
+    subject.stub(:` => '')
     subject.result.should == { type: :cane,
                                check_output: '',
                                status: "\e[32mOK\e[0m" }
   end
   it "adds Class and Line violations" do
     shell_output = "Lines violated style requirements (10):\nClasses are not documented (1):"
-    subject.stub('`' => shell_output)
+    subject.stub(:` => shell_output)
     subject.result.should == { type: :cane,
                                check_output: shell_output,
                                status: "\e[31m11\e[0m Style Violations" }
@@ -21,21 +21,21 @@ describe CaneChecker do
   it "dont count other infos" do
     shell_output = "Lines violated style requirements (1):
     app/models/foo.rb:14  Line is >100 characters (115)"
-    subject.stub('`' => shell_output)
+    subject.stub(:` => shell_output)
     subject.result.should == { type: :cane,
                                check_output: shell_output,
                                status: "\e[33m1\e[0m Style Violations" }
   end
   it "is yellow under 10 Violations" do
     shell_output = "Lines violated style requirements (10):"
-    subject.stub('`' => shell_output)
+    subject.stub(:` => shell_output)
     subject.result.should == { type: :cane,
                                check_output: shell_output,
                                status: "\e[31m10\e[0m Style Violations" }
   end
   it "is red under 10 Violations" do
     shell_output = "Lines violated style requirements (9):"
-    subject.stub('`' => shell_output)
+    subject.stub(:` => shell_output)
     subject.result.should == { type: :cane,
                                check_output: shell_output,
                                status: "\e[33m9\e[0m Style Violations" }

data/spec/lib/rake_check/cucumber_checker_spec.rb

@@ -2,17 +2,17 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../lib/rake_check/cucu
 
 describe CucumberChecker do
   it "gives N/A on Error" do
-    subject.stub('`' => 'Error')
+    subject.stub(:` => 'Error')
     subject.result.should == { type: :cucumber, check_output: '', status: 'N/A' }
   end
   it "gives OK with no Errors" do
-    subject.stub('`' => '8 scenarios (8 passed)')
+    subject.stub(:` => '8 scenarios (8 passed)')
     subject.result.should == { type: :cucumber,
                                check_output: '',
                                status: "\e[32mOK\e[0m" }
   end
   it "is red on Error" do
-    subject.stub('`' => "8 scenarios (1 failed, 7 passed)")
+    subject.stub(:` => "8 scenarios (1 failed, 7 passed)")
     subject.result.should == { type: :cucumber,
                                check_output: '8 scenarios (1 failed, 7 passed)',
                                status: "\e[31m1 failed scenarios\e[0m" }

data/spec/lib/rake_check/rbp_checker_spec.rb

@@ -2,15 +2,15 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../lib/rake_check/rbp_
 
 describe RbpChecker do
   it "gives N/A on Error" do
-    subject.stub('`' => 'Error')
+    subject.stub(:` => 'Error')
     subject.result.should == { type: :rbp, check_output: 'Error', status: 'N/A' }
   end
   it "gives OK with no Errors" do
-    subject.stub('`' => 'No warning found. Cool!')
+    subject.stub(:` => 'No warning found. Cool!')
     subject.result.should == { type: :rbp, check_output: '', status: "\e[32mOK\e[0m" }
   end
   it "gives warning message with Errors" do
-    subject.stub('`' => 'Found 1 warnings.')
+    subject.stub(:` => 'Found 1 warnings.')
     subject.result.should == { type: :rbp,
                                check_output: 'Found 1 warnings.',
                                status: "\e[31mFound 1 warnings\e[0m" }

data/spec/lib/rake_check/reek_checker_spec.rb

@@ -2,17 +2,17 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../lib/rake_check/reek
 describe ReekChecker do
   it "gives N/A on Error" do
     require 'ruby_parser'
-    subject.stub('`' => 'Error')
+    subject.stub(:` => 'Error')
     subject.result.should == { type: :reek, check_output: 'Error', status: "\e[31mN/A\e[0m" }
   end
   it "gives OK on no Error" do
-    subject.stub('`' => 'warning: already initialized constant ENC_UTF8')
+    subject.stub(:` => 'warning: already initialized constant ENC_UTF8')
     subject.result.should == { type: :reek, check_output: '', status: "\e[32mOK\e[0m" }
   end
   it "gives Error with on Codesmells" do
     shell_output = File.read(File.expand_path(File.dirname(__FILE__) +
                                               '/../../files/reek_output.yaml'))
-    subject.stub('`' => shell_output)
+    subject.stub(:` => shell_output)
     check_output = "DuplicateMethodCall: ReekChecker#status@19, 20, 21, 22, 23\n"
     check_output += "TooManyStatements: ReekChecker#status@17"
     subject.result.should == { type: :reek,

data/spec/lib/rake_check/rspec_checker_spec.rb

@@ -2,20 +2,20 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../lib/rake_check/rspe
 
 describe RspecChecker do
   it "gives N/A on Error" do
-    subject.stub('`' => 'Error')
+    subject.stub(:` => 'Error')
     subject.result.should == { type: "spec", check_output: 'Error', status: 'N/A' }
   end
   it "gives OK with no Errors" do
-    subject.stub('`' => '6 examples, 0 failures')
+    subject.stub(:` => '6 examples, 0 failures')
     subject.result.should == { type: "spec", check_output: '', status: "\e[32mOK\e[0m" }
   end
   it "gives warning message with Errors" do
-    subject.stub('`' => '6 examples, 3 failures')
+    subject.stub(:` => '6 examples, 3 failures')
     subject.result.should == { type: "spec", check_output: '6 examples, 3 failures',
                                     status: "\e[31m3 failures\e[0m" }
   end
   it "gives warning message with one Error" do
-    subject.stub('`' => '6 examples, 1 failure')
+    subject.stub(:` => '6 examples, 1 failure')
     subject.result.should == { type: "spec", check_output: '6 examples, 1 failure',
                                     status: "\e[31m1 failure\e[0m" }
   end
@@ -23,21 +23,21 @@ describe RspecChecker do
     it "is green over 90%" do
       check_output = "6 examples, 0 failures
 Coverage report generated for RSpec to /foo/bar/coverage. 38 / 38 LOC (93.90%) covered."
-      subject.stub('`' => check_output)
+      subject.stub(:` => check_output)
       subject.result.should == { type: "spec", check_output: '',
                                       status: "\e[32mOK\e[0m with \e[32m93.9%\e[0m Code Coverage" }
     end
     it "is green over 70%" do
       check_output = "6 examples, 0 failures
 Coverage report generated for RSpec to /foo/bar/coverage. 38 / 38 LOC (73.90%) covered."
-      subject.stub('`' => check_output)
+      subject.stub(:` => check_output)
       subject.result.should == { type: "spec", check_output: '',
                                       status: "\e[32mOK\e[0m with \e[33m73.9%\e[0m Code Coverage" }
     end
     it "is green over 10%" do
       check_output = "6 examples, 0 failures
 Coverage report generated for RSpec to /foo/bar/coverage. 38 / 38 LOC (13.90%) covered."
-      subject.stub('`' => check_output)
+      subject.stub(:` => check_output)
       subject.result.should == { type: "spec", check_output: '',
                                       status: "\e[32mOK\e[0m with \e[31m13.9%\e[0m Code Coverage" }
     end

data/spec/lib/rake_check/yard_checker_spec.rb

@@ -2,30 +2,30 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../lib/rake_check/yard
 
 describe YardChecker do
   it "gives N/A on Error" do
-    subject.stub('`' => 'Error')
+    subject.stub(:` => 'Error')
     subject.result.should == { type: :yard, check_output: 'Error', status: 'N/A' }
   end
   it "gives OK with no Errors" do
-    subject.stub('`' => '100.00% documented')
+    subject.stub(:` => '100.00% documented')
     subject.result.should == { type: :yard,
                                check_output: '',
                                status: "\e[32m100.0%\e[0m documented" }
   end
   describe "Code Coverage" do
     it "is green over 90%" do
-      subject.stub('`' => "93.00% documented")
+      subject.stub(:` => "93.00% documented")
       subject.result.should == { type: :yard,
                                  check_output: '',
                                  status: "\e[32m93.0%\e[0m documented" }
     end
     it "is green over 70%" do
-      subject.stub('`' => "73.00% documented")
+      subject.stub(:` => "73.00% documented")
       subject.result.should == { type: :yard,
                                  check_output: '',
                                  status: "\e[33m73.0%\e[0m documented" }
     end
     it "is green over 10%" do
-      subject.stub('`' => "13.00% documented")
+      subject.stub(:` => "13.00% documented")
       subject.result.should == { type: :yard,
                                  check_output: '',
                                  status: "\e[31m13.0%\e[0m documented" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake_check
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70366337294260 !ruby/object:Gem::Requirement
+  requirement: &70358149806960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70366337294260
+  version_requirements: *70358149806960
 - !ruby/object:Gem::Dependency
   name: colored
-  requirement: &70366337338960 !ruby/object:Gem::Requirement
+  requirement: &70358149804880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70366337338960
+  version_requirements: *70358149804880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70366337337680 !ruby/object:Gem::Requirement
+  requirement: &70358149802660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70366337337680
+  version_requirements: *70358149802660
 - !ruby/object:Gem::Dependency
   name: reek
-  requirement: &70366337336820 !ruby/object:Gem::Requirement
+  requirement: &70358149801500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70366337336820
+  version_requirements: *70358149801500
 - !ruby/object:Gem::Dependency
   name: cane
-  requirement: &70366337336080 !ruby/object:Gem::Requirement
+  requirement: &70358149593540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70366337336080
+  version_requirements: *70358149593540
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70366337335360 !ruby/object:Gem::Requirement
+  requirement: &70358149591800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70366337335360
+  version_requirements: *70358149591800
 - !ruby/object:Gem::Dependency
   name: brakeman
-  requirement: &70366337334660 !ruby/object:Gem::Requirement
+  requirement: &70358149588860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70366337334660
+  version_requirements: *70358149588860
 description: Checking the Project for Code Smells and bad documentation
 email:
 - dominik.masur@googlemail.com
@@ -104,6 +104,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- config/rails_best_practices.yml
 - lib/rake_check.rb
 - lib/rake_check/brakeman_checker.rb
 - lib/rake_check/cane_checker.rb
@@ -142,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2623682170575336086
+      hash: 1454485576063868119
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -151,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2623682170575336086
+      hash: 1454485576063868119
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10