nxt_cop 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa842f12fc52becc03c69ab9b31ed84490cef95cfab304e560afdaedc076dab
-  data.tar.gz: 6f5a9aa11731b24bbe97107efec680a5e7aa7753752419c69b4f3051ea605ee5
+  metadata.gz: 2b196848eede14a56c47b9828efd5b5f6f5fb47f70cc259aa509536dd683e71e
+  data.tar.gz: e967860b4d70d8bd00abf0127c04216b61d216e71c8c1a631a055b83abd82957
 SHA512:
-  metadata.gz: 7bcca20a477fd8130a27aa595f0eb39cd548502d6f6accd75a8cef97931e0f2b7627244be6776b72afb8b0f231f1716146a74c23151968ce9c5e36e1b66f36ac
-  data.tar.gz: fa16aa38b4f39b64b8592774f5306ad08692a0058090f070e57f7ed794ffe9624ef3ff5e9c755ef77388ba8d4c2444632e79b013529c9199b21eee141e67aaae
+  metadata.gz: c81ef302a52a1acb9facb68fe1ec2a695ffaa28d95e5a671fc7ac3444304a43fc354172b72ae680a46ef90653b7ff37f7239ae4220e49a66afcd09e8bced84c4
+  data.tar.gz: 2419798b3be96e052a18cce5af279952015c00057ed66b02d9c987cb535ad4d5c58e4c24b836612ae34d474c927db976a74f170b2326c402949369675a51640f

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.0
+    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/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 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)
+
 # v2.2.0 2024-01-30
 ## What's Changed
 - Add rubocop-factory_bot

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_cop (2.2.0)
+    nxt_cop (2.4.0)
       rubocop (~> 1.60.0)
       rubocop-rails (~> 2.8)
       rubocop-rspec (~> 2.12)
@@ -24,6 +24,7 @@ GEM
     bigdecimal (3.1.6)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
+    diff-lcs (1.5.1)
     drb (2.2.0)
       ruby2_keywords
     i18n (1.14.1)
@@ -42,6 +43,21 @@ GEM
     rake (13.1.0)
     regexp_parser (2.9.0)
     rexml (3.2.6)
+    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.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -81,6 +97,8 @@ DEPENDENCIES
   bundler (~> 2.1)
   nxt_cop!
   rake (~> 13.0)
+  rspec
+  rspec_junit_formatter
 
 BUNDLED WITH
    2.1.4

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:
@@ -30,26 +26,17 @@ AllCops:
   DisabledByDefault: false
   NewCops: disable # to avoid warnings. TODO: remove this setting and add new cops from the warning.
 
-# A bunch of these layout cops are enabled by default,
-# but for some reason 'DisableByDefault' is set to 'true' above.
-# Removing this configuration leads to a lot of violations triggered
-# by other cops that are not auto-correctable.
+
 Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
 Layout/ArrayAlignment:
   EnforcedStyle: with_fixed_indentation
-Layout/HashAlignment:
-  EnforcedHashRocketStyle: key
 Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 Layout/MultilineArrayLineBreaks:
   Enabled: true
-Layout/MultilineBlockLayout:
-  Enabled: true
 Layout/MultilineHashKeyLineBreaks:
   Enabled: true
-Layout/MultilineHashBraceLayout:
-  Enabled: true
 Layout/FirstMethodArgumentLineBreak:
   Enabled: true
 Layout/MultilineMethodCallBraceLayout:
@@ -74,120 +61,22 @@ Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 Layout/FirstArrayElementLineBreak:
   Enabled: true
-Layout/IndentationWidth:
-  Enabled: true
-Layout/ClosingParenthesisIndentation:
-  Enabled: true
-Layout/FirstArgumentIndentation:
-  Enabled: true
-Layout/ElseAlignment:
-  Enabled: true
-Layout/FirstHashElementIndentation:
-  Enabled: true
-Layout/AssignmentIndentation:
-  Enabled: true
-Layout/CaseIndentation:
-  Enabled: true
-Layout/MultilineArrayBraceLayout:
-  Enabled: true
-Layout/BeginEndAlignment:
-  Enabled: true
-Layout/CommentIndentation:
-  Enabled: true
-Layout/DotPosition:
-  EnforcedStyle: leading
-Layout/EmptyLineAfterGuardClause:
-  Enabled: true
-Layout/IndentationConsistency:
-  Enabled: true
 Layout/MultilineMethodParameterLineBreaks:
   Enabled: true
