rubocop-github 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fd87ba9b81dbf0489ef9f8bdddfdc7ad832c7735e4376851165a03369a4493d
-  data.tar.gz: 294732c21b2ac89bde8bc654854d659293b7347ca478013e2eeeda8be3b92c4d
+  metadata.gz: a5aac9faf8fd07df225b66910c710065d8d69fd889bd424778c3802374691d95
+  data.tar.gz: fc3548902e7759613503804188cd2e71e45ff0e4c6464c7544c6f3a62d9addd3
 SHA512:
-  metadata.gz: 75eca6f6d9a4c688a24f57f6b282d8a7515e7408db7c403ae0c3acdcd677d9cbb6acaa0713c55f8544baed002a077a1bcb3f2a4efd24d9118b720b7175d84a2c
-  data.tar.gz: 4770a141ce649d7bb034a9071db481a52858461672804e63ba62ea928072e0094177630d747a40b50ec017dafb323b5e6f4d4249d2e4ab543a20ebd5c53cfb14
+  metadata.gz: d5850a48c2665aff47ca0d0505b20869d0e573e4bb4018a79132a78e64c3b7fd3fe9c27c0c472966a1ce1e9bcaf9969a61d9241d919f899769a6b73f308fd48a
+  data.tar.gz: d451981724e1d7bc407f7bf0f5fb2078f97eb9779f83fa3168241e25b28beffebb06d55805bc8e7fee8eceb1621e8cc28ce0308f389e1ebe30edd4ef023108b5

data/README.md

@@ -4,28 +4,6 @@ This repository provides recommended RuboCop configuration and additional Cops f
 
 ## Usage
 
-Rubocop 0.68 removed performance cops and 0.72 removed Rails cops. However, upgrading `rubocop-github` without modification will almost definitely create very many new offenses. The current version of this gem exposes the "legacy" configuration under `config/default.yml` and `config/rails.yml` which should be used *if and only if* the version of rubocop is locked to `< 0.68` in your project (which it should be unless you `bundle update rubocop`). It also exposes an "edge" configuration under `config/default_edge.yml` and `config/rails_edge.yml` so that the changes can be tested without introducing breaking changes.
-
-### Legacy usage
-
-**Gemfile**
-
-``` ruby
-gem "rubocop", "< 0.68"
-gem "rubocop-github"
-```
-
-**.rubocop.yml**
-
-``` yaml
-inherit_gem:
-  rubocop-github:
-    - config/default.yml
-    - config/rails.yml
-```
-
-### Edge usage
-
 **Gemfile**
 
 ``` ruby
@@ -43,6 +21,11 @@ inherit_gem:
     - config/rails_edge.yml
 ```
 
+### Legacy usage
+
+If you are using a rubocop version < 1.0.0, you can use rubocop-github version
+0.16.2 (see the README from that version for more details).
+
 ## Testing
 
 `bundle install`

data/STYLEGUIDE.md

@@ -387,7 +387,8 @@ remove_member(user, skip_membership_check: true)
 
 * The names of potentially "dangerous" methods (i.e. methods that modify `self` or the
   arguments, `exit!`, etc.) should end with an exclamation mark. Bang methods
