Class: Spoom::Sorbet::Assertions::Locator

Inherits:
Visitor
  • Object
show all
Defined in:
lib/spoom/sorbet/assertions.rb

Defined Under Namespace

Classes: HeredocVisitor

Constant Summary collapse

ANNOTATION_METHODS = 
T.let([:let], T::Array[Symbol])

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Visitor

#visit_alias_global_variable_node, #visit_alias_method_node, #visit_alternation_pattern_node, #visit_and_node, #visit_arguments_node, #visit_array_node, #visit_array_pattern_node, #visit_assoc_node, #visit_assoc_splat_node, #visit_back_reference_read_node, #visit_begin_node, #visit_block_argument_node, #visit_block_local_variable_node, #visit_block_node, #visit_block_parameter_node, #visit_block_parameters_node, #visit_break_node, #visit_call_and_write_node, #visit_call_node, #visit_call_operator_write_node, #visit_call_or_write_node, #visit_call_target_node, #visit_capture_pattern_node, #visit_case_match_node, #visit_case_node, #visit_child_nodes, #visit_class_node, #visit_class_variable_read_node, #visit_class_variable_target_node, #visit_constant_path_node, #visit_constant_path_target_node, #visit_constant_read_node, #visit_constant_target_node, #visit_def_node, #visit_defined_node, #visit_else_node, #visit_embedded_statements_node, #visit_embedded_variable_node, #visit_ensure_node, #visit_false_node, #visit_find_pattern_node, #visit_flip_flop_node, #visit_float_node, #visit_for_node, #visit_forwarding_arguments_node, #visit_forwarding_parameter_node, #visit_forwarding_super_node, #visit_global_variable_read_node, #visit_global_variable_target_node, #visit_hash_node, #visit_hash_pattern_node, #visit_if_node, #visit_imaginary_node, #visit_implicit_node, #visit_implicit_rest_node, #visit_in_node, #visit_index_and_write_node, #visit_index_operator_write_node, #visit_index_or_write_node, #visit_index_target_node, #visit_instance_variable_read_node, #visit_instance_variable_target_node, #visit_integer_node, #visit_interpolated_match_last_line_node, #visit_interpolated_regular_expression_node, #visit_interpolated_string_node, #visit_interpolated_symbol_node, #visit_interpolated_x_string_node, #visit_keyword_hash_node, #visit_keyword_rest_parameter_node, #visit_lambda_node, #visit_local_variable_read_node, #visit_local_variable_target_node, #visit_match_last_line_node, #visit_match_predicate_node, #visit_match_required_node, #visit_match_write_node, #visit_missing_node, #visit_module_node, #visit_multi_target_node, #visit_next_node, #visit_nil_node, #visit_no_keywords_parameter_node, #visit_numbered_parameters_node, #visit_numbered_reference_read_node, #visit_optional_keyword_parameter_node, #visit_optional_parameter_node, #visit_or_node, #visit_parameters_node, #visit_parentheses_node, #visit_pinned_expression_node, #visit_pinned_variable_node, #visit_post_execution_node, #visit_pre_execution_node, #visit_program_node, #visit_range_node, #visit_rational_node, #visit_redo_node, #visit_regular_expression_node, #visit_required_keyword_parameter_node, #visit_required_parameter_node, #visit_rescue_modifier_node, #visit_rescue_node, #visit_rest_parameter_node, #visit_retry_node, #visit_return_node, #visit_self_node, #visit_singleton_class_node, #visit_source_encoding_node, #visit_source_file_node, #visit_source_line_node, #visit_splat_node, #visit_statements_node, #visit_string_node, #visit_super_node, #visit_symbol_node, #visit_true_node, #visit_undef_node, #visit_unless_node, #visit_until_node, #visit_when_node, #visit_while_node, #visit_x_string_node, #visit_yield_node

Constructor Details

#initialize ⇒ Locator

: -> void



153
154
155
156
 
# File 'lib/spoom/sorbet/assertions.rb', line 153

def initialize
  super
  @assigns = T.let([], T::Array[AssignNode])
end

Instance Attribute Details

#assigns ⇒ Object (readonly)

: Array



150
151
152
 
# File 'lib/spoom/sorbet/assertions.rb', line 150

def assigns
  @assigns
end

Instance Method Details

#contains_heredoc?(node) ⇒ Boolean

: (Prism::Node) -> bool

Returns:

  • (Boolean) 


245
246
247
248
249
 
# File 'lib/spoom/sorbet/assertions.rb', line 245

def contains_heredoc?(node)
  visitor = HeredocVisitor.new
  visitor.visit(node)
  visitor.contains_heredoc
end

#t?(node) ⇒ Boolean

Is this node a ‘T` or `::T` constant? : (Prism::Node?) -> bool

Returns:

  • (Boolean) 


223
224
225
226
227
228
229
230
231
232
 
# File 'lib/spoom/sorbet/assertions.rb', line 223

def t?(node)
  case node
  when Prism::ConstantReadNode
    node.name == :T
  when Prism::ConstantPathNode
    node.parent.nil? && node.name == :T
  else
    false
  end
end

#t_annotation?(node) ⇒ Boolean

Is this node a ‘T.let` or `T.cast`? : (Prism::CallNode) -> bool

Returns:

  • (Boolean) 


236
237
238
239
240
241
242
 
# File 'lib/spoom/sorbet/assertions.rb', line 236

def t_annotation?(node)
  return false unless t?(node.receiver)
  return false unless ANNOTATION_METHODS.include?(node.name)
  return false unless node.arguments&.arguments&.size == 2

  true
end

#visit_assign(node) ⇒ Object Also known as: visit_class_variable_and_write_node, visit_class_variable_operator_write_node, visit_class_variable_or_write_node, visit_class_variable_write_node, visit_constant_and_write_node, visit_constant_operator_write_node, visit_constant_or_write_node, visit_constant_write_node, visit_constant_path_and_write_node, visit_constant_path_operator_write_node, visit_constant_path_or_write_node, visit_constant_path_write_node, visit_global_variable_and_write_node, visit_global_variable_operator_write_node, visit_global_variable_or_write_node, visit_global_variable_write_node, visit_instance_variable_and_write_node, visit_instance_variable_operator_write_node, visit_instance_variable_or_write_node, visit_instance_variable_write_node, visit_local_variable_and_write_node, visit_local_variable_operator_write_node, visit_local_variable_or_write_node, visit_local_variable_write_node, visit_multi_write_node

: (AssignType) -> void



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/spoom/sorbet/assertions.rb', line 159

def visit_assign(node)
  call = node.value
  return unless call.is_a?(Prism::CallNode) && t_annotation?(call)

  # We do not support translating heredocs yet because the `#: ` would need to be added to the first line
  # and it will requires us to adapt the annotation detection in Sorbet. But Sorbet desugars them into bare
  # strings making them impossible to detect.
  value = T.must(call.arguments&.arguments&.first)
  return if contains_heredoc?(value)

  operator_loc = case node
  when Prism::ClassVariableOperatorWriteNode,
        Prism::ConstantOperatorWriteNode,
        Prism::ConstantPathOperatorWriteNode,
        Prism::GlobalVariableOperatorWriteNode,
        Prism::InstanceVariableOperatorWriteNode,
        Prism::LocalVariableOperatorWriteNode
    node.binary_operator_loc
  else
    node.operator_loc
  end

  @assigns << AssignNode.new(
    node,
    operator_loc,
    value,
    T.must(call.arguments&.arguments&.last),
  )
end