yard-sorbet 0.0.1 → 0.4.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. checksums.yaml +4 -4
  2. data/lib/yard-sorbet.rb +4 -2
  3. data/lib/yard-sorbet/directives.rb +5 -1
  4. data/lib/yard-sorbet/sig_handler.rb +81 -32
  5. data/lib/yard-sorbet/sig_to_yard.rb +26 -6
  6. data/lib/yard-sorbet/struct_handler.rb +27 -11
  7. data/lib/yard-sorbet/version.rb +1 -1
  8. metadata +76 -79
  9. data/.editorconfig +0 -9
  10. data/.gitignore +0 -40
  11. data/.rspec +0 -1
  12. data/.rubocop.yml +0 -47
  13. data/.travis.yml +0 -7
  14. data/CHANGELOG.md +0 -10
  15. data/Gemfile +0 -14
  16. data/README.md +0 -17
  17. data/Rakefile +0 -11
  18. data/sorbet/config +0 -2
  19. data/sorbet/rbi/gems/ast.rbi +0 -47
  20. data/sorbet/rbi/gems/byebug.rbi +0 -1039
  21. data/sorbet/rbi/gems/codecov.rbi +0 -19
  22. data/sorbet/rbi/gems/coderay.rbi +0 -91
  23. data/sorbet/rbi/gems/docile.rbi +0 -31
  24. data/sorbet/rbi/gems/jaro_winkler.rbi +0 -14
  25. data/sorbet/rbi/gems/method_source.rbi +0 -63
  26. data/sorbet/rbi/gems/parallel.rbi +0 -81
  27. data/sorbet/rbi/gems/parser.rbi +0 -920
  28. data/sorbet/rbi/gems/pry-byebug.rbi +0 -149
  29. data/sorbet/rbi/gems/pry.rbi +0 -1964
  30. data/sorbet/rbi/gems/rainbow.rbi +0 -117
  31. data/sorbet/rbi/gems/rake.rbi +0 -635
  32. data/sorbet/rbi/gems/rspec-core.rbi +0 -1686
  33. data/sorbet/rbi/gems/rspec-expectations.rbi +0 -387
  34. data/sorbet/rbi/gems/rspec-mocks.rbi +0 -819
  35. data/sorbet/rbi/gems/rspec-support.rbi +0 -270
  36. data/sorbet/rbi/gems/rspec.rbi +0 -14
  37. data/sorbet/rbi/gems/rubocop-rspec.rbi +0 -889
  38. data/sorbet/rbi/gems/rubocop.rbi +0 -7139
  39. data/sorbet/rbi/gems/ruby-progressbar.rbi +0 -304
  40. data/sorbet/rbi/gems/simplecov-html.rbi +0 -30
  41. data/sorbet/rbi/gems/simplecov.rbi +0 -225
  42. data/sorbet/rbi/gems/site_ruby.rbi +0 -114
  43. data/sorbet/rbi/gems/unicode-display_width.rbi +0 -16
  44. data/sorbet/rbi/gems/yard.rbi +0 -1181
  45. data/sorbet/rbi/hidden-definitions/errors.txt +0 -3045
  46. data/sorbet/rbi/hidden-definitions/hidden.rbi +0 -4469
  47. data/sorbet/rbi/sorbet-typed/lib/bundler/all/bundler.rbi +0 -8684
  48. data/sorbet/rbi/sorbet-typed/lib/ruby/all/gem.rbi +0 -4222
  49. data/sorbet/rbi/sorbet-typed/lib/ruby/all/open3.rbi +0 -111
  50. data/sorbet/rbi/sorbet-typed/lib/ruby/all/resolv.rbi +0 -543
  51. data/spec/data/sig_handler.rb.txt +0 -196
  52. data/spec/data/struct_handler.rb.txt +0 -25
  53. data/spec/spec_helper.rb +0 -111
  54. data/spec/yard_sorbet/sig_handler_spec.rb +0 -233
  55. data/spec/yard_sorbet/struct_handler_spec.rb +0 -48
  56. data/yard-sorbet.gemspec +0 -27
@@ -1,48 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'yard'
4
-
5
- RSpec.describe YARDSorbet::StructHandler do
6
- before do
7
- YARD::Registry.clear
8
- path = File.join(
9
- File.expand_path('../data', __dir__),
10
- 'struct_handler.rb.txt'
11
- )
12
- YARD::Parser::SourceParser.parse(path)
13
- end
14
-
15
- describe 'constructor' do
16
- it 'has the appropriate parameters' do
17
- node = YARD::Registry.at('PersonStruct#initialize')
18
- expect(node.parameters).to eq([['name:', nil], ['age:', nil], ['optional:', 'nil'], ['mystery:', nil]])
19
- end
20
-
21
- it 'uses the docstring from an explicit initializer' do
22
- node = YARD::Registry.at('SpecializedPersonStruct#initialize')
23
- expect(node.docstring).to eq('This is a special intializer')
24
- end
25
- end
26
-
27
- describe 'attributes' do
28
- it 'creates accessor method docs' do
29
- node = YARD::Registry.at('PersonStruct#optional')
30
- expect(node.tag(:return).types).to eq(%w[String nil])
31
- end
32
-
33
- it 'attaches the docstring to the accessor' do
34
- node = YARD::Registry.at('PersonStruct#age')
35
- expect(node.docstring).to eq('An age')
36
- end
37
-
38
- it 'creates a docstring if it does not exist' do
39
- node = YARD::Registry.at('PersonStruct#mystery')
40
- expect(node.docstring).to eq('Returns the value of attribute +mystery+.')
41
- end
42
-
43
- it 'handles default values appropriately' do
44
- node = YARD::Registry.at('DefaultPersonStruct#initialize')
45
- expect(node.parameters).to eq([['defaulted:', "'hello'"]])
46
- end
47
- end
48
- end
data/yard-sorbet.gemspec DELETED
@@ -1,27 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative 'lib/yard-sorbet/version'
4
-
5
- Gem::Specification.new do |spec|
6
- spec.name = 'yard-sorbet'
7
- spec.author = 'Douglas Eichelberger'
8
- spec.files = `git ls-files`.strip.split(/\s+/)
9
- spec.summary = 'Create YARD docs from Sorbet type signatures'
10
- spec.version = YARDSorbet::VERSION
11
- spec.description = <<~DESC
12
- A YARD plugin that incorporates Sorbet type information
13
- DESC
14
- spec.email = 'dduugg@gmail.com'
15
- spec.homepage = 'https://github.com/dduugg/yard-sorbet'
16
- spec.license = 'Apache-2.0'
17
- spec.add_development_dependency 'codecov', '~> 0.1.16'
18
- spec.add_development_dependency 'rake', '~> 13.0'
19
- spec.add_development_dependency 'rspec', '~> 3.9'
20
- spec.add_development_dependency 'rubocop', '~> 0.78.0'
21
- spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
22
- spec.add_development_dependency 'simplecov', '~> 0.17.1'
23
- spec.add_development_dependency 'sorbet', '~> 0.5.5200'
24
- spec.add_runtime_dependency 'sorbet-runtime', '~> 0.5'
25
- spec.add_runtime_dependency 'yard', '~> 0.9'
26
- spec.required_ruby_version = '>= 2.4.0'
27
- end