rubocop-github 0.19.0 → 0.22.0

data/lib/rubocop/cop/github/avoid_object_send_with_dynamic_method.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      # Public: A Rubocop to discourage using methods like Object#send that allow you to dynamically call other
+      # methods on a Ruby object, when the method being called is itself completely dynamic. Instead, explicitly call
+      # methods by name.
+      #
+      # Examples:
+      #
+      #     # bad
+      #     foo.send(some_variable)
+      #
+      #     # good
+      #     case some_variable
+      #     when "bar"
+      #       foo.bar
+      #     else
+      #       foo.baz
+      #     end
+      #
+      #     # fine
+      #     foo.send(:bar)
+      #     foo.public_send("some_method")
+      #     foo.__send__("some_#{variable}_method")
+      class AvoidObjectSendWithDynamicMethod < Base
+        MESSAGE_TEMPLATE = "Avoid using Object#%s with a dynamic method name."
+        SEND_METHODS = %i(send public_send __send__).freeze
+        CONSTANT_TYPES = %i(sym str const).freeze
+
+        def on_send(node)
+          return unless send_method?(node)
+          return if method_being_sent_is_constrained?(node)
+          add_offense(source_range_for_method_call(node), message: MESSAGE_TEMPLATE % node.method_name)
+        end
+
+        private
+
+        def send_method?(node)
+          SEND_METHODS.include?(node.method_name)
+        end
+
+        def method_being_sent_is_constrained?(node)
+          method_name_being_sent_is_constant?(node) || method_name_being_sent_is_dynamic_string_with_constants?(node)
+        end
+
+        def method_name_being_sent_is_constant?(node)
+          method_being_sent = node.arguments.first
+          # e.g., `worker.send(:perform)` or `base.send("extend", Foo)`
+          CONSTANT_TYPES.include?(method_being_sent.type)
+        end
+
+        def method_name_being_sent_is_dynamic_string_with_constants?(node)
+          method_being_sent = node.arguments.first
+          return false unless method_being_sent.type == :dstr
+
+          # e.g., `foo.send("can_#{action}?")`
+          method_being_sent.child_nodes.any? { |child_node| CONSTANT_TYPES.include?(child_node.type) }
+        end
+
+        def source_range_for_method_call(node)
+          begin_pos =
+            if node.receiver # e.g., for `foo.send(:bar)`, `foo` is the receiver
+              node.receiver.source_range.end_pos
+            else # e.g., `send(:bar)`
+              node.source_range.begin_pos
+            end
+          end_pos = node.loc.selector.end_pos
+          Parser::Source::Range.new(processed_source.buffer, begin_pos, end_pos)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/github/rails_controller_render_literal.rb

@@ -9,7 +9,7 @@ module RuboCop
       class RailsControllerRenderLiteral < Base
         include RenderLiteralHelpers
 
