ezcater_rubocop 7.1.2 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 911fadcf937e62f81a8fc64de11cb3d59738c0fcb25b95839439248afbb5d620
-  data.tar.gz: 57099d0884b73639be2669343e3fbd516e3b0b10f518b2e4003220c910f0ae64
+  metadata.gz: d2a15bcc812b70fc80eeec6fc23e6e42f3ab5083292e558721b93096af34db61
+  data.tar.gz: c03044d686ebd1eb695988ab440eb80ca1efe929b91f96a87615a9683596883e
 SHA512:
-  metadata.gz: 82d100a66b9c66c1da3f491f0c8f5c9876771c7ab4e608be8e9357c1e1e7838cd63f6d5578d854141d46aae65ade6d90ba0499410d68c6902c6083fa5636893e
-  data.tar.gz: 2904b76df7994b7e8b746a921108137d3c98dafbdfef4993866ab415f021f8d60900f8730699e248d5208c1205c47405e77471f87dafd2493adef3ddf8b74e95
+  metadata.gz: 75618a8349b879090e8f7ef1a83c923fb15742db3f6975ade39bd4402ade7532724197d6dae3f6fe336348136ef5596e5bceb16f0dea41489a5fc923ba75563e
+  data.tar.gz: 119974969557ec72d6ad84f061b99714ea085a9f2547252813f572c5ce7573569ca2f45517b703945941320bf07029e2459939e9ffa877e80504693e8ba68b48

data/CHANGELOG.md

