cucumber-messages 0.0.0 → 1.0.0

data/messages.proto

@@ -0,0 +1,243 @@
+syntax = "proto3";
+import "google/protobuf/timestamp.proto";
+package io.cucumber.messages;
+option ruby_package = "Cucumber.Messages";
+option go_package = "messages";
+
+// All messages sent between processes must be of type Wrapper
+message Wrapper {
+  oneof message {
+    Source source = 1;
+    GherkinDocument gherkinDocument = 2;
+    Pickle pickle = 3;
+    Attachment attachment = 4;
+    TestCaseStarted testCaseStarted = 5;
+    TestStepStarted testStepStarted = 6;
+    TestStepFinished testStepFinished = 7;
+    TestCaseFinished testCaseFinished = 8;
+  }
+}
+
+////// Source
+
+message SourceReference {
+  string uri = 1;
+  Location location = 2;
+}
+
+message Location {
+  uint32 line = 1;
+  uint32 column = 2;
+}
+
+message Attachment {
+  SourceReference source = 1;
+  string data = 2;
+  Media media = 3;
+}
+
+message Media {
+  string encoding = 1;
+  string content_type = 2;
+}
+
+message Source {
+  string uri = 1;
+  string data = 2;
+  Media media = 3;
+}
+
+////// Gherkin
+
+message GherkinDocument {
+  string uri = 1;
+  Feature feature = 2;
+  repeated Comment comments = 3;
+}
+
+message Feature {
+  Location location = 1;
+  repeated Tag tags = 2;
+  string language = 3;
+  string keyword = 4;
+  string name = 5;
+  string description = 6;
+  repeated FeatureChild children = 7;
+}
+
+message FeatureChild {
+  oneof value {
+    Rule rule = 1;
+    Background background = 2;
+    Scenario scenario = 3;
+  }
+}
+
+message Rule {
+  Location location = 1;
+  string keyword = 2;
+  string name = 3;
+  string description = 4;
+  repeated RuleChild children = 5;
+}
+
+message RuleChild {
+  oneof value {
+    Background background = 1;
+    Scenario scenario = 2;
+  }
+}
+
+message Background {
+  Location location = 1;
+  string keyword = 2;
+  string name = 3;
+  string description = 4;
+  repeated Step steps = 5;
+}
+
+message Scenario {
+  Location location = 1;
+  repeated Tag tags = 2;
+  string keyword = 3;
+  string name = 4;
+  string description = 5;
+  repeated Step steps = 6;
+  repeated Examples examples = 7;
+}
+
+message Comment {
+  Location location = 1;
+  string text = 2;
+}
+
+message DataTable {
+  Location location = 1;
+  repeated TableRow rows = 2;
+}
+
+message DocString {
+  Location location = 1;
+  string content_type = 2;
+  string content = 3;
+  string delimiter = 4;
+}
+
+message Examples {
+  Location location = 1;
+  repeated Tag tags = 2;
+  string keyword = 3;
+  string name = 4;
+  string description = 5;
+  TableRow table_header = 6;
+  repeated TableRow table_body = 7;
+}
+
+message Step {
+  Location location = 1;
+  string keyword = 2;
+  string text = 3;
+  oneof argument {
+    DocString doc_string = 5;
+    DataTable data_table = 6;
+  }
+}
+
+message TableCell {
+  Location location = 1;
+  string value = 2;
+}
+
+message TableRow {
+  Location location = 1;
+  repeated TableCell cells = 2;
+}
+
+message Tag {
+  Location location = 1;
+  string name = 2;
+}
+
+////// Pickles
+
+message Pickle {
+  string id = 1;
+  string uri = 2;
+  string name = 3;
+  string language = 4;
+  repeated PickleStep steps = 5;
+  repeated PickleTag tags = 6;
+  repeated Location locations = 7;
+}
+
+message PickleStep {
+  string text = 1;
+  repeated Location locations = 2;
+  oneof argument {
+    PickleDocString doc_string = 3;
+    PickleTable data_table = 4;
+  }
+}
+
+message PickleDocString {
+  Location location = 1;
+  string contentType = 2;
+  string content = 3;
+}
+
+message PickleTable {
+  repeated PickleTableRow rows = 1;
+}
+
+message PickleTableCell {
+  Location location = 1;
+  string value = 2;
+}
+
+message PickleTableRow {
+  repeated PickleTableCell cells = 1;
+}
+
+message PickleTag {
+  Location location = 1;
+  string name = 2;
+}
+
+////// Results
+
+message TestCaseStarted {
+  string pickleId = 1;
+  google.protobuf.Timestamp timestamp = 2;
+}
+
+message TestCaseFinished {
+  string pickleId = 1;
+  google.protobuf.Timestamp timestamp = 2;
+}
+
+message TestStepStarted {
+  string pickleId = 1;
+  uint32 index = 2;
+  google.protobuf.Timestamp timestamp = 3;
+}
+
+message TestStepFinished {
+  string pickleId = 1;
+  uint32 index = 2;
+  TestResult testResult = 3;
+  google.protobuf.Timestamp timestamp = 4;
+}
+
+message TestResult {
+  Status status = 1;
+  string message = 2;
+}
+
+enum Status {
+  AMBIGUOUS = 0;
+  FAILED = 1;
+  PASSED = 2;
+  PENDING = 3;
+  SKIPPED = 4;
+  UNDEFINED = 5;
+}

