Module: ActiveRecord::Bitwise::Model

Extended by:
T::Sig
Defined in:
lib/active_record/bitwise.rb

Overview

Included/extended in ActiveRecord models to provide macro bitwise capabilities

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.add_column!(*values, records:) ⇒ Object

Class-level atomic method to add values to specific records.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/active_record/bitwise.rb', line 294

module Model
  extend T::Sig

  # Defines bitwise attributes, getters, setters, scopes, and helper methods.
  # @param column_name [T.any(Symbol, String)] The database column name.
  # @param mapping [T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)])] The enum/boolean value mapping.
  # @param default [T.nilable(T::Array[T.any(Symbol, String)])] Optional default values.
  # @param prefix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional prefix for method names.
  # @param suffix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional suffix for method names.
  # @return [void]
  sig do
    params(
      column_name: T.any(Symbol, String),
      mapping: T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)]),
      default: T.nilable(T::Array[T.any(Symbol, String)]),
      prefix: T.nilable(T.any(Symbol, String, T::Boolean)),
      suffix: T.nilable(T.any(Symbol, String, T::Boolean))
    ).void
  end
  def bitwise(column_name, mapping, default: nil, prefix: nil, suffix: nil)
    normalized_mapping = if mapping.is_a?(Array)
                           mapping.each_with_index.with_object({}) { |(k, idx), h| h[k.to_sym] = idx }
                         elsif mapping.is_a?(Hash)
                           mapping.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_i }
                         else
                           Kernel.raise ArgumentError, 'Mapping must be a Hash or an Array'
                         end

    default_val = default || []
    mapping_strings = normalized_mapping.keys.map(&:to_s)
    T.unsafe(self).bitwise_definitions = T.unsafe(self).bitwise_definitions.dup
    T.unsafe(self).bitwise_definitions[column_name.to_sym] = {
      mapping: normalized_mapping,
      default: default_val,
      prefix: prefix,
      suffix: suffix,
      validated: false
    }

    T.unsafe(self).attribute column_name, ActiveRecord::Bitwise::Type.new(column_name, normalized_mapping, default_val), default: default_val

    # Define getter
    T.unsafe(self).define_method(column_name) do
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      val = super()
      val = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(nil) if val.nil?

      if val.is_a?(Array) && !val.frozen?
        val = val.dup
        val.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        val.freeze
      elsif val.is_a?(Array) && val.frozen? && !val.instance_variable_defined?(:@_bitwise_raw_value)
        unfrozen = val.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        unfrozen.freeze
        val = unfrozen
      end
      val
    end

    # Define setter
    T.unsafe(self).define_method("#{column_name}=") do |new_value|
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      current_raw = raw_values[column_name.to_sym]
      typecaster = T.unsafe(self).class.attribute_types[column_name.to_s]
      casted = typecaster.cast(new_value)

      if casted.is_a?(Array)
        unfrozen = casted.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, current_raw)
        unfrozen.freeze
        casted = unfrozen
      end

      super(casted)
    end

    # Define prefix/suffix methods
    prefix_str = case prefix
                 when true then "#{T.unsafe(column_name.to_s).singularize}_"
                 when Symbol, String then "#{prefix}_"
                 else ''
                 end

    suffix_str = case suffix
                 when true then "_#{T.unsafe(column_name.to_s).singularize}"
                 when Symbol, String then "_#{suffix}"
                 else ''
                 end

    conflicting_methods = ActiveRecord::Base.instance_methods +
                          ActiveRecord::Base.private_instance_methods +
                          ActiveRecord::Base.protected_instance_methods

    normalized_mapping.each_key do |key|
      method_name = "#{prefix_str}#{key}#{suffix_str}"

      # Assert method collisions
      generated = ["#{method_name}?", "#{method_name}=", "#{method_name}!"]
      generated.each do |m|
        if conflicting_methods.include?(m.to_sym)
          Kernel.raise ArgumentError,
                       "Bitwise column #{column_name} mapping key #{key} generates method ##{m} which collides with core ActiveRecord::Base instance methods."
        end
      end

      T.unsafe(self).define_method("#{method_name}?") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name))
        current_values.include?(key)
      end

      T.unsafe(self).define_method("#{method_name}=") do |val|
        original_array = T.unsafe(self).public_send(column_name)
        current_values = Kernel.Array(original_array).dup
        if original_array.is_a?(Array) && original_array.instance_variable_defined?(:@_bitwise_raw_value)
          current_values.instance_variable_set(:@_bitwise_raw_value, original_array.instance_variable_get(:@_bitwise_raw_value))
        end
        if val
          current_values << key unless current_values.include?(key)
        else
          current_values.delete(key)
        end
        T.unsafe(self).public_send("#{column_name}=", current_values)
      end

      # @note This is a convenience wrapper that performs a full `save!` cycle
      #   (validations, callbacks, dirty tracking). It is NOT an atomic SQL operation.
      #   If a validation on another attribute fails, this will raise
      #   `ActiveRecord::RecordInvalid`. For truly atomic operations, use the
      #   instance-level `add_<singular>!` method instead.
      T.unsafe(self).define_method("#{method_name}!") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name)).dup
        current_values << key unless current_values.include?(key)
        T.unsafe(self).public_send("#{column_name}=", current_values)
        T.unsafe(self).save!
      end
    end

    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method("add_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) | ?", mask])
      end

      T.unsafe(self).define_method("remove_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) - (COALESCE(#{quoted_col}, 0) & ?)", mask])
      end
    end

    # Define Instance-level atomic methods
    # @note These methods perform the atomic SQL update, then read back the new value
    #   via a separate `pluck` query. There is a small TOCTOU window between the
    #   `update_all` and the `pluck` where another concurrent thread could modify
    #   the same row, causing the in-memory state to diverge from the DB. For
    #   absolute consistency, wrap usage in a transaction or re-read via `reload`.
    singular_col = T.unsafe(column_name.to_s).singularize

    T.unsafe(self).define_method("add_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("add_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("add_#{column_name}!") do |*values|
      T.unsafe(self).send("add_#{singular_col}!", *T.unsafe(values))
    end

    T.unsafe(self).define_method("remove_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("remove_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("remove_#{column_name}!") do |*values|
      T.unsafe(self).send("remove_#{singular_col}!", *T.unsafe(values))
    end

    # Define Scopes
    # @note `with_` and `with_any_` silently drop unrecognized values, returning
    #   `where('1=0')` (empty) only if ALL values are invalid. `with_exact_` returns
    #   `where('1=0')` if ANY value is invalid (strict validation). `without_` drops
    #   unrecognized values and returns `all` if none are valid.
    T.unsafe(self).scope "with_#{column_name}", Kernel.lambda { |*values|
      if values.empty?
        T.unsafe(self).connection.quote_column_name(column_name)
        return T.unsafe(self).all
      end

      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      if cleaned.include?(0) || cleaned.include?('0') || cleaned.empty?
        return T.unsafe(self).where("#{quoted_col} = 0")
      end

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = ?", mask, mask)
    }

    T.unsafe(self).scope "with_any_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? > 0", mask)
    }

    T.unsafe(self).scope "with_exact_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)

      return T.unsafe(self).where("#{quoted_col} = 0") if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }

      return T.unsafe(self).where('1=0') if valid.size < cleaned.size

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} = ?", mask)
    }

    T.unsafe(self).scope "without_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).all if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = 0", mask)
    }

    # Define schema helper class method
    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method(:bitwise_schema) do |col|
        T.unsafe(self).bitwise_definitions.dig(col.to_sym, :mapping)
      end
    end

    # Register callbacks (guarded to prevent duplicate registration when
    # multiple bitwise columns are defined on the same model)
    T.unsafe(self).class_eval do
      any_ancestor_registered = T.unsafe(self).ancestors.any? do |ancestor|
        ancestor.instance_variable_defined?(:@_bitwise_callbacks_registered) &&
          ancestor.instance_variable_get(:@_bitwise_callbacks_registered)
      end
      unless any_ancestor_registered
        T.unsafe(self).instance_variable_set(:@_bitwise_callbacks_registered, true)

        T.unsafe(self).after_initialize :_validate_bitwise_column_type_and_bounds
        T.unsafe(self).after_save :_reset_bitwise_raw_value_caches

        T.unsafe(self).define_method(:clear_bitwise_raw_values_cache!) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:reload) do |*args|
          T.unsafe(self).clear_bitwise_raw_values_cache!
          super(*args)
        end

        T.unsafe(self).define_method(:_validate_bitwise_column_type_and_bounds) do
          if T.unsafe(self).class.instance_variable_defined?(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.instance_variable_get(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.bitwise_definitions.values.all? { |config| config[:validated] }
            return
          end

          all_validated = T.let(true, T::Boolean)
          T.unsafe(self).class.bitwise_definitions.each do |col, config|
            next if T.unsafe(config)[:validated]

            begin
              next unless T.unsafe(self).class.connection.active? && T.unsafe(self).class.table_exists?

              column = T.unsafe(self).class.columns_hash[col.to_s]
              unless column && T.unsafe(column).type == :integer
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} must be an integer database column"
              end

              max_bits = case T.unsafe(column).limit
                         when 1 then 7
                         when 2 then 15
                         when 4, nil then 31
                         when 8 then 63
                         else 31
                         end

              max_assigned_position = config[:mapping].values.max || 0
              if max_assigned_position >= max_bits
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} has limit of #{T.unsafe(column).limit || 4} bytes (max #{max_bits} flags), but mapping requires bit shift position #{max_assigned_position}."
              end

              T.unsafe(config)[:validated] = true
            rescue ArgumentError => e
              Kernel.raise e
            rescue StandardError
              all_validated = false
              # Ignore database missing errors
            end
          end

          return unless all_validated && T.unsafe(self).class.bitwise_definitions.present?

          T.unsafe(self).class.instance_variable_set(:@_bitwise_columns_validated, true)
        end

        T.unsafe(self).define_method(:_reset_bitwise_raw_value_caches) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:initialize_dup) do |other|
          super(other)
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end
      end
    end
    nil
  end

  # Automatically extends the base class with bitwise definitions attribute.
  # @param base [T::Module[T.anything]] The class extending this module.
  # @return [void]
  sig { params(base: T::Module[T.anything]).void }
  def self.extended(base)
    T.unsafe(base).class_attribute :bitwise_definitions, default: {}
  end
end

.bitwise_schema(col) ⇒ Object

Returns the mapping schema for the specified bitwise column.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/active_record/bitwise.rb', line 294

