ruby_mod_kit 0.0.5 → 0.0.6

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

@@ -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
@@ -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

data/lib/ruby_mod_kit/node/symbol_node.rb

@@ -9,7 +9,7 @@ module RubyModKit
       # @rbs @prism_node: Prism::SymbolNode
       # @rbs @parent: Node::BaseNode
       # @rbs @prev: Node::BaseNode | nil
-      # @rbs @value: nil | Symbol
+      # @rbs @value: Symbol | nil
 
       private attr_reader :prism_node #: Prism::SymbolNode
       attr_reader :parent #: Node::BaseNode
@@ -19,6 +19,10 @@ module RubyModKit
       # @rbs parent: Node::BaseNode
       # @rbs prev: Node::BaseNode | nil
       # @rbs return: void
+      # @param prism_node [Prism::SymbolNode]
+      # @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,7 +32,8 @@ module RubyModKit
         super()
       end
 
-      # @rbs return: nil | Symbol
+      # @rbs return: Symbol | nil
+      # @return [Symbol, nil]
       def value
         return @value if defined?(@value)
 

data/lib/ruby_mod_kit/node/untyped_node.rb

@@ -18,6 +18,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

data/lib/ruby_mod_kit/node/wrap.rb

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

data/lib/ruby_mod_kit/offset_diff.rb

@@ -9,6 +9,7 @@ module RubyModKit
     # @rbs @offsets: Array[Integer]
 
     # @rbs return: void
+    # @return [void]
     def initialize
       @diffs = {}
       @offsets = []
@@ -16,6 +17,8 @@ module RubyModKit
 
     # @rbs src_offset: Integer
     # @rbs return: Integer
+    # @param src_offset [Integer]
+    # @return [Integer]
     def [](src_offset)
       dst_offset = src_offset
       @offsets.each do |offset|
@@ -31,6 +34,9 @@ module RubyModKit
     # @rbs src_offset: Integer
     # @rbs new_diff: Integer
     # @rbs return: void
+    # @param src_offset [Integer]
+    # @param new_diff [Integer]
+    # @return [void]
     def insert(src_offset, new_diff)
       if @diffs[src_offset]
         @diffs[src_offset] += new_diff

data/lib/ruby_mod_kit/version.rb

@@ -3,5 +3,5 @@
 # rbs_inline: enabled
 
 module RubyModKit
-  VERSION = "0.0.5" #: String
+  VERSION = "0.0.6" #: String
 end

data/lib/ruby_mod_kit.rb

@@ -7,15 +7,23 @@ require "prism"
 
 # The root namespace for ruby_mod_kit.
 module RubyModKit
+  # An internal error because of RubyModKit implementation
   class Error < StandardError; end
+
+  # A SyntaxError of rbm script
   class SyntaxError < ::SyntaxError; end
 
   class << self
     # @rbs file: String
     # @rbs *args: String
     # @rbs output: String | nil
-    # @rbs config: nil | Config
+    # @rbs config: Config | nil
     # @rbs return: void
+    # @param file [String]
+    # @param args [String]
+    # @param output [String, nil]
+    # @param config [Config, nil]
+    # @return [void]
     def execute_file(file, *args, output: nil, config: nil)
       rb_script = transpile_file(file, output: output, config: config)
       if output
@@ -27,8 +35,12 @@ module RubyModKit
 
     # @rbs file: String
     # @rbs output: String | IO | nil
-    # @rbs config: nil | Config
+    # @rbs config: Config | nil
     # @rbs return: String
+    # @param file [String]
+    # @param output [String, IO, nil]
+    # @param config [Config, nil]
+    # @return [String]
     def transpile_file(file, output: nil, config: nil)
       rb_script = transpile(File.read(file), filename: file, config: config)
       case output
@@ -42,8 +54,12 @@ module RubyModKit
 
     # @rbs src: String
     # @rbs filename: String | nil
-    # @rbs config: nil | Config
+    # @rbs config: Config | nil
     # @rbs return: String
+    # @param src [String]
+    # @param filename [String, nil]
+    # @param config [Config, nil]
+    # @return [String]
     def transpile(src, filename: nil, config: nil)
       Generation.resolve(src, filename: filename, config: config).script
     end
@@ -51,12 +67,17 @@ module RubyModKit
     # @rbs file: String
     # @rbs *args: String
     # @rbs return: void
+    # @param file [String]
+    # @param args [String]
+    # @return [void]
     def execute_rb_file(file, *args)
       system(RbConfig.ruby, file, *args)
     end
 
     # @rbs path: String
     # @rbs return: String
+    # @param path [String]
+    # @return [String]
     def rb_path(path)
       path.sub(/(?:\.rbm)?$/, ".rb")
     end
@@ -64,6 +85,9 @@ module RubyModKit
     # @rbs rb_script: String
     # @rbs *args: String
     # @rbs return: void