-        MSG = "render must be used with a string literal or an instance of a Class"
+        MSG = "render must be used with a string literal or an instance of a Class, and use literals for locals keys"
 
         def_node_matcher :ignore_key?, <<-PATTERN
           (pair (sym {

data/lib/rubocop/cop/github/rails_view_render_shorthand.rb

@@ -6,6 +6,8 @@ module RuboCop
   module Cop
     module GitHub
       class RailsViewRenderShorthand < Base
+        extend AutoCorrector
+
         MSG = "Prefer `render` partial shorthand"
 
         def_node_matcher :render_with_options?, <<-PATTERN
@@ -26,9 +28,13 @@ module RuboCop
             locals_key = option_pairs.map { |pair| locals_key?(pair) }.compact.first
 
             if option_pairs.length == 1 && partial_key
-              add_offense(node, message: "Use `render #{partial_key.source}` instead")
+              add_offense(node, message: "Use `render #{partial_key.source}` instead") do |corrector|
+                corrector.replace(node.source_range, "render #{partial_key.source}")
+              end
             elsif option_pairs.length == 2 && partial_key && locals_key
-              add_offense(node, message: "Use `render #{partial_key.source}, #{locals_key.source}` instead")
+              add_offense(node, message: "Use `render #{partial_key.source}, #{locals_key.source}` instead") do |corrector|
+                corrector.replace(node.source_range, "render #{partial_key.source}, #{locals_key.source}")
+              end
             end
           end
         end

data/lib/rubocop/cop/github/render_literal_helpers.rb

@@ -41,7 +41,8 @@ module RuboCop
         PATTERN
 
         def hash_with_literal_keys?(hash)
-          hash.pairs.all? { |pair| literal?(pair.key) }
+          hash.children.all? { |child| child.pair_type? } &&
+            hash.pairs.all? { |pair| literal?(pair.key) }
         end
 
         def render_view_component?(node)

data/lib/rubocop-github-rails.rb

@@ -6,12 +6,10 @@ require "rubocop/github/inject"
 
 RuboCop::GitHub::Inject.rails_defaults!
 
-require "rubocop/cop/github/rails_application_record"
 require "rubocop/cop/github/rails_controller_render_action_symbol"
 require "rubocop/cop/github/rails_controller_render_literal"
 require "rubocop/cop/github/rails_controller_render_paths_exist"
 require "rubocop/cop/github/rails_controller_render_shorthand"
-require "rubocop/cop/github/rails_render_inline"
 require "rubocop/cop/github/rails_render_object_collection"
 require "rubocop/cop/github/rails_view_render_literal"
 require "rubocop/cop/github/rails_view_render_paths_exist"

data/lib/rubocop-github.rb

@@ -6,4 +6,5 @@ require "rubocop/github/inject"
 
 RuboCop::GitHub::Inject.default_defaults!
 
+require "rubocop/cop/github/avoid_object_send_with_dynamic_method"
 require "rubocop/cop/github/insecure_hash_algorithm"

data/lib/version.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+VERSION = "0.22.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-github
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.22.0
 platform: ruby
 authors:
 - GitHub
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.37'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.37'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.17'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Code style checking for GitHub Ruby repositories '
+description: Code style checking for GitHub Ruby repositories
 email: engineering@github.com
 executables: []
 extensions: []
@@ -105,21 +105,21 @@ files:
 - STYLEGUIDE.md
 - config/default.yml
 - config/default_cops.yml
+- config/default_pending.yml
 - config/rails.yml
 - config/rails_cops.yml
+- config/rails_pending.yml
 - guides/rails-controller-render-shorthand.md
-- guides/rails-render-inline.md
 - guides/rails-render-literal.md
 - lib/rubocop-github-rails.rb
 - lib/rubocop-github.rb
 - lib/rubocop/cop/github.rb
+- lib/rubocop/cop/github/avoid_object_send_with_dynamic_method.rb
 - lib/rubocop/cop/github/insecure_hash_algorithm.rb
-- lib/rubocop/cop/github/rails_application_record.rb
 - lib/rubocop/cop/github/rails_controller_render_action_symbol.rb
 - lib/rubocop/cop/github/rails_controller_render_literal.rb
 - lib/rubocop/cop/github/rails_controller_render_paths_exist.rb
 - lib/rubocop/cop/github/rails_controller_render_shorthand.rb
-- lib/rubocop/cop/github/rails_render_inline.rb
 - lib/rubocop/cop/github/rails_render_object_collection.rb
 - lib/rubocop/cop/github/rails_view_render_literal.rb
 - lib/rubocop/cop/github/rails_view_render_paths_exist.rb
@@ -127,10 +127,14 @@ files:
 - lib/rubocop/cop/github/render_literal_helpers.rb
 - lib/rubocop/github.rb
 - lib/rubocop/github/inject.rb
+- lib/version.rb
 homepage: https://github.com/github/rubocop-github
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/github/rubocop-github
+  documentation_uri: https://github.com/github/rubocop-github
+  bug_tracker_uri: https://github.com/github/rubocop-github/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -139,14 +143,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: RuboCop GitHub

data/guides/rails-render-inline.md

@@ -1,27 +0,0 @@
-# GitHub/RailsRenderInline
-
-tldr; Do not use `render inline:`.
-
-## Rendering plain text
-
-``` ruby
-render inline: "Just plain text" # bad
-```
-
-The `inline:` option is often misused when plain text is being returned. Instead use `render plain: "Just plain text"`.
-
-## Rendering a dynamic ERB string
-
-String `#{}` interpolation is often misused with `render inline:` instead of using `<%= %>` interpolation. This will lead to a memory leak where an ERB method will be compiled and cached for each invocation of `render inline:`.
-
-``` ruby
-render inline: "Hello #{@name}" # bad
-```
-
-## Rendering static ERB strings
-
-``` ruby
-render inline: "Hello <%= @name %>" # bad
-```
-
-If you are passing a static ERB string to `render inline:`, this string is best moved to a `.erb` template under `app/views`. Template files are able to be precompiled at boot time.

data/lib/rubocop/cop/github/rails_application_record.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-
-module RuboCop
-  module Cop
-    module GitHub
-      class RailsApplicationRecord < Base
-        MSG = "Models should subclass from ApplicationRecord"
-
-        def_node_matcher :active_record_base_const?, <<-PATTERN
-          (const (const nil? :ActiveRecord) :Base)
-        PATTERN
-
-        def_node_matcher :application_record_const?, <<-PATTERN
-          (const nil? :ApplicationRecord)
-        PATTERN
-
-        def on_class(node)
-          klass, superclass, _ = *node
-
-          if active_record_base_const?(superclass) && !(application_record_const?(klass))
-            add_offense(superclass)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/cop/github/rails_render_inline.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-
-module RuboCop
-  module Cop
-    module GitHub
-      class RailsRenderInline < Base
-        MSG = "Avoid `render inline:`"
-
-        def_node_matcher :render_with_options?, <<-PATTERN
-          (send nil? {:render :render_to_string} (hash $...))
-        PATTERN
-
-        def_node_matcher :inline_key?, <<-PATTERN
-          (pair (sym :inline) $_)
-        PATTERN
-
-        def on_send(node)
-          if option_pairs = render_with_options?(node)
-            if option_pairs.detect { |pair| inline_key?(pair) }
-              add_offense(node)
-            end
-          end
-        end
-      end
-    end
-  end
-end