ruby_mod_kit 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5888d6187dc2620b37315d72fddee6b134bbd14181277ff600e864eb9c06ca0
-  data.tar.gz: 7ffb4ec96c231e6122eeaa7d47601f67a28620951ed08e9d3b3888e9fa684fbc
+  metadata.gz: 7d1688dd299feefd22167740d43d09a691ba4e01359edbdfdcb81462ec7c4d47
+  data.tar.gz: 1ea7711fddb58f15c1257fb8a63595d300a7c45483af595f4defc48c5a842466
 SHA512:
-  metadata.gz: 3c2e632593d2d0a7061f8a71a7e65131a1b72434ac3853467024503d13c57328abe88ade105b2532baf94d44bd428bd02b4eae9e0c50462d4dca6bebc767d4f9
-  data.tar.gz: 81b17d66702c1fc89c77bc3270f74608fca6ed8e9a12f26c04ea69f7d0bdceb4b91b104bfa45b0f944e5ba5dae79e789de720b8a5605df0d4ac4bb4e48e62d6d
+  metadata.gz: fa6c821537ec79c43ed5b092f2a0044126c0b925bff381c33971c2462a0578e92b0f681d313d3053c0fbc688f13907a6b10180738fa075bc192e1b582c843479
+  data.tar.gz: a84c961311ae15bc60b8db3594a1f412ca7b1a71d4922707d271c7d3eba9338e91338c69f2414a04907c1bc1e2b76581d1298a3effd22706913d4731fe93b084

data/.ruby_mod_kit.yml

@@ -3,3 +3,4 @@ features:
   - overload
   - type
   - type/rbs_inline
+  - type/yard

data/.yardopts

@@ -0,0 +1,3 @@
+--tag rbs:rbs
+--exclude lib/ruby_mod_kit/core_ext.rb
+--exclude lib/internal/

data/examples/user.rb

@@ -50,25 +50,13 @@ class Pos
   #    | (Integer) -> Pos
   def *(*args)
     case args
-    in [Pos]
-      _mul__overload0(*args)
-    in [Integer]
-      _mul__overload1(*args)
+    in [Pos => other]
+      (@x * other.x) + (@y * other.y) + (@z * other.z)
+    in [Integer => n]
+      Pos.new(@x * n, @y * n, @z * n)
     end
   end
 
-  # @rbs other: Pos
-  # @rbs return: Integer
-  def _mul__overload0(other)
-    (@x * other.x) + (@y * other.y) + (@z * other.z)
-  end
-
-  # @rbs n: Integer
-  # @rbs return: Pos
-  def _mul__overload1(n)
-    Pos.new(@x * n, @y * n, @z * n)
-  end
-
   # @rbs return: String
   def to_s
     "#<Pos: (#{@x}, #{@y}, #{@z})>"

data/lib/ruby_mod_kit/cli.rb

@@ -11,6 +11,8 @@ module RubyModKit
     desc "exec", "execute rbm file"
     # @rbs *args: String
     # @rbs return: void
+    # @param args [String]
+    # @return [void]
     def exec(*args)
       RubyModKit.execute_file(*args, config: config)
     end
@@ -19,6 +21,8 @@ module RubyModKit
     method_option :output, type: :string
     # @rbs *args: String
     # @rbs return: void
+    # @param args [String]
+    # @return [void]
     def transpile(*args)
       output = case options[:output]
       when nil, "-", "/dev/stdout"
@@ -37,6 +41,7 @@ module RubyModKit
     private
 
     # @rbs return: Config | nil
+    # @return [Config, nil]
     def config
       if options[:config]
         config_path = options[:config]

data/lib/ruby_mod_kit/config.rb

@@ -15,6 +15,8 @@ module RubyModKit
 
     # @rbs features: Array[String]
     # @rbs return: void
+    # @param features [Array<String>]
+    # @return [void]
     def initialize(features: DEFAULT_FEATURES)
       @features = features.sort.map do |feature_name|
         raise ArgumentError, "invalid feature: #{feature_name}" if feature_name.include?(".")
@@ -29,8 +31,11 @@ module RubyModKit
 
     class << self
       # @rbs path: String
-      # @rbs if_none: nil | Symbol
+      # @rbs if_none: Symbol | nil
       # @rbs return: Config | nil
