Class: TypeProf::Core::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/typeprof/core/service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Service

Returns a new instance of Service.



3
4
5
6
7
8
9
10
11
12
13
 
# File 'lib/typeprof/core/service.rb', line 3

def initialize(options)
  @options = options

  @rb_text_nodes = {}
  @rbs_text_nodes = {}

  @genv = GlobalEnv.new
  @genv.load_core_rbs(load_rbs_declarations(@options[:rbs_collection]).declarations, @options[:position_encoding])

  Builtin.new(genv).deploy
end

Instance Attribute Details

#genv ⇒ Object (readonly)

Returns the value of attribute genv.



27
28
29
 
# File 'lib/typeprof/core/service.rb', line 27

def genv
  @genv
end

Instance Method Details

#add_workspace(rb_folder, rbs_folder) ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'lib/typeprof/core/service.rb', line 40

def add_workspace(rb_folder, rbs_folder)
  # Analyze RBS files first so that type declarations are available during RB type inference
  all_files = [rb_folder, rbs_folder].flat_map { |folder| Dir.glob(File.expand_path(folder + "/**/*.{rb,rbs}")) }
  rbs_files, rb_files = separate_rbs_and_rb(all_files.uniq)

  rbs_files.each { |path| update_rbs_file(path, nil) }
  rb_files.each { |path| update_rb_file(path, nil) }
end

#batch(files, output) ⇒ Object 



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/typeprof/core/service.rb', line 572

def batch(files, output)
  if @options[:output_typeprof_version]
    output.puts "# TypeProf #{ TypeProf::VERSION }"
    output.puts
  end

  # Analyze RBS files first so that type declarations are available during RB type inference
  rbs_files, rb_files = separate_rbs_and_rb(files)
  sorted_files = rbs_files + rb_files

  i = 0
  show_files = sorted_files.select do |file|
    if @options[:display_indicator]
      $stderr << "\r[%d/%d] %s\e[K" % [i, sorted_files.size, file]
      i += 1
    end

    res = update_file(file, File.read(file))

    if res
      true
    else
      output.puts "# failed to analyze: #{ file }"
      false
    end
  rescue => e
    output.puts "# error: #{ file }"
    raise e
  end
  if @options[:display_indicator]
    $stderr << "\r\e[K"
  end

  first = true
  show_files.each do |file|
    next if File.extname(file) == ".rbs"
    output.puts unless first
    first = false
    output.puts "# #{ file }"
    if @options[:output_diagnostics]
      diagnostics(file) do |diag|
        output.puts "# #{ diag.code_range.to_s }:#{ diag.msg }"
      end
    end
    output.puts dump_declarations(file)
  end

  if @options[:output_stats]
    rb_files = show_files.reject {|f| File.extname(f) == ".rbs" }
    stats = collect_stats(rb_files)
    output.puts
    output.puts format_stats(stats)
  end
end

#classify_vertex(vtx) ⇒ Object 



721
722
723
 
# File 'lib/typeprof/core/service.rb', line 721

def classify_vertex(vtx)
  vtx.types.empty? ? :untyped : :typed
end

#code_lens(path) ⇒ Object 



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/typeprof/core/service.rb', line 369

def code_lens(path)
  cpaths = []
  @rb_text_nodes[path]&.traverse do |event, node|
    if node.is_a?(AST::ModuleBaseNode)
      if node.static_cpath
        if event == :enter
          cpaths << node.static_cpath
        else
          cpaths.pop
        end
      end
    else
      if event == :enter
        next if node.is_a?(AST::DefNode) && node.rbs_method_type
        node.boxes(:mdef) do |mdef|
          hint = mdef.show(@options[:output_parameter_names])
          if hint
            yield mdef.node.code_range, hint
          end
        end
      end
    end
  end
end

#collect_stats(files) ⇒ Object 



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/typeprof/core/service.rb', line 627

def collect_stats(files)
  file_stats = []

  files.each do |path|
    methods = []
    constants = []
    seen_ivars = Set.empty
    ivars = []
    seen_cvars = Set.empty
    cvars = []
    seen_gvars = Set.empty
    gvars = []

    @rb_text_nodes[path]&.traverse do |event, node|
      next unless event == :enter

      node.boxes(:mdef) do |mdef|
        param_slots = []
        f = mdef.f_args
        [f.req_positionals, f.opt_positionals, f.post_positionals, f.req_keywords, f.opt_keywords].each do |ary|
          ary.each {|vtx| param_slots << classify_vertex(vtx) }
        end
        [f.rest_positionals, f.rest_keywords].each do |vtx|
          param_slots << classify_vertex(vtx) if vtx
        end

        is_initialize = mdef.mid == :initialize
        ret_slots = is_initialize ? [] : [classify_vertex(mdef.ret)]

        blk = mdef.record_block
        block_param_slots = []
        block_ret_slots = []
        if blk.used
          blk.f_args.each {|vtx| block_param_slots << classify_vertex(vtx) }
          block_ret_slots << classify_vertex(blk.ret)
        end

        methods << {
          mid: mdef.mid,
          singleton: mdef.singleton,
          param_slots: param_slots,
          ret_slots: ret_slots,
          block_param_slots: block_param_slots,
          block_ret_slots: block_ret_slots,
        }
      end

      if node.is_a?(AST::ConstantWriteNode) && node.static_cpath
        constants << classify_vertex(node.ret)
      end

      if node.is_a?(AST::InstanceVariableWriteNode)
        scope = node.lenv.cref.scope_level
        if scope == :class || scope == :instance
          key = [node.lenv.cref.cpath, scope == :class, node.var]
          unless seen_ivars.include?(key)
            seen_ivars << key
            ve = @genv.resolve_ivar(key[0], key[1], key[2])
            ivars << classify_vertex(ve.vtx)
          end
        end
      end

      if node.is_a?(AST::ClassVariableWriteNode)
        key = [node.lenv.cref.cpath, node.var]
        unless seen_cvars.include?(key)
          seen_cvars << key
          ve = @genv.resolve_cvar(key[0], key[1])
          cvars << classify_vertex(ve.vtx)
        end
      end

      if node.is_a?(AST::GlobalVariableWriteNode)
        unless seen_gvars.include?(node.var)
          seen_gvars << node.var
          ve = @genv.resolve_gvar(node.var)
          gvars << classify_vertex(ve.vtx)
        end
      end
    end

    file_stats << {
      path: path,
      methods: methods,
      constants: constants,
      ivars: ivars,
      cvars: cvars,
      gvars: gvars,
    }
  end

  file_stats
end

#completion(path, trigger, pos) ⇒ Object 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/typeprof/core/service.rb', line 394

def completion(path, trigger, pos)
  @rb_text_nodes[path]&.retrieve_at(pos) do |node|
    if node.code_range.last == pos.right
      node.ret.types.map do |ty, _source|
        base_ty = ty.base_type(genv)

        @genv.each_superclass(base_ty.mod, base_ty.is_a?(Type::Singleton)) do |mod, singleton|
          mod.methods[singleton].each do |mid, me|
            sig = nil
            me.decls.each do |mdecl|
              sig = mdecl.method_types.map {|method_type| method_type.instance_variable_get(:@raw_node).to_s }.join(" | ")
              break
            end
            unless sig
              me.defs.each do |mdef|
                sig = mdef.show(@options[:output_parameter_names])
                break
              end
            end
            # The base class has no name to show
            owner = mod.cpath.last == AST::StructNewNode::BASE_CNAME ? base_ty.mod : mod
            yield mid, "#{ owner.cpath.join("::" )}#{ singleton ? "." : "#" }#{ mid } : #{ sig }" if sig
          end
        end
      end
      return
    end
  end
end

#definitions(path, pos) ⇒ Object 



154
155
156
157
158
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/typeprof/core/service.rb', line 154

