nxt_cop 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbd4cf87a6cdec2af74789d277deed6b7827251b00237a6aa031bcafabef5737
-  data.tar.gz: 1edc20eb4e39f0f7d9a9e3e9b9d2c770b4fc7817a2b3e8814dd87132770947b6
+  metadata.gz: 31120e5b23ae4a12f07a900c4331cf782390dd6e33d1e1f85ec700bfb6b40bc4
+  data.tar.gz: b6177b79c00d01220d57ded64b554e84106db6d87a0173b106bdc8e4d5f70aa0
 SHA512:
-  metadata.gz: 51e915c704f32e3fa571b3cc3e8dd4d5d57d09fad40e81010424b75b85ddc06e6c5e12f8ee7a3efc059787cd2802d42d68fa55e379223390a46705921cb7fb65
-  data.tar.gz: 7f34022a50fa24a7536ce367e018880d033b6a5cc6c247a50ed89c97b0cde2c0721f9992e28344ff10b54d83b6028592883d18341fbd5a7b80d36578b62ca19e
+  metadata.gz: c78924a1a8ad16e71c65989580e6b22b17e9fca132829fcd8d0b179284ba37c0aea827633acd1fb0ddfb30b29e8b1c904bf4e4398f3d814dce8ea2a1762775a3
+  data.tar.gz: a4526ac0f36242d8114a3d681453585dda82f9a0c5cb5420f3d2d7afe3b128a5ad277660c6fba0c75cd0dab85993b0af495a41c2ca5d783ed2c65da4e42d2ca7

data/.rubocop.yml

@@ -1 +1,4 @@
 inherit_from: default.yml
+
+Rails:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v2.1.0 2024-01-26
+## What's Changed
+- Add cops for Rails + NxtCore logger functionality
+
 # v2.0.2 2024-01-10
 ## What's Changed
 * Disable more cops depending on the code style in our backend-services

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_cop (2.0.2)
+    nxt_cop (2.1.0)
       rubocop (~> 1.60.0)
       rubocop-rails (~> 2.8)
       rubocop-rspec (~> 2.12)
@@ -33,7 +33,7 @@ GEM
     minitest (5.21.2)
     mutex_m (0.2.0)
     parallel (1.24.0)
-    parser (3.3.0.4)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
@@ -42,7 +42,7 @@ GEM
     rake (13.1.0)
     regexp_parser (2.9.0)
     rexml (3.2.6)
-    rubocop (1.60.1)
+    rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)

data/custom_cops/nxt_core/rails/missing_logger_include.rb

@@ -0,0 +1,39 @@
+# 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

data/custom_cops/nxt_core/rails/use_of_rails_logger.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CustomCops
+  module NxtCore
+    module Rails
+      # Ensures that the NxtCore logger is used instead of `Rails.logger`.
+      class UseOfRailsLogger < RuboCop::Cop::Base
+        extend RuboCop::Cop::AutoCorrector
+
+        RESTRICT_ON_SEND = [:logger].freeze
+
+        MSG = 'Use of Rails.logger is not allowed. Use `logger` and include `Nxt::Loggable`'
+
+        def on_send(node)
+          return unless node.receiver&.const_type? && node.receiver.short_name == :Rails
+
+          add_offense(node, message: MSG) do |corrector|
+            corrected = node.source.gsub('Rails.logger', 'logger')
+            corrector.replace(node, corrected)
+          end
+        end
+      end
+    end
+  end
+end

data/default.yml

@@ -1,12 +1,20 @@
 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:
     - Exclude
     - Include
 
+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:
     - bin/guard

data/lib/nxt_cop/version.rb

@@ -1,3 +1,3 @@
 module NxtCop
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nxt_cop
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Scott Livingstone
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -88,6 +88,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -98,6 +99,8 @@ 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
 - nxt_cop.gemspec
@@ -124,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Getsafe shared Rubocop.