+      # @param path [String]
+      # @param if_none [Symbol, nil]
+      # @return [Config, nil]
       def load(path, if_none: nil)
         return load(File.join(path, ".ruby_mod_kit.yml"), if_none: if_none) if File.directory?(path)
 

data/lib/ruby_mod_kit/core_ext/eval.rb

@@ -6,6 +6,7 @@ require "ruby_mod_kit"
 
 # Define RubyMotKit.eval
 module RubyModKit
+  # the namespace for language core extensions
   module CoreExt
     # the extension for eval
     module Eval
@@ -17,6 +18,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 eval(expr, binding = TOPLEVEL_BINDING, fname = "(eval)", lineno = 1, transpile: true)
         expr = RubyModKit.transpile(expr, filename: fname) if transpile
 

data/lib/ruby_mod_kit/core_ext/load.rb

@@ -17,6 +17,9 @@ module RubyModKit
       # @rbs path: String
       # @rbs wrap: bool
       # @rbs return: bool
+      # @param path [String]
+      # @param wrap [Boolean]
+      # @return [Boolean]
       def load(path, wrap = false) # rubocop:disable Style/OptionalBooleanParameter
         return super unless path.end_with?(".rbm")
 
@@ -27,6 +30,8 @@ module RubyModKit
 
       # @rbs path: String
       # @rbs return: bool
+      # @param path [String]
+      # @return [Boolean]
       def require(path)
         require_path = Load.require_path(path)
         return super unless require_path&.end_with?(".rbm")
@@ -39,11 +44,13 @@ module RubyModKit
 
       class << self
         # @rbs return: Array[String]
+        # @return [Array<String>]
         def loaded_features
           $LOADED_FEATURES
         end
 
         # @rbs return: Array[String]
+        # @return [Array<String>]
         def load_path
           $LOAD_PATH
         end
@@ -51,6 +58,9 @@ module RubyModKit
         # @rbs path: String
         # @rbs expanded: bool
         # @rbs return: String | nil
+        # @param path [String]
+        # @param expanded [Boolean]
+        # @return [String, nil]
         def require_path(path, expanded: false)
           if !expanded && !File.absolute_path?(path)
             return load_path.each.lazy.map { require_path(File.join(_1, path), expanded: true) }.find(&:itself)

data/lib/ruby_mod_kit/corrector.rb

@@ -6,6 +6,7 @@ module RubyModKit
   # the base class of corrector
   class Corrector
     # @rbs return: Array[Symbol]
+    # @return [Array<Symbol>]
     def correctable_error_types
       []
     end
@@ -13,11 +14,15 @@ module RubyModKit
     # @rbs _parse_error: Prism::ParseError
     # @rbs _generation: Generation
     # @rbs return: void
+    # @param _parse_error [Prism::ParseError]
+    # @param _generation [Generation]
+    # @return [void]
     def correct(_parse_error, _generation)
       raise RubyModKit::Error, "Unexpected type #{self.class}"
     end
 
     # @rbs return: void
+    # @return [void]
     def setup; end
   end
 end

data/lib/ruby_mod_kit/corrector_manager.rb

@@ -10,6 +10,8 @@ module RubyModKit
 
     # @rbs features: Array[Feature]
     # @rbs return: void
+    # @param features [Array<Feature>]
+    # @return [void]
     def initialize(features)
       @previous_source = +""
       @correctors_error_map = {}
@@ -24,6 +26,8 @@ module RubyModKit
 
     # @rbs generation: Generation
     # @rbs return: bool
+    # @param generation [Generation]
+    # @return [Boolean]
     def perform(generation)
       return true if generation.errors.empty?
 
@@ -46,6 +50,8 @@ module RubyModKit
 
     # @rbs generation: Generation
     # @rbs return: void
+    # @param generation [Generation]
+    # @return [void]
     def check_prev_errors(generation)
       return if @previous_source.empty?
       return if generation.errors.empty?

data/lib/ruby_mod_kit/feature/instance_variable_parameter/instance_variable_parameter_corrector.rb

@@ -8,6 +8,7 @@ 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
           %i[argument_formal_ivar]
         end
@@ -15,6 +16,9 @@ module RubyModKit
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def correct(parse_error, generation)
           src_offset = parse_error.location.start_offset
 

data/lib/ruby_mod_kit/feature/instance_variable_parameter/instance_variable_parameter_mission.rb

@@ -9,6 +9,8 @@ module RubyModKit
       class InstanceVariableParameterMission < Mission
         # @rbs generation: Generation
         # @rbs return: bool
+        # @param generation [Generation]
+        # @return [Boolean]
         def perform(generation)
           generation.memo_pad.each_parameter_memo do |parameter_memo|
             next unless parameter_memo.ivar_parameter

data/lib/ruby_mod_kit/feature/instance_variable_parameter.rb

@@ -7,6 +7,7 @@ module RubyModKit
     # namespace for instance_variable parameter feature
     class InstanceVariableParameter < Feature
       # @rbs return: Array[Corrector]
+      # @return [Array<Corrector>]
       def create_correctors
         [
           InstanceVariableParameterCorrector.new,
@@ -14,6 +15,7 @@ module RubyModKit
       end
 
       # @rbs return: Array[Mission]
+      # @return [Array<Mission>]
       def create_missions
         [
           InstanceVariableParameterMission.new,

data/lib/ruby_mod_kit/feature/overload/overload_mission.rb

@@ -14,6 +14,7 @@ module RubyModKit
         }.freeze #: Hash[Symbol, String]
 
         # @rbs return: void
+        # @return [void]
         def initialize
           super
           @modified = false
@@ -21,8 +22,19 @@ module RubyModKit
 
         # @rbs generation: Generation
         # @rbs return: bool
+        # @param generation [Generation]
+        # @return [Boolean]
         def perform(generation)
-          return true if @modified
+          if @modified
+            generation.memo_pad.overloads_memo.each_value do |overload_memo|
+              overload_memo.correct_offset(generation.root_node)
+              def_node = generation.root_node.def_node_at(overload_memo.offset)
+              raise RubyModKit::Error unless def_node.is_a?(Node::DefNode)
+
+              generation[def_node.end_offset, 0] = "\n" if def_node.parent.children[-1].offset > def_node.end_offset
+            end
+            return true
+          end
 
           method_memo_groups = generation.memo_pad.methods_memo.each_value.group_by do |method_memo|
             [generation.root_node.def_parent_node_at(method_memo.offset), method_memo.name]
@@ -50,18 +62,38 @@ module RubyModKit
             end
 
             script << "def #{name}(*args)\n  case args\n"
-            overload_prefix = +"#{OVERLOAD_METHOD_MAP[name] || name}_"
-            method_memos.each_with_index do |method_memo, i|
-              overload_name = "#{overload_prefix}_overload#{i}"
+            method_memos.each do |method_memo|
               def_node = generation.root_node.def_node_at(method_memo.offset)
-              raise RubyModKit::Error if !def_node || !def_node.is_a?(Node::DefNode)
+              body_node = def_node&.body_node
+              raise RubyModKit::Error unless def_node
+
+              def_start_offset = generation.line_offset(def_node) || raise(RubyModKit::Error)
+              def_end_offset = generation.end_line_offset(def_node) || raise(RubyModKit::Error)
+              def_end_offset += generation[def_end_offset..][/.*\n*/]&.size || 0
+              generation[def_start_offset, def_end_offset - def_start_offset] = ""
+              generation.memo_pad.delete(method_memo)
+
+              params = method_memo.parameters.map { |param| "#{param.type} => #{param.name}" }
+              script << "  in [#{params.join(", ")}]\n"
+
+              body = nil
+              case body_node
+              when Node::StatementsNode
+                src_indent = generation.line_indent(body_node)
+                body = "#{src_indent}#{body_node.slice}\n".gsub(/^#{src_indent}/, "    ")
+              when Node::BeginNode
+                src_indent = generation.line_indent(body_node)
+                src_line_offset = generation.line_offset(body_node.children[0]) || raise(RubyModKit::Error)
+                body = body_node.slice[(src_line_offset - body_node.offset)..]
+                body = "#{src_indent}begin\n#{body}\n".gsub(/^#{src_indent}/, "    ")
+              when nil
+                body = ""
+              end
+              raise RubyModKit::Error unless body
 
-              name_loc = def_node.name_loc
-              generation[name_loc.start_offset, name_loc.length] = overload_name
-              script << "  in [#{method_memo.parameters.map(&:type).join(", ")}]\n"
-              script << "    #{overload_name}(*args)\n"
+              script << body
             end
-            script << "  end\nend\n\n"
+            script << "  end\nend\n"
 
             script.gsub!(/^(?=.)/, indent)
             generation[src_offset, 0] = script

data/lib/ruby_mod_kit/feature/overload.rb

@@ -7,6 +7,7 @@ module RubyModKit
     # namespace for overload feature
     class Overload < Feature
       # @rbs return: Array[Mission]
+      # @return [Array<Mission>]
       def create_missions
         [
           OverloadMission.new,

data/lib/ruby_mod_kit/feature/type/check/arguments/add_arguments_checker_mission.rb

@@ -10,6 +10,8 @@ module RubyModKit
         class AddArgumentsCheckerMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform(generation)
             # reload if line break is added
             line_break_added = false

data/lib/ruby_mod_kit/feature/type/check/arguments.rb

@@ -5,10 +5,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
             [
               AddArgumentsCheckerMission.new,

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

@@ -12,6 +12,7 @@ module RubyModKit
         REGEXP = /(\A\s*)(?:(#{VISIBILITIES.join("|")}) )?(?:(#{ATTR_PATTERNS.join("|")}) )?@(\w*)\s*:\s*(.*)\n(\n+)?/.freeze #: Regexp
 
         # @rbs return: Array[Symbol]
+        # @return [Array<Symbol>]
         def correctable_error_types
           %i[unexpected_token_ignore]
         end
@@ -19,6 +20,9 @@ module RubyModKit
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def correct(parse_error, generation)
           return if parse_error.location.slice != ":"
 

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

@@ -10,11 +10,13 @@ module RubyModKit
         # @rbs @last_parameter_offsets: Set[Integer]
 
         # @rbs return: Array[Symbol]
+        # @return [Array<Symbol>]
         def correctable_error_types
           %i[unexpected_token_ignore def_params_term_paren argument_formal_constant]
         end
 
         # @rbs return: void
+        # @return [void]
         def setup
           super
           @last_parameter_offsets = Set.new
@@ -23,6 +25,9 @@ module RubyModKit
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def correct(parse_error, generation)
           case parse_error.type
           when :unexpected_token_ignore
@@ -39,6 +44,9 @@ module RubyModKit
         # @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(parse_error, generation)
           def_node = generation.root_node.def_node_at(parse_error.location.start_offset) || return
           def_parent_node = def_node.parent
@@ -71,6 +79,9 @@ module RubyModKit
         # @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(parse_error, generation)
           column = parse_error.location.start_column - 1
           return if column < 0
@@ -93,6 +104,9 @@ module RubyModKit
         # @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(parse_error, generation)
           line = generation.line(parse_error)
           line = line[parse_error.location.start_column..] || return

data/lib/ruby_mod_kit/feature/type/rbs_inline/add_magic_comment_mission.rb

@@ -11,6 +11,7 @@ module RubyModKit
           # @rbs @reloaded: bool
 
           # @rbs return: void
+          # @return [void]
           def initialize
             super
             @reloaded = false
@@ -18,6 +19,8 @@ module RubyModKit
 
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform(generation)
             return true unless generation.memo_pad.flags[:rbs_annotated]
 

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

@@ -10,6 +10,8 @@ module RubyModKit
         class TypeAttrMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform(generation)
             generation.memo_pad.def_parents_memo.each_value do |def_parent_memo|
               ivars_memo = def_parent_memo.ivars_memo.dup

data/lib/ruby_mod_kit/feature/type/rbs_inline/type_instance_variable_mission.rb

@@ -10,6 +10,8 @@ module RubyModKit
         class TypeInstanceVariableMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform(generation)
             generation.memo_pad.def_parents_memo.each_value do |def_parent_memo|
               def_parent_memo.ivars_memo.each do |name, ivar_memo|

data/lib/ruby_mod_kit/feature/type/rbs_inline/type_overload_mission.rb

@@ -10,6 +10,8 @@ module RubyModKit
         class TypeOverloadMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform(generation)
             generation.memo_pad.overloads_memo.each_value do |overload_memo|
               overload_memo.correct_offset(generation.root_node)

data/lib/ruby_mod_kit/feature/type/rbs_inline/type_parameter_mission.rb

@@ -10,6 +10,8 @@ module RubyModKit
         class TypeParameterMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform(generation)
             generation.memo_pad.each_parameter_memo do |parameter_memo|
               next if parameter_memo.untyped?

data/lib/ruby_mod_kit/feature/type/rbs_inline/type_return_mission.rb

@@ -10,6 +10,8 @@ module RubyModKit
         class TypeReturnMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform(generation)
             generation.memo_pad.methods_memo.each do |offset, method_memo|
               def_node = generation.root_node.def_node_at(offset)

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

@@ -8,6 +8,7 @@ module RubyModKit
       # namespace for type with rbs-line feature
       class RbsInline < Feature
         # @rbs return: Array[Mission]
+        # @return [Array<Mission>]
         def create_missions
           [
             TypeInstanceVariableMission.new,

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

@@ -8,6 +8,7 @@ module RubyModKit
       # the class to correct `def foo: Some ...` -> `def foo ...`
       class ReturnValueColonCorrector < Corrector
         # @rbs return: Array[Symbol]
+        # @return [Array<Symbol>]
         def correctable_error_types
           %i[unexpected_token_ignore]
         end
@@ -15,6 +16,9 @@ module RubyModKit
         # @rbs parse_error: Prism::ParseError
         # @rbs generation: Generation
         # @rbs return: void
+        # @param parse_error [Prism::ParseError]
+        # @param generation [Generation]
+        # @return [void]
         def correct(parse_error, generation)
           return if parse_error.location.slice != ":"
 

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

@@ -10,6 +10,7 @@ module RubyModKit
         # @rbs @modified: bool
 
         # @rbs return: void
+        # @return [void]
         def initialize
           super
           @modified = false
@@ -17,6 +18,8 @@ module RubyModKit
 
         # @rbs generation: Generation
         # @rbs return: bool
+        # @param generation [Generation]
+        # @return [Boolean]
         def perform(generation)
           return true if @modified
 

data/lib/ruby_mod_kit/feature/type/yard/type_parameter_mission.rb

@@ -10,6 +10,8 @@ module RubyModKit
         class TypeParameterMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform(generation)
             generation.memo_pad.each_parameter_memo do |parameter_memo|
               next if parameter_memo.untyped?

data/lib/ruby_mod_kit/feature/type/yard/type_return_mission.rb

@@ -10,6 +10,8 @@ module RubyModKit
         class TypeReturnMission < Mission
           # @rbs generation: Generation
           # @rbs return: bool
+          # @param generation [Generation]
+          # @return [Boolean]
           def perform(generation)
             generation.memo_pad.methods_memo.each do |offset, method_memo|
               def_node = generation.root_node.def_node_at(offset)

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

@@ -8,6 +8,7 @@ module RubyModKit
       # namespace for type with rbs-line feature
       class Yard < Feature
         # @rbs return: Array[Mission]
+        # @return [Array<Mission>]
         def create_missions
           [
             TypeParameterMission.new,
@@ -18,6 +19,8 @@ module RubyModKit
         class << self
           # @rbs type: String
           # @rbs return: String
+          # @param type [String]
+          # @return [String]
           def rbs2yard(type)
             type.gsub(/\s*\|\s*/, ", ").tr("[]", "<>").gsub(/(?<=^|\W)bool(?=$|\W)/, "Boolean")
           end

data/lib/ruby_mod_kit/feature/type.rb

@@ -7,6 +7,7 @@ module RubyModKit
     # namespace for type feature
     class Type < Feature
       # @rbs return: Array[Corrector]
+      # @return [Array<Corrector>]
       def create_correctors
         [
           InstanceVariableColonCorrector.new,
@@ -16,6 +17,7 @@ module RubyModKit
       end
 
       # @rbs return: Array[Mission]
+      # @return [Array<Mission>]
       def create_missions
         [
           TypeAttrMission.new,

data/lib/ruby_mod_kit/feature.rb

@@ -6,11 +6,13 @@ module RubyModKit
   # the base class of feature
   class Feature
     # @rbs return: Array[Corrector]
+    # @return [Array<Corrector>]
     def create_correctors
       []
     end
 
     # @rbs return: Array[Mission]
+    # @return [Array<Mission>]
     def create_missions
       []
     end