ruby_mod_kit 0.0.3 → 0.0.4

data/lib/ruby_mod_kit/feature/type/type_attr_mission.rb

@@ -7,6 +7,8 @@ module RubyModKit
     class Type
       # The mission for parameter attributes
       class TypeAttrMission < Mission
+        # @rbs @modified: bool
+
         # @rbs return: void
         def initialize
           super
@@ -14,17 +16,15 @@ module RubyModKit
         end
 
         # @rbs generation: Generation
-        # @rbs root_node: Node::ProgramNode
-        # @rbs _parse_result: Prism::ParseResult
-        # @rbs memo_pad: MemoPad
         # @rbs return: bool
-        def perform(generation, root_node, _parse_result, memo_pad)
+        def perform(generation)
           return true if @modified
 
-          memo_pad.def_parents_memo.each_value do |def_parent_memo|
-            ivars_memo = def_parent_memo.ivars_memo.dup
-            def_parent_node = root_node.def_parent_node_at(def_parent_memo.offset) || raise(RubyModKit::Error)
+          generation.memo_pad.def_parents_memo.each_value do |def_parent_memo|
             attr_adding_line = 0
+            ivars_memo = def_parent_memo.ivars_memo.dup
+            def_parent_node = generation.root_node.def_parent_node_at(def_parent_memo.offset)
+            raise(RubyModKit::Error) unless def_parent_node
 
             ivars_memo.keep_if { |_, ivar_memo| ivar_memo.attr_kind }
             next if ivars_memo.empty?
@@ -54,7 +54,9 @@ module RubyModKit
 
             generation[offset, 0] = "\n" if add_first_separator_line
             ivars_memo.each do |name, ivar_memo|
-              generation[offset, 0] = "#{indent}#{ivar_memo.attr_kind} :#{name}\n"
+              attr = ivar_memo.attr_kind
+              attr = "#{ivar_memo.visibility} #{attr}" if ivar_memo.visibility
+              generation[offset, 0] = "#{indent}#{attr} :#{name}\n"
             end
             @modified = true
             generation[offset, 0] = "\n" if add_separator_line

data/lib/ruby_mod_kit/feature.rb

@@ -5,12 +5,6 @@
 module RubyModKit
   # the base class of feature
   class Feature
-    # @rbs other: Feature
-    # @rbs return: -1 | 0 | 1 | nil
-    def <=>(other)
-      self.class.name <=> other.class.name
-    end
-
     # @rbs return: Array[Corrector]
     def create_correctors
       []

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,44 @@ 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]
 
-    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
+      @root_node = Node::ProgramNode.new(parse_result.value)
       init_missions
     end
 
@@ -66,7 +73,7 @@ module RubyModKit
 
     # @rbs return: Generation
     def succ
-      if @parse_result.errors.empty?
+      if @errors.empty?
         perform_missions
       else
         perform_corrector
@@ -84,6 +91,7 @@ module RubyModKit
         filename: @filename,
         corrector_manager: @corrector_manager,
         features: @features,
+        config: @config,
       )
     end
 
@@ -94,7 +102,7 @@ module RubyModKit
 
     # @rbs return: bool
     def completed?
-      @parse_result.errors.empty? && @missions.empty?
+      @errors.empty? && @missions.empty?
     end
 
     # @rbs src_offset: Integer
@@ -138,13 +146,13 @@ module RubyModKit
     # @rbs line_num: Integer
     # @rbs return: String
     def line__overload0(line_num)
-      line_by_offset(@parse_result.source.offsets[line_num])
+      line_by_offset(@offsets[line_num])
     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
@@ -167,7 +175,7 @@ module RubyModKit
     # @rbs line_num: Integer
     # @rbs return: Integer | nil
     def src_offset__overload0(line_num)
-      parse_result.source.offsets[line_num]
+      @offsets[line_num]
     end
 
     # @rbs parse_error: Prism::ParseError
@@ -178,13 +186,13 @@ module RubyModKit
 
     # @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 +205,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,13 @@ module RubyModKit
       # @rbs @offset: nil | Integer
       # @rbs @indent: String
       # @rbs @name: Symbol
+      # @rbs @visibility: nil | Symbol
 
       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
 
       # @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.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

data/lib/ruby_mod_kit/mission.rb

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

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}")
@@ -93,11 +106,6 @@ 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
@@ -132,6 +140,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/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

@@ -15,7 +15,7 @@ module RubyModKit
       #                   | Prism::OptionalParameterNode | Prism::RequiredKeywordParameterNode
       #                   | Prism::RestParameterNode
 
-      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/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.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 module RubyModKit
   # The namespace of transpile node.
   module 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.4" #: String
 end

data/lib/ruby_mod_kit.rb

@@ -14,9 +14,10 @@ module RubyModKit
     # @rbs file: String
     # @rbs *args: String
     # @rbs output: String | nil
+    # @rbs config: nil | Config
     # @rbs return: void
-    def execute_file(file, *args, output: nil)
-      rb_script = transpile_file(file, output: output)
+    def execute_file(file, *args, output: nil, config: nil)
+      rb_script = transpile_file(file, output: output, config: config)
       if output
         execute_rb_file(output, *args)
       else
@@ -26,9 +27,10 @@ module RubyModKit
 
     # @rbs file: String
     # @rbs output: String | IO | nil
+    # @rbs config: nil | Config
     # @rbs return: String
-    def transpile_file(file, output: nil)
-      rb_script = transpile(File.read(file), filename: file)
+    def transpile_file(file, output: nil, config: nil)
+      rb_script = transpile(File.read(file), filename: file, config: config)
       case output
       when IO
         output.write(rb_script)
