Class: Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs

Inherits:
Translator
  • Object
show all
Includes:
RBS::ExtractRBSComments
Defined in:
lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RBS::ExtractRBSComments

#node_rbs_comments

Methods inherited from Translator

#rewrite

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_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_variable_and_write_node, #visit_class_variable_operator_write_node, #visit_class_variable_or_write_node, #visit_class_variable_read_node, #visit_class_variable_target_node, #visit_class_variable_write_node, #visit_constant_and_write_node, #visit_constant_operator_write_node, #visit_constant_or_write_node, #visit_constant_path_and_write_node, #visit_constant_path_node, #visit_constant_path_operator_write_node, #visit_constant_path_or_write_node, #visit_constant_path_target_node, #visit_constant_path_write_node, #visit_constant_read_node, #visit_constant_target_node, #visit_constant_write_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_and_write_node, #visit_global_variable_operator_write_node, #visit_global_variable_or_write_node, #visit_global_variable_read_node, #visit_global_variable_target_node, #visit_global_variable_write_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_and_write_node, #visit_instance_variable_operator_write_node, #visit_instance_variable_or_write_node, #visit_instance_variable_read_node, #visit_instance_variable_target_node, #visit_instance_variable_write_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_and_write_node, #visit_local_variable_operator_write_node, #visit_local_variable_or_write_node, #visit_local_variable_read_node, #visit_local_variable_target_node, #visit_local_variable_write_node, #visit_match_last_line_node, #visit_match_predicate_node, #visit_match_required_node, #visit_match_write_node, #visit_missing_node, #visit_multi_target_node, #visit_multi_write_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_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_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(ruby_contents, file:, max_line_length: nil) ⇒ RBSCommentsToSorbetSigs

: (String, file: String, ?max_line_length: Integer?) -> void



38
39
40
41
42
 
# File 'lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb', line 38

def initialize(ruby_contents, file:, max_line_length: nil)
  super(ruby_contents, file: file)

  @max_line_length = max_line_length
end

Class Method Details

.contains_rbs_syntax?(source) ⇒ Boolean

: (String source) -> bool

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb', line 25

def contains_rbs_syntax?(source)
  Sigils.contains_valid_sigil?(source) && source.match?(RBS_REWRITE_PATTERN)
end

.rewrite_if_needed(ruby_contents, file:, max_line_length: nil) ⇒ Object

: (String ruby_contents, file: String, ?max_line_length: Integer?) -> String



30
31
32
33
34
 
# File 'lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb', line 30

def rewrite_if_needed(ruby_contents, file:, max_line_length: nil)
  return ruby_contents unless contains_rbs_syntax?(ruby_contents)

  new(ruby_contents, file:, max_line_length:).rewrite
end

Instance Method Details

#visit_call_node(node) ⇒ Object

: (Prism::CallNode node) -> void



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb', line 86

def visit_call_node(node)
  case node.message
  when "attr_reader", "attr_writer", "attr_accessor"
    visit_attr(node)
  else
    def_node = node.arguments&.arguments&.first
    if def_node&.is_a?(Prism::DefNode)
      rewrite_def(def_node, node_rbs_comments(node))
      return
    end

    super
  end
end

#visit_class_node(node) ⇒ Object

: (Prism::ClassNode node) -> void



56
57
58
59
60
 
# File 'lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb', line 56

def visit_class_node(node)
  apply_class_annotations(node)

  super
end

#visit_def_node(node) ⇒ Object

: (Prism::DefNode node) -> void



80
81
82
 
# File 'lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb', line 80

def visit_def_node(node)
  rewrite_def(node, node_rbs_comments(node))
end

#visit_module_node(node) ⇒ Object

: (Prism::ModuleNode node) -> void



64
65
66
67
68
 
# File 'lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb', line 64

def visit_module_node(node)
  apply_class_annotations(node)

  super
end

#visit_program_node(node) ⇒ Object

: (Prism::ProgramNode node) -> void



46
47
48
49
50
51
52
 
# File 'lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb', line 46

def visit_program_node(node)
  # Process all type aliases from the entire file first
  apply_type_aliases(@comments)

  # Now process the rest of the file with type aliases available
  super
end

#visit_singleton_class_node(node) ⇒ Object

: (Prism::SingletonClassNode node) -> void



72
73
74
75
76
 
# File 'lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb', line 72

def visit_singleton_class_node(node)
  apply_class_annotations(node)

  super
end