ruby_mod_kit 0.0.5 → 0.0.6

data/lib/ruby_mod_kit/generation.rb

@@ -36,6 +36,15 @@ module RubyModKit
     # @rbs corrector_manager: CorrectorManager | nil
     # @rbs features: Array[Feature] | nil
     # @rbs return: void
+    # @param script [String]
+    # @param missions [Array<Mission>]
+    # @param memo_pad [MemoPad, nil]
+    # @param generation_num [Integer]
+    # @param config [Config, nil]
+    # @param filename [String, nil]
+    # @param corrector_manager [CorrectorManager, nil]
+    # @param features [Array<Feature>, nil]
+    # @return [void]
     def initialize(script, missions: [], memo_pad: nil, generation_num: 0, config: nil,
                    filename: nil, corrector_manager: nil, features: nil)
       @script = script
@@ -58,6 +67,7 @@ module RubyModKit
     end
 
     # @rbs return: void
+    # @return [void]
     def init_missions
       return unless first_generation?
 
@@ -69,11 +79,13 @@ module RubyModKit
     end
 
     # @rbs return: bool
+    # @return [Boolean]
     def first_generation?
       @generation_num == 0
     end
 
     # @rbs return: Generation
+    # @return [Generation]
     def succ
       if @errors.empty?
         perform_missions
@@ -95,11 +107,13 @@ module RubyModKit
     end
 
     # @rbs return: String
+    # @return [String]
     def name
       "#{@filename || "(eval)"}[gen #{@generation_num}]"
     end
 
     # @rbs return: bool
+    # @return [Boolean]
     def completed?
       @errors.empty? && @missions.empty?
     end
@@ -108,6 +122,10 @@ module RubyModKit
     # @rbs length: Integer
     # @rbs str: String
     # @rbs return: String
+    # @param src_offset [Integer]
+    # @param length [Integer]
+    # @param str [String]
+    # @return [String]
     def []=(src_offset, length, str)
       diff = str.length - length
       @script[@offset_diff[src_offset], length] = str
@@ -116,6 +134,8 @@ module RubyModKit
 
     # @rbs src_range: Range[Integer | nil]
     # @rbs return: String
+    # @param src_range [Range<Integer, nil>]
+    # @return [String]
     def [](src_range)
       @source[src_range] || raise(RubyModKit::Error, "Invalid range")
     end
@@ -125,106 +145,63 @@ module RubyModKit
     #    | (Prism::ParseError) -> String
     def line(*args)
       case args
-      in [Integer]
-        line__overload0(*args)
-      in [Node::BaseNode]
-        line__overload1(*args)
-      in [Prism::ParseError]
-        line__overload2(*args)
+      in [Integer => line_num]
+        @lines[line_num] || raise(RubyModKit::Error)
+      in [Node::BaseNode => node]
+        line(node.location.start_line - 1)
+      in [Prism::ParseError => parse_error]
+        begin
+          line(parse_error.location.start_line - 1)
+        rescue RubyModKit::Error
+          ""
+        end
       end
     end
 
-    # @rbs line_num: Integer
-    # @rbs return: String
-    def line__overload0(line_num)
-      @lines[line_num] || raise(RubyModKit::Error)
-    end
-
-    # @rbs node: Node::BaseNode
-    # @rbs return: String
-    def line__overload1(node)
-      line(node.location.start_line - 1)
-    end
-
-    # @rbs parse_error: Prism::ParseError
-    # @rbs return: String
-    def line__overload2(parse_error)
-      line(parse_error.location.start_line - 1)
-    rescue RubyModKit::Error
-      ""
-    end
-
     # @rbs (Integer) -> (Integer | nil)
     #    | (Node::BaseNode) -> (Integer | nil)
     #    | (Node::BaseNode, Integer) -> (Integer | nil)
     #    | (Prism::ParseError) -> (Integer | nil)
     def line_offset(*args)
       case args
-      in [Integer]
-        line_offset__overload0(*args)
-      in [Node::BaseNode]
-        line_offset__overload1(*args)
-      in [Node::BaseNode, Integer]
-        line_offset__overload2(*args)
-      in [Prism::ParseError]
-        line_offset__overload3(*args)
+      in [Integer => line_num]
+        @offsets[line_num]
+      in [Node::BaseNode => node]
+        line_offset(node, 0)
+      in [Node::BaseNode => node, Integer => line_offset]
+        line_offset(node.location.start_line - 1 + line_offset)
+      in [Prism::ParseError => parse_error]
+        line_offset(parse_error.location.start_line - 1)
       end
     end
 