data/spec/capture_warnings.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+# With thanks to @myronmarston
+# https://github.com/vcr/vcr/blob/master/spec/capture_warnings.rb
+
+module CaptureWarnings
+  def report_warnings(&block)
+    current_dir = Dir.pwd
+    warnings, errors = capture_error(&block).partition { |line| line.include?('warning') }
+    project_warnings, other_warnings = warnings.uniq.partition { |line| line.include?(current_dir) }
+
+    if errors.any?
+      puts errors.join("\n")
+    end
+
+    if other_warnings.any?
+      puts "#{ other_warnings.count } warnings detected, set VIEW_OTHER_WARNINGS=true to see them."
+      print_warnings('other', other_warnings) if ENV['VIEW_OTHER_WARNINGS']
+    end
+
+    # Until they fix https://bugs.ruby-lang.org/issues/10661
+    if RUBY_VERSION == "2.2.0"
+      project_warnings = project_warnings.reject { |w| w =~ /warning: possible reference to past scope/ }
+    end
+
+    if project_warnings.any?
+      puts "#{ project_warnings.count } warnings detected"
+      print_warnings('cucumber-expressions', project_warnings)
+      fail "Please remove all cucumber-expressions warnings."
+    end
+
+    ensure_system_exit_if_required
+  end
+
+  def capture_error(&block)
+    old_stderr = STDERR.clone
+    pipe_r, pipe_w = IO.pipe
+    pipe_r.sync    = true
+    error          = String.new
+    reader = Thread.new do
+      begin
+        loop do
+          error << pipe_r.readpartial(1024)
+        end
+      rescue EOFError
+      end
+    end
+    STDERR.reopen(pipe_w)
+    block.call
+  ensure
+    capture_system_exit
+    STDERR.reopen(old_stderr)
+    pipe_w.close
+    reader.join
+    return error.split("\n")
+  end
+
+  def print_warnings(type, warnings)
+    puts
+    puts "-" * 30 + " #{type} warnings: " + "-" * 30
+    puts
+    puts warnings.join("\n")
+    puts
+    puts "-" * 75
+    puts
+  end
+
+  def ensure_system_exit_if_required
+    raise @system_exit if @system_exit
+  end
+
+  def capture_system_exit
+    @system_exit = $!
+  end
+end

data/spec/coverage.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'simplecov'
+formatters = [ SimpleCov::Formatter::HTMLFormatter ]
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(*formatters)
+SimpleCov.add_filter 'spec/'
+SimpleCov.start

data/spec/cucumber/messages/messages_spec.rb

