ruby_mod_kit 0.0.4 → 0.0.6

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,21 +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 = ""
@@ -28,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
@@ -47,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

@@ -8,16 +8,20 @@ module RubyModKit
     class ParameterMemo < OffsetMemo
       # @rbs @type: String
       # @rbs @ivar_parameter: bool
-      # @rbs @qualifier: String
+      # @rbs @qualifier: String | nil
+      # @rbs @name: Symbol
 
       attr_reader :type #: String
       attr_accessor :ivar_parameter #: bool
-      attr_accessor :qualifier #: String
+      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
@@ -25,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)
@@ -68,5 +80,27 @@ 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
   end
 end

data/lib/ruby_mod_kit/mission.rb

@@ -7,12 +7,10 @@ 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
-
-    # @rbs offset_diff: OffsetDiff
-    # @rbs return: void
-    def succ(offset_diff); end
   end
 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) }
@@ -93,25 +109,48 @@ module RubyModKit
       end
 
       # @rbs offset: Integer
+      # @rbs allowed: Array[Class] | nil
       # @rbs return: Node::DefParentNode | nil
-      def def_parent_node_at(offset)
+      # @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 { return _1 if _1.is_a?(Node::DefParentNode) }
+        [node, *node.ancestors].each do |ancestor_node|
+          return ancestor_node if ancestor_node.is_a?(Node::DefParentNode)
+          return nil if allowed && !allowed.include?(ancestor_node.class)
+        end
         nil
       end
 
       # @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
@@ -146,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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module RubyModKit
+  module Node
+    # Transpiler program node
+    class BeginNode < Node::BaseNode
+      # @rbs @prism_node: Prism::BeginNode
+      # @rbs @parent: Node::BaseNode
+      # @rbs @prev: Node::BaseNode | nil
+
+      private attr_reader :prism_node #: Prism::BeginNode
+      attr_reader :parent #: Node::BaseNode
+      attr_reader :prev #: Node::BaseNode | nil
+
+      # @rbs prism_node: Prism::BeginNode
+      # @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
+        @prev = prev
+        raise RubyModKit::Error unless prism_node.is_a?(Prism::BeginNode)
+
+        super()
+      end
+    end
+  end
+end

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

data/lib/ruby_mod_kit/node/def_node.rb

@@ -9,6 +9,7 @@ module RubyModKit
       # @rbs @prism_node: Prism::DefNode
       # @rbs @parent: Node::BaseNode
       # @rbs @prev: Node::BaseNode | nil
+      # @rbs @body_node: Node::StatementsNode | Node::BeginNode | nil
 
       private attr_reader :prism_node #: Prism::DefNode
       attr_reader :parent #: Node::BaseNode
@@ -18,6 +19,10 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::DefNode]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize(prism_node, parent:, prev: nil)
         @prism_node = prism_node
         @parent = parent
@@ -28,34 +33,65 @@ module RubyModKit
       end
 
       # @rbs return: Symbol
+      # @return [Symbol]
       def name
         @prism_node.name
       end
 
       # @rbs return: Prism::Location | nil
+      # @return [Prism::Location, nil]
       def body_location
         prism_node.body&.location
       end
 
       # @rbs return: Prism::Location | nil
+      # @return [Prism::Location, nil]
       def lparen_loc
         @prism_node.lparen_loc
       end
 
       # @rbs return: Prism::Location | nil
+      # @return [Prism::Location, nil]
       def rparen_loc
         @prism_node.rparen_loc
       end
 
       # @rbs return: Prism::Location
+      # @return [Prism::Location]
       def name_loc
         @prism_node.name_loc
       end
 
       # @rbs return: Prism::Location | nil
+      # @return [Prism::Location, nil]
       def end_keyword_loc
         @prism_node.end_keyword_loc
       end
