Multi controllers per entity + REST actions only

Author: serradura

README.md

@@ -16,51 +16,48 @@ _**Eighteen versions**_ (gradually implemented) of a Web and REST API app made w
 ## 💡 Summary
 
 <table>
- <tr><td><strong>Branch</strong></td><td>020-multi-controllers-per-entity</td></tr>
- <tr><td><strong>Lines of Code</strong></td><td>1342</td></tr>
- <tr><td><strong>Rubycritic Score</strong></td><td>91.34</td></tr>
+ <tr><td><strong>Branch</strong></td><td>021-multi-controllers-per-entity_rest-actions-only</td></tr>
+ <tr><td><strong>Lines of Code</strong></td><td>1361</td></tr>
+ <tr><td><strong>Rubycritic Score</strong></td><td>91.56</td></tr>
 </table>
 
-The previous version demonstrates how concerns can help safely move code around, facilitating a better understanding of the different responsibilities in an implementation.
+This version ensures that all controllers only have REST actions.
 
-These were the created concerns:
-- `UserRegistrationsConcern`
-- `UserSessionsConcern`
-- `UserPasswordsConcern`
-- `UserTokensConcern`
-- `UserProfilesConcern`
+To accomplish this the `task_items#complete` and `task_items#incomplete` actions were moved to their own controller:
 
-However, since the concerns are mixins, we need to ensure that all method names are unique. After all, if any are repeated, they will overwrite each other.
+| From | To |
+| -------------------------------- | -------------------------------------- |
+| `TaskItemsComtroller#complete` | `CompleteTaskItemsController#update` |
+| `TaskItemsComtroller#incomplete` | `IncompleteTaskItemsController#update` |
 
-And here is what this version does. It uses the concerns categorization to implement dedicated routes and controllers.
+Beyond this change, concern was created to share code between the `CompleteTaskItemsController,` `IncompleteTaskItemsController`, and `TaskItemsController.`
 
-See how the controllers turned out:
+See how the task items controllers are now:
 
 ```sh
-110 app/controllers/application_controller.rb
-130 app/controllers/task_items_controller.rb
- 82 app/controllers/task_lists_controller.rb
- 60 app/controllers/user_passwords_controller.rb
- 41 app/controllers/user_profiles_controller.rb
- 49 app/controllers/user_registrations_controller.rb
- 50 app/controllers/user_sessions_controller.rb
- 25 app/controllers/user_tokens_controller.rb
-547 total
+app/controllers/
+├── concerns/
+│ └── task_items_concern.rb
+├── complete_task_items_controller.rb
+├── incomplete_task_items_controller.rb
+└── task_items_controller.rb
 ```
 
 ### 🤔 What was changed? <!-- omit in toc -->
 
-The Rubycritic score increased from `90.34` to `91.34`.
+The Rubycritic score increased from `91.34` to `91.56`.
 
-This happened because each controller allowed the isolation of each action and callback and allowed the definition of methods with the same name. (Example: `user_params` instead of `user_registration_params`, `user_session_params`, `user_password_params`...).
+This happened because each cohesion has been increased, and the controllers are more specialized.
 
-Another benefit was the routing definition. It became more readable and easier to understand as it was possible to declare them using only default `REST` actions (index, show, new, create, edit, update, destroy).
+But lets be honest, the routes are worse than before. 😅
 
 ### 🔎 What the next version will have? <!-- omit in toc -->
 
-It shows how the restriction of REST actions can enforce cohesion and ensure controllers are responsible for specific contexts/concepts.
+Let's do what DHH taught us over a decade ago: https://jeromedalbert.com/how-dhh-organizes-his-rails-controllers/
 
