yard2rbs 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74d0fab907be0a8229347fbda564913a08a6688b3b1c76db58ab98e52a783c3b
-  data.tar.gz: 1e51981642df3c3ee35cfd8a0e8c9651d6c03db6fff51bb7fd8d995f96101b13
+  metadata.gz: 89cede55d743ff594a63059976abb91340df2296817864612b5414ac7d2202ed
+  data.tar.gz: 340ea58b5d5425d9257fc43589534f7097e78ae5bad5040695b532eb88365603
 SHA512:
-  metadata.gz: c29df8ed7704ff31f8a7640a52f3f50e02ccf654e0d999c25d3c228b162e9488c1abf598e71d63f39ec4c240ee1a2cd685dcd9a2b898d2d6c35b665035865d6c
-  data.tar.gz: 20c59a4b6462c4d14636587d7426faf377b2931ccb6c9ce7ae6eebaf5725ed58cc5dcc4859c6be00b46e6afd70e8efeec1c233bdba648e0b47a4d12d70b74bbb
+  metadata.gz: 06d23c6bf1c51b606a39071c2cdd7b9ee4b72043e2f2b7f36d9b71b27b66e7e9c371b213b0e70bac65c3fb8c1bd9877b8f7175aaac17dcab5cf9b967f9cf80f6
+  data.tar.gz: df576094cc163320c461cd04cf3007b480e372b70f5d19353b5c04e7d192bf9c96a215d3129e1cf3e845e5106ed2f44bb21e0c2029eb389093748c444000ff56

data/lib/yard2rbs/converter.rb

@@ -1,13 +1,23 @@
 # frozen_string_literal: true
 
 require "prism"
+require "rbs"
 
 # https://ruby.github.io/prism/rb/index.html
 # https://github.com/ruby/rbs/blob/master/docs/syntax.md
 # https://github.com/ruby/rbs/blob/master/lib/rbs/prototype/rb.rb
+# https://rubydoc.info/gems/yard/file/docs/GettingStarted.md
 
 module Yard2rbs
   class Converter
+    class << self
+      # @param input_path [String]
+      # @return [String]
+      def convert(input_path)
+        new(input_path).convert
+      end
+    end
+
     # @param input_path [String]
     # @return [void]
     def initialize(input_path)
@@ -19,6 +29,7 @@ module Yard2rbs
     # @return [String]
     def convert
       @_indent_level = 0
+      @_superclasses = []
       # puts @parse_result.value.inspect
       process(@parse_result.value)
       output = @output.join("\n")
@@ -39,12 +50,20 @@ module Yard2rbs
 
       when Prism::ClassNode
         if node.superclass
-          output("class #{node.constant_path.name} < #{node.superclass.name}")
+          case node.superclass
+          when Prism::SelfNode
+            output("class #{node.constant_path.name} < ::#{@_superclasses.join("::")}")
+          else
+            output("class #{node.constant_path.name} < #{node.superclass.name}")
+          end
         else
           output("class #{node.constant_path.name}")
         end
+
         @_indent_level += 1
+        @_superclasses << node.constant_path.name
         process(node.compact_child_nodes)
+        @_superclasses.pop
         @_indent_level -= 1
         output("end")
 
@@ -56,7 +75,9 @@ module Yard2rbs
       when Prism::ModuleNode
         output("module #{node.constant_path.name}")
         @_indent_level += 1
+        @_superclasses << node.constant_path.name
         process(node.compact_child_nodes)
+        @_superclasses.pop
         @_indent_level -= 1
         output("end")
 
@@ -66,10 +87,14 @@ module Yard2rbs
         output("#{node.name}: #{type}")
 
       when Prism::ClassVariableWriteNode
-        output("#{node.name}: untyped")
+        types = parse_comments(node)
+        type = format_types(types[:returns])
+        output("#{node.name}: #{type}")
 
       when Prism::InstanceVariableWriteNode
-        output("self.#{node.name}: untyped")
+        types = parse_comments(node)
+        type = format_types(types[:returns])
+        output("self.#{node.name}: #{type}")
 
       when Prism::DefNode
         visibility = @_visibility_node&.name
@@ -96,7 +121,7 @@ module Yard2rbs
 
           if arg = node.parameters.rest
             type = format_types(types[:params][arg.name.to_s])
-            params << "*#{type} #{arg.name}"
+            params << "*#{type}"
           end
 
           if node.parameters.keywords
@@ -112,11 +137,19 @@ module Yard2rbs
 
           if arg = node.parameters.keyword_rest
             type = format_types(types[:params][arg.name.to_s])
-            params << "**#{type} #{arg.name}"
+            params << "**#{type}"
           end
 
           if arg = node.parameters.block
-            block = "{ (?) -> untyped }"
+            yieldparams =
+              types[:yieldparams].map do |name, types|
+                type = format_types(types)
+                "#{type} #{name}"
+              end
+
+            return_type = format_types(types[:yieldreturns])
+
+            block = "{ (#{yieldparams.join(", ")}) -> #{return_type} }"
           end
         end
 
@@ -148,10 +181,12 @@ module Yard2rbs
         when :attr_accessor, :attr_reader, :attr_writer
           if node.arguments
             receiver = "self." if self?(node)
+            types = parse_comments(node)
+            type = format_types(types[:returns])
             node.arguments.arguments.each do |arg|
               output([
                 "#{receiver}#{node.name}",
-                "#{arg.unescaped}: untyped"
+                "#{arg.unescaped}: #{type}"
               ].compact.join(' '))
             end
           end
@@ -211,41 +246,8 @@ module Yard2rbs
     # @param node [Prism::Node]
     # @return [Hash]
     def parse_comments(node)