module Model
  extend T::Sig

  # Defines bitwise attributes, getters, setters, scopes, and helper methods.
  # @param column_name [T.any(Symbol, String)] The database column name.
  # @param mapping [T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)])] The enum/boolean value mapping.
  # @param default [T.nilable(T::Array[T.any(Symbol, String)])] Optional default values.
  # @param prefix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional prefix for method names.
  # @param suffix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional suffix for method names.
  # @return [void]
  sig do
    params(
      column_name: T.any(Symbol, String),
      mapping: T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)]),
      default: T.nilable(T::Array[T.any(Symbol, String)]),
      prefix: T.nilable(T.any(Symbol, String, T::Boolean)),
      suffix: T.nilable(T.any(Symbol, String, T::Boolean))
    ).void
  end
  def bitwise(column_name, mapping, default: nil, prefix: nil, suffix: nil)
    normalized_mapping = if mapping.is_a?(Array)
                           mapping.each_with_index.with_object({}) { |(k, idx), h| h[k.to_sym] = idx }
                         elsif mapping.is_a?(Hash)
                           mapping.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_i }
                         else
                           Kernel.raise ArgumentError, 'Mapping must be a Hash or an Array'
                         end

    default_val = default || []
    mapping_strings = normalized_mapping.keys.map(&:to_s)
    T.unsafe(self).bitwise_definitions = T.unsafe(self).bitwise_definitions.dup
    T.unsafe(self).bitwise_definitions[column_name.to_sym] = {
      mapping: normalized_mapping,
      default: default_val,
      prefix: prefix,
      suffix: suffix,
      validated: false
    }

    T.unsafe(self).attribute column_name, ActiveRecord::Bitwise::Type.new(column_name, normalized_mapping, default_val), default: default_val

    # Define getter
    T.unsafe(self).define_method(column_name) do
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      val = super()
      val = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(nil) if val.nil?

      if val.is_a?(Array) && !val.frozen?
        val = val.dup
        val.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        val.freeze
      elsif val.is_a?(Array) && val.frozen? && !val.instance_variable_defined?(:@_bitwise_raw_value)
        unfrozen = val.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        unfrozen.freeze
        val = unfrozen
      end
      val
    end

    # Define setter
    T.unsafe(self).define_method("#{column_name}=") do |new_value|
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      current_raw = raw_values[column_name.to_sym]
      typecaster = T.unsafe(self).class.attribute_types[column_name.to_s]
      casted = typecaster.cast(new_value)

      if casted.is_a?(Array)
        unfrozen = casted.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, current_raw)
        unfrozen.freeze
        casted = unfrozen
      end

      super(casted)
    end

    # Define prefix/suffix methods
    prefix_str = case prefix
                 when true then "#{T.unsafe(column_name.to_s).singularize}_"
                 when Symbol, String then "#{prefix}_"
                 else ''
                 end

    suffix_str = case suffix
                 when true then "_#{T.unsafe(column_name.to_s).singularize}"
                 when Symbol, String then "_#{suffix}"
                 else ''
                 end

    conflicting_methods = ActiveRecord::Base.instance_methods +
                          ActiveRecord::Base.private_instance_methods +
                          ActiveRecord::Base.protected_instance_methods

    normalized_mapping.each_key do |key|
      method_name = "#{prefix_str}#{key}#{suffix_str}"

      # Assert method collisions
      generated = ["#{method_name}?", "#{method_name}=", "#{method_name}!"]
      generated.each do |m|
        if conflicting_methods.include?(m.to_sym)
          Kernel.raise ArgumentError,
                       "Bitwise column #{column_name} mapping key #{key} generates method ##{m} which collides with core ActiveRecord::Base instance methods."
        end
      end

      T.unsafe(self).define_method("#{method_name}?") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name))
        current_values.include?(key)
      end

      T.unsafe(self).define_method("#{method_name}=") do |val|
        original_array = T.unsafe(self).public_send(column_name)
        current_values = Kernel.Array(original_array).dup
        if original_array.is_a?(Array) && original_array.instance_variable_defined?(:@_bitwise_raw_value)
          current_values.instance_variable_set(:@_bitwise_raw_value, original_array.instance_variable_get(:@_bitwise_raw_value))
        end
        if val
          current_values << key unless current_values.include?(key)
        else
          current_values.delete(key)
        end
        T.unsafe(self).public_send("#{column_name}=", current_values)
      end

      # @note This is a convenience wrapper that performs a full `save!` cycle
      #   (validations, callbacks, dirty tracking). It is NOT an atomic SQL operation.
      #   If a validation on another attribute fails, this will raise
      #   `ActiveRecord::RecordInvalid`. For truly atomic operations, use the
      #   instance-level `add_<singular>!` method instead.
      T.unsafe(self).define_method("#{method_name}!") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name)).dup
        current_values << key unless current_values.include?(key)
        T.unsafe(self).public_send("#{column_name}=", current_values)
        T.unsafe(self).save!
      end
    end

    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method("add_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) | ?", mask])
      end

      T.unsafe(self).define_method("remove_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) - (COALESCE(#{quoted_col}, 0) & ?)", mask])
      end
    end

    # Define Instance-level atomic methods
    # @note These methods perform the atomic SQL update, then read back the new value
    #   via a separate `pluck` query. There is a small TOCTOU window between the
    #   `update_all` and the `pluck` where another concurrent thread could modify
    #   the same row, causing the in-memory state to diverge from the DB. For
    #   absolute consistency, wrap usage in a transaction or re-read via `reload`.
    singular_col = T.unsafe(column_name.to_s).singularize

    T.unsafe(self).define_method("add_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("add_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("add_#{column_name}!") do |*values|
      T.unsafe(self).send("add_#{singular_col}!", *T.unsafe(values))
    end

    T.unsafe(self).define_method("remove_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("remove_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("remove_#{column_name}!") do |*values|
      T.unsafe(self).send("remove_#{singular_col}!", *T.unsafe(values))
    end

    # Define Scopes
    # @note `with_` and `with_any_` silently drop unrecognized values, returning
    #   `where('1=0')` (empty) only if ALL values are invalid. `with_exact_` returns
    #   `where('1=0')` if ANY value is invalid (strict validation). `without_` drops
    #   unrecognized values and returns `all` if none are valid.
    T.unsafe(self).scope "with_#{column_name}", Kernel.lambda { |*values|
      if values.empty?
        T.unsafe(self).connection.quote_column_name(column_name)
        return T.unsafe(self).all
      end

      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      if cleaned.include?(0) || cleaned.include?('0') || cleaned.empty?
        return T.unsafe(self).where("#{quoted_col} = 0")
      end

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = ?", mask, mask)
    }

    T.unsafe(self).scope "with_any_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? > 0", mask)
    }

    T.unsafe(self).scope "with_exact_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)

      return T.unsafe(self).where("#{quoted_col} = 0") if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }

      return T.unsafe(self).where('1=0') if valid.size < cleaned.size

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} = ?", mask)
    }

    T.unsafe(self).scope "without_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).all if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = 0", mask)
    }

    # Define schema helper class method
    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method(:bitwise_schema) do |col|
        T.unsafe(self).bitwise_definitions.dig(col.to_sym, :mapping)
      end
    end

    # Register callbacks (guarded to prevent duplicate registration when
    # multiple bitwise columns are defined on the same model)
    T.unsafe(self).class_eval do
      any_ancestor_registered = T.unsafe(self).ancestors.any? do |ancestor|
        ancestor.instance_variable_defined?(:@_bitwise_callbacks_registered) &&
          ancestor.instance_variable_get(:@_bitwise_callbacks_registered)
      end
      unless any_ancestor_registered
        T.unsafe(self).instance_variable_set(:@_bitwise_callbacks_registered, true)

        T.unsafe(self).after_initialize :_validate_bitwise_column_type_and_bounds
        T.unsafe(self).after_save :_reset_bitwise_raw_value_caches

        T.unsafe(self).define_method(:clear_bitwise_raw_values_cache!) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:reload) do |*args|
          T.unsafe(self).clear_bitwise_raw_values_cache!
          super(*args)
        end

        T.unsafe(self).define_method(:_validate_bitwise_column_type_and_bounds) do
          if T.unsafe(self).class.instance_variable_defined?(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.instance_variable_get(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.bitwise_definitions.values.all? { |config| config[:validated] }
            return
          end

          all_validated = T.let(true, T::Boolean)
          T.unsafe(self).class.bitwise_definitions.each do |col, config|
            next if T.unsafe(config)[:validated]

            begin
              next unless T.unsafe(self).class.connection.active? && T.unsafe(self).class.table_exists?

              column = T.unsafe(self).class.columns_hash[col.to_s]
              unless column && T.unsafe(column).type == :integer
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} must be an integer database column"
              end

              max_bits = case T.unsafe(column).limit
                         when 1 then 7
                         when 2 then 15
                         when 4, nil then 31
                         when 8 then 63
                         else 31
                         end

              max_assigned_position = config[:mapping].values.max || 0
              if max_assigned_position >= max_bits
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} has limit of #{T.unsafe(column).limit || 4} bytes (max #{max_bits} flags), but mapping requires bit shift position #{max_assigned_position}."
              end

              T.unsafe(config)[:validated] = true
            rescue ArgumentError => e
              Kernel.raise e
            rescue StandardError
              all_validated = false
              # Ignore database missing errors
            end
          end

          return unless all_validated && T.unsafe(self).class.bitwise_definitions.present?

          T.unsafe(self).class.instance_variable_set(:@_bitwise_columns_validated, true)
        end

        T.unsafe(self).define_method(:_reset_bitwise_raw_value_caches) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:initialize_dup) do |other|
          super(other)
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end
      end
    end
    nil
  end

  # Automatically extends the base class with bitwise definitions attribute.
  # @param base [T::Module[T.anything]] The class extending this module.
  # @return [void]
  sig { params(base: T::Module[T.anything]).void }
  def self.extended(base)
    T.unsafe(base).class_attribute :bitwise_definitions, default: {}
  end
end

.extended(base) ⇒ Object 



700
701
702
 
# File 'lib/active_record/bitwise.rb', line 700

def self.extended(base)
  T.unsafe(base).class_attribute :bitwise_definitions, default: {}
end

.remove_column!(*values, records:) ⇒ Object

Class-level atomic method to remove values from specific records.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/active_record/bitwise.rb', line 294

