ezcater_rubocop 7.1.2 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 911fadcf937e62f81a8fc64de11cb3d59738c0fcb25b95839439248afbb5d620
-  data.tar.gz: 57099d0884b73639be2669343e3fbd516e3b0b10f518b2e4003220c910f0ae64
+  metadata.gz: d1a7228be76189e5a330bb1e9edae0e1bc35be77af84aebae08fd9b76f652283
+  data.tar.gz: 5727cedd1aa216879a69a06b02448a1eb3806e15ea82339d4ee5f14cfb87c162
 SHA512:
-  metadata.gz: 82d100a66b9c66c1da3f491f0c8f5c9876771c7ab4e608be8e9357c1e1e7838cd63f6d5578d854141d46aae65ade6d90ba0499410d68c6902c6083fa5636893e
-  data.tar.gz: 2904b76df7994b7e8b746a921108137d3c98dafbdfef4993866ab415f021f8d60900f8730699e248d5208c1205c47405e77471f87dafd2493adef3ddf8b74e95
+  metadata.gz: 4cc8fd3788297b86403405edfc35e2b17ade3aa5a6656249021b022e41377cebd894ab45938204eefc556cb5585761ee89ecdf45c9613ce6256d99bcc06e0258
+  data.tar.gz: 844b539b44ffd246b2cc03af450d0239f2e3cd515e9e0ba7acdbd797b9cd229888ecd0ef1785faced9e7c06d82051690bc779e13d56c448afa57e000423b3d7c

data/CHANGELOG.md

@@ -6,8 +6,16 @@ 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.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/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/lib/ezcater_rubocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzcaterRubocop
-  VERSION = "7.1.2"
+  VERSION = "8.0.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.0.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -205,6 +205,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- bin/check_configs.sh
 - bin/circle_rubocop.rb
 - conf/rubocop.yml
 - conf/rubocop_gem.yml
@@ -217,6 +218,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