todoro 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3484fe0d4b42818d6da75b14b1338263923ba16af50f7e004604f456a9793f89
-  data.tar.gz: db0eb21bd21af52c31e146e1500990b6621bef2989d311f367c14d9b4cb83fac
+  metadata.gz: 1e52adb97a2a743b91e09a3b654b3ac9d7782298c6ee3b933bad51d1a2a94caf
+  data.tar.gz: d8b17e1c03b70d67aec43528fe6b8acec2e9519e6ad0c2797f48af22012b5147
 SHA512:
-  metadata.gz: 7bbcbdd4e9b607f5e1dadaa596e5ce1b712269762c481826823b46c564516e43eceaca8de23c186c3a28036b975966e79157df31c7550c47ac1a21de35c620a9
-  data.tar.gz: eacfe1c557993e63efac5e8161cc8517b511627fbb2236fea10e7b7cf4e6c664bc4de12d907b9e7580be9931ca400c5adb7b0b322b58f1ab38e706b3488c53b5
+  metadata.gz: 4638b8767f43a852653c6f68ef6ae718fc70a1281f39d09d32554facf1038d4507e11f46669de3b39d4345153876a6dad15aa1d74a120021a2f4416cd64f25e1
+  data.tar.gz: 0b5232015299955bf5f2825bcbe540fcad438f75d1346fa7c3758d23978f6f0d80c46ebe2cfc473101a743861e76fc3030b7b77021b400a4b5d2c6d885302ccb

data/README.md

@@ -1,11 +1,42 @@
+To enhance the **Todoro** gem's documentation, here's an updated version of the `README.md` file that includes instructions on mounting the engine and customizing the mount path:
+
+```markdown
 # Todoro
+
 A lightweight Rails engine that lets any model manage task lists and tasks with a simple, flexible API.
 
 ![Totoro](totoro.png)
 
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "todoro"
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install todoro
+```
+
 ## Usage
 
-Include Taskable in the model(s) that can have tasks
+Generate the required migrations:
+
+```sh
+$ rails generate todoro:install
+$ rails db:migrate
+```
+
+Include `acts_as_taskable` in the model(s) that can have tasks:
 
 ```ruby
 class Project < ApplicationRecord
@@ -13,9 +44,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")
@@ -23,25 +54,38 @@ task = project.add_task_to_list(task_list, "Build homepage", "Implement UI compo
 puts project.tasks # Lists all tasks in all its task lists
 ```
 
-## Installation
+## Mounting the Engine
 
-Add to your Gemfile:
+To access Todoro's routes, mount the engine in your application's routes file:
 
 ```ruby
-gem "todoro"
+# config/routes.rb
+Rails.application.routes.draw do
+  mount Todoro::Engine, at: '/todoro'
+  # Other routes...
+end
 ```
 
-And then execute:
+This makes Todoro's features accessible under the `/todoro` path (e.g., `http://yourdomain.com/todoro`).
 
-```bash
-$ bundle
-```
+### Customizing the Mount Path
 
-Or install it yourself as:
+You can mount Todoro at any path that fits your application's structure:
+
+- To mount at the root:
+
+  ```ruby
+  Rails.application.routes.draw do
+    mount Todoro::Engine, at: '/'
+    # Other routes...
+  end
+  ```
+
+  Now, Todoro's routes are available at the root URL (e.g., `http://yourdomain.com/`).
 
-```bash
-$ gem install todoro
-```
 
 ## 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/controllers/todoro/task_lists_controller.rb

@@ -16,7 +16,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 task_lists_path(taskable: @taskable), notice: "Task list created successfully."
       else
         render :new
       end
@@ -26,7 +26,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 task_lists_path(taskable: @task_list.taskable), notice: "Task list updated successfully."
       else
         render :edit
       end
@@ -35,7 +35,7 @@ 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 task_lists_path(taskable: taskable), notice: "Task list deleted."
     end
 
     private

data/app/controllers/todoro/tasks_controller.rb

