Class: Tapioca::Dsl::Compilers::Kredis

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

Overview

‘Tapioca::Dsl::Compilers::Kredis` decorates RBI files for all classes that include [`Kredis::Attributes`](github.com/rails/kredis/blob/main/lib/kredis/attributes.rb).

For example, with the following class:

~~~rb class Person < ApplicationRecord

kredis_list :names
kredis_flag :awesome
kredis_counter :steps, expires_in: 1.hour
kredis_enum :morning, values: %w[ bright blue black ], default: "bright"

end ~~~

this compiler will produce an RBI file with the following content: ~~~rbi # typed: true

class Person

module GeneratedKredisAttributeMethods
  sig { returns(Kredis::Types::Flag) }
  def awesome; end

  sig { returns(T::Boolean) }
  def awesome?; end

  sig { returns(PrivateEnumMorning) }
  def morning; end

  sig { returns(Kredis::Types::List) }
  def names; end

  sig { returns(Kredis::Types::Counter) }
  def steps; end

  class PrivateEnumMorning < Kredis::Types::Enum
    sig { void }
    def black!; end

    sig { returns(T::Boolean) }
    def black?; end

    sig { void }
    def blue!; end

    sig { returns(T::Boolean) }
    def blue?; end

    sig { void }
    def bright!; end

    sig { returns(T::Boolean) }
    def bright?; end
  end
end

end ~~~

Constant Summary collapse

ConstantType = 
type_member do
  { fixed: T.all(T::Class[::Kredis::Attributes], ::Kredis::Attributes::ClassMethods, Extensions::Kredis) }
end

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::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=

Methods included from T::Generic::TypeStoragePatch

#[], #has_attached_class!, #type_member, #type_template

Methods included from Runtime::Reflection

#abstract_type_of, #ancestors_of, #are_equal?, #class_of, #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 



93
94
95
96
97
 
# File 'lib/tapioca/dsl/compilers/kredis.rb', line 93

def gather_constants
  all_classes
    .grep(::Kredis::Attributes::ClassMethods)
    .reject { |klass| klass.to_s == "ActiveRecord::Base" || klass.try(:abstract_class?) }
end

Instance Method Details

#decorate ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/tapioca/dsl/compilers/kredis.rb', line 74

def decorate
  return if constant.__tapioca_kredis_types.nil?

  module_name = "GeneratedKredisAttributeMethods"

  root.create_path(constant) do |model|
    model.create_module(module_name) do |mod|
      constant.__tapioca_kredis_types.each do |method, data|
        generate_methods(mod, method, data)
      end
    end
    model.create_include(module_name)
  end
end