# typed: true module Parlour class RbiGenerator < Generator # Represents an attribute reader, writer or accessor. class Attribute < Method sig do params( generator: Generator, name: String, kind: Symbol, type: Types::TypeLike, class_attribute: T::Boolean, block: T.nilable(T.proc.params(x: Attribute).void) ).void end # Creates a new attribute. # @note You should use {Namespace#create_attribute} rather than this directly. # # @param generator [RbiGenerator] The current RbiGenerator. # @param name [String] The name of this attribute. # @param kind [Symbol] The kind of attribute this is; one of :writer, :reader or # :accessor. # @param type [String, Types::Type] This attribute's type. # @param class_attribute [Boolean] Whether this attribute belongs to the # singleton class. # @param block A block which the new instance yields itself to. # @return [void] def initialize(generator, name, kind, type, class_attribute: false, &block) # According to this source: # https://github.com/sorbet/sorbet/blob/2275752e51604acfb79b30a0a96debc996c089d9/test/testdata/dsl/attr_multi.rb # attr_accessor and attr_reader should have: sig { returns(X) } # attr_writer :foo should have: sig { params(foo: X).returns(X) } @type = type @kind = kind @class_attribute = class_attribute case kind when :accessor, :reader super(generator, name, [], type, &block) when :writer super(generator, name, [ Parameter.new(name, type: type) ], type, &block) else raise 'unknown kind' end end sig { returns(Symbol) } # The kind of attribute this is; one of +:writer+, +:reader+, or +:accessor+. # @return [Symbol] attr_reader :kind sig { returns(T::Boolean) } # Whether this attribute belongs to the singleton class. attr_reader :class_attribute sig { returns(Types::TypeLike) } # The type of this attribute. attr_reader :type sig { override.params(other: Object).returns(T::Boolean) } # Returns true if this instance is equal to another attribute. # # @param other [Object] The other instance. If this is not a {Attribute} # (or a subclass of it), this will always return false. # @return [Boolean] def ==(other) T.must( super(other) && Attribute === other && kind == other.kind && class_attribute == other.class_attribute ) end sig { override.void } def generalize_from_rbi! @type = TypeParser.parse_single_type(@type) if String === @type end private sig do override.params( indent_level: Integer, options: Options ).returns(T::Array[String]) end # Generates the RBI lines for this method. # # @param indent_level [Integer] The indentation level to generate the lines at. # @param options [Options] The formatting options to use. # @return [Array] The RBI lines, formatted as specified. def generate_definition(indent_level, options) [options.indented(indent_level, "attr_#{kind} :#{name}")] end end end end