yard_to_rbs_inline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75ff275975592a47d67427039bdbb4eb3a617b4dd5b0b08f64529a51a71aac9a
+  data.tar.gz: c15d5a93607172ed4a3753b3bcef47ffa9429c657a470423bdbc9d135398b6ab
+SHA512:
+  metadata.gz: 1809ffd8bfa11fef92442a8450be27c12c11fbe178d62c896308f3bb5bf7024626cbd95e73a760053462625b025117e14a03547d97d5491328a6ece252fdc8b5
+  data.tar.gz: 9974e192dd12b4d49f25ebf3284b32f19aa9b86be7c34a9afeb1d30a3c5a4be7e694922a256021daa6ec07f37329f8dd998c18e04fd23ed8241151c18ea2689f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tomo.asleep@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tomoya Chiba
+
+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,15 @@
+# yard → rbs-inline
+
+Rewrite YARD type annotations in Your codes to rbs-inline.
+
+## Usage
+
+```console
+bundle
+
+# Print rewrited code to stdout.
+./exe/yard-rbs-inline --dry-run your-file.rb
+
+# Overwrite files.
+./exe/yard-rbs-inline your-file.rb
+```

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+desc "Build parser files generated by racc"
+task racc: [
+  "lib/yard_to_rbs_inline/yard_type/parser.rb"
+]
+
+rule ".rb" => ".y" do |t|
+  sh "bundle exec racc #{t.source} -o #{t.name}"
+end

data/examples/example.rb

@@ -0,0 +1,23 @@
+class Code
+  # @return [String]
+  attr_reader :source
+
+  # @param source [String]
+  def initialize(source)
+    @source = source
+  end
+
+  # @param new_source [String]
+  # @return [Code]
+  def rewrite(new_source)
+    @source = new_source
+
+    self
+  end
+
+  # @param recover [Boolean].
+  # @return [Array<Token>]
+  def tokenize(recover: false)
+    parser.tokenize(source, recover: recover)
+  end
+end

data/exe/yard-to-rbs-inline

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+if Dir.exist?(File.join(__dir__, "..", ".git"))
+  $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+end
+
+require 'yard_to_rbs_inline'
+YardToRbsInline::Cli.start(ARGV)

data/lib/yard_to_rbs_inline/cli.rb

@@ -0,0 +1,19 @@
+# rbs_inline: enabled
+
+require 'optparse'
+
+module YardToRbsInline
+  class Cli
+    def self.start(argv)
+      opt = OptionParser.new
+      dry_run = false
+
+      opt.on('-n', '--dry-run', 'Dry run') { dry_run = true }
+      opt.parse!(argv)
+
+      argv.each do |file|
+        Converter.convert(file, dry_run: dry_run)
+      end
+    end
+  end
+end

data/lib/yard_to_rbs_inline/converter/code_visitor.rb

