yard-sorbet 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01297d9a9e47af3e48b7aef782f9ffd60fe41476567ef1e7e986ae38a1b24880'
-  data.tar.gz: e612bbdc440d264051f58c95c744a48753d31b6ec6ea94dec928101c9612c54b
+  metadata.gz: '0877d9e7c2166c05eaf8b6e758ca07e046258053458a33cc6847b8103ba998b0'
+  data.tar.gz: 1a2ec7ab8d6e8036c53a816053e91abb117a7330fb52aaeba692a5331d2f597b
 SHA512:
-  metadata.gz: 391fb61ef58440411978c3508666fa7accd43d5987b0f80f91506bb01991aef4e1801b40c428cb2fc7bad8e1ae55dd4a13ac7a02d90a603e007aee8f306a8c86
-  data.tar.gz: 5b4749046bc5d4da734d81924de6f46de540aa2d750ad1d53e3c50723da36241aa905d75e0e888d34c3322ee15f0df8f7ea2565ef8ab249010b4d2b6b0583a24
+  metadata.gz: 8c32134d99eb150900275db0a7c34f7e3e1c08deb1c6fbee35d8303aa3ed0ad98dc1453268fc2a97a4f23fdf9c5969f2edff6bfc62ba271e8c9af70708ab385c
+  data.tar.gz: e3de167e4393f4a832e65e4d91459e17f7218423e392df25b405c0cdbf3a16e9f4ebaefd3f3ec71efc6b62330942cef98267545c7410305487efabbacf805715

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+---
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/ClassStructure:
+  Enabled: true
+# doesn't recognize sorbet magic comments
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Naming/FileName:
+  Exclude:
+    - lib/yard-sorbet.rb
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+Style/NegatedIf:
+  Enabled: false
+Style/NegatedWhile:
+  Enabled: false
+Style/Next:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+language: ruby
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# master
+
+# 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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'codecov', '~> 0.1.16'
+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/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,17 @@
+# yard-sorbet
+[![Gem Version](https://badge.fury.io/rb/yard-sorbet.svg)](https://badge.fury.io/rb/yard-sorbet)
+[![Build Status](https://travis-ci.com/dduugg/yard-sorbet.svg?branch=master)](https://travis-ci.com/dduugg/yard-sorbet)
+[![codecov](https://codecov.io/gh/dduugg/yard-sorbet/branch/master/graph/badge.svg)](https://codecov.io/gh/dduugg/yard-sorbet)
+
+A YARD [plugin](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#Plugin_Support) that parses Sorbet type annotations
+
+## Install
+
+```shell
+gem install yard-sorbet
+```
+
+## Usage
+```bash
+yard doc --plugin sorbet
+```

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :lint do
+  sh 'rubocop'
+end
+
+task default: %i[lint spec]

data/lib/yard-sorbet.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+# typed: strong
+require 'sorbet-runtime'
+require 'yard'
+
+# top-level namespace
+module YARDSorbet; end
+
+require_relative 'yard-sorbet/directives.rb'
+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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Extract & re-add directives to a docstring
+module YARDSorbet::Directives
+  def self.extract_directives(docstring)
+    parser = YARD::DocstringParser.new.parse(docstring)
+    # Directives are already parsed at this point, and there doesn't
+    # seem to be an API to tweeze them from one node to another without
+    # managing YARD internal state. Instead, we just extract them from
+    # the raw text and re-attach them.
+    directives = parser.raw_text&.split("\n")&.select do |line|
+      line.start_with?('@!')
+    end || []
+
+    [parser.to_docstring, directives]
+  end
+
+  def self.add_directives(docstring, directives)
+    directives.each do |directive|
+      docstring.concat("\n#{directive}")
+    end
+  end
+end

data/lib/yard-sorbet/sig_handler.rb

@@ -0,0 +1,131 @@
+# typed: true
+# frozen_string_literal: true
+
+# A YARD Handler for Sorbet type declarations
+class YARDSorbet::SigHandler < YARD::Handlers::Ruby::Base
+  extend T::Sig
+  handles :class, :module, :singleton_class?
+
+  sig { returns(String).checked(:never) }
+  def process
+    # Find the list of declarations inside the class
+    class_def = statement.children.find { |c| c.type == :list }
+    class_contents = class_def.children
+
+    class_contents.each_with_index do |child, i|
+      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
+      end
+    end
+  end
+
+  private def enhance_param(docstring, name, types)
+    tag = docstring.tags.find { |t| t.tag_name == 'param' && t.name == name }
+    if tag
+      docstring.delete_tag_if { |t| t == tag }
+      tag.types = types
+    else
+      tag = YARD::Tags::Tag.new(:param, '', types, name)
+    end
+    docstring.add_tag(tag)
+  end
+
+  private def enhance_tag(docstring, type, parsed_sig)
+    return if !parsed_sig[type]
+
+    tag = docstring.tags.find { |t| t.tag_name == type.to_s }
+    if tag
+      docstring.delete_tags(type)
+    else
+      tag = YARD::Tags::Tag.new(type, '')
+    end
+    if parsed_sig[type].is_a?(Array)
+      tag.types = parsed_sig[type]
+    end
+    docstring.add_tag(tag)
+  end
+
+  private def parse_sig(sig_node)
+    parsed = {}
+    parsed[:abstract] = false
+    parsed[:params] = {}
+    found_params = T.let(false, T::Boolean)
+    found_return = T.let(false, T::Boolean)
+    bfs_traverse(sig_node, exclude: %i[array hash]) do |n|
+      if n.source == 'abstract'
+        parsed[:abstract] = true
+      elsif n.source == 'params' && !found_params
+        found_params = true
+        sibling = T.must(sibling_node(n))
+        bfs_traverse(sibling, exclude: %i[array call hash]) do |p|
+          if p.type == :assoc
+            param_name = p.children.first.source[0...-1]
+            types = YARDSorbet::SigToYARD.convert(p.children.last)
+            parsed[:params][param_name] = types
+          end
+        end
+      elsif n.source == 'returns' && !found_return
+        found_return = true
+        parsed[:return] = YARDSorbet::SigToYARD.convert(T.must(sibling_node(n)))
+      elsif n.source == 'void'
+        parsed[:return] ||= ['void']
+      end
+    end
+    parsed
+  end
+
+  # Returns true if the given node is part of a type signature.
+  private def type_signature?(node)
+    loop do
+      return false if node.nil?
+      return false unless %i[call vcall fcall].include?(node.type)
+      return true if T.unsafe(node).method_name(true) == :sig
+
+      node = node.children.first
+    end
+  end
+
+  private def sibling_node(node)
+    found_sibling = T.let(false, T::Boolean)
+    node.parent.children.each do |n|
+      if found_sibling
+        return n
+      end
+
+      if n == node
+        found_sibling = true
+      end
+    end
+    nil
+  end
+
+  # @yield [YARD::Parser::Ruby::AstNode]
+  private def bfs_traverse(node, exclude: [])
+    queue = [node]
+    while !queue.empty?
+      n = T.must(queue.shift)
+      yield n
+      n.children.each do |c|
+        if !exclude.include?(c.type)
+          queue.push(c)
+        end
+      end
+    end
+  end
+end