sord 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf3418f5f5f96e17c76ee48515382ac008d975ed200eae3f837f9e136077a7f3
-  data.tar.gz: 2592ad90c6b6c17ec9a9c550d348a3989b4511a51b2b115643dafa05b41e9191
+  metadata.gz: 9a20a16fb8b21d103c934ed6f4846db387ab40174ebe9468b33ec70b82c8c883
+  data.tar.gz: 235f786ea4950554c1c78a9887c40218efdb1cafdf2b281ca5d923af2130eaf5
 SHA512:
-  metadata.gz: 4db0db07817d59efdceb9455cbf3613d4d6031d635fc40ad6dd310ad0828a6b8a6be35c6cd7e9cfa11d3cb7ab23496c851686027a82f5e6f55c034420a9c98a2
-  data.tar.gz: b00f3f123af693111782b734ce72d00930613408f113197bcddd182c6b36308b8f6b9e7d3cc2e0bc7a7ed15bb666aec93a9da7d2e7f9595e601ff51b7e16866a
+  metadata.gz: e4c45eef8d708353b0a1817b273c7a548799fed3380e5ad76a0744e6c51b02d9b5d139e31a9aac49bfafc9936a4cecf8f0098a9911b2cda556b9c8456bb3cde9
+  data.tar.gz: 47f885d8222de2169f987e603cc46b949475046439a7d7e7e312ecb09e9d1510459a59e1621622e967d185b5855cdd5face4a984cf825a1a17256e7ed0876186

data/Gemfile

@@ -2,5 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in sord.gemspec
 gemspec
-
-gem "commander", "~> 4.4"

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    sord (0.3.0)
+    sord (0.4.1)
       colorize
+      commander (~> 4.4)
       sorbet-runtime
       yard
 
@@ -37,7 +38,7 @@ GEM
     simplecov-html (0.10.2)
     sorbet (0.4.4254)
       sorbet-static (= 0.4.4254)
-    sorbet-runtime (0.4.4293)
+    sorbet-runtime (0.4.4294)
     sorbet-static (0.4.4254-x86_64-linux)
     yard (0.9.19)
 
@@ -46,7 +47,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  commander (~> 4.4)
   rake (~> 10.0)
   rspec (~> 3.0)
   simplecov

data/lib/sord/logging.rb

@@ -53,6 +53,17 @@ module Sord
       generic(:warn, '[WARN ]'.yellow, msg, item)
     end
 
+    # Print a duck-typing message. This should be used when the YARD 
+    # documentation contains duck typing, which isn't supported by Sorbet, so
+    # it is substituted for something different.
+    # @param [String] msg The log message to write.
+    # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
+    #  is associated with, if any. This is shown before the log message if it is
+    #  specified.
+    def self.duck(msg, item=nil)
+      generic(:ducl, '[DUCK ]'.cyan, msg, item)
+    end
+
     # Print an error message. This should be used for things which require the
     # current process to stop.
     # @param [String] msg The log message to write.

data/lib/sord/rbi_generator.rb

@@ -75,16 +75,17 @@ module Sord
 
         # This is better than iterating over YARD's "@param" tags directly 
         # because it includes parameters without documentation
+        # (The gsubs allow for better splat-argument compatibility)
         parameter_names_to_tags = meth.parameters.map do |name, _|
-          [name, meth.tags('param').find { |p| p.name == name }]
+          [name, meth.tags('param')
+            .find { |p| p.name.gsub('*', '') == name.gsub('*', '') }]
         end.to_h
 
         sig_params_list = parameter_names_to_tags.map do |name, tag|
+          name = name.gsub('*', '')
+
           if tag
             "#{name}: #{TypeConverter.yard_to_sorbet(tag.types, meth)}"
-          elsif name.start_with? '*'
-            # TODO: is there a YARD definition for this?
-            "args: T::Array[T.any]"
           elsif name.start_with? '&'
             # Cut the ampersand from the block parameter name.
             "#{name[1..-1]}: T.untyped"

data/lib/sord/type_converter.rb

