put reported issue's mass in read up contents

One aspect of the duplication engine that is different from other
engines and that can be frustrating is that the main dial you can turn
to adjust the results, mass threshold, is a completely invisible value
once the issue has been reported to CC (either .com or CLI). As a user,
this makes the engine difficult to configure because even though the
README documents how to set the mass threshold, the fact that you can't
ever see what mass issues have makes the feedback loop between getting
results and deciding what your settings should be basically impossible.

This is an attempt to remediate this problem by describing generally
what mass is, and what its specific value for an issue is, within the
read up contents. This makes the value accessible without unduly
cluttering the description with that value.

Author: wfleming

config/contents/duplicated_code.md config/contents/duplicated_code.md.erbconfig/contents/duplicated_code.md renamed to config/contents/duplicated_code.md.erb

@@ -6,6 +6,11 @@ Duplicated code can lead to software that is hard to understand and difficult to
 
 When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
 
+## 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).
+
 ## Refactorings
 
 *   [Extract Method](http://sourcemaking.com/refactoring/extract-method)

lib/cc/engine/analyzers/violation.rb

@@ -1,3 +1,5 @@
+require "cc/engine/analyzers/sexp_lines"
+require "cc/engine/analyzers/violation_read_up"
 require "digest"
 
 module CC
@@ -80,14 +82,7 @@ def format_sexp(sexp)
         end
 
         def content_body
-          @_content_body ||= { "body": File.read(read_up_path) }
-        end
-
-        def read_up_path
-          relative_path = "../../../../config/contents/duplicated_code.md"
-          File.expand_path(
-            File.join(File.dirname(__FILE__), relative_path)
-          )
+          @_content_body ||= { "body": ViolationReadUp.new(issue).contents }
         end
 
         def fingerprint

lib/cc/engine/analyzers/violation_read_up.rb

@@ -0,0 +1,29 @@
+require "erb"
+
+module CC
+  module Engine
+    module Analyzers
+      class ViolationReadUp
+        def initialize(issue)
+          @issue = issue
+        end
+
+        def contents
+          ERB.new(File.read(template_path)).result(binding)
+        end
+
+        private
+
+        attr_reader :issue
+
+        TEMPLATE_REL_PATH = "../../../../config/contents/duplicated_code.md.erb"
+
+        def template_path
+          File.expand_path(
+            File.join(File.dirname(__FILE__), TEMPLATE_REL_PATH)
+          )
+        end
+      end
+    end
+  end
+end

lib/cc/engine/duplication.rb

@@ -6,7 +6,6 @@
 require 'cc/engine/analyzers/reporter'
 require 'cc/engine/analyzers/engine_config'
 require 'cc/engine/analyzers/sexp'
-require 'cc/engine/analyzers/sexp_lines'
 require 'flay'
 require 'json'
 

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

@@ -41,7 +41,7 @@
         {"path" => "foo.js", "lines" => { "begin" => 2, "end" => 2} },
         {"path" => "foo.js", "lines" => { "begin" => 3, "end" => 3} }
       ])
-      expect(json["content"]).to eq({ "body" => read_up })
+      expect(json["content"]["body"]).to match /This issue has a mass of `99`/
       expect(json["fingerprint"]).to eq("55ae5d0990647ef496e9e0d315f9727d")
     end
   end

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

@@ -53,7 +53,7 @@
       expect(json["other_locations"]).to eq([
         {"path" => "foo.php", "lines" => { "begin" => 10, "end" => 14} },
       ])
-      expect(json["content"]).to eq({ "body" => read_up })
+      expect(json["content"]["body"]).to match /This issue has a mass of `44`/
       expect(json["fingerprint"]).to eq("667da0e2bab866aa2fe9d014a65d57d9")
     end
   end

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

@@ -41,7 +41,7 @@
         {"path" => "foo.py", "lines" => { "begin" => 2, "end" => 2} },
         {"path" => "foo.py", "lines" => { "begin" => 3, "end" => 3} }
       ])
-      expect(json["content"]).to eq({ "body" => read_up })
+      expect(json["content"]["body"]).to match /This issue has a mass of `54`/
       expect(json["fingerprint"]).to eq("42b832387c997f54a2012efb2159aefc")
     end
   end

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

@@ -50,7 +50,7 @@
       expect(json["other_locations"]).to eq([
         {"path" => "foo.rb", "lines" => { "begin" => 9, "end" => 13} },
       ])
-      expect(json["content"]).to eq({ "body" => read_up })
+      expect(json["content"]["body"]).to match /This issue has a mass of `36`/
       expect(json["fingerprint"]).to eq("f21b75bbd135ec3ae6638364d5c73762")
     end
 

spec/spec_helper.rb

@@ -14,6 +14,4 @@
 
   config.order = :random
   config.disable_monkey_patching!
-
-  config.include ReadUpHelpers
 end