+    # @param rb_script [String]
+    # @param args [String]
+    # @return [void]
     def execute_rb(rb_script, *args)
       ARGV.replace(args)
       eval(rb_script, TOPLEVEL_BINDING) # rubocop:disable Security/Eval
@@ -71,6 +95,8 @@ module RubyModKit
 
     # @rbs type: String
     # @rbs return: String
+    # @param type [String]
+    # @return [String]
     def unify_type(type)
       type[/\A\(([^()]*)\)\z/, 1] || type
     end

data/sig/generated/ruby_mod_kit/cli.rbs

@@ -5,15 +5,20 @@ module RubyModKit
   class CLI < Thor
     # @rbs *args: String
     # @rbs return: void
+    # @param args [String]
+    # @return [void]
     def exec: (*String args) -> void
 
     # @rbs *args: String
     # @rbs return: void
+    # @param args [String]
+    # @return [void]
     def transpile: (*String args) -> void
 
     private
 
     # @rbs return: Config | nil
+    # @return [Config, nil]
     def config: () -> (Config | nil)
   end
 end

data/sig/generated/ruby_mod_kit/config.rbs

@@ -11,11 +11,16 @@ module RubyModKit
 
     # @rbs features: Array[String]
     # @rbs return: void
+    # @param features [Array<String>]
+    # @return [void]
     def initialize: (?features: Array[String]) -> void
 
     # @rbs path: String
-    # @rbs if_none: nil | Symbol
+    # @rbs if_none: Symbol | nil
     # @rbs return: Config | nil
-    def self.load: (String path, ?if_none: nil | Symbol) -> (Config | nil)
+    # @param path [String]
+    # @param if_none [Symbol, nil]
+    # @return [Config, nil]
+    def self.load: (String path, ?if_none: Symbol | nil) -> (Config | nil)
   end
 end

data/sig/generated/ruby_mod_kit/core_ext/eval.rbs

@@ -2,6 +2,7 @@
 
 # Define RubyMotKit.eval
 module RubyModKit
+  # the namespace for language core extensions
   module CoreExt
     # the extension for eval
     module Eval
@@ -11,6 +12,12 @@ module RubyModKit
       # @rbs lineno: Integer
       # @rbs transpile: bool
       # @rbs return: Object
+      # @param expr [String]
+      # @param binding [Binding]
+      # @param fname [String]
+      # @param lineno [Integer]
+      # @param transpile [Boolean]
+      # @return [Object]
       def self?.eval: (String expr, ?Binding binding, ?String fname, ?Integer lineno, ?transpile: bool) -> Object
     end
   end

data/sig/generated/ruby_mod_kit/core_ext/load.rbs

@@ -10,21 +10,31 @@ module RubyModKit
       # @rbs path: String
       # @rbs wrap: bool
       # @rbs return: bool
+      # @param path [String]
+      # @param wrap [Boolean]
+      # @return [Boolean]
       def self?.load: (String path, ?bool wrap) -> bool
 
       # @rbs path: String
       # @rbs return: bool
+      # @param path [String]
+      # @return [Boolean]
       def self?.require: (String path) -> bool
 
       # @rbs return: Array[String]
+      # @return [Array<String>]
       def self.loaded_features: () -> Array[String]
 
       # @rbs return: Array[String]
+      # @return [Array<String>]
       def self.load_path: () -> Array[String]
 
       # @rbs path: String
       # @rbs expanded: bool
       # @rbs return: String | nil
+      # @param path [String]
+      # @param expanded [Boolean]
+      # @return [String, nil]
       def self.require_path: (String path, ?expanded: bool) -> (String | nil)
     end
   end

data/sig/generated/ruby_mod_kit/corrector.rbs

@@ -4,14 +4,19 @@ module RubyModKit
   # the base class of corrector
   class Corrector
     # @rbs return: Array[Symbol]
+    # @return [Array<Symbol>]
     def correctable_error_types: () -> Array[Symbol]
 
     # @rbs _parse_error: Prism::ParseError
     # @rbs _generation: Generation
     # @rbs return: void
+    # @param _parse_error [Prism::ParseError]
+    # @param _generation [Generation]
+    # @return [void]
     def correct: (untyped _parse_error, untyped _generation) -> void
 
     # @rbs return: void
+    # @return [void]
     def setup: () -> void
   end
 end

data/sig/generated/ruby_mod_kit/corrector_manager.rbs

@@ -9,14 +9,20 @@ module RubyModKit
 
     # @rbs features: Array[Feature]
     # @rbs return: void
+    # @param features [Array<Feature>]
+    # @return [void]
     def initialize: (Array[Feature] features) -> void
 
     # @rbs generation: Generation
     # @rbs return: bool
+    # @param generation [Generation]
+    # @return [Boolean]
     def perform: (Generation generation) -> bool
 
     # @rbs generation: Generation
     # @rbs return: void
+    # @param generation [Generation]
+    # @return [void]
     def check_prev_errors: (Generation generation) -> void
   end
 end

data/sig/generated/ruby_mod_kit/feature/instance_variable_parameter/instance_variable_parameter_corrector.rbs

