Merge pull request #18 from codeclimate/handle-includes-or-excludes

Support both include_paths and exclude_paths in config.json.

Author: fhwang

lib/cc/engine/rubocop.rb

@@ -17,31 +17,45 @@ def initialize(code, engine_config, io)
 
       def run
         Dir.chdir(@code) do
-          runner = RuboCop::Runner.new({}, rubocop_config_store)
-          paths = runner.send :find_target_files, []
-          paths.each do |path|
-            realpath = Pathname.new(@code).realpath.to_s
-            local_path = path.gsub(%r|^#{realpath}/|, '')
-            unless exclude?(local_path)
-              parsed = RuboCop::ProcessedSource.from_file(path)
-              rubocop_team_for_path(path).inspect_file(parsed).each do |violation|
-                json = violation_json(violation, local_path)
-                @io.print "#{json}\0"
-              end
-            end
+          files_to_inspect.each do |path|
+            inspect_file(path)
           end
         end
       end
 
       private
 
+      def files_to_inspect
+        runner = RuboCop::Runner.new({}, rubocop_config_store)
+        if @engine_config["include_paths"]
+          runner.send(:find_target_files, @engine_config["include_paths"])
+        else
+          runner.send(:find_target_files, []).reject do |path|
+            exclude_due_to_config?(path)
+          end
+        end
+      end
+
       def category(cop_name)
         CategoryParser.new(cop_name).category
       end
 
-      def exclude?(local_path)
+      def exclude_due_to_config?(path)
         exclusions = @engine_config["exclude_paths"] || []
-        exclusions.include?(local_path)
+        exclusions.include?(local_path(path))
+      end
+
+      def inspect_file(path)
+        parsed = RuboCop::ProcessedSource.from_file(path)
+        rubocop_team_for_path(path).inspect_file(parsed).each do |violation|
+          json = violation_json(violation, local_path(path))
+          @io.print "#{json}\0"
+        end
+      end
+
+      def local_path(path)
+        realpath = Pathname.new(@code).realpath.to_s
+        path.gsub(%r|^#{realpath}/|, '')
       end
 
       def rubocop_config_store

spec/cc/engine/rubocop_spec.rb

@@ -210,6 +210,35 @@ def method(a,b,c,d,e,f,g)
         assert includes_content_for?(output, "Metrics/ClassLength")
       end
 
+      it "uses only include_paths when they're passed in via the config hash" do
+        okay_contents = <<-EORUBY
+          #!/usr/bin/env ruby
+
+          puts "Hello world"
+        EORUBY
+        create_source_file("included_root_file.rb", okay_contents)
+        create_source_file("subdir/subdir_file.rb", okay_contents)
+        create_source_file("ignored_root_file.rb", <<-EORUBY)
+          def method
+            unused = "x" and "y"
+
+            return false
+          end
+        EORUBY
+        create_source_file("ignored_subdir/subdir_file.rb", <<-EORUBY)
+          def method
+            unused = "x"
+
+            return false
+          end
+        EORUBY
+        output = run_engine(
+          "include_paths" => %w(included_root_file.rb subdir/)
+        )
+        assert !includes_check?(output, "Lint/UselessAssignment")
+        assert !includes_check?(output, "Style/AndOr")
+      end
+
       def includes_check?(output, cop_name)
         !!issues(output).detect { |i| i["check_name"] =~ /#{cop_name}$/ }
       end
@@ -221,11 +250,13 @@ def includes_content_for?(output, cop_name)
       end
 
       def issues(output)
-        issues = output.split("\0").map { |x| JSON.parse(x) }
+        output.split("\0").map { |x| JSON.parse(x) }
       end
 
       def create_source_file(path, content)
-        File.write(File.join(@code, path), content)
+        abs_path = File.join(@code, path)
+        FileUtils.mkdir_p(File.dirname(abs_path))
+        File.write(abs_path, content)
       end
 
       def run_engine(config = nil)