mangrove 0.24.0 → 0.30.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +32 -5
  3. data/lib/mangrove/result.rb +73 -64
  4. data/lib/mangrove/version.rb +1 -1
  5. data/rbi/mangrove.rbi +20 -0
  6. data/sorbet/rbi/annotations/rainbow.rbi +3 -3
  7. data/sorbet/rbi/gems/{diff-lcs@1.5.0.rbi → diff-lcs@1.5.1.rbi} +100 -48
  8. data/sorbet/rbi/gems/{io-console@0.6.0.rbi → io-console@0.7.2.rbi} +1 -0
  9. data/sorbet/rbi/gems/{json@2.6.3.rbi → json@2.7.2.rbi} +95 -74
  10. data/sorbet/rbi/gems/{parallel@1.23.0.rbi → parallel@1.24.0.rbi} +9 -1
  11. data/sorbet/rbi/gems/{parser@3.2.2.4.rbi → parser@3.3.2.0.rbi} +1267 -1282
  12. data/sorbet/rbi/gems/prism@0.29.0.rbi +37987 -0
  13. data/sorbet/rbi/gems/{psych@5.1.1.1.rbi → psych@5.1.2.rbi} +231 -267
  14. data/sorbet/rbi/gems/{racc@1.7.1.rbi → racc@1.8.0.rbi} +37 -36
  15. data/sorbet/rbi/gems/{rake@13.0.6.rbi → rake@13.2.1.rbi} +217 -73
  16. data/sorbet/rbi/gems/{rbi@0.1.3.rbi → rbi@0.1.13.rbi} +322 -166
  17. data/sorbet/rbi/gems/{rdoc@6.6.0.rbi → rdoc@6.7.0.rbi} +735 -685
  18. data/sorbet/rbi/gems/{regexp_parser@2.8.2.rbi → regexp_parser@2.9.2.rbi} +192 -169
  19. data/sorbet/rbi/gems/{reline@0.4.0.rbi → reline@0.5.8.rbi} +1 -0
  20. data/sorbet/rbi/gems/{rexml@3.2.6.rbi → rexml@3.2.8.rbi} +122 -109
  21. data/sorbet/rbi/gems/{rspec-core@3.12.2.rbi → rspec-core@3.13.0.rbi} +400 -300
  22. data/sorbet/rbi/gems/{rspec-expectations@3.12.3.rbi → rspec-expectations@3.13.0.rbi} +173 -119
  23. data/sorbet/rbi/gems/{rspec-mocks@3.12.6.rbi → rspec-mocks@3.13.1.rbi} +195 -160
  24. data/sorbet/rbi/gems/{rspec-support@3.12.1.rbi → rspec-support@3.13.1.rbi} +319 -298
  25. data/sorbet/rbi/gems/{rspec@3.12.0.rbi → rspec@3.13.0.rbi} +23 -22
  26. data/sorbet/rbi/gems/ruboclean@0.6.0.rbi +315 -0
  27. data/sorbet/rbi/gems/{rubocop-ast@1.29.0.rbi → rubocop-ast@1.31.3.rbi} +348 -285
  28. data/sorbet/rbi/gems/{rubocop-capybara@2.19.0.rbi → rubocop-capybara@2.20.0.rbi} +148 -65
  29. data/sorbet/rbi/gems/{rubocop-factory_bot@2.24.0.rbi → rubocop-factory_bot@2.25.1.rbi} +70 -20
  30. data/sorbet/rbi/gems/{rubocop-rspec@2.24.1.rbi → rubocop-rspec@2.30.0.rbi} +678 -389
  31. data/sorbet/rbi/gems/rubocop-rspec_rails@2.28.3.rbi +911 -0
  32. data/sorbet/rbi/gems/{rubocop@1.57.1.rbi → rubocop@1.64.1.rbi} +3225 -1915
  33. data/sorbet/rbi/gems/{ruby-lsp@0.12.0.rbi → ruby-lsp@0.17.2.rbi} +1 -0
  34. data/sorbet/rbi/gems/{spoom@1.2.4.rbi → spoom@1.3.2.rbi} +1057 -413
  35. data/sorbet/rbi/gems/strscan@3.1.0.rbi +9 -0
  36. data/sorbet/rbi/gems/{tapioca@0.11.10.rbi → tapioca@0.14.3.rbi} +268 -234
  37. data/sorbet/rbi/gems/{thor@1.3.0.rbi → thor@1.3.1.rbi} +57 -50
  38. data/sorbet/rbi/gems/{yard@0.9.34.rbi → yard@0.9.36.rbi} +154 -82
  39. metadata +38 -38
  40. data/sorbet/rbi/gems/base64@0.1.1.rbi +0 -172
  41. data/sorbet/rbi/gems/irb@1.9.0.rbi +0 -342
  42. data/sorbet/rbi/gems/prettier_print@1.2.1.rbi +0 -951
  43. data/sorbet/rbi/gems/prism@0.15.1.rbi +0 -23922
  44. data/sorbet/rbi/gems/ruboclean@0.4.0.rbi +0 -189
  45. data/sorbet/rbi/gems/syntax_tree@6.2.0.rbi +0 -23136
  46. /data/sorbet/rbi/gems/{stringio@3.0.9.rbi → stringio@3.1.0.rbi} +0 -0
@@ -4,6 +4,7 @@
4
4
  # This is an autogenerated file for types exported from the `yard` gem.
5
5
  # Please instead update this file by running `bin/tapioca gem yard`.
6
6
 
7
+
7
8
  # source://yard//lib/yard.rb#61
8
9
  ::RUBY18 = T.let(T.unsafe(nil), FalseClass)
9
10
 
