activerecord-bitwise 0.10.0

data/lib/activerecord-bitwise.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'active_record/bitwise'

data/lib/tapioca/dsl/compilers/activerecord_bitwise.rb

@@ -0,0 +1,207 @@
+# typed: strict
+# frozen_string_literal: true
+
+begin
+  require 'tapioca/dsl'
+rescue LoadError
+  # Namespace for Tapioca integration.
+  module Tapioca
+    # Namespace for Tapioca DSL.
+    module Dsl
+      # Stub class for Compiler under environments where Tapioca is not loaded.
+      class Compiler
+        extend T::Sig
+
+        # The model constant being compiled.
+        # @return [T.untyped]
+        sig { returns(T.untyped) }
+        attr_reader :constant
+
+        # The root node of the generated RBI tree.
+        # @return [T.untyped]
+        sig { returns(T.untyped) }
+        attr_reader :root
+
+        # Initializes a new compiler.
+        # @param constant [T.untyped]
+        sig { params(constant: T.untyped).void }
+        def initialize(constant)
+          @constant = T.let(constant, T.untyped)
+          @root = T.let(nil, T.untyped)
+        end
+
+        # Stub for type member definition.
+        # @param args [T.untyped]
+        # Sorbet's runtime signature verification requires the block argument to be named in the method definition
+        # (i.e. matching the `blk` name in `sig { params(blk: ...) }`) and raises `RuntimeError` if anonymous `&` is used.
+        # rubocop:disable Naming/BlockForwarding
+        sig { params(args: T.untyped, blk: T.nilable(T.proc.returns(T.untyped))).returns(T.untyped) }
+        def self.type_member(*args, &blk)
+          # Stub for environments without Tapioca
+        end
+        # rubocop:enable Naming/BlockForwarding
+
+        # Returns descendants of a class.
+        # @param klass [T.untyped]
+        # @return [T::Array[T.untyped]]
+        sig { params(klass: T.untyped).returns(T::Array[T.untyped]) }
+        def self.descendants_of(klass)
+          ObjectSpace.each_object(Class).select { |c| c < klass }
+        end
+
+        # Stub for gathering constants.
+        # @return [T.untyped]
+        sig { returns(T.untyped) }
+        def self.gather_constants
+          # Stub for override verification
+        end
+
+        # Stub for decorating model RBI.
+        # @return [void]
+        sig { void }
+        def decorate
+          # Stub for override verification
+        end
+
+        # Stub for creating method parameter.
+        # @param name [String]
+        # @param type [String]
+        sig { params(name: String, type: String).returns(T.untyped) }
+        def create_param(name, type:)
+          # Stub
+        end
+
+        # Stub for creating method rest parameter.
+        # @param name [String]
+        # @param type [String]
+        sig { params(name: String, type: String).returns(T.untyped) }
+        def create_rest_param(name, type:)
+          # Stub
+        end
+
+        # Stub for creating method keyword parameter.
+        # @param name [String]
+        # @param type [String]
+        sig { params(name: String, type: String).returns(T.untyped) }
+        def create_kw_param(name, type:)
+          # Stub
+        end
+      end
+    end
+  end
+end
+
+# Namespace for Tapioca integration.
+module Tapioca
+  # Namespace for Tapioca DSL.
+  module Dsl
+    # Namespace for specific Tapioca DSL compilers.
+    module Compilers
+      # Tapioca DSL Compiler for Sorbet static analysis of ActiveRecord::Bitwise attributes and scopes.
+      class ActiveRecordBitwise < Compiler
+        extend T::Sig
+
+        # The fixed constant type that this compiler is responsible for.
+        ConstantType = type_member { { fixed: T.class_of(ActiveRecord::Base) } }
+
+        sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
+        def self.gather_constants
+          descendants_of(ActiveRecord::Base).select do |klass|
+            klass.respond_to?(:bitwise_definitions) && T.unsafe(klass).bitwise_definitions.any?
+          end
+        end
+
+        sig { override.void }
+        def decorate
+          T.unsafe(root).create_path(constant) do |model|
+            model.create_method('bitwise_schema',
+                                parameters: [create_param('col', type: 'T.any(Symbol, String)')],
+                                return_type: 'T.nilable(T::Hash[Symbol, Integer])',
+                                class_method: true)
+          end
+
+          T.unsafe(constant).bitwise_definitions.each do |column_name, config|
+            T.unsafe(root).create_path(constant) do |model|
+              model.create_method(column_name.to_s, return_type: 'T::Array[T.any(Symbol, String)]')
+              model.create_method("#{column_name}=",
+                                  parameters: [create_param('val', type: 'T::Array[T.any(Symbol, String)]')], return_type: 'T::Array[T.any(Symbol, String)]')
+
+              prefix = config[:prefix]
+              suffix = config[:suffix]
+              mapping = config[:mapping]
+
+              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
+
+              mapping.each_key do |key|
+                method_name = "#{prefix_str}#{key}#{suffix_str}"
+                model.create_method("#{method_name}?", return_type: 'T::Boolean')
+                model.create_method("#{method_name}=", parameters: [create_param('val', type: 'T::Boolean')],
+                                                       return_type: 'T::Boolean')
+                model.create_method("#{method_name}!", return_type: 'TrueClass')
+              end
+
+              # Instance-level atomic methods
+              singular_col = T.unsafe(column_name.to_s).singularize
+              model.create_method("add_#{singular_col}!",
+                                  parameters: [create_rest_param('values', type: 'T.any(Symbol, String)')],
+                                  return_type: 'void')
+              model.create_method("add_#{column_name}!",
+                                  parameters: [create_rest_param('values', type: 'T.any(Symbol, String)')],
+                                  return_type: 'void')
+              model.create_method("remove_#{singular_col}!",
+                                  parameters: [create_rest_param('values', type: 'T.any(Symbol, String)')],
+                                  return_type: 'void')
+              model.create_method("remove_#{column_name}!",
+                                  parameters: [create_rest_param('values', type: 'T.any(Symbol, String)')],
+                                  return_type: 'void')
+
+              # Class-level atomic methods
+              model.create_method("add_#{column_name}!",
+                                  parameters: [
+                                    create_rest_param('values', type: 'T.any(Symbol, String)'),
+                                    create_kw_param('records', type: 'T.untyped')
+                                  ],
+                                  return_type: 'void',
+                                  class_method: true)
+              model.create_method("remove_#{column_name}!",
+                                  parameters: [
+                                    create_rest_param('values', type: 'T.any(Symbol, String)'),
+                                    create_kw_param('records', type: 'T.untyped')
+                                  ],
+                                  return_type: 'void',
+                                  class_method: true)
+
+              # Scopes
+              model.create_method("with_#{column_name}",
+                                  parameters: [create_rest_param('values', type: 'T.any(Symbol, String)')],
+                                  return_type: 'ActiveRecord::Relation',
+                                  class_method: true)
+              model.create_method("with_any_#{column_name}",
+                                  parameters: [create_rest_param('values', type: 'T.any(Symbol, String)')],
+                                  return_type: 'ActiveRecord::Relation',
+                                  class_method: true)
+              model.create_method("with_exact_#{column_name}",
+                                  parameters: [create_rest_param('values', type: 'T.any(Symbol, String)')],
+                                  return_type: 'ActiveRecord::Relation',
+                                  class_method: true)
+              model.create_method("without_#{column_name}",
+                                  parameters: [create_rest_param('values', type: 'T.any(Symbol, String)')],
+                                  return_type: 'ActiveRecord::Relation',
+                                  class_method: true)
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,278 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-bitwise
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- VitaliiLazebnyi
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEOTCCAqGgAwIBAgIUBONmsFo7fxLGkUHsKe65onH+5ogwDQYJKoZIhvcNAQEL
+  BQAwLDEqMCgGA1UEAwwhdml0YWxpaS5sYXplYm55aS5naXRodWJAZ21haWwuY29t
+  MB4XDTI2MDQxNTEzNTMyOVoXDTM2MDQxMjEzNTMyOVowLDEqMCgGA1UEAwwhdml0
+  YWxpaS5sYXplYm55aS5naXRodWJAZ21haWwuY29tMIIBojANBgkqhkiG9w0BAQEF
+  AAOCAY8AMIIBigKCAYEA5zdezJE+Zrsk9j53/IxBfRoaqvLcPvrcfl+EaEwWhIkV
+  0+08GtgS9N7VpB8cgaH2rkLJPjHIetsN/g5GMkDRsbJNXMrPVhxe1e1lI/r6j0Tm
+  JD0PaU4r8VzitxkqY9BBmSI8GjDjAfrT1u5jSXH1iAtKUoq5F116uYrxbgiDpvqa
+  kUQYcTf+6cZaPlF4KKhULnhKqs8u/NxyH4vPZyxEfg/gA4bODvcjW1A6d59BTiLV
+  yrJPebwU+F+URb8aoQ4AGvPKFiG1Y1fxRHuPrOpyymFnBnjwgMyQkNHtzTeEriV9
+  z1BUb10Pb/pjLBCrOvnStTPmcm1GE8HL2psYvlLvBlYqq3gzpQPBBKE3Jefa7ilC
+  cYsBYOGpynpA9uu9cXKa4jtpPDGQ7Qrpnk9gHy/0xfbgLdAkRCoZJeR7wDL/1xmm
+  nXwcUOLSOBj1Y4P9M+uQSQUZFTAaLbwyaBfE1gvVjwbTv3+rNP1ck1hACt+numGG
+  m7R6MF+Hmh8pNnDBYpBNAgMBAAGjUzBRMB0GA1UdDgQWBBRbuaz1EhdG6T4KIeWr
+  ac8LULxO9zAfBgNVHSMEGDAWgBRbuaz1EhdG6T4KIeWrac8LULxO9zAPBgNVHRMB
+  Af8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBgQBgfGTDIMxlm6o8o7dzCR0HosRm
+  DSeUrx46EG1knTEqO05CooEHW98hrHa1/EwzkPaH1KhjjserQb6VtczMnySlfySu
+  HbKWAIaqzlpf8zaE5tCiAKgFKr77b2XB7xKt25p/Vf/Kn/RLm3+sYQ2izzzMimei
+  tBHo29cLV9bB/5HHFDwjrtdC5a0HJHiir0w4MCSDDGtnsKird4RKD2xESpoVjiNg
+  L9nEGk25YDeIfKn8UtxduMv53T86CiBSsDcEb6oVjNiMOA0HFucwFKX+Vy5u0/qx
+  ZRoLbZiCkTTGyNkBh4o6RCCTn37Lj98FBxYMbAHLNhEcKnAGxB7XP/CYsV4+QHOy
+  h0PctylhIvm24QeKgIWJUWamFPfqdvlP660T4umxl2wMqvNpWmGMmGTMCraoKwxl
+  zpp6uA15MXgTU7CxGivRgUKM64TqBMZKkOJcCtPkruSobxiR8cROrBNTqEbrmedM
+  26EUEoxwDzfSzHU2SKz5pMR+8DClMUKB1rctg68=
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-ai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: A Ruby gem that extends ActiveRecord to support bitwise enum mapping,
+  allowing multiple states to be saved in a single database column.
+email:
+- vitalii.lazebnyi.github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- BUGS.md
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- REQUIREMENTS.md
+- certs/activerecord-bitwise-public_cert.pem
+- lib/active_record/bitwise.rb
+- lib/active_record/bitwise/bitwise_validator.rb
+- lib/active_record/bitwise/version.rb
+- lib/activerecord-bitwise.rb
+- lib/tapioca/dsl/compilers/activerecord_bitwise.rb
+homepage: https://github.com/VitaliiLazebnyi/activerecord-bitwise
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/VitaliiLazebnyi/activerecord-bitwise
+  changelog_uri: https://github.com/VitaliiLazebnyi/activerecord-bitwise/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Store multiple boolean values as a single integer bitmask.
+test_files: []