rubocop-petal 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7943295b53d5afb66efeedd6b5801405d67f41ca3e87cbe80afe6310e8dfa65a
-  data.tar.gz: 2ee305587c6e13494669395c45ce9e405d902ca3a05727f9fac28858af800c0e
+  metadata.gz: f457dc147b37b31a89fc5f511560442983a438b191e5723fe95d981f8cb32e91
+  data.tar.gz: 197112fd588a74778acc75c2d0da8238dcc4681c49636b5ed7a543728b0abe97
 SHA512:
-  metadata.gz: db9b94e57d4ce9c6656488786e91c7a9f89d71b93e7ee816535610a2877b2e2a29ffbec578c2f97eec195b68e5d86e54d35a27208b23986a46956a2b034b5817
-  data.tar.gz: 9bff7fea4ee7d6df84a93f6acac7518591fbe6a75dda9ba2b9fd8a894ce305c028076e1c7bd9e3bf5cf4b5ae03d82c01ca594df4218eda7b6ad12e1860c867b7
+  metadata.gz: a455e3b3db660c5fa02a148263582aee5e82ad561638d8094f2beff087c08eb0e8414e45f2eccd4f1bbaa7d8740e41317fb5421dea0a9e39a41fbc947cb65f49
+  data.tar.gz: f89c1da3350fccba89c879092bfb8734f2a903714017cf177e24183a3bb44864c86c90ab1648bb9a5cf8cf0f0347b7dc2f4bfdebb139a684ac9a45b7af5676a7

data/config/default.yml

@@ -77,3 +77,14 @@ Rails/TableName:
 Chewy/ResetOnType:
   Description: 'Prevent using reset! methods on Chewy type class'
   Enabled: true
+
+RSpec/JsonResponse:
+  Description: 'Prevent json_response in favor of response.parsed_body'
+  Enabled: true
+  SafeAutoCorrect: true
+  Include:
+    - spec/**/*
+
+Performance/Snif:
+  Description: 'Prevent snif in favor of detect'
+  Enabled: true

data/lib/rubocop/cop/performance/snif.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # Prevent using `snif`.
+      # Consider using `detect`.
+      #
+      # @example
+      #   # bad
+      #   period.equity_packs.snif(:code, 'ONCALL')
+      #
+      #   # good
+      #   period.equity_packs.detect { |equity_pack| equity_pack.code == 'ONCALL' }
+      class Snif < Base
+        MSG = 'Use `detect` instead.'
+
+        def_node_matcher :snif?, <<~PATTERN
+          (send _ :snif _ _)
+        PATTERN
+
+        def on_send(node)
+          return unless snif?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/json_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Prevent using `json_response` in spec.
+      # Consider using `response.parsed_body`.
+      #
+      # @example
+      #   # bad
+      #   expect(json_response)
+      #
+      #   # good
+      #   expect(response.parsed_body)
+      #
+      class JsonResponse < Base
+        extend AutoCorrector
+
+        MSG = 'Use `response.parsed_body` instead.'
+
+        def_node_matcher :json_response?, <<~PATTERN
+          (send _ :json_response)
+        PATTERN
+
+        def on_send(node)
+          return unless json_response?(node)
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, 'response.parsed_body')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/sidekiq_inline.rb

@@ -7,19 +7,21 @@ module RuboCop
       # The method will execute inline every perform_async called.
       # Must likely a spec want to test a specific worker and called it.
       # If you don't need to execute it, consider using `have_enqueued_sidekiq_job`
-      # matcher.
+      # matcher. Or if you need to perform the jobs in queue for this worker, use
+      # `drain` method on the worker class.
       #
       # @example
       #   # bad
-      #   Sidekiq::Testing.inline! do; end
+      #   Sidekiq::Testing.inline! do
+      #      OperationThatTriggerWorker.call(some_id)
+      #   end
       #
       #   # good
-      #   expect(MyWorker).to receive(:perform_async).with(some_id) do |id|
-      #     MyWorker.new.perform(id)
-      #   end
+      #   OperationThatTriggerWorker.call(some_id)
+      #   MyWorker.drain
       #
       class SidekiqInline < Base
-        MSG = 'Stub `perform_async` and call inline worker with `new.perform`.'
+        MSG = 'Use `MyWorker.drain` method instead of `Sidekiq::Testing.inline!`.'
         RESTRICT_ON_SEND = [:inline!].freeze
 
         def_node_matcher :sidekiq_inline?, <<~PATTERN

data/lib/rubocop/petal/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Petal
-    VERSION = '0.7.0'
+    VERSION = '0.9.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-petal
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -49,20 +49,12 @@ email:
 - jfbastien@petalmd.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
 files:
-- ".github/workflows/build.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - config/default.yml
 - lib/rubocop-petal.rb
 - lib/rubocop/cop/chewy/reset_on_type.rb
@@ -71,24 +63,27 @@ files:
 - lib/rubocop/cop/grape/unnecessary_namespace.rb
 - lib/rubocop/cop/migration/foreign_key_option.rb
 - lib/rubocop/cop/migration/schema_statements_methods.rb
+- lib/rubocop/cop/performance/snif.rb
 - lib/rubocop/cop/petal_cops.rb
 - lib/rubocop/cop/rails/enum_prefix.rb
 - lib/rubocop/cop/rails/risky_activerecord_invocation.rb
 - lib/rubocop/cop/rails/table_name.rb
 - lib/rubocop/cop/rspec/authenticated_as.rb
 - lib/rubocop/cop/rspec/create_list_max.rb
+- lib/rubocop/cop/rspec/json_response.rb
 - lib/rubocop/cop/rspec/sidekiq_inline.rb
 - lib/rubocop/cop/rspec/stub_products.rb
 - lib/rubocop/petal.rb
 - lib/rubocop/petal/inject.rb
 - lib/rubocop/petal/version.rb
-- rubocop-petal.gemspec
 homepage: https://github.com/petalmd/rubocop-petal
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/petalmd/rubocop-petal
+  changelog_uri: https://github.com/petalmd/rubocop-petal/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/petalmd/rubocop-petal
+  bug_tracker_uri: https://github.com/petalmd/rubocop-petal/issues
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -105,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Petal custom cops

data/.github/workflows/build.yml

@@ -1,18 +0,0 @@
-name: Build
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.6
-        bundler-cache: true
-    - name: Default task, RSpec and Rubocop
-      run: bundle exec rake

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/.idea/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -1,18 +0,0 @@
-require:
-  - rubocop-rspec
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 2.6
-  SuggestExtensions: false
-
-Naming/FileName:
- Exclude:
-   - lib/rubocop-petal.rb
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*_spec.rb
-
-RSpec/ExampleLength:
-  Enabled: false

data/CHANGELOG.md

@@ -1,52 +0,0 @@
-# Changelog
-
-# main
-
-# v0.7.0
-
-* Support more cases for `Grape/UnnecessaryNamespace`. ([#26](https://github.com/petalmd/rubocop-petal/pull/26))
-
-# v0.6.0
-
-* Added cop `RSpec::SidekiqInline` ([#24](https://github.com/petalmd/rubocop-petal/pull/24))
-* Remove cop `Rails/ValidateUniquenessCase` ([#21](https://github.com/petalmd/rubocop-petal/pull/21))
-
-# v0.5.0
-
-* Added cop `Rails/ValidateUniquenessCase` ([#20](https://github.com/petalmd/rubocop-petal/pull/20))
-
-# v0.4.1
-
-* Fix typo default config SafeAutoCorrect RSpec/StubProducts ([#19](https://github.com/petalmd/rubocop-petal/pull/19))
-
-# v0.4.0
-
-* Added cop `RSpec/StubProducts` ([#18](https://github.com/petalmd/rubocop-petal/pull/18))
-
-# v0.3.1
-
-* Correct cop name `Migration/SchemaStatementsMethods` in config ([#17](https://github.com/petalmd/rubocop-petal/pull/17))
-
-# v0.3.0
-
-* Added cop `Added Migration/ForeignKeyOption` ([#11](https://github.com/petalmd/rubocop-petal/pull/11))
-* Added cop `Added Grape/PreferNamespace` ([#6](https://github.com/petalmd/rubocop-petal/pull/6))
-* Added cop `Added Migration/SchemaStatementsMethods` ([#14](https://github.com/petalmd/rubocop-petal/pull/14))
-* Remove cop `Added Migration/UseChangeTableBulk` ([#15](https://github.com/petalmd/rubocop-petal/pull/15))
-* Update cop `Grape/PreferNamespace` ([#16](https://github.com/petalmd/rubocop-petal/pull/16))
-
-# v0.2.1
-
-* Update lock dependencies `rubocop-rails` ([#9](https://github.com/petalmd/rubocop-petal/pull/9))
-
-# v0.2.0
-
-* Added cop `RSpec/AuthenticatedAs` ([#3](https://github.com/petalmd/rubocop-petal/pull/3))
-* Added cop `Grape/UnnecessaryNamespace` ([#2](https://github.com/petalmd/rubocop-petal/pull/2))
-* Added cop `RSpec/CreateListMax` ([#4](https://github.com/petalmd/rubocop-petal/pull/4))
-* Added Cop `Migration/UseChangeTableBulk` ([#7](https://github.com/petalmd/rubocop-petal/pull/7))
-* Added cop `Grape/HelpersIncludeModule` ([#1](https://github.com/petalmd/rubocop-petal/pull/1))
-
-# v0.1.0
-
-* First version

data/Gemfile

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rubocop-petal.gemspec
-gemspec
-
-gem 'rake', '~> 13.0'
-
-gem 'rspec', '~> 3.0'
-
-gem 'rubocop', '~> 1.0'
-gem 'rubocop-rspec', require: false
-
-gem 'activesupport', '~> 5.2.0'

data/Gemfile.lock

@@ -1,78 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rubocop-petal (0.7.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-rails (~> 2.10)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.6)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    ast (2.4.2)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    i18n (1.8.11)
-      concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.0.3.2)
-      ast (~> 2.4.1)
-    rack (3.0.0)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.2.0)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.23.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.0)
-      parser (>= 3.0.1.1)
-    rubocop-rails (2.15.2)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 1.7.0, < 2.0)
-    rubocop-rspec (2.6.0)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (~> 5.2.0)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.0)
-  rubocop-petal!
-  rubocop-rspec
-
-BUNDLED WITH
-   2.2.3

data/Rakefile

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-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/petal_cops.rb')
-  generator.inject_config(config_file_path: 'config/default.yml')
-
-  puts generator.todo
-end

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'rubocop/petal'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/rubocop-petal.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/rubocop/petal/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'rubocop-petal'
-  spec.version       = RuboCop::Petal::VERSION
-  spec.authors       = ['Jean-Francis Bastien']
-  spec.email         = ['jfbastien@petalmd.com']
-
-  spec.summary       = 'Petal custom cops'
-  spec.homepage      = 'https://github.com/petalmd/rubocop-petal'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/petalmd/rubocop-petal'
-  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(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-
-  spec.add_runtime_dependency 'rubocop', '>= 1.7.0', '< 2.0'
-  spec.add_dependency 'rubocop-rails', '~> 2.10'
-end