rubocop-springest 0.6.0

data/guides/rails-controller-render-shorthand.md

@@ -0,0 +1,9 @@
+# GitHub/RailsControllerRenderShorthand
+
+Prefer `render "path/to/template"` shorthand in controllers.
+
+``` ruby
+render template: "products/show"
+# can be written as
+render "products/show"
+```

data/guides/rails-render-inline.md

@@ -0,0 +1,27 @@
+# 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/guides/rails-render-literal.md

@@ -0,0 +1,8 @@
+# GitHub/RailsRenderLiteral
+
+tldr; `render` MUST be passed a string literal template path.
+
+* When used in conjunction with `GitHub/RailsViewRenderPathsExist`, linters can ensure the target file exists on disk and would not crash rendering a missing template.
+* Makes it easier for humans to trace callers of a template. Simply search for the full path of the target template to find **all** call sites.
+* This same call site tracing enables automated unused template checking. If no callers are found, the template can be safely removed.
+* Enables render precompilation and inlining optimizations. Target templates can be compiled and inlined on boot time rather than deferring to first render to lazily compile templates.

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsApplicationRecord < Cop
+        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, location: :expression)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsControllerRenderActionSymbol < Cop
+        MSG = "Prefer `render` with string instead of symbol"
+
+        def_node_matcher :render_sym?, <<-PATTERN
+          (send nil? :render $(sym _))
+        PATTERN
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil? :render (hash $...))
+        PATTERN
+
+        def_node_matcher :action_key?, <<-PATTERN
+          (pair (sym {:action :template}) $(sym _))
+        PATTERN
+
+        def on_send(node)
+          if sym_node = render_sym?(node)
+            add_offense(sym_node, location: :expression)
+          elsif option_pairs = render_with_options?(node)
+            option_pairs.each do |pair|
+              if sym_node = action_key?(pair)
+                add_offense(sym_node, location: :expression)
+              end
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.source_range, "\"#{node.children[0]}\"")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsControllerRenderLiteral < Cop
+        MSG = "render must be used with a string literal"
+
+        def_node_matcher :literal?, <<-PATTERN
+          ({str sym true false nil?} ...)
+        PATTERN
+
+        def_node_matcher :render?, <<-PATTERN
+          (send nil? :render ...)
+        PATTERN
+
+        def_node_matcher :render_literal?, <<-PATTERN
+          (send nil? :render ({str sym} $_) $...)
+        PATTERN
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil? :render (hash $...))
+        PATTERN
+
+        def_node_matcher :ignore_key?, <<-PATTERN
+          (pair (sym {
+            :body
+            :file
+            :html
+            :inline
+            :js
+            :json
+            :nothing
+            :plain
+            :text
+            :xml
+          }) $_)
+        PATTERN
+
+        def_node_matcher :template_key?, <<-PATTERN
+          (pair (sym {
+            :action
+            :partial
+            :template
+          }) $_)
+        PATTERN
+
+        def_node_matcher :layout_key?, <<-PATTERN
+          (pair (sym :layout) $_)
+        PATTERN
+
+        def_node_matcher :options_key?, <<-PATTERN
+          (pair (sym {
+            :content_type
+            :location
+            :status
+            :formats
+          }) ...)
+        PATTERN
+
+        def on_send(node)
+          return unless render?(node)
+
+          if render_literal?(node)
+          elsif option_pairs = render_with_options?(node)
+            option_pairs = option_pairs.reject { |pair| options_key?(pair) }
+
+            if option_pairs.any? { |pair| ignore_key?(pair) }
+              return
+            end
+
+            if template_node = option_pairs.map { |pair| template_key?(pair) }.compact.first
+              if !literal?(template_node)
+                add_offense(node, location: :expression)
+              end
+            else
+              add_offense(node, location: :expression)
+            end
+
+            if layout_node = option_pairs.map { |pair| layout_key?(pair) }.compact.first
+              if !literal?(layout_node)
+                add_offense(node, location: :expression)
+              end
+            end
+          else
+            add_offense(node, location: :expression)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsControllerRenderPathsExist < Cop
+        def_node_matcher :render?, <<-PATTERN
+          (send nil? :render $...)
+        PATTERN
+
+        def_node_matcher :render_str?, <<-PATTERN
+          (send nil? :render $({str sym} $_) ...)
+        PATTERN
+
+        def_node_matcher :render_options?, <<-PATTERN
+          (send nil? :render (hash $...))
+        PATTERN
+
+        def_node_matcher :render_key?, <<-PATTERN
+          (pair (sym ${:action :partial :template}) $({str sym} $_))
+        PATTERN
+
+        def on_send(node)
+          return unless cop_config["ViewPath"]
+
+          if args = render_str?(node)
+            node, path = args
+            unless resolve_template(path.to_s)
+              add_offense(node, location: :expression, message: "Template could not be found")
+            end
+          elsif pairs = render_options?(node)
+            if pair = pairs.detect { |p| render_key?(p) }
+              key, node, path = render_key?(pair)
+
+              case key
+              when :action, :template
+                unless resolve_template(path.to_s)
+                  add_offense(node, location: :expression, message: "Template could not be found")
+                end
+              when :partial
+                unless resolve_partial(path.to_s)
+                  add_offense(node, location: :expression, message: "Partial template could not be found")
+                end
+              end
+            end
+          end
+        end
+
+        def resolve_template(path)
+          cop_config["ViewPath"].each do |view_path|
+            if m = Dir[File.join(config.path_relative_to_config(view_path), path) + "*"].first
+              return m
+            end
+          end
+          nil
+        end
+
+        def resolve_partial(path)
+          parts = path.split(File::SEPARATOR)
+          parts << "_#{parts.pop}"
+          path = parts.join(File::SEPARATOR)
+          resolve_template(path)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsControllerRenderShorthand < Cop
+        MSG = "Prefer `render` template shorthand"
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil? :render (hash $...))
+        PATTERN
+
+        def_node_matcher :action_key?, <<-PATTERN
+          (pair (sym {:action :template}) $({str sym} _))
+        PATTERN
+
+        def_node_matcher :str, <<-PATTERN
+          ({str sym} $_)
+        PATTERN
+
+        def investigate(*)
+          @autocorrect = {}
+        end
+
+        def autocorrect(node)
+          @autocorrect[node]
+        end
+
+        def on_send(node)
+          if option_pairs = render_with_options?(node)
+            option_pairs.each do |pair|
+              if value_node = action_key?(pair)
+                comma = option_pairs.length > 1 ? ", " : ""
+                corrected_source = node.source
+                  .sub(/#{pair.source}(,\s*)?/, "")
+                  .sub("render ", "render \"#{str(value_node)}\"#{comma}")
+
+                @autocorrect[node] = lambda do |corrector|
+                  corrector.replace(node.source_range, corrected_source)
+                end
+                add_offense(node, location: :expression, message: "Use `#{corrected_source}` instead")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsRenderInline < Cop
+        MSG = "Avoid `render inline:`"
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil? :render (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, location: :expression)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsRenderObjectCollection < Cop
+        MSG = "Avoid `render object:`"
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil? :render (hash $...) ...)
+        PATTERN
+
+        def_node_matcher :partial_key?, <<-PATTERN
+          (pair (sym :partial) $_)
+        PATTERN
+
+        def_node_matcher :object_key?, <<-PATTERN
+          (pair (sym ${:object :collection :spacer_template}) $_)
+        PATTERN
+
+        def on_send(node)
+          if option_pairs = render_with_options?(node)
+            partial_pair = option_pairs.detect { |pair| partial_key?(pair) }
+            object_pair  = option_pairs.detect { |pair| object_key?(pair) }
+
+            if partial_pair && object_pair
+              partial_name = partial_key?(partial_pair)
+              object_sym, object_node = object_key?(object_pair)
+
+              case object_sym
+              when :object
+                if partial_name.children[0].is_a?(String)
+                  suggestion = ", instead `render partial: #{partial_name.source}, locals: { #{File.basename(partial_name.children[0], '.html.erb')}: #{object_node.source} }`"
+                end
+                add_offense(node, location: :expression, message: "Avoid `render object:`#{suggestion}")
+              when :collection, :spacer_template
+                add_offense(node, location: :expression, message: "Avoid `render collection:`")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsViewRenderLiteral < Cop
+        MSG = "render must be used with a string literal"
+
+        def_node_matcher :literal?, <<-PATTERN
+          ({str sym true false nil?} ...)
+        PATTERN
+
+        def_node_matcher :render?, <<-PATTERN
+          (send nil? :render $...)
+        PATTERN
+
+        def_node_matcher :render_literal?, <<-PATTERN
+          (send nil? :render ({str sym} $_) $...)
+        PATTERN
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil? :render (hash $...) ...)
+        PATTERN
+
+        def_node_matcher :ignore_key?, <<-PATTERN
+          (pair (sym {
+            :inline
+          }) $_)
+        PATTERN
+
+        def_node_matcher :partial_key?, <<-PATTERN
+          (pair (sym {
+            :file
+            :layout
+            :partial
+          }) $_)
+        PATTERN
+
+        def on_send(node)
+          return unless render?(node)
+
+          if render_literal?(node)
+          elsif option_pairs = render_with_options?(node)
+            if option_pairs.any? { |pair| ignore_key?(pair) }
+              return
+            end
+
+            if partial_node = option_pairs.map { |pair| partial_key?(pair) }.compact.first
+              if !literal?(partial_node)
+                add_offense(node, location: :expression)
+              end
+            else
+              add_offense(node, location: :expression)
+            end
+          else
+            add_offense(node, location: :expression)
+          end
+        end
+      end
+    end
+  end
+end