ruby_mod_kit 0.0.3 → 0.0.5

data/lib/ruby_mod_kit/generation.rb

@@ -5,7 +5,6 @@
 module RubyModKit
   # The class of transpiler generation.
   class Generation
-    # @rbs @parse_result: Prism::ParseResult
     # @rbs @script: String
     # @rbs @missions: Array[Mission]
     # @rbs @memo_pad: MemoPad
@@ -15,36 +14,46 @@ module RubyModKit
     # @rbs @filename: String | nil
     # @rbs @corrector_manager: CorrectorManager
     # @rbs @features: Array[Feature]
+    # @rbs @config: Config
+    # @rbs @errors: Array[Prism::ParseError]
+    # @rbs @lines: Array[String]
+    # @rbs @offsets: Array[Integer]
+    # @rbs @source: String
 
-    attr_reader :parse_result #: Prism::ParseResult
     attr_reader :script #: String
+    attr_reader :memo_pad #: MemoPad
+    attr_reader :root_node #: Node::ProgramNode
+    attr_reader :errors #: Array[Prism::ParseError]
+    attr_reader :lines #: Array[String]
+    attr_reader :offsets #: Array[Integer]
 
     # @rbs script: String
     # @rbs missions: Array[Mission]
     # @rbs memo_pad: MemoPad | nil
     # @rbs generation_num: Integer
+    # @rbs config: Config | nil
     # @rbs filename: String | nil
     # @rbs corrector_manager: CorrectorManager | nil
     # @rbs features: Array[Feature] | nil
     # @rbs return: void
