maxveldink / activerecord-ejection_seat Goto Github PK

The mechanics of this library are very similar to another serializer in sorbet-schema, where an AR model is formatting converting to and from. We can ship a serializer implementation here to allow this behavior using the sorbet-schema infrastructure.

When eject is called on an instance of an ActiveRecord model that defines ejects_to, Sorbet does not know the method exists. Further, we don't know what the return type should be, so we're forced to use the typed: false sigil.

Tapioca allows for custom compilers to generate RBIs for a project based on given conditions. We should add one for ejection_seat to give more type information.

Right now, we only support simple mappings onto T::Struct. This is fine if you just need the id of a relation for a given model. What I'd love to do is have types like

module Types
  class User < T::Struct
    const :name, String
    const :location, Location
  end

  class Location < T::Struct
    const :name, String
  end
end

and be able to eject a user, look up the location information via the association and also eject the location onto this type.

Caveat - We need to be careful of circular requires here. Something will need to prevent trying to create infinite structs if two types reference each other. We should not create any associations if the type of that association is the ejection target of the receiver.

We should have the option between a Sorbet T::Struct and a Ruby 3.2 Data.define type

Currently, when you add activerecord-ejection_seat to your Gemfile, it will auto-require the Ejectable module in ActiveRecord::Base to make it available to all models automatically. There probably should be an option for auto-requiring (current behavior) or manually requiring. This would allow a company to have an explicit extend Ejectable in their ApplicationRecord or only extend Ejectable on the models they want to have that functionality for.