Merge pull request #21 from andyw8/add-rubocop-config-and-corrections

Add RuboCop configuration and basic style corrections

Author: wfleming

.rubocop.yml

@@ -0,0 +1,19 @@
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'spec/**/*'
+Style/Documentation:
+  Enabled: false
+Style/FileName:
+  Exclude:
+    - 'bin/codeclimate-rubocop'
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'
+Style/StringLiterals:
+  Enabled: false
+Style/TrailingComma:
+  Enabled: false

Rakefile

@@ -2,7 +2,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.test_files = Dir.glob('spec/**/*_spec.rb')
-  t.libs = ["lib", "spec"]
+  t.libs = %w[lib spec]
 end
 
 task(default: :test)

bin/codeclimate-rubocop

@@ -1,9 +1,11 @@
 #!/usr/bin/env ruby
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../lib")))
+$LOAD_PATH.unshift(
+  File.expand_path(File.join(File.dirname(__FILE__), "../lib"))
+)
 
 require 'cc/engine/rubocop'
 
-if File.exists?("/config.json")
+if File.exist?("/config.json")
   engine_config = JSON.parse(File.read("/config.json"))
 else
   engine_config = {}

lib/cc/engine/file_list_resolver.rb

@@ -40,7 +40,7 @@ def include_based_files_to_inspect
 
       def local_path(path)
         realpath = Pathname.new(@code).realpath.to_s
-        path.gsub(%r|^#{realpath}/|, '')
+        path.gsub(%r{^#{realpath}/}, '')
       end
 
       def rubocop_file_to_include?(file)

lib/cc/engine/rubocop.rb

@@ -49,7 +49,7 @@ def inspect_file(path)
 
       def local_path(path)
         realpath = Pathname.new(@code).realpath.to_s
-        path.gsub(%r|^#{realpath}/|, '')
+        path.gsub(%r{^#{realpath}/}, '')
       end
 
       def rubocop_config_store
@@ -83,7 +83,7 @@ def violation_positions(location)
         end
 
         {
-          begin:  {
+          begin: {
             column: first_column + 1, # columns are 0-based in Parser
             line: first_line,
           },
@@ -112,7 +112,9 @@ def violation_json(violation, local_path)
       end
 
       def content_body(cop_name)
-        path = File.expand_path("../../../../config/contents/#{cop_name.underscore}.md", __FILE__)
+        path = File.expand_path(
+          "../../../../config/contents/#{cop_name.underscore}.md", __FILE__
+        )
         File.exist?(path) ? File.read(path) : nil
       end
     end

lib/rubocop/cop/method_complexity_patch.rb

@@ -8,7 +8,7 @@
   # original AST is no longer available. So it's easier to monkey-path
   # this method on complexity checkers to send the location of the entire
   # method to the created `Offense`.
-  def add_offense(node, loc, message = nil, severity = nil)
+  def add_offense(node, _loc, message = nil, severity = nil)
     super(node, node.loc, message, severity)
   end
 end

spec/cc/engine/rubocop_spec.rb

@@ -133,11 +133,17 @@ def method
       end
 
       it "handles different locations properly" do
-        RuboCop::Cop::Team.any_instance.expects(:inspect_file).returns([OpenStruct.new(
-          location: RuboCop::Cop::Lint::Syntax::PseudoSourceRange.new(1, 0, ""),
-          cop_name: "fake",
-          message: "message"
-        )])
+        RuboCop::Cop::Team.any_instance.expects(:inspect_file).returns(
+          [
+            OpenStruct.new(
+              location: RuboCop::Cop::Lint::Syntax::PseudoSourceRange.new(
+                1, 0, ""
+              ),
+              cop_name: "fake",
+              message: "message"
+            )
+          ]
+        )
         create_source_file("my_script.rb", <<-EORUBY)
           #!/usr/bin/env ruby
 
@@ -154,8 +160,8 @@ def method
         location = {
           "path" => "my_script.rb",
           "positions" => {
-            "begin" => { "column"=>1, "line"=>1 },
-            "end" => { "column"=>1, "line"=>1 }
+            "begin" => { "column" => 1, "line" => 1 },
+            "end" => { "column" => 1, "line" => 1 }
           }
         }
         assert_equal location, result["location"]
@@ -190,12 +196,14 @@ def method(a,b,c,d,e,f,g)
 
         json = JSON.parse('[' + output.split("\u0000").join(',') + ']')
 
-        result = json.select { |i| i && i["check_name"] =~ /Metrics\/CyclomaticComplexity/ }.first
+        result = json.find do |i|
+          i && i["check_name"] =~ %r{Metrics\/CyclomaticComplexity}
+        end
         location = {
           "path" => "my_script",
           "positions" => {
-            "begin" => { "column"=>11, "line"=>3 },
-            "end" => { "column"=>14, "line"=>21 }
+            "begin" => { "column" => 11, "line" => 3 },
+            "end" => { "column" => 14, "line" => 21 }
           }
         }
         assert_equal location, result["location"]
@@ -233,7 +241,7 @@ def method
           end
         EORUBY
         output = run_engine(
-          "include_paths" => %w(included_root_file.rb subdir/)
+          "include_paths" => %w[included_root_file.rb subdir/]
         )
         assert !includes_check?(output, "Lint/UselessAssignment")
         assert !includes_check?(output, "Style/AndOr")
@@ -245,7 +253,7 @@ def method
         output = run_engine(
           "include_paths" => %w[config.yml]
         )
-        refute (issues(output).detect do |i| 
+        refute(issues(output).detect do |i|
           i["description"] == "unexpected token tCOLON"
         end)
       end
@@ -258,12 +266,12 @@ def method
             return false
           end
         EORUBY
-        output = run_engine("include_paths" => %w(Rakefile))
+        output = run_engine("include_paths" => %w[Rakefile])
         assert includes_check?(output, "Lint/UselessAssignment")
       end
 
       def includes_check?(output, cop_name)
-        !!issues(output).detect { |i| i["check_name"] =~ /#{cop_name}$/ }
+        issues(output).any? { |i| i["check_name"] =~ /#{cop_name}$/ }
       end
 
       def includes_content_for?(output, cop_name)