@@ -503,7 +504,7 @@ end
503
504
  # A subclass of Hash where all keys are converted into Symbols, and
504
505
  # optionally, all String values are converted into Symbols.
505
506
  #
506
- # source://yard//lib/yard/core_ext/symbol_hash.rb#8
507
+ # source://yard//lib/yard/core_ext/symbol_hash.rb#4
507
508
  class SymbolHash < ::Hash
508
509
  # Creates a new SymbolHash object
509
510
  #
@@ -590,6 +591,28 @@ class SymbolHash < ::Hash
590
591
  end
591
592
  end
592
593
 
594
+ # @private
595
+ #
596
+ # source://yard//lib/yard/server/webrick_adapter.rb#42
597
+ class WEBrick::HTTPRequest
598
+ # Returns the value of attribute version_supplied.
599
+ #
600
+ # source://yard//lib/yard/server/webrick_adapter.rb#43
601
+ def version_supplied; end
602
+
603
+ # Sets the attribute version_supplied
604
+ #
605
+ # @param value the value to set the attribute version_supplied to.
606
+ #
607
+ # source://yard//lib/yard/server/webrick_adapter.rb#43
608
+ def version_supplied=(_arg0); end
609
+
610
+ # @return [Boolean]
611
+ #
612
+ # source://yard//lib/yard/server/webrick_adapter.rb#44
613
+ def xhr?; end
614
+ end
615
+
593
616
  # Gem::YARDoc provides methods to generate YARDoc and yri data for installed gems
594
617
  # upon gem installation.
595
618
  #
@@ -808,7 +831,7 @@ end
808
831
  #
809
832
  # @since 0.6.2
810
833
  #
811
- # source://yard//lib/yard/cli/config.rb#7
834
+ # source://yard//lib/yard/cli/config.rb#6
812
835
  class YARD::CLI::Config < ::YARD::CLI::Command
813
836
  # @return [Config] a new instance of Config
814
837
  # @since 0.6.2
@@ -1129,7 +1152,7 @@ end
1129
1152
  # @see Graph#run
1130
1153
  # @since 0.6.0
1131
1154
  #
1132
- # source://yard//lib/yard/cli/graph.rb#27
1155
+ # source://yard//lib/yard/cli/graph.rb#24
1133
1156
  class YARD::CLI::Graph < ::YARD::CLI::YardoptsCommand
1134
1157
  # Creates a new instance of the command-line utility
1135
1158
  #
@@ -1189,7 +1212,7 @@ end
1189
1212
 
1190
1213
  # Options to pass to the {Graph} CLI.
1191
1214
  #
1192
- # source://yard//lib/yard/cli/graph.rb#6
1215
+ # source://yard//lib/yard/cli/graph.rb#5
1193
1216
  class YARD::CLI::GraphOptions < ::YARD::Templates::TemplateOptions
1194
1217
  # @return [String] any contents to pass to the digraph
1195
1218
  #
@@ -1329,7 +1352,7 @@ end
1329
1352
  #
1330
1353
  # @since 0.6.0
1331
1354
  #
1332
- # source://yard//lib/yard/cli/server.rb#8
1355
+ # source://yard//lib/yard/cli/server.rb#7
1333
1356
  class YARD::CLI::Server < ::YARD::CLI::Command
1334
1357
  # Creates a new instance of the Server command line utility
1335
1358
  #
@@ -1632,7 +1655,7 @@ YARD::CLI::Stats::STATS_ORDER = T.let(T.unsafe(nil), Array)
1632
1655
 
1633
1656
  # A tool to view documentation in the console like `ri`
1634
1657
  #
1635
- # source://yard//lib/yard/cli/yri.rb#9
1658
+ # source://yard//lib/yard/cli/yri.rb#7
1636
1659
  class YARD::CLI::YRI < ::YARD::CLI::Command
1637
1660
  # @return [YRI] a new instance of YRI
1638
1661
  #
@@ -1762,7 +1785,7 @@ YARD::CLI::YRI::DEFAULT_SEARCH_PATHS = T.let(T.unsafe(nil), Array)
1762
1785
  # source://yard//lib/yard/cli/yri.rb#15
1763
1786
  YARD::CLI::YRI::SEARCH_PATHS_FILE = T.let(T.unsafe(nil), String)
1764
1787
 
1765
- # source://yard//lib/yard/cli/yardoc.rb#147
1788
+ # source://yard//lib/yard/cli/yardoc.rb#145
1766
1789
  class YARD::CLI::Yardoc < ::YARD::CLI::YardoptsCommand
1767
1790
  # Creates a new instance of the commandline utility
1768
1791
  #
@@ -2135,7 +2158,7 @@ end
2135
2158
 
2136
2159
  # Default options used in +yard doc+ command.
2137
2160
  #
2138
- # source://yard//lib/yard/cli/yardoc.rb#10
2161
+ # source://yard//lib/yard/cli/yardoc.rb#8
2139
2162
  class YARD::CLI::YardocOptions < ::YARD::Templates::TemplateOptions
2140
2163
  # @return [CodeObjects::ExtraFileObject] the file object being rendered.
2141
2164
  # The +object+ key is not used so that a file may be rendered in the context
@@ -2263,7 +2286,7 @@ end
2263
2286
  # @abstract
2264
2287
  # @since 0.8.3
2265
2288
  #
2266
- # source://yard//lib/yard/cli/yardopts_command.rb#11
2289
+ # source://yard//lib/yard/cli/yardopts_command.rb#10
2267
2290
  class YARD::CLI::YardoptsCommand < ::YARD::CLI::Command
2268
2291
  # Creates a new command that reads .yardopts
2269
2292
  #