@@ -0,0 +1,270 @@
+# rbs_inline: enabled
+
+require_relative 'subscriptable'
+
+module YardToRbsInline
+  module Converter
+    class CodeVisitor < Prism::Visitor
+      include Subscriptable
+
+      # @!rbs
+      #   type mod = PrependLine | AppendLineContent
+
+      attr_reader :source #:: Prism::Source
+
+      attr_reader :comments #:: Array[Prism::InlineComment]
+
+      attr_reader :text_with_mod #:: TextWithMod
+
+      #:: (source: Prism::Source, comments: Array[Prism::InlineComment]) -> untyped
+      def initialize(source:, comments:)
+        @source = source
+        @comments = comments
+        @text_with_mod = TextWithMod.new(source.source)
+      end
+
+      #:: (Prism::CallNode) -> void
+      def visit_call_node(node)
+        parse_annotation = lambda do
+          annotation_comments = annotations_for(node)
+          annotation_strs = annotation_comments.map(&method(:source_for_comment))
+          annotation_strs.map(&:chomp).join("\n")
+        end
+
+        case node.name.to_sym
+        when :attr_reader
+          annotation = parse_annotation.call
+
+          unless annotation.match?(/^\s*#(::|\s*@rbs)/)
+            docstring = YARD::DocstringParser.new.parse(annotation.gsub(/^\s*#\s*/, '')).to_docstring
+
+            sig = capture_error_to_write_comment(node) { build_return_sig(docstring) }
+            text_with_mod.mods << AppendLineContent.from_node_and_content(node, "#:: #{sig}")
+          end
+        end
+
+        super
+      end
+
+      #:: (Prism::DefNode) -> void
+      def visit_def_node(node)
+        annotation_comments = annotations_for(node)
+        annotation_strs = annotation_comments.map(&method(:source_for_comment))
+        annotation = annotation_strs.map(&:chomp).join("\n")
+
+        unless annotation.match?(/^\s*#(::|\s*@rbs)/)
+          docstring = YARD::DocstringParser.new.parse(annotation.gsub(/^\s*#\s*/, '')).to_docstring
+
+          sig = capture_error_to_write_comment(node) { build_signature(node.parameters, docstring) }
+
+          text_with_mod.mods << PrependLine.from_node_and_content(node, "#:: #{sig}")
+
+          # STDERR.puts "#{node.name_loc.inspect} #{node.name}: #{sig}"
+        end
+
+        super
+      end
+
+      private
+
+      #:: (YARD::Docstring) -> String
+      def build_return_sig(docstring)
+        return_tag = docstring.tag("return") #:: YARD::Tags::Tag | nil
+
+        if return_tag&.types
+          convert_types(return_tag.types)
+        else
+          "untyped"
+        end
+      end
+
+      #:: (Prism::ParametersNode | nil, YARD::Docstring) -> String
+      def build_signature(params, docstring)
+        params_sig = build_params_signature(params, docstring)
+        return_sig = build_return_sig(docstring)
+
+        "(#{params_sig}) -> #{return_sig}"
+      end
+
+      #:: (Prism::ParametersNode | nil, YARD::Docstring) -> String
+      def build_params_signature(params, docstring)
+        return "" unless params
+
+        param_tags = docstring.tags("param") #:: Array[YARD::Tags::Tag]
+
+        find_tag = proc do |name|
+          if name
+            param_tags.find { |tag| tag.name == name.to_s }
+          else
+            nil
+          end
+        end
+
+        param_sigs = []
+        params.requireds.each do |param|
+          tag = find_tag.call(param.name)
+
+          if tag&.types
+            param_sigs << "#{convert_types(tag.types)} #{param.name}"
+          else
+            param_sigs << "untyped #{param.name}"
+          end
+        end
+
+        params.optionals.each do |param|
+          tag = find_tag.call(param.name)
+
+          if tag&.types
+            param_sigs << "?#{convert_types(tag.types)} #{param.name}"
+          else
+            param_sigs << "?untyped #{param.name}"
+          end
+        end
+
+        if (param = params.rest)
+          tag = find_tag.call(param.name)
+
+          if tag&.types
+            param_sigs << "*#{convert_types(tag.types)} #{param.name}"
+          else
+            param_sigs << "*untyped #{param.name}"
+          end
+        end
+
+        params.posts.each do |param|
+          tag = find_tag.call(param.name)
+
+          if tag&.types
+            param_sigs << "#{convert_types(tag.types)} #{param.name}"
+          else
+            param_sigs << "untyped #{param.name}"
+          end
+        end
+
+        params.keywords.each do |param|
+          tag = find_tag.call(param.name)
+
+          prefix =
+            case param.type
+            when :required_keyword_parameter_node
+              ""
+            when :optional_keyword_parameter_node
+              "?"
+            end
+
+          if tag && tag.types
+            param_sigs << "#{prefix}#{param.name}: #{convert_types(tag.types)}"
+          else
+            param_sigs << "#{prefix}#{param.name}: untyped"
+          end
+        end
+
+        if (param = params.keyword_rest)
+          tag = find_tag.call(param.name)
+
+          if tag&.types
+            param_sigs << "**#{convert_types(tag.types)} #{param.name}"
+          else
+            param_sigs << "**untyped #{param.name}"
+          end
+        end
+
+        # Remove trailing spaces for unnamed params
+        param_sigs.map(&:strip).join(", ")
+      end
+
+      #:: (Array[String], node: Prism::Node) -> String
+      def convert_types(yard_type_literals)
+        new_types = yard_type_literals.map do |literal|
+          yard_type = YardToRbsInline::YardType::Parser.new.parse(literal)
+          convert_yard_type(yard_type)
+        rescue Racc::ParseError, Yoda::Parsing::YardType::Scanner::ScanError => e
+          # STDERR.puts "Cannot parse #{literal}: #{e}"
+          emit_error_message("Cannot parse #{literal}: #{e}")
+
+          'untyped'
+        end.uniq
+
+        new_types.empty? ? 'untyped' : new_types.join(' | ')
+      end
+
+      #:: (YardToRbsInline::YardType::Ast::node, node: Prism::Node) -> String
+      def convert_yard_type(yard_type)
+        case yard_type
+        in YardType::Ast::Type(name:)
+          case name
+          when "Object"
+            "untyped"
+          when "Boolean", "TrueClass", "FalseClass", "boolean", "true", "false"
+            "bool"
+          else
+            name
+          end
+        in YardType::Ast::DuckType(name:)
+          case name
+          when "each"
+            "Enumerable"
+          else
+            emit_error_message("Unknown duck type: ##{name}")
+            "untyped"
+          end
+        in YardType::Ast::LiteralType(content:)
+          content
+        in YardType::Ast::GenericType(container_type:, types:)
+          container_sig = container_type ? convert_yard_type(container_type) : "Array"
+          "#{container_sig}[#{types.map(&method(:convert_yard_type)).join(' | ')}]"
+        in YardType::Ast::TupleType(container_type:, types:)
+          container_sig = container_type ? convert_yard_type(container_type) : "Array"
+          "#{container_sig} & [#{types.map(&method(:convert_yard_type)).join(', ')}]"
+        in YardType::Ast::HashType(container_type:, type_pair: [key_type, value_type])
+          container_sig = container_type ? convert_yard_type(container_type) : "Hash"
+          "#{container_sig}[#{convert_yard_type(key_type)}, #{convert_yard_type(value_type)}]"
+        in YardType::Ast::UnionType(types:)
+          types.map(&method(:convert_yard_type)).join(' | ')
+        end
+      end
+
+      #:: (Prism::Node) -> Integer
+      def start_line_of_node(node)
+        gather_comment_targets = proc do |l|
+          if l.respond_to?(:comment_targets)
+            l.comment_targets.flat_map { |t| gather_comment_targets.call(t) }
+          else
+            [l]
+          end
+        end
+
+        gather_comment_targets.call(node).map(&:start_line).min || 0
+      end
+
+      #:: (Prism::Node) -> Array[Prism::InlineComment]
+      def annotations_for(node)
+        start_line = start_line_of_node(node)
+
+        matched_comments = []
+        matched_comments += comments_by_line[start_line] if comments_by_line[start_line]
+
+        (start_line - 1).downto(1) do |line|
+          current_comments = comments_by_line[line]
+          if current_comments
+            matched_comments += current_comments
+          else
+            break
+          end
+        end
+
+        matched_comments
+      end
+
+      #:: (Prism::InlineComment) -> String
+      def source_for_comment(comment)
+        source.slice(comment.location.start_offset, comment.location.length)
+      end
+
+      #:: () -> Hash[Integer, Array[Prism::InlineComment]]
+      def comments_by_line
+        @comments_by_line ||= comments.group_by { |comment| comment.location.start_line }
+      end
+    end
+  end
+end

data/lib/yard_to_rbs_inline/converter/subscriptable.rb

@@ -0,0 +1,34 @@
+# rbs_inline: enabled
+
+module YardToRbsInline
+  module Converter
+    module Subscriptable
+      # @rbs!
+      #   type subscriber = ^(String) -> void
+
+      #:: (String) -> void
+      def emit_error_message(error_message)
+        (@subscribers || []).each { |subscriber| subscriber.call(error_message) }
+      end
+
+      #:: [X] (subscriber) { () -> X } -> X
+      def capture_error_message(subscriber)
+        @subscribers ||= []
+        @subscribers.push(subscriber)
+        yield
+      ensure
+        @subscribers.pop
+      end
+
+      #:: (Prism::Node) -> subscriber
+      def subscriber_to_prepend_error(node)
+        lambda { |message| text_with_mod.mods << PrependLine.from_node_and_content(node, "# YARD to RBS Error: #{message}") }
+      end
+
+      #:: [X] (Prism::Node) { () -> X } -> X
+      def capture_error_to_write_comment(node)
+        capture_error_message(subscriber_to_prepend_error(node)) { yield }
+      end
+    end
+  end
+end

data/lib/yard_to_rbs_inline/converter/text_with_mod.rb

@@ -0,0 +1,56 @@
+# rbs_inline: enabled
+
+module YardToRbsInline
+  module Converter
+    PrependLine = Data.define(:line_num, :content) do
+      #:: (Prism::Node, String) -> PrependLine
+      def self.from_node_and_content(node, comment_content)
+        start_line = node.location.start_line
+        start_column = node.location.start_column
+
+        line = ' ' * start_column + comment_content
+
+        PrependLine.new(line_num: start_line, content: line)
+      end
+    end
+
+    AppendLineContent = Data.define(:line_num, :content) do
+      #:: (Prism::Node, String) -> PrependLine
+      def self.from_node_and_content(node, comment_content)
+        start_line = node.location.start_line
+
+        AppendLineContent.new(line_num: start_line, content: ' ' + comment_content)
+      end
+    end
+
+    class TextWithMod
+      attr_reader :original_text #:: Prism::Source
+
+      attr_reader :mods #:: Array[mod]
+
+      #:: (String) -> untyped
+      def initialize(original_text)
+        @original_text = original_text
+        @mods = []
+      end
+
+      #:: () -> String
+      def modified_text
+        prepended_line_nums = []
+        mods.reduce(original_text.lines(chomp: true)) do |source_lines, mod|
+          real_line_num = mod.line_num + prepended_line_nums.map { |i| i <= mod.line_num }.length # 1-index
+
+          case mod
+          in PrependLine(content:)
+            prepended_line_nums << mod.line_num
+            source_lines.insert(real_line_num - 1, content)
+          in AppendLineContent(content:)
+            source_lines[real_line_num - 1] += content
+          end
+
+          source_lines
+        end.join("\n") + "\n"
+      end
+    end
+  end
+end

data/lib/yard_to_rbs_inline/converter.rb

@@ -0,0 +1,28 @@
+require 'prism'
+require 'yard'
+
+module YardToRbsInline
+  module Converter
+    def self.convert(file, dry_run: false)
+      result = Prism.parse_file(file)
+
+      visitor = CodeVisitor.new(source: result.source, comments: result.comments)
+      unless result.source.source.match(/^# rbs_inline:/)
+        visitor.text_with_mod.mods << PrependLine.new(line_num: 1, content: "# rbs_inline: enabled")
+        visitor.text_with_mod.mods << PrependLine.new(line_num: 1, content: "")
+      end
+
+      result.value.accept(visitor)
+
+      if dry_run
+        puts visitor.text_with_mod.modified_text
+      else
+        File.write(file, visitor.text_with_mod.modified_text)
+      end
+    end
+  end
+end
+
+require_relative "converter/code_visitor"
+require_relative "converter/subscriptable"
+require_relative "converter/text_with_mod"

data/lib/yard_to_rbs_inline/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module YardToRbsInline
+  VERSION = "0.1.0"
+end

data/lib/yard_to_rbs_inline/yard_type/ast.rb

@@ -0,0 +1,27 @@
+# rbs_inline: enabled
+
+module YardToRbsInline
+  module YardType
+    module Ast
+      # @rbs!
+      #   type node = Type | LiteralType | DuckType | GenericType | TupleType | HashType | UnionType
+
+      Type = Struct.new(:name, keyword_init: true)
+      LiteralType = Struct.new(:content, keyword_init: true)
+      DuckType = Struct.new(:name, keyword_init: true)
+      GenericType = Struct.new(:container_type, :types, keyword_init: true)
+      TupleType = Struct.new(:container_type, :types, keyword_init: true)
+      HashType = Struct.new(:container_type, :type_pair, keyword_init: true)
+      UnionType = Struct.new(:types, keyword_init: true) do
+        #:: (untyped types) -> untyped
+        def self.build(types)
+          if types.length == 1
+            types.first
+          else
+            UnionType.new(types: types)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard_to_rbs_inline/yard_type/parser.rb

@@ -0,0 +1,307 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.7.1
+# from Racc grammar file "".
+#
+
+require 'racc/parser.rb'
+
+# Note: Prepend magic comment by script because default comments are prepended to header.
+
+module YardToRbsInline
+  module YardType
+    class Parser < Racc::Parser
+
+module_eval(<<'...end parser.y/module_eval...', 'parser.y', 34)
+
+#:: (String) -> Ast::node
+def parse(string)
+  @tokens = Scanner.new(string).to_racc_tokens
+
+  do_parse()
+end
+
+#:: () -> untyped
+def next_token
+  @tokens.shift
+end
+
+...end parser.y/module_eval...
+##### State transition tables begin ###
+
+racc_action_table = [
+     8,     9,    16,    10,    17,    11,    17,    12,    13,    14,
+    15,     8,     9,    32,    10,    21,    11,    17,    12,    13,
+    14,    15,     8,     9,    36,    10,    26,    11,    33,    12,
+    13,    14,    15,     8,     9,    34,    10,    37,    11,   nil,
+    12,    13,    14,    15,     8,     9,   nil,    10,   nil,    11,
+   nil,    12,    13,    14,    15,     8,     9,   nil,    10,   nil,
+    11,   nil,    12,    13,    14,    15,     8,     9,   nil,    10,
+   nil,    11,   nil,    12,    13,    14,    15,     8,     9,   nil,
+    10,   nil,    11,   nil,    12,    13,    14,    15,     8,     9,
+   nil,    10,    18,    11,    19,    12,    13,    14,    15,    20,
+    18,    17,    19,    17,   nil,   nil,    31,    20,    35 ]
+
+racc_action_check = [
+     0,     0,     1,     0,     2,     0,    23,     0,     0,     0,
+     0,    10,    10,    23,    10,     8,    10,    29,    10,    10,
+    10,    10,    11,    11,    29,    11,    16,    11,    24,    11,
+    11,    11,    11,    15,    15,    25,    15,    30,    15,   nil,
+    15,    15,    15,    15,    17,    17,   nil,    17,   nil,    17,
+   nil,    17,    17,    17,    17,    18,    18,   nil,    18,   nil,
+    18,   nil,    18,    18,    18,    18,    19,    19,   nil,    19,
+   nil,    19,   nil,    19,    19,    19,    19,    20,    20,   nil,
+    20,   nil,    20,   nil,    20,    20,    20,    20,    33,    33,
+   nil,    33,     3,    33,     3,    33,    33,    33,    33,     3,
+    27,    22,    27,    28,   nil,   nil,    22,    27,    28 ]
+
+racc_action_pointer = [
+    -3,     2,     2,    86,   nil,   nil,   nil,   nil,    11,   nil,
+     8,    19,   nil,   nil,   nil,    30,    26,    41,    52,    63,
+    74,   nil,    99,     4,    23,    21,   nil,    94,   101,    15,
+    23,   nil,   nil,    85,   nil,   nil,   nil,   nil,   nil ]
+
+racc_action_default = [
+   -20,   -20,    -1,    -3,    -4,    -5,    -6,    -7,   -20,    -9,
+   -20,   -20,   -15,   -16,   -17,   -20,   -20,   -20,   -20,   -20,
+   -20,    -8,   -20,   -20,   -20,   -20,    39,    -2,   -20,   -20,
+   -20,   -12,   -14,   -20,   -19,   -11,   -13,   -18,   -10 ]
+
+racc_goto_table = [
+     1,    22,    23,    25,    27,   nil,   nil,   nil,    30,    28,
+    29,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
+   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
+   nil,   nil,   nil,    38 ]
+
+racc_goto_check = [
+     1,     2,     2,     8,     3,   nil,   nil,   nil,     8,     2,
+     2,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
+   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
+   nil,   nil,   nil,     1 ]
+
+racc_goto_pointer = [
+   nil,     0,    -9,   -13,   nil,   nil,   nil,   nil,   -12 ]
+
+racc_goto_default = [
+   nil,    24,     2,     3,     4,     5,     6,     7,   nil ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  1, 16, :_reduce_1,
+  3, 17, :_reduce_2,
+  1, 17, :_reduce_3,
+  1, 18, :_reduce_none,
+  1, 18, :_reduce_none,
+  1, 18, :_reduce_none,
+  1, 18, :_reduce_7,
+  2, 18, :_reduce_8,
+  1, 18, :_reduce_9,
+  3, 23, :_reduce_10,
+  4, 19, :_reduce_11,
+  3, 19, :_reduce_12,
+  4, 20, :_reduce_13,
+  3, 20, :_reduce_14,
+  1, 22, :_reduce_none,
+  1, 22, :_reduce_none,
+  1, 22, :_reduce_none,
+  4, 21, :_reduce_18,
+  3, 21, :_reduce_19 ]
+
+racc_reduce_n = 20
+
+racc_shift_n = 39
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  :SEPARATOR => 2,
+  :DUCK_SYMBOL => 3,
+  :NAME => 4,
+  :ARROW => 5,
+  :GENERIC_START => 6,
+  :GENERIC_END => 7,
+  :TUPLE_START => 8,
+  :TUPLE_END => 9,
+  :SYMBOL => 10,
+  :STRING => 11,
+  :INTEGER => 12,
+  :HASH_START => 13,
+  :HASH_END => 14 }
+
+racc_nt_base = 15
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+Ractor.make_shareable(Racc_arg) if defined?(Ractor)
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "SEPARATOR",
+  "DUCK_SYMBOL",
+  "NAME",
+  "ARROW",
+  "GENERIC_START",
+  "GENERIC_END",
+  "TUPLE_START",
+  "TUPLE_END",
+  "SYMBOL",
+  "STRING",
+  "INTEGER",
+  "HASH_START",
+  "HASH_END",
+  "$start",
+  "expression",
+  "type_list",
+  "type_single",
+  "generic_type",
+  "tuple_type",
+  "hash_type",
+  "literal_type",
+  "type_pair" ]
+Ractor.make_shareable(Racc_token_to_s_table) if defined?(Ractor)
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+module_eval(<<'.,.,', 'parser.y', 3)
+  def _reduce_1(val, _values, result)
+     result = Ast::UnionType.build(val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 5)
+  def _reduce_2(val, _values, result)
+     result = [*val[0], val[2]]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 6)
+  def _reduce_3(val, _values, result)
+     result = [val[0]]
+    result
+  end
+.,.,
+
+# reduce 4 omitted
+
+# reduce 5 omitted
+
+# reduce 6 omitted
+
+module_eval(<<'.,.,', 'parser.y', 11)
+  def _reduce_7(val, _values, result)
+     result = Ast::LiteralType.new(content: val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 12)
+  def _reduce_8(val, _values, result)
+     result = Ast::DuckType.new(name: val[1])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 13)
+  def _reduce_9(val, _values, result)
+     result = Ast::Type.new(name: val[0])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 15)
+  def _reduce_10(val, _values, result)
+     result = [val[0], val[2]]
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 17)
+  def _reduce_11(val, _values, result)
+     result = Ast::GenericType.new(container_type: val[0], types: val[2])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 18)
+  def _reduce_12(val, _values, result)
+     result = Ast::GenericType.new(types: val[1])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 20)
+  def _reduce_13(val, _values, result)
+     result = Ast::TupleType.new(container_type: val[0], types: val[2])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 21)
+  def _reduce_14(val, _values, result)
+     result = Ast::TupleType.new(types: val[1])
+    result
+  end
+.,.,
+
+# reduce 15 omitted
+
+# reduce 16 omitted
+
+# reduce 17 omitted
+
+module_eval(<<'.,.,', 'parser.y', 25)
+  def _reduce_18(val, _values, result)
+     result = Ast::HashType.new(container_type: val[0], type_pair: val[2])
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.y', 26)
+  def _reduce_19(val, _values, result)
+     result = Ast::HashType.new(type_pair: val[1])
+    result
+  end
+.,.,
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+    end   # class Parser
+  end   # module YardType
+end   # module YardToRbsInline
+
+
+module Yoda
+  module Parsing
+    module YardType
+      class Parser
+        # @rbs!
+        #   def parse: (String) -> Ast::node
+        #   def next_token: () -> untyped
+      end
+    end
+  end
+end

data/lib/yard_to_rbs_inline/yard_type/parser.y

@@ -0,0 +1,59 @@
+class YardToRbsInline::YardType::Parser
+start expression
+rule
+  expression : type_list { result = Ast::UnionType.build(val[0]) }
+
+  type_list : type_list SEPARATOR type_single { result = [*val[0], val[2]] }
+            | type_single                     { result = [val[0]] }
+
+  type_single : generic_type
+              | tuple_type
+              | hash_type
+              | literal_type     { result = Ast::LiteralType.new(content: val[0]) }
+              | DUCK_SYMBOL NAME { result = Ast::DuckType.new(name: val[1]) }
+              | NAME             { result = Ast::Type.new(name: val[0]) }
+
+  type_pair : expression ARROW expression { result = [val[0], val[2]] }
+
+  generic_type : type_single GENERIC_START type_list GENERIC_END { result = Ast::GenericType.new(container_type: val[0], types: val[2]) }
+               | GENERIC_START type_list GENERIC_END             { result = Ast::GenericType.new(types: val[1]) }
+
+  tuple_type : type_single TUPLE_START type_list TUPLE_END { result = Ast::TupleType.new(container_type: val[0], types: val[2]) }
+             | TUPLE_START type_list TUPLE_END             { result = Ast::TupleType.new(types: val[1]) }
+
+  literal_type : SYMBOL | STRING | INTEGER
+
+  hash_type : type_single HASH_START type_pair HASH_END  { result = Ast::HashType.new(container_type: val[0], type_pair: val[2]) }
+            | HASH_START type_pair HASH_END             { result = Ast::HashType.new(type_pair: val[1]) }
+end
+
+---- header
+# Note: Prepend magic comment by script because default comments are prepended to header.
+
+---- inner
+
+#:: (String) -> Ast::node
+def parse(string)
+  @tokens = Scanner.new(string).to_racc_tokens
+
+  do_parse()
+end
+
+#:: () -> untyped
+def next_token
+  @tokens.shift
+end
+
+---- footer
+
+module Yoda
+  module Parsing
+    module YardType
+      class Parser
+        # @rbs!
+        #   def parse: (String) -> Ast::node
+        #   def next_token: () -> untyped
+      end
+    end
+  end
+end

