Report issue for each instance of duplicated code

Previously, we just chose the first location where a duplication
occurred, and report the others in `other_locations`.

Author: ABaldwinHunter

config/contents/duplicated_code.md.erb

@@ -9,7 +9,7 @@ When you violate DRY, bugs and maintenance problems are sure to follow. Duplicat
 ## Issue Mass
 
 Duplicated code has a calculated mass, which can be thought of as a measure of how much logic has been duplicated.
-This issue has a mass of `<%= issue.mass %>`: if you would like to change the minimum mass that will be reported as an issue, please see the details in [`codeclimate-duplication`'s documentation](https://github.com/codeclimate/codeclimate-duplication).
+This issue has a mass of `<%= mass %>`: if you would like to change the minimum mass that will be reported as an issue, please see the details in [`codeclimate-duplication`'s documentation](https://github.com/codeclimate/codeclimate-duplication).
 
 ## Refactorings
 

lib/cc/engine/analyzers/reporter.rb

@@ -38,9 +38,11 @@ def report
           flay.report(StringIO.new).each do |issue|
             violation = new_violation(issue)
 
-            unless reports.include?(violation.report_name)
-              reports.add(violation.report_name)
-              io.puts "#{violation.format.to_json}\0"
+            violation.occurrences.each do |occurrence|
+              unless reports.include?(occurrence.report_name)
+                reports.add(occurrence.report_name)
+                io.puts "#{occurrence.format.to_json}\0"
+              end
             end
           end
         end

lib/cc/engine/analyzers/violation.rb

@@ -8,10 +8,17 @@ module Analyzers
       class Violation
         attr_reader :issue
 
-        def initialize(language_strategy, issue, hashes)
+        def initialize(language_strategy, issue, hashes, target_index = 0)
           @language_strategy = language_strategy
           @issue = issue
           @hashes = hashes
+          @target_index = target_index
+        end
+
+        def occurrences
+          hashes.map.with_index do |_, i|
+            Violation.new(language_strategy, issue, hashes, i)
+          end
         end
 
         def format
@@ -32,28 +39,34 @@ def report_name
           "#{current_sexp.file}-#{current_sexp.line}"
         end
 
-        def mass
-          flay_score / occurrences # ABH Reverse engineer the actual mass.
+        def mass # ABH Reverse engineer the actual mass from flay score.
+          if issue.identical?
+            flay_score / (occurrences.length**2)
+          else
+            flay_score / occurrences.length
+          end
         end
 
         private
 
-        attr_reader :language_strategy, :hashes
+        attr_reader :language_strategy, :hashes, :target_index
 
         def flay_score
           issue.mass
         end
 
         def current_sexp
-          @location ||= sorted_hashes.first
+          @location ||= sorted_hashes[target_index]
         end
 
         def sorted_hashes
           @_sorted_hashes ||= hashes.sort_by(&:file)
         end
 
         def other_sexps
-          @other_locations ||= sorted_hashes.drop(1)
+          sorted = sorted_hashes
+          sorted.delete_at(target_index)
+          sorted
         end
 
         def check_name
@@ -90,7 +103,7 @@ def format_sexp(sexp)
         end
 
         def content_body
-          @_content_body ||= { "body": ViolationReadUp.new(issue).contents }
+          @_content_body ||= { "body": ViolationReadUp.new(mass).contents }
         end
 
         def fingerprint
@@ -99,19 +112,15 @@ def fingerprint
           digest << "-"
           digest << current_sexp.mass.to_s
           digest << "-"
-          digest << occurrences.to_s
+          digest << occurrences.length.to_s
           digest.to_s
         end
 
         def description
-          description = "#{check_name} found in #{occurrences - 1} other location"
-          description += "s" if occurrences > 2
+          description = "#{check_name} found in #{(occurrences.length - 1)} other location"
+          description += "s" if occurrences.length > 2
           description
         end
-
-        def occurrences
-          other_sexps.count + 1
-        end
       end
     end
   end

lib/cc/engine/analyzers/violation_read_up.rb

@@ -4,8 +4,8 @@ module CC
   module Engine
     module Analyzers
       class ViolationReadUp
-        def initialize(issue)
-          @issue = issue
+        def initialize(mass)
+          @mass = mass
         end
 
         def contents
@@ -14,7 +14,7 @@ def contents
 
         private
 
-        attr_reader :issue
+        attr_reader :mass
 
         TEMPLATE_REL_PATH = "../../../../config/contents/duplicated_code.md.erb"
 

spec/cc/engine/analyzers/javascript/main_spec.rb

@@ -16,7 +16,9 @@
           console.log("hello JS!");
       EOJS
 
-      result = run_engine(engine_conf).strip
+      issues = run_engine(engine_conf).strip.split("\0")
+      result = issues.first.strip
+
       json = JSON.parse(result)
 
       expect(json["type"]).to eq("issue")
@@ -27,13 +29,13 @@
         "path" => "foo.js",
         "lines" => { "begin" => 1, "end" => 1 },
       })