@@ -2480,7 +2503,7 @@ class YARD::CodeObjects::Base
2480
2503
  # the paths are equal
2481
2504
  # @return [Boolean] whether or not the objects are considered the same
2482
2505
  #
2483
- # source://yard//lib/yard/code_objects/base.rb#322
2506
+ # source://yard//lib/yard/code_objects/base.rb#323
2484
2507
  def ==(other); end
2485
2508
 
2486
2509
  # Accesses a custom attribute on the object
@@ -2489,7 +2512,7 @@ class YARD::CodeObjects::Base
2489
2512
  # @return [Object, nil] the custom attribute or nil if not found.
2490
2513
  # @see #[]=
2491
2514
  #
2492
- # source://yard//lib/yard/code_objects/base.rb#342
2515
+ # source://yard//lib/yard/code_objects/base.rb#343
2493
2516
  def [](key); end
2494
2517
 
2495
2518
  # Sets a custom attribute on the object
@@ -2499,7 +2522,7 @@ class YARD::CodeObjects::Base
2499
2522
  # @return [void]
2500
2523
  # @see #[]
2501
2524
  #
2502
- # source://yard//lib/yard/code_objects/base.rb#355
2525
+ # source://yard//lib/yard/code_objects/base.rb#356
2503
2526
  def []=(key, value); end
2504
2527
 
2505
2528
  # Associates a file with a code object, optionally adding the line where it was defined.
@@ -2520,7 +2543,7 @@ class YARD::CodeObjects::Base
2520
2543
  # @see Docstring#add_tag
2521
2544
  # @since 0.8.4
2522
2545
  #
2523
- # source://yard//lib/yard/code_objects/base.rb#560
2546
+ # source://yard//lib/yard/code_objects/base.rb#561
2524
2547
  def add_tag(*tags); end
2525
2548
 
2526
2549
  # The non-localized documentation string associated with the object
@@ -2547,7 +2570,7 @@ class YARD::CodeObjects::Base
2547
2570
  # the locale of the documentation string.
2548
2571
  # @return [Docstring] the documentation string
2549
2572
  #
2550
- # source://yard//lib/yard/code_objects/base.rb#404
2573
+ # source://yard//lib/yard/code_objects/base.rb#405
2551
2574
  def docstring(locale = T.unsafe(nil)); end
2552
2575
 
2553
2576
  # Attaches a docstring to a code object by parsing the comments attached to the statement
@@ -2556,7 +2579,7 @@ class YARD::CodeObjects::Base
2556
2579
  # @param comments [String, Array<String>, Docstring] the comments attached to the code object to be parsed
2557
2580
  # into a docstring and meta tags.
2558
2581
  #
2559
- # source://yard//lib/yard/code_objects/base.rb#426
2582
+ # source://yard//lib/yard/code_objects/base.rb#427
2560
2583
  def docstring=(comments); end
2561
2584
 
2562
2585
  # Marks whether or not the method is conditionally defined at runtime
@@ -2587,7 +2610,7 @@ class YARD::CodeObjects::Base
2587
2610
  # the paths are equal
2588
2611
  # @return [Boolean] whether or not the objects are considered the same
2589
2612
  #
2590
- # source://yard//lib/yard/code_objects/base.rb#322
2613
+ # source://yard//lib/yard/code_objects/base.rb#323
2591
2614
  def eql?(other); end
2592
2615
 
2593
2616
  # Tests if another object is equal to this, including a proxy
@@ -2596,15 +2619,16 @@ class YARD::CodeObjects::Base
2596
2619
  # the paths are equal
2597
2620
  # @return [Boolean] whether or not the objects are considered the same
2598
2621
  #
2599
- # source://yard//lib/yard/code_objects/base.rb#322
2622
+ # source://yard//lib/yard/code_objects/base.rb#323
2600
2623
  def equal?(other); end
2601
2624
 
2602
2625
  # Returns the filename the object was first parsed at, taking
2603
2626
  # definitions with docstrings first.
2604
2627
  #
2605
2628
  # @return [String] a filename
2629
+ # @return [nil] if there is no file associated with the object
2606
2630
  #
2607
- # source://yard//lib/yard/code_objects/base.rb#306
2631
+ # source://yard//lib/yard/code_objects/base.rb#307
2608
2632
  def file; end
2609
2633
 
2610
2634
  # The files the object was defined in. To add a file, use {#add_file}.
@@ -2629,7 +2653,7 @@ class YARD::CodeObjects::Base
2629
2653
  # @return [String] the rendered template
2630
2654
  # @see Templates::Engine#render
2631
2655
  #
2632
- # source://yard//lib/yard/code_objects/base.rb#504
2656
+ # source://yard//lib/yard/code_objects/base.rb#505
2633
2657
  def format(options = T.unsafe(nil)); end
2634
2658
 
2635
2659
  # @return [String] the group this object is associated with
@@ -2649,19 +2673,19 @@ class YARD::CodeObjects::Base
2649
2673
  # @return [Boolean]
2650
2674
  # @see Docstring#has_tag?
2651
2675
  #
2652
- # source://yard//lib/yard/code_objects/base.rb#555
2676
+ # source://yard//lib/yard/code_objects/base.rb#556
2653
2677
  def has_tag?(name); end
2654
2678
 
2655
2679
  # @return [Integer] the object's hash value (for equality checking)
2656
2680
  #
2657
- # source://yard//lib/yard/code_objects/base.rb#333
2681
+ # source://yard//lib/yard/code_objects/base.rb#334
2658
2682
  def hash; end
2659
2683
 
2660
2684
  # Inspects the object, returning the type and path
2661
2685
  #
2662
2686
  # @return [String] a string describing the object
2663
2687
  #
