carwow_rubocop 3.4.2 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5eb0655bbee6e4a19a6f6768ed3bfdcbb7afd7afc8b0454141235880b3a85c2
-  data.tar.gz: c16fa6a575e36249abe3fd0b26772bbdadb5107acd058faa2e3e69a708dfaa5b
+  metadata.gz: a298086f7e65b0263cc91fe3c8d074132c26d85080f7d6005d9ff93be25b5d4f
+  data.tar.gz: f4b3524c0cb7e68ada8939cb9f7e62cfc2a1eab9c7dd48e7d2934038b167c78d
 SHA512:
-  metadata.gz: c521fe82bd262c587430af64a1c5f94f2489cbdebfe3c34a9149431b758aca78c1770484433c05f0101b5c66ecbd5244b13dca1233d439386b6e21584d5650aa
-  data.tar.gz: 1d68d6e5cd09c78b1173a572e6b11c30f3ca4a70835d8e0a9f3934f9ba5a2379f62e99e1007c41a1f7fd85a962e5e9792eb8b35ab8285878455b3fa0ef2ab518
+  metadata.gz: 8479fd94ca36b4f1afa7f5628dea506e6a51fbd28200b15e6f5d04328dea4bf451de345989a10572bb3e137d960e251e160a6a04702aa2b833cbb00ee1e83009
+  data.tar.gz: 027405a2b9112e32bc4e87977b5ba87289ce57fd2b25cb7edcb11ebf2c9b8dd50bc512a3b2989201fb89c17f09045acb66a838dab09abc03e27c12e9ef596c71

data/.circleci/config.yml

@@ -0,0 +1,73 @@
+version: 2.1
+
+orbs:
+  buildevents: honeycombio/buildevents@0.2
+  carwow: carwow/carwow-orb@0.3
+
+
+##
+# JOBs definitions
+##
+jobs:
+  tests:
+    executor: carwow/ruby
+    steps:
+      - buildevents/with_job_span:
+          steps:
+            - checkout
+            - run:
+                name: Bundle
+                command: bundle install --jobs=4 --retry=3
+
+            - run:
+                name: Running gem tests
+                command: |
+                  bundle exec rspec
+
+
+  lint_ruby:
+    executor: carwow/ruby
+    steps:
+      - buildevents/with_job_span:
+          steps:
+            - checkout
+            - run: bundle install --jobs=4 --retry=3
+            - run: bundle exec rubocop -p
+
+
+
+  publish_gem:
+    executor: carwow/ruby
+    steps:
+      - buildevents/with_job_span:
+          steps:
+            - checkout
+            - run: bundle install --jobs=4 --retry=3
+            - run: bundle exec rake upload
+
+
+
+
+workflows:
+  version: 2
+  build-and-deploy:
+    jobs:
+      - carwow/start
+      - carwow/watch:
+          context: buildevents-watch
+          requires: [carwow/start]
+
+      - tests:
+          requires: [carwow/start]
+
+      - lint_ruby:
+          requires: [carwow/start]
+
+      - publish_gem:
+          context: org-global
+          requires:
+            - tests
+            - lint_ruby
+          filters:
+            branches:
+              only: [master]

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "09:00"
+  open-pull-requests-limit: 10

data/.rubocop.yml

@@ -1 +1,5 @@
-inherit_from: default.yml
+inherit_from:
+  - config/default.yml
+
+require:
+  - rubocop-rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carwow_rubocop (3.4.2)
+    carwow_rubocop (4.0.1)
       rubocop (>= 0.93)
       rubocop-performance
       rubocop-rspec
