sord 5.0.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84021ad2fe6eca96e0b11e2ebc8b41fb7070c9e8bcd32db11e39fafecd463d86
-  data.tar.gz: a38b1025856359aff335bcac403a563ac1cbe526c2c6edb8ab3d3c6e1088af02
+  metadata.gz: 54bd59da2188e5392c6946e2cbd77ce55e1113abc40a2cf880671afe3c22efac
+  data.tar.gz: 9671e16277cba3b800d8dc4dcae525384064efd1138575eef441719624ebf45d
 SHA512:
-  metadata.gz: 9857df42edf887fc03ba10d21acd9389e6d7d87427424e5881f58eee004fabb0e644cb4bad1c487ce716af712d0208f170f7f6eafd0d6f01bc853cdf3a319ffe
-  data.tar.gz: 30195da215e3a1dcba962a441e1498733ab410c59e9b6f4eab5f56be524131c0050ec150ce37b616c3d1ce2125d6b85f7cf00fe7b2b0f5a95c5eb99525736c8e
+  metadata.gz: f9c0ca7bc3d427367fe069cc415e37a0250ad7c3010ebbfa119dbdd97f98b474da0a7092277f2f45810d376654545b930b3c59a7a537f4132a23ad68352f913d
+  data.tar.gz: 8b6ced8d20985ee9faaae5b672ebd90bd4ef00d396938e7db1e6fecf350d817b143db55eca1231782bf2c0bd5605394eac825d8fa612ff7e093fc0f3ce27e14c

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/).
 
+## [6.0.0] - 2023-05-02
+### Changed
+- **Breaking change**: Now targets RBS 3.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!

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

@@ -22,13 +22,13 @@ module Sord
     end
 
     def self.load_gem_objects(hash)
-      all_decls = []
+      env = RBS::Environment.new
       begin
-        RBS::CLI::LibraryOptions.new.loader.load(env: all_decls)
+        RBS::CLI::LibraryOptions.new.loader.load(env: env)
       rescue RBS::Collection::Config::CollectionNotAvailable
         Sord::Logging.warn("Could not load RBS collection - run rbs collection install for dependencies")
       end
-      add_rbs_objects_to_paths(all_decls, hash)
+      add_rbs_objects_to_paths(env, hash)
 
       gem_paths = Bundler.load.specs.map(&:full_gem_path)
       gem_paths.each do |path|
@@ -41,13 +41,22 @@ module Sord
       end
     end
 
-    def self.add_rbs_objects_to_paths(all_decls, names_to_paths, path=[])
+    def self.add_rbs_objects_to_paths(env, names_to_paths, path=[])
+      case env
+      when RBS::Environment
+        declarations = env.declarations
+      when Array
+        declarations = env
+      else
+        raise TypeError, "env"
+      end
+
       klasses = [
         RBS::AST::Declarations::Module,
         RBS::AST::Declarations::Class,
         RBS::AST::Declarations::Constant
       ]
-      all_decls.each do |decl|
+      declarations.each do |decl|
         next unless klasses.include?(decl.class)
         name = decl.name.to_s
         new_path = path + [name]

data/lib/sord/version.rb

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

data/sord.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sorbet-runtime'
   spec.add_dependency 'commander', '~> 4.5'
   spec.add_dependency 'parlour', '~> 5.0'
-  spec.add_dependency 'rbs', '~> 2.0'
+  spec.add_dependency 'rbs', '~> 3.0'
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sord
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 6.0.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement