rubocop-neeto 0.1.14 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae8944880d20f276426bf727a892f8d3b07a02cbba66fa734362d194eff9c693
-  data.tar.gz: 944c435b5bbaf72915d631ee5000f82b93b12ff752653782656a67083665c7e8
+  metadata.gz: fef927f6b5a152b14ff20ef805c7827e613f8daa8328545d523c9d9835d7aa54
+  data.tar.gz: 7042247a4a2f2c6a67ade4f63ef09269fae0ada7eea76ed0994fac82fb4d8e51
 SHA512:
-  metadata.gz: 5cb4071674f3abf3a935170e5b747ced06eafd98ffbcca76459e34858bf0b983cc4f69db5533ecb567450f1c725c52bbe489fc51c26db77277fc3e8aca59736b
-  data.tar.gz: b9a3a5d98df5092f19ae3f7685548d399682cf763db6c0bcfb415d6c66174d07373110737e96051f2451cf473227ece1a3eeba08358af12f87c341d64fd24540
+  metadata.gz: 78bb3316b19e1711485815504076819bb08f336af7ae7b780dc4beb40f816ae71a54d5c11de2bf7144f3eeb970fd4e0297e530a61ac865e406329a9c57e50d1d
+  data.tar.gz: 6994e654164b41c70e859fe75517c6650be12ec56ff4d84508cd4de13bc888e8fe6b1278c58c163a8b17d67eab22a623bd413d5f55b2733b97a549686021c13b

data/README.md

