cucumber-messages 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fae43985a14dd510cdad40de4e15f44d41a25d2cc5872eb8ce95b486995ddf9e
-  data.tar.gz: 3bd925db18e60f98b718ebd017e328dcc2938c8022b526bf4d3e057ae1ecb39a
+  metadata.gz: 044b9422f8add17b93b133695227dcbdbe4076302237d4f0c8899f7d04b5d9e3
+  data.tar.gz: 849b9bc2ab915d84403548dd127bfed5d9c424f08a6e947b948412d4ad19bf7e
 SHA512:
-  metadata.gz: 120be88738c8374cd69723b9e4b2a33664f8f802cf72af92a46b6dfef12c9520b85c0e853861102bad57948f5f019d7cff50e5565833e91b2a136e7f3ae7a30d
-  data.tar.gz: ba5ccba6194a142270aadb05e5db76728a1dc57f1fe1617fd25d593f069761b4da0c95b06030da83051b7e932d2bd2e1d3050a144c44dbae5fef5ada0a4fae4d
+  metadata.gz: a90107ed2606654fbf979008588002686145f0b6474a123360b9c534057433be7696acfc156e8e64d8edf0f2f4926cc235d0b25ed2e4c1c1f27266e4f6a59fdc
+  data.tar.gz: 5fd6971db10cf0bf7abbc4e93d9a8ce878dbac47bca8b42cf70b3cb0221e96c5ff80e3063a261c050f987c3d1e2c84d5fd3a4270f03eb24506a763ccc10f6d49

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,5 @@
+PLEASE DO NOT CREATE ISSUES IN THIS REPO.
+THIS REPO IS A READ-ONLY MIRROR.
+
+Create your issue in the Cucumber monorepo instead:
+https://github.com/cucumber/cucumber/issues

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+PLEASE DO NOT CREATE PULL REAUESTS IN THIS REPO.
+THIS REPO IS A READ-ONLY MIRROR.
+
+Create your pull request in the Cucumber monorepo instead:
+https://github.com/cucumber/cucumber/pulls

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rsync

@@ -0,0 +1,4 @@
+../../LICENSE LICENSE
+../../.templates/github/ .github/
+../../.templates/ruby/ .
+../messages.proto messages.proto

data/.subrepo

@@ -0,0 +1 @@
+cucumber/cucumber-messages-ruby

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+
+rvm:
+  - "2.5.1"
+  - "2.4.4"
+  - "2.3.7"
+  - "2.2.10"
+  - "jruby-9.1.17.0"
+
+script: make default
+
+matrix:
+  allow_failures:
+  - rvm: "jruby-9.1.17.0"

data/Gemfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Cucumber Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Makefile

@@ -0,0 +1,9 @@
+include default.mk
+
+.deps: lib/cucumber/messages_pb.rb
+
+lib/cucumber/messages_pb.rb: messages.proto
+	protoc --ruby_out lib/cucumber $<
+
+clean:
+	rm -f lib/cucumber/messages_pb.rb

data/README.md

@@ -1,3 +1,3 @@
-# Cucumber Messages for Ruby (JSON schema)
+# Cucumber Messages for Ruby (Protocol Buffers)
 
