cucumber-messages 33.0.2 → 33.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286fdb380e31145153dbfd4768f3c568d32722280ace209c8fe781e8cf9d2062
-  data.tar.gz: bdf782a70a98e6b30cb69a758b253562fc853a26d689f988115f82f125d4a711
+  metadata.gz: ebfbb934be415f5579944c4b44c4dc07ef7fde6a283e36d4de17d6cc8619b2a3
+  data.tar.gz: c2699843f6c5685e209fc51333977c71603e0fe28089c25dd296d53a7fb6df9b
 SHA512:
-  metadata.gz: 92000d25b584017196d62eb3814a88cbabf6ccb49b2bde7e7052d243af6d62896f994c32a3b871e3ee62e257699350465da150e52a0a2e199f4b25ec0c2b9ac9
-  data.tar.gz: c69c3513e5b0ac50ca80c90d1c786f35039ca66fc6e37efda2bae5703e82c9d125d54fcfcdc101ded0389d3f4fdb42d06511c8405b6cbbb1eadff9770d978ce7
+  metadata.gz: '0309d95a3f3770cc347c8003dd9d88819b170d70407779bdd884b3040ffa100d2614a253fd598b1ef37fc27c8eee149066ff863be852e6b5b830a2698f546e5f'
+  data.tar.gz: d5523a5d07a06a3b6ddfb62ebb7f414ea5d01a5187ceff592183caaf37886cb11fb013621057481dd6d8319b68e21a7a1726530d5a3a32f95c9841ae0c36ff16

data/VERSION

@@ -1 +1 @@
-33.0.2
+33.0.3

data/lib/cucumber/messages/message.rb

@@ -67,22 +67,48 @@ module Cucumber
       # 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}'
+      #     # => {"seconds":1,"nanos":42}
       #   Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: 'abc-def').to_json
-      #     # => '{"name":"foo","astNodeId":"abc-def"}'
+      #     # => {"name":"foo","astNodeId":"abc-def"}
       #   Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: nil).to_json
-      #     # => '{"name":"foo"}'
+      #     # => {"name":"foo"}
       #
       # As with #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"}'
+      #     # => {"location":{"line":2,"column":null},"text":"comment"}
       ##
       def to_json(*_args)
         to_h(camelize: true, reject_nil_values: true).to_json
       end
 
+      ##
+      # Returns the type of the message as a hash with snake_cased symbols.
+      #   For example, the type of a `Cucumber::Messages::Duration` will be `:duration`.
+      #
+      #   Cucumber::Messages::Duration.new(seconds: 1, nanos: 42).type
+      #     # => { type: :duration }
+      #   Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: 'abc-def').type
+      #     # => { type: :pickle_tag }
+      #
+      # For Envelopes, the hash will return the type as `:envelope` but it will also indicate the nested envelope message
+      #
+      #   location = Cucumber::Messages::Location.new(line: 2)
+      #   Cucumber::Messages::Envelope.new(location: location).type
+      #     # => { type: :envelope, contained_message: :location }
+      ##
+      def type
+        if is_a?(Cucumber::Messages::Envelope)
+          {
+            type: :envelope,
+            contained_message: unwrapped_envelope_type
+          }
+        else
+          { type: underscore(self.class.to_s.split('::').last).to_sym }
+        end
+      end
+
       private
 
       def prepare_value(value, camelize:, reject_nil_values:)
@@ -94,6 +120,21 @@ module Cucumber
           value
         end
       end
+
+      # Simplified form of `TextHelpers` generator module
+      def underscore(klazz_name)
+        klazz_name.gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+                  .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                  .downcase
+      end
+
+      # This will scan each iVar and return the first one (Should only ever be one), that is not nil
+      def unwrapped_envelope_type
+        instance_variables.detect { |name| !instance_variable_get(name).nil? }
+                          .to_s
+                          .delete_prefix('@')
+                          .to_sym
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-messages
 version: !ruby/object:Gem::Version
-  version: 33.0.2
+  version: 33.0.3
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -203,5 +203,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: cucumber-messages-33.0.2
+summary: cucumber-messages-33.0.3
 test_files: []