rubocop-eightyfourcodes 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2337a72314ad6423017df81a2dcf8f83013dc6e873fd69b5125378182721640
-  data.tar.gz: b32af92eabaeea8c0d9d87f65bfdcbc7143dfe57721a389ad1c883f287134559
+  metadata.gz: aa3ad3b979562574a7c92e3b9b3ac4f6eb4cfb64f620839dce5d93db95bb659f
+  data.tar.gz: eee72657e11b56238aef21b80d695e76189d426d78f8938757e4c87917a99f48
 SHA512:
-  metadata.gz: af6326b9251b078270670d986af36041e0af768bb69d29ba9e960f0663dc420444e333057b886714c4184ac1201624d2ab0cd34f5b1425860f70c9e0b666c747
-  data.tar.gz: 84565456b4a0c98c085ec35f86da4bd4765a399b822068d6a51df0129ab786dc0ba97a147e221b187a48b3690bb130cc77592b035c447f6da92aaf8e48c50efc
+  metadata.gz: 5bba1819cb2375c2e16f70c04d8ccc2e3ac9d63259fc83b7e0cae0e945830f7bc733e9bee610659f1cf98cb4ed5a390623e53e76b5818f728b075f87450b2865
+  data.tar.gz: db89032a12f8a23765ccce1bb8bae4ed05f131a9c3f1b6ec47e451832465e8bc7b61bf3472e60a2d7549593d31999cd37f764dbb8648c25cc4e78be2b1ea883a

data/README.md

@@ -28,6 +28,13 @@ require: rubocop-eightyfourcodes
 Now you can run `rubocop` and it will automatically load the RuboCop eightyfourcodes
 cops together with the standard cops.
 
