Class: Tapioca::Dsl::Compilers::ActiveRecordRelations

Inherits:

Tapioca::Dsl::Compiler

Object
Tapioca::Dsl::Compiler
Tapioca::Dsl::Compilers::ActiveRecordRelations

show all

Extended by:: T::Sig

Includes:: Helpers::ActiveRecordConstantsHelper, SorbetHelper

Defined in:: lib/tapioca/dsl/compilers/active_record_relations.rb

Overview

Tapioca::Dsl::Compilers::ActiveRecordRelations decorates RBI files for subclasses of ActiveRecord::Base and adds [relation](api.rubyonrails.org/classes/ActiveRecord/Relation.html), [collection proxy](api.rubyonrails.org/classes/ActiveRecord/Associations/CollectionProxy.html), [query](api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html), [spawn](api.rubyonrails.org/classes/ActiveRecord/SpawnMethods.html), [finder](api.rubyonrails.org/classes/ActiveRecord/FinderMethods.html), and [calculation](api.rubyonrails.org/classes/ActiveRecord/Calculations.html) methods.

The compiler defines 3 (synthetic) modules and 3 (synthetic) classes to represent relations properly.

For a given model Model, we generate the following classes:

A Model::PrivateRelation that subclasses ActiveRecord::Relation. This synthetic class represents

a relation on Model whose methods which return a relation always return a Model::PrivateRelation instance.

Model::PrivateAssociationRelation that subclasses ActiveRecord::AssociationRelation. This synthetic

class represents a relation on a singular association of type Model (e.g. foo.model) whose methods which return a relation will always return a Model::PrivateAssociationRelation instance. The difference between this class and the previous one is mainly that an association relation also keeps track of the resource association for this relation.

Model::PrivateCollectionProxy that subclasses from ActiveRecord::Associations::CollectionProxy.

This synthetic class represents a relation on a plural association of type Model (e.g. foo.models) whose methods which return a relation will always return a Model::PrivateAssociationRelation instance. This class represents a collection of Model instances with some extra methods to build, create, etc new Model instances in the collection.

and the following modules:

Model::GeneratedRelationMethods holds all the relation methods with the return type of

Model::PrivateRelation. For example, calling all on the Model class or an instance of Model::PrivateRelation class will always return a Model::PrivateRelation instance, thus the signature of all is defined with that return type in this module.

Model::GeneratedAssociationRelationMethods holds all the relation methods with the return type

of Model::PrivateAssociationRelation. For example, calling all on an instance of Model::PrivateAssociationRelation or an instance of Model::PrivateCollectionProxy class will always return a Model::PrivateAssociationRelation instance, thus the signature of all is defined with that return type in this module.

Model::CommonRelationMethods holds all the relation methods that do not depend on the type of

relation in their return type. For example, find_by! will always return the same type (a Model instance), regardless of what kind of relation it is called on, and so belongs in this module. This module is used to reduce the replication of methods between the previous two modules.

Additionally, the actual Model class extends both Model::CommonRelationMethods and Model::PrivateRelation modules, so that, for example, find_by and all can be chained off of the Model class.

CAUTION: The generated relation classes are named PrivateXXX intentionally to reflect the fact that they represent private subconstants of the Active Record model. As such, these types do not exist at runtime, and their counterparts that do exist at runtime are marked private_constant anyway. For that reason, these types cannot be used in user code or in ‘sig`s inside Ruby files, since that will make the runtime checks fail.

For example, with the following ActiveRecord::Base subclass:

~~~rb class Post < ApplicationRecord end ~~~

this compiler will produce the RBI file post.rbi with the following content: ~~~rbi # post.rbi # typed: true

class Post

extend CommonRelationMethods
extend GeneratedRelationMethods

module CommonRelationMethods
  sig { params(block: T.nilable(T.proc.params(record: ::Post).returns(T.untyped))).returns(T::Boolean) }
  def any?(&block); end

  # ...
end

module GeneratedAssociationRelationMethods
  sig { returns(PrivateAssociationRelation) }
  def all; end

  # ...

  sig { params(args: T.untyped, blk: T.untyped).returns(PrivateAssociationRelation) }
  def where(*args, &blk); end
end

module GeneratedRelationMethods
  sig { returns(PrivateRelation) }
  def all; end

  # ...

  sig { params(args: T.untyped, blk: T.untyped).returns(PrivateRelation) }
  def where(*args, &blk); end
end

class PrivateAssociationRelation < ::ActiveRecord::AssociationRelation
  include CommonRelationMethods
  include GeneratedAssociationRelationMethods

  sig { returns(T::Array[::Post]) }
  def to_a; end

  sig { returns(T::Array[::Post]) }
  def to_ary; end

  Elem = type_member { { fixed: ::Post } }
end

class PrivateCollectionProxy < ::ActiveRecord::Associations::CollectionProxy
  include CommonRelationMethods
  include GeneratedAssociationRelationMethods

  sig do
    params(records: T.any(::Post, T::Array[::Post], T::Array[PrivateCollectionProxy]))
      .returns(PrivateCollectionProxy)
  end
  def <<(*records); end

  # ...
end

class PrivateRelation < ::ActiveRecord::Relation
  include CommonRelationMethods
  include GeneratedRelationMethods

  sig { returns(T::Array[::Post]) }
  def to_a; end

  sig { returns(T::Array[::Post]) }
  def to_ary; end

  Elem = type_member { { fixed: ::Post } }
end

end ~~~ : [ConstantType = singleton(::ActiveRecord::Base)]

Constant Summary collapse

ID_TYPES = From ActiveRecord::ConnectionAdapter::Quoting#quote, minus nil

[
  "String",
  "Symbol",
  "::ActiveSupport::Multibyte::Chars",
  "T::Boolean",
  "BigDecimal",
  "Numeric",
  "::ActiveRecord::Type::Binary::Data",
  "::ActiveRecord::Type::Time::Value",
  "Date",
  "Time",
  "::ActiveSupport::Duration",
  "T::Class[T.anything]",
].to_set.freeze

ASSOCIATION_METHODS =

::ActiveRecord::AssociationRelation.instance_methods -
::ActiveRecord::Relation.instance_methods

COLLECTION_PROXY_METHODS = : Array

::ActiveRecord::Associations::CollectionProxy.instance_methods -
::ActiveRecord::AssociationRelation.instance_methods

QUERY_METHODS = : Array

begin
  # Grab all Query methods
  query_methods = ActiveRecord::QueryMethods.instance_methods(false)
  # Grab all Spawn methods
  query_methods |= ActiveRecord::SpawnMethods.instance_methods(false)
  # Remove the ones we know are private API
  query_methods -= [:all, :arel, :build_subquery, :construct_join_dependency, :extensions, :spawn]
  # Remove the methods that ...
  query_methods
    .grep_v(/_clause$/) # end with "_clause"
    .grep_v(/_values?$/) # end with "_value" or "_values"
    .grep_v(/=$/) # end with "=""
    .grep_v(/(?<!uniq)!$/) # end with "!" except for "uniq!"
end

WHERE_CHAIN_QUERY_METHODS = : Array

ActiveRecord::QueryMethods::WhereChain.instance_methods(false)

FINDER_METHODS = : Array

ActiveRecord::FinderMethods.instance_methods(false)

SIGNED_FINDER_METHODS =

if defined?(ActiveRecord::SignedId)
  ActiveRecord::SignedId::ClassMethods.instance_methods(false)
else
  []
end

BATCHES_METHODS = : Array

ActiveRecord::Batches.instance_methods(false)

BATCHES_METHODS_PARAMETERS =

{
  start: ["T.untyped", "nil"],
  finish: ["T.untyped", "nil"],
  load: ["T.untyped", "false"],
  batch_size: ["Integer", "1000"],
  of: ["Integer", "1000"],
  error_on_ignore: ["T.untyped", "nil"],
  order: ["Symbol", ":asc"],
  cursor: ["T.untyped", "primary_key"],
  use_ranges: ["T.untyped", "nil"],
}

CALCULATION_METHODS = : Hash[Symbol, [String, String]]

ActiveRecord::Calculations.instance_methods(false)

ENUMERABLE_QUERY_METHODS = : Array

[:any?, :many?, :none?, :one?]

FIND_OR_CREATE_METHODS =

[
  :find_or_create_by,
  :find_or_create_by!,
  :find_or_initialize_by,
  :create_or_find_by,
  :create_or_find_by!,
]

BUILDER_METHODS = : Array

[:new, :create, :create!, :build]

TO_ARRAY_METHODS = : Array

[:to_ary, :to_a]

Constants included from SorbetHelper

SorbetHelper::FEATURE_REQUIREMENTS, SorbetHelper::SORBET_BIN, SorbetHelper::SORBET_EXE_PATH_ENV_VAR, SorbetHelper::SORBET_GEM_SPEC, SorbetHelper::SORBET_PAYLOAD_URL, SorbetHelper::SPOOM_CONTEXT

Constants included from Helpers::ActiveRecordConstantsHelper

Constants included from Runtime::Reflection

Instance Attribute Summary

Attributes inherited from Tapioca::Dsl::Compiler

#constant, #options, #root

Class Method Summary collapse

.gather_constants ⇒ Object

: -> T::Enumerable.

Instance Method Summary collapse

#decorate ⇒ Object

: -> void.

Constructor Details

This class inherits a constructor from Tapioca::Dsl::Compiler

Class Method Details

.gather_constants ⇒ `Object`

: -> T::Enumerable



187
188
189

# File 'lib/tapioca/dsl/compilers/active_record_relations.rb', line 187

def gather_constants
  ActiveRecord::Base.descendants.reject(&:abstract_class?)
end

Instance Method Details

#decorate ⇒ `Object`

: -> void

# File 'lib/tapioca/dsl/compilers/active_record_relations.rb', line 175

def decorate
  create_classes_and_includes
  create_common_methods
  create_relation_methods
  create_association_relation_methods
end

Class: Tapioca::Dsl::Compilers::ActiveRecordRelations

Overview

Constant Summary collapse

Constants included from SorbetHelper

Constants included from Helpers::ActiveRecordConstantsHelper

Constants included from Runtime::Reflection

Instance Attribute Summary

Attributes inherited from Tapioca::Dsl::Compiler

Class Method Summary collapse

Instance Method Summary collapse

Methods included from SorbetHelper

Methods inherited from Tapioca::Dsl::Compiler

Methods included from Runtime::Reflection

Methods included from Runtime::AttachedClassOf

Methods included from RBIHelper

Constructor Details

Class Method Details

.gather_constants ⇒ Object

Instance Method Details

#decorate ⇒ Object

.gather_constants ⇒ `Object`

#decorate ⇒ `Object`