rubocop-github 0.17.0 → 0.19.0

data/config/default_cops.yml

@@ -0,0 +1,3 @@
+GitHub/InsecureHashAlgorithm:
+  Description: 'Encourage usage of secure hash algorithms'
+  Enabled: pending

data/config/rails.yml

@@ -1,2 +1,414 @@
-# Inherit from rails_deprecated until 1.0
-inherit_from: rails_deprecated.yml
+require:
+  - rubocop-github-rails
+  - rubocop-rails
+
+GitHub/RailsApplicationRecord:
+  Enabled: true
+
+GitHub/RailsControllerRenderActionSymbol:
+  Enabled: true
+
+GitHub/RailsControllerRenderLiteral:
+  Enabled: true
+
+GitHub/RailsControllerRenderPathsExist:
+  Enabled: true
+
+GitHub/RailsControllerRenderShorthand:
+  Enabled: true
+
+GitHub/RailsRenderInline:
+  Enabled: true
+
+GitHub/RailsRenderObjectCollection:
+  Enabled: false
+
+GitHub/RailsViewRenderLiteral:
+  Enabled: true
+
+GitHub/RailsViewRenderPathsExist:
+  Enabled: true
+
+GitHub/RailsViewRenderShorthand:
+  Enabled: true
+
+Layout/BlockAlignment:
+  Exclude:
+    - app/views/**/*.erb
+
+Layout/IndentationWidth:
+  Exclude:
+    - app/views/**/*.erb
+
+Layout/InitialIndentation:
+  Exclude:
+    - app/views/**/*.erb
+
+Layout/SpaceInsideParens:
+  Exclude:
+    - app/views/**/*.erb
+
+Layout/TrailingEmptyLines:
+  Exclude:
+    - app/views/**/*.erb
+
+Layout/TrailingWhitespace:
+  Exclude:
+    - app/views/**/*.erb
+
+Lint/UselessAccessModifier:
+  ContextCreatingMethods:
+    - concerning
+
+Rails/ActionControllerTestCase:
+  Enabled: false
+
+Rails/ActionFilter:
+  Enabled: false
+
+Rails/ActiveRecordAliases:
+  Enabled: false
+
+Rails/ActiveRecordCallbacksOrder:
+  Enabled: false
+
+Rails/ActiveRecordOverride:
+  Enabled: false
+
+Rails/ActiveSupportAliases:
+  Enabled: false
+
+Rails/AddColumnIndex:
+  Enabled: false
+
+Rails/AfterCommitOverride:
+  Enabled: false
+
+Rails/ApplicationController:
+  Enabled: false
+
+Rails/ApplicationJob:
+  Enabled: false
+
+Rails/ApplicationMailer:
+  Enabled: false
+
+Rails/ApplicationRecord:
+  Enabled: false
+
+Rails/ArelStar:
+  Enabled: false
+
+Rails/AssertNot:
+  Enabled: false
+
+Rails/AttributeDefaultBlockValue:
+  Enabled: false
+
+Rails/BelongsTo:
+  Enabled: false
+
+Rails/Blank:
+  Enabled: false
+
+Rails/BulkChangeTable:
+  Enabled: false
+
+Rails/CompactBlank:
+  Enabled: false
+
+Rails/ContentTag:
+  Enabled: false
+
+Rails/CreateTableWithTimestamps:
+  Enabled: false
+
+Rails/Date:
+  Enabled: false
+
+Rails/DefaultScope:
+  Enabled: false
+
+Rails/Delegate:
+  Enabled: false
+
+Rails/DelegateAllowBlank:
+  Enabled: false
+
+Rails/DeprecatedActiveModelErrorsMethods:
+  Enabled: false
+
+Rails/DotSeparatedKeys:
+  Enabled: false
+
+Rails/DuplicateAssociation:
+  Enabled: false
+
+Rails/DuplicateScope:
+  Enabled: false
+
+Rails/DurationArithmetic:
+  Enabled: false
+
+Rails/DynamicFindBy:
+  Enabled: false
+
+Rails/EagerEvaluationLogMessage:
+  Enabled: false
+
+Rails/EnumHash:
+  Enabled: false
+
+Rails/EnumUniqueness:
+  Enabled: false
+
+Rails/EnvironmentComparison:
+  Enabled: false
+
+Rails/EnvironmentVariableAccess:
+  Enabled: false
+
+Rails/Exit:
+  Enabled: false
+
+Rails/ExpandedDateRange:
+  Enabled: false
+
+Rails/FilePath:
+  Enabled: false
+
+Rails/FindBy:
+  Enabled: false
+
+Rails/FindById:
+  Enabled: false
+
+Rails/FindEach:
+  Enabled: false
+
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+
+Rails/HelperInstanceVariable:
+  Enabled: false
+
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+Rails/HttpStatus:
+  Enabled: false
+
+Rails/I18nLazyLookup:
+  Enabled: false
+
+Rails/I18nLocaleAssignment:
+  Enabled: false
+
+Rails/I18nLocaleTexts:
+  Enabled: false
+
+Rails/IgnoredSkipActionFilterOption:
+  Enabled: false
+
+Rails/IndexBy:
+  Enabled: false
+
+Rails/IndexWith:
+  Enabled: false
+
+Rails/Inquiry:
+  Enabled: false
+
+Rails/InverseOf:
+  Enabled: false
+
+Rails/LexicallyScopedActionFilter:
+  Enabled: false
+
+Rails/LinkToBlank:
+  Enabled: false
+
+Rails/MailerName:
+  Enabled: false
+
+Rails/MatchRoute:
+  Enabled: false
+
+Rails/MigrationClassName:
+  Enabled: false
+
+Rails/NegateInclude:
+  Enabled: false
+
+Rails/NotNullColumn:
+  Enabled: false
+
+Rails/OrderById:
+  Enabled: false
+
+Rails/Output:
+  Enabled: false
+
+Rails/OutputSafety:
+  Enabled: true
+
+Rails/Pick:
+  Enabled: false
+
+Rails/Pluck:
+  Enabled: false
+
+Rails/PluckId:
+  Enabled: false
+
+Rails/PluckInWhere:
+  Enabled: false
+
+Rails/PluralizationGrammar:
+  Enabled: true
+
+Rails/Presence:
+  Enabled: false
+
+Rails/Present:
+  Enabled: false
+
+Rails/RakeEnvironment:
+  Enabled: false
+
+Rails/ReadWriteAttribute:
+  Enabled: false
+
+Rails/RedundantAllowNil:
+  Enabled: false
+
+Rails/RedundantForeignKey:
+  Enabled: false
+
+Rails/RedundantPresenceValidationOnBelongsTo:
+  Enabled: false
+
+Rails/RedundantReceiverInWithOptions:
+  Enabled: false
+
+Rails/RedundantTravelBack:
+  Enabled: false
+
+Rails/ReflectionClassName:
+  Enabled: false
+
+Rails/RefuteMethods:
+  Enabled: false
+
+Rails/RelativeDateConstant:
+  Enabled: false
+
+Rails/RenderInline:
+  Enabled: false
+
+Rails/RenderPlainText:
+  Enabled: false
+
+Rails/RequestReferer:
+  Enabled: true
+  EnforcedStyle: referrer
+
+Rails/RequireDependency:
+  Enabled: false
+
+Rails/ReversibleMigration:
+  Enabled: false
+
+Rails/ReversibleMigrationMethodDefinition:
+  Enabled: false
+
+Rails/RootJoinChain:
+  Enabled: false
+
+Rails/RootPublicPath:
+  Enabled: false
+
+Rails/SafeNavigation:
+  Enabled: false
+
+Rails/SafeNavigationWithBlank:
+  Enabled: false
+
+Rails/SaveBang:
+  Enabled: false
+
+Rails/SchemaComment:
+  Enabled: false
+
+Rails/ScopeArgs:
+  Enabled: true
+
+Rails/ShortI18n:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Rails/SquishedSQLHeredocs:
+  Enabled: false
+
+Rails/StripHeredoc:
+  Enabled: false
+
+Rails/TableNameAssignment:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+Rails/TimeZoneAssignment:
+  Enabled: false
+
+Rails/ToFormattedS:
+  Enabled: false
+
+Rails/TransactionExitStatement:
+  Enabled: false
+
+Rails/UniqBeforePluck:
+  Enabled: true
+
+Rails/UniqueValidationWithoutIndex:
+  Enabled: false
+
+Rails/UnknownEnv:
+  Enabled: false
+
+Rails/UnusedIgnoredColumns:
+  Enabled: false
+
+Rails/Validation:
+  Enabled: false
+
+Rails/WhereEquals:
+  Enabled: false
+
+Rails/WhereExists:
+  Enabled: false
+
+Rails/WhereNot:
+  Enabled: false
+
+Style/For:
+  Exclude:
+    - app/views/**/*.erb
+
+Style/OneLineConditional:
+  Exclude:
+    - app/views/**/*.erb
+
+Style/Semicolon:
+  Exclude:
+    - app/views/**/*.erb
+
+Style/StringLiterals:
+  Exclude:
+    - app/views/**/*.erb

