rubocop-hk 1.0.9

data/config/rubocop-rails.yml

@@ -0,0 +1,374 @@
+# Rails 6-8.x Configuration - Modern Best Practices for 2025
+# Optimized for Rails 6.0-8.0+ applications with backward compatibility
+
+# ==========================================
+# Core Rails Cops - Compatible with Rails 6-8.x
+# ==========================================
+
+Rails/ActionControllerFlashBeforeRender:
+  Description: Checks for calls to flash before render in controller actions
+  Enabled: true
+
+Rails/ActionControllerTestCase:
+  Description: Use ActionDispatch::IntegrationTest instead of ActionController::TestCase
+  Enabled: true
+
+Rails/ActiveRecordAliases:
+  Description: Avoid deprecated ActiveRecord aliases
+  Enabled: true
+
+Rails/ActiveRecordCallbacksOrder:
+  Description: Enforce consistent ordering of ActiveRecord callbacks
+  Enabled: true
+
+Rails/ActiveSupportAliases:
+  Description: Avoid deprecated ActiveSupport aliases
+  Enabled: true
+
+Rails/ApplicationController:
+  Description: Controllers should inherit from ApplicationController
+  Enabled: true
+
+Rails/ApplicationRecord:
+  Description: Models should inherit from ApplicationRecord
+  Enabled: true
+
+Rails/BelongsTo:
+  Description: Use belongs_to associations correctly
+  Enabled: true
+
+Rails/BulkChangeTable:
+  Description: Use change_table with bulk operations for multiple column changes
+  Enabled: true
+
+Rails/CreateTableWithTimestamps:
+  Description: Always add timestamps to new tables
+  Enabled: true
+
+Rails/Date:
+  Description: Use Rails time zone methods instead of Date methods
+  Enabled: true
+
+Rails/DefaultScope:
+  Description: Avoid using default_scope in ActiveRecord models
+  Enabled: true
+  Severity: warning
+
+Rails/Delegate:
+  Description: Prefer delegate method for object delegation
+  Enabled: true
+  EnforceForPrefixed: true
+
+Rails/DynamicFindBy:
+  Description: Use find_by instead of dynamic finders
+  Enabled: true
+
+Rails/EnumHash:
+  Description: Use hash syntax for enums instead of array syntax
+  Enabled: true
+
+Rails/EnumUniqueness:
+  Description: Ensure enum values are unique
+  Enabled: true
+
+Rails/EnvironmentComparison:
+  Description: Prefer Rails.env methods over string comparisons
+  Enabled: true
+
+Rails/Exit:
+  Description: Favor exit! in Rails applications
+  Enabled: true
+
+Rails/FilePath:
+  Description: Use Rails.root.join for file path construction
+  Enabled: true
+  EnforcedStyle: arguments
+
+Rails/FindBy:
+  Description: Prefer find_by over where.first
+  Enabled: true
+
+Rails/FindEach:
+  Description: Use find_each instead of each for large datasets
+  Enabled: true
+
+Rails/HasAndBelongsToMany:
+  Description: Prefer has_many :through over has_and_belongs_to_many
+  Enabled: true
+
+Rails/HasManyOrHasOneDependent:
+  Description: Always specify dependent option for has_many/has_one associations
+  Enabled: true
+
+Rails/HelperInstanceVariable:
+  Description: Avoid instance variables in helpers
+  Enabled: true
+
+Rails/HttpPositionalArguments:
+  Description: Use keyword arguments for HTTP request methods in tests
+  Enabled: true
+
+Rails/HttpStatus:
+  Description: Use symbolic HTTP status codes
+  Enabled: true
+  EnforcedStyle: symbolic
+
+Rails/I18nLocaleTexts:
+  Description: Move locale texts to locale files
+  Enabled: true
+
+Rails/IndexBy:
+  Description: Use index_by instead of manually building hashes
+  Enabled: true
+
+Rails/IndexWith:
+  Description: Use index_with instead of manually building hashes with same values
+  Enabled: true
+
+Rails/InverseOf:
+  Description: Specify inverse_of for associations to improve performance
+  Enabled: true
+
+Rails/LexicallyScopedActionFilter:
+  Description: Avoid lexically scoped action filters
+  Enabled: true
+
+Rails/LinkToBlank:
+  Description: Add rel="noopener" when using target="_blank" in links
+  Enabled: true
+
+Rails/MailerName:
+  Description: Mailer class names should end with 'Mailer'
+  Enabled: true
+
+Rails/MatchRoute:
+  Description: Avoid using match with :via option in routes
+  Enabled: true
+
+Rails/NegateInclude:
+  Description: Use exclude? instead of !include?
+  Enabled: true
+
+Rails/NotNullColumn:
+  Description: Add NOT NULL constraint to columns that should not be null
+  Enabled: true
+
+Rails/OrderById:
+  Description: Specify explicit order when using first/last/take
+  Enabled: true
+
+Rails/Output:
+  Description: Avoid puts/p in production code
+  Enabled: true
+  Include:
+    - app/**/*.rb
+    - lib/**/*.rb
+  Exclude:
+    - db/seeds.rb
+    - lib/tasks/**/*.rb
+
+Rails/OutputSafety:
+  Description: Avoid bypassing Rails output safety mechanisms
+  Enabled: true
+
+Rails/Pick:
+  Description: Use pick instead of pluck().first
+  Enabled: true
+
+Rails/PluckInWhere:
+  Description: Use exists? instead of pluck in where clauses
+  Enabled: true
+
+Rails/Presence:
+  Description: Use presence method for conditional assignments
+  Enabled: true
+
+Rails/Present:
+  Description: Use present? instead of !blank?
+  Enabled: true
+
+Rails/RedundantAllowNil:
+  Description: Avoid redundant allow_nil option
+  Enabled: true
+
+Rails/RedundantForeignKey:
+  Description: Avoid redundant foreign_key option
+  Enabled: true
+
+Rails/RedundantPresenceValidationOnBelongsTo:
+  Description: Avoid redundant presence validation on belongs_to associations
+  Enabled: true
+
+Rails/RedundantReceiverInWithOptions:
+  Description: Avoid redundant receiver in with_options block
+  Enabled: true
+
+Rails/ReflectionClassName:
+  Description: Use string class names in associations for better performance
+  Enabled: true
+
+Rails/RelativeDateConstant:
+  Description: Avoid using relative date constants
+  Enabled: true
+
+Rails/RenderInline:
+  Description: Avoid inline rendering in controllers
+  Enabled: true
+
+Rails/RenderPlainText:
+  Description: Use render plain instead of render text
+  Enabled: true
+
+Rails/RequestReferer:
+  Description: Use request.referer instead of request.referrer
+  Enabled: true
+
+Rails/ReversibleMigration:
+  Description: Ensure migrations are reversible
+  Enabled: true
+
+Rails/SafeNavigation:
+  Description: Use safe navigation instead of try!
+  Enabled: true
+
+Rails/SafeNavigationWithBlank:
+  Description: Avoid safe navigation with blank?
+  Enabled: true
+
+Rails/ScopeArgs:
+  Description: Use lambda for scope arguments
+  Enabled: true
+
+Rails/ShortI18n:
+  Description: Use short I18n methods (t instead of translate)
+  Enabled: true
+
+Rails/SkipsModelValidations:
+  Description: Avoid methods that skip model validations
+  Enabled: true
+  ForbiddenMethods:
+    - decrement!
+    - decrement_counter
+    - increment!
+    - increment_counter
+    - toggle!
+    - touch
+    - touch_all
+    - update_all
+    - update_attribute
+    - update_column
+    - update_columns
+    - update_counters
+  Exclude:
+    - spec/**/*
+    - test/**/*
+    - db/migrate/**/*
+
+Rails/SquishedSQLHeredocs:
+  Description: Use squiggly heredocs for SQL
+  Enabled: true
+
+Rails/StripHeredoc:
+  Description: Use strip_heredoc for multi-line strings
+  Enabled: true
+
+Rails/TimeZone:
+  Description: Use Rails time zone methods
+  Enabled: true
+
+Rails/TimeZoneAssignment:
+  Description: Use Time.zone= for setting time zone
+  Enabled: true
+
+Rails/UnknownEnv:
+  Description: Avoid unknown Rails environments
+  Enabled: true
+  Environments:
+    - development
+    - test
+    - production
+    - staging
+
+Rails/UnusedIgnoredColumns:
+  Description: Remove unused ignored columns
+  Enabled: true
+
+Rails/Validation:
+  Description: Use validates instead of validate with custom validator
+  Enabled: true
+
+Rails/WhereEquals:
+  Description: Use where with hash conditions instead of SQL strings
+  Enabled: true
+
+Rails/WhereExists:
+  Description: Use exists instead of where with present check
+  Enabled: true
+
+Rails/WhereNot:
+  Description: Use where.not instead of where with negation
+  Enabled: true
+
+Rails/WhereMissing:
+  Description: Use where.missing instead of left joins with null checks
+  Enabled: true
+
+# ==========================================
+# Rails 7.0+ Enhanced Cops (where available)
+# ==========================================
+
+Rails/CompactBlank:
+  Description: Use compact_blank instead of reject(&:blank?)
+  Enabled: true
+
+Rails/DuplicateAssociation:
+  Description: Avoid duplicate associations in models
+  Enabled: true
+
+Rails/DuplicateScope:
+  Description: Avoid duplicate scopes in models
+  Enabled: true
+
+Rails/ExpandedDateRange:
+  Description: Use Range#cover? instead of Range#include? for date ranges
+  Enabled: true
+
+Rails/I18nLazyLookup:
+  Description: Use lazy lookup for I18n keys in controllers and views
+  Enabled: true
+
+Rails/Inquiry:
+  Description: Use ActiveSupport::StringInquirer for string inquiry methods
+  Enabled: true
+
+Rails/PluralizationGrammar:
+  Description: Use correct pluralization grammar
+  Enabled: true
+
+Rails/ResponseParsedBody:
+  Description: Use response.parsed_body in tests
+  Enabled: true
+
+Rails/RootJoinChain:
+  Description: Use Rails.root.join for multiple path segments
+  Enabled: true
+
+Rails/ToFormattedS:
+  Description: Use to_formatted_s instead of to_s with format
+  Enabled: true
+
+Rails/ToSWithArgument:
+  Description: Use to_formatted_s instead of to_s with argument
+  Enabled: true
+
+Rails/TopLevelHashWithIndifferentAccess:
+  Description: Avoid top-level HashWithIndifferentAccess
+  Enabled: true
+
+Rails/TransactionExitStatement:
+  Description: Avoid transaction exit statements
+  Enabled: true
+
+Rails/UniqueValidationWithoutIndex:
+  Description: Add database index for unique validations
+  Enabled: true

