rubocop-standard 4.2.0 → 5.0.0

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

@@ -1,9 +0,0 @@
-# Standard/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

@@ -1,27 +0,0 @@
-# Standard/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

@@ -1,8 +0,0 @@
-# Standard/RailsRenderLiteral
-
-tldr; `render` MUST be passed a string literal template path.
-
-* When used in conjunction with `Standard/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/standard/rails.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop/cop/standard/rails/rails_application_record'
-require 'rubocop/cop/standard/rails/rails_controller_render_action_symbol'
-require 'rubocop/cop/standard/rails/rails_controller_render_paths_exist'
-require 'rubocop/cop/standard/rails/rails_controller_render_shorthand'
-require 'rubocop/cop/standard/rails/rails_render_inline'
-require 'rubocop/cop/standard/rails/rails_render_object_collection'
-require 'rubocop/cop/standard/rails/rails_view_render_paths_exist'
-require 'rubocop/cop/standard/rails/rails_view_render_shorthand'

data/lib/rubocop/cop/standard/rails/rails_application_record.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module RuboCop
-  module Cop
-    module Standard
-      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
-
-          add_offense(superclass, location: :expression) if active_record_base_const?(superclass) && !application_record_const?(klass)
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/cop/standard/rails/rails_controller_render_action_symbol.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module RuboCop
-  module Cop
-    module Standard
-      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/standard/rails/rails_controller_render_paths_exist.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module RuboCop
-  module Cop
-    module Standard
-      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
-            add_offense(node, location: :expression, message: 'Template could not be found') unless resolve_template(path.to_s)
-          elsif (pairs = render_options?(node))
-            if (pair = pairs.detect { |p| render_key?(p) })
-              key, node, path = render_key?(pair)
-
-              case key
-              when :action, :template
-                add_offense(node, location: :expression, message: 'Template could not be found') unless resolve_template(path.to_s)
-              when :partial
-                add_offense(node, location: :expression, message: 'Partial template could not be found') unless resolve_partial(path.to_s)
-              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/standard/rails/rails_controller_render_shorthand.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module RuboCop
-  module Cop
-    module Standard
-      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)
-          return unless (option_pairs = render_with_options?(node))
-
-          option_pairs.each do |pair|
-            next unless (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

data/lib/rubocop/cop/standard/rails/rails_render_inline.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module RuboCop
-  module Cop
-    module Standard
-      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)
-          return unless (option_pairs = render_with_options?(node))
-
-          add_offense(node, location: :expression) if option_pairs.detect { |pair| inline_key?(pair) }
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/cop/standard/rails/rails_render_object_collection.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module RuboCop
-  module Cop
-    module Standard
-      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)
-          return unless (option_pairs = render_with_options?(node))
-
-          partial_pair = option_pairs.detect { |pair| partial_key?(pair) }
-          object_pair  = option_pairs.detect { |pair| object_key?(pair) }
-
-          return unless partial_pair && object_pair
-
-          partial_name = partial_key?(partial_pair)
-          object_sym, object_node = object_key?(object_pair)
-
-          case object_sym
-          when :object
-            suggestion = ", instead `render partial: #{partial_name.source}, locals: { #{File.basename(partial_name.children[0], '.html.erb')}: #{object_node.source} }`" if partial_name.children[0].is_a?(String)
-            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

data/lib/rubocop/cop/standard/rails/rails_view_render_paths_exist.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module RuboCop
-  module Cop
-    module Standard
-      class RailsViewRenderPathsExist < Cop
-        def_node_matcher :render?, <<-PATTERN
-          (send nil? :render $...)
-        PATTERN
-
-        def_node_matcher :render_str?, <<-PATTERN
-          (send nil? :render $(str $_) ...)
-        PATTERN
-
-        def_node_matcher :render_options?, <<-PATTERN
-          (send nil? :render (hash $...))
-        PATTERN
-
-        def_node_matcher :partial_key?, <<-PATTERN
-          (pair (sym :partial) $(str $_))
-        PATTERN
-
-        def on_send(node)
-          return unless cop_config['ViewPath']
-
-          if (args = render_str?(node))
-            node, path = args
-            add_offense(node, location: :expression, message: 'Partial template could not be found') unless resolve_partial(path.to_s)
-          elsif (pairs = render_options?(node))
-            if (pair = pairs.detect { |p| partial_key?(p) })
-              node, path = partial_key?(pair)
-
-              add_offense(node, location: :expression, message: 'Partial template could not be found') unless resolve_partial(path.to_s)
-            end
-          end
-        end
-
-        def resolve_partial(path)
-          parts = path.split(File::SEPARATOR)
-          parts << "_#{parts.pop}"
-          path = parts.join(File::SEPARATOR)
-
-          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
-      end
-    end
-  end
-end

data/lib/rubocop/cop/standard/rails/rails_view_render_shorthand.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module RuboCop
-  module Cop
-    module Standard
-      class RailsViewRenderShorthand < Cop
-        MSG = 'Prefer `render` partial shorthand'
-
-        def_node_matcher :render_with_options?, <<-PATTERN
-          (send nil? :render (hash $...))
-        PATTERN
-
-        def_node_matcher :partial_key?, <<-PATTERN
-          (pair (sym :partial) $(str _))
-        PATTERN
-
-        def_node_matcher :locals_key?, <<-PATTERN
-          (pair (sym :locals) $_)
-        PATTERN
-
-        def on_send(node)
-          return unless (option_pairs = render_with_options?(node))
-
-          partial_key = option_pairs.map { |pair| partial_key?(pair) }.compact.first
-          locals_key = option_pairs.map { |pair| locals_key?(pair) }.compact.first
-
-          if option_pairs.length == 1 && partial_key
-            add_offense(node, location: :expression, message: "Use `render #{partial_key.source}` instead")
-          elsif option_pairs.length == 2 && partial_key && locals_key
-            add_offense(node, location: :expression, message: "Use `render #{partial_key.source}, #{locals_key.source}` instead")
-          end
-        end
-      end
-    end
-  end
-end