ruby_mod_kit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3a08a3d1865aa1abd27922326dc12e4cfc6c9a621f0c73882a64c12a80cc3d4
+  data.tar.gz: d30dd20e654a68c233f33925f6f27938a3920675df07dea1377f31ba8fa42ab6
+SHA512:
+  metadata.gz: cc67818cecc1c39a1aaf1f925a8ebd59dab9220a77e0d1e2dd19be99ea7b8b72e582e4a8d794966ab411125b229084f339f85cd427eebf33e29f88ee576eb111
+  data.tar.gz: ed11c866fba06fe283e1957ba41c2138194cdc3d5049dfe9cefdee662519d3e222ef5ac8b9b5f491e579fef4db049c11b3b46074f5f7fe8585c7cf2c84ab94d5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 wanabe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# RubyModKit
+
+RubyModKit is a transpiler tool from Ruby-like syntax script to Ruby script.
+The name is shorthand for ruby-modify-kit.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ruby_mod_kit
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install ruby_mod_kit
+
+## Usage
+
+### as command line tool
+
+#### `transpile`
+
+You can get transpiled ruby script from .rbm file by `ruby_mod_kit transpile` command.
+
+```
+ruby_mod_kit transpile path/to/script.rbm
+```
+
+#### `exec`
+
+You can run transpiled ruby script by `ruby_mod_kit exec` command.
+
+```
+ruby_mod_kit transpile path/to/script.rbm
+```
+
+The command also creates/updates ruby script before running.
+
+## Feature
+
+1. Type definition
+    - The deifinitions will be changed to RBS-inline annotation comments.
+    - Instance variables
+        - `@foo: Foo` -> `# @rbs @foo: Foo`
+    - Attributes (`attr_reader`, `attr_writer`, `attr_accessor`)
+        - `attr_reader @foo: Foo` -> `# @rbs @foo: Foo` and `attr_reader :foo #: Foo`
+        - `getter`, `setter`, `property` are also available
+    - Method parameters
+        - `def foo(Bar => bar) ... end` -> `# @rbs foo: Foo` and `def foo(bar) ... end`
+    - Method return values
+        - `def foo(bar): Foo ... end` -> `# @rbs return: Foo` and `def foo(bar) ... end`
+2. Instance variable parameter
+    - `def foo(@bar) ... end` -> `def foo(bar) @bar = bar ... end`
+3. Overloading
+    - ```
+      def foo(Bar => arg): void
+        ...
+      end
+
+      def foo(Buz => arg): Buz
+        ...
+      end
+      ```
+      ->
+      ```
+      # @rbs (Bar) -> void
+      #    | (Buz) -> Buz
+      def foo(*args)
+        case args
+        in [Bar]
+          foo__overload0(*args)
+        in [Buz]
+          foo__overload1(*args)
+        end
+      end
+
+      # @rbs arg: Bar
+      # @rbs return: void
+      def foo__overload0(Bar => arg)
+        ...
+      end
+
+      # @rbs arg: Buz
+      # @rbs return: Buz
+      def foo__overload1(Buz => arg)
+        ...
+      end
+      ```
+
+## Development
+
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wanabe/ruby_mod_kit.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/examples/user.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+# Example class
+class User
+  # @rbs @email: String
+  # @rbs @tel: nil | String
+  # @rbs @name: nil | String
+  # @rbs @nick: nil | String
+
+  attr_reader :email #: String
+  attr_reader :name #: nil | String
+  attr_reader :nick #: nil | String
+
+  # @rbs email: String
+  # @rbs tel: nil | String
+  # @rbs name: nil | String
+  # @rbs nick: nil | String
+  # @rbs return: void
+  def initialize(email, tel = nil, name: nil, nick: nil)
+    @email = email
+    @tel = tel
+    @name = name
+    @nick = nick
+  end
+end
+
+# Example class
+class Pos
+  # @rbs @x: Integer
+  # @rbs @y: Integer
+  # @rbs @z: Integer
+
+  attr_reader :x #: Integer
+  attr_reader :y #: Integer
+  attr_reader :z #: Integer
+
+  # @rbs x: Integer
+  # @rbs y: Integer
+  # @rbs z: Integer
+  # @rbs return: void
+  def initialize(x, y, z = 0)
+    @x = x
+    @y = y
+    @z = z
+  end
+
+  # @rbs (Pos) -> Integer
+  #    | (Integer) -> Pos
+  def *(*args)
+    case args
+    in [Pos]
+      _mul__overload0(*args)
+    in [Integer]
+      _mul__overload1(*args)
+    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})>"
+  end
+end
+
+puts(
+  User.new("a@exmple.com").email,
+  Pos.new(2, 3).y,
+  Pos.new(1, 2) * Pos.new(3, 4),
+  Pos.new(1, 2) * 3,
+)

