nxt_cop 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36425e542055540a840b751553cd953353fafe70dc6201101dfb5c72432cba54
-  data.tar.gz: 14770d51c1893f141891cf0df314b5b0af32bbd5539a862ab0868b9bc7061729
+  metadata.gz: d36d052009c7de1ca3318d89019cd42f7db459c9ee4b2c0dd88f2e63adc37a83
+  data.tar.gz: 5c8b68f2cf5db256d431f1e7a37702417401b82eb017af97a71f73c0f515fc2b
 SHA512:
-  metadata.gz: 0e1325eb79a605393bf2c985bade464459b6e035d57e8c5b3e02d638e28ff6f6f973f899ae5d006189d95216ce2908f2e2abf7db244617b33bf52bc6ed4538a0
-  data.tar.gz: '008136f537dd440edb75742c3c1219180dd33cd745644fa1fc489b4fa2234b1d846e7668bf83c880152f8ee5bca671945dd8a6a39796d0986cfd0ca111e16e43'
+  metadata.gz: 83bf1c4ce35ca15ea3211674015ca930797974855394b65fb3fbdd059399aae5542cf34be808d587df99a981ee2bc28fecfac7c2645bb244662bad3e35428fba
+  data.tar.gz: cf81b2893d0dfd9d8df6b4d9ff624fe16bfe70a546849fa5a0bb8a84b73f555ced914022ed452dc0e9f9ada71fcf4a9069c717a9dc3169b7d5b4241097472400

data/.circleci/config.yml

@@ -0,0 +1,37 @@
+# See https://circleci.com/docs/2.0/language-ruby/ for more details
+
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@2.0.1
+
+jobs:
+  checks:
+    parallelism: 1
+    resource_class: small
+    docker:
+      - image: cimg/ruby:3.3.2
+    steps:
+      - checkout
+      - ruby/install-deps:
+          key: gems-v1
+          include-branch-in-cache-key: false
+      # - ruby/rubocop-check
+      - run:
+          name: RSpec Tests
+          command: |-
+            bundle exec rspec --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec/results.xml --format progress
+      # actually not necessary for test results to be collected, but these files
+      # won't show up in the web UI otherwise
+      - store_artifacts:
+          path: /tmp/rspec/
+          destination: rspec
+      - store_test_results:
+          path: /tmp/rspec/
+
+workflows:
+  version: 2
+  checks:
+    jobs:
+      - checks

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -1 +1 @@
-3.3.0
+3.3.2

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.0
+ruby 3.3.2

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# v2.5.0 2024-06-11
+## What's Changed
+- Relaxes the rubocop version to not pin the patch
+- Updates the ruby version to 3.3.2
+- Updates dependencies
+
+# v2.4.0 2024-02-19
+## What's Changed
+- Add tests for custom cops
+- Removed `Rails/MissingLoggerInclude` due to maintenance burden
+
 # v2.3.0 2024-02-09
 ## What's Changed
 - Tree shake the config (no rules change)

data/Gemfile.lock

@@ -1,15 +1,18 @@
 PATH
   remote: .
   specs:
-    nxt_cop (2.3.0)
-      rubocop (~> 1.60.0)
+    nxt_cop (2.5.0)
+      rubocop (~> 1.60)
+      rubocop-capybara (~> 2.21)
+      rubocop-factory_bot (~> 2.26)
       rubocop-rails (~> 2.8)