-    # @rbs line_num: Integer
-    # @rbs return: Integer | nil
-    def line_offset__overload0(line_num)
-      @offsets[line_num]
-    end
-
     # @rbs node: Node::BaseNode
     # @rbs return: Integer | nil
-    def line_offset__overload1(node)
-      line_offset(node, 0)
-    end
-
-    # @rbs node: Node::BaseNode
-    # @rbs line_offset: Integer
-    # @rbs return: Integer | nil
-    def line_offset__overload2(node, line_offset)
-      line_offset(node.location.start_line - 1 + line_offset)
-    end
-
-    # @rbs parse_error: Prism::ParseError
-    # @rbs return: Integer | nil
-    def line_offset__overload3(parse_error)
-      line_offset(parse_error.location.start_line - 1)
+    # @param node [Node::BaseNode]
+    # @return [Integer, nil]
+    def end_line_offset(node)
+      line_offset(node.location.end_line - 1)
     end
 
     # @rbs (Integer) -> String
     #    | (Node::BaseNode) -> String
     def line_indent(*args)
       case args
-      in [Integer]
-        line_indent__overload0(*args)
-      in [Node::BaseNode]
-        line_indent__overload1(*args)
+      in [Integer => line_num]
+        line(line_num)[/\A[ \t]*/] || ""
+      in [Node::BaseNode => node]
+        line_indent(node.location.start_line - 1)
       end
     end
 
-    # @rbs line_num: Integer
-    # @rbs return: String
-    def line_indent__overload0(line_num)
-      line(line_num)[/\A[ \t]*/] || ""
-    end
-
-    # @rbs node: Node::BaseNode
-    # @rbs return: String
-    def line_indent__overload1(node)
-      line_indent(node.location.start_line - 1)
-    end
-
     # @rbs return: void
+    # @return [void]
     def perform_corrector
       @corrector_manager.perform(self)
     end
 
     # @rbs return: void
+    # @return [void]
     def perform_missions
       @missions.delete_if do |mission|
         mission.perform(self) || break
@@ -233,6 +210,8 @@ module RubyModKit
 
     # @rbs mission: Mission
     # @rbs return: void
+    # @param mission [Mission]
+    # @return [void]
     def add_mission(mission)
       @missions << mission
     end
@@ -242,6 +221,10 @@ module RubyModKit
       # @rbs filename: String | nil
       # @rbs config: Config | nil
       # @rbs return: Generation
+      # @param src [String]
+      # @param filename [String, nil]
+      # @param config [Config, nil]
+      # @return [Generation]
       def resolve(src, filename: nil, config: nil)
         generation = Generation.new(src.dup, filename: filename, config: config)
         generation = generation.succ until generation.completed?

data/lib/ruby_mod_kit/memo/def_parent_memo.rb

@@ -12,6 +12,8 @@ module RubyModKit
 
       # @rbs def_parent_node: Node::DefParentNode
       # @rbs return: void
+      # @param def_parent_node [Node::DefParentNode]
+      # @return [void]
       def initialize(def_parent_node)
         @ivars_memo = {}
         super(def_parent_node.offset)
@@ -19,12 +21,16 @@ module RubyModKit
 
       # @rbs name: Symbol
       # @rbs return: Memo::IvarMemo
+      # @param name [Symbol]
+      # @return [Memo::IvarMemo]
       def ivar_memo(name)
         @ivars_memo[name] ||= Memo::IvarMemo.new(name)
       end
 
       # @rbs offset_diff: OffsetDiff
       # @rbs return: void
+      # @param offset_diff [OffsetDiff]
+      # @return [void]
       def succ(offset_diff)
         @ivars_memo.each_value do |ivar_memo|
           ivar_memo.succ(offset_diff)

data/lib/ruby_mod_kit/memo/ivar_memo.rb

@@ -6,23 +6,25 @@ module RubyModKit
   module Memo
     # The memo for parameter type
     class IvarMemo
-      # @rbs @type: nil | String
-      # @rbs @attr_kind: nil | Symbol
-      # @rbs @offset: nil | Integer
+      # @rbs @type: String | nil
+      # @rbs @attr_kind: Symbol | nil
+      # @rbs @offset: Integer | nil
       # @rbs @indent: String
       # @rbs @name: Symbol
-      # @rbs @visibility: nil | Symbol
+      # @rbs @visibility: Symbol | nil
       # @rbs @separator: String
 