data/examples/user.rbm

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+# Example class
+class User
+  attr_reader @email: String
+  @tel: (nil | String)
+  attr_reader @name: (nil | String)
+  attr_reader @nick: (nil | String)
+
+  def initialize(@email, @tel = nil, @name: nil, @nick: nil): void
+  end
+end
+
+# Example class
+class Pos
+  @x: Integer
+  @y: Integer
+  @z: Integer
+
+  attr_reader :x
+  attr_reader :y
+  attr_reader :z
+
+  def initialize(@x, @y, @z = 0): void
+  end
+
+  def *(Pos => other): Integer
+    (@x * other.x) + (@y * other.y) + (@z * other.z)
+  end
+
+  def *(Integer => n): Pos
+    Pos.new(@x * n, @y * n, @z * n)
+  end
+
+  def to_s: String
+    "#<Pos: (#{@x}, #{@y}, #{@z})>"
+  end
+end
+
+puts(
+  User.new("a@exmple.com").email,
+  Pos.new(2, 3).y,
+  Pos.new(1, 2) * Pos.new(3, 4),
+  Pos.new(1, 2) * 3,
+)

data/exe/ruby_mod_kit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "ruby_mod_kit/cli"
+RubyModKit::CLI.start

data/lib/ruby_mod_kit/cli.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+require "ruby_mod_kit"
+require "thor"
+
+module RubyModKit
+  # This class provides CLI commands of ruby_mod_kit.
+  class CLI < Thor
+    desc "exec", "execute rbm file"
+    # @rbs *args: String
+    # @rbs return: void
+    def exec(*args)
+      RubyModKit.execute_file(*args)
+    end
+
+    desc "transpile", "transpile rbm files"
+    # @rbs *args: String
+    # @rbs return: void
+    def transpile(*args)
+      args.each do |path|
+        RubyModKit.transpile_file(path)
+      end
+    end
+  end
+end