def definitions(path, pos)
  defs = []
  @rb_text_nodes[path]&.retrieve_at(pos) do |node|
    node.boxes(:cread) do |box|
      if box.const_read && box.const_read.cdef
        box.const_read.cdef.defs.each do |cdef_node|
          defs << [cdef_node.lenv.path, cdef_node.cname_code_range]
        end
      end
    end
    node.boxes(:mcall) do |box|
      boxes = []
      box.changes.boxes.each do |key, box|
        # ad-hocly handle Class#new calls
        if key[0] == :mcall && key[3] == :initialize # XXX: better condition?
          boxes << box
        end
      end
      boxes << box if boxes.empty?
      boxes.each do |box|
        box.resolve(genv, nil) do |me, _ty, mid, _orig_ty|
          next unless me
          me.decls.each do |mdecl|
            next unless mdecl.node.lenv.path

            code_range =
              if mdecl.node.respond_to?(:mname_code_range)
                mdecl.node.mname_code_range(mid)
              else
                mdecl.node.code_range
              end

            defs << [mdecl.node.lenv.path, code_range]
          end
          me.defs.each do |mdef|
            code_range =
              if mdef.node.respond_to?(:mname_code_range)
                mdef.node.mname_code_range(mid)
              else
                mdef.node.code_range
              end

            defs << [mdef.node.lenv.path, code_range]
          end
        end
      end
    end
    return defs unless defs.empty?
  end
  return defs
end

#diagnostics(path, &blk) ⇒ Object 



150
151
152
 
# File 'lib/typeprof/core/service.rb', line 150

def diagnostics(path, &blk)
  @rb_text_nodes[path]&.each_diagnostic(@genv, &blk)
end

#dump_declarations(path) ⇒ Object 



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/typeprof/core/service.rb', line 463

def dump_declarations(path)
  stack = []
  out = []
  seen_consts = Set.empty
  @rb_text_nodes[path]&.traverse do |event, node|
    case node
    when AST::ModuleNode
      if node.static_cpath
        if event == :enter
          out << "  " * stack.size + "module #{ format_declared_const_path(node.static_cpath, stack) }"
          if stack == [:toplevel]
            out << "end"
            stack.pop
          end
          stack.push(node)
        else
          stack.pop
          out << "  " * stack.size + "end"
        end
      end
    when AST::ClassNode, AST::SingletonClassNode, AST::StructNewNode
      if node.static_cpath
        next if stack.any? { node.is_a?(AST::SingletonClassNode) && (_1.is_a?(AST::ClassNode) || _1.is_a?(AST::ModuleNode)) && node.static_cpath == _1.static_cpath }

        if event == :enter
          s = "class #{ format_declared_const_path(node.static_cpath, stack) }"
          mod = @genv.resolve_cpath(node.static_cpath)
          superclass = mod.superclass
          # The base class is not shown; its members are printed inline
          while superclass && superclass.cpath.last == AST::StructNewNode::BASE_CNAME
            superclass = superclass.superclass
          end
          if superclass == nil
            s << " # failed to identify its superclass"
          elsif superclass.cpath != []
            s << " < #{ format_superclass_path(node, superclass) }"
          end
          if stack == [:toplevel]
            out << "end"
            stack.pop
          end
          out << "  " * stack.size + s
          stack.push(node)
          mod.included_modules.each do |inc_def, inc_mod|
            if inc_def.is_a?(AST::ConstantReadNode) && inc_def.lenv.path == path
              out << "  " * stack.size + "include #{ inc_mod.show_cpath }"
            end
          end
          mod.extended_modules.each do |ext_def, ext_mod|
            if ext_def.is_a?(AST::ConstantReadNode) && ext_def.lenv.path == path
              out << "  " * stack.size + "extend #{ ext_mod.show_cpath }"
            end
          end
          # Output method definitions from meta nodes (StructNewNode etc.)
          node.boxes(:mdef) do |mdef|
            # A user-written method overrides the generated one
            next if node.is_a?(AST::StructNewNode) &&
                    !@genv.resolve_method(node.static_cpath, mdef.singleton, mdef.mid).defs.empty?
            out << "  " * stack.size + "def #{ mdef.singleton ? "self." : "" }#{ mdef.mid }: " + mdef.show(@options[:output_parameter_names])
          end
        else
          stack.pop
          out << "  " * stack.size + "end"
        end
      end
    when AST::ConstantWriteNode
      if node.static_cpath
        if event == :enter
          unless seen_consts.include?(node.static_cpath)
            seen_consts << node.static_cpath
            cdef = @genv.resolve_const(node.static_cpath)
            # Use the assigned value for a single write so a same-named class
            # or module (e.g. declared in RBS) is not mixed in; union the types otherwise.
            ret = cdef.defs.size > 1 ? cdef.vtx : node.ret
            out << "  " * stack.size + "#{ format_declared_const_path(node.static_cpath, stack) }: #{ ret.show }"
          end
        end
      end
    else
      if event == :enter
        node.boxes(:mdef) do |mdef|
          if stack.empty?
            out << "  " * stack.size + "class Object"
            stack << :toplevel
          end
          if @options[:output_source_locations]
            pos = mdef.node.code_range.first
            out << "  " * stack.size + "# #{ path }:#{ pos.lineno }:#{ pos.column + 1 }"
          end
          out << "  " * stack.size + "def #{ mdef.singleton ? "self." : "" }#{ mdef.mid }: " + mdef.show(@options[:output_parameter_names])
        end
      end
    end
  end
  if stack == [:toplevel]
    out << "end"
    stack.pop
  end
  out.join("\n") + "\n"
