[Ruby] Split messages files per message type

CHANGELOG.md

@@ -7,9 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 ### Changed
+- [Ruby] **Breaking change** Messages are now altered to be 1 message class per file ([#225](https://github.com/cucumber/messages/pull/225) [luke-hill](https://github.com/luke-hill))
 - [Ruby] Updated minimum Ruby version to 3.0 ([#216](https://github.com/cucumber/messages/pull/216) [luke-hill](https://github.com/luke-hill))
 - [Ruby] Use latest CCK conformance for signing off message releases ([#216](https://github.com/cucumber/messages/pull/216) [luke-hill](https://github.com/luke-hill))
-- [Ruby] Tidied up around 80% of all of the rubocop `Layout` offenses (This included 2 minor alterations to the generator code) ([#217](https://github.com/cucumber/messages/pull/217) [luke-hill](https://github.com/luke-hill))
+- [Ruby] Tidied up all remaining rubocop offenses (This included 2 minor alterations to the generator code) ([#217](https://github.com/cucumber/messages/pull/217) [#225](https://github.com/cucumber/messages/pull/225) [luke-hill](https://github.com/luke-hill))
 - [Php] Permit both PHPUnit 10 and PHPUnit 11 ([#200](https://github.com/cucumber/messages/pull/200) [ciaranmcnulty](https://github.com/ciaranmcnulty))
 
 ### Fixed

CONTRIBUTING.md

@@ -7,7 +7,7 @@ Some guidelines for making schema changes:
 - Use the most appropriate data type
 - Follow existing naming conventions (camelCase)
 - Add new fields last to minimise impact on consuming code
-- Probably don't add a new field as `required` - this will make the new code unable to read existing messages
+- Don't add a new field as `required` - this will make the new code unable to read existing messages
 - Ideally add a description to any new fields
 
 If you need some advice, drop into the `#committers` channel on the [Cucumber Slack](https://cucumber.io/community#slack) and ask.
@@ -20,24 +20,23 @@ The code for various languages is generated from the JSON files. You can clean a
 make clean-all generate-all
 ```
 
-This requires various tooling to be installed on your computer, including Ruby and Node.js. If you're missing some of it, you might find it easier to run a Docker container that has everything:
+Or you can alternative clean and generate code for just one language by cd'ing into that languages directory
+and then running the following commands
 
 ```shell
-docker run --volume $PWD:/app --user 1000 -it cucumber/cucumber-build:latest bash
+cd ruby # Or another alternative
+make clean generate
 ```
 
-For Windows (Powershell):
-
-```shell
-docker run --volume  ${PWD}:/app --user 1000 -it cucumber/cucumber-build:latest bash
-```
-
-You can then run the same command as noted previously.
+This requires various tooling to be installed on your computer, including Ruby and Node.js.
 
 ### New files
 
-If you're adding a new file to the `jsonschema` directory, you'll need to add a reference to it near the top of the `Makefile` at the root in order for it to be included in the code generation.
+If you're adding a new file to the `jsonschema` directory, you'll need to add a reference to it near the top of the `Makefile`
+at the root in order for it to be included in the code generation.
 
 ## Tests
 
-Some of the language-specific directories contain some smoke tests to ensure (de)serialization, validation etc are working right. If you happen to change one of the messages that's constructed by these tests, you may need to update them. If you're not sure, raise a draft PR and see what happens in CI.
+Some of the language-specific directories contain some smoke tests to ensure (de)serialization, validation etc
+are working right. If you happen to change one of the messages that's constructed by these tests, you may
+need to update them. If you're not sure, raise a draft PR and see what happens in CI.

README.md

@@ -56,8 +56,8 @@ Cucumber needs to produce results in a machine-readable format so that other too
 
 ![messages-stream.svg](messages-stream.svg)
 
-Historically, Cucumber has done this with the `json` and `junit` formatters.
-These formats have several shortcomings that are addressed by Cucumber Messages.
+Historically, Cucumber did this with the `json` and `junit` formatters.
+These formats however, have several shortcomings that are now addressed by using Cucumber Messages.
 
 The `json` formatter is now in maintenance mode for these implementations, and Messages is the preferred standard.
 See [utilities](#utilities) for a list of tools that may help with backward and forward compatibility
@@ -78,15 +78,14 @@ of results.
 
 ### Lack of a schema
 
-The JSON report does not have a formal schema. This has led to slightly inconsistent implementations
+The JSON reporter does not have a formal schema. This has led to slightly inconsistent implementations
 of the JSON formatter in various Cucumber implementations. Consumers of the JSON format have
 to anticipate and detect these inconsistencies and try to cope with them.
 
 ### Limited information
 
 The `junit` XML format can only contain very limited information such as test case name and status.
-While there isn't an official schema for JUnit XML, there are a few defacto ones around, and they
-are very limited.
+While there isn't an official schema for JUnit XML, there are a few defacto ones around which are very limited.
 
 The `json` format represents the following information:
 

jsonschema/scripts/templates/ruby.enum.rb.erb

@@ -1,13 +1,15 @@
+<%- @enums.each do |enum| -%>
+<%= underscore(enum[:name]) %>.rb
+# frozen_string_literal: true
 
-<% @enums.each do |enum| -%>
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
 module Cucumber
   module Messages
     class <%= enum[:name] %>
-      <%- enum[:values].each_with_index do |value, index| -%>
+      <%- enum[:values].each do |value| -%>
       <%= enum_constant(value) %> = '<%= value %>'
       <%- end -%>
     end
   end
 end
-<%= "\n" unless enum == @enums.last -%>
-<%- end -%>
+<% end -%>

jsonschema/scripts/templates/ruby.rb.erb

@@ -1,15 +1,15 @@
-require 'cucumber/messages/message'
+<%- @schemas.each do |key, schema| -%>
+<%= underscore(class_name(key)) %>.rb
+# frozen_string_literal: true
 
 # The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
-#
-
 module Cucumber
   module Messages
-  <%- @schemas.each do |key, schema| %>
     ##
     # Represents the <%= class_name(key) %> message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
     <%= "#\n    " if schema['description'] %><%= format_description(schema['description']) %>
-    class <%= class_name(key) %> < ::Cucumber::Messages::Message
+    class <%= class_name(key) %> < Message
     <%- schema['properties'].each do |property_name, property| -%>
       <%- if property['description'] -%>
       ##
@@ -30,7 +30,34 @@ module Cucumber
       <%- end -%>
         super()
       end
+
+      ##
+      # Returns a new <%= class_name(key) %> from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::<%= class_name(key) %>.from_h(some_hash) # => #<Cucumber::Messages::<%= class_name(key) %>:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          <%-
+            schema['properties'].each do |property_name, property|
+              ref = property['$ref']
+              items_ref = property.dig('items', '$ref')
+          -%>
+          <%- final_key = property_name == schema['properties'].keys.last -%>
+          <%- comma = final_key ? '' : ',' -%>
+          <%= "#{underscore(property_name)}: " -%>
+          <%- if items_ref -%>hash[:<%= property_name -%>]&.map { |item| <%= class_name(items_ref) %>.from_h(item) }<%= comma %>
+          <%- elsif ref -%><%= class_name(ref) %>.from_h(hash[:<%= property_name %>])<%= comma %>
+          <%- else -%>hash[:<%= property_name %>]<%= comma %>
+          <%- end -%>
+          <%- end -%>
+        )
+      end
     end
-  <%- end -%>
   end
 end
+<% end -%>

ruby/.rubocop.yml

@@ -1,5 +1,3 @@
-inherit_from: .rubocop_todo.yml
-
 inherit_mode:
   merge:
     - Exclude
@@ -17,9 +15,16 @@ AllCops:
 Gemspec/RequireMFA:
   Enabled: false
 
-# Some long comments in the JSON Schema cause this to be un-enforceable
+# Generated messages (including the Envelope) aren't tested by the Metrics department because they have many
+# input properties for #initialize and .from_h which are generated 1-per-line. This renders most Metrics redundant
+Metrics:
+  Exclude:
+    - lib/cucumber/messages/*.rb
+
+# Long comments in the generated messages from the JSON Schemas cause this to be un-enforceable
 Layout/LineLength:
-  Max: 1000
+  Exclude:
+    - lib/cucumber/messages/*.rb
 
 Naming/MethodParameterName:
   AllowedNames:
@@ -31,7 +36,8 @@ RSpec/MessageSpies:
 # Because of the nature of large amounts of Accessors, we disable this cop
 # This is because many of them will have custom documentation which are auto-generated from the jsonschema
 Style/AccessorGrouping:
-  Enabled: false
+  Exclude:
+    - lib/cucumber/messages/*.rb
 
 Style/Documentation:
   Enabled: false