@@ -9,33 +9,51 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rubocop (1.8.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    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.2)
+    rubocop (1.22.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.1.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -43,7 +61,9 @@ PLATFORMS
 DEPENDENCIES
   bundler
   carwow_rubocop!
+  pry
   rake
+  rspec
 
 BUNDLED WITH
-   2.1.4
+   2.2.27

data/README.md

@@ -1,16 +1,16 @@
 # CarwowRubocop
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/carwow_rubocop`. To experiment with that code, run `bin/console` for an interactive prompt.
+carwow specific analysis for [RuboCop][rubocop].
+
+It contains carwow's internally used configuration for [RuboCop][rubocop] and [RuboCop RSpec][rubocop-rspec].
+It also includes a handful custom rules that are not currently addressed by other projects.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Just put this in your `Gemfile` it depends on the appropriate version of rubocop and rubocop-rspec.
 
-```ruby
-gem 'carwow_rubocop'
-```
+    gem 'carwow_rubocop'
 
 And then execute:
 
@@ -20,20 +20,83 @@ Or install it yourself as:
 
     $ gem install carwow_rubocop
 
+
 ## Usage
 
-TODO: Write usage instructions here
+You need to tell RuboCop to load the carwow extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+First Create a new file `.rubocop_carwow.yml` in the same directory as your `.rubocop.yml`
+this file should contain
+
+    require:
+      - carwow_rubocop
+
+Next add the following to `.rubocop.yml`
+or add before `.rubocop_todo.yml` in your existing `inherit_from`
+
+    inherit_from:
+      - .rubocop_carwow.yml
+      - .rubocop_todo.yml
+
+You need to inherit `.rubocop_carwow.yml` from another file because of Rubocop order of operations.
+It runs `inherit_from` before `require` commands. If the configuration is not in a separate file
+you could potentially experience a bunch of warnings from `.rubocop_todo.yml` for non-existant
+`Carwow` rules.
+
+Now you can run `rubocop` and it will automatically load the RuboCop Carwow
+cops together with the standard cops.
+
+### Command line
+
+    rubocop --require rubocop-carwow
+
+## The Cops
+
+All cops are located under
+[`lib/rubocop/cop/carwow`](lib/rubocop/cop/carwow), and contain examples/documentation.
+
+In your `.rubocop.yml`, you may treat the carwow cops just like any other cop. For example:
+
+    Carwow/NoStubbingBusinessEvent:
+      Exclude:
+        - spec/my_poorly_named_spec_file.rb
+
+
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To update the carwow rubocop rules, edit the file: `config/default.yml`.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/carwow_rubocop.
 
+### How to write custom cops?
+
+The [official docs](https://docs.rubocop.org/rubocop/development.html) will teach you how to develop new cops.
+
+Read [Node pattern](https://github.com/rubocop/rubocop-ast/blob/master/docs/modules/ROOT/pages/node_pattern.adoc) to understand better how to write _node matches_ for your custom cop.
+
+### How other companies are doing it?
+
+There are a lot of companies with public repositories sharing their Cops.
+
+- [Airbnb](https://github.com/airbnb/ruby/tree/master/rubocop-airbnb)
+- [Github](https://github.com/github/rubocop-github)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+
+[rubocop]: https://github.com/rubocop-hq/rubocop
+[rubocop-rspec]: https://github.com/backus/rubocop-rspec

data/Rakefile

@@ -3,7 +3,7 @@ task default: :spec
 
 desc "Upload to rubygems"
 task :upload => :build do
-  # Check if tag with v#{ResearchSiteApiClient::VERSION} version exists, if so, return with error
+  # Check if tag with v#{RuboCop::Carwow::VERSION} version exists, if so, return with error
 
   if tag_exists?(current_tag_name)
     puts "Tag exists, did you run rake increase_revision_number after merging with master?"
@@ -16,7 +16,7 @@ end
 
 desc "Increase the revision number"
 task :increase_revision_number do
-  version_file = "lib/carwow_rubocop/version.rb"
+  version_file = "lib/rubocop/carwow/version.rb"
   file_content = File.read(version_file)
   rule = /(\d+\.\d+\.)(\d+)/
   new_revision_number = rule.match(file_content)[2].to_i + 1
@@ -38,5 +38,5 @@ def create_tag(tag_name)
 end
 
 def current_tag_name
-  "v#{CarwowRubocop::VERSION}"
+  "v#{RuboCop::Carwow::VERSION}"
 end

data/carwow_rubocop.gemspec

@@ -1,11 +1,12 @@
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'carwow_rubocop/version'
+require 'rubocop/carwow/version'
 
 Gem::Specification.new do |spec|
   spec.name                  = 'carwow_rubocop'
-  spec.version               = CarwowRubocop::VERSION
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.version               = RuboCop::Carwow::VERSION
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
   spec.authors               = ['carwow Developers']
   spec.email                 = ['developers@carwow.co.uk']
   spec.summary               = "carwow's rubocop configuration"
@@ -17,7 +18,7 @@ Gem::Specification.new do |spec|
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -29,6 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+
   spec.add_dependency 'rubocop', '>= 0.93'
   spec.add_dependency 'rubocop-performance'
   spec.add_dependency 'rubocop-rspec'

data/config/default.yml

@@ -0,0 +1,34 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+  - ../lib/rubocop/carwow
+
+##############
+# Global rules
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - '.git/**/*'
+    - 'Rakefile'
+    - 'bin/**/*'
+    - 'db/*schema*'
+    - 'node_modules/**/*'
+    - 'public/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+
+inherit_from:
+  - './rubocop-bundler.yml'
+  - './rubocop-carwow.yml'
+  - './rubocop-gemspec.yml'
+  - './rubocop-layout.yml'
+  - './rubocop-lint.yml'
+  - './rubocop-metrics.yml'
+  - './rubocop-naming.yml'
+  - './rubocop-performance.yml'
+  - './rubocop-rails.yml'
+  - './rubocop-rspec.yml'
+  - './rubocop-security.yml'
+  - './rubocop-style.yml'

data/config/rubocop-bundler.yml

@@ -0,0 +1,5 @@
+Bundler/DuplicatedGem:
+  Enabled: true
+
+Bundler/InsecureProtocolSource:
+  Enabled: false

data/config/rubocop-carwow.yml

@@ -0,0 +1,33 @@
+# All of these rules are implemented in this gem.
+# They are custom built for use inside carwow and address issues
+# that we have experienced in testing and production.
+
+Carwow/Jobs:
+  Enabled: true
+  Include: &jobs_only
+    - "**/jobs/**/*.rb"
+  AllowedSuperclasses: &job_classes
+    - ApplicationJob
+    - ScheduledJob
+  TopLevelJob: "ActiveJob::Base"
+
+Carwow/JobsMustDefineQueue:
+  Enabled: true
+  Include: *jobs_only
+  JobClasses: *job_classes
+  KnownQueues:
+    - seconds
+    - minutes
+    - hour
+    - hours
+
+Carwow/JobsQueueNameStyle:
+  Enabled: true
+  Include: *jobs_only
+  QueueNameAs: Symbol
+
+Carwow/NoStubbingBusinessEvent:
+  Enabled: true
+  Include: &spec_only
+    - "**/*_spec.rb"
+    - "**/spec/**/*"

data/config/rubocop-gemspec.yml

@@ -0,0 +1,12 @@
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Description: Checks that `required_ruby_version` of gemspec and `TargetRubyVersion` of
+    .rubocop.yml are equal.
+  Enabled: false
+  Include:
+    - '**/*.gemspec'
+
+Gemspec/RubyVersionGlobalsUsage:
+  Enabled: true

data/config/rubocop-layout.yml

@@ -0,0 +1,14 @@
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation

data/config/rubocop-lint.yml

@@ -0,0 +1,6 @@
+Lint/DuplicateBranch:
+  IgnoreLiteralBranches: true
+
+Lint/Debugger:
+  Description: Check for debugger calls.
+  Enabled: true

data/config/rubocop-metrics.yml

@@ -0,0 +1,8 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'config/routes.rb'
+    - 'spec/**/*'
+    - '**/*.rake'
+    - '**/*.gemspec'
+    - 'config/environments/*.rb'
+    - 'config/initializers/*.rb'

data/config/rubocop-naming.yml

@@ -0,0 +1,2 @@
+Naming/RescuedExceptionsVariableName:
+  Enabled: false

data/config/rubocop-rspec.yml

@@ -0,0 +1,25 @@
+require:
+  - rubocop-rspec
+
+RSpec:
+  Include:
+    - _spec.rb
+    - "(?:^|/)spec/"
+RSpec/FactoryBot:
+  Patterns:
+    - spec/factories/**/*.rb
+    - features/support/factories/**/*.rb
+
+RSpec/ContextWording:
+  Enabled: False
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/NotToNot:
+  Description: 'Enforces the usage of the same method on all negative message expectations.'
+  Enabled: true
+  EnforcedStyle: not_to
+  SupportedStyles:
+    - not_to
+    - to_not

data/config/rubocop-security.yml

@@ -0,0 +1,3 @@
+Security/Eval:
+  Description: The use of eval represents a serious security risk.
+  Enabled: true

data/config/rubocop-style.yml

@@ -0,0 +1,11 @@
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/lib/carwow_rubocop.rb

@@ -1,5 +1,10 @@
-require 'carwow_rubocop/version'
+require 'pathname'
+require 'yaml'
 
-module CarwowRubocop
-  # Nothing to do here
-end
+require 'rubocop'
+
+require 'rubocop/carwow'
+require 'rubocop/carwow/inject'
+require 'rubocop/carwow/version'
+
+RuboCop::Carwow::Inject.defaults!

data/lib/rubocop/carwow/inject.rb

@@ -0,0 +1,20 @@
+# Straight up ripped from the custom Rspec rubocop
+# https://github.com/nevir/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+require 'yaml'
+
+module RuboCop
+  module Carwow
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.load_file(path).to_hash
+        config = Config.new(hash, path)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/carwow/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Carwow
+    VERSION = '4.0.1'.freeze
+  end
+end

data/lib/rubocop/carwow.rb

@@ -0,0 +1,18 @@
+require 'pathname'
+require 'psych'
+
+Dir.glob(File.expand_path('cop/**/*.rb', File.dirname(__FILE__))).sort.each do |file|
+  require file
+end
+
+module RuboCop
+  # RuboCop Carwow project namespace
+  module Carwow
+    PROJECT_ROOT =
+      Pathname.new(__FILE__).parent.parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG = Psych.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(*constants(false))
+  end
+end

data/lib/rubocop/cop/carwow/jobs.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Carwow
+      # Jobs are important in our systems and having observability well configured
+      # is essential. All Job classes must behave as we expect, and only a few
+      # well-defined classes can be super classes for other jobs.
+      #
+      # We use ActiveJob as framework for declaring jobs, being `ActiveJob::Base`
+      # the top level class. However, our jobs are generally split into two big
+      # hierarchies: ApplicationJob and ScheduledJob; and all jobs should inherit
+      # from these classes rather than `ActiveJob::Base`.
+      #
+      # We understand that each application may introduce its own exceptions,
+      # so the Cop can be configured to change the allowed super classes and even
+      # the top level class!
+      #
+      #
+      # @config
+      #
+      #     # Mandatory configs
+      #     Carwow/Jobs:
+      #       AllowedSuperclasses:
+      #         - ApplicationJob
+      #         - ScheduledJob
+      #       TopLevelJob: "ActiveJob::Base"
+      #
+      #
+      # @example
+      #   # bad
+      #   class Bad < ActiveJob::Base; end
+      #
+      #   # bad
+      #   class Bad < NotAllowedJob; end
+      #
+      #   # good
+      #   class Good < ApplicationJob; end
+      #
+      #   # good
+      #   class ScheduledJob < ApplicationJob; end
+      #
+      #   # good
+      #   class ApplicationJob < ActiveJob::Base; end
+      #
+      #
+      class Jobs < ::RuboCop::Cop::Base
+        MSG = 'Jobs should subclass from one of: %s.'
+        TOP_LEVEL_MSG = 'Only %s can inherit from %s.'
+        FORCE_TOP_LEVEL_MSG = 'It should inherit from %s or %s.'
+        NOT_CONFIGURED = 'AllowedSuperclasses and TopLevelJob configs must be set before proceeding.'
+
+        def on_class(node)
+          return add_global_offense(NOT_CONFIGURED) if missing_config?
+
+          return if any_ancestor_allowed?(node)
+          return if defining_allowed_job?(*node)
+
+          register_offenses(node)
+        end
+
+        private
+
+        def any_ancestor_allowed?(class_node)
+          root_node = class_node.root? ? class_node : class_node.ancestors.last
+          root_node.each_descendant(:class).any? do |node|
+            allowed?(super_class(*node))
+          end
+        end
+
+        def allowed?(superclass)
+          cop_config.fetch('AllowedSuperclasses').include?(superclass)
+        end
+
+        def defining_allowed_job?(class_node, super_node, _)
+          super_class_name = super_node&.const_name
+
+          allowed?(class_node.const_name) &&
+            (allowed?(super_class_name) || top_level?(super_class_name))
+        end
+
+        def register_offenses(node)
+          class_node, super_node, _args = *node
+
+          if allowed?(class_node.const_name)
+            only_allowed_inherit_from_toplevel(super_node, FORCE_TOP_LEVEL_MSG)
+          elsif top_level?(super_node&.const_name)
+            only_allowed_inherit_from_toplevel(node, TOP_LEVEL_MSG)
+          else
+            add_offense(class_node, message: MSG % allowed_str)
+          end
+        end
+
+        def super_class(_, superclass_node, _)
+          superclass_node&.const_name
+        end
+
+        def missing_config?
+          !(cop_config.key?('AllowedSuperclasses') && cop_config.key?('TopLevelJob'))
+        end
+
+        def top_level?(klass)
+          top_level_class == klass
+        end
+
+        def allowed_str
+          cop_config.fetch('AllowedSuperclasses').join(', ')
+        end
+
+        def top_level_class
+          cop_config.fetch('TopLevelJob')
+        end
+
+        def only_allowed_inherit_from_toplevel(node, msg)
+          add_offense(node, message: format(msg, allowed_str, top_level_class))
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/carwow/jobs_must_define_queue.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Carwow
+      # Jobs are important in our systems and having a unified way to write them
+      # is essential. All Job classes must define the queue to be executed in.
+      # The `queue_as` defines in which queue the Job will be executed and can
+      # only be defined once. Even more, the _queue_ defined must be known by
+      # the system and declared in the configs: `KnownQueues`.
+      #
+      # We understand that each application may introduce its own exceptions,
+      # so the Cop can be configured to change the allowed classes to identify
+      # job classes and also the known queues.
+      #
+      #
+      # @config
+      #
+      #     # Mandatory configs
+      #     Carwow/Jobs:
+      #       JobClasses:
+      #         - ApplicationJob
+      #         - ScheduledJob
+      #       KnownQueues:
+      #         - seconds
+      #         - minutes
+      #         - hour
+      #         - hours
+      #
+      #
+      # @example
+      #
+      #     # bad
+      #     class Bad < ApplicationJob
+      #     end
+      #
+      #     # bad
+      #     class Bad < ApplicationJob
+      #       queue_as :minutes
+      #       queue_as :hours
+      #     end
+      #
+      #     # bad
+      #     class Bad < ApplicationJob
+      #       queue_as :unknown_queue
+      #     end
+      #
+      #     # good
+      #     class Ok < ApplicationJob
+      #       queue_as :minutes
+      #     end
+      #
+      #
+      class JobsMustDefineQueue < ::RuboCop::Cop::Base
+        def_node_matcher :on_queue_definition, <<~PATTERN
+          (send nil? :queue_as $_)
+        PATTERN
+
+        MISSING_QUEUE_MSG = 'Manually set a queue; the default is not executed!'
+        UNKNOWN_QUEUE_MSG = 'Unknown queue name'
+        MULTIPLE_DEFINITIONS_MSG = 'Jobs must define a queue only once!'
+        NOT_CONFIGURED = 'JobClasses and KnownQueues configs must be set before proceeding.'
+
+        def on_class(node)
+          return add_global_offense(NOT_CONFIGURED) if missing_config?
+
+          return if skip_on_class?(node)
+
+          queue_definitions = all_queue_definitions(node)
+
+          case queue_definitions.size
+          when 0
+            missing_queue_offense(node)
+          when 1
+            # This is ok!
+          else
+            multiple_definitions_offense(queue_definitions)
+          end
+        end
+
+        # optimization: don't call `on_send` unless the method name is in this list
+        RESTRICT_ON_SEND = %i[queue_as].freeze
+
+        def on_send(node)
+          return add_global_offense(NOT_CONFIGURED) if missing_config?
+
+          # If the class is not a Job, no need to proceed.
+          return unless application_job_top_level?(node.parent)
+
+          _, _queue_as, queue_name_node = *node
+          queue_name, _other = *queue_name_node
+
+          return if known_queues.include?(queue_name.to_s)
+
+          add_offense(queue_name_node, message: UNKNOWN_QUEUE_MSG)
+        end
+
+        private
+
+        def missing_config?
+          !cop_config.key?('JobClasses')
+        end
+
+        def skip_on_class?(node)
+          class_node, super_node, _other = *node
+
+          return true if super_node.nil?
+          return true unless application_job?(super_node.const_name)
+
+          # If the class defined is listed as JobClasses, we don't require a queue.
+          application_job?(class_node.const_name)
+        end
+
+        def application_job_top_level?(node)
+          _, super_node, _other = *(node.type == :class ? node : node.parent)
+
+          application_job?(super_node.const_name)
+        end
+
+        def application_job?(job_name)
+          cop_config.fetch('JobClasses').include?(job_name)
+        end
+
+        def known_queues
+          cop_config.fetch('KnownQueues', [])
+        end
+
+        def all_queue_definitions(node)
+          return [] unless node.body
+
+          node = node.body if node.body.type == :begin
+
+          node
+            .each_child_node
+            .filter_map { |n| on_queue_definition(n) }
+        end
+
+        def missing_queue_offense(node)
+          add_offense(node, message: MISSING_QUEUE_MSG)
+        end
+
+        def multiple_definitions_offense(all_definitions)
+          add_offense(all_definitions.last, message: MULTIPLE_DEFINITIONS_MSG)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/carwow/jobs_queue_name_style.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Carwow
+      #
+      # @config
+      #
+      #   # Optional configs
+      #   Carwow/Jobs:
+      #     QueueNameAs: "Symbol"   # default
+      #
+      #
+      # @example
+      #   # bad
+      #   class Bad < ApplicationJob
+      #     queue_as "with_string"
+      #   end
+      #
+      #   # good
+      #   class Good < ApplicationJob
+      #     queue_as :with_symbol
+      #   end
+      #
+      #
+      class JobsQueueNameStyle < ::RuboCop::Cop::Base
+        extend AutoCorrector
+
+        MSG = 'Prefer `queue_as` with symbol instead of String'
+        MSG_STRING = 'Prefer `queue_as` with String instead of Symbol'
+
+        def_node_matcher :on_queue_definition_with_symbol?, <<~PATTERN
+          (send nil? :queue_as (sym _))
+        PATTERN
+
+        def_node_matcher :on_queue_definition_with_string?, <<~PATTERN
+          (send nil? :queue_as (str _))
+        PATTERN
+
+        # optimization: don't call `on_send` unless the method name is in this list
+        RESTRICT_ON_SEND = %i[queue_as].freeze
+        def on_send(node)
+          _, _queue_as, queue_name = *node
+
+          return if prefer_symbol? && queue_name.sym_type?
+          return if prefer_string? && queue_name.str_type?
+
+          add_offense(queue_name, message: (prefer_symbol? ? MSG : MSG_STRING)) do |corrector|
+            content, _other = *queue_name
+            fix = prefer_symbol? ? ":#{content}" : content.to_s.inspect
+
+            corrector.replace(queue_name, fix)
+          end
+        end
+
+        private
+
+        def prefer_symbol?
+          !cop_config.fetch('QueueNameAs', 'Symbol').casecmp('string').zero?
+        end
+
+        def prefer_string?
+          !prefer_symbol?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/carwow/no_stubbing_business_event.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Carwow
+      # Never mock (or double) the BusinessEvent class, it won't validate the schema
+      # and it reduces the quality of your tests!
+      #
+      # [See discussion](https://carwow.discourse.team/t/schema-validations-for-business-events/414)
+      #
+      # @example
+      #   # bad
+      #   expect(BusinessEvent).to have_received(:publish).with(:topic, :event, payload: payload)
+      #
+      #   # good - preferred
+      #   expect { subject }.to have_published_event(:topic, :event).with(payload)
+      #
+      #   # good
+      #   expect(topic: :event).to have_been_published.with(payload)
+      #
+      #   # bad
+      #   expect(BusinessEvent).not_to have_received(:publish)
+      #
+      #   # good - preferred
+      #   expect { subject }.not_to have_published_event
+      #
+      #   # good
+      #   expect(topic: :event).not_to have_been_published
+      #
+      class NoStubbingBusinessEvent < ::RuboCop::Cop::Base
+        def_node_matcher :stub_on_business_event?, <<~PATTERN
+          (send nil? {:allow | :expect} (const nil? :BusinessEvent))
+        PATTERN
+
+        # optimization: don't call `on_send` unless the method name is in this list
+        RESTRICT_ON_SEND = %i[allow expect].freeze
+        MSG = 'Stub BusinessEvent is discouraged!'
+
+        def on_send(node)
+          stub_on_business_event?(node) do
+            add_offense(node)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carwow_rubocop
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 4.0.1
 platform: ruby
 authors:
 - carwow Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
@@ -97,9 +127,27 @@ files:
 - bin/console
 - bin/setup
 - carwow_rubocop.gemspec
-- default.yml
+- config/default.yml
+- config/rubocop-bundler.yml
+- config/rubocop-carwow.yml
+- config/rubocop-gemspec.yml
+- config/rubocop-layout.yml
+- config/rubocop-lint.yml
+- config/rubocop-metrics.yml
+- config/rubocop-naming.yml
+- config/rubocop-performance.yml
+- config/rubocop-rails.yml
+- config/rubocop-rspec.yml
+- config/rubocop-security.yml
+- config/rubocop-style.yml
 - lib/carwow_rubocop.rb
-- lib/carwow_rubocop/version.rb
+- lib/rubocop/carwow.rb
+- lib/rubocop/carwow/inject.rb
+- lib/rubocop/carwow/version.rb
+- lib/rubocop/cop/carwow/jobs.rb
+- lib/rubocop/cop/carwow/jobs_must_define_queue.rb
+- lib/rubocop/cop/carwow/jobs_queue_name_style.rb
+- lib/rubocop/cop/carwow/no_stubbing_business_event.rb
 homepage: https://github.com/carwow/carwow_rubocop
 licenses:
 - MIT

data/default.yml

@@ -1,61 +0,0 @@
-require:
-  - rubocop-rspec
-  - rubocop-performance
-
-AllCops:
-  TargetRubyVersion: 2.7
-  NewCops: enable
-  Exclude:
-    - 'Rakefile'
-    - 'vendor/**/*'
-    - 'db/*schema*'
-    - 'node_modules/**/*'
-    - 'bin/**/*'
-    - 'tmp/**/*'
-    - 'public/**/*'
-
-Layout/ArgumentAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/LineLength:
-  Max: 120
-
-Layout/MultilineMethodCallBraceLayout:
-  EnforcedStyle: new_line
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Metrics/BlockLength:
-  Exclude:
-    - 'config/routes.rb'
-    - 'spec/**/*'
-    - '**/*.rake'
-    - '**/*.gemspec'
-    - 'config/environments/*.rb'
-    - 'config/initializers/*.rb'
-
-Naming/RescuedExceptionsVariableName:
-  Enabled: false
-
-RSpec/ContextWording:
-  Enabled: False
-
-RSpec/ExampleLength:
-  Max: 10
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/DoubleNegation:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-

data/lib/carwow_rubocop/version.rb

@@ -1,3 +0,0 @@
-module CarwowRubocop
-  VERSION = '3.4.2'.freeze
-end