end

#format_declared_const_path(cpath, stack) ⇒ Object 



424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/typeprof/core/service.rb', line 424

def format_declared_const_path(cpath, stack)
  scope_cpath =
    stack.reverse_each.find do |entry|
      (entry.is_a?(AST::ClassNode) || entry.is_a?(AST::ModuleNode)) &&
        entry.static_cpath &&
        !entry.static_cpath.empty?
    end&.static_cpath

  return cpath.join("::") unless scope_cpath
  return cpath.join("::") unless cpath[0, scope_cpath.size] == scope_cpath

  rel_cpath = cpath.drop(scope_cpath.size)
  rel_cpath.empty? ? cpath.join("::") : rel_cpath.join("::")
end

#format_stats(stats) ⇒ Object 



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/typeprof/core/service.rb', line 725

def format_stats(stats)
  total_methods = 0
  fully_typed = 0
  partially_typed = 0
  fully_untyped = 0

  slot_categories = i[param ret blk_param blk_ret const ivar cvar gvar]
  typed = Hash.new(0)
  untyped = Hash.new(0)

  file_summaries = []

  stats.each do |file|
    f_typed = 0
    f_total = 0

    file[:methods].each do |m|
      total_methods += 1

      method_slot_keys = i[param_slots ret_slots block_param_slots block_ret_slots]
      category_keys = i[param ret blk_param blk_ret]

      all_slots = method_slot_keys.flat_map {|k| m[k] }

      method_slot_keys.zip(category_keys) do |slot_key, cat|
        m[slot_key].each do |s|
          if s == :typed
            typed[cat] += 1
          else
            untyped[cat] += 1
          end
        end
      end

      if all_slots.empty? || all_slots.all? {|s| s == :typed }
        fully_typed += 1
      elsif all_slots.none? {|s| s == :typed }
        fully_untyped += 1
      else
        partially_typed += 1
      end

      f_typed += all_slots.count(:typed)
      f_total += all_slots.size
    end

    i[constants ivars cvars gvars].zip(i[const ivar cvar gvar]) do |data_key, cat|
      file[data_key].each do |s|
        f_total += 1
        if s == :typed
          typed[cat] += 1
          f_typed += 1
        else
          untyped[cat] += 1
        end
      end
    end

    if f_total > 0
      file_summaries << {
        path: file[:path],
        methods: file[:methods].size,
        typed: f_typed,
        total: f_total,
      }
    end
  end

  overall_typed = slot_categories.sum {|c| typed[c] }
  overall_untyped = slot_categories.sum {|c| untyped[c] }
  overall_total = overall_typed + overall_untyped

  labels = {
    param: "Parameter slots",
    ret: "Return slots",
    blk_param: "Block parameter slots",
    blk_ret: "Block return slots",
    const: "Constants",
    ivar: "Instance variables",
    cvar: "Class variables",
    gvar: "Global variables",
  }

  lines = []
  lines << "# TypeProf Evaluation Statistics"
  lines << "#"
  lines << "# Total methods: #{ total_methods }"
  lines << "#   Fully typed:     #{ fully_typed }"
  lines << "#   Partially typed: #{ partially_typed }"
  lines << "#   Fully untyped:   #{ fully_untyped }"

  slot_categories.each do |cat|
    total = typed[cat] + untyped[cat]
    lines << "#"
    lines << "# #{ labels[cat] }: #{ total }"
    lines << "#   Typed:   #{ typed[cat] } (#{ pct(typed[cat], total) })"
    lines << "#   Untyped: #{ untyped[cat] } (#{ pct(untyped[cat], total) })"
  end

  lines << "#"
  lines << "# Overall: #{ overall_typed }/#{ overall_total } typed (#{ pct(overall_typed, overall_total) })"
  lines << "#          #{ overall_untyped }/#{ overall_total } untyped (#{ pct(overall_untyped, overall_total) })"

  if file_summaries.size > 1
    lines << "#"
    lines << "# Per-file breakdown:"
    file_summaries.each do |fs|
      lines << "#   #{ fs[:path] }: #{ fs[:methods] } methods, #{ fs[:typed] }/#{ fs[:total] } typed (#{ pct(fs[:typed], fs[:total]) })"
    end
  end

  lines.join("\n")
