sord 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12567f3b935a14271aedb28b62acfcfef3cb1e3bfb80fd294732947490dfb765
-  data.tar.gz: c40c2790500508fd2e575ab01e471cf7fe0e90f0c6d255285c7474433b65952c
+  metadata.gz: f101fdc3b63cf69bc59fd766ced5222c3e6b02f70f913fcc39085459e32c89de
+  data.tar.gz: ea8df6949fdef290b13cf082c364138a17224deb127e069fd8a55d8e86de29c4
 SHA512:
-  metadata.gz: 85435a86928840302557121d0deeafde94a0b70905da93403c642a303ec773f5f4503b316beed31709052839a597e671df9ac554410d4c169843e859aebf361d
-  data.tar.gz: 77795ca64b509b9c7e7da210fac12d2b27bb8fe9e952ab61dc1d87c92189a1d0e457a4546bce2cebac4230a643f96072559c39bd477fc7e345819c98dd0b3bdd
+  metadata.gz: 9bed3f4e28d753ccf493a63d552f0560267d5a4841ca6208691e557fa84ba719e1c906be765c4ba45d62ad84cbe167766b8b286202727400bcf62bf8e0748a84
+  data.tar.gz: c51d9041a3de3dd66faf35173c38ce74e89e5dc4054e9cc675c54a871dc35c84a33139e1a18674265d951f759365a66f272badca1306d89c3b7fa7997f87bb3e

data/CHANGELOG.md

@@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [5.1.0] - 2023-05-22
+### Added
+- Add support for a single `@overload` tag, typically used to describe methods defined outside of
+  Ruby. Thanks @ohai!
+
+## [5.0.1] - 2023-05-02
+### Fixed
+- Use `File#exist?` instead of `File#exists?`, for Ruby 3.2 support. Thanks @matmorel!
+
 ## [5.0.0] - 2022-10-06
 ### Added
 - If a derived class does not provide tags for a method, but it is overridden from a base class

data/lib/sord/generator.rb

@@ -294,6 +294,15 @@ module Sord
           next
         end
 
+        # If the method has YARD's "@overload" tags, the information of the
+        # first one is merged into meth object
+        # NOTE: This code does not handle the second and subsequent @overload tags
+        if meth.tag("overload")
+          meth.parameters = meth.tag("overload").parameters
+          meth.tag("overload").tags.each { |tag| meth.add_tag(tag) }
+          meth.docstring += meth.tag("overload").docstring
+        end
+        
         # Sort parameters
         meth.parameters.reverse.sort! { |pair1, pair2| sort_params(pair1, pair2) }
 

data/lib/sord/resolver.rb

@@ -32,11 +32,11 @@ module Sord
 
       gem_paths = Bundler.load.specs.map(&:full_gem_path)
       gem_paths.each do |path|
-        if File.exists?("#{path}/rbi")
-          Dir["#{path}/rbi/**/*.rbi"].each do |sigfile|
-            tree = Parlour::TypeLoader.load_file(sigfile)
-            add_rbi_objects_to_paths(tree.children, hash)
-          end
+        next unless File.exist?("#{path}/rbi")
+
+        Dir["#{path}/rbi/**/*.rbi"].each do |sigfile|
+          tree = Parlour::TypeLoader.load_file(sigfile)
+          add_rbi_objects_to_paths(tree.children, hash)
         end
       end
     end

data/lib/sord/version.rb

@@ -1,4 +1,4 @@
 # typed: strong
 module Sord
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end

data/sord.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rbs', '~> 2.0'
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'sorbet'
   spec.add_development_dependency 'simplecov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sord
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement