yard-sorbet 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0877d9e7c2166c05eaf8b6e758ca07e046258053458a33cc6847b8103ba998b0'
-  data.tar.gz: 1a2ec7ab8d6e8036c53a816053e91abb117a7330fb52aaeba692a5331d2f597b
+  metadata.gz: 47fca84744393f88777d1cb1355df3ffb693e4b5edb982a5497903da1c86daf7
+  data.tar.gz: 6cd24b1d8796de8def62dcbc02383b8de27aa60a32a00b82c9d974332e1f8e36
 SHA512:
-  metadata.gz: 8c32134d99eb150900275db0a7c34f7e3e1c08deb1c6fbee35d8303aa3ed0ad98dc1453268fc2a97a4f23fdf9c5969f2edff6bfc62ba271e8c9af70708ab385c
-  data.tar.gz: e3de167e4393f4a832e65e4d91459e17f7218423e392df25b405c0cdbf3a16e9f4ebaefd3f3ec71efc6b62330942cef98267545c7410305487efabbacf805715
+  metadata.gz: d666a9079c7190e905c1c190b014037d3bf4b0bd4fa75aa74b9c2221878f82cc88b6523b5ac14af5de981e1b157452341a196145bcc28f8ebc567fae3f10eee8
+  data.tar.gz: 7635542b9b48b775050ec0e417a23fc0700326bd733ba46293592c156a9c49cb7dc2a1800e3909c1c5ae10aacb15e03142dda44e589a8a5e9fc706388da1827c

data/.rspec

@@ -1 +1,3 @@
+--format documentation
+--color
 --require spec_helper

data/.rubocop.yml

@@ -1,9 +1,12 @@
 ---
 require:
+  - rubocop-rake
   - rubocop-rspec
+  - rubocop-sorbet
 
 AllCops:
-  TargetRubyVersion: 2.4
+  NewCops: enable
+  TargetRubyVersion: 2.5
 
 Layout/ClassStructure:
   Enabled: true
@@ -29,10 +32,22 @@ Metrics/PerceivedComplexity:
 Naming/FileName:
   Exclude:
     - lib/yard-sorbet.rb
+RSpec/EmptyExampleGroup:
+  Enabled: false
 RSpec/ExampleLength:
   Enabled: false
 RSpec/MultipleExpectations:
   Enabled: false
+Sorbet/EnforceSignatures:
+  Enabled: false
+Sorbet/StrictSigil:
+  Enabled: false
+Sorbet/StrongSigil:
+  Enabled: false
+Sorbet/TrueSigil:
+  Exclude:
+    - lib/yard-sorbet/struct_handler.rb
+    - spec/**/*
 Style/AccessModifierDeclarations:
   EnforcedStyle: inline
 Style/ClassAndModuleChildren:

data/.travis.yml

@@ -1,7 +1,8 @@
 ---
 language: ruby
+cache: bundler
 rvm:
-  - 2.4
   - 2.5
   - 2.6
   - 2.7
+before_install: gem install bundler -v 2.1.4

data/.yardopts

@@ -0,0 +1,2 @@
+--plugin sorbet
+

data/CHANGELOG.md

@@ -1,10 +1,30 @@
-# master
+# Change log
 
-# 0.0.1 / 2020-01-24
+## master (unreleased)
 
-- [#1](https://github.com/dduugg/yard-sorbet/pull/1): Add `T::Struct` support.
-- [#3](https://github.com/dduugg/yard-sorbet/pull/3): Rename require path to be conistent with gem name.
+## 0.1.0 (2020-12-01)
 
-# 0.0.0 / 2020-01-05
+### New features
+
+* [#8](https://github.com/dduugg/yard-sorbet/pull/8): Add support for singleton class syntax.
+* [#7](https://github.com/dduugg/yard-sorbet/pull/7): Add support for top-level constants in sigs.
+
+### Bug fixes
+
+* [#9](https://github.com/dduugg/yard-sorbet/pull/9): Remove warning for use of `T.attached_class`.
+* [#11](https://github.com/dduugg/yard-sorbet/pull/11): Fix parsing of custom parameterized types.
+* [#12](https://github.com/dduugg/yard-sorbet/pull/12): Fix parsing of recursive custom parameterized types.
+
+### Changes
+
+* [#10](https://github.com/dduugg/yard-sorbet/pull/10): Downgrade log level of unsupported `sig` `aref` nodes.
+* Drop Ruby 2.4 support
+
+## 0.0.1 (2020-01-24)
+
+* [#1](https://github.com/dduugg/yard-sorbet/pull/1): Add `T::Struct` support.
+* [#3](https://github.com/dduugg/yard-sorbet/pull/3): Rename require path to be conistent with gem name.
+
+## 0.0.0 (2020-01-05)
 
 * Initial Release

data/Gemfile

@@ -1,14 +1,8 @@
+# typed: strong
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
 
-gem 'codecov', '~> 0.1.16'
+gemspec
+
 gem 'pry-byebug'
-gem 'rake', '~> 13.0'
-gem 'rspec', '~> 3.9'
-gem 'rubocop', '~> 0.78.0'
-gem 'rubocop-rspec', '~> 1.37'
-gem 'simplecov', '~> 0.17.1'
-gem 'sorbet', '~> 0.5.5200'
-gem 'sorbet-runtime', '~> 0.5.5200'
-gem 'yard', '~> 0.9.22'

data/Rakefile

@@ -1,11 +1,19 @@
+# typed: strong
 # frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
+desc 'Lint files with Rubocop'
 task :lint do
   sh 'rubocop'
 end
 
-task default: %i[lint spec]
+desc 'Typecheck files with Sorbet'
+task :typecheck do
+  sh 'srb tc --ignore=vendor/'
+end
+
+task default: %i[lint spec typecheck]

data/lib/yard-sorbet.rb

@@ -1,12 +1,13 @@
-# frozen_string_literal: true
 # typed: strong
+# frozen_string_literal: true
+
 require 'sorbet-runtime'
 require 'yard'
 
 # top-level namespace
 module YARDSorbet; end
 
-require_relative 'yard-sorbet/directives.rb'
+require_relative 'yard-sorbet/directives'
 require_relative 'yard-sorbet/sig_handler'
 require_relative 'yard-sorbet/sig_to_yard'
 require_relative 'yard-sorbet/struct_handler'

data/lib/yard-sorbet/directives.rb

@@ -1,5 +1,5 @@
+# typed: true
 # frozen_string_literal: true
-# typed: strict
 
 # Extract & re-add directives to a docstring
 module YARDSorbet::Directives

data/lib/yard-sorbet/sig_handler.rb

@@ -12,27 +12,43 @@ class YARDSorbet::SigHandler < YARD::Handlers::Ruby::Base
     class_def = statement.children.find { |c| c.type == :list }
     class_contents = class_def.children
 
+    process_class_contents(class_contents)
+  end
+
+  private def process_class_contents(class_contents)
     class_contents.each_with_index do |child, i|
+      if child.type == :sclass && child.children.size == 2 && child.children[1].type == :list
+        singleton_class_contents = child.children[1]
+        process_class_contents(singleton_class_contents)
+      end
       next unless type_signature?(child)
 
       next_statement = class_contents[i + 1]
-      if %i[def defs command].include?(next_statement&.type) && !next_statement.docstring
-        # Swap the method definition docstring and the sig docstring.
-        # Parse relevant parts of the `sig` and include them as well.
-        docstring, directives = YARDSorbet::Directives.extract_directives(child.docstring)
-        parsed_sig = parse_sig(child)
-        enhance_tag(docstring, :abstract, parsed_sig)
-        enhance_tag(docstring, :return, parsed_sig)
-        if next_statement.type != :command
-          parsed_sig[:params]&.each do |name, types|
-            enhance_param(docstring, name, types)
-          end
-        end
-        next_statement.docstring = docstring.to_raw
-        YARDSorbet::Directives.add_directives(next_statement.docstring, directives)
-        child.docstring = nil
+      next unless processable_method?(next_statement)
+
+      process_method_definition(next_statement, child)
+    end
+  end
+
+  private def processable_method?(next_statement)
+    %i[def defs command].include?(next_statement&.type) && !next_statement.docstring
+  end
+
+  private def process_method_definition(method_node, sig_node)
+    # Swap the method definition docstring and the sig docstring.
+    # Parse relevant parts of the `sig` and include them as well.
+    docstring, directives = YARDSorbet::Directives.extract_directives(sig_node.docstring)
+    parsed_sig = parse_sig(sig_node)
+    enhance_tag(docstring, :abstract, parsed_sig)
+    enhance_tag(docstring, :return, parsed_sig)
+    if method_node.type != :command
+      parsed_sig[:params]&.each do |name, types|
+        enhance_param(docstring, name, types)
       end
     end
+    method_node.docstring = docstring.to_raw
+    YARDSorbet::Directives.add_directives(method_node.docstring, directives)
+    sig_node.docstring = nil
   end
 
   private def enhance_param(docstring, name, types)

data/lib/yard-sorbet/sig_to_yard.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 # Translate sig type syntax to YARD type syntax.
 module YARDSorbet::SigToYARD
@@ -27,8 +27,8 @@ module YARDSorbet::SigToYARD
         value_type = convert(children.last.children.last).join(', ')
         ["Hash{#{key_type} => #{value_type}}"]
       else
-        log.warn("Unsupported sig aref node #{node.source}")
-        [node.source]
+        log.info("Unsupported sig aref node #{node.source}")
+        [build_generic_type(node)]
       end
     when :arg_paren
       convert(children.first.children.first)
@@ -40,7 +40,7 @@ module YARDSorbet::SigToYARD
       if children[0].source == 'T'
         t_method = IS_LEGACY_RUBY_VERSION ? children[1].source : children[2].source
         case t_method
-        when 'all', 'class_of', 'enum', 'noreturn', 'self_type', 'type_parameter', 'untyped'
+        when 'all', 'attached_class', 'class_of', 'enum', 'noreturn', 'self_type', 'type_parameter', 'untyped'
           # YARD doesn't have equivalent notions, so we just use the raw source
           [node.source]
         when 'any'
@@ -56,7 +56,7 @@ module YARDSorbet::SigToYARD
       else
         [node.source]
       end
-    when :const_path_ref
+    when :const_path_ref, :const
       case node.source
       when 'T::Boolean'
         ['Boolean'] # YARD convention for booleans
@@ -83,9 +83,24 @@ module YARDSorbet::SigToYARD
       else
         [node.source]
       end
+    when :top_const_ref
+      # A top-level constant reference, such as ::Klass
+      # It contains a child node of type :const
+      convert(children.first)
     else
       log.warn("Unsupported sig #{node.type} node #{node.source}")
       [node.source]
     end
   end
+
+  def self.build_generic_type(node)
+    return node.source if node.children.empty? || node.type != :aref
+
+    collection_type = node.children.first.source
+    member_type = node.children.last.children
+                      .map { |child| build_generic_type(child) }
+                      .join(', ')
+
+    "#{collection_type}[#{member_type}]"
+  end
 end

data/lib/yard-sorbet/struct_handler.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 # Handle all `const` calls, creating accessor methods, and compiles them for later usage at the class level
@@ -30,8 +31,6 @@ class YARDSorbet::StructHandler < YARD::Handlers::Ruby::Base
     object = MethodObject.new(namespace, name, scope)
     object.source = source
 
-    register(object)
-
     reader_docstring = doc.empty? ? "Returns the value of attribute +#{name}+." : doc
     docstring = YARD::DocstringParser.new.parse(reader_docstring).to_docstring
     docstring.add_tag(YARD::Tags::Tag.new(:return, '', types))

data/lib/yard-sorbet/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module YARDSorbet
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/yard-sorbet.gemspec

@@ -1,27 +1,39 @@
+# typed: strong
 # frozen_string_literal: true
 
 require_relative 'lib/yard-sorbet/version'
 
 Gem::Specification.new do |spec|
   spec.name = 'yard-sorbet'
+  spec.version = YARDSorbet::VERSION
   spec.author = 'Douglas Eichelberger'
-  spec.files = `git ls-files`.strip.split(/\s+/)
+  spec.email = 'dduugg@gmail.com'
+  spec.license = 'Apache-2.0'
+
   spec.summary = 'Create YARD docs from Sorbet type signatures'
-  spec.version = YARDSorbet::VERSION
   spec.description = <<~DESC
     A YARD plugin that incorporates Sorbet type information
   DESC
-  spec.email = 'dduugg@gmail.com'
   spec.homepage = 'https://github.com/dduugg/yard-sorbet'
-  spec.license = 'Apache-2.0'
-  spec.add_development_dependency 'codecov', '~> 0.1.16'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/dduugg/yard-sorbet/blob/master/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(sorbet|spec)/}) }
+  end
+
+  spec.add_development_dependency 'codecov', '~> 0.2.12'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'rubocop', '~> 0.78.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
-  spec.add_development_dependency 'simplecov', '~> 0.17.1'
-  spec.add_development_dependency 'sorbet', '~> 0.5.5200'
-  spec.add_runtime_dependency 'sorbet-runtime', '~> 0.5'
-  spec.add_runtime_dependency 'yard', '~> 0.9'
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.5.0'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.0.0'
+  spec.add_development_dependency 'rubocop-sorbet', '~> 0.5.1'
+  spec.add_development_dependency 'simplecov', '~> 0.20.0'
+  spec.add_development_dependency 'sorbet', '~> 0.5.6083'
+  spec.add_runtime_dependency 'sorbet-runtime', '>= 0.5'
+  spec.add_runtime_dependency 'yard', '>= 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Douglas Eichelberger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.12
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,96 +44,124 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5200
+        version: 0.5.6083
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5200
+        version: 0.5.6083
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
 description: 'A YARD plugin that incorporates Sorbet type information
@@ -149,6 +177,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -160,50 +189,15 @@ files:
 - lib/yard-sorbet/sig_to_yard.rb
 - lib/yard-sorbet/struct_handler.rb
 - lib/yard-sorbet/version.rb
-- sorbet/config
-- sorbet/rbi/gems/ast.rbi
-- sorbet/rbi/gems/byebug.rbi
-- sorbet/rbi/gems/codecov.rbi
-- sorbet/rbi/gems/coderay.rbi
-- sorbet/rbi/gems/docile.rbi
-- sorbet/rbi/gems/jaro_winkler.rbi
-- sorbet/rbi/gems/method_source.rbi
-- sorbet/rbi/gems/parallel.rbi
-- sorbet/rbi/gems/parser.rbi
-- sorbet/rbi/gems/pry-byebug.rbi
-- sorbet/rbi/gems/pry.rbi
-- sorbet/rbi/gems/rainbow.rbi
-- sorbet/rbi/gems/rake.rbi
-- sorbet/rbi/gems/rspec-core.rbi
-- sorbet/rbi/gems/rspec-expectations.rbi
-- sorbet/rbi/gems/rspec-mocks.rbi
-- sorbet/rbi/gems/rspec-support.rbi
-- sorbet/rbi/gems/rspec.rbi
-- sorbet/rbi/gems/rubocop-rspec.rbi
-- sorbet/rbi/gems/rubocop.rbi
-- sorbet/rbi/gems/ruby-progressbar.rbi
-- sorbet/rbi/gems/simplecov-html.rbi
-- sorbet/rbi/gems/simplecov.rbi
-- sorbet/rbi/gems/site_ruby.rbi
-- sorbet/rbi/gems/unicode-display_width.rbi
-- sorbet/rbi/gems/yard.rbi
-- sorbet/rbi/hidden-definitions/errors.txt
-- sorbet/rbi/hidden-definitions/hidden.rbi
-- sorbet/rbi/sorbet-typed/lib/bundler/all/bundler.rbi
-- sorbet/rbi/sorbet-typed/lib/ruby/all/gem.rbi
-- sorbet/rbi/sorbet-typed/lib/ruby/all/open3.rbi
-- sorbet/rbi/sorbet-typed/lib/ruby/all/resolv.rbi
-- spec/data/sig_handler.rb.txt
-- spec/data/struct_handler.rb.txt
-- spec/spec_helper.rb
-- spec/yard_sorbet/sig_handler_spec.rb
-- spec/yard_sorbet/struct_handler_spec.rb
 - yard-sorbet.gemspec
 homepage: https://github.com/dduugg/yard-sorbet
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/dduugg/yard-sorbet
+  source_code_uri: https://github.com/dduugg/yard-sorbet
+  changelog_uri: https://github.com/dduugg/yard-sorbet/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -211,15 +205,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Create YARD docs from Sorbet type signatures
 test_files: []