@@ -11,12 +11,14 @@ module Sord
 
     # A regular expression which matches a Ruby namespace immediately followed
     # by another Ruby namespace in angle brackets. This is the format usually
-    # used in YARD to model generic types, such as "Array<String>".
+    # used in YARD to model generic types, such as "Array<String>",
+    # "Hash<String, Symbol>", "Hash{String => Symbol}", etc.
     GENERIC_TYPE_REGEX =
-      /(#{SIMPLE_TYPE_REGEX})\s*<\s*(.*)\s*>/
+      /(#{SIMPLE_TYPE_REGEX})\s*[<{]\s*(.*)\s*[>}]/
 
     # An array of built-in generic types supported by Sorbet.
     SORBET_SUPPORTED_GENERIC_TYPES = %w{Array Set Enumerable Enumerator Range Hash}
+    SORBET_SINGLE_ARG_GENERIC_TYPES = %w{Array Set Enumerable Enumerator Range}
 
     # Given a string of YARD type parameters (without angle brackets), splits
     # the string into an array of each type parameter.
@@ -31,10 +33,15 @@ module Sord
       while character_pointer < params.length
         should_buffer = true
 
-        current_bracketing_level += 1 if params[character_pointer] == ?<
-        current_bracketing_level -= 1 if params[character_pointer] == ?>
+        current_bracketing_level += 1 if ['<', '{'].include?(params[character_pointer])
+        # Decrease bracketing level by 1 when encountering `>` or `}`, unless
+        # the previous character is `=` (to prevent hash rockets from causing
+        # nesting problems).
+        current_bracketing_level -= 1 if ['>', '}'].include?(params[character_pointer]) && params[character_pointer - 1] != '='
 
-        if params[character_pointer] == ?,
+        # Handle commas as separators.
+        # e.g. Hash<Symbol, String>
+        if params[character_pointer] == ','
           if current_bracketing_level == 0
             result << buffer.strip
             buffer = ""
@@ -42,6 +49,17 @@ module Sord
           end
         end
 
+        # Handle hash rockets as separators.
+        # e.g. Hash<Symbol => String>
+        if params[character_pointer] == '=' && params[character_pointer + 1] == '>'
+          if current_bracketing_level == 0
+            character_pointer += 1
+            result << buffer.strip
+            buffer = ""
+            should_buffer = false
+          end
+        end
+
         buffer += params[character_pointer] if should_buffer
         character_pointer += 1
       end
@@ -80,13 +98,21 @@ module Sord
           Logging.warn("#{yard} is probably not a type, but using anyway", item)
         end
         yard
+      when /^\##{SIMPLE_TYPE_REGEX}$/
+        Logging.duck("#{yard} looks like a duck type, replacing with T.untyped", item)
+        'T.untyped'
       when /^#{GENERIC_TYPE_REGEX}$/
         generic_type = $1
         type_parameters = $2
 
         if SORBET_SUPPORTED_GENERIC_TYPES.include?(generic_type)
-          "T::#{generic_type}[#{
-            split_type_parameters(type_parameters).map { |x| yard_to_sorbet(x, item) }.join(', ')}]"
+          parameters = split_type_parameters(type_parameters)
+            .map { |x| yard_to_sorbet(x, item) }
+          if SORBET_SINGLE_ARG_GENERIC_TYPES.include?(generic_type) && parameters.length > 1
+            "T::#{generic_type}[T.any(#{parameters.join(', ')})]"
+          else
+            "T::#{generic_type}[#{parameters.join(', ')}]"
+          end
         else
           Logging.warn("unsupported generic type #{generic_type.inspect} in #{yard.inspect}", item)
           "SORD_ERROR_#{generic_type.gsub(/[^0-9A-Za-z_]/i, '')}"
@@ -97,4 +123,4 @@ module Sord
       end
     end
   end
-end
+end

data/lib/sord/version.rb

@@ -1,4 +1,4 @@
 # typed: strong
 module Sord
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/sord.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'yard'
   spec.add_dependency 'sorbet-runtime'
   spec.add_dependency 'colorize'
+  spec.add_dependency 'commander', '~> 4.4'
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sord
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Aaron Christiansen
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement