feat: you can now choose a threshold for changed files. Past the threshhold, we analyze all files rather than each file one by one. You can also pass in the --all parameter to get this behaviour, regardless of threshold.

Author: isabel-anastasiadis-boost

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    codeclimate_diff (0.1.5)
+    codeclimate_diff (0.1.6)
       colorize
       json
       optparse

README.md

@@ -87,6 +87,7 @@ NOTE: similar code will only work correctly if you run a diff on all the files i
 4. Add a `.codecimate_diff.yml` configuration file
       ```
       main_branch_name: master # defaults to main
+      threshold_to_run_on_all_files: 8  # when you reach a certain number of files changed, it becomes faster to analyze all files rather than analyze them one by one.
       ```
 
 5. Install the gem
@@ -123,18 +124,23 @@ NOTE: similar code will only work correctly if you run a diff on all the files i
 3. Check if you've added any issues (about 10 secs per code file changed on your branch):
 
     ```bash
-    # runs on all code files changed in your branch
+    # runs on each file changed in your branch (about 10 secs per code file changed on your branch)
     ./bin/codeclimate_diff
 
     OR
 
-    # filters the changed files in your branch futher
+    # filters the changed files in your branch futher by a grep pattern
     ./bin/codeclimate_diff --pattern places
 
     OR
 
     # only shows the new and fixed issues
     ./bin/codeclimate_diff --new-only
+
+    OR
+
+    # always analyzes all files rather than the changed files one by one, even if below the 'threshold_to_run_on_all_files' setting.
+    ./bin/codeclimate_diff --all
     ```
 
 4. Now you have time to fix the issues, horray!

exe/codeclimate_diff

@@ -16,14 +16,17 @@ OptionParser.new do |opts|
   opts.on("-n", "--new-only",
           "It will only show what you have changed and not existing issues in files you have touched.")
 
+  opts.on("-a", "--all",
+          "It will always analyze all files, and not the changed files one by one, even if below the 'threshold_to_run_on_all_files' setting.")
+
   opts.on("-pPATTERN", "--pattern=PATTERN",
           "Grep pattern to filter files.  If provided, will filter the files changed on your branch further.")
 end.parse!(into: options)
 
 if options[:baseline]
   CodeclimateDiff::Runner.generate_baseline
 elsif options[:"new-only"]
-  CodeclimateDiff::Runner.run_diff_on_branch(options[:pattern], show_preexisting: false)
+  CodeclimateDiff::Runner.run_diff_on_branch(options[:pattern], always_analyze_all_files: options[:all], show_preexisting: false)
 else
-  CodeclimateDiff::Runner.run_diff_on_branch(options[:pattern], show_preexisting: true)
+  CodeclimateDiff::Runner.run_diff_on_branch(options[:pattern], always_analyze_all_files: options[:all], show_preexisting: true)
 end

lib/codeclimate_diff/runner.rb

@@ -16,19 +16,35 @@ def self.calculate_changed_filenames(pattern)
       files_changed_str.split("\n")
     end
 
-    def self.calculate_issues_in_changed_files(changed_filenames)
+    def self.calculate_issues_in_changed_files(changed_filenames, always_analyze_all_files)
       changed_file_issues = []
 
-      changed_filenames.each do |filename|
-        next if filename == "codeclimate_diff.rb" # TODO: fix this file's code quality issues when we make a Gem!
+      threshold_to_run_on_all_files = CodeclimateDiff.configuration["threshold_to_run_on_all_files"] || 8
+      analyze_all_files = always_analyze_all_files || changed_filenames.count > threshold_to_run_on_all_files
+      if analyze_all_files
+        message = always_analyze_all_files ? "Analyzing all files..." : "The number of changed files is greater than the threshold '#{threshold_to_run_on_all_files}', so analyzing all files..."
+        puts message
 
-        puts "Analysing '#{filename}'..."
-        result = CodeclimateWrapper.new.run_codeclimate(filename)
+        result = CodeclimateWrapper.new.run_codeclimate
         JSON.parse(result).each do |issue|
           next if issue["type"] != "issue"
+          next unless changed_filenames.include? issue["location"]["path"]
 
           changed_file_issues.append(issue)
         end
+
+      else
+        changed_filenames.each do |filename|
+          next if filename == "codeclimate_diff.rb" # TODO: fix this file's code quality issues when we make a Gem!
+
+          puts "Analysing '#{filename}'..."
+          result = CodeclimateWrapper.new.run_codeclimate(filename)
+          JSON.parse(result).each do |issue|
+            next if issue["type"] != "issue"
+
+            changed_file_issues.append(issue)
+          end
+        end
       end
 
       changed_file_issues
@@ -52,12 +68,12 @@ def self.generate_baseline
       puts "Done!"
     end
 
-    def self.run_diff_on_branch(pattern, show_preexisting: true)
+    def self.run_diff_on_branch(pattern, always_analyze_all_files: false, show_preexisting: true)
       CodeclimateWrapper.new.pull_latest_image
 
       changed_filenames = calculate_changed_filenames(pattern)
 
-      changed_file_issues = calculate_issues_in_changed_files(changed_filenames)
+      changed_file_issues = calculate_issues_in_changed_files(changed_filenames, always_analyze_all_files)
 
       preexisting_issues = calculate_preexisting_issues_in_changed_files(changed_filenames)
 

lib/codeclimate_diff/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CodeclimateDiff
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end