@@ -5,6 +5,7 @@
 1. [Neeto/UnsafeTableDeletion](https://rubocop-neeto.neetodeployapp.com/docs/RuboCop/Cop/Neeto/UnsafeTableDeletion)
 2. [Neeto/UnsafeColumnDeletion](https://rubocop-neeto.neetodeployapp.com/docs/RuboCop/Cop/Neeto/UnsafeColumnDeletion)
 3. [Neeto/DirectEnvAccess](https://rubocop-neeto.neetodeployapp.com/docs/RuboCop/Cop/Neeto/DirectEnvAccess)
+4. [Neeto/DeprecatedJobBaseClass](https://rubocop-neeto.neetodeployapp.com/docs/RuboCop/Cop/Neeto/DeprecatedJobBaseClass)
 
 ## Installation
 

data/config/default.yml

@@ -26,14 +26,29 @@ Neeto/UnsafeColumnDeletion:
 
 Neeto/DirectEnvAccess:
   Description: >-
-    Rails had `secrets.yml` which provided a single source of truth for all
-    environment variables and their fallback values. Rails deprecated this in
-    favor of encrypted credentials, so we created Secvault to maintain
-    centralized configuration. Direct usage of `ENV` bypasses this system,
-    making it harder to track what environment variables are being used and
-    their defaults. Use `Secvault.secrets` instead.
+    `config/secrets.yml` provides a single source of truth for all environment
+    variables and their fallback values, loaded via Rails' built-in
+    `config_for`. Direct usage of `ENV` bypasses this system, making it harder
+    to track what environment variables are being used and their defaults.
+    Use `Rails.application.secrets` instead.
   Enabled: true
   Severity: refactor
   VersionAdded: '0.1'
   Include:
     - app/**/*.rb
+
+Neeto/DeprecatedJobBaseClass:
+  Description: >-
+    Jobs should not inherit directly from the legacy
+    `NeetoCommonsBackend::BaseJobs::*` base classes. Use latency-based job
+    classes such as `LatencyBasedJobs::Within5Seconds`,
+    `LatencyBasedJobs::Within1Minute`, `LatencyBasedJobs::Within5Minutes`,
+    or `LatencyBasedJobs::Within1Hour` instead.
+  Enabled: true
+  Severity: refactor
+  VersionAdded: '0.1'
+  Include:
+    - app/jobs/**/*.rb
+    - app/workers/**/*.rb
+    - test/dummy/app/jobs/**/*.rb
+    - test/dummy/app/workers/**/*.rb

data/lib/rubocop/cop/neeto/deprecated_job_base_class.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Neeto
+      # The legacy `NeetoCommonsBackend::BaseJobs::*` base classes have been
+      # replaced with latency-based job classes such as
+      # `LatencyBasedJobs::Within5Seconds`, `LatencyBasedJobs::Within1Minute`,
+      # `LatencyBasedJobs::Within5Minutes`, and `LatencyBasedJobs::Within1Hour`.
+      # This cop prevents new jobs from inheriting directly from the legacy
+      # Neeto Commons base classes.
+      #
+      # @example DeprecatedJobBaseClass: true (default)
+      #   # bad
+      #   class ExportJob < NeetoCommonsBackend::BaseJobs::Default
+      #   end
+      #
+      #   # bad
+      #   class SyncWebhookJob < NeetoCommonsBackend::BaseJobs::Urgent
+      #   end
+      #
+      #   # good
+      #   class ExportJob < LatencyBasedJobs::Within5Minutes
+      #   end
+      #
+      #   # good
+      #   class SyncWebhookJob < LatencyBasedJobs::Within5Seconds
+      #   end
+      #
+      #   # good
+      #   # Defining the latency classes themselves
+      #   module LatencyBasedJobs
+      #     class Within5Seconds < NeetoCommonsBackend::BaseJobs::Base
+      #     end
+      #   end
+      #
+      class DeprecatedJobBaseClass < Base
+        LEGACY_SUPERCLASSES = {
+          "NeetoCommonsBackend::BaseJobs::Urgent" => "Use `LatencyBasedJobs::Within5Seconds` instead.",
+          "NeetoCommonsBackend::BaseJobs::Auth" => "Use `LatencyBasedJobs::Within1Minute` instead.",
+          "NeetoCommonsBackend::BaseJobs::Default" => "Use `LatencyBasedJobs::Within1Minute` or `LatencyBasedJobs::Within5Minutes` based on the job's SLA.",
+          "NeetoCommonsBackend::BaseJobs::Low" => "Use `LatencyBasedJobs::Within1Hour` instead.",
+          "NeetoCommonsBackend::BaseJobs::Base" => "Use a latency-based job base class instead, for example `LatencyBasedJobs::Within5Seconds`, `LatencyBasedJobs::Within1Minute`, `LatencyBasedJobs::Within5Minutes`, or `LatencyBasedJobs::Within1Hour`."
+        }.freeze
+
+        MSG = "Do not inherit jobs directly from `%<superclass>s`. %<replacement>s"
+
+        def on_class(node)
+          return if allowed_file_path?
+
+          superclass = node.parent_class
+          return unless superclass&.const_type?
+
+          superclass_name = superclass.const_name
+          replacement = LEGACY_SUPERCLASSES[superclass_name]
+          return unless replacement
+
+          add_offense(superclass, message: format(MSG, superclass: superclass_name, replacement:))
+        end
+
+        private
+
+          def allowed_file_path?
+            file_path = processed_source.file_path.to_s
+
+            file_path.end_with?("app/jobs/concerns/latency_based_jobs.rb") ||
+              file_path.match?(%r{(?:\A|/)app/jobs/neeto_commons_backend/base_jobs/})
+          end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/neeto/direct_env_access.rb

@@ -3,16 +3,15 @@
 module RuboCop
   module Cop
     module Neeto
-      # Rails had `secrets.yml` which provided a single source of truth for all
-      # environment variables and their fallback values. Rails deprecated this in
-      # favor of encrypted credentials, so we created Secvault
-      # (https://github.com/neetozone/secvault) to maintain centralized configuration.
-      # Direct usage of `ENV` bypasses this system, making it harder to track what
-      # environment variables are being used and their defaults. This cop enforces
-      # that all environment variable access goes through `Secvault.secrets`.
+      # `config/secrets.yml` provides a single source of truth for all
+      # environment variables and their fallback values, loaded via Rails'
+      # built-in `config_for`. Direct usage of `ENV` bypasses this system,
+      # making it harder to track what environment variables are being used
+      # and their defaults. This cop enforces that all environment variable
+      # access goes through `Rails.application.secrets`.
       #
       # @example DirectEnvAccess: true (default)
-      #   # Enforces the usage of `Secvault.secrets` over direct `ENV` access.
+      #   # Enforces the usage of `Rails.application.secrets` over direct `ENV` access.
       #
       #   # bad
       #   api_key = ENV['STRIPE_API_KEY']
@@ -21,17 +20,17 @@ module RuboCop
       #   default_timezone = ENV['DEFAULT_TIMEZONE'] || 'UTC'
       #
       #   # good
-      #   api_key = Secvault.secrets.stripe_api_key
+      #   api_key = Rails.application.secrets.stripe_api_key
       #
       #   # good
-      #   default_timezone = Secvault.secrets.default_timezone
+      #   default_timezone = Rails.application.secrets.default_timezone
       #
       #   # good (ENV access is permitted in directories other than the app directory)
       #   config.log_level = ENV.fetch('LOG_LEVEL', 'info')
       #
       class DirectEnvAccess < Base
         MSG = "Do not use ENV directly. " \
-              "Use Secvault.secrets to maintain a single source of truth for configuration."
+              "Use Rails.application.secrets to maintain a single source of truth for configuration."
 
         def_node_matcher :env_access?, <<~PATTERN
           (const {nil? cbase} :ENV)

data/lib/rubocop/cop/neeto_cops.rb

@@ -3,3 +3,4 @@
 require_relative "neeto/unsafe_table_deletion"
 require_relative "neeto/unsafe_column_deletion"
 require_relative "neeto/direct_env_access"
+require_relative "neeto/deprecated_job_base_class"

data/lib/rubocop/neeto/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Neeto
-    VERSION = "0.1.14"
+    VERSION = "0.1.16"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-neeto
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.16
 platform: ruby
 authors:
 - Abhay V Ashokan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-02 00:00:00.000000000 Z
+date: 2026-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -35,6 +35,7 @@ files:
 - Rakefile
 - config/default.yml
 - lib/rubocop-neeto.rb
+- lib/rubocop/cop/neeto/deprecated_job_base_class.rb
 - lib/rubocop/cop/neeto/direct_env_access.rb
 - lib/rubocop/cop/neeto/unsafe_column_deletion.rb
 - lib/rubocop/cop/neeto/unsafe_table_deletion.rb