Boba

⚠️ This software is currently under active development. It should not be considered stable until 1.0.0.

Boba is a collection of compilers for Sorbet & Tapioca.

Tapioca is very opinionated about what types of compilers or changes are accepted into the repository. See here. Boba come in all different shapes, sizes, consistencies, etc, and is much less opinionated about what is or is not accepted. Boba is a collection of optional compilers that you can pick and choose from.

See the compilers manual for a list of available compilers.

Add Boba to your development dependencies in your gemfile:

group :development do
  gem 'boba', require: false
end

We recommend you also use the only configuration option in your Tapioca config (typically sorbet/tapioca/config.yml) to specify only the Tapioca compilers you wish to use.

dsl:
  only:
    Compiler1
    Compiler2

This makes it easy to selectively enable only the compilers you want to use in your project.

If you'd like to use relation types in your sigs that are less broad than ActiveRecord::Relation, such as those specific to a model, Boba provides a railtie to initialize these constants for each class. Move Boba in your gemfile out of the development group:

  gem 'boba'

The railtie will automatically define the PrivateRelation, PrivateAssociationRelation, and PrivateCollectionProxy constants on each model that inherits from ActiveRecord::Base. These are defined as their corresponding private ActiveRecord classes, so runtime type checking works as expected. They can then be used in typing, like so:

class Post < ::ActiveRecord::Base
  scope :recent -> { where('created_at > ?', Date.current) }

  belongs_to :author
  has_many :comments
end

sig { params(author: Author).returns(Post::PrivateRelation) }
def posts_from_author(author); end

and the following should not raise a Sorbet error:

sig { params(author: Author).returns(Post::PrivateRelation) }
def recent_posts_from_author(author)
  posts_from_author(author).recent
end

Boba also defines a type alias RelationType on each such class, which is defined as the union of the three relation types. This is useful because the relation types are often used interchangeably and so you may expect to return or pass any of the three classes as an argument. To use this, you will also need to use the ActiveRecordRelationTypes compiler to generate the type alias in the signatures as well (or define them manually in shims).

sig { params(author: Author).returns(Post::RelationType) }
def recent_posts_from_author(author)
  posts_from_author(author).recent
end

Bugs and feature requests are welcome and should be filed as issues on github.

Compilers for any commonly used Ruby or Rails gems are welcome to be contributed. See the Writing New Compilers section of the Tapioca docs for an introduction to writing compilers.

Since Boba is intended to be used alongside Tapioca and the compilers provided by Boba are intended to be fully optional, we will not accept compilers which overwrite the Tapioca default compilers. See the Tapioca Manual for a list of these compilers. Instead, compilers which extend or overwrite the default Tapioca compilers should be given unique names.

Contributed compilers should be well documented, and named after and include a link or reference to the Gem, DSL, or other module they implement RBIs for.

Compilers for Gems, DSLs, or modules that are not publicly available will not be accepted.