-      expect(json["remediation_points"]).to eq(297000)
+      expect(json["remediation_points"]).to eq(33000)
       expect(json["other_locations"]).to eq([
         {"path" => "foo.js", "lines" => { "begin" => 2, "end" => 2} },
         {"path" => "foo.js", "lines" => { "begin" => 3, "end" => 3} }
       ])
-      expect(json["content"]["body"]).to match /This issue has a mass of `99`/
-      expect(json["fingerprint"]).to eq("55ae5d0990647ef496e9e0d315f9727d")
+      expect(json["content"]["body"]).to match /This issue has a mass of `11`/
+      expect(json["fingerprint"]).to eq("d3e06d4d67aa65ea09a190bae018053e")
     end
 
     it "prints an issue for similar code" do
@@ -43,7 +45,9 @@
           console.log("helllllllllllllllllo JS!");
       EOJS
 
-      result = run_engine(engine_conf).strip
+      issues = run_engine(engine_conf).strip.split("\0")
+      result = issues.first.strip
+
       json = JSON.parse(result)
 
       expect(json["type"]).to eq("issue")
@@ -54,13 +58,13 @@
         "path" => "foo.js",
         "lines" => { "begin" => 1, "end" => 1 },
       })
-      expect(json["remediation_points"]).to eq(99000)
+      expect(json["remediation_points"]).to eq(33000)
       expect(json["other_locations"]).to eq([
         {"path" => "foo.js", "lines" => { "begin" => 2, "end" => 2} },
         {"path" => "foo.js", "lines" => { "begin" => 3, "end" => 3} }
       ])
-      expect(json["content"]["body"]).to match /This issue has a mass of `33`/
-      expect(json["fingerprint"]).to eq("55ae5d0990647ef496e9e0d315f9727d")
+      expect(json["content"]["body"]).to match /This issue has a mass of `11`/
+      expect(json["fingerprint"]).to eq("d3e06d4d67aa65ea09a190bae018053e")
     end
 
     it "skips unparsable files" do
@@ -91,8 +95,8 @@
           <a className='button button-primary full' href='#' onClick={this.onSubmit.bind(this)}>Login</a>
     EOJSX
 
-    result = run_engine(engine_conf).strip
-    issues = result.split("\0")
+    issues = run_engine(engine_conf).strip.split("\0")
+
     expect(issues.length).to eq 1
   end
 

spec/cc/engine/analyzers/php/main_spec.rb

@@ -29,7 +29,9 @@
           }
       EOPHP
 
-      result = run_engine(engine_conf).strip
+      issues = run_engine(engine_conf).strip.split("\0")
+      result = issues.first.strip
+
       json = JSON.parse(result)
 
       expect(json["type"]).to eq("issue")
@@ -40,17 +42,18 @@
         "path" => "foo.php",
         "lines" => { "begin" => 2, "end" => 6 },
       })
