From 3a21618e4e828583f8f9c6a629c57b136e4ef6ee Mon Sep 17 00:00:00 2001
From: Arpit Jalan <er.ajalan@gmail.com>
Date: Mon, 15 Aug 2022 05:52:07 +0530
Subject: [PATCH] FEATURE: allow wizard checkbox field to be disabled (#17916)

* FEATURE: allow wizard checkbox field to be disabled

* Changes per review feedback
---
 .../wizard/addon/components/wizard-field.js            |  1 +
 .../templates/components/wizard-field-checkbox.hbs     |  2 +-
 app/serializers/wizard_field_serializer.rb             | 10 +++++++++-
 lib/wizard/field.rb                                    |  3 ++-
 spec/lib/wizard/wizard_step_spec.rb                    |  5 ++++-
 5 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/app/assets/javascripts/wizard/addon/components/wizard-field.js b/app/assets/javascripts/wizard/addon/components/wizard-field.js
index 63b42c536d0..d732f6bf477 100644
--- a/app/assets/javascripts/wizard/addon/components/wizard-field.js
+++ b/app/assets/javascripts/wizard/addon/components/wizard-field.js
@@ -7,6 +7,7 @@ export default Component.extend({
     ":wizard-container__field",
     "typeClasses",
     "field.invalid",
+    "field.disabled",
   ],
 
   @discourseComputed("field.type", "field.id")
diff --git a/app/assets/javascripts/wizard/addon/templates/components/wizard-field-checkbox.hbs b/app/assets/javascripts/wizard/addon/templates/components/wizard-field-checkbox.hbs
index a0a5086725f..978ec3a70eb 100644
--- a/app/assets/javascripts/wizard/addon/templates/components/wizard-field-checkbox.hbs
+++ b/app/assets/javascripts/wizard/addon/templates/components/wizard-field-checkbox.hbs
@@ -1,5 +1,5 @@
 <label class="wizard-container__label">
-  <Input @type="checkbox" class="wizard-container__checkbox" @checked={{this.field.value}} />
+  <Input @type="checkbox" disabled={{this.field.disabled}} class="wizard-container__checkbox" @checked={{this.field.value}} />
   <span class="wizard-container__checkbox-slider"></span>
   {{#if this.field.icon}}
     {{d-icon this.field.icon}}
diff --git a/app/serializers/wizard_field_serializer.rb b/app/serializers/wizard_field_serializer.rb
index b6b5cf3b2ad..12c3db2060d 100644
--- a/app/serializers/wizard_field_serializer.rb
+++ b/app/serializers/wizard_field_serializer.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class WizardFieldSerializer < ApplicationSerializer
-  attributes :id, :type, :required, :value, :label, :placeholder, :description, :extra_description, :icon, :show_in_sidebar
+  attributes :id, :type, :required, :value, :label, :placeholder, :description, :extra_description, :icon, :disabled, :show_in_sidebar
   has_many :choices, serializer: WizardFieldChoiceSerializer, embed: :objects
 
   def id
@@ -75,6 +75,14 @@ class WizardFieldSerializer < ApplicationSerializer
     object.icon.present?
   end
 
+  def disabled
+    object.disabled
+  end
+
+  def include_disabled?
+    object.disabled
+  end
+
   def show_in_sidebar
     object.show_in_sidebar
   end
diff --git a/lib/wizard/field.rb b/lib/wizard/field.rb
index a9feaee6e8c..0fccefb9a88 100644
--- a/lib/wizard/field.rb
+++ b/lib/wizard/field.rb
@@ -16,7 +16,7 @@ class Wizard
   end
 
   class Field
-    attr_reader :id, :type, :required, :value, :icon, :choices, :show_in_sidebar
+    attr_reader :id, :type, :required, :value, :icon, :choices, :disabled, :show_in_sidebar
     attr_accessor :step
 
     def initialize(attrs)
@@ -27,6 +27,7 @@ class Wizard
       @required = !!attrs[:required]
       @value = attrs[:value]
       @icon = attrs[:icon]
+      @disabled = attrs[:disabled]
       @choices = []
       @show_in_sidebar = attrs[:show_in_sidebar]
     end
diff --git a/spec/lib/wizard/wizard_step_spec.rb b/spec/lib/wizard/wizard_step_spec.rb
index f8d03d8b762..e507b2e0a31 100644
--- a/spec/lib/wizard/wizard_step_spec.rb
+++ b/spec/lib/wizard/wizard_step_spec.rb
@@ -16,9 +16,12 @@ RSpec.describe Wizard::Step do
     dropdown.add_choice('candy')
     dropdown.add_choice('nachos', data: { color: 'yellow' })
     dropdown.add_choice('pizza', label: 'Pizza!')
-
     expect(step.fields).to eq([text, dropdown])
     expect(dropdown.choices.size).to eq(3)
+
+    checkbox = step.add_field(id: 'foobar', type: 'checkbox', disabled: true)
+    expect(step.fields).to eq([text, dropdown, checkbox])
+    expect(checkbox.disabled).to eq(true)
   end
 
 end