fix: tests

Learned we can't get offenses directly off of the cop, it has to be
obtained from the commissioner.investigate method.

[rubocop sourcecode about not being able to access offenses off the cop base](https://github.com/rubocop/rubocop/blob/9c6e0ef9039f3602cc0b6e267b7be71ed1110d5b/lib/rubocop/cop/base.rb#L314-L318)

Learned we have to provide our cop as the forces argument to the
commissioner.investigate if we have our own investigate like we do for
the overfetch cop. If we don't it never runs. This is not the case with
the heredoc cop because it does not have an investigate method.

[rubocop commissioner source code where our custom cop invetigate method is actually called](https://github.com/rubocop/rubocop/blob/9c6e0ef9039f3602cc0b6e267b7be71ed1110d5b/lib/rubocop/cop/commissioner.rb#L85)
that calls [this function](https://github.com/rubocop/rubocop/blob/9c6e0ef9039f3602cc0b6e267b7be71ed1110d5b/lib/rubocop/cop/commissioner.rb#L163) and you'll notice the second argument is called cops

Signed-off-by: jmeridth <[email protected]>
Co-authored-by: Hannah Yiu <[email protected]>

Author: jmeridth

lib/rubocop/cop/graphql/overfetch.rb

@@ -42,7 +42,7 @@ def investigate(processed_source)
 
           visitor.fields.each do |field, count|
             next if count > 0
-            add_offense(nil, message: "GraphQL field '#{field}' query but was not used in template.")
+            add_offense(visitor.ranges[field], message: "GraphQL field '#{field}' query but was not used in template.")
           end
         end
 

test/test_client_fetch.rb

@@ -79,10 +79,10 @@ def self.resolve_type(_type, _obj, _ctx)
     refute response.data
 
     refute_empty response.errors
-    assert_equal "Field 'err' doesn't exist on type 'Query'", response.errors[:data][0]
+    assert_includes response.errors[:data][0], "Field 'err' doesn't exist on type 'Query'"
 
     refute_empty response.errors.all
-    assert_equal "Field 'err' doesn't exist on type 'Query'", response.errors[:data][0]
+    assert_includes response.errors[:data][0], "Field 'err' doesn't exist on type 'Query'"
   end
 
   def test_failed_response

test/test_rubocop_heredoc.rb

@@ -9,126 +9,126 @@ def setup
   end
 
   def test_good_graphql_heredoc
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       Query = Client.parse <<'GRAPHQL'
         { version }
 GRAPHQL
     RUBY
 
-    assert_empty @cop.offenses.map(&:message)
+    assert_empty result.offenses.map(&:message)
   end
 
   def test_good_graphql_dash_heredoc
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       Query = Client.parse <<-'GRAPHQL'
         { version }
       GRAPHQL
     RUBY
 
-    assert_empty @cop.offenses.map(&:message)
+    assert_empty result.offenses.map(&:message)
   end
 
   def test_good_graphql_squiggly_heredoc
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       Query = Client.parse <<~'GRAPHQL'
         { version }
       GRAPHQL
     RUBY
 
-    assert_empty @cop.offenses.map(&:message)
+    assert_empty result.offenses.map(&:message)
   end
 
   def test_bad_graphql_heredoc
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       Query = Client.parse <<GRAPHQL
         { version }
 GRAPHQL
     RUBY
 
-    assert_equal 1, @cop.offenses.count
-    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", @cop.offenses.first.message
+    assert_equal 1, result.offenses.count
+    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", result.offenses.first.message
   end
 
   def test_bad_graphql_dash_heredoc
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       Query = Client.parse <<-GRAPHQL
         { version }
       GRAPHQL
     RUBY
 
-    assert_equal 1, @cop.offenses.count
-    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", @cop.offenses.first.message
+    assert_equal 1, result.offenses.count
+    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", result.offenses.first.message
   end
 
   def test_bad_graphql_squiggly_heredoc
     skip if RUBY_VERSION < "2.3"
 
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       Query = Client.parse <<~GRAPHQL
         { version }
       GRAPHQL
     RUBY
 
-    assert_equal 1, @cop.offenses.count
-    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", @cop.offenses.first.message
+    assert_equal 1, result.offenses.count
+    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", result.offenses.first.message
   end
 
   def test_bad_graphql_heredoc_with_interpolation
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       field = "version"
       Query = Client.parse <<-GRAPHQL
         { \#{field} }
       GRAPHQL
     RUBY
 
-    assert_equal 2, @cop.offenses.count
-    assert_equal "GraphQL/Heredoc: Do not interpolate variables into GraphQL queries, used variables instead.", @cop.offenses[0].message
-    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", @cop.offenses[1].message
+    assert_equal 2, result.offenses.count
+    assert_equal "GraphQL/Heredoc: Do not interpolate variables into GraphQL queries, used variables instead.", result.offenses[0].message
+    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", result.offenses[1].message
   end
 
   def test_bad_graphql_multiline_heredoc
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       Query = Client.parse <<GRAPHQL
         {
           version
         }
 GRAPHQL
     RUBY
 
-    assert_equal 1, @cop.offenses.count
-    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", @cop.offenses[0].message
+    assert_equal 1, result.offenses.count
+    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", result.offenses[0].message
   end
 
   def test_bad_graphql_multiline_dash_heredoc
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       Query = Client.parse <<-GRAPHQL
         {
           version
         }
       GRAPHQL
     RUBY
 
-    assert_equal 1, @cop.offenses.count
-    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", @cop.offenses[0].message
+    assert_equal 1, result.offenses.count
+    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", result.offenses[0].message
   end
 
   def test_bad_graphql_multiline_squiggly_heredoc
     skip if RUBY_VERSION < "2.3"
 
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       Query = Client.parse <<~GRAPHQL
         {
           version
         }
       GRAPHQL
     RUBY
 
-    assert_equal 1, @cop.offenses.count
-    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", @cop.offenses[0].message
+    assert_equal 1, result.offenses.count
+    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", result.offenses[0].message
   end
 
   def test_bad_graphql_multiline_heredoc_with_interpolation
-    investigate(@cop, <<-RUBY)
+    result = investigate(@cop, <<-RUBY)
       field = "version"
       Query = Client.parse <<-GRAPHQL
         {
@@ -137,9 +137,9 @@ def test_bad_graphql_multiline_heredoc_with_interpolation
       GRAPHQL
     RUBY
 
-    assert_equal 2, @cop.offenses.count
-    assert_equal "GraphQL/Heredoc: Do not interpolate variables into GraphQL queries, used variables instead.", @cop.offenses[0].message
-    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", @cop.offenses[1].message
+    assert_equal 2, result.offenses.count
+    assert_equal "GraphQL/Heredoc: Do not interpolate variables into GraphQL queries, used variables instead.", result.offenses[0].message
+    assert_equal "GraphQL/Heredoc: GraphQL heredocs should be quoted. <<-'GRAPHQL'", result.offenses[1].message
   end
 
   private
@@ -148,6 +148,5 @@ def investigate(cop, src)
     processed_source = RuboCop::ProcessedSource.new(src, RUBY_VERSION.to_f)
     commissioner = RuboCop::Cop::Commissioner.new([cop], [], raise_error: true)
     commissioner.investigate(processed_source)
-    commissioner
   end
 end

test/test_rubocop_overfetch.rb

@@ -12,33 +12,32 @@ def setup
   end
 
   def test_all_fields_used
-    investigate(@cop, "#{Root}/views/users/show.html.erb")
+    result = investigate(@cop, "#{Root}/views/users/show.html.erb")
 
-    assert_empty @cop.offenses.map(&:message)
+    assert_empty result.offenses.map(&:message)
   end
 
   def test_all_fields_used_with_safe_navigation_operator
     skip if RUBY_VERSION < "2.3"
 
-    investigate(@cop, "#{Root}/views/users/show-2-3.html.erb")
+    result = investigate(@cop, "#{Root}/views/users/show-2-3.html.erb")
 
-    assert_empty @cop.offenses.map(&:message)
+    assert_empty result.offenses.map(&:message)
   end
 
   def test_field_unused
-    investigate(@cop, "#{Root}/views/users/overfetch.html.erb")
+    result = investigate(@cop, "#{Root}/views/users/overfetch.html.erb")
 
-    assert_equal 1, @cop.offenses.count
-    assert_equal "GraphQL/Overfetch: GraphQL field 'birthday' query but was not used in template.", @cop.offenses.first.message
+    assert_equal 1, result.offenses.count
+    assert_equal "GraphQL/Overfetch: GraphQL field 'birthday' query but was not used in template.", result.offenses.first.message
   end
 
   private
 
   def investigate(cop, path)
     engine = GraphQL::Client::ERB.new(File.read(path))
     processed_source = RuboCop::ProcessedSource.new(engine.src.dup, RUBY_VERSION.to_f, path)
-    commissioner = RuboCop::Cop::Commissioner.new([cop], [], raise_error: true)
+    commissioner = RuboCop::Cop::Commissioner.new([cop], [cop], raise_error: true)
     commissioner.investigate(processed_source)
-    commissioner
   end
 end