2664
- # source://yard//lib/yard/code_objects/base.rb#512
2688
+ # source://yard//lib/yard/code_objects/base.rb#513
2665
2689
  def inspect; end
2666
2690
 
2667
2691
  # Returns the line the object was first parsed at (or nil)
@@ -2669,13 +2693,13 @@ class YARD::CodeObjects::Base
2669
2693
  # @return [Fixnum] the line where the object was first defined.
2670
2694
  # @return [nil] if there is no line associated with the object
2671
2695
  #
2672
- # source://yard//lib/yard/code_objects/base.rb#314
2696
+ # source://yard//lib/yard/code_objects/base.rb#315
2673
2697
  def line; end
2674
2698
 
2675
2699
  # @overload dynamic_attr_name
2676
2700
  # @overload dynamic_attr_name=
2677
2701
  #
2678
- # source://yard//lib/yard/code_objects/base.rb#372
2702
+ # source://yard//lib/yard/code_objects/base.rb#373
2679
2703
  def method_missing(meth, *args, &block); end
2680
2704
 
2681
2705
  # The name of the object
@@ -2703,7 +2727,7 @@ class YARD::CodeObjects::Base
2703
2727
  # for {Registry.root}). If obj is nil, the object is unregistered
2704
2728
  # from the Registry.
2705
2729
  #
2706
- # source://yard//lib/yard/code_objects/base.rb#521
2730
+ # source://yard//lib/yard/code_objects/base.rb#522
2707
2731
  def namespace=(obj); end
2708
2732
 
2709
2733
  # The namespace the object is defined in. If the object is in the
@@ -2720,7 +2744,7 @@ class YARD::CodeObjects::Base
2720
2744
  # for {Registry.root}). If obj is nil, the object is unregistered
2721
2745
  # from the Registry.
2722
2746
  #
2723
- # source://yard//lib/yard/code_objects/base.rb#521
2747
+ # source://yard//lib/yard/code_objects/base.rb#522
2724
2748
  def parent=(obj); end
2725
2749
 
2726
2750
  # Represents the unique path of the object. The default implementation
@@ -2733,19 +2757,19 @@ class YARD::CodeObjects::Base
2733
2757
  # @return [String] the unique path of the object
2734
2758
  # @see #sep
2735
2759
  #
2736
- # source://yard//lib/yard/code_objects/base.rb#452
2760
+ # source://yard//lib/yard/code_objects/base.rb#453
2737
2761
  def path; end
2738
2762
 
2739
2763
  # @param other [Base, String] another code object (or object path)
2740
2764
  # @return [String] the shortest relative path from this object to +other+
2741
2765
  # @since 0.5.3
2742
2766
  #
2743
- # source://yard//lib/yard/code_objects/base.rb#474
2767
+ # source://yard//lib/yard/code_objects/base.rb#475
2744
2768
  def relative_path(other); end
2745
2769
 
2746
2770
  # @return [Boolean] whether or not this object is a RootObject
2747
2771
  #
2748
- # source://yard//lib/yard/code_objects/base.rb#566
2772
+ # source://yard//lib/yard/code_objects/base.rb#567
2749
2773
  def root?; end
2750
2774
 
2751
2775
  # Override this method with a custom component separator. For instance,
@@ -2756,7 +2780,7 @@ class YARD::CodeObjects::Base
2756
2780
  # @return [String] the component that separates the namespace path
2757
2781
  # and the name (default is {NSEP})
2758
2782
  #
2759
- # source://yard//lib/yard/code_objects/base.rb#575
2783
+ # source://yard//lib/yard/code_objects/base.rb#576
2760
2784
  def sep; end
2761
2785
 
2762
2786
  # The one line signature representing an object. For a method, this will
@@ -2789,7 +2813,7 @@ class YARD::CodeObjects::Base
2789
2813
  # @param statement [#source, String] the +Parser::Statement+ holding the source code or the raw source
2790
2814
  # as a +String+ for the definition of the code object only (not the block)
2791
2815
  #
2792
- # source://yard//lib/yard/code_objects/base.rb#387
2816
+ # source://yard//lib/yard/code_objects/base.rb#388
2793
2817
  def source=(statement); end
2794
2818
 
2795
2819
  # Language of the source code associated with the object. Defaults to
@@ -2812,14 +2836,14 @@ class YARD::CodeObjects::Base
2812
2836
  #
2813
2837
  # @see Docstring#tag
2814
2838
  #
2815
- # source://yard//lib/yard/code_objects/base.rb#547
2839
+ # source://yard//lib/yard/code_objects/base.rb#548
2816
2840
  def tag(name); end
2817
2841
 
2818
2842
  # Gets a list of tags from the {#docstring}
2819
2843
  #
2820
2844
  # @see Docstring#tags
2821
2845
  #
2822
- # source://yard//lib/yard/code_objects/base.rb#551
2846
+ # source://yard//lib/yard/code_objects/base.rb#552
2823
2847
  def tags(name = T.unsafe(nil)); end
2824
2848
 
2825
2849
  # @note Override this method if your object has a special title that does
@@ -2828,12 +2852,12 @@ class YARD::CodeObjects::Base
2828
2852
  # @return [String] the display title for an object
2829
2853
  # @see 0.8.4
2830
2854
  #
2831
- # source://yard//lib/yard/code_objects/base.rb#467
2855
+ # source://yard//lib/yard/code_objects/base.rb#468
2832
2856
  def title; end
2833
2857
 
2834
2858
  # @return [nil] this object does not turn into an array
2835
2859
  #
2836
- # source://yard//lib/yard/code_objects/base.rb#336
2860
+ # source://yard//lib/yard/code_objects/base.rb#337
2837
2861
  def to_ary; end