-      params = {}
-      returns = []
-
-      comments = node.location.comments
-      comments&.each do |comment|
-        line = comment.slice
-
-        case line
-        when /@param/
-          if matches = line.match(/# @param ([^\s]+) \[([^\]]+)\].*/)
-            types = matches[2].split(',').map(&:strip)
-            params[matches[1]] = convert_types(types)
-          end
-        when /@return/
-          if matches = line.match(/# @return \[([^\]]+)\].*/)
-            types = matches[1].split(',').map(&:strip)
-            returns += convert_types(types)
-          end
-        end
-      end
-
-      {
-        params: params,
-        returns: returns,
-      }
-    end
-
-    # @param types [String]
-    # @return [Array<String>]
-    def convert_types(types)
-      types.map do |type|
-        type.
-          gsub(/Array\<([^>]+)\>/, 'Array[\1]').
-          gsub(/Hash\<([^>]+),\s*([^>]+)\>/, 'Hash[\1,\2]')
-      end
+      comments = node.location.comments.map(&:slice)
+      YardParser.parse(comments)
     end
 
     # @param types [Array<String>]

data/lib/yard2rbs/version.rb

@@ -2,5 +2,5 @@
 
 module Yard2rbs
   # @return [String]
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/yard2rbs/yard_parser.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# TODO:
+# * Convert YARD "Boolean" to RBS "bool"
+# * Make some classes top level via :: (e.g. String -> ::String)
+
+module Yard2rbs
+  class YardParser
+    class << self
+      # @param comments [Array<String>]
+      # @return [Hash<Symbol, Array<String> | Hash<String, String>>]
+      def parse(comments)
+        params = {}
+        returns = []
+
+        yieldparams = {}
+        yieldreturns = []
+
+        comments&.each do |comment|
+          case comment
+          when /@param/
+            if matches = comment.match(/# @param ([^\s]+) \[([^\]]+)\].*/)
+              params[matches[1]] = convert(matches[2])
+            end
+
+          when /@return/
+            if matches = comment.match(/# @return \[([^\]]+)\].*/)
+              returns += convert(matches[1])
+            end
+
+          when /@yieldparam/
+            if matches = comment.match(/# @yieldparam ([^\s]+) \[([^\]]+)\].*/)
+              yieldparams[matches[1]] = convert(matches[2])
+            end
+
+          when /@yieldreturn/
+            if matches = comment.match(/# @yieldreturn \[([^\]]+)\].*/)
+              yieldreturns += convert(matches[1])
+            end
+          end
+        end
+
+        {
+          params:,
+          returns:,
+
+          yieldparams:,
+          yieldreturns:,
+        }
+      end
+
+      # Converts YARD type string into RBS type array
+      # e.g. Input:  "String, Array<String>, Hash<String, String>"
+      #      Output: ["String", "Array[String]", "Hash[String, String]"]
+      #
+      # @param types_str [String]
+      # @return [Array<String>]
+      def convert(types_str)
+        types = []
+
+        nested_level = 0
+        current_type = []
+        types_str.each_char.with_index(1) do |char, index|
+          case char
+          when ','
+            if nested_level > 0
+              current_type << char
+            else
+              types << current_type.join
+              current_type = []
+            end
+          when '<'
+            nested_level += 1
+            current_type << "["
+          when '>'
+            nested_level -= 1
+            current_type << "]"
+          when ' '
+            if current_type.any?
+              current_type << " "
+            end
+          else
+            current_type << char
+          end
+
+          if index == types_str.size
+            types << current_type.join
+          end
+        end
+
+        types
+      end
+    end
+  end
+end

data/lib/yard2rbs.rb

@@ -1,19 +1,16 @@
 # frozen_string_literal: true
 
 require_relative "yard2rbs/converter"
+require_relative "yard2rbs/yard_parser"
 require_relative "yard2rbs/version"
 
-require "rbs"
-
 module Yard2rbs
   class << self
     # @param file_paths [Array<String>]
     # @return [Boolean]
     def convert(file_paths)
-      # TODO: Clear out rbs/ directory
-
       file_paths.each do |file_path|
-        output = Converter.new(file_path).convert
+        output = Converter.convert(file_path)
         next if output.empty?
 
         input_dirname = File.dirname(file_path)

data/sig/lib/yard2rbs/converter.rbs

@@ -1,5 +1,6 @@
 module Yard2rbs
   class Converter
+    def self.convert: (String input_path) -> String
     def initialize: (String input_path) -> void
     def convert: () -> String
     private
@@ -8,7 +9,6 @@ module Yard2rbs
     def output: (String str) -> String
     def self?: (Prism::Node node) -> Boolean
     def parse_comments: (Prism::Node node) -> Hash
-    def convert_types: (String types) -> Array[String]
     def format_types: (Array[String] types) -> String
   end
 end

data/sig/lib/yard2rbs/yard_parser.rbs

@@ -0,0 +1,6 @@
+module Yard2rbs
+  class YardParser
+    def self.parse: (Array[String] comments) -> Hash[Symbol, Array[String] | Hash[String, String]]
+    def self.convert: (String types_str) -> Array[String]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard2rbs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Kieran Pilkington
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -54,9 +54,11 @@ files:
 - lib/yard2rbs.rb
 - lib/yard2rbs/converter.rb
 - lib/yard2rbs/version.rb
+- lib/yard2rbs/yard_parser.rb
 - sig/lib/yard2rbs.rbs
 - sig/lib/yard2rbs/converter.rbs
 - sig/lib/yard2rbs/version.rbs
+- sig/lib/yard2rbs/yard_parser.rbs
 homepage:
 licenses:
 - MIT