yard-sorbet 0.0.1 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/.rspec +2 -0
  3. data/.rubocop.yml +16 -1
  4. data/.travis.yml +2 -1
  5. data/.yardopts +2 -0
  6. data/CHANGELOG.md +25 -5
  7. data/Gemfile +3 -9
  8. data/Rakefile +9 -1
  9. data/lib/yard-sorbet.rb +3 -2
  10. data/lib/yard-sorbet/directives.rb +1 -1
  11. data/lib/yard-sorbet/sig_handler.rb +31 -15
  12. data/lib/yard-sorbet/sig_to_yard.rb +20 -5
  13. data/lib/yard-sorbet/struct_handler.rb +1 -2
  14. data/lib/yard-sorbet/version.rb +1 -1
  15. data/yard-sorbet.gemspec +25 -13
  16. metadata +56 -62
  17. data/sorbet/config +0 -2
  18. data/sorbet/rbi/gems/ast.rbi +0 -47
  19. data/sorbet/rbi/gems/byebug.rbi +0 -1039
  20. data/sorbet/rbi/gems/codecov.rbi +0 -19
  21. data/sorbet/rbi/gems/coderay.rbi +0 -91
  22. data/sorbet/rbi/gems/docile.rbi +0 -31
  23. data/sorbet/rbi/gems/jaro_winkler.rbi +0 -14
  24. data/sorbet/rbi/gems/method_source.rbi +0 -63
  25. data/sorbet/rbi/gems/parallel.rbi +0 -81
  26. data/sorbet/rbi/gems/parser.rbi +0 -920
  27. data/sorbet/rbi/gems/pry-byebug.rbi +0 -149
  28. data/sorbet/rbi/gems/pry.rbi +0 -1964
  29. data/sorbet/rbi/gems/rainbow.rbi +0 -117
  30. data/sorbet/rbi/gems/rake.rbi +0 -635
  31. data/sorbet/rbi/gems/rspec-core.rbi +0 -1686
  32. data/sorbet/rbi/gems/rspec-expectations.rbi +0 -387
  33. data/sorbet/rbi/gems/rspec-mocks.rbi +0 -819
  34. data/sorbet/rbi/gems/rspec-support.rbi +0 -270
  35. data/sorbet/rbi/gems/rspec.rbi +0 -14
  36. data/sorbet/rbi/gems/rubocop-rspec.rbi +0 -889
  37. data/sorbet/rbi/gems/rubocop.rbi +0 -7139
  38. data/sorbet/rbi/gems/ruby-progressbar.rbi +0 -304
  39. data/sorbet/rbi/gems/simplecov-html.rbi +0 -30
  40. data/sorbet/rbi/gems/simplecov.rbi +0 -225
  41. data/sorbet/rbi/gems/site_ruby.rbi +0 -114
  42. data/sorbet/rbi/gems/unicode-display_width.rbi +0 -16
  43. data/sorbet/rbi/gems/yard.rbi +0 -1181
  44. data/sorbet/rbi/hidden-definitions/errors.txt +0 -3045
  45. data/sorbet/rbi/hidden-definitions/hidden.rbi +0 -4469
  46. data/sorbet/rbi/sorbet-typed/lib/bundler/all/bundler.rbi +0 -8684
  47. data/sorbet/rbi/sorbet-typed/lib/ruby/all/gem.rbi +0 -4222
  48. data/sorbet/rbi/sorbet-typed/lib/ruby/all/open3.rbi +0 -111
  49. data/sorbet/rbi/sorbet-typed/lib/ruby/all/resolv.rbi +0 -543
  50. data/spec/data/sig_handler.rb.txt +0 -196
  51. data/spec/data/struct_handler.rb.txt +0 -25
  52. data/spec/spec_helper.rb +0 -111
  53. data/spec/yard_sorbet/sig_handler_spec.rb +0 -233
  54. data/spec/yard_sorbet/struct_handler_spec.rb +0 -48
@@ -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