@@ -6,11 +6,15 @@ module RubyModKit
       # the class to correct `def foo(@bar) ...` -> `def foo(bar) ...`
       class InstanceVariableParameterCorrector < Corrector
         # @rbs return: Array[Symbol]
+        # @return [Array<Symbol>]
         def correctable_error_types: () -> Array[Symbol]
 
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def correct: (Prism::ParseError parse_error, Generation generation) -> void
       end
     end

data/sig/generated/ruby_mod_kit/feature/instance_variable_parameter/instance_variable_parameter_mission.rbs

@@ -7,6 +7,8 @@ module RubyModKit
       class InstanceVariableParameterMission < Mission
         # @rbs generation: Generation
         # @rbs return: bool
+        # @param generation [Generation]
+        # @return [Boolean]
         def perform: (Generation generation) -> bool
       end
     end

data/sig/generated/ruby_mod_kit/feature/instance_variable_parameter.rbs

@@ -5,9 +5,11 @@ module RubyModKit
     # namespace for instance_variable parameter feature
     class InstanceVariableParameter < Feature
       # @rbs return: Array[Corrector]
+      # @return [Array<Corrector>]
       def create_correctors: () -> Array[Corrector]
 
       # @rbs return: Array[Mission]
+      # @return [Array<Mission>]
       def create_missions: () -> Array[Mission]
     end
   end

data/sig/generated/ruby_mod_kit/feature/overload/overload_mission.rbs

@@ -10,10 +10,13 @@ module RubyModKit
         OVERLOAD_METHOD_MAP: Hash[Symbol, String]
 
         # @rbs return: void
+        # @return [void]
         def initialize: () -> void
 
         # @rbs generation: Generation
         # @rbs return: bool
+        # @param generation [Generation]
+        # @return [Boolean]
         def perform: (Generation generation) -> bool
       end
     end

data/sig/generated/ruby_mod_kit/feature/overload.rbs

@@ -5,6 +5,7 @@ module RubyModKit
     # namespace for overload feature
     class Overload < Feature
       # @rbs return: Array[Mission]
+      # @return [Array<Mission>]
       def create_missions: () -> Array[Mission]
     end
   end

data/sig/generated/ruby_mod_kit/feature/type/check/arguments/add_arguments_checker_mission.rbs

@@ -8,6 +8,8 @@ module RubyModKit
         class AddArgumentsCheckerMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform: (Generation generation) -> bool
         end
       end

data/sig/generated/ruby_mod_kit/feature/type/check/arguments.rbs

@@ -3,10 +3,12 @@
 module RubyModKit
   class Feature
     class Type
+      # namespace for type checker
       module Check
         # namespace for arguments type checker
         class Arguments < Feature
           # @rbs return: Array[Mission]
+          # @return [Array<Mission>]
           def create_missions: () -> Array[Mission]
         end
       end

data/sig/generated/ruby_mod_kit/feature/type/instance_variable_colon_corrector.rbs

@@ -12,11 +12,15 @@ module RubyModKit
         REGEXP: Regexp
 
         # @rbs return: Array[Symbol]
+        # @return [Array<Symbol>]
         def correctable_error_types: () -> Array[Symbol]
 
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def correct: (Prism::ParseError parse_error, Generation generation) -> void
       end
     end

data/sig/generated/ruby_mod_kit/feature/type/parameter_arrow_corrector.rbs

@@ -8,29 +8,43 @@ module RubyModKit
         @last_parameter_offsets: Set[Integer]
 
         # @rbs return: Array[Symbol]
+        # @return [Array<Symbol>]
         def correctable_error_types: () -> Array[Symbol]
 
         # @rbs return: void
+        # @return [void]
         def setup: () -> void
 
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def correct: (Prism::ParseError parse_error, Generation generation) -> void
 
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def remove_arrow_before_parameter: (Prism::ParseError parse_error, Generation generation) -> void
 
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def remove_arrow_after_quailifier: (Prism::ParseError parse_error, Generation generation) -> void
 
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def wrap_parameter_type_for_next_parse: (Prism::ParseError parse_error, Generation generation) -> void
       end
     end

data/sig/generated/ruby_mod_kit/feature/type/rbs_inline/add_magic_comment_mission.rbs

@@ -9,10 +9,13 @@ module RubyModKit
           @reloaded: bool
 
           # @rbs return: void
+          # @return [void]
           def initialize: () -> void
 
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform: (Generation generation) -> bool
         end
       end

data/sig/generated/ruby_mod_kit/feature/type/rbs_inline/type_attr_mission.rbs

@@ -8,6 +8,8 @@ module RubyModKit
         class TypeAttrMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform: (Generation generation) -> bool
         end
       end

data/sig/generated/ruby_mod_kit/feature/type/rbs_inline/type_instance_variable_mission.rbs

@@ -8,6 +8,8 @@ module RubyModKit
         class TypeInstanceVariableMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform: (Generation generation) -> bool
         end
       end