-      attr_reader :type #: nil | String
-      attr_reader :attr_kind #: nil | Symbol
-      attr_accessor :offset #: nil | Integer
+      attr_reader :type #: String | nil
+      attr_reader :attr_kind #: Symbol | nil
+      attr_accessor :offset #: Integer | nil
       attr_accessor :indent #: String
-      attr_accessor :visibility #: nil | Symbol
+      attr_accessor :visibility #: Symbol | nil
       attr_accessor :separator #: String
 
       # @rbs name: Symbol
       # @rbs return: void
+      # @param name [Symbol]
+      # @return [void]
       def initialize(name)
         @name = name
         @indent = ""
@@ -30,12 +32,16 @@ module RubyModKit
 
       # @rbs type: String
       # @rbs return: void
+      # @param type [String]
+      # @return [void]
       def type=(type)
         @type = RubyModKit.unify_type(type)
       end
 
       # @rbs kind: Symbol | String
       # @rbs return: void
+      # @param kind [Symbol, String]
+      # @return [void]
       def attr_kind=(kind)
         case kind.to_sym
         when :attr_reader, :reader, :getter
@@ -49,6 +55,8 @@ module RubyModKit
 
       # @rbs offset_diff: OffsetDiff
       # @rbs return: void
+      # @param offset_diff [OffsetDiff]
+      # @return [void]
       def succ(offset_diff)
         offset = @offset
         return unless offset

data/lib/ruby_mod_kit/memo/method_memo.rb

@@ -14,10 +14,12 @@ module RubyModKit
       attr_reader :parameters #: Set[Memo::ParameterMemo]
       attr_reader :type #: String
 
-      UNTYPED = "untyped"
+      UNTYPED = "untyped" #: String
 
       # @rbs node: Node::DefNode
       # @rbs return: void
+      # @param node [Node::DefNode]
+      # @return [void]
       def initialize(node)
         @type = UNTYPED
         @parameters = Set.new
@@ -29,18 +31,23 @@ module RubyModKit
 
       # @rbs parameter_memo: Memo::ParameterMemo
       # @rbs return: Memo::ParameterMemo
+      # @param parameter_memo [Memo::ParameterMemo]
+      # @return [Memo::ParameterMemo]
       def add_parameter(parameter_memo)
         @parameters << parameter_memo
         parameter_memo
       end
 
       # @rbs return: bool
+      # @return [Boolean]
       def untyped?
         @type == UNTYPED
       end
 
       # @rbs type: String
       # @rbs return: void
+      # @param type [String]
+      # @return [void]
       def type=(type)
         @type = RubyModKit.unify_type(type)
       end

data/lib/ruby_mod_kit/memo/offset_memo.rb

@@ -12,12 +12,16 @@ module RubyModKit
 
       # @rbs offset: Integer
       # @rbs return: void
+      # @param offset [Integer]
+      # @return [void]
       def initialize(offset)
         @offset = offset
       end
 
       # @rbs offset_diff: OffsetDiff
       # @rbs return: void
+      # @param offset_diff [OffsetDiff]
+      # @return [void]
       def succ(offset_diff)
         @offset = offset_diff[@offset]
       end

data/lib/ruby_mod_kit/memo/overload_memo.rb

@@ -17,6 +17,9 @@ module RubyModKit
       # @rbs offset: Integer
       # @rbs name: Symbol
       # @rbs return: void
+      # @param offset [Integer]
+      # @param name [Symbol]
+      # @return [void]
       def initialize(offset, name)
         @name = name
         @overload_types = []
@@ -26,10 +29,12 @@ module RubyModKit
 
       # @rbs root_node: Node::ProgramNode
       # @rbs return: Integer
+      # @param root_node [Node::ProgramNode]
+      # @return [Integer]
       def correct_offset(root_node)
         return @offset if @offset_corrected
 
-        node = root_node.def_node_at(@offset)&.prev
+        node = root_node.def_node_at(@offset)
         raise RubyModKit::Error unless node.is_a?(Node::DefNode)
 
         @offset_corrected = true
@@ -39,6 +44,9 @@ module RubyModKit
       # @rbs parameter_types: Array[String]
       # @rbs return_value_type: String
       # @rbs return: void
+      # @param parameter_types [Array<String>]
+      # @param return_value_type [String]
+      # @return [void]
       def add_overload_type(parameter_types, return_value_type)
         @overload_types << [parameter_types, return_value_type]
       end

data/lib/ruby_mod_kit/memo/parameter_memo.rb

@@ -16,10 +16,12 @@ module RubyModKit
       attr_accessor :qualifier #: String | nil
       attr_accessor :name #: Symbol
 