+To use the `eightyfourcodes` RuboCop config:
+
+```yaml
+inherit_gem:
+  rubocop-eightyfourcodes: config/eightyfourcodes.yml
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -36,7 +43,40 @@ Use `bundle exec rake 'new_cop[EightyFourCodes/CommandLiteralInjection]'` to gen
 
 The [NodePattern Debugger](https://nodepattern.herokuapp.com/) is a very helpful resource when creating new AST matchers.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+If you need to try out this gem in a project using it, before releasing a new version, you can do the following in the project:
+
+```ruby
+gem "rubocop-eightyfourcodes", **(ENV["LOCAL_RUBOCOP84"] ? { path: ENV["LOCAL_RUBOCOP84"] } : {})
+```
+
+Then try it like this:
+
+```shell
+LOCAL_RUBOCOP84=~/repos/rubocop-eightyfourcodes bundle install
+LOCAL_RUBOCOP84=~/repos/rubocop-eightyfourcodes bundle exec rubocop
+```
+
+## Releasing
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, in a commit or pull request.
+
+Create and push a new signed git tag, the `git:tag` rake task will use the version from `version.rb`.
+
+```shell
+rake git:tag
+git push --tags
+```
+
+This will trigger GitHub Actions to build and push the gem to [RubyGems.org](https://rubygems.org/gems/rubocop-eightyfourcodes).
+
+If the release workflow fails, you can re-run it by deleting the tag and pushing it again.
+
+```shell
+git push --delete origin v<VERSION>
+```
 
 ## Contributing
 

data/config/eightyfourcodes.yml

@@ -0,0 +1,143 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-sequel
+
+require:
+  - rubocop-eightyfourcodes
+
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+
+### Metrics
+
+Metrics/ClassLength:
+  Max: 300
+  CountAsOne: ["array", "hash", "heredoc", "method_call"]
+
+Metrics/ModuleLength:
+  Max: 300
+  CountAsOne: ["array", "hash", "heredoc", "method_call"]
+
+Metrics/MethodLength:
+  Max: 50
+  CountAsOne: ["array", "hash", "heredoc", "method_call"]
+
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/BlockLength:
+  Max: 200
+  AllowedMethods:
+    - refine
+    - describe
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+### Lint
+
+Lint/DuplicateBranch:
+  IgnoreDuplicateElseBranch: true
+  IgnoreLiteralBranches: true
+  IgnoreConstantBranches: true
+
+Lint/UselessConstantScoping:
+  # Increases indirection and reduces readability. We often don't care about constant scoping.
+  Enabled: false
+
+### Style
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  AllowConsecutiveConditionals: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/MethodCallWithArgsParentheses:
+  AllowParenthesesInMultilineCall: true
+  AllowParenthesesInChaining: true
+  AllowParenthesesInCamelCaseMethod: true
+  AllowParenthesesInStringInterpolation: true
+  AllowedMethods: ["puts", "print"]
+  AllowedPatterns: ["^assert"]
+
+Style/ClassVars:
+  # We use them quite a lot, and the "good" alternative is not so nice.
+  # Need a targeted effort to refactor our codebase to get rid of them.
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: always
+
+### Layout
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/LineLength:
+  URISchemes: ["http", "https", "amqp", "amqps"]
+  AllowedPatterns:
+    - '^\s*puts(\s|\()'
+    - '^\s*print(\s|\()'
+    - '^\s*@?log(ger)?[\s\(\.]'
+    - '^\s*LOG(GER)?[\s\(\.]'
+    - '^\s*debug[\s\(]'
+    - '^\s*\#'
+
+### Performance
+
+Performance/RedundantMerge:
+  MaxKeyValuePairs: 1
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: false
+
+Performance/ChainArrayAllocation:
+  Enabled: false
+
+### Naming
+
+Naming/MethodParameterName:
+  MinNameLength: 1
+
+Naming/PredicateMethod:
+  AllowBangMethods: true
+
+### Security
+
+GitlabSecurity/JsonSerialization:
+  Enabled: false
+
+### Minitest
+
+Minitest/GlobalExpectations:
+  EnforcedStyle: _
+
+Minitest/MultipleAssertions:
+  Enabled: true
+
+# Sequel
+
+Sequel/SaveChanges:
+  Enabled: false
+
+Sequel/IrreversibleMigration:
+  Enabled: false

data/lib/rubocop/cop/eighty_four_codes/ensure_redirect.rb

@@ -33,11 +33,11 @@ module RuboCop
       #     cleanup
       #   end
       class EnsureRedirect < Base
-        MSG = 'Do not redirect from an `ensure` block.'
+        MSG = "Do not redirect from an `ensure` block."
 
         def on_ensure(node)
           # `:send` nodes represent method calls, so we look for send nodes and then check if they are `redirect`
-          node.body&.each_node(:send) do |send_node|
+          node.branch&.each_node(:send) do |send_node|
             # Check if the method name being called is `redirect`
             add_offense(send_node) if send_node.method?(:redirect)
           end

data/lib/rubocop/cop/eighty_four_codes/ruby_version_file.rb

@@ -28,12 +28,12 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless File.basename(processed_source.file_path).eql?('Gemfile')
+          return unless File.basename(processed_source.file_path).eql?("Gemfile")
 
           static_version_found?(node) do |source_node, source|
-            message = format(MSG, source: source)
+            message = format(MSG, source:)
 
-            add_offense(source_node, message: message) do |corrector|
+            add_offense(source_node, message:) do |corrector|
               corrector.replace(source_node, "File.read('.ruby-version')")
             end
           end

data/lib/rubocop/cop/eightyfourcodes_cops.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'eighty_four_codes/command_literal_injection'
-require_relative 'eighty_four_codes/ensure_redirect'
-require_relative 'eighty_four_codes/ruby_version_file'
+require_relative "eighty_four_codes/command_literal_injection"
+require_relative "eighty_four_codes/ensure_redirect"
+require_relative "eighty_four_codes/ruby_version_file"
 
-require_relative 'gitlab_security/json_serialization'
-require_relative 'gitlab_security/public_send'
-require_relative 'gitlab_security/redirect_to_params_update'
-require_relative 'gitlab_security/send_file_params'
-require_relative 'gitlab_security/sql_injection'
-require_relative 'gitlab_security/system_command_injection'
+require_relative "gitlab_security/json_serialization"
+require_relative "gitlab_security/public_send"
+require_relative "gitlab_security/redirect_to_params_update"
+require_relative "gitlab_security/send_file_params"
+require_relative "gitlab_security/sql_injection"
+require_relative "gitlab_security/system_command_injection"

data/lib/rubocop/eightyfourcodes/inject.rb

@@ -9,7 +9,7 @@ module RuboCop
     module Inject
       def self.defaults!
         path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        hash = ConfigLoader.send(:load_yaml_configuration, path) # rubocop:disable GitlabSecurity/PublicSend
         config = Config.new(hash, path).tap(&:make_excludes_absolute)
         puts "configuration from #{path}" if ConfigLoader.debug?
         config = ConfigLoader.merge_with_default(config, path)

data/lib/rubocop/eightyfourcodes/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module EightyFourCodes
-    VERSION = '0.0.4'
+    VERSION = "0.0.6"
   end
 end

data/lib/rubocop/eightyfourcodes.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'eightyfourcodes/version'
+require_relative "eightyfourcodes/version"
 
 module RuboCop
   # Namespace for EightyFourCodes cops
   module EightyFourCodes
     class Error < StandardError; end
     PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
     CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)

data/lib/rubocop-eightyfourcodes.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
-require_relative 'rubocop/eightyfourcodes'
-require_relative 'rubocop/eightyfourcodes/version'
-require_relative 'rubocop/eightyfourcodes/inject'
+require_relative "rubocop/eightyfourcodes"
+require_relative "rubocop/eightyfourcodes/version"
+require_relative "rubocop/eightyfourcodes/inject"
 
 RuboCop::EightyFourCodes::Inject.defaults!
 
-require_relative 'rubocop/cop/eightyfourcodes_cops'
+require_relative "rubocop/cop/eightyfourcodes_cops"

metadata

@@ -1,18 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-eightyfourcodes
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
-- Anders Bälter
+- 84codes
 bindir: bin
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.69.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -20,29 +23,83 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.69.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'A plugin for the RuboCop code style enforcing & linting tool.
 
   '
 email:
-- anders@84codes.com
+- developers@84codes.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.md
 - README.md
 files:
-- ".rspec"
-- ".rubocop.yml"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
-- Rakefile
 - config/default.yml
+- config/eightyfourcodes.yml
 - lib/rubocop-eightyfourcodes.rb
 - lib/rubocop/cop/eighty_four_codes/command_literal_injection.rb
 - lib/rubocop/cop/eighty_four_codes/ensure_redirect.rb
@@ -58,9 +115,7 @@ files:
 - lib/rubocop/eightyfourcodes.rb
 - lib/rubocop/eightyfourcodes/inject.rb
 - lib/rubocop/eightyfourcodes/version.rb
-- rubocop-eightyfourcodes.gemspec
-- sig/rubocop/eightyfourcodes.rbs
-homepage: https://github.com/84codes/rubocop-eightyfourcodes/
+homepage: https://github.com/84codes/rubocop-eightyfourcodes
 licenses:
 - MIT
 metadata:
@@ -72,14 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: This is a collection of cops developed and used by 84codes AB.
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,16 +0,0 @@
-plugins:
-  - rubocop-rspec
-  - rubocop-rake
-
-AllCops:
-  NewCops: enable
-  Exclude:
-    - 'lib/rubocop/cop/gitlab_security/*.rb'
-    - 'spec/rubocop/cop/gitlab_security/*.rb'
-    # avoid linting installed gems when running in GitHub Actions
-    - '**/vendor/bundle/**/*' 
-Naming/FileName:
-  Exclude:
-    - lib/rubocop-eightyfourcodes.rb
-RSpec/ExampleLength:
-  Max: 10

data/CHANGELOG.md

@@ -1,15 +0,0 @@
-# Changelog
-
-## 0.0.3 (2024-10-23)
-
-- Recreated entire project using <https://github.com/rubocop/rubocop-extension-generator>
-- Added `EnsureRedirect`
-
-## 0.0.2 (2020-09-24)
-
-- Added `RubyVersionFile`: Ensure we read Gemfile ruby version from `.ruby-version` file
-
-## 0.0.1 (2019-09-11)
-
-- Forked from gitlab-security
-- Added `CommandLiteralInjection`: Passing user input to `` and %x without sanitization and parameterization can result in command injection)

data/Gemfile

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rubocop-eightyfourcodes.gemspec
-gemspec
-
-group :development, :test do
-  gem 'rake'
-  gem 'rspec'
-  gem 'rubocop'
-  gem 'rubocop-rake'
-  gem 'rubocop-rspec'
-  gem 'yard'
-end

data/Gemfile.lock

@@ -1,75 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rubocop-eightyfourcodes (0.0.4)
-      rubocop (< 2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.6.0)
-    json (2.10.2)
-    language_server-protocol (3.17.0.4)
-    lint_roller (1.1.0)
-    parallel (1.26.3)
-    parser (3.3.7.1)
-      ast (~> 2.4.1)
-      racc
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.10.0)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    rubocop (1.74.0)
-      json (~> 2.3)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.40.0)
-      parser (>= 3.3.1.0)
-    rubocop-rake (0.7.1)
-      lint_roller (~> 1.1)
-      rubocop (>= 1.72.1)
-    rubocop-rspec (3.5.0)
-      lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
-    ruby-progressbar (1.13.0)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    yard (0.9.37)
-
-PLATFORMS
-  arm64-darwin-23
-  ruby
-
-DEPENDENCIES
-  rake
-  rspec
-  rubocop
-  rubocop-eightyfourcodes!
-  rubocop-rake
-  rubocop-rspec
-  yard
-
-BUNDLED WITH
-   2.6.4

data/Rakefile

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-desc 'Generate a new cop with a template'
-task :new_cop, [:cop] do |_task, args|
-  require 'rubocop'
-
-  cop_name = args.fetch(:cop) do
-    warn 'usage: bundle exec rake new_cop[Department/Name]'
-    exit!
-  end
-
-  generator = RuboCop::Cop::Generator.new(cop_name)
-
-  generator.write_source
-  generator.write_spec
-  generator.inject_require(root_file_path: 'lib/rubocop/cop/eightyfourcodes_cops.rb')
-  generator.inject_config(config_file_path: 'config/default.yml')
-
-  puts generator.todo
-end

data/rubocop-eightyfourcodes.gemspec

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/rubocop/eightyfourcodes/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'rubocop-eightyfourcodes'
-  spec.version = RuboCop::EightyFourCodes::VERSION
-  spec.authors = ['Anders Bälter']
-  spec.email = ['anders@84codes.com']
-
-  spec.summary = 'This is a collection of cops developed and used by 84codes AB.'
-  spec.description = <<~DESCRIPTION
-    A plugin for the RuboCop code style enforcing & linting tool.
-  DESCRIPTION
-  spec.homepage = 'https://github.com/84codes/rubocop-eightyfourcodes/'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
-
-  spec.metadata = {
-    'rubygems_mfa_required' => 'true'
-  }
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
-    end
-  end
-
-  spec.require_paths = ['lib']
-  spec.add_dependency 'rubocop', '< 2'
-  spec.extra_rdoc_files = ['LICENSE.md', 'README.md']
-end

data/sig/rubocop/eightyfourcodes.rbs

@@ -1,6 +0,0 @@
-module Rubocop
-  module EightyFourCodes
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end