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

Inherits:
Tapioca::Dsl::Compiler show all
Extended by:
T::Sig
Defined in:
lib/tapioca/dsl/compilers/smart_properties.rb

Overview

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

For example, with the following class that includes SmartProperties:

~~~rb # 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 compiler will produce the RBI file post.rbi with the following content:

~~~rbi # 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

sig { 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 ~~~ : [ConstantType = singleton(::SmartProperties)]

Constant Summary

Constants included from Runtime::Reflection

Runtime::Reflection::ANCESTORS_METHOD, Runtime::Reflection::CLASS_METHOD, Runtime::Reflection::CONSTANTS_METHOD, Runtime::Reflection::EQUAL_METHOD, Runtime::Reflection::METHOD_METHOD, Runtime::Reflection::NAME_METHOD, Runtime::Reflection::OBJECT_ID_METHOD, Runtime::Reflection::PRIVATE_INSTANCE_METHODS_METHOD, Runtime::Reflection::PROTECTED_INSTANCE_METHODS_METHOD, Runtime::Reflection::PUBLIC_INSTANCE_METHODS_METHOD, Runtime::Reflection::REQUIRED_FROM_LABELS, Runtime::Reflection::SINGLETON_CLASS_METHOD, Runtime::Reflection::SUPERCLASS_METHOD, Runtime::Reflection::SignatureBlockError, Runtime::Reflection::UNDEFINED_CONSTANT

Constants included from SorbetHelper

SorbetHelper::FEATURE_REQUIREMENTS, SorbetHelper::SORBET_BIN, SorbetHelper::SORBET_EXE_PATH_ENV_VAR, SorbetHelper::SORBET_GEM_SPEC, SorbetHelper::SORBET_PAYLOAD_URL, SorbetHelper::SPOOM_CONTEXT

Instance Attribute Summary

Attributes inherited from Tapioca::Dsl::Compiler

#constant, #options, #root

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Tapioca::Dsl::Compiler

#add_error, #compiler_enabled?, handles?, #initialize, processable_constants, requested_constants=, reset_state

Methods included from Runtime::Reflection

#abstract_type_of, #ancestors_of, #are_equal?, #class_of, #const_source_location, #constant_defined?, #constantize, #constants_of, #descendants_of, #file_candidates_for, #final_module?, #inherited_ancestors_of, #method_of, #name_of, #name_of_type, #object_id_of, #private_instance_methods_of, #protected_instance_methods_of, #public_instance_methods_of, #qualified_name_of, #resolve_loc, #sealed_module?, #signature_of, #signature_of!, #singleton_class_of, #superclass_of

Methods included from Runtime::AttachedClassOf

#attached_class_of

Methods included from RBIHelper

#as_nilable_type, #as_non_nilable_type, #create_block_param, #create_kw_opt_param, #create_kw_param, #create_kw_rest_param, #create_opt_param, #create_param, #create_rest_param, #create_typed_param, #sanitize_signature_types, serialize_type_variable, #valid_method_name?, #valid_parameter_name?

Methods included from SorbetHelper

#sorbet, #sorbet_path, #sorbet_supports?

Constructor Details

This class inherits a constructor from Tapioca::Dsl::Compiler

Class Method Details

.gather_constants ⇒ Object

: -> T::Enumerable



84
85
86
87
88
89
90
91
 
# File 'lib/tapioca/dsl/compilers/smart_properties.rb', line 84

def gather_constants
  all_modules.select do |c|
    name_of(c) &&
      ::SmartProperties > c &&
      ::SmartProperties::Validations::Ancestor != c &&
      ::SmartProperties::ClassMethods === c
  end
end

Instance Method Details

#decorate ⇒ Object

: -> void



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/tapioca/dsl/compilers/smart_properties.rb', line 63

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

  root.create_path(constant) do |k|
    smart_properties_methods_name = "SmartPropertiesGeneratedMethods"
    k.create_module(smart_properties_methods_name) do |mod|
      properties.values.each do |property|
        generate_methods_for_property(mod, property)
      end
    end

    k.create_include(smart_properties_methods_name)
  end
end