-  should only exist if a non-bang method exists. ([More on this](http://dablog.rubypal.com/2007/8/15/bang-methods-or-danger-will-rubyist)).
+  should only exist if a non-bang counterpart (method name which does NOT end with !) 
+  also exists.
 
 ## Percent Literals
 

data/config/default.yml

@@ -1,2 +1,334 @@
-# Inherit from default_deprecated until 1.0
-inherit_from: default_deprecated.yml
+require:
+  - rubocop/cop/github
+  - rubocop-performance
+
+AllCops:
+  DisabledByDefault: true
+
+Bundler/DuplicatedGem:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: true
+
+GitHub/InsecureHashAlgorithm:
+  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/IndentationStyle:
+  Enabled: true
+  EnforcedStyle: spaces
+  IndentationWidth: 2
+
+Layout/IndentationWidth:
+  Enabled: true
+  Width: 2
+
+Layout/InitialIndentation:
+  Enabled: true
+
+Layout/LineLength:
+  Enabled: false
+
+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/TrailingEmptyLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Lint/CircularArgumentReference:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/DuplicateHashKey:
+  Enabled: true
+
+Lint/EachWithObjectArgument:
+  Enabled: true
+
+Lint/ElseLayout:
+  Enabled: true
+
+Lint/EmptyEnsure:
+  Enabled: true
+
+Lint/EmptyInterpolation:
+  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/RedundantStringCoercion:
+  Enabled: true
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+
+Lint/RedundantCopDisableDirective:
+  Enabled: true
+
+Lint/RedundantSplatExpansion:
+  Enabled: true
+
+Lint/UnreachableCode:
+  Enabled: true
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  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/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/RangeInclude:
+  Enabled: false
+
+Performance/RedundantMatch:
+  Enabled: false
+
+Performance/RedundantMerge:
+  Enabled: true
+  MaxKeyValuePairs: 1
+
+Performance/ReverseEach:
+  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/RedundantSortBy:
+  Enabled: true
+
+Style/Sample:
+  Enabled: true
+
+Style/StabbyLambdaParentheses:
+  Enabled: true
+
+Style/Strip:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/config/rails.yml

@@ -1,2 +1,127 @@
-# Inherit from rails_deprecated until 1.0
-inherit_from: rails_deprecated.yml
+require:
+  - rubocop-rails
+
+Rails/OutputSafety:
+  Enabled: true
+
+Rails/PluralizationGrammar:
+  Enabled: true
+
+Rails/RequestReferer:
+  Enabled: true
+  EnforcedStyle: referrer
+
+Rails/ScopeArgs:
+  Enabled: true
+
+Rails/UniqBeforePluck:
+  Enabled: true
+
+GitHub/RailsApplicationRecord:
+  Enabled: true
+
+GitHub/RailsControllerRenderActionSymbol:
+  Enabled: true
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderLiteral:
+  Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-render-literal.md
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderPathsExist:
+  Enabled: true
+  ViewPath:
+    - 'app/views'
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderShorthand:
+  Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-controller-render-shorthand.md
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsRenderInline:
+  Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-controller-render-inline.md
+  Include:
+    - 'app/controllers/**/*.rb'
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+GitHub/RailsRenderObjectCollection:
+  Enabled: false
+
+GitHub/RailsViewRenderLiteral:
+  Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-render-literal.md
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+GitHub/RailsViewRenderPathsExist:
+  Enabled: true
+  ViewPath:
+    - 'app/views'
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+GitHub/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/TrailingEmptyLines:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Layout/IndentationWidth:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Layout/InitialIndentation:
+  Exclude:
+    - 'app/views/**/*.erb'
+
+Lint/UselessAccessModifier:
+  ContextCreatingMethods:
+    - concerning

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

@@ -5,7 +5,7 @@ require "rubocop"
 module RuboCop
   module Cop
     module GitHub
-      class InsecureHashAlgorithm < Cop
+      class InsecureHashAlgorithm < Base
         MSG = "This hash function is not allowed"
         UUID_V3_MSG = "uuid_v3 uses MD5, which is not allowed"
         UUID_V5_MSG = "uuid_v5 uses SHA1, which is not allowed"

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

@@ -5,7 +5,7 @@ require "rubocop"
 module RuboCop
   module Cop
     module GitHub
-      class RailsApplicationRecord < Cop
+      class RailsApplicationRecord < Base
         MSG = "Models should subclass from ApplicationRecord"
 
         def_node_matcher :active_record_base_const?, <<-PATTERN
@@ -20,7 +20,7 @@ module RuboCop
           klass, superclass, _ = *node
 
           if active_record_base_const?(superclass) && !(application_record_const?(klass))
-            add_offense(superclass, location: :expression)
+            add_offense(superclass)
           end
         end
       end

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

@@ -5,7 +5,9 @@ require "rubocop"
 module RuboCop
   module Cop
     module GitHub
-      class RailsControllerRenderActionSymbol < Cop
+      class RailsControllerRenderActionSymbol < Base
+        extend AutoCorrector
+
         MSG = "Prefer `render` with string instead of symbol"
 
         def_node_matcher :render_sym?, <<-PATTERN
@@ -22,18 +24,22 @@ module RuboCop
 
         def on_send(node)
           if sym_node = render_sym?(node)
-            add_offense(sym_node, location: :expression)
+            add_offense(sym_node) do |corrector|
+              register_offense(sym_node, node)
+            end
           elsif option_pairs = render_with_options?(node)
             option_pairs.each do |pair|
               if sym_node = action_key?(pair)
-                add_offense(sym_node, location: :expression)
+                register_offense(sym_node, node)
               end
             end
           end
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
+        private
+
+        def register_offense(sym_node, node)
+          add_offense(sym_node) do |corrector|
             corrector.replace(node.source_range, "\"#{node.children[0]}\"")
           end
         end

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

@@ -6,7 +6,7 @@ require "rubocop/cop/github/render_literal_helpers"
 module RuboCop
   module Cop
     module GitHub
-      class RailsControllerRenderLiteral < Cop
+      class RailsControllerRenderLiteral < Base
         include RenderLiteralHelpers
 
         MSG = "render must be used with a string literal or an instance of a Class"
@@ -66,29 +66,29 @@ module RuboCop
 
             if template_node = option_pairs.map { |pair| template_key?(pair) }.compact.first
               if !literal?(template_node)
-                add_offense(node, location: :expression)
+                add_offense(node)
                 return
               end
             else
-              add_offense(node, location: :expression)
+              add_offense(node)
               return
             end
 
             if layout_node = option_pairs.map { |pair| layout_key?(pair) }.compact.first
               if !literal?(layout_node)
-                add_offense(node, location: :expression)
+                add_offense(node)
                 return
               end
             end
           else
-            add_offense(node, location: :expression)
+            add_offense(node)
             return
           end
 
           if render_literal?(node)
             option_hash = node.arguments[1]
             if option_hash && !option_hash.hash_type?
-              add_offense(node, location: :expression)
+              add_offense(node)
               return
             end
             option_pairs = option_hash && option_hash.pairs
@@ -99,7 +99,7 @@ module RuboCop
           if option_pairs
             locals = option_pairs.map { |pair| locals_key?(pair) }.compact.first
             if locals && (!locals.hash_type? || !hash_with_literal_keys?(locals))
-              add_offense(node, location: :expression)
+              add_offense(node)
             end
           end
         end

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

@@ -5,7 +5,7 @@ require "rubocop"
 module RuboCop
   module Cop
     module GitHub
-      class RailsControllerRenderPathsExist < Cop
+      class RailsControllerRenderPathsExist < Base
         def_node_matcher :render?, <<-PATTERN
           (send nil? {:render :render_to_string} $...)
         PATTERN
@@ -28,7 +28,7 @@ module RuboCop
           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")
+              add_offense(node, message: "Template could not be found")
             end
           elsif pairs = render_options?(node)
             if pair = pairs.detect { |p| render_key?(p) }
@@ -37,11 +37,11 @@ module RuboCop
               case key
               when :action, :template
                 unless resolve_template(path.to_s)
-                  add_offense(node, location: :expression, message: "Template could not be found")
+                  add_offense(node, 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")
+                  add_offense(node, message: "Partial template could not be found")
                 end
               end
             end