@@ -0,0 +1,23 @@
+require 'cucumber/messages_pb'
+require 'json'
+
+module Cucumber
+  module Messages
+    describe Messages do
+      it "builds a pickle doc string" do
+        location = Location.new(line: 10, column: 20)
+        pickle_doc_tring = PickleDocString.new(
+          location: location, 
+          contentType: 'text/plain', 
+          content: 'some\ncontent\n'
+        )
+        expect(JSON.parse(PickleDocString.encode_json(pickle_doc_tring)))
+          .to(eq(
+            'location' => { 'line' => 10, 'column' => 20 },
+            'contentType' => 'text/plain',
+            'content' => 'some\ncontent\n' 
+          ))
+      end
+    end
+  end
+end

metadata

@@ -1,118 +1,114 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-messages
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Aslak Hellesøy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-25 00:00:00.000000000 Z
+date: 2018-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cucumber-compatibility-kit
+  name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
+        version: 3.6.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 3.6.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.0
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.0
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
-description: JSON schema-based messages for Cucumber's inter-process communication
+        version: '0'
+description: Protocol Buffer messages for Cucumber's inter-process communication
 email: cukes@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".rspec"
+- ".rsync"
+- ".subrepo"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- Makefile
 - README.md
-- VERSION
-- lib/cucumber/messages.deserializers.rb
-- lib/cucumber/messages.dtos.rb
+- Rakefile
+- cucumber-messages.gemspec
+- default.mk
 - lib/cucumber/messages.rb
-- lib/cucumber/messages/id_generator.rb
-- lib/cucumber/messages/message.rb
-- lib/cucumber/messages/message/deserialization.rb
-- lib/cucumber/messages/message/serialization.rb
-- lib/cucumber/messages/message/utils.rb
-- lib/cucumber/messages/ndjson_to_message_enumerator.rb
-- lib/cucumber/messages/time_conversion.rb
-homepage: https://github.com/cucumber/messages-ruby#readme
+- lib/cucumber/messages_pb.rb
+- messages.proto
+- spec/capture_warnings.rb
+- spec/coverage.rb
+- spec/cucumber/messages/messages_spec.rb
+homepage: https://github.com/cucumber/cucumber-messages-ruby#readme
 licenses:
 - MIT
-metadata:
-  bug_tracker_uri: https://github.com/cucumber/messages/issues
-  changelog_uri: https://github.com/cucumber/messages/blob/main/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/github/cucumber/messages
-  mailing_list_uri: https://groups.google.com/forum/#!forum/cukes
-  source_code_uri: https://github.com/cucumber/messages
+metadata: {}
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -122,15 +118,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: cucumber-messages-0.0.0
-test_files: []
+summary: cucumber-messages-1.0.0
+test_files:
+- spec/capture_warnings.rb
+- spec/coverage.rb
+- spec/cucumber/messages/messages_spec.rb

data/VERSION

@@ -1 +0,0 @@
-0.0.0

data/lib/cucumber/messages/id_generator.rb

@@ -1,24 +0,0 @@
-require 'securerandom'
-
-module Cucumber
-  module Messages
-    module IdGenerator
-      class Incrementing
-        def initialize
-          @index = -1
-        end
-
-        def new_id
-          @index += 1
-          @index.to_s
-        end
-      end
-
-      class UUID
-        def new_id
-          SecureRandom.uuid
-        end
-      end
-    end
-  end
-end

data/lib/cucumber/messages/message/deserialization.rb