module Model
  extend T::Sig

  # Defines bitwise attributes, getters, setters, scopes, and helper methods.
  # @param column_name [T.any(Symbol, String)] The database column name.
  # @param mapping [T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)])] The enum/boolean value mapping.
  # @param default [T.nilable(T::Array[T.any(Symbol, String)])] Optional default values.
  # @param prefix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional prefix for method names.
  # @param suffix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional suffix for method names.
  # @return [void]
  sig do
    params(
      column_name: T.any(Symbol, String),
      mapping: T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)]),
      default: T.nilable(T::Array[T.any(Symbol, String)]),
      prefix: T.nilable(T.any(Symbol, String, T::Boolean)),
      suffix: T.nilable(T.any(Symbol, String, T::Boolean))
    ).void
  end
  def bitwise(column_name, mapping, default: nil, prefix: nil, suffix: nil)
    normalized_mapping = if mapping.is_a?(Array)
                           mapping.each_with_index.with_object({}) { |(k, idx), h| h[k.to_sym] = idx }
                         elsif mapping.is_a?(Hash)
                           mapping.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_i }
                         else
                           Kernel.raise ArgumentError, 'Mapping must be a Hash or an Array'
                         end

    default_val = default || []
    mapping_strings = normalized_mapping.keys.map(&:to_s)
    T.unsafe(self).bitwise_definitions = T.unsafe(self).bitwise_definitions.dup
    T.unsafe(self).bitwise_definitions[column_name.to_sym] = {
      mapping: normalized_mapping,
      default: default_val,
      prefix: prefix,
      suffix: suffix,
      validated: false
    }

    T.unsafe(self).attribute column_name, ActiveRecord::Bitwise::Type.new(column_name, normalized_mapping, default_val), default: default_val

    # Define getter
    T.unsafe(self).define_method(column_name) do
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      val = super()
      val = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(nil) if val.nil?

      if val.is_a?(Array) && !val.frozen?
        val = val.dup
        val.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        val.freeze
      elsif val.is_a?(Array) && val.frozen? && !val.instance_variable_defined?(:@_bitwise_raw_value)
        unfrozen = val.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        unfrozen.freeze
        val = unfrozen
      end
      val
    end

    # Define setter
    T.unsafe(self).define_method("#{column_name}=") do |new_value|
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      current_raw = raw_values[column_name.to_sym]
      typecaster = T.unsafe(self).class.attribute_types[column_name.to_s]
      casted = typecaster.cast(new_value)

      if casted.is_a?(Array)
        unfrozen = casted.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, current_raw)
        unfrozen.freeze
        casted = unfrozen
      end

      super(casted)
    end

    # Define prefix/suffix methods
    prefix_str = case prefix
                 when true then "#{T.unsafe(column_name.to_s).singularize}_"
                 when Symbol, String then "#{prefix}_"
                 else ''
                 end

    suffix_str = case suffix
                 when true then "_#{T.unsafe(column_name.to_s).singularize}"
                 when Symbol, String then "_#{suffix}"
                 else ''
                 end

    conflicting_methods = ActiveRecord::Base.instance_methods +
                          ActiveRecord::Base.private_instance_methods +
                          ActiveRecord::Base.protected_instance_methods

    normalized_mapping.each_key do |key|
      method_name = "#{prefix_str}#{key}#{suffix_str}"

      # Assert method collisions
      generated = ["#{method_name}?", "#{method_name}=", "#{method_name}!"]
      generated.each do |m|
        if conflicting_methods.include?(m.to_sym)
          Kernel.raise ArgumentError,
                       "Bitwise column #{column_name} mapping key #{key} generates method ##{m} which collides with core ActiveRecord::Base instance methods."
        end
      end

      T.unsafe(self).define_method("#{method_name}?") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name))
        current_values.include?(key)
      end

      T.unsafe(self).define_method("#{method_name}=") do |val|
        original_array = T.unsafe(self).public_send(column_name)
        current_values = Kernel.Array(original_array).dup
        if original_array.is_a?(Array) && original_array.instance_variable_defined?(:@_bitwise_raw_value)
          current_values.instance_variable_set(:@_bitwise_raw_value, original_array.instance_variable_get(:@_bitwise_raw_value))
        end
        if val
          current_values << key unless current_values.include?(key)
        else
          current_values.delete(key)
        end
        T.unsafe(self).public_send("#{column_name}=", current_values)
      end

      # @note This is a convenience wrapper that performs a full `save!` cycle
      #   (validations, callbacks, dirty tracking). It is NOT an atomic SQL operation.
      #   If a validation on another attribute fails, this will raise
      #   `ActiveRecord::RecordInvalid`. For truly atomic operations, use the
      #   instance-level `add_<singular>!` method instead.
      T.unsafe(self).define_method("#{method_name}!") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name)).dup
        current_values << key unless current_values.include?(key)
        T.unsafe(self).public_send("#{column_name}=", current_values)
        T.unsafe(self).save!
      end
    end

    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method("add_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) | ?", mask])
      end

      T.unsafe(self).define_method("remove_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) - (COALESCE(#{quoted_col}, 0) & ?)", mask])
      end
    end

    # Define Instance-level atomic methods
    # @note These methods perform the atomic SQL update, then read back the new value
    #   via a separate `pluck` query. There is a small TOCTOU window between the
    #   `update_all` and the `pluck` where another concurrent thread could modify
    #   the same row, causing the in-memory state to diverge from the DB. For
    #   absolute consistency, wrap usage in a transaction or re-read via `reload`.
    singular_col = T.unsafe(column_name.to_s).singularize

    T.unsafe(self).define_method("add_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("add_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("add_#{column_name}!") do |*values|
      T.unsafe(self).send("add_#{singular_col}!", *T.unsafe(values))
    end

    T.unsafe(self).define_method("remove_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("remove_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("remove_#{column_name}!") do |*values|
      T.unsafe(self).send("remove_#{singular_col}!", *T.unsafe(values))
    end

    # Define Scopes
    # @note `with_` and `with_any_` silently drop unrecognized values, returning
    #   `where('1=0')` (empty) only if ALL values are invalid. `with_exact_` returns
    #   `where('1=0')` if ANY value is invalid (strict validation). `without_` drops
    #   unrecognized values and returns `all` if none are valid.
    T.unsafe(self).scope "with_#{column_name}", Kernel.lambda { |*values|
      if values.empty?
        T.unsafe(self).connection.quote_column_name(column_name)
        return T.unsafe(self).all
      end

      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      if cleaned.include?(0) || cleaned.include?('0') || cleaned.empty?
        return T.unsafe(self).where("#{quoted_col} = 0")
      end

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = ?", mask, mask)
    }

    T.unsafe(self).scope "with_any_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? > 0", mask)
    }

    T.unsafe(self).scope "with_exact_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)

      return T.unsafe(self).where("#{quoted_col} = 0") if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }

      return T.unsafe(self).where('1=0') if valid.size < cleaned.size

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} = ?", mask)
    }

    T.unsafe(self).scope "without_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).all if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = 0", mask)
    }

    # Define schema helper class method
    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method(:bitwise_schema) do |col|
        T.unsafe(self).bitwise_definitions.dig(col.to_sym, :mapping)
      end
    end

    # Register callbacks (guarded to prevent duplicate registration when
    # multiple bitwise columns are defined on the same model)
    T.unsafe(self).class_eval do
      any_ancestor_registered = T.unsafe(self).ancestors.any? do |ancestor|
        ancestor.instance_variable_defined?(:@_bitwise_callbacks_registered) &&
          ancestor.instance_variable_get(:@_bitwise_callbacks_registered)
      end
      unless any_ancestor_registered
        T.unsafe(self).instance_variable_set(:@_bitwise_callbacks_registered, true)

        T.unsafe(self).after_initialize :_validate_bitwise_column_type_and_bounds
        T.unsafe(self).after_save :_reset_bitwise_raw_value_caches

        T.unsafe(self).define_method(:clear_bitwise_raw_values_cache!) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:reload) do |*args|
          T.unsafe(self).clear_bitwise_raw_values_cache!
          super(*args)
        end

        T.unsafe(self).define_method(:_validate_bitwise_column_type_and_bounds) do
          if T.unsafe(self).class.instance_variable_defined?(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.instance_variable_get(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.bitwise_definitions.values.all? { |config| config[:validated] }
            return
          end

          all_validated = T.let(true, T::Boolean)
          T.unsafe(self).class.bitwise_definitions.each do |col, config|
            next if T.unsafe(config)[:validated]

            begin
              next unless T.unsafe(self).class.connection.active? && T.unsafe(self).class.table_exists?

              column = T.unsafe(self).class.columns_hash[col.to_s]
              unless column && T.unsafe(column).type == :integer
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} must be an integer database column"
              end

              max_bits = case T.unsafe(column).limit
                         when 1 then 7
                         when 2 then 15
                         when 4, nil then 31
                         when 8 then 63
                         else 31
                         end

              max_assigned_position = config[:mapping].values.max || 0
              if max_assigned_position >= max_bits
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} has limit of #{T.unsafe(column).limit || 4} bytes (max #{max_bits} flags), but mapping requires bit shift position #{max_assigned_position}."
              end

              T.unsafe(config)[:validated] = true
            rescue ArgumentError => e
              Kernel.raise e
            rescue StandardError
              all_validated = false
              # Ignore database missing errors
            end
          end

          return unless all_validated && T.unsafe(self).class.bitwise_definitions.present?

          T.unsafe(self).class.instance_variable_set(:@_bitwise_columns_validated, true)
        end

        T.unsafe(self).define_method(:_reset_bitwise_raw_value_caches) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:initialize_dup) do |other|
          super(other)
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end
      end
    end
    nil
  end

  # Automatically extends the base class with bitwise definitions attribute.
  # @param base [T::Module[T.anything]] The class extending this module.
  # @return [void]
  sig { params(base: T::Module[T.anything]).void }
  def self.extended(base)
    T.unsafe(base).class_attribute :bitwise_definitions, default: {}
  end
end

Instance Method Details

#add_column!(*values) ⇒ Object

Alias for add_singular!.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/active_record/bitwise.rb', line 294