-      UNTYPED = "untyped"
+      UNTYPED = "untyped" #: String
 
       # @rbs offset: Integer
       # @rbs return: void
+      # @param offset [Integer]
+      # @return [void]
       def initialize(offset)
         @type = UNTYPED
         @ivar_parameter = false
@@ -27,12 +29,15 @@ module RubyModKit
       end
 
       # @rbs return: bool
+      # @return [Boolean]
       def untyped?
         @type == UNTYPED
       end
 
       # @rbs type: String
       # @rbs return: void
+      # @param type [String]
+      # @return [void]
       def type=(type)
         @type = RubyModKit.unify_type(type)
       end

data/lib/ruby_mod_kit/memo_pad.rb

@@ -18,6 +18,7 @@ module RubyModKit
     attr_accessor :flags #: Hash[Symbol, bool]
 
     # @rbs return: void
+    # @return [void]
     def initialize
       @def_parents_memo = {}
       @methods_memo = {}
@@ -28,6 +29,8 @@ module RubyModKit
 
     # @rbs offset_diff: OffsetDiff
     # @rbs return: void
+    # @param offset_diff [OffsetDiff]
+    # @return [void]
     def succ(offset_diff)
       [@methods_memo, @parameters_memo, @def_parents_memo, @overloads_memo].each do |offset_node_memo|
         new_offset_node_memo = {}
@@ -42,12 +45,16 @@ module RubyModKit
 
     # @rbs def_parent_node: Node::DefParentNode
     # @rbs return: Memo::DefParentMemo
+    # @param def_parent_node [Node::DefParentNode]
+    # @return [Memo::DefParentMemo]
     def def_parent_memo(def_parent_node)
       @def_parents_memo[def_parent_node.offset] ||= Memo::DefParentMemo.new(def_parent_node)
     end
 
     # @rbs def_node: Node::DefNode
     # @rbs return: Memo::MethodMemo
+    # @param def_node [Node::DefNode]
+    # @return [Memo::MethodMemo]
     def method_memo(def_node)
       @methods_memo[def_node.offset] ||= Memo::MethodMemo.new(def_node)
     end
@@ -55,12 +62,17 @@ module RubyModKit
     # @rbs offset: Integer
     # @rbs name: Symbol
     # @rbs return: Memo::OverloadMemo
+    # @param offset [Integer]
+    # @param name [Symbol]
+    # @return [Memo::OverloadMemo]
     def overload_memo(offset, name)
       @overloads_memo[offset] ||= Memo::OverloadMemo.new(offset, name)
     end
 
     # @rbs node: Node::BaseNode
     # @rbs return: Memo::ParameterMemo
+    # @param node [Node::BaseNode]
+    # @return [Memo::ParameterMemo]
     def parameter_memo(node)
       memo = @parameters_memo[node.offset] ||= Memo::ParameterMemo.new(node.offset)
       def_node = node.def_node_at(node.offset)
@@ -69,8 +81,24 @@ module RubyModKit
       method_memo(def_node).add_parameter(memo)
     end
 
+    # @rbs (Memo::ParameterMemo) -> void
+    #    | (Memo::MethodMemo) -> void
+    def delete(*args)
+      case args
+      in [Memo::ParameterMemo => parameter_memo]
+        @parameters_memo.delete(parameter_memo.offset)
+      in [Memo::MethodMemo => method_memo]
+        method_memo.parameters.each do |parameter_memo| # rubocop:disable Lint/ShadowingOuterLocalVariable
+          delete(parameter_memo)
+        end
+        @methods_memo.delete(method_memo.offset)
+      end
+    end
+
     # @rbs &block: (Memo::ParameterMemo) -> void
     # @rbs return: void
+    # @param block [(Memo::ParameterMemo) -> void]
+    # @return [void]
     def each_parameter_memo(&block)
       parameters_memo.each_value(&block)
     end

data/lib/ruby_mod_kit/mission.rb

@@ -7,6 +7,8 @@ module RubyModKit
   class Mission
     # @rbs _generation: Generation
     # @rbs return: void
+    # @param _generation [Generation]
+    # @return [void]
     def perform(_generation)
       raise RubyModKit::Error, "Unexpected type #{self.class}"
     end

data/lib/ruby_mod_kit/node/base_node.rb

@@ -14,6 +14,7 @@ module RubyModKit
       attr_reader :prev #: Node::BaseNode | nil
 
       # @rbs return: Prism::Location
+      # @return [Prism::Location]
       def location
         return @location if defined?(@location)
 
