yard-sig 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8a30d8e37b42f9db474cacba8fe768ae90129eb452cedaa105de1a28995a415
-  data.tar.gz: b5ef51eedc71a75d8875f392e93f09f11257b7f91ad88222ee28df64dd9bf7df
+  metadata.gz: 7ab2bf52e54c80a38edafd9ddbd34e0c1238e26001b582e828cecbd44b7fde2a
+  data.tar.gz: 88be629986e49ae4d1d4fcb2a1555f2dcce9828664a9fbdc860ae4433d8240e2
 SHA512:
-  metadata.gz: cebe6a8c8697513117acd7080217942cd4320549466a710f780b5f38f0d3d57652121eff85b435d463168f9fed75ddba67b575b25845de311a812abfe3d0891c
-  data.tar.gz: eb84fde03e6b369e4445cb31ae5348149da6eaf43952084036b5601045b88cb404f80308315091149247627631e6a3ce23da7dbb4a08aeee1c08a4a9b70fca6f
+  metadata.gz: 6f363d438620ae79fd852525a0ff3e8f3bd30adff94799d3a4e3a6aaae6e7e335d1a4357d212b1a5eae11021ab7953edf8b7c795356826300cedf2a81b0e7160
+  data.tar.gz: ccd484cc3b40d4335747946b799eb9d2796a75304a4435fa8128d1ee0b9d29505d2411cc1e91dce954a33b44895a20119e892d508c630dfa0279543f5845e2f6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.3] - 2024-02-07
+
+- fix: fix invalid tags when specifying multiple types
+
+## [0.2.2] - 2024-01-15
+
+- fix: support keyword arguments
+
 ## [0.2.1] - 2024-01-08
 
 - fix: use the hash specific syntax

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/yard-sig.svg)](https://badge.fury.io/rb/yard-sig)
+[![test](https://github.com/sinsoku/yard-sig/actions/workflows/test.yml/badge.svg)](https://github.com/sinsoku/yard-sig/actions/workflows/test.yml)
+
 # yard-sig
 
 A YARD plugin for writing documentations with [RBS syntax](https://github.com/ruby/rbs).

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)
@@ -48,14 +52,21 @@ module YardSig
       name = type.name ? type.name.to_s : find_name_from_yard(kind, pos)
 
       if kind == :rest
-        yard_types = "Array<#{yard_types}>"
+        yard_types = "Array<#{yard_types.join(", ")}>"
       elsif kind == :keyrest
-        yard_types = "Hash{Symbol => #{yard_types}}"
+        yard_types = "Hash{Symbol => #{yard_types.join(", ")}}"
       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
 
@@ -71,29 +82,31 @@ module YardSig
       when RBS::Types::Bases::Void, RBS::Types::Bases::Any, RBS::Types::Bases::Bottom
         nil
       when RBS::Types::Bases::Top
-        "Object"
+        ["Object"]
       when RBS::Types::Union
-        type.types.map { |t| to_yard_type(t) }.join(", ")
+        type.types.map { |t| to_yard_type(t) }
       when RBS::Types::Tuple
         args = type.types.map { |t| to_yard_type(t) }.join(", ")
-        "Array[#{args}]"
+        ["Array[#{args}]"]
       when RBS::Types::Bases::Bool
-        "Boolean"
+        ["Boolean"]
       when RBS::Types::Bases::Instance
-        @namespace.to_s
+        [@namespace.to_s]
       when RBS::Types::Optional
-        "#{to_yard_type(type.type)}, nil"
+        [to_yard_type(type.type).join(", ").to_s, "nil"]
       when RBS::Types::ClassInstance
         args = type.args.map { |t| to_yard_type(t) }
         if args.empty?
-          type.to_s
+          [type.to_s]
         elsif type.name.name == :Hash
-          "#{type.name}{#{args[0]} => #{args[1]}}"
+          key = args[0].join(", ")
+          value = args[1].join(", ")
+          ["#{type.name}{#{key} => #{value}}"]
         else
-          "#{type.name}<#{args.join(", ")}>"
+          ["#{type.name}<#{args.join(", ")}>"]
         end
       else
-        type.to_s
+        [type.to_s]
       end
     end
 

data/lib/yard-sig/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-sig
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Takumi Shotoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-02-07 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.1/CHANGELOG.md
-  changelog_uri: https://github.com/sinsoku/yard-sig/tree/v0.2.1
+  source_code_uri: https://github.com/sinsoku/yard-sig/blob/v0.2.3/CHANGELOG.md
+  changelog_uri: https://github.com/sinsoku/yard-sig/tree/v0.2.3
 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.19
+rubygems_version: 3.6.0.dev
 signing_key:
 specification_version: 4
 summary: A YARD plugin for writing documentations with RBS syntax