2838
2862
 
2839
2863
  # Represents the unique path of the object. The default implementation
@@ -2846,7 +2870,7 @@ class YARD::CodeObjects::Base
2846
2870
  # @return [String] the unique path of the object
2847
2871
  # @see #sep
2848
2872
  #
2849
- # source://yard//lib/yard/code_objects/base.rb#452
2873
+ # source://yard//lib/yard/code_objects/base.rb#453
2850
2874
  def to_s; end
2851
2875
 
2852
2876
  # Default type is the lowercase class name without the "Object" suffix.
@@ -2854,7 +2878,7 @@ class YARD::CodeObjects::Base
2854
2878
  #
2855
2879
  # @return [Symbol] the type of code object this represents
2856
2880
  #
2857
- # source://yard//lib/yard/code_objects/base.rb#436
2881
+ # source://yard//lib/yard/code_objects/base.rb#437
2858
2882
  def type; end
2859
2883
 
2860
2884
  # @return [Symbol] the visibility of an object (:public, :private, :protected)
@@ -2877,7 +2901,7 @@ class YARD::CodeObjects::Base
2877
2901
  # @see #copy_to
2878
2902
  # @since 0.8.0
2879
2903
  #
2880
- # source://yard//lib/yard/code_objects/base.rb#586
2904
+ # source://yard//lib/yard/code_objects/base.rb#587
2881
2905
  def copyable_attributes; end
2882
2906
 
2883
2907
  private
@@ -2887,10 +2911,10 @@ class YARD::CodeObjects::Base
2887
2911
  # @param source [String] the source code to format
2888
2912
  # @return [String] formatted source
2889
2913
  #
2890
- # source://yard//lib/yard/code_objects/base.rb#598
2914
+ # source://yard//lib/yard/code_objects/base.rb#599
2891
2915
  def format_source(source); end
2892
2916
 
2893
- # source://yard//lib/yard/code_objects/base.rb#605
2917
+ # source://yard//lib/yard/code_objects/base.rb#606
2894
2918
  def translate_docstring(locale); end
2895
2919
 
2896
2920
  class << self
@@ -2937,7 +2961,7 @@ YARD::CodeObjects::CSEPQ = T.let(T.unsafe(nil), String)
2937
2961
  # A ClassObject represents a Ruby class in source code. It is a {ModuleObject}
2938
2962
  # with extra inheritance semantics through the superclass.
2939
2963
  #
2940
- # source://yard//lib/yard/code_objects/class_object.rb#9
2964
+ # source://yard//lib/yard/code_objects/class_object.rb#7
2941
2965
  class YARD::CodeObjects::ClassObject < ::YARD::CodeObjects::NamespaceObject
2942
2966
  # Creates a new class object in +namespace+ with +name+
2943
2967
  #
@@ -3018,7 +3042,7 @@ end
3018
3042
  # Represents a class variable inside a namespace. The path is expressed
3019
3043
  # in the form "A::B::@@classvariable"
3020
3044
  #
3021
- # source://yard//lib/yard/code_objects/class_variable_object.rb#8
3045
+ # source://yard//lib/yard/code_objects/class_variable_object.rb#7
3022
3046
  class YARD::CodeObjects::ClassVariableObject < ::YARD::CodeObjects::Base
3023
3047
  # @return [String] the class variable's value
3024
3048
  #
@@ -3034,7 +3058,7 @@ end
3034
3058
  # A list of code objects. This array acts like a set (no unique items)
3035
3059
  # but also disallows any {Proxy} objects from being added.
3036
3060
  #
3037
- # source://yard//lib/yard/code_objects/base.rb#10
3061
+ # source://yard//lib/yard/code_objects/base.rb#6
3038
3062
  class YARD::CodeObjects::CodeObjectList < ::Array
3039
3063
  # Creates a new object list associated with a namespace
3040
3064
  #
@@ -3064,7 +3088,7 @@ end
3064
3088
  # A +ConstantObject+ represents a Ruby constant (not a module or class).
3065
3089
  # To access the constant's (source code) value, use {#value}.
3066
3090
  #
3067
- # source://yard//lib/yard/code_objects/constant_object.rb#9
3091
+ # source://yard//lib/yard/code_objects/constant_object.rb#7
3068
3092
  class YARD::CodeObjects::ConstantObject < ::YARD::CodeObjects::Base
3069
3093
  # The source code representing the constant's value
3070
3094
  #
@@ -3431,7 +3455,7 @@ YARD::CodeObjects::MacroObject::MACRO_MATCH = T.let(T.unsafe(nil), Regexp)
3431
3455
 
3432
3456
  # Represents a Ruby method in source
3433
3457
  #
3434
- # source://yard//lib/yard/code_objects/method_object.rb#10
3458
+ # source://yard//lib/yard/code_objects/method_object.rb#7
3435
3459
  class YARD::CodeObjects::MethodObject < ::YARD::CodeObjects::Base
3436
3460
  # Creates a new method object in +namespace+ with +name+ and an instance
3437
3461
  # or class +scope+
@@ -3604,7 +3628,7 @@ end
3604
3628
 
3605
3629
  # Represents a Ruby module.
3606
3630
  #
3607
- # source://yard//lib/yard/code_objects/module_object.rb#11
3631
+ # source://yard//lib/yard/code_objects/module_object.rb#6
3608
3632
  class YARD::CodeObjects::ModuleObject < ::YARD::CodeObjects::NamespaceObject
3609
3633
  # Returns the inheritance tree of mixins.
3610
3634
  #
@@ -3769,7 +3793,7 @@ end
3769
3793
  # The two main Ruby objects that can act as namespaces are modules
