Class: Tapioca::Compilers::Dsl::SmartProperties

Inherits:
Base
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/tapioca/compilers/dsl/smart_properties.rb

Overview

Tapioca::Compilers::Dsl::SmartProperties generates RBI files for classes that include SmartProperties (see https://github.com/t6d/smart_properties).

For example, with the following class that includes SmartProperties:

# post.rb
class Post
  include(SmartProperties)

  property :title, accepts: String
  property! :description, accepts: String
  property :published, accepts: [true, false], reader: :published?
  property :enabled, accepts: [true, false], default: false
end

this generator will produce the RBI file post.rbi with the following content:

# post.rbi
# typed: true
class Post
  sig { returns(T.nilable(::String)) }
  def title; end

  sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
  def title=(title); end

  sig { returns(::String) }
  def description; end

  sig { params(description: ::String).returns(::String) }
  def description=(description); end

  sig { returns(T.nilable(T::Boolean)) }
  def published?; end

  sig { params(published: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
  def published=(published); end

  ssig { returns(T.nilable(T::Boolean)) }
  def enabled; end

  sig { params(enabled: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
  def enabled=(enabled); end
end

Instance Attribute Summary

Attributes inherited from Base

#processable_constants

Instance Method Summary collapse

Methods inherited from Base

#handles?, #initialize

Constructor Details

This class inherits a constructor from Tapioca::Compilers::Dsl::Base

Instance Method Details

#decorate(root, constant) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/tapioca/compilers/dsl/smart_properties.rb', line 76

def decorate(root, constant)
  properties = T.let(
    T.unsafe(constant).properties,
    ::SmartProperties::PropertyCollection
  )
  return if properties.keys.empty?

  instance_methods = constant.instance_methods(false).map(&:to_s).to_set

  root.path(constant) do |k|
    properties.values.each do |property|
      generate_methods_for_property(k, property) do |method_name|
        !instance_methods.include?(method_name.to_sym)
      end
    end
  end
end

#gather_constants ⇒ Object 



95
96
97
98
99
100
101
102
 
# File 'lib/tapioca/compilers/dsl/smart_properties.rb', line 95

def gather_constants
  classes = T.cast(ObjectSpace.each_object(Class), T::Enumerable[Class])
  classes.select do |c|
    c < ::SmartProperties
  end.reject do |c|
    c.name.nil? || c == ::SmartProperties::Validations::Ancestor
  end
end