-      expect(json["remediation_points"]).to eq(176000)
+      expect(json["remediation_points"]).to eq(44_000)
       expect(json["other_locations"]).to eq([
         {"path" => "foo.php", "lines" => { "begin" => 10, "end" => 14} },
       ])
-      expect(json["content"]["body"]).to match /This issue has a mass of `44`/
-      expect(json["fingerprint"]).to eq("667da0e2bab866aa2fe9d014a65d57d9")
+      expect(json["content"]["body"]).to match /This issue has a mass of `11`/
+      expect(json["fingerprint"]).to eq("5ede2c52b49dc6542f62cfaa7efcebf1")
     end
 
     it "runs against complex files" do
       FileUtils.cp(fixture_path("symfony_configuration.php"), File.join(@code, "configuration.php"))
-      result = run_engine(engine_conf).strip
+      issues = run_engine(engine_conf).strip.split("\0")
+      result = issues.first.strip
 
       expect(result).to match "\"type\":\"issue\""
     end
@@ -91,11 +94,6 @@
     end
   end
 
-  def printed_issue
-    issue = {"type":"issue","check_name":"Identical code","description":"Similar code found in 1 other location","categories":["Duplication"],"location":{"path":"foo.php","lines":{"begin":2,"end":6}},"remediation_points":176000,"other_locations":[{"path":"foo.php","lines":{"begin":10,"end":14}}],"content":{"body": read_up}}
-    issue.to_json + "\0\n"
-  end
-
   def engine_conf
     CC::Engine::Analyzers::EngineConfig.new({
       'config' => {

spec/cc/engine/analyzers/python/main_spec.rb

@@ -16,7 +16,9 @@
 print("Hello", "python")
       EOJS
 
-      result = run_engine(engine_conf).strip
+      issues = run_engine(engine_conf).strip.split("\0")
+      result = issues.first.strip
+
       json = JSON.parse(result)
 
       expect(json["type"]).to eq("issue")
@@ -27,13 +29,13 @@
         "path" => "foo.py",
         "lines" => { "begin" => 1, "end" => 1 },
       })
-      expect(json["remediation_points"]).to eq(3_000_000)
+      expect(json["remediation_points"]).to eq(1_600_000)
       expect(json["other_locations"]).to eq([
         {"path" => "foo.py", "lines" => { "begin" => 2, "end" => 2} },
         {"path" => "foo.py", "lines" => { "begin" => 3, "end" => 3} }
       ])
-      expect(json["content"]["body"]).to match /This issue has a mass of `54`/
-      expect(json["fingerprint"]).to eq("42b832387c997f54a2012efb2159aefc")
+      expect(json["content"]["body"]).to match /This issue has a mass of `6`/
+      expect(json["fingerprint"]).to eq("cc22115aa7c7d115b799fcdf668195d6")
     end
 
     it "prints an issue for similar code" do
@@ -43,7 +45,9 @@
 print("Hello from the other side", "python")
       EOJS
 
-      result = run_engine(engine_conf).strip
+      issues = run_engine(engine_conf).strip.split("\0")
+      result = issues.first.strip
+
       json = JSON.parse(result)
 
       expect(json["type"]).to eq("issue")
@@ -54,13 +58,13 @@
         "path" => "foo.py",
         "lines" => { "begin" => 1, "end" => 1 },
       })
-      expect(json["remediation_points"]).to eq(1_920_000)
+      expect(json["remediation_points"]).to eq(1_600_000)
       expect(json["other_locations"]).to eq([
         {"path" => "foo.py", "lines" => { "begin" => 2, "end" => 2} },
         {"path" => "foo.py", "lines" => { "begin" => 3, "end" => 3} }
       ])
-      expect(json["content"]["body"]).to match /This issue has a mass of `18`/
-      expect(json["fingerprint"]).to eq("42b832387c997f54a2012efb2159aefc")
+      expect(json["content"]["body"]).to match /This issue has a mass of `6`/
+      expect(json["fingerprint"]).to eq("cc22115aa7c7d115b799fcdf668195d6")
     end