+
+      # @rbs prism_child_node: Prism::Node
+      # @rbs prev: Node::BaseNode | nil
+      # @rbs return: Node::BaseNode
+      # @param prism_child_node [Prism::Node]
+      # @param prev [Node::BaseNode, nil]
+      # @return [Node::BaseNode]
+      def wrap(prism_child_node, prev: nil)
+        child_node = super
+        if prism_child_node == @prism_node.body
+          case child_node
+          when Node::StatementsNode, Node::BeginNode
+            @body_node = child_node
+          end
+        end
+        child_node
+      end
+
+      # @rbs return: Node::StatementsNode | Node::BeginNode | nil
+      # @return [Node::StatementsNode, Node::BeginNode, nil]
+      def body_node
+        # body_node will be set in #children
+        children
+        @body_node
+      end
     end
   end
 end

data/lib/ruby_mod_kit/node/def_parent_node.rb

@@ -7,7 +7,7 @@ module RubyModKit
     # Transpiler program node
     class DefParentNode < Node::BaseNode
       # @rbs @prism_node: Prism::ClassNode | Prism::ModuleNode
-      # @rbs @body_node: nil | Node::StatementsNode
+      # @rbs @body_node: Node::StatementsNode | nil
       # @rbs @parent: Node::BaseNode
       # @rbs @prev: Node::BaseNode | nil
 
@@ -19,6 +19,10 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::ClassNode, Prism::ModuleNode]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize(prism_node, parent:, prev: nil)
         @prism_node = prism_node
         @parent = parent
@@ -31,13 +35,17 @@ module RubyModKit
       # @rbs prism_child_node: Prism::Node
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: Node::BaseNode
+      # @param prism_child_node [Prism::Node]
+      # @param prev [Node::BaseNode, nil]
+      # @return [Node::BaseNode]
       def wrap(prism_child_node, prev: nil)
         child_node = super
         @body_node = child_node if prism_child_node == @prism_node.body && child_node.is_a?(Node::StatementsNode)
         child_node
       end
 
-      # @rbs return: nil | Node::StatementsNode
+      # @rbs return: Node::StatementsNode | nil
+      # @return [Node::StatementsNode, nil]
       def body_node
         # body_node will be set in #children
         children

data/lib/ruby_mod_kit/node/parameter_node.rb

@@ -13,7 +13,7 @@ module RubyModKit
       # @rbs!
       #   type prism_node = Prism::RequiredParameterNode | Prism::OptionalKeywordParameterNode
       #                   | Prism::OptionalParameterNode | Prism::RequiredKeywordParameterNode
-      #                   | Prism::RestParameterNode
+      #                   | Prism::RestParameterNode | Prism::BlockParameterNode
 
       private attr_reader :prism_node #: prism_node
       attr_reader :parent #: Node::BaseNode
@@ -23,6 +23,10 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [prism_node]
+      # @param parent [Node::BaseNode]
+      # @param prev [Node::BaseNode, nil]
+      # @return [void]
       def initialize(prism_node, parent:, prev: nil)
         @prism_node = prism_node
         @parent = parent
@@ -30,7 +34,7 @@ module RubyModKit
         case prism_node
         when Prism::RequiredParameterNode, Prism::OptionalKeywordParameterNode,
              Prism::OptionalParameterNode, Prism::RequiredKeywordParameterNode,
-             Prism::RestParameterNode
+             Prism::RestParameterNode, Prism::BlockParameterNode
           super()
         else
           raise RubyModKit::Error, "unexpected prism node #{prism_node.class}"
@@ -38,6 +42,7 @@ module RubyModKit
       end
 
       # @rbs return: Symbol | nil
+      # @return [Symbol, nil]
       def name
         @prism_node.name
       end

data/lib/ruby_mod_kit/node/program_node.rb

@@ -12,6 +12,8 @@ module RubyModKit
 
       # @rbs prism_node: Prism::ProgramNode
       # @rbs return: void
+      # @param prism_node [Prism::ProgramNode]
+      # @return [void]
       def initialize(prism_node)
         @prism_node = prism_node
         raise RubyModKit::Error unless prism_node.is_a?(Prism::ProgramNode)
@@ -20,6 +22,7 @@ module RubyModKit
       end
 
       # @rbs return: nil
+      # @return [nil]
       def parent
         nil
       end

data/lib/ruby_mod_kit/node/statements_node.rb

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