-      rubocop-rspec (~> 2.12)
+      rubocop-rspec (~> 3.0)
+      rubocop-rspec_rails (~> 2.30)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -21,28 +24,44 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
-    concurrent-ruby (1.2.3)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
-    drb (2.2.0)
-      ruby2_keywords
-    i18n (1.14.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
-    minitest (5.22.2)
+    minitest (5.23.1)
     mutex_m (0.2.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.25.1)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
-    rack (3.0.9)
+    racc (1.8.0)
+    rack (3.1.0)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.60.2)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.0)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -50,26 +69,27 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.20.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
-    rubocop-rails (2.23.1)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-rails (2.25.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    rubocop-rspec (2.26.1)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.0.1)
+      rubocop (~> 1.61)
+    rubocop-rspec_rails (2.30.0)
+      rubocop (~> 1.61)
+      rubocop-rspec (~> 3, >= 3.0.1)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
+    strscan (3.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
@@ -81,6 +101,8 @@ DEPENDENCIES
   bundler (~> 2.1)
   nxt_cop!
   rake (~> 13.0)
+  rspec
+  rspec_junit_formatter
 
 BUNDLED WITH
-   2.1.4
+   2.5.5

data/default.yml

@@ -3,7 +3,6 @@ require:
 - rubocop-rails
 - rubocop-rspec
 - ./custom_cops/nxt_core/rails/use_of_rails_logger.rb
-- ./custom_cops/nxt_core/rails/missing_logger_include.rb
 
 inherit_mode:
   merge:
@@ -12,9 +11,6 @@ inherit_mode:
 
 Rails/UseOfRailsLogger:
   Description: "Custom Getsafe cop to ensure the correct logger is used"
-Rails/MissingLoggerInclude:
-  Description: "Custom Getsafe cop to find missing `include` statements when using our custom logger"
-  SafeAutoCorrect: false
 
 AllCops:
   Exclude:

data/lib/nxt_cop/version.rb

@@ -1,3 +1,3 @@
 module NxtCop
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/nxt_cop.gemspec

@@ -33,9 +33,14 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.2'
 
-  spec.add_dependency 'rubocop', '~> 1.60.0'
+  spec.add_dependency 'rubocop', '~> 1.60'
+  spec.add_dependency 'rubocop-capybara', '~> 2.21'
+  spec.add_dependency 'rubocop-factory_bot', '~> 2.26'
   spec.add_dependency 'rubocop-rails', '~> 2.8'
-  spec.add_dependency 'rubocop-rspec', '~> 2.12'
+  spec.add_dependency 'rubocop-rspec', '~> 3.0'
+  spec.add_dependency 'rubocop-rspec_rails', '~> 2.30'
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec_junit_formatter'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nxt_cop
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Scott Livingstone
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-14 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.0
+        version: '1.60'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.0
+        version: '1.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.30'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,13 +122,43 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.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: rspec_junit_formatter
+  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'
 description:
 email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".tool-versions"
@@ -100,7 +172,6 @@ files:
 - bin/guard
 - bin/rspec
 - bin/setup
-- custom_cops/nxt_core/rails/missing_logger_include.rb
 - custom_cops/nxt_core/rails/use_of_rails_logger.rb
 - default.yml
 - lib/nxt_cop/version.rb
@@ -128,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Getsafe shared Rubocop.

data/custom_cops/nxt_core/rails/missing_logger_include.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module CustomCops
-  module NxtCore
-    module Rails
-      # The NxtCore logger requires an include in most cases. Ensures it is present.
-      #
-      # @safety
-      #   This cop's autocorrection is unsafe because
-      #   `logger` may refer to an instance variable or other method of the class.
-      class MissingLoggerInclude < RuboCop::Cop::Base
-        extend RuboCop::Cop::AutoCorrector
-
-        RESTRICT_ON_SEND = [:logger].freeze
-
-        MSG = 'Missing `include Nxt::Loggable` for a class which uses the logger.'
-
-        # NodePattern docs: https://github.com/rubocop/rubocop-ast/blob/master/docs/modules/ROOT/pages/node_pattern.adoc
-        def_node_matcher :includes_nxt_loggable?, <<~PATTERN
-          (begin <(send nil? :include (const (const nil? :Nxt) :Loggable)) ...>)
-        PATTERN
-
-        def on_send(node)
-          return unless node.receiver.nil?
-
-          class_node = node.ancestors.find(&:class_type?)
-          return unless class_node
-
-          class_definition_node = class_node.each_child_node(:begin).first
-          return if includes_nxt_loggable?(class_definition_node)
-
-          add_offense(class_node, message: MSG) do |corrector|
-            corrector.insert_before(class_definition_node.child_nodes.first, "include Nxt::Loggable\n")
-          end
-        end
-      end
-    end
-  end
-end