Class: Spoom::Sorbet::Metrics::CodeMetricsVisitor

Inherits:
Visitor
  • Object
show all
Includes:
RBS::ExtractRBSComments
Defined in:
lib/spoom/sorbet/metrics/code_metrics_visitor.rb

Overview

Collects metrics about how Sorbet is used in the codebase.

This approach is different from the metrics file we get directly from Sorbet.

This visitor actually visits the codebase and collects metrics about the amount of signatures, ‘T.` calls, and other metrics. It also knows about RBS comments.

On the other hand, the metrics file is a snapshot of the metrics at type checking time and knows about is calls are typed, how many assertions are done, etc.

Instance Method Summary collapse

Methods included from RBS::ExtractRBSComments

#node_rbs_comments

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_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_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(counters) ⇒ CodeMetricsVisitor

: (Spoom::Counters) -> void



38
39
40
41
42
43
44
45
 
# File 'lib/spoom/sorbet/metrics/code_metrics_visitor.rb', line 38

def initialize(counters)
  super()

  @counters = counters

  @last_sigs = [] #: Array[Prism::CallNode]
  @type_params = [] #: Array[Prism::CallNode]
end

Instance Method Details

#visit(node) ⇒ Object

: (Prism::Node?) -> void



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/spoom/sorbet/metrics/code_metrics_visitor.rb', line 49

def visit(node)
  return if node.nil?

  node.location.trailing_comments.each do |comment|
    text = comment.slice.strip
    next unless text.start_with?("#:")

    @counters.increment("rbs_assertions")

    case text
    when /^#: as !nil/
      @counters.increment("rbs_must")
    when /^#: as untyped/
      @counters.increment("rbs_unsafe")
    when /^#: as/
      @counters.increment("rbs_cast")
    when /^#:/
      @counters.increment("rbs_let")
    end
  end

  super
end

#visit_call_node(node) ⇒ Object

: (Prism::CallNode) -> void



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/spoom/sorbet/metrics/code_metrics_visitor.rb', line 124

def visit_call_node(node)
  @counters.increment("calls")

  case node.name
  when :attr_accessor, :attr_reader, :attr_writer
    visit_attr_accessor(node)
    return
  when :sig
    visit_sig(node)
    return
  when :type_member, :type_template
    visit_type_member(node)
    return
  end

  case node.receiver&.slice
  when /^(::)?T$/
    @counters.increment("T_calls")
    @counters.increment("T.#{node.name}")
  end

  super
end

#visit_class_node(node) ⇒ Object

: (Prism::ClassNode) -> void



75
76
77
78
79
 
# File 'lib/spoom/sorbet/metrics/code_metrics_visitor.rb', line 75

def visit_class_node(node)
  visit_scope(node) do
    super
  end
end

#visit_def_node(node) ⇒ Object

: (Prism::DefNode) -> void



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/spoom/sorbet/metrics/code_metrics_visitor.rb', line 99

def visit_def_node(node)
  unless node.name.to_s.start_with?("test_")
    @counters.increment("methods")

    rbs_sigs = node_rbs_comments(node).signatures
    srb_sigs = collect_last_srb_sigs

    if rbs_sigs.any?
      @counters.increment("methods_with_rbs_sig")
    end

    if srb_sigs.any?
      @counters.increment("methods_with_srb_sig")
    end

    if rbs_sigs.empty? && srb_sigs.empty?
      @counters.increment("methods_without_sig")
    end
  end

  super
end

#visit_module_node(node) ⇒ Object

: (Prism::ModuleNode) -> void



83
84
85
86
87
 
# File 'lib/spoom/sorbet/metrics/code_metrics_visitor.rb', line 83

def visit_module_node(node)
  visit_scope(node) do
    super
  end
end

#visit_singleton_class_node(node) ⇒ Object

: (Prism::SingletonClassNode) -> void



91
92
93
94
95
 
# File 'lib/spoom/sorbet/metrics/code_metrics_visitor.rb', line 91

def visit_singleton_class_node(node)
  visit_scope(node) do
    super
  end
end