Follow rename from refund to return in rails app.

Author: dysk

rails_application/app/controllers/refunds_controller.rb

@@ -0,0 +1,71 @@
+class ReturnsController < ApplicationController
+  def edit
+    @return = Returns::Return.find_by_uid!(params[:id])
+    @order = Orders::Order.find_by_uid!(@return.order_uid)
+    @return_items = build_return_items_list(@order.order_lines, @return.return_items)
+  end
+
+  def create
+    return_id = SecureRandom.uuid
+    create_draft_return(return_id)
+
+    redirect_to edit_order_return_path(return_id, order_id: params[:order_id])
+  end
+
+  def add_item
+    add_item_to_return
+    redirect_to edit_order_return_path(params[:id], order_id: params[:order_id])
+  rescue Ordering::Return::ExceedsOrderQuantityError
+    flash[:alert] = "You cannot add more of this product to the return than is in the original order."
+    redirect_to edit_order_return_path(params[:id], order_id: params[:order_id])
+  end
+
+  def remove_item
+    remove_item_from_return
+    redirect_to edit_order_return_path(params[:id], order_id: params[:order_id])
+  rescue Ordering::Return::ReturnHaveNotBeenRequestedForThisProductError
+    flash[:alert] = "This product is not added to the return."
+    redirect_to edit_order_return_path(params[:id], order_id: params[:order_id])
+  end
+
+  private
+
+  def create_draft_return_cmd(return_id)
+    Ordering::CreateDraftReturn.new(return_id: return_id, order_id: params[:order_id])
+  end
+
+  def create_draft_return(return_id)
+    command_bus.(create_draft_return_cmd(return_id))
+  end
+
+  def add_item_to_return_cmd
+    Ordering::AddItemToReturn.new(return_id: params[:id], order_id: params[:order_id], product_id: params[:product_id])
+  end
+
+  def add_item_to_return
+    command_bus.(add_item_to_return_cmd)
+  end
+
+  def remove_item_from_return_cmd
+    Ordering::RemoveItemFromReturn.new(return_id: params[:id], order_id: params[:order_id], product_id: params[:product_id])
+  end
+
+  def remove_item_from_return
+    command_bus.(remove_item_from_return_cmd)
+  end
+
+  def build_return_items_list(order_lines, return_items)
+    order_lines.map { |order_line| build_return_item(order_line, return_items) }
+  end
+
+  def build_return_item(order_line, return_items)
+    return_item = return_items.find { |item| item.product_uid == order_line.product_id } || initialize_return_item(order_line)
+
+    return_item.order_line = order_line
+    return_item
+  end
+
+  def initialize_return_item(order_line)
+    Returns::ReturnItem.new(product_uid: order_line.product_id, quantity: 0, price: order_line.price)
+  end
+end

rails_application/app/controllers/returns_controller.rb

@@ -24,7 +24,7 @@
   <% end %>
 
   <% if @order.state == "Paid" %>
-    <%= button_to("Refund", order_refunds_path(order_id: @order.uid), class: "ml-3 inline-flex items-center px-4 py-2 border rounded-md shadow-sm text-sm font-medium focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-50 border-gray-300 text-gray-700 bg-white hover:bg-gray-50") %>
+    <%= button_to("Return", order_returns_path(order_id: @order.uid), class: "ml-3 inline-flex items-center px-4 py-2 border rounded-md shadow-sm text-sm font-medium focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-50 border-gray-300 text-gray-700 bg-white hover:bg-gray-50") %>
   <% end %>
 
   <% if (@order.state == "Submitted") %>

rails_application/app/read_models/refunds/add_item_to_refund.rb

@@ -1,5 +1,5 @@
 <% content_for(:header) do %>
-  Refund for Order <%= @order.number %>
+  Return for Order <%= @order.number %>
 <% end %>
 
 <% content_for(:actions) do %>
@@ -8,7 +8,7 @@
   <% end %>
 
   <%= primary_form_action_button do %>
-    Submit Refund
+    Submit Return
   <% end %>
 <% end %>
 
@@ -25,20 +25,20 @@
   </thead>
 
   <tbody>
-    <% @refund_items.each do |refund_item| %>
-      <tr class="border-b" id="order_line_product_<%= refund_item.product_uid %>">
-        <td class="py-2"><%= refund_item.product_name %></td>
-        <td class="py-2"><%= refund_item.quantity %> / <%= refund_item.order_quantity %></td>
-        <td class="py-2"><%= number_to_currency(refund_item.price) %></td>
-        <td class="py-2"><%= number_to_currency(refund_item.value) %></td>
+    <% @return_items.each do |return_item| %>
+      <tr class="border-b" id="order_line_product_<%= return_item.product_uid %>">
+        <td class="py-2"><%= return_item.product_name %></td>
+        <td class="py-2"><%= return_item.quantity %> / <%= return_item.order_quantity %></td>
+        <td class="py-2"><%= number_to_currency(return_item.price) %></td>
+        <td class="py-2"><%= number_to_currency(return_item.value) %></td>
         <td class="py-2">
-          <% unless refund_item.max_quantity? %>
-            <%= button_to "Add", add_item_order_refund_path(order_id: @order.uid, id: @refund.uid, product_id: refund_item.product_uid), class: "hover:underline text-blue-500" %>
+          <% unless return_item.max_quantity? %>
+            <%= button_to "Add", add_item_order_return_path(order_id: @order.uid, id: @return.uid, product_id: return_item.product_uid), class: "hover:underline text-blue-500" %>
           <% end %>
         </td>
         <td class="py-2 text-right">
-          <% unless refund_item.quantity.zero? %>
-            <%= button_to "Remove", remove_item_order_refund_path(order_id: @order.uid, id: @refund.uid, product_id: refund_item.product_uid), class: "hover:underline text-blue-500" %>
+          <% unless return_item.quantity.zero? %>
+            <%= button_to "Remove", remove_item_order_return_path(order_id: @order.uid, id: @return.uid, product_id: return_item.product_uid), class: "hover:underline text-blue-500" %>
           <% end %>
         </td>
       </tr>
@@ -47,7 +47,7 @@
   <tfoot class="border-t-4">
     <tr class="border-t">
       <td class="py-2" colspan="3">Total</td>
-      <td class="py-2 font-bold"><%= number_to_currency(@refund.total_value) %></td>
+      <td class="py-2 font-bold"><%= number_to_currency(@return.total_value) %></td>
     </tr>
   </tfoot>
 </table>

rails_application/app/read_models/refunds/configuration.rb

@@ -17,7 +17,7 @@
     resource :shipping_address, only: [:edit, :update]
     resource :billing_address, only: [:edit, :update]
     resource :invoice, only: [:create]
-    resources :refunds, only: [:edit, :create] do
+    resources :returns, only: [:edit, :create] do
       member do
         post :add_item
         post :remove_item

rails_application/app/read_models/refunds/create_draft_refund.rb

@@ -1,6 +1,6 @@
 require "test_helper"
 
-class RefundsTest < InMemoryRESIntegrationTestCase
+class ReturnsTest < InMemoryRESIntegrationTestCase
   def setup
     super
     add_available_vat_rate(10)
@@ -20,16 +20,16 @@ def test_happy_path
 
     get "/orders/#{order_id}"
 
-    assert_select("button", "Refund")
+    assert_select("button", "Return")
 
-    post "/orders/#{order_id}/refunds"
+    post "/orders/#{order_id}/returns"
     follow_redirect!
 
     assert_order_line_row(async_remote_id, "Async Remote", 1)
     assert_order_line_row(fearless_id, "Fearless Refactoring", 2)
   end
 
-  def test_renders_error_when_exceeds_available_quantity_to_refund
+  def test_renders_error_when_exceeds_available_quantity_to_return
     shopify_id = register_customer("Shopify")
     order_id = SecureRandom.uuid
     async_remote_id = register_product("Async Remote", 39, 10)
@@ -38,16 +38,16 @@ def test_renders_error_when_exceeds_available_quantity_to_refund
     submit_order(shopify_id, order_id)
     pay_order(order_id)
 
-    post "/orders/#{order_id}/refunds"
+    post "/orders/#{order_id}/returns"
     follow_redirect!
 
-    refund = Refunds::Refund.last
+    return_record = Returns::Return.last
 
-    add_item_to_refund(order_id, refund.uid, async_remote_id)
-    add_item_to_refund(order_id, refund.uid, async_remote_id)
+    add_item_to_return(order_id, return_record.uid, async_remote_id)
+    add_item_to_return(order_id, return_record.uid, async_remote_id)
     follow_redirect!
 
-    assert_select("#alert", "You cannot add more of this product to the refund than is in the original order.")
+    assert_select("#alert", "You cannot add more of this product to the return than is in the original order.")
   end
 
   def test_renders_error_when_trying_to_remove_not_added_product
@@ -59,15 +59,15 @@ def test_renders_error_when_trying_to_remove_not_added_product
     submit_order(shopify_id, order_id)
     pay_order(order_id)
 
-    post "/orders/#{order_id}/refunds"
+    post "/orders/#{order_id}/returns"
     follow_redirect!
 
-    refund = Refunds::Refund.last
+    return_record = Returns::Return.last
 
-    remove_item_from_refund(order_id, refund.uid, async_remote_id)
+    remove_item_from_return(order_id, return_record.uid, async_remote_id)
     follow_redirect!
 
-    assert_select("#alert",  "This product is not added to the refund.")
+    assert_select("#alert",  "This product is not added to the return.")
   end
 
   private