yard-sig 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0222c39af762e8f0c74f9ab32b00810f1fef82130f7fce31055a3d213dc7004c
-  data.tar.gz: aeaaa149c7de85e02fcc489ad8797c5d72d598d144916b5311f6e3e63fc2c437
+  metadata.gz: a8a30d8e37b42f9db474cacba8fe768ae90129eb452cedaa105de1a28995a415
+  data.tar.gz: b5ef51eedc71a75d8875f392e93f09f11257b7f91ad88222ee28df64dd9bf7df
 SHA512:
-  metadata.gz: d0680c7d050b65311197c39cc0bb5fe6aaf68fd696f5631c45fe08f65206805bab33d3e5786270a58bddbcc0589405d4e38be82b97b37625cd7ebdd1eabf93ce
-  data.tar.gz: c148870b2939b3258014f22bb8309f0bacfc948ab61c57a74db8d3cd44d82e76fcb4458b020a80a59c297e264ca1cdde5e91eafc7200ab0302592b4c315b4a0a
+  metadata.gz: cebe6a8c8697513117acd7080217942cd4320549466a710f780b5f38f0d3d57652121eff85b435d463168f9fed75ddba67b575b25845de311a812abfe3d0891c
+  data.tar.gz: eb84fde03e6b369e4445cb31ae5348149da6eaf43952084036b5601045b88cb404f80308315091149247627631e6a3ce23da7dbb4a08aeee1c08a4a9b70fca6f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [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

@@ -50,7 +50,7 @@ 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)
@@ -81,9 +81,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.1"
 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.1
 platform: ruby
 authors:
 - Takumi Shotoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2024-01-08 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.1/CHANGELOG.md
+  changelog_uri: https://github.com/sinsoku/yard-sig/tree/v0.2.1
 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.4.19
 signing_key:
 specification_version: 4
 summary: A YARD plugin for writing documentations with RBS syntax