cucumber-messages 22.0.0 → 23.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -6,7 +6,6 @@ require 'cucumber/messages/message'
6
6
  module Cucumber
7
7
  module Messages
8
8
 
9
-
10
9
  ##
11
10
  # Represents the Attachment message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
12
11
  #
@@ -22,16 +21,14 @@ module Cucumber
22
21
  #
23
22
  # It is not to be used for runtime errors raised/thrown during execution. This
24
23
  # is captured in `TestResult`.
25
- #
26
-
24
+ ##
27
25
  class Attachment < ::Cucumber::Messages::Message
28
-
29
26
  ##
30
27
  # *
31
28
  # The body of the attachment. If `contentEncoding` is `IDENTITY`, the attachment
32
29
  # is simply the string. If it's `BASE64`, the string should be Base64 decoded to
33
30
  # obtain the attachment.
34
-
31
+ ##
35
32
  attr_reader :body
36
33
 
37
34
  ##
@@ -44,13 +41,13 @@ module Cucumber
44
41
  # - string: IDENTITY
45
42
  # - byte array: BASE64
46
43
  # - stream: BASE64
47
-
44
+ ##
48
45
  attr_reader :content_encoding
49
46
 
50
47
  ##
51
48
  # *
52
49
  # Suggested file name of the attachment. (Provided by the user as an argument to `attach`)
53
-
50
+ ##
54
51
  attr_reader :file_name
55
52
 
56
53
  ##
@@ -59,7 +56,7 @@ module Cucumber
59
56
  # [IANA Media Type](https://www.iana.org/assignments/media-types/media-types.xhtml)
60
57
  # as well as Cucumber-specific media types such as `text/x.cucumber.gherkin+plain`
61
58
  # and `text/x.cucumber.stacktrace+plain`
62
-
59
+ ##
63
60
  attr_reader :media_type
64
61
 
65
62
  attr_reader :source
@@ -81,7 +78,7 @@ module Cucumber
81
78
  # This will result in a smaller message stream, which can improve performance and
82
79
  # reduce bandwidth of message consumers. It also makes it easier to process and download attachments
83
80
  # separately from reports.
84
-
81
+ ##
85
82
  attr_reader :url
86
83
 
87
84
  def initialize(
@@ -105,16 +102,13 @@ module Cucumber
105
102
  end
106
103
  end
107
104
 
108
-
109
105
  ##
110
106
  # Represents the Duration message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
111
107
  #
112
108
  # The structure is pretty close of the Timestamp one. For clarity, a second type
113
109
  # of message is used.
114
- #
115
-
110
+ ##
116
111
  class Duration < ::Cucumber::Messages::Message
117
-
118
112
  attr_reader :seconds
119
113
 
120
114
  ##
@@ -122,7 +116,7 @@ module Cucumber
122
116
  # second values with fractions must still have non-negative nanos values
123
117
  # that count forward in time. Must be from 0 to 999,999,999
124
118
  # inclusive.
125
-
119
+ ##
126
120
  attr_reader :nanos
127
121
 
128
122
  def initialize(
@@ -134,7 +128,6 @@ module Cucumber
134
128
  end
135
129
  end
136
130
 
137
-
138
131
  ##
139
132
  # Represents the Envelope message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
140
133
  #
@@ -145,10 +138,8 @@ module Cucumber
145
138
  # *
146
139
  # All the messages that are passed between different components/processes are Envelope
147
140
  # messages.
148
- #
149
-
141
+ ##
150
142
  class Envelope < ::Cucumber::Messages::Message
151
-
152
143
  attr_reader :attachment
153
144
 
154
145
  attr_reader :gherkin_document
@@ -222,23 +213,20 @@ module Cucumber
222
213
  end
223
214
  end
224
215
 
225
-
226
216
  ##
227
217
  # Represents the Exception message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
228
218
  #
229
219
  # A simplified representation of an exception
230
- #
231
-
220
+ ##
232
221
  class Exception < ::Cucumber::Messages::Message
233
-
234
222
  ##
235
223
  # The type of the exception that caused this result. E.g. "Error" or "org.opentest4j.AssertionFailedError"
236
-
224
+ ##
237
225
  attr_reader :type
238
226
 
239
227
  ##
240
228
  # The message of exception that caused this result. E.g. expected: "a" but was: "b"
241
-
229
+ ##
242
230
  attr_reader :message
243
231
 
244
232
  def initialize(
@@ -250,7 +238,6 @@ module Cucumber
250
238
  end
251
239
  end
252
240
 
253
-
254
241
  ##
255
242
  # Represents the GherkinDocument message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
256
243
  #
@@ -261,22 +248,20 @@ module Cucumber
261
248
  #
262
249
  # The only consumers of `GherkinDocument` should only be formatters that produce
263
250
  # "rich" output, resembling the original Gherkin document.
264
- #
265
-
251
+ ##
266
252
  class GherkinDocument < ::Cucumber::Messages::Message
267
-
268
253
  ##
269
254
  # *
270
255
  # The [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier)
271
256
  # of the source, typically a file path relative to the root directory
272
-
257
+ ##
273
258
  attr_reader :uri
274
259
 
275
260
  attr_reader :feature
276
261
 
277
262
  ##
278
263
  # All the comments in the Gherkin document
279
-
264
+ ##
280
265
  attr_reader :comments
281
266
 
282
267
  def initialize(
@@ -290,18 +275,13 @@ module Cucumber
290
275
  end
291
276
  end
292
277
 
293
-
294
278
  ##
295
279
  # Represents the Background message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
296
- #
297
-
298
- #
299
-
280
+ ##
300
281
  class Background < ::Cucumber::Messages::Message
301
-
302
282
  ##
303
283
  # The location of the `Background` keyword
304
-
284
+ ##
305
285
  attr_reader :location
306
286
 
307
287
  attr_reader :keyword
@@ -331,24 +311,21 @@ module Cucumber
331
311
  end
332
312
  end
333
313
 
334
-
335
314
  ##
336
315
  # Represents the Comment message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
337
316
  #
338
317
  # *
339
318
  # A comment in a Gherkin document
340
- #
341
-
319
+ ##
342
320
  class Comment < ::Cucumber::Messages::Message
343
-
344
321
  ##
345
322
  # The location of the comment
346
-
323
+ ##
347
324
  attr_reader :location
348
325
 
349
326
  ##
350
327
  # The text of the comment
351
-
328
+ ##
352
329
  attr_reader :text
353
330
 
354
331
  def initialize(
@@ -360,15 +337,10 @@ module Cucumber
360
337
  end
361
338
  end
362
339
 
363
-
364
340
  ##
365
341
  # Represents the DataTable message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
366
- #
367
-
368
- #
369
-
342
+ ##
370
343
  class DataTable < ::Cucumber::Messages::Message
371
-
372
344
  attr_reader :location
373
345
 
374
346
  attr_reader :rows
@@ -382,15 +354,10 @@ module Cucumber
382
354
  end
383
355
  end
384
356
 
385
-
386
357
  ##
387
358
  # Represents the DocString message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
388
- #
389
-
390
- #
391
-
359
+ ##
392
360
  class DocString < ::Cucumber::Messages::Message
393
-
394
361
  attr_reader :location
395
362
 
396
363
  attr_reader :media_type
@@ -412,18 +379,13 @@ module Cucumber
412
379
  end
413
380
  end
414
381
 
415
-
416
382
  ##
417
383
  # Represents the Examples message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
418
- #
419
-
420
- #
421
-
384
+ ##
422
385
  class Examples < ::Cucumber::Messages::Message
423
-
424
386
  ##
425
387
  # The location of the `Examples` keyword
426
-
388
+ ##
427
389
  attr_reader :location
428
390
 
429
391
  attr_reader :tags
@@ -461,48 +423,43 @@ module Cucumber
461
423
  end
462
424
  end
463
425
 
464
-
465
426
  ##
466
427
  # Represents the Feature message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
467
- #
468
-
469
- #
470
-
428
+ ##
471
429
  class Feature < ::Cucumber::Messages::Message
472
-
473
430
  ##
474
431
  # The location of the `Feature` keyword
475
-
432
+ ##
476
433
  attr_reader :location
477
434
 
478
435
  ##
479
436
  # All the tags placed above the `Feature` keyword
480
-
437
+ ##
481
438
  attr_reader :tags
482
439
 
483
440
  ##
484
441
  # The [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code of the Gherkin document
485
-
442
+ ##
486
443
  attr_reader :language
487
444
 
488
445
  ##
489
446
  # The text of the `Feature` keyword (in the language specified by `language`)
490
-
447
+ ##
491
448
  attr_reader :keyword
492
449
 
493
450
  ##
494
451
  # The name of the feature (the text following the `keyword`)
495
-
452
+ ##
496
453
  attr_reader :name
497
454
 
498
455
  ##
499
456
  # The line(s) underneath the line with the `keyword` that are used as description
500
-
457
+ ##
501
458
  attr_reader :description
502
459
 
503
460
  ##
504
461
  # Zero or more children
505
-
462
+ ##
506
463
  attr_reader :children
507
464
 
508
465
  def initialize(
@@ -524,16 +481,13 @@ module Cucumber
524
481
  end
525
482
  end
526
483
 
527
-
528
484
  ##
529
485
  # Represents the FeatureChild message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
530
486
  #
531
487
  # *
532
488
  # A child node of a `Feature` node
533
- #
534
-
489
+ ##
535
490
  class FeatureChild < ::Cucumber::Messages::Message
536
-
537
491
  attr_reader :rule
538
492
 
539
493
  attr_reader :background
@@ -551,23 +505,18 @@ module Cucumber
551
505
  end
552
506
  end
553
507
 
554
-
555
508
  ##
556
509
  # Represents the Rule message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
557
- #
558
-
559
- #
560
-
510
+ ##
561
511
  class Rule < ::Cucumber::Messages::Message
562
-
563
512
  ##
564
513
  # The location of the `Rule` keyword
565
-
514
+ ##
566
515
  attr_reader :location
567
516
 
568
517
  ##
569
518
  # All the tags placed above the `Rule` keyword
570
-
519
+ ##
571
520
  attr_reader :tags
572
521
 
573
522
  attr_reader :keyword
@@ -599,16 +548,13 @@ module Cucumber
599
548
  end
600
549
  end
601
550
 
602
-
603
551
  ##
604
552
  # Represents the RuleChild message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
605
553
  #
606
554
  # *
607
555
  # A child node of a `Rule` node
608
- #
609
-
556
+ ##
610
557
  class RuleChild < ::Cucumber::Messages::Message
611
-
612
558
  attr_reader :background
613
559
 
614
560
  attr_reader :scenario
@@ -622,18 +568,13 @@ module Cucumber
622
568
  end
623
569
  end
624
570
 
625
-
626
571
  ##
627
572
  # Represents the Scenario message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
628
- #
629
-
630
- #
631
-
573
+ ##
632
574
  class Scenario < ::Cucumber::Messages::Message
633
-
634
575
  ##
635
576
  # The location of the `Scenario` keyword
636
-
577
+ ##
637
578
  attr_reader :location
638
579
 
639
580
  attr_reader :tags
@@ -671,28 +612,25 @@ module Cucumber
671
612
  end
672
613
  end
673
614
 
674
-
675
615
  ##
676
616
  # Represents the Step message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
677
617
  #
678
618
  # A step
679
- #
680
-
619
+ ##
681
620
  class Step < ::Cucumber::Messages::Message
682
-
683
621
  ##
684
622
  # The location of the steps' `keyword`
685
-
623
+ ##
686
624
  attr_reader :location
687
625
 
688
626
  ##
689
627
  # The actual keyword as it appeared in the source.
690
-
628
+ ##
691
629
  attr_reader :keyword
692
630
 
693
631
  ##
694
632
  # The test phase signalled by the keyword: Context definition (Given), Action performance (When), Outcome assertion (Then). Other keywords signal Continuation (And and But) from a prior keyword. Please note that all translations which a dialect maps to multiple keywords (`*` is in this category for all dialects), map to 'Unknown'.
695
-
633
+ ##
696
634
  attr_reader :keyword_type
697
635
 
698
636
  attr_reader :text
@@ -703,7 +641,7 @@ module Cucumber
703
641
 
704
642
  ##
705
643
  # Unique ID to be able to reference the Step from PickleStep
706
-
644
+ ##
707
645
  attr_reader :id
708
646
 
709
647
  def initialize(
@@ -725,23 +663,20 @@ module Cucumber
725
663
  end
726
664
  end
727
665
 
728
-
729
666
  ##
730
667
  # Represents the TableCell message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
731
668
  #
732
669
  # A cell in a `TableRow`
733
- #
734
-
670
+ ##
735
671
  class TableCell < ::Cucumber::Messages::Message
736
-
737
672
  ##
738
673
  # The location of the cell
739
-
674
+ ##
740
675
  attr_reader :location
741
676
 
742
677
  ##
743
678
  # The value of the cell
744
-
679
+ ##
745
680
  attr_reader :value
746
681
 
747
682
  def initialize(
@@ -753,23 +688,20 @@ module Cucumber
753
688
  end
754
689
  end
755
690
 
756
-
757
691
  ##
758
692
  # Represents the TableRow message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
759
693
  #
760
694
  # A row in a table
761
- #
762
-
695
+ ##
763
696
  class TableRow < ::Cucumber::Messages::Message
764
-
765
697
  ##
766
698
  # The location of the first cell in the row
767
-
699
+ ##
768
700
  attr_reader :location
769
701
 
770
702
  ##
771
703
  # Cells in the row
772
-
704
+ ##
773
705
  attr_reader :cells
774
706
 
775
707
  attr_reader :id
@@ -785,29 +717,26 @@ module Cucumber
785
717
  end
786
718
  end
787
719
 
788
-
789
720
  ##
790
721
  # Represents the Tag message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
791
722
  #
792
723
  # *
793
724
  # A tag
794
- #
795
-
725
+ ##
796
726
  class Tag < ::Cucumber::Messages::Message
797
-
798
727
  ##
799
728
  # Location of the tag
800
-
729
+ ##
801
730
  attr_reader :location
802
731
 
803
732
  ##
804
733
  # The name of the tag (including the leading `@`)
805
-
734
+ ##
806
735
  attr_reader :name
807
736
 
808
737
  ##
809
738
  # Unique ID to be able to reference the Tag from PickleTag
810
-
739
+ ##
811
740
  attr_reader :id
812
741
 
813
742
  def initialize(
@@ -821,15 +750,10 @@ module Cucumber
821
750
  end
822
751
  end
823
752
 
824
-
825
753
  ##
826
754
  # Represents the Hook message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
827
- #
828
-
829
- #
830
-
755
+ ##
831
756
  class Hook < ::Cucumber::Messages::Message
832
-
833
757
  attr_reader :id
834
758
 
835
759
  attr_reader :name
@@ -851,16 +775,13 @@ module Cucumber
851
775
  end
852
776
  end
853
777
 
854
-
855
778
  ##
856
779
  # Represents the Location message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
857
780
  #
858
781
  # *
859
782
  # Points to a line and a column in a text file
860
- #
861
-
783
+ ##
862
784
  class Location < ::Cucumber::Messages::Message
863
-
864
785
  attr_reader :line
865
786
 
866
787
  attr_reader :column
@@ -874,41 +795,38 @@ module Cucumber
874
795
  end
875
796
  end
876
797
 
877
-
878
798
  ##
879
799
  # Represents the Meta message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
880
800
  #
881
801
  # *
882
802
  # This message contains meta information about the environment. Consumers can use
883
803
  # this for various purposes.
884
- #
885
-
804
+ ##
886
805
  class Meta < ::Cucumber::Messages::Message
887
-
888
806
  ##
889
807
  # *
890
808
  # The [SEMVER](https://semver.org/) version number of the protocol
891
-
809
+ ##
892
810
  attr_reader :protocol_version
893
811
 
894
812
  ##
895
813
  # SpecFlow, Cucumber-JVM, Cucumber.js, Cucumber-Ruby, Behat etc.
896
-
814
+ ##
897
815
  attr_reader :implementation
898
816
 
899
817
  ##
900
818
  # Java, Ruby, Node.js etc
901
-
819
+ ##
902
820
  attr_reader :runtime
903
821
 
904
822
  ##
905
823
  # Windows, Linux, MacOS etc
906
-
824
+ ##
907
825
  attr_reader :os
908
826
 
909
827
  ##
910
828
  # 386, arm, amd64 etc
911
-
829
+ ##
912
830
  attr_reader :cpu
913
831
 
914
832
  attr_reader :ci
@@ -930,28 +848,25 @@ module Cucumber
930
848
  end
931
849
  end
932
850
 
933
-
934
851
  ##
935
852
  # Represents the Ci message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
936
853
  #
937
854
  # CI environment
938
- #
939
-
855
+ ##
940
856
  class Ci < ::Cucumber::Messages::Message
941
-
942
857
  ##
943
858
  # Name of the CI product, e.g. "Jenkins", "CircleCI" etc.
944
-
859
+ ##
945
860
  attr_reader :name
946
861
 
947
862
  ##
948
863
  # Link to the build
949
-
864
+ ##
950
865
  attr_reader :url
951
866
 
952
867
  ##
953
868
  # The build number. Some CI servers use non-numeric build numbers, which is why this is a string
954
-
869
+ ##
955
870
  attr_reader :build_number
956
871
 
957
872
  attr_reader :git
@@ -969,16 +884,13 @@ module Cucumber
969
884
  end
970
885
  end
971
886
 
972
-
973
887
  ##
974
888
  # Represents the Git message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
975
889
  #
976
890
  # Information about Git, provided by the Build/CI server as environment
977
891
  # variables.
978
- #
979
-
892
+ ##
980
893
  class Git < ::Cucumber::Messages::Message
981
-
982
894
  attr_reader :remote
983
895
 
984
896
  attr_reader :revision
@@ -1000,23 +912,20 @@ module Cucumber
1000
912
  end
1001
913
  end
1002
914
 
1003
-
1004
915
  ##
1005
916
  # Represents the Product message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1006
917
  #
1007
918
  # Used to describe various properties of Meta
1008
- #
1009
-
919
+ ##
1010
920
  class Product < ::Cucumber::Messages::Message
1011
-
1012
921
  ##
1013
922
  # The product name
1014
-
923
+ ##
1015
924
  attr_reader :name
1016
925
 
1017
926
  ##
1018
927
  # The product version
1019
-
928
+ ##
1020
929
  attr_reader :version
1021
930
 
1022
931
  def initialize(
@@ -1028,18 +937,13 @@ module Cucumber
1028
937
  end
1029
938
  end
1030
939
 
1031
-
1032
940
  ##
1033
941
  # Represents the ParameterType message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1034
- #
1035
-
1036
- #
1037
-
942
+ ##
1038
943
  class ParameterType < ::Cucumber::Messages::Message
1039
-
1040
944
  ##
1041
945
  # The name is unique, so we don't need an id.
1042
-
946
+ ##
1043
947
  attr_reader :name
1044
948
 
1045
949
  attr_reader :regular_expressions
@@ -1069,15 +973,10 @@ module Cucumber
1069
973
  end
1070
974
  end
1071
975
 
1072
-
1073
976
  ##
1074
977
  # Represents the ParseError message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1075
- #
1076
-
1077
- #
1078
-
978
+ ##
1079
979
  class ParseError < ::Cucumber::Messages::Message
1080
-
1081
980
  attr_reader :source
1082
981
 
1083
982
  attr_reader :message
@@ -1091,7 +990,6 @@ module Cucumber
1091
990
  end
1092
991
  end
1093
992
 
1094
-
1095
993
  ##
1096
994
  # Represents the Pickle message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1097
995
  #
@@ -1108,41 +1006,39 @@ module Cucumber
1108
1006
  # with the complex structure of a [GherkinDocument](#io.cucumber.messages.GherkinDocument).
1109
1007
  #
1110
1008
  # Each `PickleStep` of a `Pickle` is matched with a `StepDefinition` to create a `TestCase`
1111
- #
1112
-
1009
+ ##
1113
1010
  class Pickle < ::Cucumber::Messages::Message
1114
-
1115
1011
  ##
1116
1012
  # *
1117
1013
  # A unique id for the pickle
1118
-
1014
+ ##
1119
1015
  attr_reader :id
1120
1016
 
1121
1017
  ##
1122
1018
  # The uri of the source file
1123
-
1019
+ ##
1124
1020
  attr_reader :uri
1125
1021
 
1126
1022
  ##
1127
1023
  # The name of the pickle
1128
-
1024
+ ##
1129
1025
  attr_reader :name
1130
1026
 
1131
1027
  ##
1132
1028
  # The language of the pickle
1133
-
1029
+ ##
1134
1030
  attr_reader :language
1135
1031
 
1136
1032
  ##
1137
1033
  # One or more steps
1138
-
1034
+ ##
1139
1035
  attr_reader :steps
1140
1036
 
1141
1037
  ##
1142
1038
  # *
1143
1039
  # One or more tags. If this pickle is constructed from a Gherkin document,
1144
1040
  # It includes inherited tags from the `Feature` as well.
1145
-
1041
+ ##
1146
1042
  attr_reader :tags
1147
1043
 
1148
1044
  ##
@@ -1150,7 +1046,7 @@ module Cucumber
1150
1046
  # Points to the AST node locations of the pickle. The last one represents the unique
1151
1047
  # id of the pickle. A pickle constructed from `Examples` will have the first
1152
1048
  # id originating from the `Scenario` AST node, and the second from the `TableRow` AST node.
1153
-
1049
+ ##
1154
1050
  attr_reader :ast_node_ids
1155
1051
 
1156
1052
  def initialize(
@@ -1172,15 +1068,10 @@ module Cucumber
1172
1068
  end
1173
1069
  end
1174
1070
 
1175
-
1176
1071
  ##
1177
1072
  # Represents the PickleDocString message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1178
- #
1179
-
1180
- #
1181
-
1073
+ ##
1182
1074
  class PickleDocString < ::Cucumber::Messages::Message
1183
-
1184
1075
  attr_reader :media_type
1185
1076
 
1186
1077
  attr_reader :content
@@ -1194,34 +1085,31 @@ module Cucumber
1194
1085
  end
1195
1086
  end
1196
1087
 
1197
-
1198
1088
  ##
1199
1089
  # Represents the PickleStep message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1200
1090
  #
1201
1091
  # *
1202
1092
  # An executable step
1203
- #
1204
-
1093
+ ##
1205
1094
  class PickleStep < ::Cucumber::Messages::Message
1206
-
1207
1095
  attr_reader :argument
1208
1096
 
1209
1097
  ##
1210
1098
  # References the IDs of the source of the step. For Gherkin, this can be
1211
1099
  # the ID of a Step, and possibly also the ID of a TableRow
1212
-
1100
+ ##
1213
1101
  attr_reader :ast_node_ids
1214
1102
 
1215
1103
  ##
1216
1104
  # A unique ID for the PickleStep
1217
-
1105
+ ##
1218
1106
  attr_reader :id
1219
1107
 
1220
1108
  ##
1221
1109
  # The context in which the step was specified: context (Given), action (When) or outcome (Then).
1222
1110
  #
1223
1111
  # Note that the keywords `But` and `And` inherit their meaning from prior steps and the `*` 'keyword' doesn't have specific meaning (hence Unknown)
1224
-
1112
+ ##
1225
1113
  attr_reader :type
1226
1114
 
1227
1115
  attr_reader :text
@@ -1241,15 +1129,12 @@ module Cucumber
1241
1129
  end
1242
1130
  end
1243
1131
 
1244
-
1245
1132
  ##
1246
1133
  # Represents the PickleStepArgument message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1247
1134
  #
1248
1135
  # An optional argument
1249
- #
1250
-
1136
+ ##
1251
1137
  class PickleStepArgument < ::Cucumber::Messages::Message
1252
-
1253
1138
  attr_reader :doc_string
1254
1139
 
1255
1140
  attr_reader :data_table
@@ -1263,15 +1148,10 @@ module Cucumber
1263
1148
  end
1264
1149
  end
1265
1150
 
1266
-
1267
1151
  ##
1268
1152
  # Represents the PickleTable message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1269
- #
1270
-
1271
- #
1272
-
1153
+ ##
1273
1154
  class PickleTable < ::Cucumber::Messages::Message
1274
-
1275
1155
  attr_reader :rows
1276
1156
 
1277
1157
  def initialize(
@@ -1281,15 +1161,10 @@ module Cucumber
1281
1161
  end
1282
1162
  end
1283
1163
 
1284
-
1285
1164
  ##
1286
1165
  # Represents the PickleTableCell message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1287
- #
1288
-
1289
- #
1290
-
1166
+ ##
1291
1167
  class PickleTableCell < ::Cucumber::Messages::Message
1292
-
1293
1168
  attr_reader :value
1294
1169
 
1295
1170
  def initialize(
@@ -1299,15 +1174,10 @@ module Cucumber
1299
1174
  end
1300
1175
  end
1301
1176
 
1302
-
1303
1177
  ##
1304
1178
  # Represents the PickleTableRow message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1305
- #
1306
-
1307
- #
1308
-
1179
+ ##
1309
1180
  class PickleTableRow < ::Cucumber::Messages::Message
1310
-
1311
1181
  attr_reader :cells
1312
1182
 
1313
1183
  def initialize(
@@ -1317,21 +1187,18 @@ module Cucumber
1317
1187
  end
1318
1188
  end
1319
1189
 
1320
-
1321
1190
  ##
1322
1191
  # Represents the PickleTag message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1323
1192
  #
1324
1193
  # *
1325
1194
  # A tag
1326
- #
1327
-
1195
+ ##
1328
1196
  class PickleTag < ::Cucumber::Messages::Message
1329
-
1330
1197
  attr_reader :name
1331
1198
 
1332
1199
  ##
1333
1200
  # Points to the AST node this was created from
1334
-
1201
+ ##
1335
1202
  attr_reader :ast_node_id
1336
1203
 
1337
1204
  def initialize(
@@ -1343,7 +1210,6 @@ module Cucumber
1343
1210
  end
1344
1211
  end
1345
1212
 
1346
-
1347
1213
  ##
1348
1214
  # Represents the Source message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1349
1215
  #
@@ -1351,26 +1217,24 @@ module Cucumber
1351
1217
  #
1352
1218
  # *
1353
1219
  # A source file, typically a Gherkin document or Java/Ruby/JavaScript source code
1354
- #
1355
-
1220
+ ##
1356
1221
  class Source < ::Cucumber::Messages::Message
1357
-
1358
1222
  ##
1359
1223
  # *
1360
1224
  # The [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier)
1361
1225
  # of the source, typically a file path relative to the root directory
1362
-
1226
+ ##
1363
1227
  attr_reader :uri
1364
1228
 
1365
1229
  ##
1366
1230
  # The contents of the file
1367
-
1231
+ ##
1368
1232
  attr_reader :data
1369
1233
 
1370
1234
  ##
1371
1235
  # The media type of the file. Can be used to specify custom types, such as
1372
1236
  # text/x.cucumber.gherkin+plain
1373
-
1237
+ ##
1374
1238
  attr_reader :media_type
1375
1239
 
1376
1240
  def initialize(
@@ -1384,17 +1248,14 @@ module Cucumber
1384
1248
  end
1385
1249
  end
1386
1250
 
1387
-
1388
1251
  ##
1389
1252
  # Represents the SourceReference message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1390
1253
  #
1391
1254
  # *
1392
1255
  # Points to a [Source](#io.cucumber.messages.Source) identified by `uri` and a
1393
1256
  # [Location](#io.cucumber.messages.Location) within that file.
1394
- #
1395
-
1257
+ ##
1396
1258
  class SourceReference < ::Cucumber::Messages::Message
1397
-
1398
1259
  attr_reader :uri
1399
1260
 
1400
1261
  attr_reader :java_method
@@ -1416,15 +1277,10 @@ module Cucumber
1416
1277
  end
1417
1278
  end
1418
1279
 
1419
-
1420
1280
  ##
1421
1281
  # Represents the JavaMethod message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1422
- #
1423
-
1424
- #
1425
-
1282
+ ##
1426
1283
  class JavaMethod < ::Cucumber::Messages::Message
1427
-
1428
1284
  attr_reader :class_name
1429
1285
 
1430
1286
  attr_reader :method_name
@@ -1442,15 +1298,10 @@ module Cucumber
1442
1298
  end
1443
1299
  end
1444
1300
 
1445
-
1446
1301
  ##
1447
1302
  # Represents the JavaStackTraceElement message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1448
- #
1449
-
1450
- #
1451
-
1303
+ ##
1452
1304
  class JavaStackTraceElement < ::Cucumber::Messages::Message
1453
-
1454
1305
  attr_reader :class_name
1455
1306
 
1456
1307
  attr_reader :file_name
@@ -1468,15 +1319,10 @@ module Cucumber
1468
1319
  end
1469
1320
  end
1470
1321
 
1471
-
1472
1322
  ##
1473
1323
  # Represents the StepDefinition message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1474
- #
1475
-
1476
- #
1477
-
1324
+ ##
1478
1325
  class StepDefinition < ::Cucumber::Messages::Message
1479
-
1480
1326
  attr_reader :id
1481
1327
 
1482
1328
  attr_reader :pattern
@@ -1494,15 +1340,10 @@ module Cucumber
1494
1340
  end
1495
1341
  end
1496
1342
 
1497
-
1498
1343
  ##
1499
1344
  # Represents the StepDefinitionPattern message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1500
- #
1501
-
1502
- #
1503
-
1345
+ ##
1504
1346
  class StepDefinitionPattern < ::Cucumber::Messages::Message
1505
-
1506
1347
  attr_reader :source
1507
1348
 
1508
1349
  attr_reader :type
@@ -1516,7 +1357,6 @@ module Cucumber
1516
1357
  end
1517
1358
  end
1518
1359
 
1519
-
1520
1360
  ##
1521
1361
  # Represents the TestCase message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1522
1362
  #
@@ -1524,15 +1364,13 @@ module Cucumber
1524
1364
  #
1525
1365
  # *
1526
1366
  # A `TestCase` contains a sequence of `TestStep`s.
1527
- #
1528
-
1367
+ ##
1529
1368
  class TestCase < ::Cucumber::Messages::Message
1530
-
1531
1369
  attr_reader :id
1532
1370
 
1533
1371
  ##
1534
1372
  # The ID of the `Pickle` this `TestCase` is derived from.
1535
-
1373
+ ##
1536
1374
  attr_reader :pickle_id
1537
1375
 
1538
1376
  attr_reader :test_steps
@@ -1548,15 +1386,10 @@ module Cucumber
1548
1386
  end
1549
1387
  end
1550
1388
 
1551
-
1552
1389
  ##
1553
1390
  # Represents the Group message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1554
- #
1555
-
1556
- #
1557
-
1391
+ ##
1558
1392
  class Group < ::Cucumber::Messages::Message
1559
-
1560
1393
  attr_reader :children
1561
1394
 
1562
1395
  attr_reader :start
@@ -1574,7 +1407,6 @@ module Cucumber
1574
1407
  end
1575
1408
  end
1576
1409
 
1577
-
1578
1410
  ##
1579
1411
  # Represents the StepMatchArgument message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1580
1412
  #
@@ -1585,15 +1417,13 @@ module Cucumber
1585
1417
  # - Highlight the matched parameter in rich formatters such as the HTML formatter
1586
1418
  #
1587
1419
  # This message closely matches the `Argument` class in the `cucumber-expressions` library.
1588
- #
1589
-
1420
+ ##
1590
1421
  class StepMatchArgument < ::Cucumber::Messages::Message
1591
-
1592
1422
  ##
1593
1423
  # *
1594
1424
  # Represents the outermost capture group of an argument. This message closely matches the
1595
1425
  # `Group` class in the `cucumber-expressions` library.
1596
-
1426
+ ##
1597
1427
  attr_reader :group
1598
1428
 
1599
1429
  attr_reader :parameter_type_name
@@ -1607,15 +1437,10 @@ module Cucumber
1607
1437
  end
1608
1438
  end
1609
1439
 
1610
-
1611
1440
  ##
1612
1441
  # Represents the StepMatchArgumentsList message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1613
- #
1614
-
1615
- #
1616
-
1442
+ ##
1617
1443
  class StepMatchArgumentsList < ::Cucumber::Messages::Message
1618
-
1619
1444
  attr_reader :step_match_arguments
1620
1445
 
1621
1446
  def initialize(
@@ -1625,39 +1450,36 @@ module Cucumber
1625
1450
  end
1626
1451
  end
1627
1452
 
1628
-
1629
1453
  ##
1630
1454
  # Represents the TestStep message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1631
1455
  #
1632
1456
  # *
1633
1457
  # A `TestStep` is derived from either a `PickleStep`
1634
1458
  # combined with a `StepDefinition`, or from a `Hook`.
1635
- #
1636
-
1459
+ ##
1637
1460
  class TestStep < ::Cucumber::Messages::Message
1638
-
1639
1461
  ##
1640
1462
  # Pointer to the `Hook` (if derived from a Hook)
1641
-
1463
+ ##
1642
1464
  attr_reader :hook_id
1643
1465
 
1644
1466
  attr_reader :id
1645
1467
 
1646
1468
  ##
1647
1469
  # Pointer to the `PickleStep` (if derived from a `PickleStep`)
1648
-
1470
+ ##
1649
1471
  attr_reader :pickle_step_id
1650
1472
 
1651
1473
  ##
1652
1474
  # Pointer to all the matching `StepDefinition`s (if derived from a `PickleStep`)
1653
-
1475
+ ##
1654
1476
  attr_reader :step_definition_ids
1655
1477
 
1656
1478
  ##
1657
1479
  # A list of list of StepMatchArgument (if derived from a `PickleStep`).
1658
1480
  # Each element represents a matching step definition. A size of 0 means `UNDEFINED`,
1659
1481
  # and a size of 2+ means `AMBIGUOUS`
1660
-
1482
+ ##
1661
1483
  attr_reader :step_match_arguments_lists
1662
1484
 
1663
1485
  def initialize(
@@ -1675,15 +1497,10 @@ module Cucumber
1675
1497
  end
1676
1498
  end
1677
1499
 
1678
-
1679
1500
  ##
1680
1501
  # Represents the TestCaseFinished message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1681
- #
1682
-
1683
- #
1684
-
1502
+ ##
1685
1503
  class TestCaseFinished < ::Cucumber::Messages::Message
1686
-
1687
1504
  attr_reader :test_case_started_id
1688
1505
 
1689
1506
  attr_reader :timestamp
@@ -1701,34 +1518,29 @@ module Cucumber
1701
1518
  end
1702
1519
  end
1703
1520
 
1704
-
1705
1521
  ##
1706
1522
  # Represents the TestCaseStarted message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1707
- #
1708
-
1709
- #
1710
-
1523
+ ##
1711
1524
  class TestCaseStarted < ::Cucumber::Messages::Message
1712
-
1713
1525
  ##
1714
1526
  # *
1715
1527
  # The first attempt should have value 0, and for each retry the value
1716
1528
  # should increase by 1.
1717
-
1529
+ ##
1718
1530
  attr_reader :attempt
1719
1531
 
1720
1532
  ##
1721
1533
  # *
1722
1534
  # Because a `TestCase` can be run multiple times (in case of a retry),
1723
1535
  # we use this field to group messages relating to the same attempt.
1724
-
1536
+ ##
1725
1537
  attr_reader :id
1726
1538
 
1727
1539
  attr_reader :test_case_id
1728
1540
 
1729
1541
  ##
1730
1542
  # An identifier for the worker process running this test case, if test cases are being run in parallel. The identifier will be unique per worker, but no particular format is defined - it could be an index, uuid, machine name etc - and as such should be assumed that it's not human readable.
1731
-
1543
+ ##
1732
1544
  attr_reader :worker_id
1733
1545
 
1734
1546
  attr_reader :timestamp
@@ -1748,33 +1560,28 @@ module Cucumber
1748
1560
  end
1749
1561
  end
1750
1562
 
1751
-
1752
1563
  ##
1753
1564
  # Represents the TestRunFinished message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1754
- #
1755
-
1756
- #
1757
-
1565
+ ##
1758
1566
  class TestRunFinished < ::Cucumber::Messages::Message
1759
-
1760
1567
  ##
1761
1568
  # An informative message about the test run. Typically additional information about failure, but not necessarily.
1762
-
1569
+ ##
1763
1570
  attr_reader :message
1764
1571
 
1765
1572
  ##
1766
1573
  # A test run is successful if all steps are either passed or skipped, all before/after hooks passed and no other exceptions where thrown.
1767
-
1574
+ ##
1768
1575
  attr_reader :success
1769
1576
 
1770
1577
  ##
1771
1578
  # Timestamp when the TestRun is finished
1772
-
1579
+ ##
1773
1580
  attr_reader :timestamp
1774
1581
 
1775
1582
  ##
1776
1583
  # Any exception thrown during the test run, if any. Does not include exceptions thrown while executing steps.
1777
-
1584
+ ##
1778
1585
  attr_reader :exception
1779
1586
 
1780
1587
  def initialize(
@@ -1790,15 +1597,10 @@ module Cucumber
1790
1597
  end
1791
1598
  end
1792
1599
 
1793
-
1794
1600
  ##
1795
1601
  # Represents the TestRunStarted message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1796
- #
1797
-
1798
- #
1799
-
1602
+ ##
1800
1603
  class TestRunStarted < ::Cucumber::Messages::Message
1801
-
1802
1604
  attr_reader :timestamp
1803
1605
 
1804
1606
  def initialize(
@@ -1808,15 +1610,10 @@ module Cucumber
1808
1610
  end
1809
1611
  end
1810
1612
 
1811
-
1812
1613
  ##
1813
1614
  # Represents the TestStepFinished message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1814
- #
1815
-
1816
- #
1817
-
1615
+ ##
1818
1616
  class TestStepFinished < ::Cucumber::Messages::Message
1819
-
1820
1617
  attr_reader :test_case_started_id
1821
1618
 
1822
1619
  attr_reader :test_step_id
@@ -1838,27 +1635,22 @@ module Cucumber
1838
1635
  end
1839
1636
  end
1840
1637
 
1841
-
1842
1638
  ##
1843
1639
  # Represents the TestStepResult message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1844
- #
1845
-
1846
- #
1847
-
1640
+ ##
1848
1641
  class TestStepResult < ::Cucumber::Messages::Message
1849
-
1850
1642
  attr_reader :duration
1851
1643
 
1852
1644
  ##
1853
1645
  # An arbitrary bit of information that explains this result. This can be a stack trace of anything else.
1854
-
1646
+ ##
1855
1647
  attr_reader :message
1856
1648
 
1857
1649
  attr_reader :status
1858
1650
 
1859
1651
  ##
1860
1652
  # Exception thrown while executing this step, if any.
1861
-
1653
+ ##
1862
1654
  attr_reader :exception
1863
1655
 
1864
1656
  def initialize(
@@ -1874,15 +1666,10 @@ module Cucumber
1874
1666
  end
1875
1667
  end
1876
1668
 
1877
-
1878
1669
  ##
1879
1670
  # Represents the TestStepStarted message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1880
- #
1881
-
1882
- #
1883
-
1671
+ ##
1884
1672
  class TestStepStarted < ::Cucumber::Messages::Message
1885
-
1886
1673
  attr_reader :test_case_started_id
1887
1674
 
1888
1675
  attr_reader :test_step_id
@@ -1900,20 +1687,15 @@ module Cucumber
1900
1687
  end
1901
1688
  end
1902
1689
 
1903
-
1904
1690
  ##
1905
1691
  # Represents the Timestamp message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1906
- #
1907
-
1908
- #
1909
-
1692
+ ##
1910
1693
  class Timestamp < ::Cucumber::Messages::Message
1911
-
1912
1694
  ##
1913
1695
  # Represents seconds of UTC time since Unix epoch
1914
1696
  # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
1915
1697
  # 9999-12-31T23:59:59Z inclusive.
1916
-
1698
+ ##
1917
1699
  attr_reader :seconds
1918
1700
 
1919
1701
  ##
@@ -1921,7 +1703,7 @@ module Cucumber
1921
1703
  # second values with fractions must still have non-negative nanos values
1922
1704
  # that count forward in time. Must be from 0 to 999,999,999
1923
1705
  # inclusive.
1924
-
1706
+ ##
1925
1707
  attr_reader :nanos
1926
1708
 
1927
1709
  def initialize(
@@ -1933,15 +1715,10 @@ module Cucumber
1933
1715
  end
1934
1716
  end
1935
1717
 
1936
-
1937
1718
  ##
1938
1719
  # Represents the UndefinedParameterType message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
1939
- #
1940
-
1941
- #
1942
-
1720
+ ##
1943
1721
  class UndefinedParameterType < ::Cucumber::Messages::Message
1944
-
1945
1722
  attr_reader :expression
1946
1723
 
1947
1724
  attr_reader :name
@@ -1954,7 +1731,6 @@ module Cucumber
1954
1731
  @name = name
1955
1732
  end
1956
1733
  end
1957
-
1958
1734
  end
1959
1735
  end
1960
1736
 
@@ -1997,4 +1773,3 @@ class Cucumber::Messages::TestStepResultStatus
1997
1773
  AMBIGUOUS = 'AMBIGUOUS'
1998
1774
  FAILED = 'FAILED'
1999
1775
  end
2000
-