@@ -21,6 +22,7 @@ module RubyModKit
       end
 
       # @rbs return: Array[Node::BaseNode]
+      # @return [Array<Node::BaseNode>]
       def children
         return @children if @children
 
@@ -33,11 +35,15 @@ module RubyModKit
       # @rbs prism_node: Prism::Node
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: Node::BaseNode
+      # @param prism_node [Prism::Node]
+      # @param prev [Node::BaseNode, nil]
+      # @return [Node::BaseNode]
       def wrap(prism_node, prev: nil)
         Node.wrap(prism_node, parent: self, prev: prev)
       end
 
       # @rbs return: Array[Node::BaseNode]
+      # @return [Array<Node::BaseNode>]
       def ancestors
         return @ancestors if @ancestors
 
@@ -49,18 +55,22 @@ module RubyModKit
         end
       end
 
-      # @rbs return: nil | BaseNode
+      # @rbs return: BaseNode | nil
+      # @return [BaseNode, nil]
       def parent
         raise(RubyModKit::Error)
       end
 
       # @rbs return: Symbol
+      # @return [Symbol]
       def name
         raise(RubyModKit::Error, "Expected ParameterNode but #{self.class}:#{prism_node.inspect}")
       end
 
       # @rbs offset: Integer
       # @rbs return: Node::BaseNode | nil
+      # @param offset [Integer]
+      # @return [Node::BaseNode, nil]
       def node_at(offset)
         return nil unless include?(offset)
 
@@ -70,6 +80,8 @@ module RubyModKit
 
       # @rbs offset: Integer
       # @rbs return: Node::StatementsNode | nil
+      # @param offset [Integer]
+      # @return [Node::StatementsNode, nil]
       def statements_node_at(offset)
         node = node_at(offset) || return
         [node, *node.ancestors].each { return _1 if _1.is_a?(Node::StatementsNode) }
@@ -78,6 +90,8 @@ module RubyModKit
 
       # @rbs offset: Integer
       # @rbs return: Node::DefNode | nil
+      # @param offset [Integer]
+      # @return [Node::DefNode, nil]
       def def_node_at(offset)
         node = node_at(offset) || return
         [node, *node.ancestors].each { return _1 if _1.is_a?(Node::DefNode) }
@@ -86,6 +100,8 @@ module RubyModKit
 
       # @rbs offset: Integer
       # @rbs return: Node::ParameterNode | nil
+      # @param offset [Integer]
+      # @return [Node::ParameterNode, nil]
       def parameter_node_at(offset)
         node = node_at(offset) || return
         [node, *node.ancestors].each { return _1 if _1.is_a?(Node::ParameterNode) }
@@ -95,6 +111,9 @@ module RubyModKit
       # @rbs offset: Integer
       # @rbs allowed: Array[Class] | nil
       # @rbs return: Node::DefParentNode | nil
+      # @param offset [Integer]
+      # @param allowed [Array<Class>, nil]
+      # @return [Node::DefParentNode, nil]
       def def_parent_node_at(offset, allowed: nil)
         node = node_at(offset) || return
         [node, *node.ancestors].each do |ancestor_node|
@@ -106,21 +125,32 @@ module RubyModKit
 
       # @rbs offset: Integer
       # @rbs return: bool
+      # @param offset [Integer]
+      # @return [Boolean]
       def include?(offset)
         self.offset <= offset && offset <= prism_node.location.end_offset
       end
 
       # @rbs return: Integer
+      # @return [Integer]
       def offset
         location.start_offset
       end
 
+      # @rbs return: Integer
+      # @return [Integer]
+      def end_offset
+        location.end_offset
+      end
+
       # @rbs return: String
+      # @return [String]
       def slice
         location.slice
       end
 
       # @rbs return: String
+      # @return [String]
       def inspect
         str = +"#<#{self.class} "
         first = true
@@ -155,6 +185,7 @@ module RubyModKit
       # :nocov:
       # This is just for interface definition, must not be called
       # @rbs return: Prism::Node & Prism::_Node
+      # @return [Prism::Node & Prism::_Node]
       def prism_node
         raise RubyModKit::Error
       end

data/lib/ruby_mod_kit/node/begin_node.rb

@@ -18,6 +18,10 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::BeginNode]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize(prism_node, parent:, prev: nil)
         @prism_node = prism_node
         @parent = parent

data/lib/ruby_mod_kit/node/call_node.rb

@@ -20,6 +20,10 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::CallNode]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize(prism_node, parent:, prev: nil)
         @prism_node = prism_node
         @parent = parent