data/config/rubocop-rspec.yml

@@ -0,0 +1,29 @@
+RSpec/AnyInstance:
+  Description: Check that instances are not being stubbed globally.
+    Prefer instance doubles over stubbing any instance of a class
+  Enabled: false
+
+RSpec/ContextWording:
+  Description: Checks that context docstring starts with an allowed prefix.
+  Enabled: true
+  Prefixes:
+    - when
+    - with
+    - without
+    - and # custom
+
+RSpec/ExampleLength:
+  Description: Checks for long examples.
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Description: Checks if examples contain too many expect calls.
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Description: Checks if example groups contain too many let and subject calls.
+  Enabled: false
+
+RSpec/NestedGroups:
+  Description: Checks for nested example groups.
+  Enabled: false

data/config/rubocop-style.yml

@@ -0,0 +1,197 @@
+Style/AndOr:
+  Description: Use &&/|| instead of and/or.
+  Enabled: true
+  EnforcedStyle: always
+  SupportedStyles:
+  - always
+  - conditionals
+
+Style/ClassAndModuleChildren:
+  Description: Checks the style of children definitions at classes and modules.
+  Enabled: true
+  EnforcedStyle: nested
+
+Style/ColonMethodCall:
+  Description: Checks for methods invoked via the operator instead of the . operator
+  Enabled: true
+
+Style/DefWithParentheses:
+  Description: Checks for parentheses in the definition of a method, that does not take any
+    arguments.
+  Enabled: true
+
+Style/DisableCopsWithinSourceCodeDirective:
+  Description: Detects comments to enable/disable RuboCop. This is useful if want to make sure that every RuboCop error gets fixed and not quickly disabled with a comment.
+  Enabled: true
+  AllowedCops:
+  - Layout/ArgumentAlignment
+  - Layout/ArrayAlignment
+  - Layout/HashAlignment
+  - Layout/IndentationConsistency
+  - Layout/IndentationWidth
+  - Layout/LineLength
+  - Layout/MultilineArrayBraceLayout
+  - Lint/DuplicateMethods
+  - Lint/RescueException
+  - Lint/UnusedMethodArgument
+  - Lint/UselessAssignment
+  - Lint/Void
+  - Metrics/BlockNesting
+  - Metrics/ClassLength
+  - Metrics/CyclomaticComplexity
+  - Metrics/ModuleLength
+  - Metrics/ParameterLists
+  - Metrics/PerceivedComplexity
+  - Naming/AccessorMethodName
+  - Naming/PredicateName
+  - Naming/VariableNumber
+  - Rails/ApplicationController
+  - Rails/FilePath
+  - Rails/HasManyOrHasOneDependent
+  - Rails/InverseOf
+  - Rails/OutputSafety
+  - Rails/UniqueValidationWithoutIndex
+  - RSpec/BeforeAfterAll
+  - RSpec/DescribeClass
+  - RSpec/DescribedClass
+  - RSpec/EmptyLineAfterFinalLet
+  - RSpec/ExampleLength
+  - RSpec/FilePath
+  - RSpec/ImplicitExpect
+  - RSpec/ImplicitSubject
+  - RSpec/InstanceVariable
+  - RSpec/LeadingSubject
+  - RSpec/LetSetup
+  - RSpec/MessageChain
+  - RSpec/MessageSpies
+  - RSpec/MultipleExpectations
+  - RSpec/NamedSubject
+  - RSpec/PredicateMatcher
+  - RSpec/StubbedMock
+  - RSpec/SubjectStub
+  - RSpec/VerifiedDoubles
+  - Security/Open
+  - Style/AccessModifierDeclarations
+  - Style/CaseLikeIf
+  - Style/Documentation
+  - Style/DoubleNegation
+  - Style/GlobalVars
+  - Style/GuardClause
+  - Style/IfUnlessModifier
+  - Style/OptionalBooleanParameter
+  - Style/RedundantBegin
+  - Style/RescueModifier
+  - Style/SignalException
+  - Style/StringConcatenation
+  - Style/SymbolArray
+  - Style/WordArray
+
+
+
+Style/FrozenStringLiteralComment:
+  Description: Add the frozen_string_literal comment to the top of files to help transition
+    from Ruby 2.3.0 to Ruby 3.0. Enabled for Ruby 3.1+ performance benefits.
+  Enabled: true
+  EnforcedStyle: always_true
+  SupportedStyles:
+  - always
+  - always_true
+  - never
+  # Only require in Ruby 3.0+ projects for performance benefits
+  Include:
+    - "**/*.rb"
+  Exclude:
+    - "bin/**/*"
+    - "config/boot.rb"
+    - "db/migrate/**/*"
+
+Style/HashSyntax:
+  Description: Checks hash literal syntax
+  Enabled: true
+  EnforcedStyle: ruby19
+  UseHashRocketsWithSymbolValues: false
+  PreferHashRocketsForNonAlnumEndingSymbols: false
+  SupportedStyles:
+  - ruby19
+  - hash_rockets
+  - no_mixed_keys
+  - ruby19_no_mixed_keys
+
+Style/MethodDefParentheses:
+  Description: Checks if the method definitions have or don't have parentheses.
+  Enabled: true
+  EnforcedStyle: require_parentheses
+  SupportedStyles:
+  - require_parentheses
+  - require_no_parentheses
+  - require_no_parentheses_except_multiline
+
+Style/NumericLiterals:
+  Description: Checks for big numeric literals without _ between groups of digits in them
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  Description: Checks for the presence of superfluous parentheses around the condition of
+    if/unless/while/until.
+  Enabled: true
+  AllowSafeAssignment: true
+  AllowInMultilineConditions: false
+
+Style/RedundantBegin:
+  Description: Checks for redundant begin blocks.
+  Enabled: true
+
+Style/RedundantFreeze:
+  Description: Checks usages of Object#freeze on immutable objects.
+  Enabled: true
+
+Style/RedundantPercentQ:
+  Description: Checks for %q/%Q when single quotes or double quotes would do.
+  Enabled: true
+
+Style/RedundantReturn:
+  Description: Checks for redundant return expressions.
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/RegexpLiteral:
+  Description: Use / or %r around regular expressions.
+  Enabled: true
+  EnforcedStyle: slashes
+  AllowInnerSlashes: false
+  SupportedStyles:
+  - slashes
+  - percent_r
+  - mixed
+
+Style/Semicolon:
+  Description: Checks for multiple expressions placed on the same line. It also checks for lines
+    terminated with a semicolon.
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  Enabled: true
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/TrailingCommaInArrayLiteral:
+  Description: Checks for trailing comma in array literals
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Description: Checks for trailing comma in hash literals
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrivialAccessors:
+  Description: Checks for trivial reader/writer methods, that c`ould have been created with the
+    attr_* family of functions automatically.
+  Enabled: true
+  ExactNameMatch: true
+  AllowPredicates: true
+  AllowDSLWriters: true
+  IgnoreClassMethods: false
+

data/lib/rubocop/hk/command.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "thor"
+
+require "rubocop/hk"
+
+module Rubocop
+  module Hk
+    ##
+    # CLI entry point for commands
+    #
+    class Command < Thor
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "version", "Get the version of rubocop-hk"
+      option :plain, type: :boolean, default: false, aliases: ["-p"]
+      def version
+        return puts Rubocop::Hk::VERSION if options[:plain]
+
+        puts "rubocop-hk version: #{Rubocop::Hk::VERSION}"
+      end
+      map ["-v", "--version"] => :version
+    end
+  end
+end

data/lib/rubocop/hk/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Hk
+    VERSION = "1.0.9"
+  end
+end

data/lib/rubocop/hk.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "hk/version"
+
+module Rubocop
+  module Hk
+    class Error < StandardError; end
+  end
+end