sord 5.1.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f101fdc3b63cf69bc59fd766ced5222c3e6b02f70f913fcc39085459e32c89de
-  data.tar.gz: ea8df6949fdef290b13cf082c364138a17224deb127e069fd8a55d8e86de29c4
+  metadata.gz: 0cd5e0c9f0db7151e0f04f309f277fecb64ce6aaf2fefdff88f749ce7a6d02d1
+  data.tar.gz: 8ef9d26ef5b4e6cf6acc7a6bfa9f46887a07891346e37cdb46b5e48d903c22bd
 SHA512:
-  metadata.gz: 9bed3f4e28d753ccf493a63d552f0560267d5a4841ca6208691e557fa84ba719e1c906be765c4ba45d62ad84cbe167766b8b286202727400bcf62bf8e0748a84
-  data.tar.gz: c51d9041a3de3dd66faf35173c38ce74e89e5dc4054e9cc675c54a871dc35c84a33139e1a18674265d951f759365a66f272badca1306d89c3b7fa7997f87bb3e
+  metadata.gz: 5b5dbaa497fe039afcb125a9e7801bdb124ed1e06b2ba0970b3743f9cfad1aa92a982710fa0f2eb5da9647803e8b2e8d6d11e3b236891687eca35c4f16c25626
+  data.tar.gz: 3b432c0005c9cc1d00b6ec4c42a52eb8be6e8dc8425e6eb2a168b1c503e6f6df5fa5ea2a2cfb4c3e4fad98de88104e2166f8cda469305ec383719080a7836ffe

data/.github/workflows/ruby.yml

@@ -6,7 +6,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.7, 3.0, 3.1]
+        ruby: [3.0, 3.1]
     continue-on-error: false
 
     runs-on: ubuntu-latest

data/CHANGELOG.md

@@ -3,6 +3,30 @@ 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/).
 
+## [7.0.0] - 2025-03-03
+### Added
+- Messages now show the file and line number that the message originated from. (Thanks @apiology)
+- Sord will now recognise `Class<T, E>` as an equivalent of `Class<T>, Class<E>`, similar to the
+  existing behaviour for `Array`. (Thanks @tomoasleep)
+
+### Changed
+- **Breaking change**: Now uses Commander 5.0 to support Ruby 3.3. This increases the minimum
+  required Ruby version to 3.0.
+- **Breaking change**: Parlour version has been bumped significantly, from 5.0 to 9.1. This may be
+  relevant if you're using other Parlour plugins alongside Sord.
+
+### Fixed
+- Sord now generates correct RBI when heredoc strings are used in constants. (Thanks @apiology)
+- Fixed error when using as a Parlour plugin, but without any custom tags defined. (Thanks
+  @dsisnero)
+- Fixed incorrect precedence when union types were nested inside hashes. (Thanks @apiology)
+- Sord now adds `::` when required, to disambiguate nested namespaces from top-level ones. (Thanks
+  @sinsoku)
+
+## [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

data/Gemfile

@@ -2,3 +2,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in sord.gemspec
 gemspec
+
+# Not in gemspec so it doesn't get distributed or depended on by the built gem.
+# Used by resolver tests, to ensure Sord can import bundled RBIs from gems.
+gem 'resolver-test', path: 'spec/resolver-test-gem'

data/lib/sord/generator.rb

@@ -4,6 +4,7 @@ require 'sord/type_converter'
 require 'sord/logging'
 require 'parlour'
 require 'rainbow'
+require 'parser/current'
 
 module Sord
   # Converts the current working directory's YARD registry into an type
@@ -80,7 +81,6 @@ module Sord
 
       # Hook the logger so that warnings are collected
       Logging.add_hook do |type, msg, item|
-        # TODO: is it possible to get line numbers here?
         warnings << [msg, item, 0] if type == :warn
       end
     end
@@ -141,7 +141,25 @@ module Sord
         # Add the constant to the current object being generated.
         case @mode
         when :rbi