@@ -6,8 +6,20 @@ This gem is moving onto its own [Semantic Versioning](https://semver.org/) schem
 
 Prior to v1.0.0 this gem was versioned based on the `MAJOR`.`MINOR` version of RuboCop. The first release of the ezcater_rubocop gem was `v0.49.0`.
 
+## 8.0.1 (February 20, 2025)
+
+- Pin maximum versions of `rubocop` and `rubocop-rails` to the versions before they moved to the `plugin` architecture in 1.72 and 2.28, respectively
+
+## 8.0.0
+
+- Add `Ezcater/Migration/BigintForeignKey` Cop, which enforces the use of `bigint` for foreign keys in migrations.
+
+## 7.1.3
+
+- Update internal CI processes to validate Rubocop config files
+
 ## 7.1.2
-- 
+
 - Fix a stray space in `Rails/BulkChangeTable` definition
 
 ## 7.1.1

data/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: .
+  specs:
+    ezcater_rubocop (8.1.0)
+      parser (>= 2.6)
+      rubocop (>= 1.16.0, < 1.72.0)
+      rubocop-graphql (>= 0.14.0, < 1.0)
+      rubocop-rails (>= 2.10.1, < 2.28.0)
+      rubocop-rspec (>= 2.22.0, < 2.28.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.2.2.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    diff-lcs (1.6.0)
+    docile (1.4.1)
+    drb (2.2.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    logger (1.6.6)
+    method_source (1.1.0)
+    minitest (5.25.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.8.1)
+    rack (3.1.10)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.71.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-graphql (0.19.0)
+      rubocop (>= 0.87, < 2)
+    rubocop-rails (2.27.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (2.27.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  arm64-darwin-24
+
+DEPENDENCIES
+  bundler
+  ezcater_rubocop!
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.11)
+  rspec_junit_formatter
+  simplecov
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -48,6 +48,10 @@ Further customization of RuboCop for your local project may be added to this fil
 - **rubocop_gem**: For use in Ruby gem projects, this inherits from the **rubocop** configuration.
 - **rubocop_rails**: For Rails projects, this inherits from the **rubocop** configuration.
 
+### Documentation
+
+Visit https://gemdocs.org/gems/ezcater_rubocop to view the documentation for our custom cops in the latest release.
+
 ## Usage
 
 Run `rubocop` for an entire project:
@@ -92,8 +96,9 @@ not add cops with `enabled: false` unless you want that cop to always be disable
 * [RspecRequireFeatureFlagMock](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_feature_flag_mock.rb) - Enforce use of `mock_feature_flag` helper instead of mocking `FeatureFlag.is_active?` directly.
 * [RspecRequireHttpStatusMatcher](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/rspec_require_http_status_matcher.rb) - Use the HTTP status code matcher, like `expect(response).to have_http_status :bad_request`, rather than `expect(response.code).to eq 400`
 * [StyleDig](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/style_dig.rb) - Recommend `dig` for deeply nested access.
+* [Migration/BigintForeignKey](https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/migration/bigint_foreign_key.rb) - Use `#bigint` instead of `#integer` for all foreign keys.
 
-[GraphQL/NotAuthorizedScalarField]: https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/graphql/not_authorized_scalar_field.rb)
+[GraphQL/NotAuthorizedScalarField]: https://github.com/ezcater/ezcater_rubocop/blob/main/lib/rubocop/cop/ezcater/graphql/not_authorized_scalar_field.rb
 
 ## Development
 

data/bin/check_configs.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# Checks the validity of RuboCop config files in `conf/` directory (excluding the base config).
+
+CONFIGS=(
+  "conf/rubocop_gem.yml"
+  "conf/rubocop_rails.yml"
+)
+
+exit_code=0
+
+for config in "${CONFIGS[@]}"; do
+  if ! output=$(bundle exec rubocop --show-cops -c "$config" 2>&1); then
+    echo "❌ Error in $config"
+    echo "$output"
+    exit_code=1
+  fi
+done
+
+if [[ $exit_code -eq 0 ]]; then
+  echo "✅ All configs are valid"
+fi
+exit $exit_code

data/config/default.yml

@@ -74,3 +74,8 @@ GraphQL/ObjectDescription:
 GraphQL/ExtractInputType:
   Exclude:
     - "**/input_objects/**/*.rb"
+
+Ezcater/Migration/BigintForeignKey:
+  Description: "Use `bigint` instead of `integer` for all foreign keys."
+  Include:
+    - "**/db/migrate/**/*.rb"

data/ezcater_rubocop.gemspec

@@ -52,8 +52,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
 
   spec.add_runtime_dependency "parser", ">= 2.6"
-  spec.add_runtime_dependency "rubocop", ">= 1.16.0", "< 2.0"
+  spec.add_runtime_dependency "rubocop", ">= 1.16.0", "< 1.72.0"
   spec.add_runtime_dependency "rubocop-graphql", ">= 0.14.0", "< 1.0"
-  spec.add_runtime_dependency "rubocop-rails", ">= 2.10.1", "< 3.0"
+  spec.add_runtime_dependency "rubocop-rails", ">= 2.10.1", "< 2.28.0"
   spec.add_runtime_dependency "rubocop-rspec", ">= 2.22.0", "< 2.28.0"
 end

data/lib/ezcater_rubocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzcaterRubocop
-  VERSION = "7.1.2"
+  VERSION = "8.1.0"
 end

data/lib/ezcater_rubocop.rb

@@ -16,19 +16,20 @@ puts "configuration from #{DEFAULT_FILES}" if RuboCop::ConfigLoader.debug?
 config = RuboCop::ConfigLoader.merge_with_default(config, path)
 RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
 
-require "rubocop/cop/ezcater/direct_env_check"
-require "rubocop/cop/ezcater/feature_flag_active"
-require "rubocop/cop/ezcater/feature_flag_name_valid"
-require "rubocop/cop/ezcater/graphql/not_authorized_scalar_field"
-require "rubocop/cop/ezcater/rails_configuration"
-require "rubocop/cop/ezcater/rails_env"
-require "rubocop/cop/ezcater/ruby_timeout"
-require "rubocop/cop/ezcater/rails_top_level_sql_execute"
-require "rubocop/cop/ezcater/require_custom_error"
-require "rubocop/cop/ezcater/require_gql_error_helpers"
-require "rubocop/cop/ezcater/rspec_match_ordered_array"
-require "rubocop/cop/ezcater/rspec_require_browser_mock"
-require "rubocop/cop/ezcater/rspec_require_feature_flag_mock"
-require "rubocop/cop/ezcater/rspec_require_http_status_matcher"
-require "rubocop/cop/ezcater/rspec_dot_not_self_dot"
-require "rubocop/cop/ezcater/style_dig"
+require_relative "rubocop/cop/ezcater/direct_env_check"
+require_relative "rubocop/cop/ezcater/feature_flag_active"
+require_relative "rubocop/cop/ezcater/feature_flag_name_valid"
+require_relative "rubocop/cop/ezcater/graphql/not_authorized_scalar_field"
+require_relative "rubocop/cop/ezcater/rails_configuration"
+require_relative "rubocop/cop/ezcater/rails_env"
+require_relative "rubocop/cop/ezcater/ruby_timeout"
+require_relative "rubocop/cop/ezcater/rails_top_level_sql_execute"
+require_relative "rubocop/cop/ezcater/require_custom_error"
+require_relative "rubocop/cop/ezcater/require_gql_error_helpers"
+require_relative "rubocop/cop/ezcater/rspec_match_ordered_array"
+require_relative "rubocop/cop/ezcater/rspec_require_browser_mock"
+require_relative "rubocop/cop/ezcater/rspec_require_feature_flag_mock"
+require_relative "rubocop/cop/ezcater/rspec_require_http_status_matcher"
+require_relative "rubocop/cop/ezcater/rspec_dot_not_self_dot"
+require_relative "rubocop/cop/ezcater/style_dig"
+require_relative "rubocop/cop/ezcater/migration/bigint_foreign_key"

data/lib/rubocop/cop/ezcater/migration/bigint_foreign_key.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Ezcater
+      module Migration
+        # Use `bigint` instead of `integer` for all foreign keys.
+        #
+        # @example
+        #
+        #   # bad
+        #   create_table :foos do |t|
+        #     t.integer :bar_id
+        #   end
+        #
+        #   # bad
+        #   create_table :foos do |t|
+        #     t.integer :bar_id, limit: 7
+        #   end
+        #
+        #   # bad
+        #   add_column :foos, :bar_id, :integer
+        #
+        #   # bad
+        #   add_column :foos, :bar_id, :integer, limit: 7
+        #
+        #   # bad
+        #   add_reference :foos, :bar, type: :integer
+        #
+        #   # bad
+        #   add_reference :foos, :bar, type: :integer, limit: 7
+        #
+        #   # good
+        #   create_table :foos do |t|
+        #     t.bigint :bar_id
+        #   end
+        #
+        #   # good
+        #   create_table :foos do |t|
+        #     t.references :bar
+        #   end
+        #
+        #   # good
+        #   add_column :foos, :bar_id, :bigint
+        #
+        #   # good
+        #   add_reference :foos, :bar
+        #
+        class BigintForeignKey < Base # rubocop:disable Metrics/ClassLength
+          extend AutoCorrector
+
+          MSG = <<~MSG.chomp
+            Use `bigint` instead of `integer` for foreign keys. This ensures that they are capable of storing all possible values from referenced primary keys which are `bigint` or may eventually be migrated to `bigint`.
+          MSG
+
+          # Optimization: only call `on_send` for the methods in this list
+          RESTRICT_ON_SEND = %i(
+            integer
+            references
+            belongs_to
+            add_column
+            add_reference
+            add_belongs_to
+          ).freeze
+
+          BIGINT_BYTES = 8
+
+          # @!method t_integer_method(node)
+          def_node_matcher :t_integer_method, <<~PATTERN
+            (send
+              # Any local variable that calls an `integer` method
+              (lvar _) :integer
+
+              # Column name: symbol or string ending in _id
+              {(sym #ends_with_id?) (str #ends_with_id?)}
+
+              # Optional hash that includes a limit key
+              (hash <(pair (sym :limit) (int $_)) ...>)?
+            )
+          PATTERN
+
+          # @!method t_references_method(node)
+          def_node_matcher :t_references_method, <<~PATTERN
+            (send
+              # Any local variable that calls a `references` or `belongs_to` method
+              (lvar _) {:references :belongs_to}
+
+              # Reference name
+              {(sym _) (str _)}
+
+              # A hash that includes `type: :integer`
+              (hash <(pair (sym :type) (sym :integer)) ...>)
+            )
+          PATTERN
+
+          # @!method add_column_method(node)
+          def_node_matcher :add_column_method, <<~PATTERN
+            # A call to an `add_column` method
+            (send nil? :add_column
+              # Table name
+              {(sym _) (str _)}
+
+              # Column name: a symbol or string ending in _id
+              {(sym #ends_with_id?) (str #ends_with_id?)}
+
+              # Column type
+              (sym :integer)
+
+              # Optional hash that includes a limit key
+              (hash <(pair (sym :limit) (int $_)) ...>)?
+            )
+          PATTERN
+
+          # @!method add_reference_method(node)
+          def_node_matcher :add_reference_method, <<~PATTERN
+            # A call to a `add_reference` or `add_belongs_to` method
+            (send nil? {:add_reference :add_belongs_to}
+              # Table name
+              {(sym _) (str _)}
+
+              # Reference name
+              {(sym _) (str _)}
+
+              # A hash that includes `type: :integer`
+              (hash <(pair (sym :type) (sym :integer)) ...>)
+            )
+          PATTERN
+
+          # @!method limit_pair(node)
+          def_node_search :limit_pair, <<~PATTERN
+            (pair (sym :limit) (int $_))
+          PATTERN
+
+          def on_send(node)
+            t_integer_method(node) do |captures|
+              check_integer_method(node, captures)
+            end
+
+            add_column_method(node) do |captures|
+              check_integer_method(node, captures)
+            end
+
+            t_references_method(node) do
+              check_reference_method(node)
+            end
+
+            add_reference_method(node) do
+              check_reference_method(node)
+            end
+          end
+
+          private
+
+          def ends_with_id?(str)
+            str.end_with?("_id")
+          end
+
+          def check_integer_method(node, captures)
+            limit_value = captures.first
+            check_for_offense(node, limit_value)
+          end
+
+          def check_reference_method(node)
+            limit_vals = limit_pair(node)
+            limit_value = limit_vals.first
+
+            check_for_offense(node, limit_value)
+          end
+
+          def check_for_offense(node, limit_value)
+            return unless limit_value.nil? || limit_value < BIGINT_BYTES
+
+            add_offense(node) do |corrector|
+              make_correction(node, corrector)
+            end
+          end
+
+          def make_correction(node, corrector)
+            case node.method_name
+            when :integer
+              correct_integer_method(node, corrector)
+            when :references, :belongs_to
+              correct_references_method(node, corrector)
+            when :add_column
+              correct_add_column_method(node, corrector)
+            when :add_reference, :add_belongs_to
+              correct_add_reference_method(node, corrector)
+            end
+          end
+
+          def correct_integer_method(node, corrector)
+            # There's no hash argument or it has only one pair
+            if node.arguments.size == 1 ||
+               (node.arguments.size == 2 &&
+                (node.arguments[1].hash_type? &&
+                 node.arguments[1].pairs.size == 1))
+
+              corrector.replace(
+                range_for_method_and_optional_limit(node),
+                "bigint #{node.arguments[0].source}"
+              )
+            end
+          end
+
+          def correct_references_method(node, corrector)
+            # There's only one hash pair (:type) or only two: :type and :limit
+            return unless node.arguments.size == 2 && node.arguments[1].hash_type?
+
+            hash_pairs = node.arguments[1].pairs
+            keys = hash_pairs.map { |pair| pair.key.source }
+
+            if keys.size == 1 ||
+               (keys.size == 2 && keys.include?("limit"))
+
+              corrector.replace(
+                range_for_method_and_optional_limit(node),
+                "#{node.method_name} #{node.arguments[0].source}"
+              )
+            end
+          end
+
+          def correct_add_column_method(node, corrector)
+            # There's no hash argument or it has only one pair (:limit)
+            if node.arguments.size == 3 ||
+               (node.arguments.size == 4 &&
+                (node.arguments[3].hash_type? &&
+                 node.arguments[3].pairs.size == 1))
+
+              corrector.replace(
+                range_for_method_and_optional_limit(node),
+                "add_column #{node.arguments[0].source}, #{node.arguments[1].source}, :bigint"
+              )
+            end
+          end
+
+          def correct_add_reference_method(node, corrector)
+            # There's only one hash pair (:type) or only two: :type and :limit
+            return unless node.arguments.size == 3 && node.arguments[2].hash_type?
+
+            hash_pairs = node.arguments[2].pairs
+            keys = hash_pairs.map { |pair| pair.key.source }
+
+            if keys.size == 1 ||
+               (keys.size == 2 && keys.include?("limit"))
+
+              corrector.replace(
+                range_for_method_and_optional_limit(node),
+                "#{node.method_name} #{node.arguments[0].source}, #{node.arguments[1].source}"
+              )
+            end
+          end
+
+          def range_for_method_and_optional_limit(node)
+            Parser::Source::Range.new(
+              node.source_range.source_buffer,
+              node.selector.begin_pos,
+              node.source_range.end_pos
+            )
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 7.1.2
+  version: 8.1.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,7 +117,7 @@ dependencies:
         version: 1.16.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.72.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -127,7 +127,7 @@ dependencies:
         version: 1.16.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.72.0
 - !ruby/object:Gem::Dependency
   name: rubocop-graphql
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +157,7 @@ dependencies:
         version: 2.10.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.28.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -167,7 +167,7 @@ dependencies:
         version: 2.10.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.28.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -203,8 +203,10 @@ files:
 - ".tool-versions"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
+- bin/check_configs.sh
 - bin/circle_rubocop.rb
 - conf/rubocop.yml
 - conf/rubocop_gem.yml
@@ -217,6 +219,7 @@ files:
 - lib/rubocop/cop/ezcater/feature_flag_active.rb
 - lib/rubocop/cop/ezcater/feature_flag_name_valid.rb
 - lib/rubocop/cop/ezcater/graphql/not_authorized_scalar_field.rb
+- lib/rubocop/cop/ezcater/migration/bigint_foreign_key.rb
 - lib/rubocop/cop/ezcater/rails_configuration.rb
 - lib/rubocop/cop/ezcater/rails_env.rb
 - lib/rubocop/cop/ezcater/rails_top_level_sql_execute.rb