data/lib/yard_to_rbs_inline/yard_type/scanner.rb

@@ -0,0 +1,69 @@
+# rbs_inline: enabled
+
+require 'strscan'
+
+module YardToRbsInline::YardType
+  class Scanner
+    class ScanError < StandardError; end
+
+    Token = Struct.new(:kind, :content, keyword_init: true)
+
+    TOKEN_PATTERNS = {
+      generic_start: /</,
+      generic_end: />/,
+      tuple_start: /\(/,
+      tuple_end: /\)/,
+      duck_symbol: /#/,
+      separator: /[,;]/,
+      arrow: /\=>/,
+      hash_start: /\{/,
+      hash_end: /\}/,
+      name: /(::|\w)+/,
+      symbol: /:\w+/,
+      string: [/\"[^"]*\"/, /\'[^']*\'/],
+      integer: /\d+/,
+      spaces: /\s+/,
+    }
+
+    attr_reader :text #:: String
+
+    #:: (String text) -> untyped
+    def initialize(text)
+      @text = text
+    end
+
+    #:: () -> Array[[Symbol | bool, String]]
+    def to_racc_tokens
+      tokens.map { |token| [token.kind.to_s.upcase.to_sym, token.content] } + [[false, "EOS"]]
+    end
+
+    #:: () -> Array[Token]
+    def tokens
+      @tokens ||= begin
+        scanner = StringScanner.new(text)
+        tokens = []
+
+        scan_step = lambda do
+          TOKEN_PATTERNS.each do |kind, pattern_or_patterns|
+            Array(pattern_or_patterns).each do |pattern|
+              if (matched = scanner.scan(pattern))
+                tokens << Token.new(kind: kind, content: matched) unless kind == :spaces
+                return
+              end
+            end
+          end
+
+          raise ScanError, "Unknown keyword #{scanner.rest} (in #{text})"
+        end
+
+        until scanner.eos? do
+          scan_step.call
+        end
+
+        tokens
+      end
+    end
+  end
+
+
+end

data/lib/yard_to_rbs_inline/yard_type.rb

@@ -0,0 +1,9 @@
+# rbs_inline: enabled
+
+module YardToRbsInline
+  module YardType
+    require_relative 'yard_type/ast'
+    require_relative 'yard_type/parser'
+    require_relative 'yard_type/scanner'
+  end
+end

data/lib/yard_to_rbs_inline.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "yard_to_rbs_inline/version"
+
+module YardToRbsInline
+  class Error < StandardError; end
+end
+
+require_relative "yard_to_rbs_inline/cli"
+require_relative "yard_to_rbs_inline/converter"
+require_relative "yard_to_rbs_inline/yard_type"

data/sig/yard_to_rbs_inline_example.rbs

@@ -0,0 +1,4 @@
+module YardToRbsInline
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: yard_to_rbs_inline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomoya Chiba
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Converter of yard to rbs-inline
+email:
+- tomo.asleep@gmail.com
+executables:
+- yard-to-rbs-inline
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- examples/example.rb
+- exe/yard-to-rbs-inline
+- lib/yard_to_rbs_inline.rb
+- lib/yard_to_rbs_inline/cli.rb
+- lib/yard_to_rbs_inline/converter.rb
+- lib/yard_to_rbs_inline/converter/code_visitor.rb
+- lib/yard_to_rbs_inline/converter/subscriptable.rb
+- lib/yard_to_rbs_inline/converter/text_with_mod.rb
+- lib/yard_to_rbs_inline/version.rb
+- lib/yard_to_rbs_inline/yard_type.rb
+- lib/yard_to_rbs_inline/yard_type/ast.rb
+- lib/yard_to_rbs_inline/yard_type/parser.rb
+- lib/yard_to_rbs_inline/yard_type/parser.y
+- lib/yard_to_rbs_inline/yard_type/scanner.rb
+- sig/yard_to_rbs_inline_example.rbs
+homepage: https://github.com/tomoasleep/yard_to_rbs_inline
+licenses: []
+metadata:
+  homepage_uri: https://github.com/tomoasleep/yard_to_rbs_inline
+  source_code_uri: https://github.com/tomoasleep/yard_to_rbs_inline
+  changelog_uri: https://github.com/tomoasleep/yard_to_rbs_inline/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Converter of yard to rbs-inline
+test_files: []