end

#format_superclass_path(node, superclass) ⇒ Object 



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/typeprof/core/service.rb', line 439

def format_superclass_path(node, superclass)
  sc_path = superclass.show_cpath

  if node.is_a?(AST::ClassNode) && node.superclass_cpath
    sc_node = node.superclass_cpath
    if superclass_source_is_toplevel?(sc_node)
      return "::#{ sc_path }"
    end

    if node.static_cpath && node.static_cpath.size > 1 &&
       superclass.cpath == [node.static_cpath.last]
      return "::#{ sc_path }"
    end
  end

  sc_path
end

#get_method_sig(cpath, singleton, mid) ⇒ Object 



564
565
566
567
568
569
570
 
# File 'lib/typeprof/core/service.rb', line 564

def get_method_sig(cpath, singleton, mid)
  s = []
  @genv.resolve_method(cpath, singleton, mid).defs.each do |mdef|
    s << "def #{ mid }: " + mdef.show
  end
  s
end

#hover(path, pos) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/typeprof/core/service.rb', line 336

def hover(path, pos)
  @rb_text_nodes[path]&.retrieve_at(pos) do |node|
    node.boxes(:mcall) do |box|
      boxes = []
      box.changes.boxes.each do |key, box|
        # ad-hocly handle Class#new calls
        if key[0] == :mcall && key[3] == :initialize # XXX: better condition?
          boxes << box
        end
      end
      boxes << box if boxes.empty?
      boxes.each do |box|
        box.resolve(genv, nil) do |me, ty, mid, orig_ty|
          if me
            if !me.decls.empty?
              me.decls.each do |mdecl|
                return "#{ orig_ty.show }##{ mid } : #{ mdecl.show }"
              end
            end
            if !me.defs.empty?
              me.defs.each do |mdef|
                return "#{ orig_ty.show }##{ mid } : #{ mdef.show(@options[:output_parameter_names]) }"
              end
            end
          end
        end
      end
      return "??? failed to hover"
    end
    return node.ret ? node.ret.show : "??? no type ???"
  end
end

#load_rbs_declarations(rbs_collection) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/typeprof/core/service.rb', line 15

def load_rbs_declarations(rbs_collection)
  if rbs_collection
    loader = RBS::EnvironmentLoader.new
    loader.add_collection(rbs_collection)
    RBS::Environment.from_loader(loader)
  else
    return $raw_rbs_env if defined?($raw_rbs_env)
    loader = RBS::EnvironmentLoader.new
    $raw_rbs_env = RBS::Environment.from_loader(loader)
  end
end

#pct(n, total) ⇒ Object 



839
840
841
842
 
# File 'lib/typeprof/core/service.rb', line 839

def pct(n, total)
  return "0.0%" if total == 0
  "#{ (n * 100.0 / total).round(1) }%"
end

#process_diagnostic_paths(&blk) ⇒ Object 



146
147
148
 
# File 'lib/typeprof/core/service.rb', line 146

def process_diagnostic_paths(&blk)
  @genv.process_diagnostic_paths(&blk)
end

#references(path, pos) ⇒ Object

: (String, TypeProf::CodePosition) -> Array[[String?, TypeProf::CodeRange]]?



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/typeprof/core/service.rb', line 236