-See main [README](../README.md)
+[![Build Status](https://travis-ci.org/cucumber/cucumber-messages-ruby.svg?branch=master)](https://travis-ci.org/cucumber/cucumber-messages-ruby)

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts  = %w[-r./spec/coverage -w]
+end
+
+require_relative 'spec/capture_warnings'
+include CaptureWarnings
+namespace :spec do
+  task :warnings do
+    report_warnings do
+      Rake::Task['spec'].invoke
+    end
+  end
+end
+
+task default: ['spec:warnings']

data/cucumber-messages.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = 'cucumber-messages'
+  s.version     = '1.0.0'
+  s.authors     = ["Aslak Hellesøy"]
+  s.description = "Protocol Buffer messages for Cucumber's inter-process communication"
+  s.summary     = "cucumber-messages-#{s.version}"
+  s.email       = 'cukes@googlegroups.com'
+  s.homepage    = "https://github.com/cucumber/cucumber-messages-ruby#readme"
+  s.platform    = Gem::Platform::RUBY
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 1.9.3"
+
+  # As of this writing (28 June 2018), the latest version is
+  # 3.6.0, which doesn't works with JRuby. 
+  # See https://github.com/google/protobuf/issues/1594 
+  # 3.1.0 works with JRuby, but fails with MRI 2.4.4 and above.
+  # There doesn't seem to be a version that works with all rubies,
+  # so we're picking the version that works with the most recent MRIs.
+  s.add_dependency 'google-protobuf', '3.6.1'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake',      '~> 12.3'
+  s.add_development_dependency 'rspec',     '~> 3.7'
+
+  # For coverage reports
+  s.add_development_dependency 'coveralls'
+
+  s.rubygems_version = ">= 1.6.1"
+  s.files            = `git ls-files`.split("\n").reject {|path| path =~ /\.gitignore$/ }
+  s.test_files       = `git ls-files -- spec/*`.split("\n")
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+end

data/default.mk

@@ -0,0 +1,33 @@
+SHELL := /usr/bin/env bash
+RUBY_SOURCE_FILES = $(shell find . -name "*.rb")
+GEMSPECS = $(shell find . -name "*.gemspec")
+
+ifdef TRAVIS_BRANCH
+	LIBRARY_VERSION=$(TRAVIS_BRANCH)
+endif
+ifdef TRAVIS_TAG
+	LIBRARY_VERSION=$(TRAVIS_TAG)
+endif
+ifndef LIBRARY_VERSION
+	LIBRARY_VERSION=$(shell git rev-parse --abbrev-ref HEAD)
+endif
+
+default: .tested
+.PHONY: default
+
+.deps: Gemfile.lock
+
+Gemfile.lock: Gemfile $(GEMSPECS)
+	bundle install
+	touch $@
+
+.tested: .deps $(RUBY_SOURCE_FILES)
+	bundle exec rspec --color
+	touch $@
+
+clean: clean-ruby
+.PHONY: clean
+
+clean-ruby:
+	rm -f .deps .linked .tested Gemfile.lock
+.PHONY: clean-ruby

data/lib/cucumber/messages.rb

@@ -1,10 +1,36 @@
-require 'cucumber/messages/ndjson_to_message_enumerator'
-require 'cucumber/messages/time_conversion'
-require 'cucumber/messages/id_generator'
-require 'cucumber/messages.deserializers'
+require 'cucumber/messages_pb'
 
 module Cucumber
   module Messages
-    VERSION = File.read(File.expand_path("../../VERSION", __dir__)).strip
+    module Varint
+      def decode_varint(io)
+        # https://github.com/ruby-protobuf/protobuf/blob/master/lib/protobuf/varint_pure.rb
+        value = index = 0
+        begin
+          byte = io.readbyte
+          value |= (byte & 0x7f) << (7 * index)
+          index += 1
+        end while (byte & 0x80).nonzero?
+        value
+      end
+
+      # https://www.rubydoc.info/gems/ruby-protocol-buffers/1.2.2/ProtocolBuffers%2FVarint.encode
+      def encode_varint(io, int_val)
+        if int_val < 0
+          # negative varints are always encoded with the full 10 bytes
+          int_val = int_val & 0xffffffff_ffffffff
+        end
+        loop do
+          byte = int_val & 0x7f
+          int_val >>= 7
+          if int_val == 0
+            io << byte.chr
+            break
+          else
+            io << (byte | 0x80).chr
+          end
+        end
+      end
+    end
   end
-end
+end

data/lib/cucumber/messages_pb.rb

@@ -0,0 +1,242 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: messages.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "io.cucumber.messages.Wrapper" do
+    oneof :message do
+      optional :source, :message, 1, "io.cucumber.messages.Source"
+      optional :gherkinDocument, :message, 2, "io.cucumber.messages.GherkinDocument"
+      optional :pickle, :message, 3, "io.cucumber.messages.Pickle"
+      optional :attachment, :message, 4, "io.cucumber.messages.Attachment"
+      optional :testCaseStarted, :message, 5, "io.cucumber.messages.TestCaseStarted"
+      optional :testStepStarted, :message, 6, "io.cucumber.messages.TestStepStarted"
+      optional :testStepFinished, :message, 7, "io.cucumber.messages.TestStepFinished"
+      optional :testCaseFinished, :message, 8, "io.cucumber.messages.TestCaseFinished"
+    end
+  end
+  add_message "io.cucumber.messages.SourceReference" do
+    optional :uri, :string, 1
+    optional :location, :message, 2, "io.cucumber.messages.Location"
+  end
+  add_message "io.cucumber.messages.Location" do
+    optional :line, :uint32, 1
+    optional :column, :uint32, 2
+  end
+  add_message "io.cucumber.messages.Attachment" do
+    optional :source, :message, 1, "io.cucumber.messages.SourceReference"
+    optional :data, :string, 2
+    optional :media, :message, 3, "io.cucumber.messages.Media"
+  end
+  add_message "io.cucumber.messages.Media" do
+    optional :encoding, :string, 1
+    optional :content_type, :string, 2
+  end
+  add_message "io.cucumber.messages.Source" do
+    optional :uri, :string, 1
+    optional :data, :string, 2
+    optional :media, :message, 3, "io.cucumber.messages.Media"
+  end
+  add_message "io.cucumber.messages.GherkinDocument" do
+    optional :uri, :string, 1
+    optional :feature, :message, 2, "io.cucumber.messages.Feature"
+    repeated :comments, :message, 3, "io.cucumber.messages.Comment"
+  end
+  add_message "io.cucumber.messages.Feature" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    repeated :tags, :message, 2, "io.cucumber.messages.Tag"
+    optional :language, :string, 3
+    optional :keyword, :string, 4
+    optional :name, :string, 5
+    optional :description, :string, 6
+    repeated :children, :message, 7, "io.cucumber.messages.FeatureChild"
+  end
+  add_message "io.cucumber.messages.FeatureChild" do
+    oneof :value do
+      optional :rule, :message, 1, "io.cucumber.messages.Rule"
+      optional :background, :message, 2, "io.cucumber.messages.Background"
+      optional :scenario, :message, 3, "io.cucumber.messages.Scenario"
+    end
+  end
+  add_message "io.cucumber.messages.Rule" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :keyword, :string, 2
+    optional :name, :string, 3
+    optional :description, :string, 4
+    repeated :children, :message, 5, "io.cucumber.messages.RuleChild"
+  end
+  add_message "io.cucumber.messages.RuleChild" do
+    oneof :value do
+      optional :background, :message, 1, "io.cucumber.messages.Background"
+      optional :scenario, :message, 2, "io.cucumber.messages.Scenario"
+    end
+  end
+  add_message "io.cucumber.messages.Background" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :keyword, :string, 2
+    optional :name, :string, 3
+    optional :description, :string, 4
+    repeated :steps, :message, 5, "io.cucumber.messages.Step"
+  end
+  add_message "io.cucumber.messages.Scenario" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    repeated :tags, :message, 2, "io.cucumber.messages.Tag"
+    optional :keyword, :string, 3
+    optional :name, :string, 4
+    optional :description, :string, 5
+    repeated :steps, :message, 6, "io.cucumber.messages.Step"
+    repeated :examples, :message, 7, "io.cucumber.messages.Examples"
+  end
+  add_message "io.cucumber.messages.Comment" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :text, :string, 2
+  end
+  add_message "io.cucumber.messages.DataTable" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    repeated :rows, :message, 2, "io.cucumber.messages.TableRow"
+  end
+  add_message "io.cucumber.messages.DocString" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :content_type, :string, 2
+    optional :content, :string, 3
+    optional :delimiter, :string, 4
+  end
+  add_message "io.cucumber.messages.Examples" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    repeated :tags, :message, 2, "io.cucumber.messages.Tag"
+    optional :keyword, :string, 3
+    optional :name, :string, 4
+    optional :description, :string, 5
+    optional :table_header, :message, 6, "io.cucumber.messages.TableRow"
+    repeated :table_body, :message, 7, "io.cucumber.messages.TableRow"
+  end
+  add_message "io.cucumber.messages.Step" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :keyword, :string, 2
+    optional :text, :string, 3
+    oneof :argument do
+      optional :doc_string, :message, 5, "io.cucumber.messages.DocString"
+      optional :data_table, :message, 6, "io.cucumber.messages.DataTable"
+    end
+  end
+  add_message "io.cucumber.messages.TableCell" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :value, :string, 2
+  end
+  add_message "io.cucumber.messages.TableRow" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    repeated :cells, :message, 2, "io.cucumber.messages.TableCell"
+  end
+  add_message "io.cucumber.messages.Tag" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :name, :string, 2
+  end
+  add_message "io.cucumber.messages.Pickle" do
+    optional :id, :string, 1
+    optional :uri, :string, 2
+    optional :name, :string, 3
+    optional :language, :string, 4
+    repeated :steps, :message, 5, "io.cucumber.messages.PickleStep"
+    repeated :tags, :message, 6, "io.cucumber.messages.PickleTag"
+    repeated :locations, :message, 7, "io.cucumber.messages.Location"
+  end
+  add_message "io.cucumber.messages.PickleStep" do
+    optional :text, :string, 1
+    repeated :locations, :message, 2, "io.cucumber.messages.Location"
+    oneof :argument do
+      optional :doc_string, :message, 3, "io.cucumber.messages.PickleDocString"
+      optional :data_table, :message, 4, "io.cucumber.messages.PickleTable"
+    end
+  end
+  add_message "io.cucumber.messages.PickleDocString" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :contentType, :string, 2
+    optional :content, :string, 3
+  end
+  add_message "io.cucumber.messages.PickleTable" do
+    repeated :rows, :message, 1, "io.cucumber.messages.PickleTableRow"
+  end
+  add_message "io.cucumber.messages.PickleTableCell" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :value, :string, 2
+  end
+  add_message "io.cucumber.messages.PickleTableRow" do
+    repeated :cells, :message, 1, "io.cucumber.messages.PickleTableCell"
+  end
+  add_message "io.cucumber.messages.PickleTag" do
+    optional :location, :message, 1, "io.cucumber.messages.Location"
+    optional :name, :string, 2
+  end
+  add_message "io.cucumber.messages.TestCaseStarted" do
+    optional :pickleId, :string, 1
+    optional :timestamp, :message, 2, "google.protobuf.Timestamp"
+  end
+  add_message "io.cucumber.messages.TestCaseFinished" do
+    optional :pickleId, :string, 1
+    optional :timestamp, :message, 2, "google.protobuf.Timestamp"
+  end
+  add_message "io.cucumber.messages.TestStepStarted" do
+    optional :pickleId, :string, 1
+    optional :index, :uint32, 2
+    optional :timestamp, :message, 3, "google.protobuf.Timestamp"
+  end
+  add_message "io.cucumber.messages.TestStepFinished" do
+    optional :pickleId, :string, 1
+    optional :index, :uint32, 2
+    optional :testResult, :message, 3, "io.cucumber.messages.TestResult"
+    optional :timestamp, :message, 4, "google.protobuf.Timestamp"
+  end
+  add_message "io.cucumber.messages.TestResult" do
+    optional :status, :enum, 1, "io.cucumber.messages.Status"
+    optional :message, :string, 2
+  end
+  add_enum "io.cucumber.messages.Status" do
+    value :AMBIGUOUS, 0
+    value :FAILED, 1
+    value :PASSED, 2
+    value :PENDING, 3
+    value :SKIPPED, 4
+    value :UNDEFINED, 5
+  end
+end
+
+module Cucumber
+  module Messages
+    Wrapper = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Wrapper").msgclass
+    SourceReference = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.SourceReference").msgclass
+    Location = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Location").msgclass
+    Attachment = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Attachment").msgclass
+    Media = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Media").msgclass
+    Source = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Source").msgclass
+    GherkinDocument = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.GherkinDocument").msgclass
+    Feature = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Feature").msgclass
+    FeatureChild = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.FeatureChild").msgclass
+    Rule = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Rule").msgclass
+    RuleChild = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.RuleChild").msgclass
+    Background = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Background").msgclass
+    Scenario = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Scenario").msgclass
+    Comment = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Comment").msgclass
+    DataTable = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.DataTable").msgclass
+    DocString = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.DocString").msgclass
+    Examples = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Examples").msgclass
+    Step = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Step").msgclass
+    TableCell = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.TableCell").msgclass
+    TableRow = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.TableRow").msgclass
+    Tag = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Tag").msgclass
+    Pickle = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Pickle").msgclass
+    PickleStep = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.PickleStep").msgclass
+    PickleDocString = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.PickleDocString").msgclass
+    PickleTable = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.PickleTable").msgclass
+    PickleTableCell = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.PickleTableCell").msgclass
+    PickleTableRow = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.PickleTableRow").msgclass
+    PickleTag = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.PickleTag").msgclass
+    TestCaseStarted = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.TestCaseStarted").msgclass
+    TestCaseFinished = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.TestCaseFinished").msgclass
+    TestStepStarted = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.TestStepStarted").msgclass
+    TestStepFinished = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.TestStepFinished").msgclass
+    TestResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.TestResult").msgclass
+    Status = Google::Protobuf::DescriptorPool.generated_pool.lookup("io.cucumber.messages.Status").enummodule
+  end
+end