@@ -40,9 +42,10 @@ module RubyModKit
 
     # @rbs src: String
     # @rbs filename: String | nil
+    # @rbs config: nil | Config
     # @rbs return: String
-    def transpile(src, filename: nil)
-      Generation.resolve(src, filename: filename).script
+    def transpile(src, filename: nil, config: nil)
+      Generation.resolve(src, filename: filename, config: config).script
     end
 
     # @rbs file: String
@@ -75,6 +78,8 @@ module RubyModKit
 end
 
 require_relative "ruby_mod_kit/version"
+
+require_relative "ruby_mod_kit/config"
 require_relative "ruby_mod_kit/corrector"
 require_relative "ruby_mod_kit/corrector_manager"
 require_relative "ruby_mod_kit/feature"

data/ruby_mod_kit.gemspec

@@ -26,7 +26,13 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject do |f|
       next true if File.expand_path(f) == __FILE__
       next false if f =~ %r{\Aexamples/.*rbm?\z}
-      next true if f.start_with?(*%w[bin/ test/ spec/ features/ coverage/ bin/ .git])
+      next true if f.start_with?(
+        *%w[
+          bin/ test/ spec/ features/ coverage/ bin/ .git
+          lib/internal/ sig/generated/internal/
+          sig/rubocop
+        ],
+      )
       next true if %w[Gemfile Gemfile.lock .rspec .rubocop.yml Rakefile Steepfile].include?(f)
       next true if f.end_with?(".rbm")
 

data/sig/generated/ruby_mod_kit/cli.rbs

@@ -10,5 +10,10 @@ module RubyModKit
     # @rbs *args: String
     # @rbs return: void
     def transpile: (*String args) -> void
+
+    private
+
+    # @rbs return: Config | nil
+    def config: () -> (Config | nil)
   end
 end

data/sig/generated/ruby_mod_kit/config.rbs

@@ -0,0 +1,21 @@
+# Generated from lib/ruby_mod_kit/config.rb with RBS::Inline
+
+module RubyModKit
+  # config class
+  class Config
+    @features: Array[Config]
+
+    attr_reader features: Array[Config]
+
+    DEFAULT_FEATURES: Array[String]
+
+    # @rbs features: Array[String]
+    # @rbs return: void
+    def initialize: (?features: Array[String]) -> void
+
+    # @rbs path: String
+    # @rbs if_none: nil | Symbol
+    # @rbs return: Config | nil
+    def self.load: (String path, ?if_none: nil | Symbol) -> (Config | nil)
+  end
+end

data/sig/generated/ruby_mod_kit/corrector.rbs

@@ -8,9 +8,7 @@ module RubyModKit
 
     # @rbs _parse_error: Prism::ParseError
     # @rbs _generation: Generation
-    # @rbs _root_node: Node::ProgramNode
-    # @rbs _memo_pad: MemoPad
     # @rbs return: void
-    def correct: (untyped _parse_error, untyped _generation, untyped _root_node, untyped _memo_pad) -> void
+    def correct: (untyped _parse_error, untyped _generation) -> void
   end
 end

data/sig/generated/ruby_mod_kit/corrector_manager.rbs

@@ -12,15 +12,11 @@ module RubyModKit
     def initialize: (Array[Feature] features) -> void
 
     # @rbs generation: Generation
-    # @rbs root_node: Node::ProgramNode
-    # @rbs parse_result: Prism::ParseResult
-    # @rbs memo_pad: MemoPad
     # @rbs return: bool
-    def perform: (Generation generation, Node::ProgramNode root_node, Prism::ParseResult parse_result, MemoPad memo_pad) -> bool
+    def perform: (Generation generation) -> bool
 
     # @rbs generation: Generation
-    # @rbs parse_result: Prism::ParseResult
     # @rbs return: void
-    def check_prev_errors: (Generation generation, Prism::ParseResult parse_result) -> 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

@@ -10,10 +10,8 @@ module RubyModKit
 
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
-        # @rbs root_node: Node::ProgramNode
-        # @rbs memo_pad: MemoPad
         # @rbs return: void
-        def correct: (Prism::ParseError parse_error, Generation generation, Node::ProgramNode root_node, MemoPad memo_pad) -> void
+        def correct: (Prism::ParseError parse_error, Generation generation) -> void
       end
     end
   end

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

@@ -5,16 +5,9 @@ module RubyModKit
     class InstanceVariableParameter
       # The mission for instance variable arguments
       class InstanceVariableParameterMission < Mission
-        @assignment: String
-
-        attr_reader assignment: String
-
         # @rbs generation: Generation
-        # @rbs root_node: Node::ProgramNode
-        # @rbs _parse_result: Prism::ParseResult
-        # @rbs memo_pad: MemoPad
         # @rbs return: bool
-        def perform: (Generation generation, Node::ProgramNode root_node, untyped _parse_result, MemoPad memo_pad) -> bool
+        def perform: (Generation generation) -> bool
       end
     end
   end

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

@@ -13,11 +13,8 @@ module RubyModKit
         def initialize: () -> void
 
         # @rbs generation: Generation
-        # @rbs root_node: Node::ProgramNode
-        # @rbs parse_result: Prism::ParseResult
-        # @rbs memo_pad: MemoPad
         # @rbs return: bool
-        def perform: (Generation generation, Node::ProgramNode root_node, Prism::ParseResult parse_result, MemoPad memo_pad) -> bool
+        def perform: (Generation generation) -> bool
       end
     end
   end