todoro 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9df4d399bddcdec90b476afd3f277a388c9ed04a60c3388cbd339f33f9bc78a
-  data.tar.gz: 4d56a850c3674c38e6abeaae287afe234f6a6fee73edb09722b8d066f3a61095
+  metadata.gz: 5fdd815954054219782d8b2281bced824aca47cb6c7add82408cf6d1fdad3f4d
+  data.tar.gz: aa21ff161a69f8d9ae91cc5634871fdb354aeead527c92b8798b6526e576812b
 SHA512:
-  metadata.gz: 4b9fd5d72efb5b3a6bb3b8b5c1b024405ab5f43b9f626607ce6ea2b740f8498abe14d045cd0c3d31256132ff80ab042664209985f48b02b72dbd07f0479f9890
-  data.tar.gz: c2d103b2d0b301652b364ceeecc0e65e057e6431c79386a52e54a8ba26d841988394683337ee09d4f9c8ee8c4395edbc70152f7597427fc2ca0e432695a8abe0
+  metadata.gz: d5c69c6f569090184889b7536ea4d380c5a616be36155a70941e7f2cae1095a73780b4844013539d3ff536da18db1f34b48ce62e5dd9d5bcce37e00239c1d1d6
+  data.tar.gz: ee5361a8bc6904bba93619563a6b4d504a5e2b359c8c75ad25b44fda556b8b2d79349011a50b6ad32c1af5613459eec36320317584cec7ff753345d68216fe2d

data/README.md

@@ -1,4 +1,5 @@
 # Todoro
+
 A lightweight Rails engine that lets any model manage task lists and tasks with a simple, flexible API.
 
 ![Totoro](totoro.png)
@@ -13,25 +14,26 @@ gem "todoro"
 
 And then execute:
 
-```bash
-$ bundle
+```sh
+$ bundle install
 ```
 
 Or install it yourself as:
 
-```bash
+```sh
 $ gem install todoro
 ```
 
 ## Usage
 
-Generate the required migrations
+Generate the required migrations:
 
-```ruby
-rails generate todoro:install
+```sh
+$ rails generate todoro:install
+$ rails db:migrate
 ```
 
-Include Taskable in the model(s) that can have tasks
+Include `acts_as_taskable` in the model(s) that can have tasks:
 
 ```ruby
 class Project < ApplicationRecord
@@ -39,9 +41,9 @@ class Project < ApplicationRecord
 end
 ```
 
-Now, a Project can have task lists and tasks!
+Now, a `Project` can have task lists and tasks:
 
-```bash
+```ruby
 project = Project.create(name: "Website Redesign")
 task_list = project.create_task_list("Development Tasks")
 task = project.add_task_to_list(task_list, "Build homepage", "Implement UI components")
@@ -49,6 +51,36 @@ task = project.add_task_to_list(task_list, "Build homepage", "Implement UI compo
 puts project.tasks # Lists all tasks in all its task lists
 ```
 
+## Automatic Route Generation
+
+Todoro automatically generates routes for any model that includes `acts_as_taskable`. For example, if `Project` includes `acts_as_taskable`, the following routes are created:
+
+```sh
+GET    /projects/:project_id/task_lists(.:format)
+POST   /projects/:project_id/task_lists(.:format)
+GET    /projects/:project_id/task_lists/:id(.:format)
+PATCH  /projects/:project_id/task_lists/:id(.:format)
+DELETE /projects/:project_id/task_lists/:id(.:format)
+GET    /projects/:project_id/task_lists/:task_list_id/tasks(.:format)
+POST   /projects/:project_id/task_lists/:task_list_id/tasks(.:format)
+```
+
+These routes are automatically configured, so no additional setup is needed.
+
+## Mounting the Engine
+
+To access Todoro's routes, mount the engine in your application's routes file:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  mount Todoro::Engine, at: "/"
+  # Other routes...
+end
+```
+
+Since Todoro dynamically registers routes for `acts_as_taskable` models, no further route configuration is required.
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+The gem is available as open source under the terms of the [MIT License](MIT-LICENSE).

data/app/constraints/taskable_models_constraint.rb

@@ -0,0 +1,6 @@
+class TaskableModelsConstraint
+  def matches?(request)
+    taskable_type = request.params[:taskable_type]&.classify
+    Todoro.taskable_models.include?(taskable_type)
+  end
+end

data/app/controllers/todoro/application_controller.rb

@@ -1,4 +1,26 @@
 module Todoro
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
+    before_action :set_taskable
+    before_action :validate_taskable!
+
+    private
+
+    def set_taskable
+      taskable_type = params[:taskable_type]&.classify
+      taskable_id_param = "#{params[:taskable_type]}_id"
+      taskable_id = params[taskable_id_param]
+
+      if taskable_type.present? && taskable_id.present? && Todoro.taskable_models.include?(taskable_type)
+        @taskable = taskable_type.safe_constantize&.find_by(id: taskable_id)
+      end
+
+      render json: { error: "Taskable not found" }, status: :not_found unless @taskable
+    end
+
+    def validate_taskable!
+      unless @taskable && Todoro.taskable_models.include?(@taskable.class.name)
+        render json: { error: "Unauthorized taskable model" }, status: :forbidden
+      end
+    end
   end
 end

data/app/controllers/todoro/task_lists_controller.rb

@@ -1,7 +1,6 @@
 module Todoro
   class TaskListsController < ApplicationController
     before_action :set_task_list, only: %i[show edit update destroy]
-    before_action :set_taskable, only: %i[index new create]
 
     def index
       @task_lists = @taskable.task_lists
@@ -16,7 +15,7 @@ module Todoro
     def create
       @task_list = @taskable.task_lists.new(task_list_params)
       if @task_list.save
-        redirect_to taskable_task_lists_path(taskable: @taskable), notice: "Task list created successfully."
+        redirect_to [ @taskable, @task_list ], notice: "Task list created successfully."
       else
         render :new
       end
@@ -26,7 +25,7 @@ module Todoro
 
     def update
       if @task_list.update(task_list_params)
-        redirect_to taskable_task_lists_path(taskable: @task_list.taskable), notice: "Task list updated successfully."
+        redirect_to [ @taskable, @task_list ], notice: "Task list updated successfully."
       else
         render :edit
       end
@@ -35,23 +34,14 @@ module Todoro
     def destroy
       taskable = @task_list.taskable
       @task_list.destroy
-      redirect_to taskable_task_lists_path(taskable: taskable), notice: "Task list deleted."
+
+      redirect_to [ @taskable, :task_list ], notice: "Task list deleted."
     end
 
     private
 
     def set_task_list
-      @task_list = TaskList.find(params[:id])
-    end
-
-    def set_taskable
-      @taskable = find_taskable
-    end
-
-    def find_taskable
-      return unless params[:taskable] && params[:taskable_id]
-
-      params[:taskable].constantize.find(params[:taskable_id])
+      @task_list = @taskable.task_lists.find(params[:id])
     end
 
     def task_list_params

data/app/controllers/todoro/tasks_controller.rb

@@ -8,9 +8,10 @@ module Todoro
     end
 
     def create
-      @task = @task_list.tasks.new(task_params)
+      @task = @task_list.tasks.build(task_params)
+
       if @task.save
-        redirect_to todoro.taskable_task_list_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, id: @task_list.id), notice: "Task created successfully."
+        redirect_to [ @taskable, @task_list ], notice: "Task created successfully."
       else
         render :new
       end
@@ -20,7 +21,7 @@ module Todoro
 
     def update
       if @task.update(task_params)
-        redirect_to @task_list, notice: "Task updated successfully."
+        redirect_to [ @taskable, @task_list ], notice: "Task updated successfully."
       else
         render :edit
       end
@@ -28,26 +29,26 @@ module Todoro
 
     def destroy
       @task.destroy
-      redirect_to @task_list, notice: "Task deleted."
+      redirect_to [ @taskable, @task_list ], notice: "Task deleted."
     end
 
     def complete
       @task.update(status: "completed")
-      redirect_to todoro.taskable_task_list_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, id: @task_list.id), notice: "Task marked as completed."
+      redirect_to [ @taskable, @task_list ], notice: "Task marked as completed."
     end
 
     private
 
-    def set_task_list
-      @task_list = Todoro::TaskList.find(params[:task_list_id])
-    end
-
     def set_task
       @task = @task_list.tasks.find(params[:id])
     end
 
+    def set_task_list
+      @task_list = @taskable.task_lists.find(params[:task_list_id])
+    end
+
     def task_params
-      params.require(:task).permit(:title, :description, :expiry_date, :status)
+      params.require(:task).permit(:title, :description, :status, :expiry_date)
     end
   end
 end

data/app/models/todoro/task.rb

@@ -4,7 +4,6 @@ module Todoro
     has_many :reminders, dependent: :destroy
 
     validates :title, presence: true
-    validates :description, presence: true
     validates :status, presence: true, inclusion: { in: %w[pending completed] }
 
     enum :status, { pending: "pending", completed: "completed" }

data/app/views/todoro/task_lists/_form.html.erb

@@ -1,12 +1,9 @@
-<%= form_with model: [taskable, task_list], local: true do |form| %>
+<%= form_with model: task_list, url: polymorphic_path([@taskable, task_list]), local: true do |form| %>
   <div class="form-group">
     <%= form.label :name %>
     <%= form.text_field :name, class: "form-control", required: true %>
   </div>
 
-  <%= form.hidden_field :taskable_id, value: taskable.id %>
-  <%= form.hidden_field :taskable_type, value: taskable.class.name %>
 
   <%= form.submit class: "btn btn-success" %>
 <% end %>
-

data/app/views/todoro/task_lists/edit.html.erb

@@ -2,4 +2,4 @@
 
 <%= render "form", task_list: @task_list %>
 
-<%= link_to "Back to Task Lists", task_lists_path, class: "btn btn-secondary" %>
+<%= link_to "Back to Task Lists", polymorphic_path([@task_list.taskable, :task_lists]), class: "btn btn-secondary" %>

data/app/views/todoro/task_lists/index.html.erb

@@ -1,15 +1,15 @@
 <h1>Task Lists for <%= @taskable.class.name %>: <%= @taskable.try(:name) || "Unknown" %></h1>
 
-<%= link_to "Create New Task List", new_taskable_task_list_path(taskable: @taskable.class.name, taskable_id: @taskable.id), class: "btn btn-primary" %>
+<%= link_to "Create New Task List", new_polymorphic_path([@taskable, :task_list]), class: "btn btn-primary" %>
 
 <ul>
   <% @task_lists.each do |task_list| %>
     <li>
-      <%= link_to task_list.name, taskable_task_list_path(taskable: @taskable.class.name, taskable_id: @taskable.id, id: task_list.id) %>
-      (<%= link_to "Edit", edit_taskable_task_list_path(taskable: @taskable.class.name, taskable_id: @taskable.id, id: task_list.id) %> |
-       <%= link_to "Delete", taskable_task_list_path(taskable: @taskable.class.name, taskable_id: @taskable.id, id: task_list.id), method: :delete, data: { confirm: "Are you sure?" } %>)
+      <%= link_to task_list.name, polymorphic_path([ @taskable, task_list]) %>
+      (<%= link_to "Edit", edit_polymorphic_path([@taskable, task_list ])%> |
+       <%= link_to "Delete", polymorphic_path([ @taskable, task_list ]), method: :delete, data: { confirm: "Are you sure?" } %>)
     </li>
   <% end %>
 </ul>
 
-<%= link_to "Back", root_path, class: "btn btn-secondary" %>
+<%= link_to "Back", polymorphic_path(@taskable), class: "btn btn-secondary" %>

data/app/views/todoro/task_lists/new.html.erb

@@ -2,4 +2,4 @@
 
 <%= render "form", task_list: @task_list %>
 
-<%= link_to "Back to Task Lists", task_lists_path, class: "btn btn-secondary" %>
+<%= link_to "Back to Task Lists", polymorphic_path([@taskable, @task_list]), class: "btn btn-secondary" %>

data/app/views/todoro/task_lists/show.html.erb

@@ -1,21 +1,24 @@
 <h1><%= @task_list.name %></h1>
 
-<%= link_to "Edit", edit_taskable_task_list_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, id: @task_list.id), class: "btn btn-warning" %>
-<%= link_to "Delete", taskable_task_list_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, id: @task_list.id), method: :delete, data: { confirm: "Are you sure?" }, class: "btn btn-danger" %>
+<%= link_to "Edit", edit_polymorphic_path([@task_list.taskable, @task_list]), class: "btn btn-warning" %>
+
+<%= button_to "Delete", polymorphic_path([@task_list.taskable, @task_list]), method: :delete, data: { confirm: "Are you sure?" }, class: "btn btn-danger btn-link" %>
 
 <h2>Tasks</h2>
-<%= link_to "Add Task", new_taskable_task_list_task_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, task_list_id: @task_list.id), class: "btn btn-primary" %>
+<%= link_to "Add Task", new_polymorphic_path([@task_list.taskable, @task_list, :task]), class: "btn btn-primary" %>
 
 <ul>
   <% @task_list.tasks.each do |task| %>
     <li>
       <%= task.title %> - <%= task.status %>
-      (<%= link_to "Edit", edit_taskable_task_list_task_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, task_list_id: @task_list.id, id: task.id) %> |
-       <%= link_to "Complete", complete_taskable_task_list_task_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, task_list_id: @task_list.id, id: task.id), method: :patch if task.status == "pending" %> |
-       <%= link_to "Delete", taskable_task_list_task_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, task_list_id: @task_list.id, id: task.id), method: :delete, data: { confirm: "Are you sure?" } %>)
+      <%= link_to "Edit", edit_polymorphic_path([@task_list.taskable, @task_list, task]) %> |
+
+       <%= button_to "Complete", polymorphic_path([@task_list.taskable, @task_list, task], action: :complete), method: :patch, class: "btn btn-success btn-link", data: { turbo: true } if task.status == "pending" %>
+
+       <%= button_to "Delete", polymorphic_path([@task_list.taskable, @task_list, task]), method: :delete, data: { confirm: "Are you sure?" }, class: "btn btn-danger btn-link" %>
+
     </li>
   <% end %>
 </ul>
 
-<%= link_to "Back to Task Lists", taskable_task_lists_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id), class: "btn btn-secondary" %>
-
+<%= link_to "Back to Task Lists", polymorphic_path([@task_list.taskable, :task_lists]), class: "btn btn-secondary" %>

data/app/views/todoro/tasks/_form.html.erb

@@ -1,4 +1,4 @@
-<%= form_with model: [task.task_list, task], local: true do |form| %>
+<%= form_with model: task, url: polymorphic_path([@taskable, @task_list, @task]), local: true do |form| %>
   <div class="form-group">
     <%= form.label :title %>
     <%= form.text_field :title, class: "form-control", required: true %>
@@ -6,7 +6,7 @@
 
   <div class="form-group">
     <%= form.label :description %>
-    <%= form.text_area :description, class: "form-control", required: true %>
+    <%= form.text_area :description, class: "form-control" %>
   </div>
 
   <div class="form-group">

data/app/views/todoro/tasks/edit.html.erb

@@ -2,4 +2,4 @@
 
 <%= render "form", task: @task %>
 
-<%= link_to "Back to Task List", task_list_path(@task_list), class: "btn btn-secondary" %>
+<%= link_to "Back to Task List", polymorphic_path([@taskable, @task_list]), class: "btn btn-secondary" %>

data/app/views/todoro/tasks/new.html.erb

@@ -2,4 +2,4 @@
 
 <%= render "form", task: @task %>
 
-<%= link_to "Back to Task List", task_list_path(@task_list), class: "btn btn-secondary" %>
+<%= link_to "Back to Task List", polymorphic_path([@taskable, @task_list]), class: "btn btn-secondary" %>

data/config/routes.rb

@@ -1,9 +1,11 @@
 Todoro::Engine.routes.draw do
-  resources :taskables, only: [] do
-    resources :task_lists do
-      resources :tasks do
-        member do
-          patch :complete
+  Todoro.taskable_models.each do |model|
+    resource_name = model.underscore.pluralize.to_sym
+
+    resources resource_name, defaults: { taskable_type: model.downcase }, constraints: TaskableModelsConstraint.new do
+      resources :task_lists do
+        resources :tasks, only: [ :new, :edit, :create, :update, :destroy ] do
+          patch :complete, on: :member
         end
       end
     end

data/db/migrate/20250215225042_create_todoro_task_lists.rb

@@ -0,0 +1,10 @@
+class CreateTodoroTaskLists < ActiveRecord::Migration[ActiveRecord::Migration.current_version]
+  def change
+    create_table :todoro_task_lists do |t|
+      t.string :name, null: false
+      t.references :taskable, polymorphic: true, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20250215225043_create_todoro_tasks.rb

@@ -0,0 +1,20 @@
+class CreateTodoroTasks < ActiveRecord::Migration[ActiveRecord::Migration.current_version]
+  def change
+    create_table :todoro_tasks do |t|
+      t.string :title
+      t.text :description, null: false  # Description is required
+      t.datetime :expiry_date
+      t.string :status, null: false, default: "pending"  # Status is required
+      t.references :task_list, null: false, foreign_key: { to_table: :todoro_task_lists }
+
+      t.timestamps
+    end
+
+    # Enforce status constraint
+    execute <<-SQL
+      ALTER TABLE todoro_tasks
+      ADD CONSTRAINT status_check
+      CHECK (status IN ('pending', 'completed'));
+    SQL
+  end
+end

data/db/migrate/20250215225044_create_todoro_reminders.rb

@@ -0,0 +1,12 @@
+class CreateTodoroReminders < ActiveRecord::Migration[ActiveRecord::Migration.current_version]
+  def change
+    create_table :todoro_reminders do |t|
+      t.references :task, null: false, foreign_key: { to_table: :todoro_tasks }
+      t.datetime :remind_at, null: false  # Enforce remind_at is mandatory
+
+
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20250215225045_add_indexes_to_todoro_tasks.rb

@@ -0,0 +1,7 @@
+class AddIndexesToTodoroTasks < ActiveRecord::Migration[ActiveRecord::Migration.current_version]
+   def change
+    add_index :todoro_task_lists, [ :taskable_type, :taskable_id ]
+    add_index :todoro_tasks, :status
+    add_index :todoro_tasks, :expiry_date
+  end
+end

data/lib/todoro/version.rb

@@ -1,3 +1,3 @@
 module Todoro
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/todoro.rb

@@ -3,4 +3,11 @@ require "todoro/engine"
 require "todoro/taskable"
 
 module Todoro
+  def self.taskable_models
+    Rails.application.eager_load!
+
+    ActiveRecord::Base.descendants.select do |model|
+      model.included_modules.include?(Todoro::Taskable)
+    end.map(&:name)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todoro
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Despo Pentara
 - Evangelos Giataganas
 bindir: bin
 cert_chain: []
-date: 2025-02-15 00:00:00.000000000 Z
+date: 2025-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,6 +37,7 @@ files:
 - README.md
 - Rakefile
 - app/assets/stylesheets/todoro/application.css
+- app/constraints/taskable_models_constraint.rb
 - app/controllers/todoro/application_controller.rb
 - app/controllers/todoro/task_lists_controller.rb
 - app/controllers/todoro/tasks_controller.rb
@@ -45,7 +46,6 @@ files:
 - app/helpers/todoro/tasks_helper.rb
 - app/jobs/todoro/application_job.rb
 - app/mailers/todoro/application_mailer.rb
-- app/models/concerns/taskable.rb
 - app/models/todoro/application_record.rb
 - app/models/todoro/reminder.rb
 - app/models/todoro/task.rb
@@ -60,6 +60,10 @@ files:
 - app/views/todoro/tasks/edit.html.erb
 - app/views/todoro/tasks/new.html.erb
 - config/routes.rb
+- db/migrate/20250215225042_create_todoro_task_lists.rb
+- db/migrate/20250215225043_create_todoro_tasks.rb
+- db/migrate/20250215225044_create_todoro_reminders.rb
+- db/migrate/20250215225045_add_indexes_to_todoro_tasks.rb
 - lib/generators/todoro/install_generator.rb
 - lib/generators/todoro/templates/add_indexes_to_todoro_tasks.rb
 - lib/generators/todoro/templates/create_todoro_reminders.rb

data/app/models/concerns/taskable.rb

@@ -1,21 +0,0 @@
-module Todoro
-  module Taskable
-    extend ActiveSupport::Concern
-
-    included do
-      has_many :task_lists, as: :taskable, class_name: "Todoro::TaskList", dependent: :destroy
-    end
-
-    def tasks
-      Todoro::Task.joins(:task_list).where(task_lists: { taskable_id: id, taskable_type: self.class.name })
-    end
-
-    def create_task_list(name)
-      task_lists.create(name: name)
-    end
-
-    def add_task_to_list(task_list, title, description, expiry_date = nil)
-      task_list.tasks.create(title: title, description: description, expiry_date: expiry_date, status: "pending")
-    end
-  end
-end