3770
3794
  # ({ModuleObject}) and classes ({ClassObject}).
3771
3795
  #
3772
- # source://yard//lib/yard/code_objects/namespace_object.rb#11
3796
+ # source://yard//lib/yard/code_objects/namespace_object.rb#9
3773
3797
  class YARD::CodeObjects::NamespaceObject < ::YARD::CodeObjects::Base
3774
3798
  # Creates a new namespace object inside +namespace+ with +name+.
3775
3799
  #
@@ -5915,7 +5939,7 @@ class YARD::Handlers::HandlerAborted < ::RuntimeError; end
5915
5939
  # an operation on an object's namespace but the namespace could
5916
5940
  # not be resolved.
5917
5941
  #
5918
- # source://yard//lib/yard/handlers/base.rb#15
5942
+ # source://yard//lib/yard/handlers/base.rb#13
5919
5943
  class YARD::Handlers::NamespaceMissingError < ::YARD::Parser::UndocumentableError
5920
5944
  # @return [NamespaceMissingError] a new instance of NamespaceMissingError
5921
5945
  #
@@ -6503,7 +6527,7 @@ class YARD::Handlers::Ruby::Legacy::AttributeHandler < ::YARD::Handlers::Ruby::L
6503
6527
  #
6504
6528
  # @abstract See {Handlers::Base} for subclassing information.
6505
6529
  #
6506
- # source://yard//lib/yard/handlers/ruby/legacy/base.rb#10
6530
+ # source://yard//lib/yard/handlers/ruby/legacy/base.rb#9
6507
6531
  class YARD::Handlers::Ruby::Legacy::Base < ::YARD::Handlers::Base
6508
6532
  include ::YARD::Parser::Ruby::Legacy::RubyToken
6509
6533
 
@@ -7405,13 +7429,13 @@ class YARD::I18n::Text
7405
7429
  # block separated by one or more empty lines. Empty line is a
7406
7430
  # line that contains only zero or more whitespaces. It may
7407
7431
  # called many times.
7432
+ # @yieldparam text [String] the text of extracted paragraph.
7433
+ # @yieldparam start_line_no [Integer] the start line number of
7434
+ # extracted paragraph.
7408
7435
  # @yieldparam name [String] the name of extracted attribute.
7409
7436
  # @yieldparam value [String] the value of extracted attribute.
7410
7437
  # @yieldparam line_no [Integer] the defined line number of extracted
7411
7438
  # attribute.
7412
- # @yieldparam text [String] the text of extracted paragraph.
7413
- # @yieldparam start_line_no [Integer] the start line number of
7414
- # extracted paragraph.
7415
7439
  #
7416
7440
  # source://yard//lib/yard/i18n/text.rb#35
7417
7441
  def extract_messages; end
@@ -7459,7 +7483,7 @@ end
7459
7483
  # Handles console logging for info, warnings and errors.
7460
7484
  # Uses the stdlib Logger class in Ruby for all the backend logic.
7461
7485
  #
7462
- # source://yard//lib/yard/logging.rb#12
7486
+ # source://yard//lib/yard/logging.rb#9
7463
7487
  class YARD::Logger < ::Logger
7464
7488
  # Creates a new logger
7465
7489
  #
@@ -7635,7 +7659,7 @@ class YARD::Logger < ::Logger
7635
7659
  # source://yard//lib/yard/logging.rb#201
7636
7660
  def format_log(sev, _time, _prog, msg); end
7637
7661
 
7638
- # source://logger/1.5.0/logger.rb#485
7662
+ # source://logger/1.6.0/logger.rb#684
7639
7663
  def print_no_newline(msg); end
7640
7664
 
7641
7665
  class << self
@@ -9972,7 +9996,7 @@ end
9972
9996
 
9973
9997
  # source://yard//lib/yard/parser/ruby/ast_node.rb#479
9974
9998
  class YARD::Parser::Ruby::MethodDefinitionNode < ::YARD::Parser::Ruby::AstNode
9975
- def block(*_arg0); end
9999
+ def block(n = T.unsafe(nil)); end
9976
10000
 
9977
10001
  # @return [Boolean]
9978
10002
  #
@@ -11033,10 +11057,10 @@ class YARD::Parser::SourceParser
11033
11057
 
11034
11058
  # @since 0.5.6
11035
11059
  #
11036
- # source://yard//lib/yard/parser/source_parser.rb#516
11060
+ # source://yard//lib/yard/parser/source_parser.rb#515
11037
11061
  def parser_class; end
11038
11062
 
11039
- # source://yard//lib/yard/parser/source_parser.rb#501
11063
+ # source://yard//lib/yard/parser/source_parser.rb#500
11040
11064
  def parser_type=(value); end
11041
11065
 
11042
11066
  # Guesses the parser type to use depending on the file extension.
@@ -11044,14 +11068,14 @@ class YARD::Parser::SourceParser
11044
11068
  # @param filename [String] the filename to use to guess the parser type
11045
11069
  # @return [Symbol] a parser type that matches the filename
11046
11070
  #
11047
- # source://yard//lib/yard/parser/source_parser.rb#509
11071
+ # source://yard//lib/yard/parser/source_parser.rb#508
11048
11072
  def parser_type_for_filename(filename); end
11049
11073
 
11050
11074
  # Runs a {Handlers::Processor} object to post process the parsed statements.
11051
11075
  #
11052
11076
  # @return [void]
11053
11077
  #
11054
- # source://yard//lib/yard/parser/source_parser.rb#491
11078
+ # source://yard//lib/yard/parser/source_parser.rb#490
11055
11079
  def post_process; end
11056
11080
 
11057
11081
  class << self
