yard2rbs 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64504ace7fababa2cb5317bcb21e136d76e2e8cf499d4f40f186cab14f9a118b
-  data.tar.gz: 5b7aa4e867494a923a54817ac5dd028ac7f0649402000ca3ca2da00f2a8ea811
+  metadata.gz: 89cede55d743ff594a63059976abb91340df2296817864612b5414ac7d2202ed
+  data.tar.gz: 340ea58b5d5425d9257fc43589534f7097e78ae5bad5040695b532eb88365603
 SHA512:
-  metadata.gz: 5338d1061085af86b8476c2e6aaba9ee1150a44979079ea13e3257bc17977fa9afe10ec914e46b7ab7235b82ea66f20d4b3219ef6cce5839fbc93a1daf5c7c51
-  data.tar.gz: 60fdfd9feda4627ab4f388fcfbd16e72bc0dc002cb769ebf42b1ab969b86549e08eb1ff70ae54e2387de62d81720f74bcd272bef8d8329604e2ce2e2e4e8b481
+  metadata.gz: 06d23c6bf1c51b606a39071c2cdd7b9ee4b72043e2f2b7f36d9b71b27b66e7e9c371b213b0e70bac65c3fb8c1bd9877b8f7175aaac17dcab5cf9b967f9cf80f6
+  data.tar.gz: df576094cc163320c461cd04cf3007b480e372b70f5d19353b5c04e7d192bf9c96a215d3129e1cf3e845e5106ed2f44bb21e0c2029eb389093748c444000ff56

data/lib/yard2rbs/converter.rb

@@ -6,9 +6,18 @@ 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)
@@ -20,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")
@@ -40,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")
 
@@ -57,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")
 
@@ -67,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
@@ -97,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
@@ -113,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
 
@@ -149,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

data/lib/yard2rbs/version.rb

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

data/lib/yard2rbs/yard_parser.rb

@@ -1,30 +1,51 @@
 # 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]
+      # @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: params,
-          returns: returns,
+          params:,
+          returns:,
+
+          yieldparams:,
+          yieldreturns:,
         }
       end
 

data/lib/yard2rbs.rb

@@ -10,7 +10,7 @@ module Yard2rbs
     # @return [Boolean]
     def convert(file_paths)
       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

data/sig/lib/yard2rbs/yard_parser.rbs

@@ -1,6 +1,6 @@
 module Yard2rbs
   class YardParser
-    def self.parse: (Array[String] comments) -> Hash
+    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.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kieran Pilkington
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism