Replace cable_ready responses with turbo_stream OFN-12794

.rubocop_todo.yml

@@ -6,6 +6,12 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'app/controllers/spree/admin/orders_controller.rb'
+
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 Layout/EmptyLines:
@@ -35,15 +41,8 @@ Lint/EmptyClass:
     - 'spec/lib/reports/report_loader_spec.rb'
 
 # Offense count: 1
-# Configuration parameters: AllowComments.
-Lint/EmptyFile:
-  Exclude:
-    - 'spec/lib/open_food_network/enterprise_injection_data_spec.rb'
-
-# Offense count: 2
 Lint/FloatComparison:
   Exclude:
-    - 'app/models/product_import/entry_validator.rb'
     - 'app/models/spree/gateway/pay_pal_express.rb'
 
 # Offense count: 1
@@ -85,14 +84,13 @@ Lint/UselessMethodDefinition:
   Exclude:
     - 'app/models/spree/gateway.rb'
 
-# Offense count: 24
+# Offense count: 23
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
     - 'app/controllers/admin/enterprises_controller.rb'
     - 'app/controllers/payment_gateways/paypal_controller.rb'
     - 'app/controllers/spree/admin/payments_controller.rb'
-    - 'app/controllers/spree/admin/taxons_controller.rb'
     - 'app/controllers/spree/admin/variants_controller.rb'
     - 'app/controllers/spree/orders_controller.rb'
     - 'app/helpers/spree/admin/navigation_helper.rb'
@@ -137,6 +135,7 @@ Metrics/ClassLength:
     - 'app/controllers/admin/resource_controller.rb'
     - 'app/controllers/admin/subscriptions_controller.rb'
     - 'app/controllers/application_controller.rb'
+    - 'app/controllers/checkout_controller.rb'
     - 'app/controllers/payment_gateways/paypal_controller.rb'
     - 'app/controllers/spree/admin/orders_controller.rb'
     - 'app/controllers/spree/admin/payment_methods_controller.rb'
@@ -162,7 +161,6 @@ Metrics/ClassLength:
     - 'app/models/spree/user.rb'
     - 'app/models/spree/variant.rb'
     - 'app/models/spree/zone.rb'
-    - 'app/reflexes/admin/orders_reflex.rb'
     - 'app/serializers/api/cached_enterprise_serializer.rb'
     - 'app/serializers/api/enterprise_shopfront_serializer.rb'
     - 'app/services/cart_service.rb'
@@ -178,12 +176,11 @@ Metrics/ClassLength:
     - 'lib/reporting/reports/enterprise_fee_summary/scope.rb'
     - 'lib/reporting/reports/xero_invoices/base.rb'
 
-# Offense count: 32
+# Offense count: 30
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
     - 'app/controllers/admin/enterprises_controller.rb'
-    - 'app/controllers/spree/admin/taxons_controller.rb'
     - 'app/controllers/spree/orders_controller.rb'
     - 'app/helpers/checkout_helper.rb'
     - 'app/helpers/order_cycles_helper.rb'
@@ -199,7 +196,6 @@ Metrics/CyclomaticComplexity:
     - 'app/models/spree/preferences/preferable_class_methods.rb'
     - 'app/models/spree/return_authorization.rb'
     - 'app/models/spree/tax_rate.rb'
-    - 'app/models/spree/variant.rb'
     - 'app/models/spree/zone.rb'
     - 'lib/open_food_network/enterprise_issue_validator.rb'
     - 'lib/reporting/reports/xero_invoices/base.rb'
@@ -208,13 +204,12 @@ Metrics/CyclomaticComplexity:
     - 'lib/spree/localized_number.rb'
     - 'spec/models/product_importer_spec.rb'
 
-# Offense count: 24
+# Offense count: 23
 # Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Exclude:
     - 'app/controllers/admin/enterprises_controller.rb'
     - 'app/controllers/payment_gateways/paypal_controller.rb'
-    - 'app/controllers/spree/admin/taxons_controller.rb'
     - 'app/controllers/spree/orders_controller.rb'
     - 'app/helpers/spree/admin/navigation_helper.rb'
     - 'app/models/spree/ability.rb'
@@ -293,19 +288,17 @@ Metrics/ParameterLists:
     - 'spec/support/controller_requests_helper.rb'
     - 'spec/system/admin/reports_spec.rb'
 
-# Offense count: 4
+# Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Exclude:
-    - 'app/controllers/spree/admin/taxons_controller.rb'
     - 'app/models/enterprise_relationship.rb'
     - 'app/models/spree/ability.rb'
     - 'app/models/spree/order/checkout.rb'
 
-# Offense count: 8
+# Offense count: 7
 Naming/AccessorMethodName:
   Exclude:
-    - 'app/controllers/spree/admin/taxonomies_controller.rb'
     - 'app/mailers/producer_mailer.rb'
     - 'app/models/spree/order.rb'
     - 'app/services/checkout/post_checkout_actions.rb'
@@ -353,7 +346,7 @@ Naming/VariableNumber:
     - 'spec/models/spree/tax_rate_spec.rb'
     - 'spec/requests/api/orders_spec.rb'
 
-# Offense count: 142
+# Offense count: 141
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: ResponseMethods.
 # ResponseMethods: response, last_response
@@ -557,7 +550,7 @@ RSpecRails/InferredSpecType:
     - 'spec/requests/voucher_adjustments_spec.rb'
     - 'spec/routing/stripe_spec.rb'
 
-# Offense count: 22
+# Offense count: 21
 # Configuration parameters: IgnoreScopes, Include.
 # Include: app/models/**/*.rb
 Rails/InverseOf:
@@ -572,11 +565,10 @@ Rails/InverseOf:
     - 'app/models/spree/price.rb'
     - 'app/models/spree/product.rb'
     - 'app/models/spree/stock_item.rb'
-    - 'app/models/spree/taxonomy.rb'
     - 'app/models/spree/variant.rb'
     - 'app/models/subscription_line_item.rb'
 
-# Offense count: 35
+# Offense count: 36
 # Configuration parameters: Include.
 # Include: app/controllers/**/*.rb, app/mailers/**/*.rb
 Rails/LexicallyScopedActionFilter:
@@ -720,17 +712,15 @@ Style/GlobalStdStream:
     - 'lib/tasks/subscriptions/debug.rake'
     - 'lib/tasks/subscriptions/test.rake'
 
-# Offense count: 12
+# Offense count: 10
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: AllowSplatArgument.
 Style/HashConversion:
   Exclude:
     - 'app/controllers/admin/column_preferences_controller.rb'
     - 'app/controllers/admin/variant_overrides_controller.rb'
     - 'app/controllers/spree/admin/products_controller.rb'
-    - 'app/models/order_cycle.rb'
     - 'app/models/product_import/product_importer.rb'
-    - 'app/models/spree/shipping_method.rb'
     - 'app/serializers/api/admin/exchange_serializer.rb'
     - 'app/services/variants_stock_levels.rb'
     - 'spec/controllers/admin/inventory_items_controller_spec.rb'

Gemfile

@@ -101,7 +101,6 @@ gem 'redis'
 gem 'sidekiq'
 gem 'sidekiq-scheduler'
 
-gem "cable_ready"
 gem "stimulus_reflex"
 
 gem "turbo_power"

Gemfile.lock

@@ -869,7 +869,6 @@ DEPENDENCIES
   bootsnap
   bugsnag
   bullet
-  cable_ready
   cancancan (~> 1.15.0)
   capybara
   catalog!

app/components/confirm_modal_component.rb

@@ -8,7 +8,7 @@ def initialize(
     controller: nil,
     message: nil,
     confirm_actions: nil,
-    confirm_reflexes: nil,
+    form_url: nil,
     confirm_button_class: :primary,
     confirm_button_text: I18n.t('js.admin.modals.confirm'),
     cancel_button_text: I18n.t('js.admin.modals.cancel'),
@@ -17,7 +17,7 @@ def initialize(
     super(id:, close_button: true)
     @confirm_actions = confirm_actions
     @reflex = reflex
-    @confirm_reflexes = confirm_reflexes
+    @form_url = form_url
     @controller = controller
     @message = message
     @confirm_button_class = confirm_button_class

app/components/confirm_modal_component/confirm_modal_component.html.haml

@@ -1,10 +1,19 @@
 %div{ id: @id, "data-controller": "modal #{@controller}", "data-action": "keyup@document->modal#closeIfEscapeKey", "data-#{@controller}-reflex-value": @reflex }
   .reveal-modal-bg.fade{ "data-modal-target": "background", "data-action": "click->modal#close" }
   .reveal-modal.fade.tiny.modal-component{ "data-modal-target": "modal" }
-    = content
+    - if @confirm_actions
+      = content
 
-    = render @message if @message
+      = render @message if @message
 
-    %div{ class: "modal-actions #{@actions_alignment_class}" }
-      %input{ class: "button icon-plus #{close_button_class}", type: 'button', value: @cancel_button_text, "data-action": "click->modal#close" }
-      %input{ id: 'modal-confirm-button', class: "button icon-plus #{@confirm_button_class}", type: 'button', value: @confirm_button_text, "data-action": @confirm_actions, "data-reflex": @confirm_reflexes }
+      %div{ class: "modal-actions #{@actions_alignment_class}" }
+        %input{ class: "button icon-plus #{close_button_class}", type: 'button', value: @cancel_button_text, "data-action": "click->modal#close" }
+        %input{ id: 'modal-confirm-button', class: "button icon-plus #{@confirm_button_class}", type: 'button', value: @confirm_button_text, "data-action": @confirm_actions }
+    - elsif @form_url
+      = form_with(url: @form_url, method: :post, data: { turbo: true, controller: 'bulk-actions' }) do
+        = content
+        %p{ class: "modal-actions #{@actions_alignment_class}" }
+          %button.button.secondary{ type: "button", 'data-action': 'click->modal#close' }
+            = @cancel_button_text
+          %button.button.primary{ type: 'submit' }
+            = @confirm_button_text

app/components/ship_order_component.html.haml

@@ -1,8 +1,15 @@
-= render ConfirmModalComponent.new(id: dom_id(@order, :ship), confirm_reflexes: "click->Admin::OrdersReflex#ship", controller: "orders", reflex: "Admin::Orders#ship") do
-  %div{class: "margin-bottom-30"}
-    %p= t('spree.admin.orders.shipment.mark_as_shipped_message_html')
-  %div{class: "margin-bottom-30"}
-    = hidden_field_tag :id, @order.id
-    = label_tag do
-      = check_box_tag :send_shipment_email, "1", true
-      = t('spree.admin.orders.shipment.mark_as_shipped_label_message')
+= render ModalComponent.new(id: dom_id(@order, :ship), modal_class: 'tiny', close_button: false) do
+  = form_with(url: helpers.ship_admin_order_url(@order), method: :post, data: { turbo: true }) do
+    %div{class: "margin-bottom-30"}
+      %p= t('spree.admin.orders.shipment.mark_as_shipped_message_html')
+    %div{class: "margin-bottom-30"}
+      = hidden_field_tag :id, @order.id
+      = hidden_field_tag :current_page, @current_page
+      = label_tag do
+        = check_box_tag :send_shipment_email, "1", true
+        = t('spree.admin.orders.shipment.mark_as_shipped_label_message')
+    %p.modal-actions.justify-space-around
+      %button.button.secondary{ type: "button", 'data-action': 'click->modal#close' }
+        = t('js.admin.modals.cancel')
+      %button.button.primary{ type: 'submit' }
+        = t('js.admin.modals.confirm')

app/components/ship_order_component.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 class ShipOrderComponent < ViewComponent::Base
-  def initialize(order:)
+  def initialize(order:, current_page:)
     @order = order
+    @current_page = current_page
   end
 end

app/controllers/admin/enterprises_controller.rb

@@ -7,14 +7,13 @@
 module Admin
   class EnterprisesController < Admin::ResourceController
     include GeocodeEnterpriseAddress
-    include CablecarResponses
     include Pagy::Backend
 
     # These need to run before #load_resource so that @object is initialised with sanitised values
     prepend_before_action :override_owner, only: :create
     prepend_before_action :override_sells, only: :create
 
-    before_action :load_countries, except: [:index, :register, :check_permalink]
+    before_action :load_countries, except: [:index, :register, :check_permalink, :remove_logo]
     before_action :load_methods_and_fees, only: [:edit, :update]
     before_action :load_groups, only: [:new, :edit, :update, :create]
     before_action :load_taxons, only: [:new, :edit, :update, :create]
@@ -51,8 +50,10 @@ def edit
 
       @enterprise.is_primary_producer = params[:is_primary_producer]
       @enterprise.sells = params[:enterprise_sells]
-      render cable_ready: cable_car.morph("#side_menu", partial("admin/shared/side_menu"))
-        .morph("#permalink", partial("admin/enterprises/form/permalink"))
+      respond_to do |format|
+        format.html { head :ok }
+        format.turbo_stream { render :edit }
+      end
     end
 
     def welcome
@@ -141,6 +142,33 @@ def visible
       end
     end
 
+    def remove_logo
+      # delete the white_label_logo_link attribute as well since it has no meaning without the logo
+      @object.update!(white_label_logo: nil, white_label_logo_link: "")
+
+      f = ActionView::Helpers::FormBuilder.new(:enterprise, @object, view_context, {})
+
+      respond_to do |format|
+        format.html do
+          flash[:success] = I18n.t("admin.enterprises.form.white_label.remove_logo_success")
+          redirect_to edit_admin_enterprise_path
+        end
+        format.turbo_stream do
+          flash.now[:success] = I18n.t("admin.enterprises.form.white_label.remove_logo_success")
+          render turbo_stream: [
+            turbo_stream.replace(
+              'white_label_panel',
+              partial: "admin/enterprises/form/white_label", locals: { f:, enterprise: @object }
+            ),
+            turbo_stream.append(
+              "flashes",
+              partial: 'admin/shared/flashes', locals: { flashes: flash }
+            )
+          ]
+        end
+      end
+    end
+
     protected
 
     def delete_custom_tab

app/controllers/application_controller.rb

@@ -9,7 +9,6 @@
 require 'open_food_network/referer_parser'
 
 class ApplicationController < ActionController::Base
-  include CablecarResponses
   include Pagy::Backend
   include RequestTimeouts
 

app/controllers/checkout_controller.rb

@@ -10,7 +10,6 @@ class CheckoutController < BaseController
   include CheckoutCallbacks
   include CheckoutSteps
   include OrderCompletion
-  include CablecarResponses
   include WhiteLabel
 
   helper 'terms_and_conditions'
@@ -49,17 +48,20 @@ def update
   rescue Spree::Core::GatewayError => e
     flash[:error] = I18n.t(:spree_gateway_error_flash_for_checkout, error: e.message)
     @order.update_column(:state, "payment")
-    render cable_ready: cable_car.redirect_to(url: checkout_step_path(:payment))
+    redirect_to checkout_step_path(:payment)
   end
 
   private
 
   def render_error
     flash.now[:error] ||= I18n.t('checkout.errors.saving_failed')
 
-    render status: :unprocessable_entity, cable_ready: cable_car.
-      replace("#checkout", partial("checkout/checkout")).
-      replace("#flashes", partial("shared/flashes", locals: { flashes: flash }))
+    respond_to do |format|
+      format.html { head :unprocessable_entity }
+      format.turbo_stream do
+        render :render_error, status: :unprocessable_entity
+      end
+    end
   end
 
   def check_payments_adjustments
@@ -87,7 +89,7 @@ def redirect_to_payment_gateway
     return unless selected_payment_method&.external_gateway?
     return unless (redirect_url = selected_payment_method.external_payment_url(order: @order))
 
-    render cable_ready: cable_car.redirect_to(url: redirect_url)
+    redirect_to redirect_url
     true
   end