Use #to_hash instead of #as_json

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-12-24 10:13:24 UTC using RuboCop version 1.59.0.
+# on 2024-01-01 09:54:28 UTC using RuboCop version 1.59.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -27,7 +27,7 @@ Metrics/ClassLength:
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 105
+  Max: 111
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.

lib/operations.rb

@@ -15,12 +15,12 @@
 require "operations/contract"
 require "operations/contract/messages_resolver"
 require "operations/convenience"
-require "operations/command"
-require "operations/result"
 require "operations/form"
 require "operations/form/base"
 require "operations/form/attribute"
 require "operations/form/builder"
+require "operations/command"
+require "operations/result"
 
 # The root gem module
 module Operations

lib/operations/command.rb

@@ -290,11 +290,11 @@ def pretty_print(pp)
     end
   end
 
-  def as_json(*)
+  def to_hash
     {
-      **main_components_as_json,
-      **form_components_as_json,
-      configuration: configuration.as_json
+      **main_components_to_hash,
+      **form_components_to_hash,
+      configuration: configuration
     }
   end
 
@@ -304,7 +304,7 @@ def form_class
 
   private
 
-  def main_components_as_json
+  def main_components_to_hash
     {
       operation: operation.class.name,
       contract: contract.class.name,
@@ -316,7 +316,7 @@ def main_components_as_json
     }
   end
 
-  def form_components_as_json
+  def form_components_to_hash
     {
       form_model_map: form_model_map,
       form_base: form_base.name,

lib/operations/form/base.rb

@@ -141,6 +141,13 @@ def read_attribute(name)
       end
     end
 
+    def to_hash
+      {
+        attributes: attributes,
+        errors: errors
+      }
+    end
+
     private
 
     def add_messages(errors, key, messages)

lib/operations/result.rb

@@ -92,16 +92,20 @@ def pretty_print(pp)
     end
   end
 
-  def as_json(*, include_command: false, **)
+  def as_json(options = {})
+    to_hash(**options.slice(:include_command))
+  end
+
+  def to_hash(include_command: false)
     hash = {
       component: component,
       params: params,
-      context: context_as_json,
+      context: context_to_hash,
       on_success: on_success.as_json,
       on_failure: on_failure.as_json,
       errors: errors(full: true).to_h
     }
-    hash[:command] = operation.as_json if include_command
+    hash[:command] = operation&.to_hash if include_command
     hash
   end
 
@@ -112,7 +116,7 @@ def errors_with_code?(name, *names)
     (errors.map { |error| error.meta[:code] } & names).present?
   end
 
-  def context_as_json
+  def context_to_hash
     context.transform_values do |context_value|
       next context_value.class.name unless context_value.respond_to?(:id)
 

spec/operations/command_spec.rb

@@ -921,7 +921,7 @@ def build(**kwargs)
   end
 
   describe "#as_json" do
-    subject(:as_json) { command.as_json(:ignored_arg, ignored: :kwarg) }
+    subject(:as_json) { command.as_json }
 
     let(:command) { DummyOperation.instance }
     let(:command_implementation) do
@@ -988,18 +988,18 @@ def call; end
 
     specify do
       expect(as_json).to eq(
-        operation: "DummyOperation",
-        contract: "DummyOperation::Contract",
-        policies: ["DummyOperation::Policy"],
-        preconditions: ["DummyOperation::Precondition"],
-        idempotency: ["DummyOperation::IdempotencyCheck"],
-        on_success: ["DummyOperation::OnSuccess"],
-        on_failure: ["DummyOperation::OnFailure"],
-        form_base: "DummyOperation::FormBase",
-        form_class: "DummyOperation::FormClass",
-        form_hydrator: "DummyOperation::FormHydrator",
-        form_model_map: { [:attribute] => "attribute_map" },
-        configuration: { "after_commit" => {}, "error_reporter" => {}, "transaction" => {} }
+        "operation" => "DummyOperation",
+        "contract" => "DummyOperation::Contract",
+        "policies" => ["DummyOperation::Policy"],
+        "preconditions" => ["DummyOperation::Precondition"],
+        "idempotency" => ["DummyOperation::IdempotencyCheck"],
+        "on_success" => ["DummyOperation::OnSuccess"],
+        "on_failure" => ["DummyOperation::OnFailure"],
+        "form_base" => "DummyOperation::FormBase",
+        "form_class" => "DummyOperation::FormClass",
+        "form_hydrator" => "DummyOperation::FormHydrator",
+        "form_model_map" => { "[:attribute]" => "attribute_map" },
+        "configuration" => { "after_commit" => {}, "error_reporter" => {}, "transaction" => {} }
       )
     end
   end

spec/operations/form/base_spec.rb

@@ -305,6 +305,39 @@
         it { is_expected.to be_valid }
       end
     end
+
+    describe "#as_json" do
+      subject(:as_json) { form.as_json }
+
+      let(:messages) do
+        {
+          name: ["should be present"],
+          author: { title: [:invalid] }
+        }
+      end
+      let(:attributes) do
+        {
+          name: "Name",
+          author: { ignored: 42 },
+          ignored: 42
+        }
+      end
+
+      specify do
+        expect(as_json).to eq({
+          "attributes" => {
+            "author" => {
+              "attributes" => { "title" => nil },
+              "errors" => { title: ["is invalid"] }
+            },
+            "name" => "Name",
+            "posts" => [],
+            "tags" => []
+          },
+          "errors" => { name: ["should be present"] }
+        })
+      end
+    end
   end
 
   it_behaves_like "a form base", form_base: described_class

spec/operations/result_spec.rb

@@ -209,7 +209,7 @@ def initialize(params, messages:)
   end
 
   describe "#as_json" do
-    subject(:as_json) { result.as_json(:ignored_arg, ignored: :kwarg) }
+    subject(:as_json) { result.as_json }
 
     let(:traceable_object) { Struct.new(:id, :name) }
     let(:anonymous_object) { Struct.new(:name) }
@@ -224,7 +224,7 @@ def initialize(params, messages:)
     let(:on_success) { [Dry::Monads::Success(Entity: "Model#1"), Dry::Monads::Failure(additional: :value)] }
     let(:on_failure) { [Dry::Monads::Success(Entity: "Model#1"), Dry::Monads::Failure(additional: :value)] }
     let(:errors) { Dry::Validation::MessageSet.new([message]).freeze }
-    let(:command_json) do
+    let(:command_to_hash) do
       {
         operation: "DummyOperation",
         contract: "DummyOperation::Contract",
@@ -247,7 +247,7 @@ def initialize(params, messages:)
       stub_const("TraceableObject", traceable_object)
       stub_const("AnonymousObject", anonymous_object)
 
-      allow(operation).to receive(:as_json).and_return(command_json)
+      allow(operation).to receive(:to_hash).and_return(command_to_hash)
     end
 
     specify do
@@ -273,7 +273,7 @@ def initialize(params, messages:)
       specify do
         expect(as_json).to include(
           component: :contract,
-          command: command_json,
+          command: command_to_hash,
           params: { id: 123, name: "Jon", lastname: "Snow" },
           context: { record: "TraceableObject#1", object: "AnonymousObject" },
           on_success: match([