rubocop-github 0.18.0 → 0.20.0

data/config/default_cops.yml

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

data/config/default_pending.yml

@@ -0,0 +1,6 @@
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: false
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: false
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: false

data/config/rails.yml

@@ -1,127 +1,411 @@
+inherit_from:
+  - ./rails_pending.yml
+
 require:
+  - rubocop-github-rails
   - 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'
+    - "**/*.erb"
 
-Style/For:
-  Exclude:
-    - 'app/views/**/*.erb'
-
-Style/OneLineConditional:
+Layout/IndentationWidth:
   Exclude:
-    - 'app/views/**/*.erb'
+    - "**/*.erb"
 
-Style/Semicolon:
+Layout/InitialIndentation:
   Exclude:
-    - 'app/views/**/*.erb'
+    - "**/*.erb"
 
 Layout/SpaceInsideParens:
   Exclude:
-    - 'app/views/**/*.erb'
-
-Style/StringLiterals:
-  Exclude:
-    - 'app/views/**/*.erb'
+    - "**/*.erb"
 
 Layout/TrailingEmptyLines:
   Exclude:
-    - 'app/views/**/*.erb'
+    - "**/*.erb"
 
 Layout/TrailingWhitespace:
   Exclude:
-    - 'app/views/**/*.erb'
+    - "**/*.erb"
 
-Layout/IndentationWidth:
+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: true
+
+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: true
+
+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'
+    - "**/*.erb"
 
-Layout/InitialIndentation:
+Style/OneLineConditional:
   Exclude:
-    - 'app/views/**/*.erb'
+    - "**/*.erb"
 
-Lint/UselessAccessModifier:
-  ContextCreatingMethods:
-    - concerning
+Style/Semicolon:
+  Exclude:
+    - "**/*.erb"
+
+Style/StringLiterals:
+  Exclude:
+    - "**/*.erb"

data/config/rails_cops.yml

@@ -0,0 +1,50 @@
+GitHub/RailsControllerRenderActionSymbol:
+  Enabled: pending
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderLiteral:
+  Enabled: pending
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/guides/rails-render-literal.md
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderPathsExist:
+  Enabled: pending
+  ViewPath:
+    - 'app/views'
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderShorthand:
+  Enabled: pending
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/guides/rails-controller-render-shorthand.md
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsRenderObjectCollection:
+  Enabled: pending
+
+GitHub/RailsViewRenderLiteral:
+  Enabled: pending
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/guides/rails-render-literal.md
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+GitHub/RailsViewRenderPathsExist:
+  Enabled: pending
+  ViewPath:
+    - 'app/views'
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+GitHub/RailsViewRenderShorthand:
+  Enabled: pending
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'

data/config/rails_pending.yml

@@ -0,0 +1,20 @@
+Rails/ActionControllerFlashBeforeRender: # new in 2.16
+  Enabled: false
+Rails/ActionOrder: # new in 2.17
+  Enabled: false
+Rails/ActiveSupportOnLoad: # new in 2.16
+  Enabled: false
+Rails/FreezeTime: # new in 2.16
+  Enabled: false
+Rails/IgnoredColumnsAssignment: # new in 2.17
+  Enabled: false
+Rails/RootPathnameMethods: # new in 2.16
+  Enabled: false
+Rails/ToSWithArgument: # new in 2.16
+  Enabled: false
+Rails/TopLevelHashWithIndifferentAccess: # new in 2.16
+  Enabled: false
+Rails/WhereMissing: # new in 2.16
+  Enabled: false
+Rails/WhereNotWithMultipleConditions: # new in 2.17
+  Enabled: false

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

@@ -6,6 +6,8 @@ module RuboCop
   module Cop
     module GitHub
       class RailsViewRenderShorthand < Base
+        extend AutoCorrector
+
         MSG = "Prefer `render` partial shorthand"
 
         def_node_matcher :render_with_options?, <<-PATTERN
@@ -26,9 +28,13 @@ module RuboCop
             locals_key = option_pairs.map { |pair| locals_key?(pair) }.compact.first
 
             if option_pairs.length == 1 && partial_key
-              add_offense(node, message: "Use `render #{partial_key.source}` instead")
+              add_offense(node, message: "Use `render #{partial_key.source}` instead") do |corrector|
+                corrector.replace(node.source_range, "render #{partial_key.source}")
+              end
             elsif option_pairs.length == 2 && partial_key && locals_key
-              add_offense(node, message: "Use `render #{partial_key.source}, #{locals_key.source}` instead")
+              add_offense(node, message: "Use `render #{partial_key.source}, #{locals_key.source}` instead") do |corrector|
+                corrector.replace(node.source_range, "render #{partial_key.source}, #{locals_key.source}")
+              end
             end
           end
         end

data/lib/rubocop/cop/github.rb

@@ -1,13 +1,4 @@
 # frozen_string_literal: true
 
-require "rubocop/cop/github/insecure_hash_algorithm"
-require "rubocop/cop/github/rails_application_record"
-require "rubocop/cop/github/rails_controller_render_action_symbol"
-require "rubocop/cop/github/rails_controller_render_literal"
-require "rubocop/cop/github/rails_controller_render_paths_exist"
-require "rubocop/cop/github/rails_controller_render_shorthand"
-require "rubocop/cop/github/rails_render_inline"
-require "rubocop/cop/github/rails_render_object_collection"
-require "rubocop/cop/github/rails_view_render_literal"
-require "rubocop/cop/github/rails_view_render_paths_exist"
-require "rubocop/cop/github/rails_view_render_shorthand"
+require "rubocop-github"
+require "rubocop-rails"

data/lib/rubocop/github/inject.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GitHub
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration. Borrowed from:
+    # https://github.com/rubocop/rubocop-rails/blob/f36121946359615a26c9a941763abd1470693e8d/lib/rubocop/rails/inject.rb
+    module Inject
+      def self.default_defaults!
+        _load_config(CONFIG_DEFAULT)
+      end
+
+      def self.rails_defaults!
+        _load_config(CONFIG_RAILS)
+      end
+
+      def self._load_config(path)
+        path = path.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path, unset_nil: false)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/github.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module GitHub
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default_cops.yml").freeze
+    CONFIG_RAILS = PROJECT_ROOT.join("config", "rails_cops.yml").freeze
+  end
+end

data/lib/rubocop-github-rails.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rubocop/github"
+require "rubocop/github/inject"
+
+RuboCop::GitHub::Inject.rails_defaults!
+
+require "rubocop/cop/github/rails_controller_render_action_symbol"
+require "rubocop/cop/github/rails_controller_render_literal"
+require "rubocop/cop/github/rails_controller_render_paths_exist"
+require "rubocop/cop/github/rails_controller_render_shorthand"
+require "rubocop/cop/github/rails_render_object_collection"
+require "rubocop/cop/github/rails_view_render_literal"
+require "rubocop/cop/github/rails_view_render_paths_exist"
+require "rubocop/cop/github/rails_view_render_shorthand"

data/lib/rubocop-github.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rubocop/github"
+require "rubocop/github/inject"
+
+RuboCop::GitHub::Inject.default_defaults!
+
+require "rubocop/cop/github/insecure_hash_algorithm"