def references(path, pos)
  refs = []
  @rb_text_nodes[path]&.retrieve_at(pos) do |node|
    case node
    when AST::DefNode
      if node.mid_code_range.include?(pos)
        node.boxes(:mdef) do |mdef|
          me = @genv.resolve_method(mdef.cpath, mdef.singleton, mdef.mid)
          if me
            me.method_call_boxes.each do |box|
              node = box.node
              refs << [node.lenv.path, node.code_range]
            end
          end
        end
      end
    # TODO: Callsite
    when AST::ConstantReadNode
      if node.cname_code_range.include?(pos)
        node.boxes(:cread) do |cread_box|
          @genv.resolve_const(cread_box.const_read.cpath).read_boxes.each do |box|
            node = box.node
            refs << [node.lenv.path, node.code_range]
          end
        end
      end
    when AST::ConstantWriteNode
      if node.cname_code_range && node.cname_code_range.include?(pos) && node.static_cpath
        @genv.resolve_const(node.static_cpath).read_boxes.each do |box|
          node = box.node
          refs << [node.lenv.path, node.code_range]
        end
      end
    end
  end
  refs = refs.uniq
  return refs.empty? ? nil : refs
end

#rename(path, pos) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/typeprof/core/service.rb', line 275

def rename(path, pos)
  mdefs = []
  cdefs = []
  @rb_text_nodes[path]&.retrieve_at(pos) do |node|
    node.boxes(:mcall) do |box|
      box.resolve(genv, nil) do |me, _ty, _mid, _orig_ty|
        next unless me
        me.defs.each do |mdef|
          mdefs << mdef
        end
      end
    end
    node.boxes(:cread) do |box|
      if box.node.cname_code_range.include?(pos)
        box.const_read.cdef.defs.each do |cdef|
          cdefs << cdef
        end
      end
    end
    if node.is_a?(AST::ConstantWriteNode)
      if node.cname_code_range.include?(pos) && node.static_cpath
        genv.resolve_const(node.static_cpath).defs.each do |cdef|
          cdefs << cdef
        end
      end
    end
    if node.is_a?(AST::DefNode) && node.mid_code_range.include?(pos)
      node.boxes(:mdef) do |mdef|
        mdefs << mdef
      end
    end
  end
  targets = []
  mdefs.each do |mdef|
    # TODO: support all method definition nodes rather than defn/defs (e.g., attr_reader, alias, SIG_DEF, etc.)
    targets << [mdef.node.lenv.path, mdef.node.mid_code_range]
    me = @genv.resolve_method(mdef.cpath, mdef.singleton, mdef.mid)
    if me
      me.method_call_boxes.each do |box|
        # TODO: if it is a super node, we need to change its method name too
        targets << [box.node.lenv.path, box.node.mid_code_range]
      end
    end
  end
  cdefs.each do |cdef|
    if cdef.is_a?(AST::ConstantWriteNode)
      targets << [cdef.lenv.path, cdef.cname_code_range] if cdef.cname_code_range
    end
    ve = @genv.resolve_const(cdef.static_cpath)
    ve.read_boxes.each do |box|
      targets << [box.node.lenv.path, box.node.cname_code_range]
    end
  end
  if targets.all? {|_path, cr| cr }
    targets.uniq
  else
    # TODO: report an error
    nil
  end
end

#reset! ⇒ Object 



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/typeprof/core/service.rb', line 29

def reset!
  @rb_text_nodes.each_value {|node| node.undefine(@genv) }
  @rbs_text_nodes.each_value {|nodes| nodes.each {|n| n.undefine(@genv) } }
  @genv.define_all
  @rb_text_nodes.each_value {|node| node.uninstall(@genv) }
  @rbs_text_nodes.each_value {|nodes| nodes.each {|n| n.uninstall(@genv) } }
  @genv.run_all
  @rb_text_nodes.clear
  @rbs_text_nodes.clear
end

#superclass_source_is_toplevel?(const_node) ⇒ Boolean

Returns:

  • (Boolean) 


457
458
459
460
461
 
# File 'lib/typeprof/core/service.rb', line 457

