yard2steep 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd410ad306476662e4768508ddb91363d6881d8714b83588f890b871571e8c2
-  data.tar.gz: a4ea944e7ec8b0ddaec01dfadce13cf85ad934ee1612aeff4ca00b045396f57e
+  metadata.gz: 9bb70f71599de19c3366d88dcafff7a50180c9358f2c331467158b3a711865cb
+  data.tar.gz: 7efcad232269e58c28f8cab663b10936eaa6c58fc5d8548426cfc8e768c21199
 SHA512:
-  metadata.gz: ca073d5d4eba5d8caad1d94877b9d7800cd1ec10306f2f02e8bc36cd37695e70a5e571c30aafeec27f0e42842e25ac34e46d1115f0534a39c846085612d97e1e
-  data.tar.gz: 470f49608f90134ce4cddee5e9a905371347ae3ad8eb49b245a2d8fab83b8be8b5d9d82fb813cf2389c49fdfecbb6c23f9f32b9ac2973bcd46010ba0a410ec7e
+  metadata.gz: 934d8b340f06399d2990f96330c01eeece9db711a2dbfc7aebfb7e43355145b3dee1f4594081cdcd193f2211fe8200d9f2f4878346ab1879b9bb4dcffcf9783b
+  data.tar.gz: b674c6de151346cc48015d1b166c4c2059f1fd5967a4dbd94a1e14db05206876b78abea19921d236962cd272d37ac16e993533b6c8b1cac2253a6bd554fe2894

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yard2steep (0.1.1)
+    yard2steep (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -27,6 +27,9 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-doc (0.13.4)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
     rainbow (2.2.2)
       rake
     rake (10.5.0)
@@ -52,6 +55,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    yard (0.9.14)
 
 PLATFORMS
   ruby
@@ -59,6 +63,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   pry
+  pry-doc
   rake (~> 10.0)
   rspec (~> 3.2)
   steep (= 0.4.0)

data/example/sample1/lib/example1.rb

@@ -13,8 +13,12 @@ end
 # @param [Array] contents
 
 class SomeClass
-  # @dynamic index
+  # @dynamic index, comment
   attr_reader :index
+  attr_reader("comment")
+end
+
+module SomeModule
 end
 
 class MyClass
@@ -60,6 +64,14 @@ class MyClass
     {}
   end
 
+  # @param [String] base
+  # @param [Integer] off
+  # @param [Hash] opt
+  # @return [String]
+  def comment(base, off = 0, opt: {})
+    ""
+  end
+
   # @param [Integer] off
   # @return [Hash{ Symbol => Integer, nil }]
   def values(off: 0)
@@ -97,6 +109,13 @@ class MyClass
     list.last
   end
 
+  # NOTE: Args after default args is not supported by steep.
+  # # @param [String] str
+  # # @param [Integer] id
+  # # @param [Array] rest
+  # def setup(str, id = 1, rest)
+  # end
+
   # NOTE: should be interpreterd as any -> any
   def present?(list)
     list.size > 0

data/example/sample1/sig/example1.rbi

@@ -1,6 +1,8 @@
 class SomeClass
   @index: any
+  @comment: any
   def index: -> any
+  def comment: -> any
 end
 class MyClass
   def self.name: -> String
@@ -9,6 +11,7 @@ class MyClass
   def nest: -> Array<Array<Symbol>>
   def type: -> Array<Symbol | Integer>
   def opts: -> Hash<any, any>
+  def comment: (String, ?Integer, ?opt: Hash<any, any>) -> String
   def values: (?off: Integer) -> Hash<Symbol, Integer | nil>
   def nest_hash: -> Hash<Symbol, Array<Integer>>
   def reverse: (Array<Integer>, order: Symbol) -> Array<Integer>

data/lib/yard2steep/ast/p_node.rb

@@ -6,6 +6,7 @@ module Yard2steep
 
       STYLE = {
         normal:               "STYLE.normal",
+        normal_with_default:  "STYLE.normal_with_default",
         keyword:              "STYLE.keyword",
         keyword_with_default: "STYLE.keyword_with_default",
       }

data/lib/yard2steep/gen.rb

@@ -150,6 +150,8 @@ module Yard2steep
       case p_node.style
       when AST::PNode::STYLE[:normal]
         emit! t.p_type
+      when AST::PNode::STYLE[:normal_with_default]
+        emit! "?#{t.p_type}"
       when AST::PNode::STYLE[:keyword]
         emit! "#{t.p_name}: #{t.p_type}"
       when AST::PNode::STYLE[:keyword_with_default]