yard-sorbet 0.0.0 → 0.0.1

data/spec/yard_sorbet/struct_handler_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'yard'
+
+RSpec.describe YARDSorbet::StructHandler do
+  before do
+    YARD::Registry.clear
+    path = File.join(
+      File.expand_path('../data', __dir__),
+      'struct_handler.rb.txt'
+    )
+    YARD::Parser::SourceParser.parse(path)
+  end
+
+  describe 'constructor' do
+    it 'has the appropriate parameters' do
+      node = YARD::Registry.at('PersonStruct#initialize')
+      expect(node.parameters).to eq([['name:', nil], ['age:', nil], ['optional:', 'nil'], ['mystery:', nil]])
+    end
+
+    it 'uses the docstring from an explicit initializer' do
+      node = YARD::Registry.at('SpecializedPersonStruct#initialize')
+      expect(node.docstring).to eq('This is a special intializer')
+    end
+  end
+
+  describe 'attributes' do
+    it 'creates accessor method docs' do
+      node = YARD::Registry.at('PersonStruct#optional')
+      expect(node.tag(:return).types).to eq(%w[String nil])
+    end
+
+    it 'attaches the docstring to the accessor' do
+      node = YARD::Registry.at('PersonStruct#age')
+      expect(node.docstring).to eq('An age')
+    end
+
+    it 'creates a docstring if it does not exist' do
+      node = YARD::Registry.at('PersonStruct#mystery')
+      expect(node.docstring).to eq('Returns the value of attribute +mystery+.')
+    end
+
+    it 'handles default values appropriately' do
+      node = YARD::Registry.at('DefaultPersonStruct#initialize')
+      expect(node.parameters).to eq([['defaulted:', "'hello'"]])
+    end
+  end
+end

data/yard-sorbet.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'lib/yard-sorbet/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'yard-sorbet'
+  spec.author = 'Douglas Eichelberger'
+  spec.files = `git ls-files`.strip.split(/\s+/)
+  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.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'
+end

metadata

@@ -1,29 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Douglas Eichelberger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-01-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.16
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.78.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.78.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5200
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5200
+- !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
@@ -45,7 +143,62 @@ email: dduugg@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yard-sorbet.rb
+- lib/yard-sorbet/directives.rb
+- lib/yard-sorbet/sig_handler.rb
+- 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
@@ -65,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Create YARD docs from Sorbet type signatures