-    def initialize(script, missions: [], memo_pad: nil, generation_num: 0,
+    def initialize(script, missions: [], memo_pad: nil, generation_num: 0, config: nil,
                    filename: nil, corrector_manager: nil, features: nil)
       @script = script
       @missions = missions
       @generation_num = generation_num
       @filename = filename
-      @features = features || [
-        Feature::InstanceVariableParameter.new,
-        Feature::Overload.new,
-        Feature::Type.new,
-        Feature::Type::RbsInline.new,
-      ].sort
+      @config = config || Config.new
+      @features = features || @config.features
 
       @memo_pad = memo_pad || MemoPad.new
       @corrector_manager = corrector_manager || CorrectorManager.new(@features)
       @offset_diff = OffsetDiff.new
-      @parse_result = Prism.parse(@script)
-      @root_node = Node::ProgramNode.new(@parse_result.value)
+      parse_result = Prism.parse(@script)
+      @errors = parse_result.errors
+      @lines = parse_result.source.lines
+      @offsets = parse_result.source.offsets
+      @source = @script.dup
+      @root_node = Node::ProgramNode.new(parse_result.value)
       init_missions
     end
 
@@ -66,14 +75,11 @@ module RubyModKit
 
     # @rbs return: Generation
     def succ
-      if @parse_result.errors.empty?
+      if @errors.empty?
         perform_missions
       else
         perform_corrector
       end
-      @missions.each do |mission|
-        mission.succ(@offset_diff)
-      end
       @memo_pad.succ(@offset_diff)
 
       Generation.new(
@@ -84,6 +90,7 @@ module RubyModKit
         filename: @filename,
         corrector_manager: @corrector_manager,
         features: @features,
+        config: @config,
       )
     end
 
@@ -94,7 +101,7 @@ module RubyModKit
 
     # @rbs return: bool
     def completed?
-      @parse_result.errors.empty? && @missions.empty?
+      @errors.empty? && @missions.empty?
     end
 
     # @rbs src_offset: Integer
@@ -107,18 +114,10 @@ module RubyModKit
       @offset_diff.insert(src_offset, diff)
     end
 
-    # @rbs src_range: Range[Integer]
+    # @rbs src_range: Range[Integer | nil]
     # @rbs return: String
     def [](src_range)
-      dst_range = Range.new(@offset_diff[src_range.first], @offset_diff[src_range.last], src_range.exclude_end?)
-      @script[dst_range] || raise(RubyModKit::Error, "Invalid range")
-    end
-
-    # @rbs offset: Integer
-    # @rbs return: String
-    def line_by_offset(offset)
-      offset = @offset_diff[offset]
-      (@script.match(/.*\n?/, offset) && Regexp.last_match(0)) || raise(RubyModKit::Error)
+      @source[src_range] || raise(RubyModKit::Error, "Invalid range")
     end
 
     # @rbs (Integer) -> String
@@ -138,53 +137,97 @@ module RubyModKit
     # @rbs line_num: Integer
     # @rbs return: String
     def line__overload0(line_num)
-      line_by_offset(@parse_result.source.offsets[line_num])
+      @lines[line_num] || raise(RubyModKit::Error)
     end
 
     # @rbs node: Node::BaseNode
     # @rbs return: String
     def line__overload1(node)
-      line(node.prism_node.location.start_line - 1)
+      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 src_offset(*args)
+    def line_offset(*args)
       case args
       in [Integer]
-        src_offset__overload0(*args)
+        line_offset__overload0(*args)
+      in [Node::BaseNode]
+        line_offset__overload1(*args)
+      in [Node::BaseNode, Integer]
+        line_offset__overload2(*args)
       in [Prism::ParseError]
-        src_offset__overload1(*args)
+        line_offset__overload3(*args)
       end
     end
 
     # @rbs line_num: Integer
     # @rbs return: Integer | nil
-    def src_offset__overload0(line_num)
-      parse_result.source.offsets[line_num]
+    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 src_offset__overload1(parse_error)
-      src_offset(parse_error.location.start_line - 1)
+    def line_offset__overload3(parse_error)
+      line_offset(parse_error.location.start_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)
+      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
     def perform_corrector
-      @corrector_manager.perform(self, @root_node, @parse_result, @memo_pad)
+      @corrector_manager.perform(self)
     end
 
     # @rbs return: void
     def perform_missions
       @missions.delete_if do |mission|
-        mission.perform(self, @root_node, @parse_result, @memo_pad) || break
+        mission.perform(self) || break
       end
     end
 
@@ -197,9 +240,10 @@ module RubyModKit
     class << self
       # @rbs src: String
       # @rbs filename: String | nil
+      # @rbs config: Config | nil
       # @rbs return: Generation
-      def resolve(src, filename: nil)
-        generation = Generation.new(src.dup, filename: filename)
+      def resolve(src, filename: nil, config: nil)
+        generation = Generation.new(src.dup, filename: filename, config: config)
         generation = generation.succ until generation.completed?
         generation
       end

data/lib/ruby_mod_kit/memo/ivar_memo.rb

@@ -11,11 +11,15 @@ module RubyModKit
       # @rbs @offset: nil | Integer
       # @rbs @indent: String
       # @rbs @name: Symbol
+      # @rbs @visibility: nil | Symbol
+      # @rbs @separator: String
 
       attr_reader :type #: nil | String
       attr_reader :attr_kind #: nil | Symbol
       attr_accessor :offset #: nil | Integer
       attr_accessor :indent #: String
+      attr_accessor :visibility #: nil | Symbol
+      attr_accessor :separator #: String
 
       # @rbs name: Symbol
       # @rbs return: void

data/lib/ruby_mod_kit/memo/overload_memo.rb

@@ -9,6 +9,7 @@ module RubyModKit
       # @rbs @name: Symbol
       # @rbs @overload_types: [[Array[String], String]]
       # @rbs @offset_corrected: bool
+      # @rbs @offset: Integer
 
       attr_reader :name #: Symbol
       attr_reader :overload_types #: [[Array[String], String]]

data/lib/ruby_mod_kit/memo/parameter_memo.rb

@@ -8,11 +8,13 @@ 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"
 

data/lib/ruby_mod_kit/memo.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 module RubyModKit
   # The namespace of transpiler memo.
   module Memo

data/lib/ruby_mod_kit/memo_pad.rb

@@ -9,11 +9,13 @@ module RubyModKit
     # @rbs @methods_memo: Hash[Integer, Memo::MethodMemo]
     # @rbs @parameters_memo: Hash[Integer, Memo::ParameterMemo]
     # @rbs @overloads_memo: Hash[Integer, Memo::OverloadMemo]
+    # @rbs @flags: Hash[Symbol, bool]
 
     attr_reader :def_parents_memo #: Hash[Integer, Memo::DefParentMemo]
     attr_reader :methods_memo #: Hash[Integer, Memo::MethodMemo]
     attr_reader :parameters_memo #: Hash[Integer, Memo::ParameterMemo]
     attr_reader :overloads_memo #: Hash[Integer, Memo::OverloadMemo]
+    attr_accessor :flags #: Hash[Symbol, bool]
 
     # @rbs return: void
     def initialize
@@ -21,6 +23,7 @@ module RubyModKit
       @methods_memo = {}
       @parameters_memo = {}
       @overloads_memo = {}
+      @flags = Hash.new(false)
     end
 
     # @rbs offset_diff: OffsetDiff
@@ -65,5 +68,11 @@ module RubyModKit
 
       method_memo(def_node).add_parameter(memo)
     end
+
+    # @rbs &block: (Memo::ParameterMemo) -> void
+    # @rbs return: void
+    def each_parameter_memo(&block)
+      parameters_memo.each_value(&block)
+    end
   end
 end

data/lib/ruby_mod_kit/mission.rb

@@ -6,16 +6,9 @@ module RubyModKit
   # The base class of transpiler mission.
   class Mission
     # @rbs _generation: Generation
-    # @rbs _root_node: Node::ProgramNode
-    # @rbs _parse_result: Prism::ParseResult
-    # @rbs _memo_pad: MemoPad
     # @rbs return: void
-    def perform(_generation, _root_node, _parse_result, _memo_pad)
+    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

@@ -11,11 +11,12 @@ module RubyModKit
       # @rbs @ancestors: Array[Node::BaseNode]
       # @rbs @prev: Node::BaseNode | nil
 
-      attr_reader :location #: Prism::Location
       attr_reader :prev #: Node::BaseNode | nil
 
-      # @rbs return: void
-      def initialize
+      # @rbs return: Prism::Location
+      def location
+        return @location if defined?(@location)
+
         @location = prism_node.location
       end
 
@@ -25,15 +26,22 @@ module RubyModKit
 
         prev = nil
         @children = prism_node.child_nodes.compact.map do |prism_child_node|
-          prev = Node.wrap(prism_child_node, parent: self, prev: prev)
+          prev = wrap(prism_child_node, prev: prev)
         end
       end
 
+      # @rbs prism_node: Prism::Node
+      # @rbs prev: Node::BaseNode | nil
+      # @rbs return: Node::BaseNode
+      def wrap(prism_node, prev: nil)
+        Node.wrap(prism_node, parent: self, prev: prev)
+      end
+
       # @rbs return: Array[Node::BaseNode]
       def ancestors
         return @ancestors if @ancestors
 
-        parent = @parent
+        parent = self.parent
         @ancestors = if parent
           [parent] + parent.ancestors
         else
@@ -41,6 +49,11 @@ module RubyModKit
         end
       end
 
+      # @rbs return: nil | BaseNode
+      def parent
+        raise(RubyModKit::Error)
+      end
+
       # @rbs return: Symbol
       def name
         raise(RubyModKit::Error, "Expected ParameterNode but #{self.class}:#{prism_node.inspect}")
@@ -80,10 +93,14 @@ module RubyModKit
       end
 
       # @rbs offset: Integer
+      # @rbs allowed: Array[Class] | nil
       # @rbs return: Node::DefParentNode | nil
-      def def_parent_node_at(offset)
+      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
 
@@ -93,16 +110,16 @@ module RubyModKit
         self.offset <= offset && offset <= prism_node.location.end_offset
       end
 
-      # @rbs return: Prism::Node & Prism::_Node
-      def prism_node
-        raise RubyModKit::Error
-      end
-
       # @rbs return: Integer
       def offset
         location.start_offset
       end
 
+      # @rbs return: String
+      def slice
+        location.slice
+      end
+
       # @rbs return: String
       def inspect
         str = +"#<#{self.class} "
@@ -132,6 +149,16 @@ module RubyModKit
         str << ">"
         str
       end
+
+      private
+
+      # :nocov:
+      # This is just for interface definition, must not be called
+      # @rbs return: Prism::Node & Prism::_Node
+      def prism_node
+        raise RubyModKit::Error
+      end
+      # :nocov:
     end
   end
 end

data/lib/ruby_mod_kit/node/begin_node.rb

@@ -0,0 +1,31 @@
+# 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
+      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

@@ -11,7 +11,7 @@ module RubyModKit
       # @rbs @parent: Node::BaseNode
       # @rbs @prev: Node::BaseNode | nil
 
-      attr_reader :prism_node #: Prism::CallNode
+      private attr_reader :prism_node #: Prism::CallNode
       attr_reader :name #: Symbol
       attr_reader :parent #: Node::BaseNode
       attr_reader :prev #: Node::BaseNode | nil

data/lib/ruby_mod_kit/node/def_node.rb

@@ -10,7 +10,7 @@ module RubyModKit
       # @rbs @parent: Node::BaseNode
       # @rbs @prev: Node::BaseNode | nil
 
-      attr_reader :prism_node #: Prism::DefNode
+      private attr_reader :prism_node #: Prism::DefNode
       attr_reader :parent #: Node::BaseNode
       attr_reader :prev #: Node::BaseNode | nil
 

data/lib/ruby_mod_kit/node/def_parent_node.rb

@@ -11,7 +11,7 @@ module RubyModKit
       # @rbs @parent: Node::BaseNode
       # @rbs @prev: Node::BaseNode | nil
 
-      attr_reader :prism_node #: Prism::ClassNode | Prism::ModuleNode
+      private attr_reader :prism_node #: Prism::ClassNode | Prism::ModuleNode
       attr_reader :parent #: Node::BaseNode
       attr_reader :prev #: Node::BaseNode | nil
 
@@ -28,13 +28,20 @@ module RubyModKit
         super()
       end
 
+      # @rbs prism_child_node: Prism::Node
+      # @rbs prev: Node::BaseNode | nil
+      # @rbs 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
       def body_node
-        return @body_node if defined?(@body_node)
-
-        body_node = children.find { |node| node.prism_node == @prism_node.body }
-        body_node = nil unless body_node.is_a?(Node::StatementsNode)
-        @body_node = body_node
+        # body_node will be set in #children
+        children
+        @body_node
       end
     end
   end

data/lib/ruby_mod_kit/node/parameter_node.rb

@@ -13,9 +13,9 @@ module RubyModKit
       # @rbs!
       #   type prism_node = Prism::RequiredParameterNode | Prism::OptionalKeywordParameterNode
       #                   | Prism::OptionalParameterNode | Prism::RequiredKeywordParameterNode
-      #                   | Prism::RestParameterNode
+      #                   | Prism::RestParameterNode | Prism::BlockParameterNode
 
-      attr_reader :prism_node #: prism_node
+      private attr_reader :prism_node #: prism_node
       attr_reader :parent #: Node::BaseNode
       attr_reader :prev #: Node::BaseNode | nil
 
@@ -30,7 +30,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}"