@@ -11128,6 +11152,10 @@ class YARD::Parser::SourceParser
11128
11152
  # To register a callback that is called before the entire list of files
11129
11153
  # is processed, see {before_parse_list}.
11130
11154
  #
11155
+ # @example Cancel parsing of any test_*.rb files
11156
+ # SourceParser.before_parse_file do |parser|
11157
+ # return false if parser.file =~ /^test_.+\.rb$/
11158
+ # end
11131
11159
  # @example Installing a simple callback
11132
11160
  # SourceParser.before_parse_file do |parser|
11133
11161
  # puts "I'm parsing #{parser.file}"
@@ -11137,13 +11165,9 @@ class YARD::Parser::SourceParser
11137
11165
  # "I'm parsing lib/foo.rb"
11138
11166
  # "I'm parsing lib/foo_bar.rb"
11139
11167
  # "I'm parsing lib/last_file.rb"
11140
- # @example Cancel parsing of any test_*.rb files
11141
- # SourceParser.before_parse_file do |parser|
11142
- # return false if parser.file =~ /^test_.+\.rb$/
11143
- # end
11144
11168
  # @return [Proc] the yielded block
11145
- # @see after_parse_file
11146
11169
  # @see before_parse_list
11170
+ # @see after_parse_file
11147
11171
  # @since 0.7.0
11148
11172
  # @yield [parser] the yielded block is called once before each
11149
11173
  # file that is parsed. This might happen many times for a single
@@ -11167,12 +11191,6 @@ class YARD::Parser::SourceParser
11167
11191
  # via {parse}. The block passed to this method will be called on
11168
11192
  # subsequent parse calls.
11169
11193
  #
11170
- # @example Installing a simple callback
11171
- # SourceParser.before_parse_list do |files, globals|
11172
- # puts "Starting to parse..."
11173
- # end
11174
- # YARD.parse('lib/**/*.rb')
11175
- # # prints "Starting to parse..."
11176
11194
  # @example Setting global state
11177
11195
  # SourceParser.before_parse_list do |files, globals|
11178
11196
  # globals.method_count = 0
@@ -11186,6 +11204,12 @@ class YARD::Parser::SourceParser
11186
11204
  # end
11187
11205
  # YARD.parse
11188
11206
  # # Prints: "Found 37 methods"
11207
+ # @example Installing a simple callback
11208
+ # SourceParser.before_parse_list do |files, globals|
11209
+ # puts "Starting to parse..."
11210
+ # end
11211
+ # YARD.parse('lib/**/*.rb')
11212
+ # # prints "Starting to parse..."
11189
11213
  # @example Using a global callback to cancel parsing
11190
11214
  # SourceParser.before_parse_list do |files, globals|
11191
11215
  # return false if files.include?('foo.rb')
@@ -11194,8 +11218,8 @@ class YARD::Parser::SourceParser
11194
11218
  # YARD.parse(['foo.rb', 'bar.rb']) # callback cancels this method
11195
11219
  # YARD.parse('bar.rb') # parses normally
11196
11220
  # @return [Proc] the yielded block
11197
- # @see after_parse_list
11198
11221
  # @see before_parse_file
11222
+ # @see after_parse_list
11199
11223
  # @since 0.7.0
11200
11224
  # @yield [files, globals] the yielded block is called once before
11201
11225
  # parsing all files
@@ -11360,7 +11384,7 @@ module YARD::Rake; end
11360
11384
 
11361
11385
  # The rake task to run {CLI::Yardoc} and generate documentation.
11362
11386
  #
11363
- # source://yard//lib/yard/rake/yardoc_task.rb#10
11387
+ # source://yard//lib/yard/rake/yardoc_task.rb#8
11364
11388
  class YARD::Rake::YardocTask < ::Rake::TaskLib
11365
11389
  # Creates a new task with name +name+.
11366
11390
  #
@@ -11722,22 +11746,22 @@ module YARD::Registry
11722
11746
  # Attempts to find an object by name starting at +namespace+, performing
11723
11747
  # a lookup similar to Ruby's method of resolving a constant in a namespace.
11724
11748
  #
11725
- # @example Looks for instance method #reverse starting from A::B::C
11726
- # Registry.resolve(P("A::B::C"), "#reverse")
11727
11749
  # @example Looks for a constant in the root namespace
11728
11750
  # Registry.resolve(nil, 'CONSTANT')
11729
11751
  # @example Looks for a class method respecting the inheritance tree
11730
11752
  # Registry.resolve(myclass, 'mymethod', true)
11753
+ # @example Looks for instance method #reverse starting from A::B::C
11754
+ # Registry.resolve(P("A::B::C"), "#reverse")
11731
11755
  # @example Looks for a constant but returns a proxy if not found
11732
11756
  # Registry.resolve(P('A::B::C'), 'D', false, true) # => #<yardoc proxy A::B::C::D>
11733
11757
  # @example Looks for a complex path from a namespace
11734
11758
  # Registry.resolve(P('A::B'), 'B::D') # => #<yardoc class A::B::D>
11759
+ # @param inheritance [Boolean] Follows inheritance chain (mixins, superclass)
11760
+ # when performing name resolution if set to +true+.
11735
11761
  # @param namespace [CodeObjects::NamespaceObject, nil] the starting namespace
11736
11762
  # (module or class). If +nil+ or +:root+, starts from the {root} object.
11737
11763
  # @param name [String, Symbol] the name (or complex path) to look for from
11738
11764
  # +namespace+.
11739
- # @param inheritance [Boolean] Follows inheritance chain (mixins, superclass)
11740
- # when performing name resolution if set to +true+.
11741
11765
  # @param proxy_fallback [Boolean] If +true+, returns a proxy representing
11742
11766
  # the unresolved path (namespace + name) if no object is found.
11743
11767
  # @param type [Symbol, nil] the {CodeObjects::Base#type} that the resolved
@@ -11895,12 +11919,12 @@ class YARD::RegistryResolver
11895
11919
  # object can be returned if the lookup fails for future resolution. The
11896
11920
  # proxy will be type hinted with the +type+ used in the original lookup.
11897
11921
  #
11922
+ # @example A lookup on a method through the inheritance tree
11923
+ # resolver.lookup_by_math("A::B#foo", inheritance: true)
11898
11924
  # @example A lookup from root
11899
11925
  # resolver.lookup_by_path("A::B::C")
11900
11926
  # @example A lookup from the A::B namespace
11901
11927
  # resolver.lookup_by_path("C", namespace: P("A::B"))
11902
- # @example A lookup on a method through the inheritance tree
11903
- # resolver.lookup_by_math("A::B#foo", inheritance: true)
11904
11928
  # @option opts
11905
11929
  # @option opts
11906
11930
  # @option opts
@@ -12298,7 +12322,7 @@ end
12298
12322
 
12299
12323
  # Implements a serializer that reads from and writes to the filesystem.
12300
12324
  #
12301
- # source://yard//lib/yard/serializers/file_system_serializer.rb#7
12325
+ # source://yard//lib/yard/serializers/file_system_serializer.rb#5
12302
12326
  class YARD::Serializers::FileSystemSerializer < ::YARD::Serializers::Base
12303
12327
  # Creates a new FileSystemSerializer with options
12304
12328
  #
@@ -12386,7 +12410,7 @@ end
12386
12410
  # serializer = ProcessSerializer.new('less')
12387
12411
  # serializer.serialize(object, "data!")
12388
12412
  #
12389
- # source://yard//lib/yard/serializers/process_serializer.rb#12
12413
+ # source://yard//lib/yard/serializers/process_serializer.rb#9
12390
12414
  class YARD::Serializers::ProcessSerializer < ::YARD::Serializers::Base
12391
12415
  # Creates a new ProcessSerializer for the shell command +cmd+
12392
12416
  #
@@ -12405,7 +12429,7 @@ end
12405
12429
 
12406
12430
  # A serializer that writes data to standard output.
12407
12431
  #
12408
- # source://yard//lib/yard/serializers/stdout_serializer.rb#9
12432
+ # source://yard//lib/yard/serializers/stdout_serializer.rb#5
12409
12433
  class YARD::Serializers::StdoutSerializer < ::YARD::Serializers::Base
12410
12434
  # Creates a serializer to print text to stdout
12411
12435
  #
@@ -14555,6 +14579,50 @@ module YARD::Server::StaticCaching
14555
14579
  def check_static_cache; end
14556
14580
  end
14557
14581
 
14582
+ # The main adapter to initialize a WEBrick server.
14583
+ #
14584
+ # @since 0.6.0
14585
+ #
14586
+ # source://yard//lib/yard/server/webrick_adapter.rb#7
14587
+ class YARD::Server::WebrickAdapter < ::YARD::Server::Adapter
14588
+ # Initializes a WEBrick server. If {Adapter#server_options} contains a
14589
+ # +:daemonize+ key set to true, the server will be daemonized.
14590
+ #
14591
+ # @since 0.6.0
14592
+ #
14593
+ # source://yard//lib/yard/server/webrick_adapter.rb#10
14594
+ def start; end
14595
+ end
14596
+
14597
+ # The main WEBrick servlet implementation, accepting only GET requests.
14598
+ #
14599
+ # @since 0.6.0
14600
+ #
14601
+ # source://yard//lib/yard/server/webrick_adapter.rb#20
14602
+ class YARD::Server::WebrickServlet < ::WEBrick::HTTPServlet::AbstractServlet
14603
+ # @return [WebrickServlet] a new instance of WebrickServlet
14604
+ # @since 0.6.0
14605
+ #
14606
+ # source://yard//lib/yard/server/webrick_adapter.rb#23
14607
+ def initialize(server, adapter); end
14608
+
14609
+ # @since 0.6.0
14610
+ #
14611
+ # source://yard//lib/yard/server/webrick_adapter.rb#21
14612
+ def adapter; end
14613
+
14614
+ # @since 0.6.0
14615
+ #
14616
+ # source://yard//lib/yard/server/webrick_adapter.rb#21
14617
+ def adapter=(_arg0); end
14618
+
14619
+ # @private
14620
+ # @since 0.6.0
14621
+ #
14622
+ # source://yard//lib/yard/server/webrick_adapter.rb#29
14623
+ def do_GET(request, response); end
14624
+ end
14625
+
14558
14626
  # Stubs marshal dumps and acts a delegate class for an object by path
14559
14627
  #
14560
14628
  # @private
@@ -16166,6 +16234,10 @@ class YARD::Tags::TypesExplainer
16166
16234
  #
16167
16235
  # source://yard//lib/yard/tags/types_explainer.rb#17
16168
16236
  def explain!(*types); end
16237
+
16238
+ private
16239
+
16240
+ def new(*_arg0); end
16169
16241
  end
16170
16242
  end
16171
16243
 
@@ -17861,7 +17933,7 @@ end
17861
17933
  #
17862
17934
  # @see CLI::YardocOptions
17863
17935
  #
17864
- # source://yard//lib/yard/templates/template_options.rb#11
17936
+ # source://yard//lib/yard/templates/template_options.rb#10
17865
17937
  class YARD::Templates::TemplateOptions < ::YARD::Options
17866
17938
  # @return [OpenStruct] an open struct containing any global state across all
17867
17939
  # generated objects in a template.