@@ -10,7 +10,7 @@ module Todoro
     def create
       @task = @task_list.tasks.new(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 task_list_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, id: @task_list.id), notice: "Task created successfully."
       else
         render :new
       end
@@ -33,7 +33,7 @@ module Todoro
 
     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 task_list_path(taskable: @task_list.taskable.class.name, taskable_id: @task_list.taskable.id, id: @task_list.id), notice: "Task marked as completed."
     end
 
     private

data/config/routes.rb

@@ -1,10 +1,8 @@
 Todoro::Engine.routes.draw do
-  resources :taskables, only: [] do
-    resources :task_lists do
-      resources :tasks do
-        member do
-          patch :complete
-        end
+  resources :task_lists do
+    resources :tasks do
+      member do
+        patch :complete
       end
     end
   end

data/db/migrate/{20250214104107_create_todoro_task_lists.rb → 20250215225042_create_todoro_task_lists.rb}

@@ -1,4 +1,4 @@
-class CreateTodoroTaskLists < ActiveRecord::Migration[8.0]
+class CreateTodoroTaskLists < ActiveRecord::Migration[ActiveRecord::Migration.current_version]
   def change
     create_table :todoro_task_lists do |t|
       t.string :name, null: false

data/db/migrate/{20250214104109_create_todoro_tasks.rb → 20250215225043_create_todoro_tasks.rb}

@@ -1,4 +1,4 @@
-class CreateTodoroTasks < ActiveRecord::Migration[8.0]
+class CreateTodoroTasks < ActiveRecord::Migration[ActiveRecord::Migration.current_version]
   def change
     create_table :todoro_tasks do |t|
       t.string :title

data/db/migrate/{20250214104111_create_todoro_reminders.rb → 20250215225044_create_todoro_reminders.rb}

@@ -1,4 +1,4 @@
-class CreateTodoroReminders < ActiveRecord::Migration[8.0]
+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 }

data/db/migrate/{20250215024110_add_indexes_to_todoro_tasks.rb → 20250215225045_add_indexes_to_todoro_tasks.rb}

@@ -1,4 +1,4 @@
-class AddIndexesToTodoroTasks < ActiveRecord::Migration[8.0]
+class AddIndexesToTodoroTasks < ActiveRecord::Migration[ActiveRecord::Migration.current_version]
    def change
     add_index :todoro_task_lists, [ :taskable_type, :taskable_id ]
     add_index :todoro_tasks, :status

data/lib/generators/todoro/install_generator.rb

@@ -0,0 +1,22 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Todoro
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("templates", __dir__)
+
+      def create_migrations
+        migration_template "create_todoro_task_lists.rb", "db/migrate/create_todoro_task_lists.rb"
+        migration_template "create_todoro_tasks.rb", "db/migrate/create_todoro_tasks.rb"
+        migration_template "create_todoro_reminders.rb", "db/migrate/create_todoro_reminders.rb"
+        migration_template "add_indexes_to_todoro_tasks.rb", "db/migrate/add_indexes_to_todoro_tasks.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+    end
+  end
+end

data/lib/generators/todoro/templates/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/generators/todoro/templates/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/lib/generators/todoro/templates/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/lib/generators/todoro/templates/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/lib/todoro/version.rb

@@ -1,3 +1,3 @@
 module Todoro
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: todoro
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Despo Pentara
@@ -60,10 +60,15 @@ files:
 - app/views/todoro/tasks/edit.html.erb
 - app/views/todoro/tasks/new.html.erb
 - config/routes.rb
-- db/migrate/20250214104107_create_todoro_task_lists.rb
-- db/migrate/20250214104109_create_todoro_tasks.rb
-- db/migrate/20250214104111_create_todoro_reminders.rb
-- db/migrate/20250215024110_add_indexes_to_todoro_tasks.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
+- lib/generators/todoro/templates/create_todoro_task_lists.rb
+- lib/generators/todoro/templates/create_todoro_tasks.rb
 - lib/tasks/todoro_tasks.rake
 - lib/todoro.rb
 - lib/todoro/engine.rb