def superclass_source_is_toplevel?(const_node)
  return false unless const_node.is_a?(AST::ConstantReadNode)
  return true if const_node.toplevel
  const_node.cbase ? superclass_source_is_toplevel?(const_node.cbase) : false
end

#type_definitions(path, pos) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/typeprof/core/service.rb', line 206

def type_definitions(path, pos)
  @rb_text_nodes[path]&.retrieve_at(pos) do |node|
    if node.ret
      ty_defs = []
      node.ret.types.map do |ty, _source|
        mod = case ty
              when Type::Instance, Type::Singleton
                ty.mod
              else
                base = ty.base_type(@genv)
                base.mod if base.is_a?(Type::Instance)
              end

        if mod
          mod.module_decls.each do |mdecl|
            decl_path = mdecl.lenv.path
            ty_defs << [decl_path, mdecl.code_range] if decl_path
          end
          mod.module_defs.each do |mdef_node|
            ty_defs << [mdef_node.lenv.path, mdef_node.code_range]
          end
        end
      end
      return ty_defs
    end
  end
  []
end

#update_file(path, code) ⇒ Object 



49
50
51
52
53
54
55
 
# File 'lib/typeprof/core/service.rb', line 49

def update_file(path, code)
  if File.extname(path) == ".rbs"
    update_rbs_file(path, code)
  else
    update_rb_file(path, code)
  end
end

#update_rb_ast(path, parse_result) ⇒ Object

path is used only as a key to find the previous analysis; the file is not read.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/typeprof/core/service.rb', line 63

def update_rb_ast(path, parse_result)
  prev_node = @rb_text_nodes[path]

  node = AST.build_rb(path, parse_result, @options[:position_encoding])
  return false unless node

  node.diff(@rb_text_nodes[path]) if prev_node
  @rb_text_nodes[path] = node

  node.define(@genv)
  prev_node.undefine(@genv) if prev_node
  @genv.define_all

  node.install(@genv)
  prev_node.uninstall(@genv) if prev_node
  @genv.run_all

  # invariant validation
  if prev_node
    live_vtxs = []
    node.get_vertexes(live_vtxs)
    set = Set.empty
    live_vtxs.uniq.each {|vtx| set << vtx }
    live_vtxs = set

    dead_vtxs = []
    prev_node.get_vertexes(dead_vtxs)
    set = Set.empty
    dead_vtxs.uniq.each {|vtx| set << vtx }
    dead_vtxs = set

    live_vtxs.each do |vtx|
      next unless vtx
      raise vtx.inspect if dead_vtxs.include?(vtx)
    end

    global_vtxs = []
    @genv.get_vertexes(global_vtxs)
    set = Set.empty
    global_vtxs.uniq.each {|vtx| set << vtx }
    global_vtxs = set

    global_vtxs.each do |global_vtx|
      next unless global_vtx.is_a?(Vertex)
      raise if dead_vtxs.include?(global_vtx)
      global_vtx.types.each_value do |prev_vtxs|
        prev_vtxs.each do |prev_vtx|
          raise if dead_vtxs.include?(prev_vtx)
        end
      end
      global_vtx.next_vtxs.each do |next_vtx|
        raise "#{ next_vtx }" if dead_vtxs.include?(next_vtx)
      end
    end
  end

  return true
end

#update_rb_file(path, code) ⇒ Object 



57
58
59
60
 
# File 'lib/typeprof/core/service.rb', line 57

def update_rb_file(path, code)
  code = File.read(path) unless code
  update_rb_ast(path, Prism.parse(code))
end

#update_rbs_file(path, code) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/typeprof/core/service.rb', line 122

def update_rbs_file(path, code)
  prev_decls = @rbs_text_nodes[path]

  code = File.read(path) unless code
  begin
    decls = AST.parse_rbs(path, code, @options[:position_encoding])
  rescue RBS::ParsingError
    return false
  end

  # TODO: diff
  @rbs_text_nodes[path] = decls

  decls.each {|decl| decl.define(@genv) }
  prev_decls.each {|decl| decl.undefine(@genv) } if prev_decls
  @genv.define_all

  decls.each {|decl| decl.install(@genv) }
  prev_decls.each {|decl| decl.uninstall(@genv) } if prev_decls
  @genv.run_all

  true
end