-          @current_object.create_constant(constant_name, value: "T.let(#{constant.value}, T.untyped)") do |c|
+          # Parse so we can set up constant with correct heredoc syntax
+          kwargs = {}
+          value_node = Parser::CurrentRuby.parse(constant.value)
+          loc = value_node.loc
+          if loc.instance_of? Parser::Source::Map::Heredoc
+            #
+            # heredocs in Ruby come after the full expression is complete.  e.g.,
+            # puts(>>FOO)
+            #   bar
+            # FOO
+            #
+            # so if we want to wrap them in a T.let, we need to parse out the expression vs the rest
+            kwargs[:heredocs] = constant.value[loc.heredoc_body.begin_pos...loc.heredoc_end.end_pos]
+            expression = loc.expression
+            value = constant.value[expression.begin_pos...expression.end_pos]
+          else
+            value = constant.value
+          end
+          @current_object.create_constant(constant_name, value: "T.let(#{value}, T.untyped)", **kwargs) do |c|
             c.add_comments(constant.docstring.all.split("\n"))
           end
         when :rbs
@@ -582,8 +600,10 @@ module Sord
       return if @hide_private && item.visibility == :private
       count_namespace
 
-      superclass = nil
-      superclass = item.superclass.path.to_s if item.type == :class && item.superclass.to_s != "Object"
+      if item.type == :class && item.superclass.to_s != "Object"
+        prefix = "::" if item.name.to_s == item.superclass.path
+        superclass = "#{prefix}#{item.superclass.path}"
+      end
 
       parent = @current_object
       @current_object = item.type == :class \
@@ -651,7 +671,13 @@ module Sord
         Logging.warn("Please edit the file to fix these errors.")
         Logging.warn("Alternatively, edit your YARD documentation so that your types are valid and re-run Sord.")
         warnings.each do |(msg, item, _)|