data/lib/ruby_mod_kit/generation.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module RubyModKit
+  # The class of transpiler generation.
+  class Generation
+    # @rbs @parse_result: Prism::ParseResult
+    # @rbs @script: String
+    # @rbs @missions: Array[Mission]
+    # @rbs @memo: Memo
+    # @rbs @root_node: Node::ProgramNode
+    # @rbs @offset_diff: OffsetDiff
+    # @rbs @generation_num: Integer
+    # @rbs @filename: String | nil
+
+    attr_reader :parse_result #: Prism::ParseResult
+    attr_reader :script #: String
+
+    # @rbs script: String
+    # @rbs missions: Array[Mission]
+    # @rbs memo: Memo
+    # @rbs generation_num: Integer
+    # @rbs filename: String | nil
+    # @rbs return: void
+    def initialize(script, missions: [], memo: Memo.new, generation_num: 0, filename: nil)
+      @script = script
+      @missions = missions
+      @memo = memo
+      @generation_num = generation_num
+      @filename = filename
+      @offset_diff = OffsetDiff.new
+      @parse_result = Prism.parse(@script)
+      @root_node = Node::ProgramNode.new(@parse_result.value)
+      init_missions
+    end
+
+    # @rbs return: void
+    def init_missions
+      return unless first_generation?
+
+      add_mission(Mission::FixParseError.new)
+      add_mission(Mission::TypeAttr.new)
+      add_mission(Mission::Overload.new)
+      add_mission(Mission::TypeParameter.new)
+      add_mission(Mission::TypeReturn.new)
+    end
+
+    # @rbs return: bool
+    def first_generation?
+      @generation_num == 0
+    end
+
+    # @rbs return: Generation
+    def succ
+      @missions.each do |mission|
+        mission.succ(@offset_diff)
+      end
+      @memo.succ(@offset_diff)
+      Generation.new(
+        @script,
+        missions: @missions,
+        memo: @memo,
+        generation_num: @generation_num + 1,
+        filename: @filename,
+      )
+    end
+
+    # @rbs return: String
+    def name
+      "#{@filename || "(eval)"}[gen #{@generation_num}]"
+    end
+
+    # @rbs return: void
+    def resolve
+      perform_missions
+    end
+
+    # @rbs return: bool
+    def completed?
+      @parse_result.errors.empty? && @missions.empty?
+    end
+
+    # @rbs src_offset: Integer
+    # @rbs length: Integer
+    # @rbs str: String
+    # @rbs return: String
+    def []=(src_offset, length, str)
+      diff = str.length - length
+      @script[@offset_diff[src_offset], length] = str
+      @offset_diff.insert(src_offset, diff)
+    end
+
+    # @rbs src_range: Range[Integer]
+    # @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 (Integer) -> String
+    #    | (Node) -> String
+    #    | (Prism::ParseError) -> String
+    def line(*args)
+      case args
+      in [Integer]
+        line__overload0(*args)
+      in [Node]
+        line__overload1(*args)
+      in [Prism::ParseError]
+        line__overload2(*args)
+      end
+    end
+
+    # @rbs line_num: Integer
+    # @rbs return: String
+    def line__overload0(line_num)
+      offset = @offset_diff[@parse_result.source.offsets[line_num]]
+      (@script.match(/.*\n?/, offset) && Regexp.last_match(0)) || raise(RubyModKit::Error)
+    end
+
+    # @rbs node: Node
+    # @rbs return: String
+    def line__overload1(node)
+      line(node.prism_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)
+    end
+
+    # @rbs (Integer) -> (Integer | nil)
+    #    | (Prism::ParseError) -> (Integer | nil)
+    def src_offset(*args)
+      case args
+      in [Integer]
+        src_offset__overload0(*args)
+      in [Prism::ParseError]
+        src_offset__overload1(*args)
+      end
+    end
+
+    # @rbs line_num: Integer
+    # @rbs return: Integer | nil
+    def src_offset__overload0(line_num)
+      parse_result.source.offsets[line_num]
+    end
+
+    # @rbs parse_error: Prism::ParseError
+    # @rbs return: Integer | nil
+    def src_offset__overload1(parse_error)
+      src_offset(parse_error.location.start_line - 1)
+    end
+
+    # @rbs return: void
+    def perform_missions
+      @missions.delete_if do |mission|
+        mission.perform(self, @root_node, @parse_result, @memo) || break
+      end
+    end
+
+    # @rbs mission: Mission
+    # @rbs return: void
+    def add_mission(mission)
+      @missions << mission
+    end
+  end
+end

data/lib/ruby_mod_kit/memo/class.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module RubyModKit
+  class Memo
+    # The memo for parameter type
+    class Class < OffsetMemo
+      # @rbs @ivars_memo: Hash[Symbol, Memo::Ivar]
+
+      attr_reader :ivars_memo #: Hash[Symbol, Memo::Ivar]
+
+      # @rbs class_node: Node::ClassNode
+      # @rbs return: void
+      def initialize(class_node)
+        @ivars_memo = {}
+        super(class_node.offset)
+      end
+
+      # @rbs name: Symbol
+      # @rbs return: Memo::Ivar
+      def ivar_memo(name)
+        @ivars_memo[name] ||= Memo::Ivar.new(name)
+      end
+    end
+  end
+end