data/lib/ruby_mod_kit/node/program_node.rb

@@ -8,7 +8,7 @@ module RubyModKit
     class ProgramNode < Node::BaseNode
       # @rbs @prism_node: Prism::ProgramNode
 
-      attr_reader :prism_node #: Prism::ProgramNode
+      private attr_reader :prism_node #: Prism::ProgramNode
 
       # @rbs prism_node: Prism::ProgramNode
       # @rbs return: void
@@ -18,6 +18,11 @@ module RubyModKit
 
         super()
       end
+
+      # @rbs return: nil
+      def parent
+        nil
+      end
     end
   end
 end

data/lib/ruby_mod_kit/node/statements_node.rb

@@ -10,7 +10,7 @@ module RubyModKit
       # @rbs @parent: Node::BaseNode
       # @rbs @prev: Node::BaseNode | nil
 
-      attr_reader :prism_node #: Prism::StatementsNode
+      private attr_reader :prism_node #: Prism::StatementsNode
       attr_reader :parent #: Node::BaseNode
       attr_reader :prev #: Node::BaseNode | nil
 

data/lib/ruby_mod_kit/node/symbol_node.rb

@@ -9,8 +9,9 @@ module RubyModKit
       # @rbs @prism_node: Prism::SymbolNode
       # @rbs @parent: Node::BaseNode
       # @rbs @prev: Node::BaseNode | nil
