yard-sig 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0222c39af762e8f0c74f9ab32b00810f1fef82130f7fce31055a3d213dc7004c
-  data.tar.gz: aeaaa149c7de85e02fcc489ad8797c5d72d598d144916b5311f6e3e63fc2c437
+  metadata.gz: a5f0199099b90174466cf9c16956ad076ebef5c79a371eb28bd96e9f7ead2195
+  data.tar.gz: 1760b6025f143dc79fdb34cf48f8f4cc2779047fbfe5203e74bf5a633e4b1eaa
 SHA512:
-  metadata.gz: d0680c7d050b65311197c39cc0bb5fe6aaf68fd696f5631c45fe08f65206805bab33d3e5786270a58bddbcc0589405d4e38be82b97b37625cd7ebdd1eabf93ce
-  data.tar.gz: c148870b2939b3258014f22bb8309f0bacfc948ab61c57a74db8d3cd44d82e76fcb4458b020a80a59c297e264ca1cdde5e91eafc7200ab0302592b4c315b4a0a
+  metadata.gz: 18333b749e23f6da2ab2f6b946e8c1fce265fd1fa9c4ebbd6b108d93dd8e4226b0ef513b18e1ceafa151511a09f9e6161bc92a1067fd826fc68e4440da81de1a
+  data.tar.gz: 5eb6cfcc8a229cd0550bd447db8c9397578ef51f67c178d739f22af3e008d7894ed3dc85bdeedb0f888da46d0fa0cc4dbdfe32a615cca3a4709a1d08201cd7b7

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.2.2] - 2024-01-15
+
+- fix: support keyword arguments
+
+## [0.2.1] - 2024-01-08
+
+- fix: use the hash specific syntax
+- fix: support optional types
+- ci: CI against ruby 3.3
+- ci: upgrade actions/checkout
+
 ## [0.2.0] - 2023-07-07
 
 - feat: support [AaronC81/sord](https://github.com/AaronC81/sord)

data/lib/yard-sig/sig.rb

@@ -25,12 +25,16 @@ module YardSig
       @rbs_method_type ||= RBS::Parser.parse_method_type(@source)
     end
 
-    def rbs_type_to_tags(rbs_type, within_block: false)
+    def rbs_type_to_tags(rbs_type, within_block: false) # rubocop:disable Metrics/AbcSize
       positionals = rbs_type.required_positionals + rbs_type.optional_positionals
 
       tags = positionals.map.with_index do |param, i|
         build_param_tag(param, :positionals, pos: i, within_block: within_block)
       end
+
+      tags += rbs_type.required_keywords.map { |name, type| build_param_tag_for_keyword(name, type) }
+      tags += rbs_type.optional_keywords.map { |name, type| build_param_tag_for_keyword(name, type) }
+
       tags << build_param_tag(rbs_type.rest_positionals, :rest, within_block: within_block)
       tags << build_param_tag(rbs_type.rest_keywords, :keyrest, within_block: within_block)
       tags << build_return_tag(rbs_type.return_type, within_block: within_block)
@@ -50,12 +54,19 @@ module YardSig
       if kind == :rest
         yard_types = "Array<#{yard_types}>"
       elsif kind == :keyrest
-        yard_types = "Hash<Symbol, #{yard_types}>"
+        yard_types = "Hash{Symbol => #{yard_types}}"
       end
 
       YARD::Tags::Tag.new(tag_name, "", yard_types, name)
     end
 
+    def build_param_tag_for_keyword(name, type)
+      yard_types = to_yard_type(type.type)
+      return unless yard_types
+
+      YARD::Tags::Tag.new(:param, "", yard_types, name.to_s)
+    end
+
     def build_return_tag(type, within_block: false)
       return unless type
 
@@ -81,9 +92,17 @@ module YardSig
         "Boolean"
       when RBS::Types::Bases::Instance
         @namespace.to_s
+      when RBS::Types::Optional
+        "#{to_yard_type(type.type)}, nil"
       when RBS::Types::ClassInstance
-        args = type.args.map { |t| to_yard_type(t) }.join(", ")
-        args.empty? ? type.to_s : "#{type.name}<#{args}>"
+        args = type.args.map { |t| to_yard_type(t) }
+        if args.empty?
+          type.to_s
+        elsif type.name.name == :Hash
+          "#{type.name}{#{args[0]} => #{args[1]}}"
+        else
+          "#{type.name}<#{args.join(", ")}>"
+        end
       else
         type.to_s
       end

data/lib/yard-sig/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YardSig
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-sig
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Takumi Shotoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -63,8 +63,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/sinsoku/yard-sig
-  source_code_uri: https://github.com/sinsoku/yard-sig/blob/v0.2.0/CHANGELOG.md
-  changelog_uri: https://github.com/sinsoku/yard-sig/tree/v0.2.0
+  source_code_uri: https://github.com/sinsoku/yard-sig/blob/v0.2.2/CHANGELOG.md
+  changelog_uri: https://github.com/sinsoku/yard-sig/tree/v0.2.2
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.6.0.dev
 signing_key:
 specification_version: 4
 summary: A YARD plugin for writing documentations with RBS syntax