-Layout/SpaceBeforeBlockBraces:
-  Enabled: true
-Layout/SpaceInsideBlockBraces:
-  Enabled: true
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: true
-Layout/TrailingEmptyLines:
-  Enabled: true
-Layout/EmptyLinesAroundClassBody:
-  EnforcedStyle: no_empty_lines
-Layout/EmptyLinesAroundBlockBody:
-  EnforcedStyle: no_empty_lines
-Layout/TrailingWhitespace:
-  AllowInHeredoc: false
-Layout/SpaceBeforeComma:
-  Enabled: true
-Layout/SpaceAfterComma:
-  Enabled: true
-Layout/EmptyLines:
-  Enabled: true
-Layout/EmptyLineAfterMagicComment:
-  Enabled: true
 
 Lint:
   Enabled: true
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - spec/**/*
-Lint/BinaryOperatorWithIdenticalOperands:
-  Enabled: true
-Lint/ConstantDefinitionInBlock:
-  Enabled: true
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-Lint/DuplicateElsifCondition:
-  Enabled: true
-Lint/DuplicateRequire:
-  Enabled: true
-Lint/DuplicateRescueException:
-  Enabled: true
-Lint/EmptyConditionalBody:
-  Enabled: true
-Lint/EmptyFile:
-  Enabled: true
-Lint/FloatComparison:
-  Enabled: true
-Lint/IdentityComparison:
-  Enabled: true
 Lint/Loop:
   Enabled: false
 Lint/MissingSuper:
   Enabled: false
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-Lint/OutOfRangeRegexpRef:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/SelfAssignment:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
 Lint/SymbolConversion:
   EnforcedStyle: consistent
-Lint/TopLevelReturnWithArgument:
-  Enabled: true
-Lint/TrailingCommaInAttributeDeclaration:
-  Enabled: true
-Lint/UnreachableLoop:
-  Enabled: true
-Lint/UselessMethodDefinition:
-  Enabled: true
-Lint/UselessTimes:
-  Enabled: true
-Style/MutableConstant:
-  Enabled: true
-Style/StringLiterals:
-  Enabled: true
-Style/SymbolArray:
-  Enabled: true
 Style/TrailingCommaInHashLiteral:
   Enabled: false
-Style/TrailingCommaInArguments:
-  Enabled: true
-Style/WordArray:
-  Enabled: true
 Style/HashSyntax:
   Enabled: true
   EnforcedShorthandSyntax: either
@@ -246,7 +135,7 @@ Lint/IncompatibleIoSelectWithFiberScheduler:
   Enabled: false
 Lint/LambdaWithoutLiteralBlock:
   Enabled: false
-Lint/NoReturnInBeginEndBlocks:
+Lint/NoReturnInBeginEndBlocks:  # ❌ ENABLE THIS!
   Enabled: false
 Lint/NumberedParameterAssignment:
   Enabled: false
@@ -513,155 +402,3 @@ Style/EmptyElse:
   Enabled: false
 Style/MixinUsage: # Enable and then manually disable offenses?
   Enabled: false
-
-
-
-# ✅ Enabled in 2.0 version (activated by "enable all rules by default')
-# Let's keep commented list here for visibility for a while
-#
-#Layout/SpaceInsideParens:
-#  Enabled: false
-#Layout/SpaceBeforeFirstArg:
-#  Enabled: false
-#Layout/ExtraSpacing:
-#  Enabled: false
-#Layout/SpaceAfterColon:
-#  Enabled: false
-#Rails/PluralizationGrammar:
-#  Enabled: false
-#Layout/SpaceAroundMethodCallOperator:
-#  Enabled: false
-#Style/RedundantFreeze:
-#  Enabled: false
-#Layout/SpaceInLambdaLiteral:
-#  Enabled: false
-#Layout/LeadingCommentSpace:
-#  Enabled: false
-#Layout/DefEndAlignment:
-#  Enabled: false
-#Style/RedundantRegexpEscape:
-#  Enabled: false
-#Layout/HeredocIndentation:
-#  Enabled: false
-#Layout/ClosingHeredocIndentation:
-#  Enabled: false
-#Layout/LeadingEmptyLines:
-#  Enabled: false
-#Layout/EmptyLinesAroundAccessModifier:
-#  Enabled: false
-#Style/NegatedIf:
-#  Enabled: false
-#Style/CommentAnnotation:
-#  Enabled: false
-#Layout/MultilineOperationIndentation:
-#  Enabled: false
-#Style/ExpandPathArguments:
-#  Enabled: false
-#Layout/EmptyLinesAroundMethodBody:
-#  Enabled: false
-#Style/RedundantReturn:
-#  Enabled: false
-#Style/GlobalStdStream:
-#  Enabled: false
-#Style/FloatDivision:
-#  Enabled: false
-#Style/RescueStandardError:
-#  Enabled: false
-#Style/NilComparison:
-#  Enabled: false
-#Style/RedundantFetchBlock:
-#  Enabled: false
-#Style/Encoding:
-#  Enabled: false
-#Style/EmptyLiteral:
-#  Enabled: false
-#Layout/SpaceInsideReferenceBrackets:
-#  Enabled: false
-#Style/EmptyLambdaParameter:
-#  Enabled: false
-#Style/TernaryParentheses:
-#  Enabled: false
-#Naming/MethodName:
-#  Enabled: false
-#Style/SlicingWithRange:
-#  Enabled: false
-#Style/EmptyCaseCondition:
-#  Enabled: false
-#Style/SoleNestedConditional:
-#  Enabled: false
-#Rails/FindEach:
-#  Enabled: false
-#Style/RedundantFileExtensionInRequire:
-#  Enabled: false
-#Layout/SpaceInsideArrayLiteralBrackets:
-#  Enabled: false
-#Style/HashAsLastArrayItem:
-#  Enabled: false
-#Lint/RedundantCopDisableDirective:
-#  Enabled: false
-#Layout/SpaceAroundKeyword:
-#  Enabled: false
-#Style/KeywordParametersOrder:
-#  Enabled: false
-#Style/BlockComments:
-#  Enabled: false
-#Style/AndOr:
-#  Enabled: false
-#Style/EachWithObject:
-#  Enabled: false
-#Layout/SpaceAroundBlockParameters:
-#  Enabled: false
-#Style/MultilineTernaryOperator:
-#  Enabled: false
-#Style/RedundantParentheses:
-#  Enabled: false
-#Security/JSONLoad:
-#  Enabled: false
-#Style/MethodCallWithoutArgsParentheses:
-#  Enabled: false
-#Style/CommentedKeyword:
-#  Enabled: false
-#Style/MultilineIfModifier:
-#  Enabled: false
-#Style/IfInsideElse:
-#  Enabled: false
-#Style/AccessorGrouping:
-#  Enabled: false
-#Layout/BlockEndNewline:
-#  Enabled: false
-#Rails/RedundantForeignKey:
-#  Enabled: false
-#Style/UnlessElse:
-#  Enabled: false
-#Layout/EmptyLinesAroundModuleBody:
-#  Enabled: false
-#Rails/RakeEnvironment:
-#  Enabled: false
-#Layout/EmptyLinesAroundArguments:
-#  Enabled: false
-#Style/EachForSimpleLoop:
-#  Enabled: false
-#Style/ClassCheck:
-#  Enabled: false
-#Style/NestedParenthesizedCalls:
-#  Enabled: false
-#Style/LineEndConcatenation:
-#  Enabled: false
-#Style/ParallelAssignment:
-#  Enabled: false
-#Layout/EmptyLinesAroundExceptionHandlingKeywords:
-#  Enabled: false
-#Layout/SpaceAroundEqualsInParameterDefault:
-#  Enabled: false
-#Style/YodaCondition:
-#  Enabled: false
-#Layout/SpaceInsideStringInterpolation:
-#  Enabled: false
-#Style/EmptyMethod:
-#  Enabled: false
-#Layout/EmptyLineBetweenDefs:
-#  Enabled: false
-#Naming/ConstantName:
-#  Enabled: false
-#Rails/RelativeDateConstant:
-#  Enabled: false

data/lib/nxt_cop/version.rb

@@ -1,3 +1,3 @@
 module NxtCop
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/nxt_cop.gemspec

@@ -38,4 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rubocop-rspec', '~> 2.12'
   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.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Scott Livingstone
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-14 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -80,13 +80,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 +130,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

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