cucumber-messages 16.0.1 → 17.1.1

data/lib/cucumber/messages.rb

@@ -1,6 +1,7 @@
 require 'cucumber/messages/ndjson_to_message_enumerator'
 require 'cucumber/messages/time_conversion'
 require 'cucumber/messages/id_generator'
+require 'cucumber/messages.deserializers'
 
 module Cucumber
   module Messages

data/spec/cucumber/messages/acceptance_spec.rb

@@ -0,0 +1,27 @@
+require 'json'
+require 'cucumber/messages'
+
+module Cucumber
+  module Messages
+    describe 'messages acdeptance tests' do
+      # TODO: Remove '/minimal' from the glob
+      Dir["#{File.dirname(__FILE__)}/../../../../../compatibility-kit/javascript/features/**/*.ndjson"].each do |ndjson_file|
+        it "deserialises and serialises messages in #{ndjson_file}" do
+          File.open(ndjson_file, 'r:utf-8') do |io|
+            io.each_line do |json|
+              check(json)
+            end
+          end
+        end
+      end
+
+      def check(json)
+        hash = JSON.parse(json)
+        envelope = Envelope.from_json(json)
+        new_json = envelope.to_json
+        new_hash = JSON.parse(new_json)
+        expect(new_hash).to eq(hash)
+      end
+    end
+  end
+end

data/spec/cucumber/messages/message/deserialization_spec.rb

@@ -0,0 +1,30 @@
+require 'rspec'
+require 'cucumber/messages/message/dummy_messages'
+
+describe Cucumber::Messages::Message::Deserialization do
+  describe '#from_json' do
+    subject { Cucumber::Messages::Message.from_json(json_document) }
+
+    let(:json_document) { '' }
+
+    context 'with a valid JSON document' do
+      let(:json_document) { '{"simpleMessage":{"isString":"answer"}}' }
+
+      it 'deserialize the message using #from_h' do
+        allow(Cucumber::Messages::Message).to receive(:from_h)
+
+        subject
+
+        expect(Cucumber::Messages::Message)
+          .to have_received(:from_h)
+          .with({ simpleMessage: { isString: "answer" } })
+      end
+    end
+
+    context 'with an invalid JSON document' do
+      let(:json_document) { '{foo: bar}' }
+
+      it { expect { subject }.to raise_error(JSON::ParserError) }
+    end
+  end
+end

data/spec/cucumber/messages/message/dummy_messages.rb

@@ -0,0 +1,38 @@
+require 'cucumber/messages/message'
+
+module Cucumber::Messages
+  class SimpleMessage < Message
+    attr_reader :is_nil, :is_string, :is_array, :is_number
+
+    def initialize(is_nil: nil, is_string: '', is_array: [], is_number: 0)
+      @is_nil = is_nil
+      @is_string = is_string
+      @is_array = is_array
+      @is_number = is_number
+    end
+  end
+
+  class EnumMessage
+    ENUM = 'an enum'
+  end
+
+  class ComprehensiveMessage < Message
+    attr_reader :simple_message, :message_array, :is_enum
+
+    def initialize(
+      simple_message: SimpleMessage.new,
+      message_array: [SimpleMessage.new, SimpleMessage.new],
+      is_enum: EnumMessage::ENUM
+    )
+      @simple_message = simple_message
+      @message_array = message_array
+      @is_enum = is_enum
+    end
+
+    private
+
+    def self.message_array_from_h(hash)
+      SimpleMessage.from_h(hash)
+    end
+  end
+end

data/spec/cucumber/messages/message/serialization_spec.rb

@@ -0,0 +1,89 @@
+require 'rspec'
+require 'cucumber/messages/message/dummy_messages'
+
+describe Cucumber::Messages::Message::Serialization do
+  context 'with a simple message' do
+    describe '#to_h' do
+      subject { Cucumber::Messages::SimpleMessage.new.to_h }
+
+      it 'returns a Hash with all the attributes of the Message' do
+        expect(subject).to eq({ is_nil: nil, is_string: '', is_array: [], is_number: 0 })
+      end
+
+      context 'whith camelize: true' do
+        subject { Cucumber::Messages::SimpleMessage.new.to_h(camelize: true) }
+
+        it 'camelize the keys of the resulting hash' do
+          expect(subject).to eq({ isNil: nil, isString: '', isArray: [], isNumber: 0 })
+        end
+      end
+
+      context 'with reject_nil_values: true' do
+        subject { Cucumber::Messages::SimpleMessage.new.to_h(reject_nil_values: true) }
+
+        it 'rejects nil values from the resulting hash' do
+          expect(subject).to eq({ is_string: '', is_array: [], is_number: 0 })
+        end
+      end
+    end
+
+    describe '#to_json' do
+      subject { Cucumber::Messages::SimpleMessage.new.to_json }
+
+      it 'returns a JSON document with all the attributes of the Message except nil values' do
+        expect(subject).to eq({ isString: '', isArray: [], isNumber: 0 }.to_json)
+      end
+    end
+  end
+
+  context 'with a message which embeds other messages' do
+    describe '#to_h' do
+      subject { Cucumber::Messages::ComprehensiveMessage.new.to_h }
+
+      it 'includes hash representation of embedded messages' do
+        expect(subject[:simple_message]).to eq({ is_nil: nil, is_string: '', is_array: [], is_number: 0 })
+        expect(subject[:is_enum]).to eq 'an enum'
+      end
+
+      it 'includes hash representation of messages arrays' do
+        expect(subject[:message_array]).to eq([
+          { is_nil: nil, is_string: '', is_array: [], is_number: 0 },
+          { is_nil: nil, is_string: '', is_array: [], is_number: 0 }
+        ])
+      end
+
+      context 'whith camelize: true' do
+        subject { Cucumber::Messages::ComprehensiveMessage.new.to_h(camelize: true) }
+
+        it 'camelize the keys of the embedded messages resulting hashes' do
+          expect(subject[:simpleMessage]).to eq({ isNil: nil, isString: '', isArray: [], isNumber: 0 })
+        end
+
+        it 'camelize the keys of hashes for messages arrays' do
+          expect(subject[:messageArray]).to eq([
+            { isNil: nil, isString: '', isArray: [], isNumber: 0 },
+            { isNil: nil, isString: '', isArray: [], isNumber: 0 }
+          ])
+        end
+      end
+    end
+
+    describe '#to_json' do
+      subject { Cucumber::Messages::ComprehensiveMessage.new.to_json }
+
+      it 'returns a JSON document with embedded messages' do
+        expect(subject).to include({ isString: '', isArray: [], isNumber: 0}.to_json)
+        expect(subject).to include('"isEnum":"an enum"')
+      end
+
+      it 'returns a JSON document with messages arrays' do
+        expect(subject).to include(
+          [
+            { isString: '', isArray: [], isNumber: 0},
+            { isString: '', isArray: [], isNumber: 0}
+          ].to_json
+        )
+      end
+    end
+  end
+end

data/spec/cucumber/messages/message/utils_spec.rb

@@ -0,0 +1,30 @@
+require 'rspec'
+require 'cucumber/messages/message/utils'
+
+class DummyTestClass
+  include Cucumber::Messages::Message::Utils
+end
+
+describe Cucumber::Messages::Message::Utils do
+  subject { DummyTestClass }
+
+  describe '#underscore' do
+    it { expect(subject.underscore('test')).to eq 'test' }
+    it { expect(subject.underscore('testTest')).to eq 'test_test' }
+    it { expect(subject.underscore('')).to eq '' }
+    it { expect(subject.underscore('T')).to eq 't' }
+    it { expect(subject.underscore('test123test456Test')).to eq 'test123test456_test' }
+    it { expect(subject.underscore('test-test')).to eq 'test_test' }
+    it { expect(subject.underscore('TEST_Test')).to eq 'test_test' }
+    it { expect(subject.underscore('test-Test')).to eq 'test_test' }
+  end
+
+  describe '#camelize' do
+    it { expect(subject.camelize('test')).to eq 'test' }
+    it { expect(subject.camelize('test_test')).to eq 'testTest' }
+    it { expect(subject.camelize('Test_TeSt')).to eq 'TestTest' }
+    it { expect(subject.camelize('')).to eq '' }
+    it { expect(subject.camelize('test123test4_5_6_test')).to eq 'test123test456Test' }
+    it { expect(subject.camelize('test-test')).to eq 'test-test' }
+  end
+end

data/spec/cucumber/messages/ndjson_serialization_spec.rb

@@ -3,27 +3,28 @@ require 'cucumber/messages'
 module Cucumber
   module Messages
     describe 'messages' do
-      it "can be serialised over an ndjson stream" do
-        outgoing_messages = [
-          {'source' => {'data' => 'Feature: Hello'}},
-          {'attachment' => {'binary' => [1,2,3,4].pack('C*')}}
+      let(:outgoing_messages) do
+        [
+          Envelope.new(
+            source: Source.new(data: 'Feature: Hello')
+          ),
+          Envelope.new(
+            attachment: Attachment.new(body: 'Hello', content_encoding: AttachmentContentEncoding::IDENTITY)
+          )
         ]
+      end
 
+      it "can be serialised over an ndjson stream" do
         io = StringIO.new
         write_outgoing_messages(outgoing_messages, io)
 
         io.rewind
         incoming_messages = NdjsonToMessageEnumerator.new(io)
 
-        expect(incoming_messages.to_a).to(eq(outgoing_messages))
+        expect(incoming_messages.to_a.map(&:to_h)).to(eq(outgoing_messages.map(&:to_h)))
       end
 
       it "ignores empty lines" do
-        outgoing_messages = [
-          {'source' => {'data' => 'Feature: Hello'}},
-          {'attachment' => {'binary' => [1,2,3,4].pack('C*')}}
-        ]
-
         io = StringIO.new
         write_outgoing_messages(outgoing_messages, io)
         io.write("\n\n")
@@ -31,7 +32,7 @@ module Cucumber
         io.rewind
         incoming_messages = NdjsonToMessageEnumerator.new(io)
 
-        expect(incoming_messages.to_a).to(eq(outgoing_messages))
+        expect(incoming_messages.to_a.map(&:to_h)).to(eq(outgoing_messages.map(&:to_h)))
       end
 
       it "includes offending line in error message" do

data/spec/cucumber/messages/time_conversion_spec.rb

@@ -28,6 +28,14 @@ module Cucumber
 
         expect(duration_in_seconds_again).to be_within(0.000000001).of(duration_in_seconds)
       end
+
+      it 'converts to a hash where seconds and nanos are integers' do
+        duration_in_seconds = 3.000161
+        duration = seconds_to_duration(duration_in_seconds)
+
+        expect(duration['seconds']).to be_integer
+        expect(duration['nanos']).to be_integer
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-messages
 version: !ruby/object:Gem::Version
-  version: 16.0.1
+  version: 17.1.1
 platform: ruby
 authors:
 - Aslak Hellesøy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -19,7 +19,7 @@ dependencies:
         version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,12 +59,23 @@ files:
 - LICENSE
 - README.md
 - VERSION
+- lib/cucumber/messages.deserializers.rb
+- lib/cucumber/messages.dtos.rb
 - 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
 - spec/capture_warnings.rb
+- spec/cucumber/messages/acceptance_spec.rb
 - spec/cucumber/messages/id_generator_spec.rb
+- spec/cucumber/messages/message/deserialization_spec.rb
+- spec/cucumber/messages/message/dummy_messages.rb
+- spec/cucumber/messages/message/serialization_spec.rb
+- spec/cucumber/messages/message/utils_spec.rb
 - spec/cucumber/messages/ndjson_serialization_spec.rb
 - spec/cucumber/messages/time_conversion_spec.rb
 - spec/cucumber/messages/version_spec.rb
@@ -96,10 +107,15 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: cucumber-messages-16.0.1
+summary: cucumber-messages-17.1.1
 test_files:
-- spec/capture_warnings.rb
-- spec/cucumber/messages/id_generator_spec.rb
-- spec/cucumber/messages/ndjson_serialization_spec.rb
-- spec/cucumber/messages/time_conversion_spec.rb
 - spec/cucumber/messages/version_spec.rb
+- spec/cucumber/messages/time_conversion_spec.rb
+- spec/cucumber/messages/message/dummy_messages.rb
+- spec/cucumber/messages/message/deserialization_spec.rb
+- spec/cucumber/messages/message/utils_spec.rb
+- spec/cucumber/messages/message/serialization_spec.rb
+- spec/cucumber/messages/ndjson_serialization_spec.rb
+- spec/cucumber/messages/id_generator_spec.rb
+- spec/cucumber/messages/acceptance_spec.rb
+- spec/capture_warnings.rb