+      # @rbs @value: nil | Symbol
 
-      attr_reader :prism_node #: Prism::SymbolNode
+      private attr_reader :prism_node #: Prism::SymbolNode
       attr_reader :parent #: Node::BaseNode
       attr_reader :prev #: Node::BaseNode | nil
 

data/lib/ruby_mod_kit/node/untyped_node.rb

@@ -10,7 +10,7 @@ module RubyModKit
       # @rbs @parent: Node::BaseNode
       # @rbs @prev: Node::BaseNode | nil
 
-      attr_reader :prism_node #: Prism::Node
+      private attr_reader :prism_node #: Prism::Node
       attr_reader :parent #: Node::BaseNode
       attr_reader :prev #: Node::BaseNode | nil
 

data/lib/ruby_mod_kit/node/wrap.rb

@@ -20,6 +20,8 @@ module RubyModKit
       # @rbs return: Node::BaseNode
       def wrap(prism_node, parent:, prev: nil)
         case prism_node
+        when Prism::BeginNode
+          Node::BeginNode.new(prism_node, parent: parent, prev: prev)
         when Prism::CallNode
           Node::CallNode.new(prism_node, parent: parent, prev: prev)
         when Prism::DefNode
@@ -28,7 +30,7 @@ module RubyModKit
           Node::DefParentNode.new(prism_node, parent: parent, prev: prev)
         when Prism::RequiredParameterNode, Prism::OptionalKeywordParameterNode,
             Prism::OptionalParameterNode, Prism::RequiredKeywordParameterNode,
-            Prism::RestParameterNode
+            Prism::RestParameterNode, Prism::BlockParameterNode
           Node::ParameterNode.new(prism_node, parent: parent, prev: prev)
         when Prism::StatementsNode
           Node::StatementsNode.new(prism_node, parent: parent, prev: prev)

data/lib/ruby_mod_kit/node.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 module RubyModKit
   # The namespace of transpile node.
   module Node
@@ -9,6 +7,7 @@ module RubyModKit
 end
 
 require_relative "node/base_node"
+require_relative "node/begin_node"
 require_relative "node/symbol_node"
 require_relative "node/def_parent_node"
 require_relative "node/call_node"

data/lib/ruby_mod_kit/version.rb

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