Generate methods for ActiveStorage attachments

[connorshea]

Describe the bug:

SorbetRails doesn't currently generate methods for ActiveStorage attachments. For example, in my Rails app users have avatars and games have covers, but neither of these are typed.

Steps to reproduce:

class User < ApplicationRecord
  has_one_attached :avatar
end

class Game < ApplicationRecord
  has_one_attached :cover
end

In hidden.rbi we have some methods like this:

module User::GeneratedAssociationMethods
  def avatar(); end

  def avatar=(attachable); end
end

Expected behavior:

It should return either ActiveStorage::Attached::One or ActiveStorage::Attached::Many depending on the definition in the model.

This is what I'd expect to see in game.rbi:

module Game::GeneratedAttributeMethods
  extend T::Sig
  
  sig { returns(T.nilable(ActiveStorage::Attached::One)) }
  def cover; end

  sig { params(attachable: T.untyped).returns(T.untyped) }
  def cover=(attachable); end

  # or, if we had something defined like `has_many_attached :covers`
  sig { returns(T.nilable(ActiveStorage::Attached::Many)) }
  def covers; end

  sig { params(attachable: T.untyped).returns(T.untyped) }
  def covers=(*attachables); end
end

I'm not entirely sure what the setters take or return, unfortunately.

Versions:

• Ruby: 2.6.2
• Rails: 6.0.0
• Sorbet:
• Sorbet-Rails: 0.5.3 (master)

[connorshea]

I think you can get attachment names for a model like this

User.attachment_reflections.keys
# => ["avatar"]

You can also get the type of attachment (has_one_attached vs has_many_attached) like this:

User.attachment_reflections.values.map { |x| x.class }
# }=> [ActiveStorage::Reflection::HasOneAttachedReflection]

Or, to simplify things:

User.attachment_reflections.transform_values { |x| x.class }
=> {"avatar"=>ActiveStorage::Reflection::HasOneAttachedReflection}

[hdoan741]

Sounds like you’ve got it figured out. Would you mind opening a PR for a plugin?

…

On Thu, Aug 29, 2019 at 7:02 PM Connor Shea ***@***.***> wrote: I think you can get attachment names for a model like this User.attachment_reflections.keys# => ["avatar"] You can also get the type of attachment (has_one_attached vs has_many_attached) like this: User.attachment_reflections.values.map { |x| x.class }# }=> [ActiveStorage::Reflection::HasOneAttachedReflection] — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#148?email_source=notifications&email_token=AAFH4ANVHE4JMYJBRVEKW3LQHB5URA5CNFSM4ISIMBTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD5QKABA#issuecomment-526426116>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAFH4ALNAND5D5TKPM4LHB3QHB5URANCNFSM4ISIMBTA> .