Rails way

[JuzerShakir]

This PR brings some big improvements focusing on backend system. I have highlighted some of it here.

Linting Errors

erblint

Currently

this PR

rubocop

(includes rspec, factory-bot, capybara & rails)

Currently

..
..
after scrolling for a few moments 🥱
..
..

this PR

(this will be auto-corrected later)

Test Suite

Currently (without headless)

this PR (with headless)

Metric	Currently	this PR	Percentage improvement
Run time	1 minute and 32.45 seconds	47.25 seconds	72.83%
Load time	1.61 seconds	1.31 seconds	18.63%

Requests

Some actions render both HTML & turbo_stream actions like Thaalis#index action, Transactions#all action, etc. The logic defined in these actions runs twice, each for both actions, HTML & turbo_stream.

Meaning if you have logic that triggers a SQL request, it would make that request twice, for each action.

So we need those resources to load only for turbo stream action but it is not explicitly defined in the controller. So currently it loads resources for HTML action too. For example:

Thaali index (Homepage)

Currently

this PR

By using the respond_to method, we avoid making unnecessary SQL calls hence making the HTML template load faster:

---

Gems added:

1. robocop-rspec
2. rubocop-rails
3. rails-i18n
4. active_record_union
5. rolify
6. cancancan

Here is the list of changes:

In schema

• Merge migration files.
• Remove sabeels' name uniqueness constraint with its.
• Remove thaalis' year uniqueness constraint with number.
• Change table name from thaali_takhmeens to thaalis.
• Remove the address, balance, paid, is_complete, and role attributes.
• use rollify library to support roles for users.

In tests

• Add robocop-rspec, and rubocop-capybara gems to address all linting errors in test suites.
• Re-organise tests, rename test titles, delete redundant tests, and add new tests where necessary.
• Create new and rename existing factories.
• Configure Selenium to run js tests with a headless browser (firefox).
• Divide feature tests of all controllers into different files with respect to their actions/views.
• Divide requests tests of all controllers into different files with respect to their actions.

In controllers

• Load resources only in the turbo_stream action and not in both html & turbo_stream.
• Use the preload method to load associated resources resulting in faster response time.
• Use the length instead of the count method which avoids making separate SQL queries.
• Use Cancancan gem for authorization and remove redundant before actions from all controller files and methods from application_controller

In views

• Format amounts with grouped thousands using the number_with_delimeter method.
• Use locales for validation and flash messages, and use custom attribute names.
• Update turbo_steram files to show no_results partial if resources don't exist.
• Show balance amount instead of font awesome icons: check & x-mark in turbo_stream pages.
• Show the same content in Sabeel#active & Sabeel#inactive views.
• Do Not show edit, delete, new thaali & new transaction buttons if the user type is a viewer.
• Shows font-awesome icon with content without the html-safe method.

In seeds

• Seed 100 sabeels instead of 1000.
• Generate Roles and a user with a viewer type.

Constants

• Remove the concept of Phase, deleting its constants, factories, scopes, and tests.
• Init APARTMENT with 5 apartment names.
• Init MODES with 3 modes.
• Init ROLES with 3 roles.

Misc:

• Use 2-space indentation.
• Add frozen_string_literal comments.
• Add rubocop-rails to address all linting errors for rails.
• Alphabetically order gems in Gemfile & methods, and attributes in model files.
• Add new and rename existing scopes.