Chore: Apply literal properties

[binarygit]

This PR replaces the initialize method on components to use the prop method from the literal gem which provides a way to specify type.

Description

Fixes #2974
Fixes #2893

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works

Screenshots & recording

Manual review steps

1. Step 1
2. Step 2

Manual reviewer: please leave a comment with output from the test if that's the case.

[qlty-cloud-legacy]

Code Climate has analyzed commit 6dc34c2 and detected 0 issues on this pull request.

View more on Code Climate.

[Paul-Bob]

I left some questions.

I noticed that we have many props with reader: :public where the reader is not necessarily needed as public. I know this PR respects the previous attr_reader and converts it to reader: :public but using the instance variable is faster than accessing through the reader.

Whenever there is a case where the reader is not necessary since the attribute is used only on the object's scope lets remove the reader and use the instance variable in favor.

[Paul-Bob]

I left some questions and some tweaks comments, overall is looking great, thank you for changing the readers to ivars!

[Paul-Bob]

Thank you for the effort on this one @binarygit!

[github-actions]

This PR has been merged into main. The functionality will be available in the next release.

Please check the release guide for more information.

[xeron]

@binarygit @Paul-Bob this broke my custom code for setting current user based on HTTP basic auth:

/app/avo/concerns/avo_current_user.rb:

module AvoCurrentUser
  extend ActiveSupport::Concern

  User = Struct.new(:name)

  included do
    before_action :set_paper_trail_whodunnit
  end

  protected

    def user_for_paper_trail
      current_user.name
    end

    def current_user
      user, _pass = ActionController::HttpAuthentication::Basic.user_name_and_password(request)
      User.new(user)
    end
end

/config/initializers/avo.rb:

Rails.configuration.to_prepare do
  Avo::ApplicationController.include AvoCurrentUser
end

13:41:36 web.1  | ActionView::Template::Error (Expected `#<struct AvoCurrentUser::User name=nil>` to be of type: `_Nilable(ActiveRecord::Base)`.):
13:41:36 web.1  |
13:41:36 web.1  | Causes:
13:41:36 web.1  | Literal::TypeError (Expected `#<struct AvoCurrentUser::User name=nil>` to be of type: `_Nilable(ActiveRecord::Base)`.)
13:41:36 web.1  |     32:         <%= render partial: "avo/partials/navbar" %>
13:41:36 web.1  |     33:         <div data-sidebar-target="mainArea" class="content-area flex-1 flex pt-16 relative <%= "sidebar-open" if @sidebar_open %>">
13:41:36 web.1  |     34:           <div class="hidden lg:flex">
13:41:36 web.1  |     35:             <%= render Avo::SidebarComponent.new sidebar_open: @sidebar_open %>
13:41:36 web.1  |     36:           </div>
13:41:36 web.1  |     37:           <div class="flex lg:hidden">
13:41:36 web.1  |     38:             <%= render Avo::SidebarComponent.new sidebar_open: false, for_mobile: true %>
13:41:36 web.1  |
13:41:36 web.1  | (eval):7:in `initialize'

[segiddins]

This breaks eager-loading on rails apps that dont have active_storage/engine required

[adrianthedev]

Thanks! We missed it before.
Fixed by #3215