Ensure locals are fixed

jhawthorn · jhawthorn · commit 7f5fbd963d8e · 2021-01-14T14:48:04.000-08:00
diff --git a/lib/rubocop/cop/github/rails_view_render_literal.rb b/lib/rubocop/cop/github/rails_view_render_literal.rb
@@ -6,7 +6,7 @@ module RuboCop
   module Cop
     module GitHub
       class RailsViewRenderLiteral < Cop
-        MSG = "render must be used with a string literal or an instance of a Class"
+        MSG = "render must be used with a literal template and use literals for locals keys"
 
         def_node_matcher :literal?, <<-PATTERN
           ({str sym true false nil?} ...)
@@ -20,11 +20,11 @@ class RailsViewRenderLiteral < Cop
           (send nil? {:render :render_to_string} ({str sym} $_) $...)
         PATTERN
 
-        def_node_matcher :render_inst?, <<-PATTERN
+        def_node_matcher :render_view_component?, <<-PATTERN
           (send nil? {:render :render_to_string} (send _ :new ...) ...)
         PATTERN
 
-        def_node_matcher :render_collection?, <<-PATTERN
+        def_node_matcher :render_view_component_collection?, <<-PATTERN
           (send nil? {:render :render_to_string} (send _ :with_collection ...) ...)
         PATTERN
 
@@ -38,6 +38,12 @@ class RailsViewRenderLiteral < Cop
           }) $_)
         PATTERN
 
+        def_node_matcher :locals_key?, <<-PATTERN
+          (pair (sym {
+            :locals
+          }) $_)
+        PATTERN
+
         def_node_matcher :partial_key?, <<-PATTERN
           (pair (sym {
             :file
@@ -47,10 +53,17 @@ class RailsViewRenderLiteral < Cop
           }) $_)
         PATTERN
 
+        def hash_with_literal_keys?(hash)
+          hash.pairs.all? { |pair| literal?(pair.key) }
+        end
+
         def on_send(node)
           return unless render?(node)
 
-          if render_literal?(node) || render_inst?(node) || render_collection?(node)
+          # Ignore "component"-style renders
+          return if render_view_component?(node) || render_view_component_collection?(node)
+
+          if render_literal?(node)
           elsif option_pairs = render_with_options?(node)
             if option_pairs.any? { |pair| ignore_key?(pair) }
               return
@@ -59,12 +72,31 @@ def on_send(node)
             if partial_node = option_pairs.map { |pair| partial_key?(pair) }.compact.first
               if !literal?(partial_node)
                 add_offense(node, location: :expression)
+                return
               end
             else
               add_offense(node, location: :expression)
+              return
             end
           else
             add_offense(node, location: :expression)
+            return
+          end
+
+          if render_literal?(node) && node.arguments.count > 1
+            locals = node.arguments[1]
+          elsif options_pairs = render_with_options?(node)
+            locals = option_pairs.map { |pair| locals_key?(pair) }.compact.first
+          end
+
+          if locals
+            if locals.hash_type?
+              if !hash_with_literal_keys?(locals)
+                add_offense(node, location: :expression)
+              end
+            else
+              add_offense(node, location: :expression)
+            end
           end
         end
       end
diff --git a/test/test_rails_view_render_literal.rb b/test/test_rails_view_render_literal.rb
@@ -43,7 +43,7 @@ def test_render_variable_offense
     ERB
 
     assert_equal 2, cop.offenses.count
-    assert_equal "render must be used with a string literal or an instance of a Class", cop.offenses[0].message
+    assert_equal "render must be used with a literal template and use literals for locals keys", cop.offenses[0].message
   end
 
   def test_render_component_no_offense
@@ -94,7 +94,7 @@ def test_render_layout_variable_literal_no_offense
     ERB
 
     assert_equal 1, cop.offenses.count
-    assert_equal "render must be used with a string literal or an instance of a Class", cop.offenses[0].message
+    assert_equal "render must be used with a literal template and use literals for locals keys", cop.offenses[0].message
   end
 
   def test_render_inline_no_offense
@@ -112,4 +112,52 @@ def test_render_template_literal_no_offense
 
     assert_equal 0, cop.offenses.count
   end
+
+  def test_render_literal_static_locals_no_offense
+    erb_investigate cop, <<-ERB, "app/views/products/index.html.erb"
+      <%= render "products/product", product: product %>
+    ERB
+
+    assert_equal 0, cop.offenses.count
+  end
+
+  def test_render_literal_dynamic_locals_offense
+    erb_investigate cop, <<-ERB, "app/views/products/index.html.erb"
+      <%= render "products/product", locals %>
+    ERB
+
+    assert_equal 1, cop.offenses.count
+  end
+
+  def test_render_literal_dynamic_local_key_offense
+    erb_investigate cop, <<-ERB, "app/views/products/index.html.erb"
+      <%= render "products/product", { product_key => product } %>
+    ERB
+
+    assert_equal 1, cop.offenses.count
+  end
+
+  def test_render_options_static_locals_no_offense
+    erb_investigate cop, <<-ERB, "app/views/products/index.html.erb"
+      <%= render partial: "products/product", locals: { product: product } %>
+    ERB
+
+    assert_equal 0, cop.offenses.count
+  end
+
+  def test_render_options_dynamic_locals_offense
+    erb_investigate cop, <<-ERB, "app/views/products/index.html.erb"
+      <%= render partial: "products/product", locals: locals %>
+    ERB
+
+    assert_equal 1, cop.offenses.count
+  end
+
+  def test_render_options_dynamic_local_key_offense
+    erb_investigate cop, <<-ERB, "app/views/products/index.html.erb"
+      <%= render partial: "products/product", locals: { product_key => product } %>
+    ERB
+
+    assert_equal 1, cop.offenses.count
+  end
 end