@@ -1,37 +0,0 @@
-require 'cucumber/messages/message/utils'
-require 'json'
-
-module Cucumber
-  module Messages
-    class Message
-      include Cucumber::Messages::Message::Utils
-
-      module Deserialization
-        def self.included(other)
-          other.extend(ClassMethods)
-        end
-
-        module ClassMethods
-          ##
-          # Returns a new Message - or messages into an array - deserialized from the given json document.
-          # CamelCased keys are properly converted to snake_cased attributes in the process
-          #
-          #   Cucumber::Messages::Duration.from_json('{"seconds":1,"nanos":42}')               # => #<Cucumber::Messages::Duration:0x00007efda134c290 @seconds=1, @nanos=42>
-          #   Cucumber::Messages::PickleTag.from_json('{"name":"foo","astNodeId":"abc-def"}')  # => #<Cucumber::Messages::PickleTag:0x00007efda138cdb8 @name="foo", @ast_node_id="abc-def">
-          #
-          # It is recursive so embedded messages are also processed.
-          #
-          #   json_string = { location: { line: 2 }, text: "comment" }.to_json
-          #   Cucumber::Messages::Comment.from_json(json_string)  # => #<Cucumber::Messages::Comment:0x00007efda6abf888 @location=#<Cucumber::Messages::Location:0x00007efda6abf978 @line=2, @column=nil>, @text="comment">
-          #
-          #   json_string = { uri: 'file:///...', comments: [{text: 'text comment'}, {text: 'another comment'}]}.to_json
-          #   Cucumber::Messages::GherkinDocument.from_json(json_string)  # => #<Cucumber::Messages::GherkinDocument:0x00007efda11e6a90 ... @comments=[#<Cucumber::Messages::Comment:0x00007efda11e6e50 ..., #<Cucumber::Messages::Comment:0x00007efda11e6b58 ...>]>
-          ##
-          def from_json(json_string)
-            from_h(JSON.parse(json_string, { symbolize_names: true }))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/cucumber/messages/message/serialization.rb

@@ -1,70 +0,0 @@
-require 'cucumber/messages/message/utils'
-require 'json'
-
-module Cucumber
-  module Messages
-    class Message
-      include Cucumber::Messages::Message::Utils
-
-      module Serialization
-        ##
-        # Returns a new Hash formed from the message attributes
-        # If +camelize:+ keyword parameter is set to true, then keys will be camelized
-        # If +reject_nil_values:+ keyword parameter is set to true, resulting hash won't include nil values
-        #
-        #   Cucumber::Messages::Duration.new(seconds: 1, nanos: 42).to_h                                 # => { seconds: 1, nanos: 42 }
-        #   Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: 'abc-def').to_h(camelize: true)  # => { name: 'foo', astNodeId: 'abc-def' }
-        #   Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: nil).to_h(reject_nil_values: true)  # => { name: 'foo' }
-        #
-        # It is recursive so embedded messages are also processed
-        #
-        #   location = Cucumber::Messages::Location.new(line: 2)
-        #   Cucumber::Messages::Comment.new(location: location, text: 'comment').to_h  # => { location: { line: 2, :column: nil }, text: "comment" }
-        ##
-        def to_h(camelize: false, reject_nil_values: false)
-          resulting_hash = self.instance_variables.map do |variable_name|
-            h_key = variable_name[1..-1]
-            h_key = Cucumber::Messages::Message.camelize(h_key) if camelize
-
-            h_value = prepare_value(
-              self.instance_variable_get(variable_name),
-              camelize: camelize,
-              reject_nil_values: reject_nil_values
-            )
-
-            [ h_key.to_sym, h_value ]
-          end.to_h
-
-          resulting_hash.reject! { |_, value| value.nil? } if reject_nil_values
-          resulting_hash
-        end
-
-        ##
-        # Generates a JSON document from the message.
-        # Keys are camelized during the process. Null values are not part of the json document.
-        #
-        #   Cucumber::Messages::Duration.new(seconds: 1, nanos: 42).to_json                 # => '{"seconds":1,"nanos":42}'
-        #   Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: 'abc-def').to_json  # => '{"name":"foo","astNodeId":"abc-def"}'
-        #   Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: nil).to_json        # => '{"name":"foo"}'
-        #
-        # As #to_h, the method is recursive
-        #
-        #   location = Cucumber::Messages::Location.new(line: 2)
-        #   Cucumber::Messages::Comment.new(location: location, text: 'comment').to_json     # => '{"location":{"line":2,"column":null},"text":"comment"}'
-        ##
-        def to_json
-          to_h(camelize: true, reject_nil_values: true).to_json
-        end
-
-        private
-
-        def prepare_value(value, camelize:, reject_nil_values:)
-          return value.to_h(camelize: camelize, reject_nil_values: reject_nil_values) if value.is_a?(Cucumber::Messages::Message)
-          return value.map { |v| prepare_value(v, camelize: camelize, reject_nil_values: reject_nil_values) } if value.is_a?(Array)
-
-          value
-        end
-      end
-    end
-  end
-end