-          puts "        (#{Rainbow(item&.path).bold}) #{msg}"
+          message = if item
+                      (filename, line), = item.files
+                      "        #{Rainbow("(#{item.path}) #{filename}:#{line}:").bold} #{msg}"
+                    else
+                      "        #{msg}"
+                   end
+          puts message
         end
       end
     rescue

data/lib/sord/logging.rb

@@ -74,7 +74,8 @@ module Sord
       return unless enabled_types.include?(kind)
 
       message = if item
-        "#{header} (#{Rainbow(item.path).bold}) #{msg}"
+        (filename, line), = item.files
+        "#{header} #{Rainbow("(#{item.path}) #{filename}:#{line}:").bold} #{msg}"
       else
         "#{header} #{msg}"
       end

data/lib/sord/parlour_plugin.rb

@@ -80,6 +80,7 @@ module Sord
     end
 
     def add_custom_tags
+      return unless options[:tags]
       return if options[:tags].empty?
 
       options[:tags].each do |tag|

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/type_converter.rb

@@ -24,7 +24,7 @@ module Sord
     # Matches valid method names.
     # From: https://stackoverflow.com/a/4379197/2626000
     METHOD_NAME_REGEX =
-      /(?:[a-z_]\w*[?!=]?|\[\]=?|<<|>>|\*\*|[!~+\*\/%&^|-]|[<>]=?|<=>|={2,3}|![=~]|=~)/i 
+      /(?:[a-z_]\w*[?!=]?|\[\]=?|<<|>>|\*\*|[!~+\*\/%&^|-]|[<>]=?|<=>|={2,3}|![=~]|=~)/i
 
     # Match duck types which require the object implement one or more methods,
     # like '#foo', '#foo & #bar', '#foo&#bar&#baz', and '#foo&#bar&#baz&#foo_bar'.
@@ -76,13 +76,15 @@ module Sord
         end
 
         # Handle hash rockets as separators.
-        # e.g. Hash<Symbol => String>
+        # e.g. Hash<Symbol => String> or Hash<Symbol, String => Integer>
         if params[character_pointer] == '=' && params[character_pointer + 1] == '>'
           if current_bracketing_level == 0
             character_pointer += 1
             result << buffer.strip
             buffer = ""
-            should_buffer = false
+            # commas are higher precedence
+            result = [result] if result.length > 1
+            return [result.first, split_type_parameters(params[character_pointer+1..-1].strip)]
           end
         end
 
@@ -197,8 +199,12 @@ module Sord
           .map { |x| yard_to_parlour(x, item, config) }
         if SINGLE_ARG_GENERIC_TYPES.include?(relative_generic_type) && parameters.length > 1
           Parlour::Types.const_get(relative_generic_type).new(Parlour::Types::Union.new(parameters))
-        elsif relative_generic_type == 'Class' && parameters.length == 1
-          Parlour::Types::Class.new(parameters.first)
+        elsif relative_generic_type == 'Class'
+          if parameters.length == 1
+            Parlour::Types::Class.new(parameters.first)
+          else
+            Parlour::Types::Union.new(parameters.map { |x| Parlour::Types::Class.new(x) })
+          end
         elsif relative_generic_type == 'Hash'
           if parameters.length == 2
             Parlour::Types::Hash.new(*parameters)

data/lib/sord/version.rb

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

data/rbi/sord.rbi

@@ -1,7 +1,7 @@
 # typed: strong
 # typed: strong
 module Sord
-  VERSION = T.let('5.0.0', T.untyped)
+  VERSION = T.let('7.0.0', T.untyped)
 
   # Handles writing logs to stdout and any other classes which request them.
   module Logging
@@ -178,12 +178,12 @@ module Sord
     sig { params(hash: T.untyped).returns(T.untyped) }
     def self.load_gem_objects(hash); end
 
-    # sord omit - no YARD type given for "all_decls", using untyped
+    # sord omit - no YARD type given for "env", using untyped
     # sord omit - no YARD type given for "names_to_paths", using untyped
     # sord omit - no YARD type given for "path", using untyped
     # sord omit - no YARD return type given, using untyped
-    sig { params(all_decls: T.untyped, names_to_paths: T.untyped, path: T.untyped).returns(T.untyped) }
-    def self.add_rbs_objects_to_paths(all_decls, names_to_paths, path = []); end
+    sig { params(env: T.untyped, names_to_paths: T.untyped, path: T.untyped).returns(T.untyped) }
+    def self.add_rbs_objects_to_paths(env, names_to_paths, path = []); end
 
     # sord omit - no YARD type given for "nodes", using untyped
     # sord omit - no YARD type given for "names_to_paths", using untyped
@@ -253,6 +253,7 @@ module Sord
     def add_constants(item); end
 
     # sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
+    # sord warn - Parlour::TypedObject wasn't able to be resolved to a constant in this project
     # Adds comments to an object based on a docstring.
     # 
     # _@param_ `item`
@@ -415,6 +416,7 @@ module Sord
     def self.split_type_parameters(params); end
 
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # sord warn - Parlour::Types::Type wasn't able to be resolved to a constant in this project
     # Converts a YARD type into a Parlour type.
     # 
     # _@param_ `yard` — The YARD type.
@@ -425,7 +427,9 @@ module Sord
     sig { params(yard: T.any(T::Boolean, T::Array[T.untyped], String), item: YARD::CodeObjects::Base, config: Configuration).returns(Parlour::Types::Type) }
     def self.yard_to_parlour(yard, item, config); end
 
+    # sord warn - Parlour::Types::Type wasn't able to be resolved to a constant in this project
     # sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
+    # sord warn - Parlour::Types::Type wasn't able to be resolved to a constant in this project
     # Handles SORD_ERRORs.
     # 
     # _@param_ `name`
@@ -445,6 +449,7 @@ module Sord
     end
     def self.handle_sord_error(name, log_warning, item, replace_errors_with_untyped); end
 
+    # sord warn - Parlour::Types::Type wasn't able to be resolved to a constant in this project
     # Given a YARD duck type string, attempts to convert it to one of a list of pre-defined RBS
     # built-in interfaces.
     # 

data/sord.gemspec

@@ -24,9 +24,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'yard'
   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 'commander', '~> 5.0'
+  spec.add_dependency "parser"
+  spec.add_dependency 'parlour', '~> 9.1'
+  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.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-22 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -44,42 +44,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parlour
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '9.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '9.1'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
     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