Add BaseClass for input edit fields to avoid duplication

Author: HDinger

app/components/open_project/common/inplace_edit_fields/base_field_component.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+module OpenProject
+  module Common
+    module InplaceEditFields
+      class BaseFieldComponent < ViewComponent::Base
+        attr_reader :form, :attribute, :model, :show_action_buttons
+
+        def self.display_class
+          DisplayFields::DisplayFieldComponent
+        end
+
+        def initialize(form:, attribute:, model:, show_action_buttons: true, **system_arguments)
+          super()
+          @form = form
+          @attribute = attribute
+          @model = model
+          @show_action_buttons = show_action_buttons
+          @system_arguments = system_arguments
+        end
+
+        def custom_field?
+          attribute.to_s.start_with?("custom_field_")
+        end
+
+        def custom_field
+          return @custom_field if defined?(@custom_field)
+
+          @custom_field = CustomField.find_by(id: attribute.to_s.sub("custom_field_", "").to_i)
+        end
+      end
+    end
+  end
+end

app/components/open_project/common/inplace_edit_fields/boolean_input_component.rb

@@ -31,26 +31,7 @@
 module OpenProject
   module Common
     module InplaceEditFields
-      class BooleanInputComponent < ViewComponent::Base
-        attr_reader :form, :attribute, :model
-
-        def self.display_class
-          DisplayFields::DisplayFieldComponent
-        end
-
-        def initialize(form:, attribute:, model:, **system_arguments)
-          super()
-          @form = form
-          @attribute = attribute
-          @model = model
-          @system_arguments = system_arguments
-          @system_arguments[:classes] = class_names(
-            @system_arguments[:classes],
-            "op-inplace-edit-field--boolean"
-          )
-          @system_arguments[:label] ||= model.class.human_attribute_name(attribute)
-        end
-
+      class BooleanInputComponent < BaseFieldComponent
         def call
           form.check_box name: attribute,
                          data: { controller: "inplace-edit",

app/components/open_project/common/inplace_edit_fields/link_input_component.rb

@@ -32,8 +32,6 @@ module OpenProject
   module Common
     module InplaceEditFields
       class LinkInputComponent < TextInputComponent
-        attr_reader :form, :attribute, :model
-
         def self.display_class
           DisplayFields::LinkInputComponent
         end

app/components/open_project/common/inplace_edit_fields/rich_text_area_component.rb

@@ -31,20 +31,13 @@
 module OpenProject
   module Common
     module InplaceEditFields
-      class RichTextAreaComponent < ViewComponent::Base
-        attr_reader :form, :attribute, :model, :show_action_buttons
-
+      class RichTextAreaComponent < BaseFieldComponent
         def self.display_class
           DisplayFields::RichTextAreaComponent
         end
 
         def initialize(form:, attribute:, model:, show_action_buttons: true, **system_arguments)
-          super()
-          @form = form
-          @attribute = attribute
-          @model = model
-          @show_action_buttons = show_action_buttons
-          @system_arguments = system_arguments
+          super
           @system_arguments[:classes] = class_names(
             @system_arguments[:classes],
             "op-inplace-edit-field--text-area"

app/components/open_project/common/inplace_edit_fields/select_list_component.rb

@@ -31,30 +31,18 @@
 module OpenProject
   module Common
     module InplaceEditFields
-      class SelectListComponent < ViewComponent::Base
-        attr_reader :form, :attribute, :model
-
+      class SelectListComponent < BaseFieldComponent
         def self.display_class
           DisplayFields::SelectListComponent
         end
 
         def initialize(form:, attribute:, model:, show_action_buttons: true, **system_arguments)
-          super()
-          @form = form
-          @attribute = attribute
-          @model = model
-          @show_action_buttons = show_action_buttons
-          @system_arguments = system_arguments
-          @system_arguments[:classes] = class_names(
-            @system_arguments[:classes],
-            "op-inplace-edit-field--select-list"
-          )
-          @system_arguments[:label] ||= model.class.human_attribute_name(attribute)
+          super
 
           @system_arguments[:autocomplete_options] ||= {}
           @system_arguments[:autocomplete_options][:model] ||= { id: model.id, name: model.name }
           @system_arguments[:autocomplete_options][:inputName] ||= attribute
-          @system_arguments[:autocomplete_options][:wrapper_id] ||= system_arguments[:wrapper_id]
+          @system_arguments[:autocomplete_options][:wrapper_id] ||= @system_arguments[:wrapper_id]
           if @system_arguments[:autocomplete_options][:focusDirectly].nil?
             @system_arguments[:autocomplete_options][:focusDirectly] =
               true
@@ -105,16 +93,6 @@ def render_custom_field_input
         def render_autocompleter
           form.autocompleter(name: attribute, **@system_arguments)
         end
-
-        def custom_field?
-          attribute.to_s.start_with?("custom_field_")
-        end
-
-        def custom_field
-          return @custom_field if defined?(@custom_field)
-
-          @custom_field = CustomField.find_by(id: attribute.to_s.sub("custom_field_", "").to_i)
-        end
       end
     end
   end

app/components/open_project/common/inplace_edit_fields/text_input_component.rb

@@ -31,21 +31,7 @@
 module OpenProject
   module Common
     module InplaceEditFields
-      class TextInputComponent < ViewComponent::Base
-        attr_reader :form, :attribute, :model
-
-        def self.display_class
-          DisplayFields::DisplayFieldComponent
-        end
-
-        def initialize(form:, attribute:, model:, **system_arguments)
-          super()
-          @form = form
-          @attribute = attribute
-          @model = model
-          @system_arguments = system_arguments
-        end
-
+      class TextInputComponent < BaseFieldComponent
         def call
           form.text_field name: attribute,
                           data: { controller: "inplace-edit",

app/components/open_project/common/inplace_edit_fields/user_select_list_component.rb

@@ -32,16 +32,10 @@ module OpenProject
   module Common
     module InplaceEditFields
       class UserSelectListComponent < SelectListComponent
-        attr_reader :form, :attribute, :model
-
         def self.display_class
           DisplayFields::UserSelectListComponent
         end
 
-        def initialize(form:, attribute:, model:, **system_arguments)
-          super
-        end
-
         private
 
         def render_custom_field_input

app/components/open_project/common/inplace_edit_fields/version_select_list_component.rb

@@ -32,8 +32,6 @@ module OpenProject
   module Common
     module InplaceEditFields
       class VersionSelectListComponent < SelectListComponent
-        attr_reader :form, :attribute, :model
-
         def initialize(form:, attribute:, model:, **system_arguments)
           super