data/config/{_rails_shared.yml → rails_cops.yml}

@@ -1,48 +1,32 @@
-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
+  Enabled: pending
 
 GitHub/RailsControllerRenderActionSymbol:
-  Enabled: true
+  Enabled: pending
   Include:
     - 'app/controllers/**/*.rb'
 
 GitHub/RailsControllerRenderLiteral:
-  Enabled: true
+  Enabled: pending
   StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-render-literal.md
   Include:
     - 'app/controllers/**/*.rb'
 
 GitHub/RailsControllerRenderPathsExist:
-  Enabled: true
+  Enabled: pending
   ViewPath:
     - 'app/views'
   Include:
     - 'app/controllers/**/*.rb'
 
 GitHub/RailsControllerRenderShorthand:
-  Enabled: true
+  Enabled: pending
   StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-controller-render-shorthand.md
   Include:
     - 'app/controllers/**/*.rb'
 
 GitHub/RailsRenderInline:
-  Enabled: true
+  Enabled: pending
   StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-controller-render-inline.md
   Include:
     - 'app/controllers/**/*.rb'
@@ -51,10 +35,10 @@ GitHub/RailsRenderInline:
     - 'app/views/**/*.erb'
 
 GitHub/RailsRenderObjectCollection:
-  Enabled: false
+  Enabled: pending
 
 GitHub/RailsViewRenderLiteral:
-  Enabled: true
+  Enabled: pending
   StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-render-literal.md
   Include:
     - 'app/helpers/**/*.rb'
@@ -62,7 +46,7 @@ GitHub/RailsViewRenderLiteral:
     - 'app/views/**/*.erb'
 
 GitHub/RailsViewRenderPathsExist:
-  Enabled: true
+  Enabled: pending
   ViewPath:
     - 'app/views'
   Include:
@@ -71,50 +55,8 @@ GitHub/RailsViewRenderPathsExist:
     - 'app/views/**/*.erb'
 
 GitHub/RailsViewRenderShorthand:
-  Enabled: true
+  Enabled: pending
   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/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