data/lib/ruby_mod_kit/memo/ivar.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module RubyModKit
+  class Memo
+    # The memo for parameter type
+    class Ivar
+      # @rbs @type: nil | String
+      # @rbs @attr_kind: nil | Symbol
+      # @rbs @name: Symbol
+
+      attr_reader :type #: nil | String
+      attr_reader :attr_kind #: nil | Symbol
+
+      # @rbs name: Symbol
+      # @rbs return: void
+      def initialize(name)
+        @name = name
+      end
+
+      # @rbs type: String
+      # @rbs return: void
+      def type=(type)
+        @type = Memo.unify_type(type)
+      end
+
+      # @rbs kind: Symbol | String
+      # @rbs return: void
+      def attr_kind=(kind)
+        case kind.to_sym
+        when :attr_reader, :reader, :getter
+          @attr_kind = :attr_reader
+        when :attr_writer, :writer, :setter
+          @attr_kind = :attr_writer
+        when :attr_accessor, :accessor, :property
+          @attr_kind = :attr_accessor
+        end
+      end
+    end
+  end
+end

data/lib/ruby_mod_kit/memo/method.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module RubyModKit
+  class Memo
+    # The memo for parameter type
+    class Method < OffsetMemo
+      # @rbs @name: Symbol
+      # @rbs @parameters: Set[Memo::Parameter]
+      # @rbs @type: String
+
+      attr_reader :name #: Symbol
+      attr_reader :parameters #: Set[Memo::Parameter]
+      attr_reader :type #: String
+
+      UNTYPED = "untyped"
+
+      # @rbs node: Node::DefNode
+      # @rbs return: void
+      def initialize(node)
+        @type = UNTYPED
+        @parameters = Set.new
+        @name = node.name
+        raise RubyModKit::Error unless node.parent
+
+        super(node.offset)
+      end
+
+      # @rbs parameter_memo: Memo::Parameter
+      # @rbs return: Memo::Parameter
+      def add_parameter(parameter_memo)
+        @parameters << parameter_memo
+        parameter_memo
+      end
+
+      # @rbs return: bool
+      def untyped?
+        @type == UNTYPED
+      end
+
+      # @rbs type: String
+      # @rbs return: void
+      def type=(type)
+        @type = Memo.unify_type(type)
+      end
+    end
+  end
+end

data/lib/ruby_mod_kit/memo/offset_memo.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module RubyModKit
+  class Memo
+    # The base class for located memo
+    class OffsetMemo
+      # @rbs @offset: Integer
+
+      attr_reader :offset #: Integer
+
+      # @rbs offset: Integer
+      # @rbs return: void
+      def initialize(offset)
+        @offset = offset
+      end
+
+      # @rbs offset_diff: OffsetDiff
+      # @rbs return: void
+      def succ(offset_diff)
+        @offset = offset_diff[@offset]
+      end
+    end
+  end
+end

data/lib/ruby_mod_kit/memo/parameter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module RubyModKit
+  class Memo
+    # The memo for parameter type
+    class Parameter < OffsetMemo
+      # @rbs @type: String
+      # @rbs @ivar_parameter: bool
+      # @rbs @qualifier: String
+
+      attr_reader :type #: String
+      attr_accessor :ivar_parameter #: bool
+      attr_accessor :qualifier #: String
+
+      UNTYPED = "untyped"
+
+      # @rbs offset: Integer
+      # @rbs return: void
+      def initialize(offset)
+        @type = UNTYPED
+        @ivar_parameter = false
+        super
+      end
+
+      # @rbs return: bool
+      def untyped?
+        @type == UNTYPED
+      end
+
+      # @rbs type: String
+      # @rbs return: void
+      def type=(type)
+        @type = Memo.unify_type(type)
+      end
+    end
+  end
+end