Rubocop fixes

Author: rsmithlal

app/builders/better_together/navigation_builder.rb

@@ -68,7 +68,7 @@ def build_better_together # rubocop:todo Metrics/MethodLength
         end
       end
 
-      def build_footer # rubocop:todo Metrics/MethodLength
+      def build_footer # rubocop:todo Metrics/MethodLength, Metrics/AbcSize
         I18n.with_locale(:en) do # rubocop:todo Metrics/BlockLength
           # Create Platform Footer Pages
           footer_pages = ::BetterTogether::Page.create!(
@@ -176,7 +176,7 @@ def build_header # rubocop:todo Metrics/MethodLength
       end
 
       # rubocop:todo Metrics/MethodLength
-      def build_host # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+      def build_host # rubocop:todo Metrics/MethodLength
         I18n.with_locale(:en) do # rubocop:todo Metrics/BlockLength
           # Create Platform Header Host Navigation Area and its Navigation Items
           ::BetterTogether::NavigationArea.create! do |area| # rubocop:todo Metrics/BlockLength

app/concerns/better_together/translatable.rb

@@ -18,12 +18,12 @@ module Translatable
       }
 
       def self.localized_attribute_list
-        localized_attributes = self.mobility_attributes.map do |attribute|
+        localized_attributes = mobility_attributes.map do |attribute|
           I18n.available_locales.map do |locale|
             :"#{attribute}_#{locale}"
           end
         end
-  
+
         localized_attributes.flatten
       end
     end

app/controllers/better_together/content/blocks_controller.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module BetterTogether
   module Content
+    # CRUD for content blocks independently of pages
     class BlocksController < ApplicationController
       before_action :authenticate_user!
       before_action :set_block, only: %i[show edit update destroy]
@@ -28,7 +31,8 @@ def update
             redirect_to edit_content_block_path(@block), notice: 'Block was successfully updated.'
           else
             format.turbo_stream do
-              render turbo_stream: turbo_stream.replace(helpers.dom_id(@block, 'form'), partial: 'form', locals: { block: @block } )
+              render turbo_stream: turbo_stream.replace(helpers.dom_id(@block, 'form'), partial: 'form',
+                                                                                        locals: { block: @block })
             end
           end
         end
@@ -37,9 +41,7 @@ def update
       def new
         @block = BetterTogether::Content::Block.new(type: params[:block_type])
 
-        respond_to do |format|
-          format.html
-        end
+        respond_to(&:html)
       end
 
       def destroy

app/controllers/better_together/content/page_blocks_controller.rb

@@ -1,23 +1,29 @@
+# frozen_string_literal: true
+
 module BetterTogether
   module Content
+    # CRUD for page blocks
     class PageBlocksController < ApplicationController
       before_action :authenticate_user!
       before_action :set_page
 
       def new
         @page_block = @page.page_blocks.build
-        
+
         @page_block.build_block(type: params[:block_type]) # Build the new PageBlock and associated Block
 
         respond_to do |format|
           format.html
           format.turbo_stream do
-            render turbo_stream: turbo_stream.append("blocks-list", partial: "better_together/content/page_blocks/form_fields", locals: { page_block: @page_block })
+            render turbo_stream: turbo_stream.append('blocks-list',
+                                                     # rubocop:todo Layout/LineLength
+                                                     partial: 'better_together/content/page_blocks/form_fields', locals: { page_block: @page_block })
+            # rubocop:enable Layout/LineLength
           end
         end
       end
 
-      def destroy
+      def destroy # rubocop:todo Metrics/AbcSize
         @page_block = @page.page_blocks.find_by(id: params[:id]) || @page.page_blocks.build
         @page_block.destroy if @page_block.persisted?
 
@@ -31,7 +37,8 @@ def destroy
       private
 
       def form_for_page_block(page_block)
-        view_context.form_with(model: [page_block.page, page_block], url: new_page_page_block_path(page_block.page), local: true)
+        view_context.form_with(model: [page_block.page, page_block], url: new_page_page_block_path(page_block.page),
+                               local: true)
       end
 
       def set_page

app/controllers/better_together/pages_controller.rb

@@ -106,17 +106,17 @@ def set_page
       handle404
     end
 
-    def page_params
+    def page_params # rubocop:todo Metrics/MethodLength
       params.require(:page).permit(
         :meta_description, :keywords, :published_at,
         :privacy, :layout, :template, *Page.localized_attribute_list,
         page_blocks_attributes: [
           :id, :position, :_destroy,
-          block_attributes: [
+          { block_attributes: [
             :id, :type, :media, :identifier, :_destroy,
             *BetterTogether::Content::Block.localized_block_attributes,
             *BetterTogether::Content::Block.storext_definitions.keys
-          ]
+          ] }
         ]
       )
     end

app/helpers/better_together/content/blocks_helper.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module BetterTogether
   module Content
+    # Helpers for Content Blocks
     module BlocksHelper
       # Returns an array of acceptable image file types
       def acceptable_image_file_types

app/helpers/better_together/navigation_items_helper.rb

@@ -37,9 +37,7 @@ def nav_link_classes(navigation_item)
     def platform_host_nav_items
       # Preload navigation items and their translations in a single query
       Mobility.with_locale(current_locale) do
-        # rubocop:todo Layout/LineLength
         @platform_host_nav_area ||= ::BetterTogether::NavigationArea.find_by(identifier: 'platform-host')
-        # rubocop:enable Layout/LineLength
         @platform_host_nav_items ||= @platform_host_nav_area.top_level_nav_items_includes_children || []
       end
     end

app/helpers/better_together/translatable_fields_helper.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
 
 module BetterTogether
+  # Helps with rendering content for translatable fields
   module TranslatableFieldsHelper
     # Helper to render a translation tab button
-    def translation_tab_button(attribute:, locale:, temp_id:, model:)
+    def translation_tab_button(attribute:, locale:, temp_id:, model:) # rubocop:todo Metrics/MethodLength
       locale_attribute = "#{attribute}_#{locale}"
       unique_locale_attribute = "#{locale_attribute}_#{temp_id}"
       translation_present = model.public_send(locale_attribute).present?
-    
+
       content_tag(:li, class: 'nav-item', role: 'presentation',
-                  data: { attribute: attribute, translation_target: 'tab', locale: locale }) do
+                       data: { attribute:, translation_target: 'tab', locale: }) do
         content_tag(:button,
                     id: "#{unique_locale_attribute}-tab",
-                    class: ['nav-link', ('active' if locale.to_s == I18n.locale.to_s), 
+                    class: ['nav-link', ('active' if locale.to_s == I18n.locale.to_s),
                             ('text-success' if translation_present)],
                     data: { bs_toggle: 'tab',
                             bs_target: "##{unique_locale_attribute}-field",
                             action: 'click->translation#syncLocaleAcrossFields',
-                            locale: locale,
+                            locale:,
                             translation_target: 'tabButton' },
                     role: 'tab',
                     type: 'button',
@@ -33,9 +35,10 @@ def translation_indicator(translation_present)
         tag.i(class: 'fas fa-check-circle ms-2', aria_hidden: 'true', title: 'Translation available') +
           content_tag(:span, 'Translation available', class: 'visually-hidden')
       else
-        tag.i(class: 'fas fa-exclamation-circle text-muted ms-2', aria_hidden: 'true', title: 'No translation available') +
+        tag.i(class: 'fas fa-exclamation-circle text-muted ms-2', aria_hidden: 'true',
+              title: 'No translation available') +
           content_tag(:span, 'No translation available', class: 'visually-hidden')
       end
     end
   end
-end
+end

app/models/better_together/content.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 
 module BetterTogether
+  # Robust content editing for the Community Engine
   module Content
     def self.table_name_prefix
       'better_together_content_'
     end
   end
-end
+end

app/models/better_together/content/block.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
+
 require 'storext'
 
 module BetterTogether
   module Content
+    # Base class from which all other content blocks types inherit
     class Block < ApplicationRecord
       include ::Storext.model
 
@@ -13,7 +15,7 @@ class Block < ApplicationRecord
         aria_label String, default: ''
         aria_hidden Boolean, default: false
         aria_describedby String, default: ''
-        aria_live String, default: 'polite'  # 'polite' or 'assertive'
+        aria_live String, default: 'polite' # 'polite' or 'assertive'
         aria_role String, default: ''
         aria_controls String, default: ''
         aria_expanded Boolean, default: false
@@ -52,27 +54,30 @@ class Block < ApplicationRecord
                 length: { maximum: 100 },
                 allow_blank: true
 
-      def identifier= arg
-        super arg.parameterize
+      def identifier=(arg)
+        super(arg.parameterize)
       end
 
       def to_partial_path
         "better_together/content/blocks/#{block_name}"
       end
 
       def self.block_name
-        self.name.demodulize.underscore
+        name.demodulize.underscore
       end
 
       def self.load_all_subclasses
+        # rubocop:todo Layout/LineLength
         [::BetterTogether::Content::RichText, ::BetterTogether::Content::Image].each(&:connection) # Add all known subclasses here
+        # rubocop:enable Layout/LineLength
       end
 
       def self.localized_block_attributes
         list = []
 
         descendants.each do |descendant|
           next unless descendant.respond_to? :localized_attribute_list
+
           list += descendant.localized_attribute_list
         end
 
@@ -84,9 +89,12 @@ def block_name
       end
 
       def to_s
-        "#{block_name} - #{persisted? ? (identifier.present? ? identifier : id.split('-').first) : 'new'}"
+        "#{block_name} - #{if persisted?
+                             identifier.present? ? identifier : id.split('-').first
+                           else
+                             'new'
+                           end}"
       end
-      
     end
   end
 end