module Model
  extend T::Sig

  # Defines bitwise attributes, getters, setters, scopes, and helper methods.
  # @param column_name [T.any(Symbol, String)] The database column name.
  # @param mapping [T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)])] The enum/boolean value mapping.
  # @param default [T.nilable(T::Array[T.any(Symbol, String)])] Optional default values.
  # @param prefix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional prefix for method names.
  # @param suffix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional suffix for method names.
  # @return [void]
  sig do
    params(
      column_name: T.any(Symbol, String),
      mapping: T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)]),
      default: T.nilable(T::Array[T.any(Symbol, String)]),
      prefix: T.nilable(T.any(Symbol, String, T::Boolean)),
      suffix: T.nilable(T.any(Symbol, String, T::Boolean))
    ).void
  end
  def bitwise(column_name, mapping, default: nil, prefix: nil, suffix: nil)
    normalized_mapping = if mapping.is_a?(Array)
                           mapping.each_with_index.with_object({}) { |(k, idx), h| h[k.to_sym] = idx }
                         elsif mapping.is_a?(Hash)
                           mapping.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_i }
                         else
                           Kernel.raise ArgumentError, 'Mapping must be a Hash or an Array'
                         end

    default_val = default || []
    mapping_strings = normalized_mapping.keys.map(&:to_s)
    T.unsafe(self).bitwise_definitions = T.unsafe(self).bitwise_definitions.dup
    T.unsafe(self).bitwise_definitions[column_name.to_sym] = {
      mapping: normalized_mapping,
      default: default_val,
      prefix: prefix,
      suffix: suffix,
      validated: false
    }

    T.unsafe(self).attribute column_name, ActiveRecord::Bitwise::Type.new(column_name, normalized_mapping, default_val), default: default_val

    # Define getter
    T.unsafe(self).define_method(column_name) do
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      val = super()
      val = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(nil) if val.nil?

      if val.is_a?(Array) && !val.frozen?
        val = val.dup
        val.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        val.freeze
      elsif val.is_a?(Array) && val.frozen? && !val.instance_variable_defined?(:@_bitwise_raw_value)
        unfrozen = val.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        unfrozen.freeze
        val = unfrozen
      end
      val
    end

    # Define setter
    T.unsafe(self).define_method("#{column_name}=") do |new_value|
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      current_raw = raw_values[column_name.to_sym]
      typecaster = T.unsafe(self).class.attribute_types[column_name.to_s]
      casted = typecaster.cast(new_value)

      if casted.is_a?(Array)
        unfrozen = casted.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, current_raw)
        unfrozen.freeze
        casted = unfrozen
      end

      super(casted)
    end

    # Define prefix/suffix methods
    prefix_str = case prefix
                 when true then "#{T.unsafe(column_name.to_s).singularize}_"
                 when Symbol, String then "#{prefix}_"
                 else ''
                 end

    suffix_str = case suffix
                 when true then "_#{T.unsafe(column_name.to_s).singularize}"
                 when Symbol, String then "_#{suffix}"
                 else ''
                 end

    conflicting_methods = ActiveRecord::Base.instance_methods +
                          ActiveRecord::Base.private_instance_methods +
                          ActiveRecord::Base.protected_instance_methods

    normalized_mapping.each_key do |key|
      method_name = "#{prefix_str}#{key}#{suffix_str}"

      # Assert method collisions
      generated = ["#{method_name}?", "#{method_name}=", "#{method_name}!"]
      generated.each do |m|
        if conflicting_methods.include?(m.to_sym)
          Kernel.raise ArgumentError,
                       "Bitwise column #{column_name} mapping key #{key} generates method ##{m} which collides with core ActiveRecord::Base instance methods."
        end
      end

      T.unsafe(self).define_method("#{method_name}?") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name))
        current_values.include?(key)
      end

      T.unsafe(self).define_method("#{method_name}=") do |val|
        original_array = T.unsafe(self).public_send(column_name)
        current_values = Kernel.Array(original_array).dup
        if original_array.is_a?(Array) && original_array.instance_variable_defined?(:@_bitwise_raw_value)
          current_values.instance_variable_set(:@_bitwise_raw_value, original_array.instance_variable_get(:@_bitwise_raw_value))
        end
        if val
          current_values << key unless current_values.include?(key)
        else
          current_values.delete(key)
        end
        T.unsafe(self).public_send("#{column_name}=", current_values)
      end

      # @note This is a convenience wrapper that performs a full `save!` cycle
      #   (validations, callbacks, dirty tracking). It is NOT an atomic SQL operation.
      #   If a validation on another attribute fails, this will raise
      #   `ActiveRecord::RecordInvalid`. For truly atomic operations, use the
      #   instance-level `add_<singular>!` method instead.
      T.unsafe(self).define_method("#{method_name}!") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name)).dup
        current_values << key unless current_values.include?(key)
        T.unsafe(self).public_send("#{column_name}=", current_values)
        T.unsafe(self).save!
      end
    end

    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method("add_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) | ?", mask])
      end

      T.unsafe(self).define_method("remove_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) - (COALESCE(#{quoted_col}, 0) & ?)", mask])
      end
    end

    # Define Instance-level atomic methods
    # @note These methods perform the atomic SQL update, then read back the new value
    #   via a separate `pluck` query. There is a small TOCTOU window between the
    #   `update_all` and the `pluck` where another concurrent thread could modify
    #   the same row, causing the in-memory state to diverge from the DB. For
    #   absolute consistency, wrap usage in a transaction or re-read via `reload`.
    singular_col = T.unsafe(column_name.to_s).singularize

    T.unsafe(self).define_method("add_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("add_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("add_#{column_name}!") do |*values|
      T.unsafe(self).send("add_#{singular_col}!", *T.unsafe(values))
    end

    T.unsafe(self).define_method("remove_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("remove_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("remove_#{column_name}!") do |*values|
      T.unsafe(self).send("remove_#{singular_col}!", *T.unsafe(values))
    end

    # Define Scopes
    # @note `with_` and `with_any_` silently drop unrecognized values, returning
    #   `where('1=0')` (empty) only if ALL values are invalid. `with_exact_` returns
    #   `where('1=0')` if ANY value is invalid (strict validation). `without_` drops
    #   unrecognized values and returns `all` if none are valid.
    T.unsafe(self).scope "with_#{column_name}", Kernel.lambda { |*values|
      if values.empty?
        T.unsafe(self).connection.quote_column_name(column_name)
        return T.unsafe(self).all
      end

      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      if cleaned.include?(0) || cleaned.include?('0') || cleaned.empty?
        return T.unsafe(self).where("#{quoted_col} = 0")
      end

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = ?", mask, mask)
    }

    T.unsafe(self).scope "with_any_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? > 0", mask)
    }

    T.unsafe(self).scope "with_exact_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)

      return T.unsafe(self).where("#{quoted_col} = 0") if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }

      return T.unsafe(self).where('1=0') if valid.size < cleaned.size

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} = ?", mask)
    }

    T.unsafe(self).scope "without_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).all if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = 0", mask)
    }

    # Define schema helper class method
    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method(:bitwise_schema) do |col|
        T.unsafe(self).bitwise_definitions.dig(col.to_sym, :mapping)
      end
    end

    # Register callbacks (guarded to prevent duplicate registration when
    # multiple bitwise columns are defined on the same model)
    T.unsafe(self).class_eval do
      any_ancestor_registered = T.unsafe(self).ancestors.any? do |ancestor|
        ancestor.instance_variable_defined?(:@_bitwise_callbacks_registered) &&
          ancestor.instance_variable_get(:@_bitwise_callbacks_registered)
      end
      unless any_ancestor_registered
        T.unsafe(self).instance_variable_set(:@_bitwise_callbacks_registered, true)

        T.unsafe(self).after_initialize :_validate_bitwise_column_type_and_bounds
        T.unsafe(self).after_save :_reset_bitwise_raw_value_caches

        T.unsafe(self).define_method(:clear_bitwise_raw_values_cache!) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:reload) do |*args|
          T.unsafe(self).clear_bitwise_raw_values_cache!
          super(*args)
        end

        T.unsafe(self).define_method(:_validate_bitwise_column_type_and_bounds) do
          if T.unsafe(self).class.instance_variable_defined?(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.instance_variable_get(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.bitwise_definitions.values.all? { |config| config[:validated] }
            return
          end

          all_validated = T.let(true, T::Boolean)
          T.unsafe(self).class.bitwise_definitions.each do |col, config|
            next if T.unsafe(config)[:validated]

            begin
              next unless T.unsafe(self).class.connection.active? && T.unsafe(self).class.table_exists?

              column = T.unsafe(self).class.columns_hash[col.to_s]
              unless column && T.unsafe(column).type == :integer
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} must be an integer database column"
              end

              max_bits = case T.unsafe(column).limit
                         when 1 then 7
                         when 2 then 15
                         when 4, nil then 31
                         when 8 then 63
                         else 31
                         end

              max_assigned_position = config[:mapping].values.max || 0
              if max_assigned_position >= max_bits
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} has limit of #{T.unsafe(column).limit || 4} bytes (max #{max_bits} flags), but mapping requires bit shift position #{max_assigned_position}."
              end

              T.unsafe(config)[:validated] = true
            rescue ArgumentError => e
              Kernel.raise e
            rescue StandardError
              all_validated = false
              # Ignore database missing errors
            end
          end

          return unless all_validated && T.unsafe(self).class.bitwise_definitions.present?

          T.unsafe(self).class.instance_variable_set(:@_bitwise_columns_validated, true)
        end

        T.unsafe(self).define_method(:_reset_bitwise_raw_value_caches) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:initialize_dup) do |other|
          super(other)
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end
      end
    end
    nil
  end

  # Automatically extends the base class with bitwise definitions attribute.
  # @param base [T::Module[T.anything]] The class extending this module.
  # @return [void]
  sig { params(base: T::Module[T.anything]).void }
  def self.extended(base)
    T.unsafe(base).class_attribute :bitwise_definitions, default: {}
  end
end

#add_singular!(*values) ⇒ Object

Note:

This method wraps the database update in a transaction and uses locking to prevent TOCTOU races.

Instance-level atomic method to add values.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/active_record/bitwise.rb', line 294

module Model
  extend T::Sig

  # Defines bitwise attributes, getters, setters, scopes, and helper methods.
  # @param column_name [T.any(Symbol, String)] The database column name.
  # @param mapping [T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)])] The enum/boolean value mapping.
  # @param default [T.nilable(T::Array[T.any(Symbol, String)])] Optional default values.
  # @param prefix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional prefix for method names.
  # @param suffix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional suffix for method names.
  # @return [void]
  sig do
    params(
      column_name: T.any(Symbol, String),
      mapping: T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)]),
      default: T.nilable(T::Array[T.any(Symbol, String)]),
      prefix: T.nilable(T.any(Symbol, String, T::Boolean)),
      suffix: T.nilable(T.any(Symbol, String, T::Boolean))
    ).void
  end
  def bitwise(column_name, mapping, default: nil, prefix: nil, suffix: nil)
    normalized_mapping = if mapping.is_a?(Array)
                           mapping.each_with_index.with_object({}) { |(k, idx), h| h[k.to_sym] = idx }
                         elsif mapping.is_a?(Hash)
                           mapping.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_i }
                         else
                           Kernel.raise ArgumentError, 'Mapping must be a Hash or an Array'
                         end

    default_val = default || []
    mapping_strings = normalized_mapping.keys.map(&:to_s)
    T.unsafe(self).bitwise_definitions = T.unsafe(self).bitwise_definitions.dup
    T.unsafe(self).bitwise_definitions[column_name.to_sym] = {
      mapping: normalized_mapping,
      default: default_val,
      prefix: prefix,
      suffix: suffix,
      validated: false
    }

    T.unsafe(self).attribute column_name, ActiveRecord::Bitwise::Type.new(column_name, normalized_mapping, default_val), default: default_val

    # Define getter
    T.unsafe(self).define_method(column_name) do
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      val = super()
      val = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(nil) if val.nil?

      if val.is_a?(Array) && !val.frozen?
        val = val.dup
        val.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        val.freeze
      elsif val.is_a?(Array) && val.frozen? && !val.instance_variable_defined?(:@_bitwise_raw_value)
        unfrozen = val.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        unfrozen.freeze
        val = unfrozen
      end
      val
    end

    # Define setter
    T.unsafe(self).define_method("#{column_name}=") do |new_value|
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      current_raw = raw_values[column_name.to_sym]
      typecaster = T.unsafe(self).class.attribute_types[column_name.to_s]
      casted = typecaster.cast(new_value)

      if casted.is_a?(Array)
        unfrozen = casted.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, current_raw)
        unfrozen.freeze
        casted = unfrozen
      end

      super(casted)
    end

    # Define prefix/suffix methods
    prefix_str = case prefix
                 when true then "#{T.unsafe(column_name.to_s).singularize}_"
                 when Symbol, String then "#{prefix}_"
                 else ''
                 end

    suffix_str = case suffix
                 when true then "_#{T.unsafe(column_name.to_s).singularize}"
                 when Symbol, String then "_#{suffix}"
                 else ''
                 end

    conflicting_methods = ActiveRecord::Base.instance_methods +
                          ActiveRecord::Base.private_instance_methods +
                          ActiveRecord::Base.protected_instance_methods

    normalized_mapping.each_key do |key|
      method_name = "#{prefix_str}#{key}#{suffix_str}"

      # Assert method collisions
      generated = ["#{method_name}?", "#{method_name}=", "#{method_name}!"]
      generated.each do |m|
        if conflicting_methods.include?(m.to_sym)
          Kernel.raise ArgumentError,
                       "Bitwise column #{column_name} mapping key #{key} generates method ##{m} which collides with core ActiveRecord::Base instance methods."
        end
      end

      T.unsafe(self).define_method("#{method_name}?") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name))
        current_values.include?(key)
      end

      T.unsafe(self).define_method("#{method_name}=") do |val|
        original_array = T.unsafe(self).public_send(column_name)
        current_values = Kernel.Array(original_array).dup
        if original_array.is_a?(Array) && original_array.instance_variable_defined?(:@_bitwise_raw_value)
          current_values.instance_variable_set(:@_bitwise_raw_value, original_array.instance_variable_get(:@_bitwise_raw_value))
        end
        if val
          current_values << key unless current_values.include?(key)
        else
          current_values.delete(key)
        end
        T.unsafe(self).public_send("#{column_name}=", current_values)
      end

      # @note This is a convenience wrapper that performs a full `save!` cycle
      #   (validations, callbacks, dirty tracking). It is NOT an atomic SQL operation.
      #   If a validation on another attribute fails, this will raise
      #   `ActiveRecord::RecordInvalid`. For truly atomic operations, use the
      #   instance-level `add_<singular>!` method instead.
      T.unsafe(self).define_method("#{method_name}!") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name)).dup
        current_values << key unless current_values.include?(key)
        T.unsafe(self).public_send("#{column_name}=", current_values)
        T.unsafe(self).save!
      end
    end

    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method("add_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) | ?", mask])
      end

      T.unsafe(self).define_method("remove_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) - (COALESCE(#{quoted_col}, 0) & ?)", mask])
      end
    end

    # Define Instance-level atomic methods
    # @note These methods perform the atomic SQL update, then read back the new value
    #   via a separate `pluck` query. There is a small TOCTOU window between the
    #   `update_all` and the `pluck` where another concurrent thread could modify
    #   the same row, causing the in-memory state to diverge from the DB. For
    #   absolute consistency, wrap usage in a transaction or re-read via `reload`.
    singular_col = T.unsafe(column_name.to_s).singularize

    T.unsafe(self).define_method("add_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("add_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("add_#{column_name}!") do |*values|
      T.unsafe(self).send("add_#{singular_col}!", *T.unsafe(values))
    end

    T.unsafe(self).define_method("remove_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("remove_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("remove_#{column_name}!") do |*values|
      T.unsafe(self).send("remove_#{singular_col}!", *T.unsafe(values))
    end

    # Define Scopes
    # @note `with_` and `with_any_` silently drop unrecognized values, returning
    #   `where('1=0')` (empty) only if ALL values are invalid. `with_exact_` returns
    #   `where('1=0')` if ANY value is invalid (strict validation). `without_` drops
    #   unrecognized values and returns `all` if none are valid.
    T.unsafe(self).scope "with_#{column_name}", Kernel.lambda { |*values|
      if values.empty?
        T.unsafe(self).connection.quote_column_name(column_name)
        return T.unsafe(self).all
      end

      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      if cleaned.include?(0) || cleaned.include?('0') || cleaned.empty?
        return T.unsafe(self).where("#{quoted_col} = 0")
      end

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = ?", mask, mask)
    }

    T.unsafe(self).scope "with_any_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? > 0", mask)
    }

    T.unsafe(self).scope "with_exact_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)

      return T.unsafe(self).where("#{quoted_col} = 0") if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }

      return T.unsafe(self).where('1=0') if valid.size < cleaned.size

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} = ?", mask)
    }

    T.unsafe(self).scope "without_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).all if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = 0", mask)
    }

    # Define schema helper class method
    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method(:bitwise_schema) do |col|
        T.unsafe(self).bitwise_definitions.dig(col.to_sym, :mapping)
      end
    end

    # Register callbacks (guarded to prevent duplicate registration when
    # multiple bitwise columns are defined on the same model)
    T.unsafe(self).class_eval do
      any_ancestor_registered = T.unsafe(self).ancestors.any? do |ancestor|
        ancestor.instance_variable_defined?(:@_bitwise_callbacks_registered) &&
          ancestor.instance_variable_get(:@_bitwise_callbacks_registered)
      end
      unless any_ancestor_registered
        T.unsafe(self).instance_variable_set(:@_bitwise_callbacks_registered, true)

        T.unsafe(self).after_initialize :_validate_bitwise_column_type_and_bounds
        T.unsafe(self).after_save :_reset_bitwise_raw_value_caches

        T.unsafe(self).define_method(:clear_bitwise_raw_values_cache!) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:reload) do |*args|
          T.unsafe(self).clear_bitwise_raw_values_cache!
          super(*args)
        end

        T.unsafe(self).define_method(:_validate_bitwise_column_type_and_bounds) do
          if T.unsafe(self).class.instance_variable_defined?(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.instance_variable_get(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.bitwise_definitions.values.all? { |config| config[:validated] }
            return
          end

          all_validated = T.let(true, T::Boolean)
          T.unsafe(self).class.bitwise_definitions.each do |col, config|
            next if T.unsafe(config)[:validated]

            begin
              next unless T.unsafe(self).class.connection.active? && T.unsafe(self).class.table_exists?

              column = T.unsafe(self).class.columns_hash[col.to_s]
              unless column && T.unsafe(column).type == :integer
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} must be an integer database column"
              end

              max_bits = case T.unsafe(column).limit
                         when 1 then 7
                         when 2 then 15
                         when 4, nil then 31
                         when 8 then 63
                         else 31
                         end

              max_assigned_position = config[:mapping].values.max || 0
              if max_assigned_position >= max_bits
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} has limit of #{T.unsafe(column).limit || 4} bytes (max #{max_bits} flags), but mapping requires bit shift position #{max_assigned_position}."
              end

              T.unsafe(config)[:validated] = true
            rescue ArgumentError => e
              Kernel.raise e
            rescue StandardError
              all_validated = false
              # Ignore database missing errors
            end
          end

          return unless all_validated && T.unsafe(self).class.bitwise_definitions.present?

          T.unsafe(self).class.instance_variable_set(:@_bitwise_columns_validated, true)
        end

        T.unsafe(self).define_method(:_reset_bitwise_raw_value_caches) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:initialize_dup) do |other|
          super(other)
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end
      end
    end
    nil
  end

  # Automatically extends the base class with bitwise definitions attribute.
  # @param base [T::Module[T.anything]] The class extending this module.
  # @return [void]
  sig { params(base: T::Module[T.anything]).void }
  def self.extended(base)
    T.unsafe(base).class_attribute :bitwise_definitions, default: {}
  end
end

#bitwise(column_name, mapping, default: nil, prefix: nil, suffix: nil) ⇒ Object 



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/active_record/bitwise.rb', line 313

def bitwise(column_name, mapping, default: nil, prefix: nil, suffix: nil)
  normalized_mapping = if mapping.is_a?(Array)
                         mapping.each_with_index.with_object({}) { |(k, idx), h| h[k.to_sym] = idx }
                       elsif mapping.is_a?(Hash)
                         mapping.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_i }
                       else
                         Kernel.raise ArgumentError, 'Mapping must be a Hash or an Array'
                       end

  default_val = default || []
  mapping_strings = normalized_mapping.keys.map(&:to_s)
  T.unsafe(self).bitwise_definitions = T.unsafe(self).bitwise_definitions.dup
  T.unsafe(self).bitwise_definitions[column_name.to_sym] = {
    mapping: normalized_mapping,
    default: default_val,
    prefix: prefix,
    suffix: suffix,
    validated: false
  }

  T.unsafe(self).attribute column_name, ActiveRecord::Bitwise::Type.new(column_name, normalized_mapping, default_val), default: default_val

  # Define getter
  T.unsafe(self).define_method(column_name) do
    raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
    unless raw_values
      raw_values = {}
      T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
    end

    unless raw_values.key?(column_name.to_sym)
      raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
      raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                         raw_before
                                       elsif raw_before.respond_to?(:to_i)
                                         raw_before.to_i
                                       else
                                         0
                                       end
    end

    val = super()
    val = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(nil) if val.nil?

    if val.is_a?(Array) && !val.frozen?
      val = val.dup
      val.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
      val.freeze
    elsif val.is_a?(Array) && val.frozen? && !val.instance_variable_defined?(:@_bitwise_raw_value)
      unfrozen = val.dup
      unfrozen.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
      unfrozen.freeze
      val = unfrozen
    end
    val
  end

  # Define setter
  T.unsafe(self).define_method("#{column_name}=") do |new_value|
    raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
    unless raw_values
      raw_values = {}
      T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
    end

    unless raw_values.key?(column_name.to_sym)
      raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
      raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                         raw_before
                                       elsif raw_before.respond_to?(:to_i)
                                         raw_before.to_i
                                       else
                                         0
                                       end
    end

    current_raw = raw_values[column_name.to_sym]
    typecaster = T.unsafe(self).class.attribute_types[column_name.to_s]
    casted = typecaster.cast(new_value)

    if casted.is_a?(Array)
      unfrozen = casted.dup
      unfrozen.instance_variable_set(:@_bitwise_raw_value, current_raw)
      unfrozen.freeze
      casted = unfrozen
    end

    super(casted)
  end

  # Define prefix/suffix methods
  prefix_str = case prefix
               when true then "#{T.unsafe(column_name.to_s).singularize}_"
               when Symbol, String then "#{prefix}_"
               else ''
               end

  suffix_str = case suffix
               when true then "_#{T.unsafe(column_name.to_s).singularize}"
               when Symbol, String then "_#{suffix}"
               else ''
               end

  conflicting_methods = ActiveRecord::Base.instance_methods +
                        ActiveRecord::Base.private_instance_methods +
                        ActiveRecord::Base.protected_instance_methods

  normalized_mapping.each_key do |key|
    method_name = "#{prefix_str}#{key}#{suffix_str}"

    # Assert method collisions
    generated = ["#{method_name}?", "#{method_name}=", "#{method_name}!"]
    generated.each do |m|
      if conflicting_methods.include?(m.to_sym)
        Kernel.raise ArgumentError,
                     "Bitwise column #{column_name} mapping key #{key} generates method ##{m} which collides with core ActiveRecord::Base instance methods."
      end
    end

    T.unsafe(self).define_method("#{method_name}?") do
      current_values = Kernel.Array(T.unsafe(self).public_send(column_name))
      current_values.include?(key)
    end

    T.unsafe(self).define_method("#{method_name}=") do |val|
      original_array = T.unsafe(self).public_send(column_name)
      current_values = Kernel.Array(original_array).dup
      if original_array.is_a?(Array) && original_array.instance_variable_defined?(:@_bitwise_raw_value)
        current_values.instance_variable_set(:@_bitwise_raw_value, original_array.instance_variable_get(:@_bitwise_raw_value))
      end
      if val
        current_values << key unless current_values.include?(key)
      else
        current_values.delete(key)
      end
      T.unsafe(self).public_send("#{column_name}=", current_values)
    end

    # @note This is a convenience wrapper that performs a full `save!` cycle
    #   (validations, callbacks, dirty tracking). It is NOT an atomic SQL operation.
    #   If a validation on another attribute fails, this will raise
    #   `ActiveRecord::RecordInvalid`. For truly atomic operations, use the
    #   instance-level `add_<singular>!` method instead.
    T.unsafe(self).define_method("#{method_name}!") do
      current_values = Kernel.Array(T.unsafe(self).public_send(column_name)).dup
      current_values << key unless current_values.include?(key)
      T.unsafe(self).public_send("#{column_name}=", current_values)
      T.unsafe(self).save!
    end
  end

  T.unsafe(self).singleton_class.class_eval do
    T.unsafe(self).define_method("add_#{column_name}!") do |*values, records:|
      ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
      return if ids.empty?

      mask = values.flatten.filter_map do |v|
        val_str = v.to_s
        mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
      end.reduce(0) { |m, pos| m | (1 << pos) }
      return if mask.zero?

      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) | ?", mask])
    end

    T.unsafe(self).define_method("remove_#{column_name}!") do |*values, records:|
      ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
      return if ids.empty?

      mask = values.flatten.filter_map do |v|
        val_str = v.to_s
        mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
      end.reduce(0) { |m, pos| m | (1 << pos) }
      return if mask.zero?

      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) - (COALESCE(#{quoted_col}, 0) & ?)", mask])
    end
  end

  # Define Instance-level atomic methods
  # @note These methods perform the atomic SQL update, then read back the new value
  #   via a separate `pluck` query. There is a small TOCTOU window between the
  #   `update_all` and the `pluck` where another concurrent thread could modify
  #   the same row, causing the in-memory state to diverge from the DB. For
  #   absolute consistency, wrap usage in a transaction or re-read via `reload`.
  singular_col = T.unsafe(column_name.to_s).singularize

  T.unsafe(self).define_method("add_#{singular_col}!") do |*values|
    T.unsafe(self).class.transaction do
      T.unsafe(self).class.public_send("add_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
      new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end
      raw_values[column_name.to_sym] = new_db_value

      casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
      T.unsafe(self).write_attribute(column_name, casted)
      T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
    end
  end

  T.unsafe(self).define_method("add_#{column_name}!") do |*values|
    T.unsafe(self).send("add_#{singular_col}!", *T.unsafe(values))
  end

  T.unsafe(self).define_method("remove_#{singular_col}!") do |*values|
    T.unsafe(self).class.transaction do
      T.unsafe(self).class.public_send("remove_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
      new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end
      raw_values[column_name.to_sym] = new_db_value

      casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
      T.unsafe(self).write_attribute(column_name, casted)
      T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
    end
  end

  T.unsafe(self).define_method("remove_#{column_name}!") do |*values|
    T.unsafe(self).send("remove_#{singular_col}!", *T.unsafe(values))
  end

  # Define Scopes
  # @note `with_` and `with_any_` silently drop unrecognized values, returning
  #   `where('1=0')` (empty) only if ALL values are invalid. `with_exact_` returns
  #   `where('1=0')` if ANY value is invalid (strict validation). `without_` drops
  #   unrecognized values and returns `all` if none are valid.
  T.unsafe(self).scope "with_#{column_name}", Kernel.lambda { |*values|
    if values.empty?
      T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all
    end

    cleaned = values.flatten.reject { |v| v.nil? || v == '' }
    quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
    if cleaned.include?(0) || cleaned.include?('0') || cleaned.empty?
      return T.unsafe(self).where("#{quoted_col} = 0")
    end

    valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
    return T.unsafe(self).where('1=0') if valid.empty?

    mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
    T.unsafe(self).where("#{quoted_col} & ? = ?", mask, mask)
  }

  T.unsafe(self).scope "with_any_#{column_name}", Kernel.lambda { |*values|
    cleaned = values.flatten.reject { |v| v.nil? || v == '' }
    quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
    return T.unsafe(self).all if cleaned.empty?

    valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
    return T.unsafe(self).where('1=0') if valid.empty?

    mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
    T.unsafe(self).where("#{quoted_col} & ? > 0", mask)
  }

  T.unsafe(self).scope "with_exact_#{column_name}", Kernel.lambda { |*values|
    cleaned = values.flatten.reject { |v| v.nil? || v == '' }
    quoted_col = T.unsafe(self).connection.quote_column_name(column_name)

    return T.unsafe(self).where("#{quoted_col} = 0") if cleaned.empty?

    valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }

    return T.unsafe(self).where('1=0') if valid.size < cleaned.size

    mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
    T.unsafe(self).where("#{quoted_col} = ?", mask)
  }

  T.unsafe(self).scope "without_#{column_name}", Kernel.lambda { |*values|
    cleaned = values.flatten.reject { |v| v.nil? || v == '' }
    quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
    return T.unsafe(self).all if cleaned.empty?

    valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
    return T.unsafe(self).all if valid.empty?

    mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
    T.unsafe(self).where("#{quoted_col} & ? = 0", mask)
  }

  # Define schema helper class method
  T.unsafe(self).singleton_class.class_eval do
    T.unsafe(self).define_method(:bitwise_schema) do |col|
      T.unsafe(self).bitwise_definitions.dig(col.to_sym, :mapping)
    end
  end

  # Register callbacks (guarded to prevent duplicate registration when
  # multiple bitwise columns are defined on the same model)
  T.unsafe(self).class_eval do
    any_ancestor_registered = T.unsafe(self).ancestors.any? do |ancestor|
      ancestor.instance_variable_defined?(:@_bitwise_callbacks_registered) &&
        ancestor.instance_variable_get(:@_bitwise_callbacks_registered)
    end
    unless any_ancestor_registered
      T.unsafe(self).instance_variable_set(:@_bitwise_callbacks_registered, true)

      T.unsafe(self).after_initialize :_validate_bitwise_column_type_and_bounds
      T.unsafe(self).after_save :_reset_bitwise_raw_value_caches

      T.unsafe(self).define_method(:clear_bitwise_raw_values_cache!) do
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
      end

      T.unsafe(self).define_method(:reload) do |*args|
        T.unsafe(self).clear_bitwise_raw_values_cache!
        super(*args)
      end

      T.unsafe(self).define_method(:_validate_bitwise_column_type_and_bounds) do
        if T.unsafe(self).class.instance_variable_defined?(:@_bitwise_columns_validated) &&
           T.unsafe(self).class.instance_variable_get(:@_bitwise_columns_validated) &&
           T.unsafe(self).class.bitwise_definitions.values.all? { |config| config[:validated] }
          return
        end

        all_validated = T.let(true, T::Boolean)
        T.unsafe(self).class.bitwise_definitions.each do |col, config|
          next if T.unsafe(config)[:validated]

          begin
            next unless T.unsafe(self).class.connection.active? && T.unsafe(self).class.table_exists?

            column = T.unsafe(self).class.columns_hash[col.to_s]
            unless column && T.unsafe(column).type == :integer
              Kernel.raise ArgumentError,
                           "Bitwise column #{col} must be an integer database column"
            end

            max_bits = case T.unsafe(column).limit
                       when 1 then 7
                       when 2 then 15
                       when 4, nil then 31
                       when 8 then 63
                       else 31
                       end

            max_assigned_position = config[:mapping].values.max || 0
            if max_assigned_position >= max_bits
              Kernel.raise ArgumentError,
                           "Bitwise column #{col} has limit of #{T.unsafe(column).limit || 4} bytes (max #{max_bits} flags), but mapping requires bit shift position #{max_assigned_position}."
            end

            T.unsafe(config)[:validated] = true
          rescue ArgumentError => e
            Kernel.raise e
          rescue StandardError
            all_validated = false
            # Ignore database missing errors
          end
        end

        return unless all_validated && T.unsafe(self).class.bitwise_definitions.present?

        T.unsafe(self).class.instance_variable_set(:@_bitwise_columns_validated, true)
      end

      T.unsafe(self).define_method(:_reset_bitwise_raw_value_caches) do
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
      end

      T.unsafe(self).define_method(:initialize_dup) do |other|
        super(other)
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
      end
    end
  end
  nil
end

#remove_column!(*values) ⇒ Object

Alias for remove_singular!.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/active_record/bitwise.rb', line 294

module Model
  extend T::Sig

  # Defines bitwise attributes, getters, setters, scopes, and helper methods.
  # @param column_name [T.any(Symbol, String)] The database column name.
  # @param mapping [T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)])] The enum/boolean value mapping.
  # @param default [T.nilable(T::Array[T.any(Symbol, String)])] Optional default values.
  # @param prefix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional prefix for method names.
  # @param suffix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional suffix for method names.
  # @return [void]
  sig do
    params(
      column_name: T.any(Symbol, String),
      mapping: T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)]),
      default: T.nilable(T::Array[T.any(Symbol, String)]),
      prefix: T.nilable(T.any(Symbol, String, T::Boolean)),
      suffix: T.nilable(T.any(Symbol, String, T::Boolean))
    ).void
  end
  def bitwise(column_name, mapping, default: nil, prefix: nil, suffix: nil)
    normalized_mapping = if mapping.is_a?(Array)
                           mapping.each_with_index.with_object({}) { |(k, idx), h| h[k.to_sym] = idx }
                         elsif mapping.is_a?(Hash)
                           mapping.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_i }
                         else
                           Kernel.raise ArgumentError, 'Mapping must be a Hash or an Array'
                         end

    default_val = default || []
    mapping_strings = normalized_mapping.keys.map(&:to_s)
    T.unsafe(self).bitwise_definitions = T.unsafe(self).bitwise_definitions.dup
    T.unsafe(self).bitwise_definitions[column_name.to_sym] = {
      mapping: normalized_mapping,
      default: default_val,
      prefix: prefix,
      suffix: suffix,
      validated: false
    }

    T.unsafe(self).attribute column_name, ActiveRecord::Bitwise::Type.new(column_name, normalized_mapping, default_val), default: default_val

    # Define getter
    T.unsafe(self).define_method(column_name) do
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      val = super()
      val = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(nil) if val.nil?

      if val.is_a?(Array) && !val.frozen?
        val = val.dup
        val.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        val.freeze
      elsif val.is_a?(Array) && val.frozen? && !val.instance_variable_defined?(:@_bitwise_raw_value)
        unfrozen = val.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        unfrozen.freeze
        val = unfrozen
      end
      val
    end

    # Define setter
    T.unsafe(self).define_method("#{column_name}=") do |new_value|
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      current_raw = raw_values[column_name.to_sym]
      typecaster = T.unsafe(self).class.attribute_types[column_name.to_s]
      casted = typecaster.cast(new_value)

      if casted.is_a?(Array)
        unfrozen = casted.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, current_raw)
        unfrozen.freeze
        casted = unfrozen
      end

      super(casted)
    end

    # Define prefix/suffix methods
    prefix_str = case prefix
                 when true then "#{T.unsafe(column_name.to_s).singularize}_"
                 when Symbol, String then "#{prefix}_"
                 else ''
                 end

    suffix_str = case suffix
                 when true then "_#{T.unsafe(column_name.to_s).singularize}"
                 when Symbol, String then "_#{suffix}"
                 else ''
                 end

    conflicting_methods = ActiveRecord::Base.instance_methods +
                          ActiveRecord::Base.private_instance_methods +
                          ActiveRecord::Base.protected_instance_methods

    normalized_mapping.each_key do |key|
      method_name = "#{prefix_str}#{key}#{suffix_str}"

      # Assert method collisions
      generated = ["#{method_name}?", "#{method_name}=", "#{method_name}!"]
      generated.each do |m|
        if conflicting_methods.include?(m.to_sym)
          Kernel.raise ArgumentError,
                       "Bitwise column #{column_name} mapping key #{key} generates method ##{m} which collides with core ActiveRecord::Base instance methods."
        end
      end

      T.unsafe(self).define_method("#{method_name}?") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name))
        current_values.include?(key)
      end

      T.unsafe(self).define_method("#{method_name}=") do |val|
        original_array = T.unsafe(self).public_send(column_name)
        current_values = Kernel.Array(original_array).dup
        if original_array.is_a?(Array) && original_array.instance_variable_defined?(:@_bitwise_raw_value)
          current_values.instance_variable_set(:@_bitwise_raw_value, original_array.instance_variable_get(:@_bitwise_raw_value))
        end
        if val
          current_values << key unless current_values.include?(key)
        else
          current_values.delete(key)
        end
        T.unsafe(self).public_send("#{column_name}=", current_values)
      end

      # @note This is a convenience wrapper that performs a full `save!` cycle
      #   (validations, callbacks, dirty tracking). It is NOT an atomic SQL operation.
      #   If a validation on another attribute fails, this will raise
      #   `ActiveRecord::RecordInvalid`. For truly atomic operations, use the
      #   instance-level `add_<singular>!` method instead.
      T.unsafe(self).define_method("#{method_name}!") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name)).dup
        current_values << key unless current_values.include?(key)
        T.unsafe(self).public_send("#{column_name}=", current_values)
        T.unsafe(self).save!
      end
    end

    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method("add_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) | ?", mask])
      end

      T.unsafe(self).define_method("remove_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) - (COALESCE(#{quoted_col}, 0) & ?)", mask])
      end
    end

    # Define Instance-level atomic methods
    # @note These methods perform the atomic SQL update, then read back the new value
    #   via a separate `pluck` query. There is a small TOCTOU window between the
    #   `update_all` and the `pluck` where another concurrent thread could modify
    #   the same row, causing the in-memory state to diverge from the DB. For
    #   absolute consistency, wrap usage in a transaction or re-read via `reload`.
    singular_col = T.unsafe(column_name.to_s).singularize

    T.unsafe(self).define_method("add_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("add_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("add_#{column_name}!") do |*values|
      T.unsafe(self).send("add_#{singular_col}!", *T.unsafe(values))
    end

    T.unsafe(self).define_method("remove_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("remove_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("remove_#{column_name}!") do |*values|
      T.unsafe(self).send("remove_#{singular_col}!", *T.unsafe(values))
    end

    # Define Scopes
    # @note `with_` and `with_any_` silently drop unrecognized values, returning
    #   `where('1=0')` (empty) only if ALL values are invalid. `with_exact_` returns
    #   `where('1=0')` if ANY value is invalid (strict validation). `without_` drops
    #   unrecognized values and returns `all` if none are valid.
    T.unsafe(self).scope "with_#{column_name}", Kernel.lambda { |*values|
      if values.empty?
        T.unsafe(self).connection.quote_column_name(column_name)
        return T.unsafe(self).all
      end

      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      if cleaned.include?(0) || cleaned.include?('0') || cleaned.empty?
        return T.unsafe(self).where("#{quoted_col} = 0")
      end

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = ?", mask, mask)
    }

    T.unsafe(self).scope "with_any_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? > 0", mask)
    }

    T.unsafe(self).scope "with_exact_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)

      return T.unsafe(self).where("#{quoted_col} = 0") if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }

      return T.unsafe(self).where('1=0') if valid.size < cleaned.size

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} = ?", mask)
    }

    T.unsafe(self).scope "without_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).all if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = 0", mask)
    }

    # Define schema helper class method
    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method(:bitwise_schema) do |col|
        T.unsafe(self).bitwise_definitions.dig(col.to_sym, :mapping)
      end
    end

    # Register callbacks (guarded to prevent duplicate registration when
    # multiple bitwise columns are defined on the same model)
    T.unsafe(self).class_eval do
      any_ancestor_registered = T.unsafe(self).ancestors.any? do |ancestor|
        ancestor.instance_variable_defined?(:@_bitwise_callbacks_registered) &&
          ancestor.instance_variable_get(:@_bitwise_callbacks_registered)
      end
      unless any_ancestor_registered
        T.unsafe(self).instance_variable_set(:@_bitwise_callbacks_registered, true)

        T.unsafe(self).after_initialize :_validate_bitwise_column_type_and_bounds
        T.unsafe(self).after_save :_reset_bitwise_raw_value_caches

        T.unsafe(self).define_method(:clear_bitwise_raw_values_cache!) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:reload) do |*args|
          T.unsafe(self).clear_bitwise_raw_values_cache!
          super(*args)
        end

        T.unsafe(self).define_method(:_validate_bitwise_column_type_and_bounds) do
          if T.unsafe(self).class.instance_variable_defined?(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.instance_variable_get(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.bitwise_definitions.values.all? { |config| config[:validated] }
            return
          end

          all_validated = T.let(true, T::Boolean)
          T.unsafe(self).class.bitwise_definitions.each do |col, config|
            next if T.unsafe(config)[:validated]

            begin
              next unless T.unsafe(self).class.connection.active? && T.unsafe(self).class.table_exists?

              column = T.unsafe(self).class.columns_hash[col.to_s]
              unless column && T.unsafe(column).type == :integer
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} must be an integer database column"
              end

              max_bits = case T.unsafe(column).limit
                         when 1 then 7
                         when 2 then 15
                         when 4, nil then 31
                         when 8 then 63
                         else 31
                         end

              max_assigned_position = config[:mapping].values.max || 0
              if max_assigned_position >= max_bits
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} has limit of #{T.unsafe(column).limit || 4} bytes (max #{max_bits} flags), but mapping requires bit shift position #{max_assigned_position}."
              end

              T.unsafe(config)[:validated] = true
            rescue ArgumentError => e
              Kernel.raise e
            rescue StandardError
              all_validated = false
              # Ignore database missing errors
            end
          end

          return unless all_validated && T.unsafe(self).class.bitwise_definitions.present?

          T.unsafe(self).class.instance_variable_set(:@_bitwise_columns_validated, true)
        end

        T.unsafe(self).define_method(:_reset_bitwise_raw_value_caches) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:initialize_dup) do |other|
          super(other)
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end
      end
    end
    nil
  end

  # Automatically extends the base class with bitwise definitions attribute.
  # @param base [T::Module[T.anything]] The class extending this module.
  # @return [void]
  sig { params(base: T::Module[T.anything]).void }
  def self.extended(base)
    T.unsafe(base).class_attribute :bitwise_definitions, default: {}
  end