-`Next version`: [021-multi-controllers-per-entity_rest-actions-only](https://github.com/solid-process/rails-way-app/tree/021-multi-controllers-per-entity_rest-actions-only?tab=readme-ov-file).
+This will improve the routes and put the controllers in a better structure.
+
+`Next version`: [030-resources-within-namespaces](https://github.com/solid-process/rails-way-app/tree/030-resources-within-namespaces?tab=readme-ov-file).
 
 ## 📣 Important info
 

app/controllers/complete_task_items_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class CompleteTaskItemsController < ApplicationController
+ include TaskItemsConcern
+
+ before_action :authenticate_user!
+ before_action :require_task_list!
+ before_action :set_task_item
+
+ def update
+ @task_item.complete!
+
+ respond_to do |format|
+ format.html do
+ redirect_to(next_location, notice: "Task item was successfully marked as completed.")
+ end
+ format.json { render "task_items/show", status: :ok, location: task_item_url(@task_item) }
+ end
+ end
+end

app/controllers/concerns/task_items_concern.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module TaskItemsConcern
+ extend ActiveSupport::Concern
+
+ included do
+ rescue_from ActiveRecord::RecordNotFound do |exception|
+ raise exception unless request.format.json?
+
+ render_json_with_error(status: :not_found, message: "Task list or item not found")
+ end
+ end
+
+ private
+
+ def require_task_list!
+ raise ActiveRecord::RecordNotFound unless Current.task_list_id
+ end
+
+ def set_task_item
+ @task_item = Current.task_items.find(params[:id])
+ end
+
+ def task_items_url(...)
+ task_list_task_items_url(Current.task_list_id, ...)
+ end
+
+ def task_item_url(...)
+ task_list_task_item_url(Current.task_list_id, ...)
+ end
+
+ def next_location
+ case params[:filter]
+ when "completed" then task_items_url(filter: "completed")
+ when "incomplete" then task_items_url(filter: "incomplete")
+ when "show" then task_item_url(@task_item)
+ else task_items_url
+ end
+ end
+end

app/controllers/incomplete_task_items_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class IncompleteTaskItemsController < ApplicationController
+ include TaskItemsConcern
+
+ before_action :authenticate_user!
+ before_action :require_task_list!
+ before_action :set_task_item
+
+ def update
+ @task_item.incomplete!
+
+ respond_to do |format|
+ format.html do
+ redirect_to(next_location, notice: "Task item was successfully marked as incomplete.")
+ end
+ format.json { render "task_items/show", status: :ok, location: task_item_url(@task_item) }
+ end
+ end
+end

app/controllers/task_items_controller.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
 class TaskItemsController < ApplicationController
+ include TaskItemsConcern
+
  before_action :authenticate_user!
  before_action :require_task_list!
  before_action :set_task_item, except: %i[index new create]
 
- rescue_from ActiveRecord::RecordNotFound do |exception|
- raise exception unless request.format.json?
-
- render_json_with_error(status: :not_found, message: "Task list or item not found")
- end
-
  def index
  task_items = Current.task_items
 
@@ -75,56 +71,9 @@ def destroy
  end
  end
 
- def complete
- @task_item.complete!
-
- respond_to do |format|
- format.html do
- redirect_to(next_location, notice: "Task item was successfully marked as completed.")
- end
- format.json { render :show, status: :ok, location: task_item_url(@task_item) }
- end
- end
-
- def incomplete
- @task_item.incomplete!
-
- respond_to do |format|
- format.html do
- redirect_to(next_location, notice: "Task item was successfully marked as incomplete.")
- end
- format.json { render :show, status: :ok, location: task_item_url(@task_item) }
- end
- end
-
  private
 
- def require_task_list!
- raise ActiveRecord::RecordNotFound unless Current.task_list_id
- end
-
- def set_task_item
- @task_item = Current.task_items.find(params[:id])
- end
-
  def task_item_params
  params.require(:task_item).permit(:name, :description, :completed)
  end
-
- def task_items_url(...)
- task_list_task_items_url(Current.task_list_id, ...)
- end
-
- def task_item_url(...)
- task_list_task_item_url(Current.task_list_id, ...)
- end
-
- def next_location
- case params[:filter]
- when "completed" then task_items_url(filter: "completed")
- when "incomplete" then task_items_url(filter: "incomplete")
- when "show" then task_item_url(@task_item)
- else task_items_url
- end
- end
 end

app/controllers/user_passwords_controller.rb

@@ -44,7 +44,7 @@ def update
  private
 
  def set_user_by_token
- @user = User.find_by_token_for(:reset_password, params[:id]) || User.find_by(id: params[:id])
+ @user = User.find_by_token_for(:reset_password, params[:id])
 
  return if @user
 

app/views/task_items/_toggle_status_action.html.erb

@@ -1,7 +1,7 @@
 <% if task_item.incomplete? %>
  <%= link_to(
  "✅",
- complete_task_list_task_item_path(Current.task_list_id, task_item, filter: params[:filter]),
+ task_list_complete_task_item_path(Current.task_list_id, task_item, filter: params[:filter]),
  title: "Mark as complete",
  data: { turbo_method: :put },
  class: 'button',
@@ -10,7 +10,7 @@
 <% else %>
  <%= link_to(
  "❌",
- incomplete_task_list_task_item_path(Current.task_list_id, task_item, filter: params[:filter]),
+ task_list_incomplete_task_item_path(Current.task_list_id, task_item, filter: params[:filter]),
  title: "Mark as incomplete",
  data: { turbo_method: :put },
  class: 'button',

app/views/task_items/show.html.erb

@@ -8,15 +8,15 @@
  <% if @task_item.incomplete? %>
  <%= link_to(
  "✅ Complete",
- complete_task_list_task_item_path(Current.task_list_id, @task_item, filter: "show"),
+ task_list_complete_task_item_path(Current.task_list_id, @task_item, filter: "show"),
  title: "Mark as complete",
  data: { turbo_method: :put },
  style: "text-decoration: none;"
  ) %>
  <% else %>
  <%= link_to(
  "❌ Incomplete",
- incomplete_task_list_task_item_path(Current.task_list_id, @task_item, filter: "show"),
+ task_list_incomplete_task_item_path(Current.task_list_id, @task_item, filter: "show"),
  title: "Mark as incomplete",
  data: { turbo_method: :put },
  style: "text-decoration: none;"

config/routes.rb

@@ -20,12 +20,9 @@
  resource :user_tokens, only: [ :edit, :update ]
 
  resources :task_lists do
- resources :task_items do
- member do
- put :complete
- put :incomplete
- end
- end
+ resources :task_items
+ resources :complete_task_items, only: [ :update ]
+ resources :incomplete_task_items, only: [ :update ]
  end
 
  # Defines the root path route ("/")

docs/01_REST_API_DOC.md

@@ -224,15 +224,15 @@ curl -X PUT "$API_HOST/task_lists/1/task_items/1" \
 #### Marking as incomplete
 
 ```bash
-curl -X PUT "$API_HOST/task_lists/1/task_items/1/incomplete" \
+curl -X PUT "$API_HOST/task_lists/1/incomplete_task_items/1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_TOKEN"
 ```
 
 #### Marking as completed
 
 ```bash
-curl -X PUT "$API_HOST/task_lists/1/task_items/1/complete" \
+curl -X PUT "$API_HOST/task_lists/1/complete_task_items/1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_TOKEN"
 ```