rubocop-standard 1.12.0

data/config/default.yml

@@ -0,0 +1,326 @@
+require: rubocop/cop/standard
+
+AllCops:
+  DisabledByDefault: true
+
+Bundler/DuplicatedGem:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: true
+
+Layout/BlockAlignment:
+  Enabled: true
+
+Layout/BlockEndNewline:
+  Enabled: true
+
+Layout/ConditionPosition:
+  Enabled: true
+
+Layout/DefEndAlignment:
+  Enabled: true
+
+Layout/EndAlignment:
+  Enabled: false
+
+Layout/EndOfLine:
+  Enabled: true
+
+Layout/InitialIndentation:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterMethodName:
+  Enabled: true
+
+Layout/SpaceAfterNot:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundBlockParameters:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: true
+  EnforcedStyle: no_space
+
+Layout/SpaceInsideArrayPercentLiteral:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/SpaceInsideRangeLiteral:
+  Enabled: true
+
+Layout/SpaceInsideReferenceBrackets:
+  Enabled: true
+
+Layout/Tab:
+  Enabled: true
+
+Layout/TrailingBlankLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Lint/CircularArgumentReference:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/DuplicatedKey:
+  Enabled: true
+
+Lint/EachWithObjectArgument:
+  Enabled: true
+
+Lint/ElseLayout:
+  Enabled: true
+
+Lint/EmptyEnsure:
+  Enabled: true
+
+Lint/EmptyInterpolation:
+  Enabled: true
+
+Lint/EndInMethod:
+  Enabled: true
+
+Lint/EnsureReturn:
+  Enabled: true
+
+Lint/FlipFlop:
+  Enabled: true
+
+Lint/FloatOutOfRange:
+  Enabled: true
+
+Lint/FormatParameterMismatch:
+  Enabled: true
+
+Lint/LiteralAsCondition:
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Enabled: true
+
+Lint/Loop:
+  Enabled: true
+
+Lint/NextWithoutAccumulator:
+  Enabled: true
+
+Lint/RandOne:
+  Enabled: true
+
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/RescueException:
+  Enabled: true
+
+Lint/StringConversionInInterpolation:
+  Enabled: true
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+
+Lint/UnneededCopDisableDirective:
+  Enabled: true
+
+Lint/UnneededSplatExpansion:
+  Enabled: true
+
+Lint/UnreachableCode:
+  Enabled: true
+
+Lint/UselessComparison:
+  Enabled: true
+
+Lint/UselessSetterCall:
+  Enabled: true
+
+Lint/Void:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/AsciiIdentifiers:
+  Enabled: true
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: true
+
+Naming/FileName:
+  Enabled: true
+
+Naming/MethodName:
+  Enabled: true
+
+Performance/CaseWhenSplat:
+  Enabled: false
+
+Performance/Count:
+  Enabled: true
+
+Performance/Detect:
+  Enabled: true
+
+Performance/DoubleStartEndWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/LstripRstrip:
+  Enabled: true
+
+Performance/RangeInclude:
+  Enabled: false
+
+Performance/RedundantMatch:
+  Enabled: false
+
+Performance/RedundantMerge:
+  Enabled: true
+  MaxKeyValuePairs: 1
+
+Performance/RedundantSortBy:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/Sample:
+  Enabled: true
+
+Performance/Size:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Security/Eval:
+  Enabled: true
+
+Style/ArrayJoin:
+  Enabled: true
+
+Style/BeginBlock:
+  Enabled: true
+
+Style/BlockComments:
+  Enabled: true
+
+Style/CaseEquality:
+  Enabled: true
+
+Style/CharacterLiteral:
+  Enabled: true
+
+Style/ClassMethods:
+  Enabled: true
+
+Style/Copyright:
+  Enabled: false
+
+Style/DefWithParentheses:
+  Enabled: true
+
+Style/EndBlock:
+  Enabled: true
+
+Style/For:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/LambdaCall:
+  Enabled: true
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/MultilineIfThen:
+  Enabled: true
+
+Style/NilComparison:
+  Enabled: true
+
+Style/Not:
+  Enabled: true
+
+Style/OneLineConditional:
+  Enabled: true
+
+Style/StabbyLambdaParentheses:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/config/rails.yml

@@ -0,0 +1,118 @@
+Rails:
+  Enabled: true
+
+Rails/FindEach:
+  Enabled: false
+
+Rails/OutputSafety:
+  Enabled: true
+
+Rails/PluralizationGrammar:
+  Enabled: true
+
+Rails/RequestReferer:
+  Enabled: true
+  EnforcedStyle: referrer
+
+Rails/ScopeArgs:
+  Enabled: true
+
+Rails/UniqBeforePluck:
+  Enabled: true
+
+Standard/RailsApplicationRecord:
+  Enabled: true
+
+Standard/RailsControllerRenderActionSymbol:
+  Enabled: true
+  Include:
+    - 'app/controllers/**/*.rb'
+
+Standard/RailsControllerRenderLiteral:
+  Enabled: true
+  StyleGuide: https://github.com/gjtorikian/rubocop-standard/blob/master/guides/rails-render-literal.md
+  Include:
+    - 'app/controllers/**/*.rb'
+
+Standard/RailsControllerRenderPathsExist:
+  Enabled: true
+  ViewPath:
+    - 'app/views'
+  Include:
+    - 'app/controllers/**/*.rb'
+
+Standard/RailsControllerRenderShorthand:
+  Enabled: true
+  StyleGuide: https://github.com/gjtorikian/rubocop-standard/blob/master/guides/rails-controller-render-shorthand.md
+  Include:
+    - 'app/controllers/**/*.rb'
+
+Standard/RailsRenderInline:
+  Enabled: true
+  StyleGuide: https://github.com/gjtorikian/rubocop-standard/blob/master/guides/rails-controller-render-inline.md
+  Include:
+    - 'app/controllers/**/*.rb'
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+Standard/RailsRenderObjectCollection:
+  Enabled: false
+
+Standard/RailsViewRenderLiteral:
+  Enabled: true
+  StyleGuide: https://github.com/gjtorikian/rubocop-standard/blob/master/guides/rails-render-literal.md
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+Standard/RailsViewRenderPathsExist:
+  Enabled: true
+  ViewPath:
+    - 'app/views'
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+Standard/RailsViewRenderShorthand:
+  Enabled: true
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+# Exclude Rails ERB files from incompatible cops
+
+Layout/BlockAlignment:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Style/For:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Style/OneLineConditional:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Style/Semicolon:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Layout/SpaceInsideParens:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Style/StringLiterals:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Layout/TrailingBlankLines:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'app/views/**/*.erb'

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

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

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

@@ -0,0 +1,8 @@
+# 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_application_record.rb

@@ -0,0 +1,29 @@
+# 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
+
+          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/standard/rails_controller_render_action_symbol.rb

@@ -0,0 +1,43 @@
+# 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_controller_render_literal.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Standard
+      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