end

#remove_singular!(*values) ⇒ Object

Note:

This method wraps the database update in a transaction and uses locking to prevent TOCTOU races.

Instance-level atomic method to remove values.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/active_record/bitwise.rb', line 294

module Model
  extend T::Sig

  # Defines bitwise attributes, getters, setters, scopes, and helper methods.
  # @param column_name [T.any(Symbol, String)] The database column name.
  # @param mapping [T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)])] The enum/boolean value mapping.
  # @param default [T.nilable(T::Array[T.any(Symbol, String)])] Optional default values.
  # @param prefix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional prefix for method names.
  # @param suffix [T.nilable(T.any(Symbol, String, T::Boolean))] Optional suffix for method names.
  # @return [void]
  sig do
    params(
      column_name: T.any(Symbol, String),
      mapping: T.any(T::Hash[T.any(Symbol, String), T.any(Integer, String)], T::Array[T.any(Symbol, String)]),
      default: T.nilable(T::Array[T.any(Symbol, String)]),
      prefix: T.nilable(T.any(Symbol, String, T::Boolean)),
      suffix: T.nilable(T.any(Symbol, String, T::Boolean))
    ).void
  end
  def bitwise(column_name, mapping, default: nil, prefix: nil, suffix: nil)
    normalized_mapping = if mapping.is_a?(Array)
                           mapping.each_with_index.with_object({}) { |(k, idx), h| h[k.to_sym] = idx }
                         elsif mapping.is_a?(Hash)
                           mapping.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_i }
                         else
                           Kernel.raise ArgumentError, 'Mapping must be a Hash or an Array'
                         end

    default_val = default || []
    mapping_strings = normalized_mapping.keys.map(&:to_s)
    T.unsafe(self).bitwise_definitions = T.unsafe(self).bitwise_definitions.dup
    T.unsafe(self).bitwise_definitions[column_name.to_sym] = {
      mapping: normalized_mapping,
      default: default_val,
      prefix: prefix,
      suffix: suffix,
      validated: false
    }

    T.unsafe(self).attribute column_name, ActiveRecord::Bitwise::Type.new(column_name, normalized_mapping, default_val), default: default_val

    # Define getter
    T.unsafe(self).define_method(column_name) do
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      val = super()
      val = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(nil) if val.nil?

      if val.is_a?(Array) && !val.frozen?
        val = val.dup
        val.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        val.freeze
      elsif val.is_a?(Array) && val.frozen? && !val.instance_variable_defined?(:@_bitwise_raw_value)
        unfrozen = val.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, raw_values[column_name.to_sym])
        unfrozen.freeze
        val = unfrozen
      end
      val
    end

    # Define setter
    T.unsafe(self).define_method("#{column_name}=") do |new_value|
      raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
      unless raw_values
        raw_values = {}
        T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
      end

      unless raw_values.key?(column_name.to_sym)
        raw_before = T.unsafe(self).read_attribute_before_type_cast(column_name)
        raw_values[column_name.to_sym] = if raw_before.is_a?(Integer)
                                           raw_before
                                         elsif raw_before.respond_to?(:to_i)
                                           raw_before.to_i
                                         else
                                           0
                                         end
      end

      current_raw = raw_values[column_name.to_sym]
      typecaster = T.unsafe(self).class.attribute_types[column_name.to_s]
      casted = typecaster.cast(new_value)

      if casted.is_a?(Array)
        unfrozen = casted.dup
        unfrozen.instance_variable_set(:@_bitwise_raw_value, current_raw)
        unfrozen.freeze
        casted = unfrozen
      end

      super(casted)
    end

    # Define prefix/suffix methods
    prefix_str = case prefix
                 when true then "#{T.unsafe(column_name.to_s).singularize}_"
                 when Symbol, String then "#{prefix}_"
                 else ''
                 end

    suffix_str = case suffix
                 when true then "_#{T.unsafe(column_name.to_s).singularize}"
                 when Symbol, String then "_#{suffix}"
                 else ''
                 end

    conflicting_methods = ActiveRecord::Base.instance_methods +
                          ActiveRecord::Base.private_instance_methods +
                          ActiveRecord::Base.protected_instance_methods

    normalized_mapping.each_key do |key|
      method_name = "#{prefix_str}#{key}#{suffix_str}"

      # Assert method collisions
      generated = ["#{method_name}?", "#{method_name}=", "#{method_name}!"]
      generated.each do |m|
        if conflicting_methods.include?(m.to_sym)
          Kernel.raise ArgumentError,
                       "Bitwise column #{column_name} mapping key #{key} generates method ##{m} which collides with core ActiveRecord::Base instance methods."
        end
      end

      T.unsafe(self).define_method("#{method_name}?") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name))
        current_values.include?(key)
      end

      T.unsafe(self).define_method("#{method_name}=") do |val|
        original_array = T.unsafe(self).public_send(column_name)
        current_values = Kernel.Array(original_array).dup
        if original_array.is_a?(Array) && original_array.instance_variable_defined?(:@_bitwise_raw_value)
          current_values.instance_variable_set(:@_bitwise_raw_value, original_array.instance_variable_get(:@_bitwise_raw_value))
        end
        if val
          current_values << key unless current_values.include?(key)
        else
          current_values.delete(key)
        end
        T.unsafe(self).public_send("#{column_name}=", current_values)
      end

      # @note This is a convenience wrapper that performs a full `save!` cycle
      #   (validations, callbacks, dirty tracking). It is NOT an atomic SQL operation.
      #   If a validation on another attribute fails, this will raise
      #   `ActiveRecord::RecordInvalid`. For truly atomic operations, use the
      #   instance-level `add_<singular>!` method instead.
      T.unsafe(self).define_method("#{method_name}!") do
        current_values = Kernel.Array(T.unsafe(self).public_send(column_name)).dup
        current_values << key unless current_values.include?(key)
        T.unsafe(self).public_send("#{column_name}=", current_values)
        T.unsafe(self).save!
      end
    end

    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method("add_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) | ?", mask])
      end

      T.unsafe(self).define_method("remove_#{column_name}!") do |*values, records:|
        ids = Kernel.Array(records).map { |r| r.respond_to?(:id) ? T.unsafe(r).id : r }
        return if ids.empty?

        mask = values.flatten.filter_map do |v|
          val_str = v.to_s
          mapping_strings.include?(val_str) ? normalized_mapping[val_str.to_sym] : nil
        end.reduce(0) { |m, pos| m | (1 << pos) }
        return if mask.zero?

        quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
        T.unsafe(self).where(id: ids).update_all(["#{quoted_col} = COALESCE(#{quoted_col}, 0) - (COALESCE(#{quoted_col}, 0) & ?)", mask])
      end
    end

    # Define Instance-level atomic methods
    # @note These methods perform the atomic SQL update, then read back the new value
    #   via a separate `pluck` query. There is a small TOCTOU window between the
    #   `update_all` and the `pluck` where another concurrent thread could modify
    #   the same row, causing the in-memory state to diverge from the DB. For
    #   absolute consistency, wrap usage in a transaction or re-read via `reload`.
    singular_col = T.unsafe(column_name.to_s).singularize

    T.unsafe(self).define_method("add_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("add_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("add_#{column_name}!") do |*values|
      T.unsafe(self).send("add_#{singular_col}!", *T.unsafe(values))
    end

    T.unsafe(self).define_method("remove_#{singular_col}!") do |*values|
      T.unsafe(self).class.transaction do
        T.unsafe(self).class.public_send("remove_#{column_name}!", *T.unsafe(values), records: T.unsafe(self).id)
        new_db_value = T.unsafe(self).class.where(id: T.unsafe(self).id).lock(true).pluck(column_name.to_sym).first || 0
        raw_values = T.unsafe(self).instance_variable_get(:@_bitwise_raw_values)
        unless raw_values
          raw_values = {}
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, raw_values)
        end
        raw_values[column_name.to_sym] = new_db_value

        casted = T.unsafe(self).class.attribute_types[column_name.to_s].deserialize(new_db_value)
        T.unsafe(self).write_attribute(column_name, casted)
        T.unsafe(self).clear_attribute_changes([column_name.to_s]) if T.unsafe(self).respond_to?(:clear_attribute_changes)
      end
    end

    T.unsafe(self).define_method("remove_#{column_name}!") do |*values|
      T.unsafe(self).send("remove_#{singular_col}!", *T.unsafe(values))
    end

    # Define Scopes
    # @note `with_` and `with_any_` silently drop unrecognized values, returning
    #   `where('1=0')` (empty) only if ALL values are invalid. `with_exact_` returns
    #   `where('1=0')` if ANY value is invalid (strict validation). `without_` drops
    #   unrecognized values and returns `all` if none are valid.
    T.unsafe(self).scope "with_#{column_name}", Kernel.lambda { |*values|
      if values.empty?
        T.unsafe(self).connection.quote_column_name(column_name)
        return T.unsafe(self).all
      end

      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      if cleaned.include?(0) || cleaned.include?('0') || cleaned.empty?
        return T.unsafe(self).where("#{quoted_col} = 0")
      end

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = ?", mask, mask)
    }

    T.unsafe(self).scope "with_any_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).where('1=0') if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? > 0", mask)
    }

    T.unsafe(self).scope "with_exact_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)

      return T.unsafe(self).where("#{quoted_col} = 0") if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }

      return T.unsafe(self).where('1=0') if valid.size < cleaned.size

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} = ?", mask)
    }

    T.unsafe(self).scope "without_#{column_name}", Kernel.lambda { |*values|
      cleaned = values.flatten.reject { |v| v.nil? || v == '' }
      quoted_col = T.unsafe(self).connection.quote_column_name(column_name)
      return T.unsafe(self).all if cleaned.empty?

      valid = cleaned.select { |v| mapping_strings.include?(v.to_s) }.map { |v| v.to_s.to_sym }
      return T.unsafe(self).all if valid.empty?

      mask = valid.reduce(0) { |m, v| m | (1 << normalized_mapping[v]) }
      T.unsafe(self).where("#{quoted_col} & ? = 0", mask)
    }

    # Define schema helper class method
    T.unsafe(self).singleton_class.class_eval do
      T.unsafe(self).define_method(:bitwise_schema) do |col|
        T.unsafe(self).bitwise_definitions.dig(col.to_sym, :mapping)
      end
    end

    # Register callbacks (guarded to prevent duplicate registration when
    # multiple bitwise columns are defined on the same model)
    T.unsafe(self).class_eval do
      any_ancestor_registered = T.unsafe(self).ancestors.any? do |ancestor|
        ancestor.instance_variable_defined?(:@_bitwise_callbacks_registered) &&
          ancestor.instance_variable_get(:@_bitwise_callbacks_registered)
      end
      unless any_ancestor_registered
        T.unsafe(self).instance_variable_set(:@_bitwise_callbacks_registered, true)

        T.unsafe(self).after_initialize :_validate_bitwise_column_type_and_bounds
        T.unsafe(self).after_save :_reset_bitwise_raw_value_caches

        T.unsafe(self).define_method(:clear_bitwise_raw_values_cache!) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:reload) do |*args|
          T.unsafe(self).clear_bitwise_raw_values_cache!
          super(*args)
        end

        T.unsafe(self).define_method(:_validate_bitwise_column_type_and_bounds) do
          if T.unsafe(self).class.instance_variable_defined?(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.instance_variable_get(:@_bitwise_columns_validated) &&
             T.unsafe(self).class.bitwise_definitions.values.all? { |config| config[:validated] }
            return
          end

          all_validated = T.let(true, T::Boolean)
          T.unsafe(self).class.bitwise_definitions.each do |col, config|
            next if T.unsafe(config)[:validated]

            begin
              next unless T.unsafe(self).class.connection.active? && T.unsafe(self).class.table_exists?

              column = T.unsafe(self).class.columns_hash[col.to_s]
              unless column && T.unsafe(column).type == :integer
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} must be an integer database column"
              end

              max_bits = case T.unsafe(column).limit
                         when 1 then 7
                         when 2 then 15
                         when 4, nil then 31
                         when 8 then 63
                         else 31
                         end

              max_assigned_position = config[:mapping].values.max || 0
              if max_assigned_position >= max_bits
                Kernel.raise ArgumentError,
                             "Bitwise column #{col} has limit of #{T.unsafe(column).limit || 4} bytes (max #{max_bits} flags), but mapping requires bit shift position #{max_assigned_position}."
              end

              T.unsafe(config)[:validated] = true
            rescue ArgumentError => e
              Kernel.raise e
            rescue StandardError
              all_validated = false
              # Ignore database missing errors
            end
          end

          return unless all_validated && T.unsafe(self).class.bitwise_definitions.present?

          T.unsafe(self).class.instance_variable_set(:@_bitwise_columns_validated, true)
        end

        T.unsafe(self).define_method(:_reset_bitwise_raw_value_caches) do
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end

        T.unsafe(self).define_method(:initialize_dup) do |other|
          super(other)
          T.unsafe(self).instance_variable_set(:@_bitwise_raw_values, {})
        end
      end
    end
    nil
  end

  # Automatically extends the base class with bitwise definitions attribute.
  # @param base [T::Module[T.anything]] The class extending this module.
  # @return [void]
  sig { params(base: T::Module[T.anything]).void }
  def self.extended(base)
    T.unsafe(base).class_attribute :bitwise_definitions, default: {}
  end
end