todoro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78c58e8c3cbbd35a3847423990ebb2842bc6a51288252164b2a17270709bbe94
+  data.tar.gz: 8d0c16555e3294e5ba374096d0d06e72ccc240dfd8e395926471861251c01295
+SHA512:
+  metadata.gz: eb958edea41a965cb244c358959fc7926d2b2a9cbe59714a6518f3d06ccc7dba34a9605ba6ef01d73a5f2aa22849f5b58ef554c31a4f536eb7b7cc6a5b55c425
+  data.tar.gz: 5799d3406ca9ddc3c973037bc62964e47439d6e666f46dae99be96dcee50f2c8dde1dfbfc294362690f5fba425d62551751122916095de5ccfb94085d119dd31

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2025 Despo Pentara, Evangelos Giataganas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Todoro
+A lightweight Rails engine that lets any model manage task lists and tasks with a simple, flexible API.
+
+## Usage
+
+Include Taskable in the model(s) that can have tasks
+
+```ruby
+class Project < ApplicationRecord
+  acts_as_taskable
+end
+```
+
+Now, a Project can have task lists and tasks!
+
+```bash
+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")
+
+puts project.tasks # Lists all tasks in all its task lists
+```
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "todoro"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install todoro
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,30 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/todoapp/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require 'rdoc/task'
+
+desc 'Generate documentation for Todoro.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Todoro'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+
+# Define the "spec" task, at task load time rather than inside another task
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run all tests'
+task all_tests: :environment do
+  ENV['RUN_ALL_TESTS'] = 'true'
+  Rake::Task['spec'].invoke
+end

data/app/assets/stylesheets/todoro/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/todoro/application_controller.rb

@@ -0,0 +1,4 @@
+module Todoro
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/todoro/task_lists_controller.rb

@@ -0,0 +1,61 @@
+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
+    end
+
+    def show; end
+
+    def new
+      @task_list = @taskable.task_lists.new
+    end
+
+    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."
+      else
+        render :new
+      end
+    end
+
+    def edit; end
+
+    def update
+      if @task_list.update(task_list_params)
+        redirect_to taskable_task_lists_path(taskable: @task_list.taskable), notice: "Task list updated successfully."
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      taskable = @task_list.taskable
+      @task_list.destroy
+      redirect_to taskable_task_lists_path(taskable: taskable), 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])
+    end
+
+    def task_list_params
+      params.require(:task_list).permit(:name)
+    end
+  end
+end

data/app/controllers/todoro/tasks_controller.rb

@@ -0,0 +1,53 @@
+module Todoro
+  class TasksController < ApplicationController
+    before_action :set_task_list
+    before_action :set_task, only: %i[edit update destroy complete]
+
+    def new
+      @task = @task_list.tasks.new
+    end
+
+    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."
+      else
+        render :new
+      end
+    end
+
+    def edit; end
+
+    def update
+      if @task.update(task_params)
+        redirect_to @task_list, notice: "Task updated successfully."
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      @task.destroy
+      redirect_to @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."
+    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 task_params
+      params.require(:task).permit(:title, :description, :expiry_date, :status)
+    end
+  end
+end

data/app/helpers/todoro/application_helper.rb

@@ -0,0 +1,4 @@
+module Todoro
+  module ApplicationHelper
+  end
+end

data/app/helpers/todoro/task_lists_helper.rb

@@ -0,0 +1,4 @@
+module Todoro
+  module TaskListsHelper
+  end
+end

data/app/helpers/todoro/tasks_helper.rb

@@ -0,0 +1,4 @@
+module Todoro
+  module TasksHelper
+  end
+end

data/app/jobs/todoro/application_job.rb

@@ -0,0 +1,4 @@
+module Todoro
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/todoro/application_mailer.rb

@@ -0,0 +1,6 @@
+module Todoro
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/concerns/taskable.rb

@@ -0,0 +1,21 @@
+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

data/app/models/todoro/application_record.rb

@@ -0,0 +1,5 @@
+module Todoro
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/todoro/reminder.rb

@@ -0,0 +1,7 @@
+module Todoro
+  class Reminder < ApplicationRecord
+    belongs_to :task
+
+    validates :remind_at, presence: true
+  end
+end

data/app/models/todoro/task.rb

@@ -0,0 +1,23 @@
+module Todoro
+  class Task < ApplicationRecord
+    belongs_to :task_list
+    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" }
+
+    after_create :set_default_reminders
+
+    private
+
+    def set_default_reminders
+      return unless expiry_date
+
+      reminders.create(remind_at: expiry_date - 1.hour)
+      reminders.create(remind_at: expiry_date - 1.day)
+    end
+  end
+end

data/app/models/todoro/task_list.rb

@@ -0,0 +1,8 @@
+module Todoro
+  class TaskList < ApplicationRecord
+    belongs_to :taskable, polymorphic: true
+    has_many :tasks, dependent: :destroy
+
+    validates :name, presence: true
+  end
+end

data/app/views/layouts/todoro/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Todoro</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "todoro/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

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

@@ -0,0 +1,12 @@
+<%= form_with model: [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

@@ -0,0 +1,5 @@
+<h1>Edit Task List</h1>
+
+<%= render "form", task_list: @task_list %>
+
+<%= link_to "Back to Task Lists", task_lists_path, class: "btn btn-secondary" %>

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

@@ -0,0 +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" %>
+
+<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?" } %>)
+    </li>
+  <% end %>
+</ul>
+
+<%= link_to "Back", root_path, class: "btn btn-secondary" %>

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

@@ -0,0 +1,5 @@
+<h1>New Task List</h1>
+
+<%= render "form", task_list: @task_list %>
+
+<%= link_to "Back to Task Lists", task_lists_path, class: "btn btn-secondary" %>

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

@@ -0,0 +1,21 @@
+<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" %>
+
+<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" %>
+
+<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?" } %>)
+    </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" %>
+

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

@@ -0,0 +1,18 @@
+<%= form_with model: [task.task_list, task], local: true do |form| %>
+  <div class="form-group">
+    <%= form.label :title %>
+    <%= form.text_field :title, class: "form-control", required: true %>
+  </div>
+
+  <div class="form-group">
+    <%= form.label :description %>
+    <%= form.text_area :description, class: "form-control", required: true %>
+  </div>
+
+  <div class="form-group">
+    <%= form.label :expiry_date %>
+    <%= form.datetime_select :expiry_date, class: "form-control" %>
+  </div>
+
+  <%= form.submit class: "btn btn-success" %>
+<% end %>

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

@@ -0,0 +1,5 @@
+<h1>Edit Task</h1>
+
+<%= render "form", task: @task %>
+
+<%= link_to "Back to Task List", task_list_path(@task_list), class: "btn btn-secondary" %>

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

@@ -0,0 +1,5 @@
+<h1>New Task for <%= @task_list.name %></h1>
+
+<%= render "form", task: @task %>
+
+<%= link_to "Back to Task List", task_list_path(@task_list), class: "btn btn-secondary" %>

data/config/routes.rb

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

data/db/migrate/20250214104107_create_todoro_task_lists.rb

@@ -0,0 +1,10 @@
+class CreateTodoroTaskLists < ActiveRecord::Migration[8.0]
+  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/20250214104109_create_todoro_tasks.rb

@@ -0,0 +1,20 @@
+class CreateTodoroTasks < ActiveRecord::Migration[8.0]
+  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/20250214104111_create_todoro_reminders.rb

@@ -0,0 +1,12 @@
+class CreateTodoroReminders < ActiveRecord::Migration[8.0]
+  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/tasks/todoro_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :todoro do
+#   # Task goes here
+# end

data/lib/todoro/engine.rb

@@ -0,0 +1,11 @@
+module Todoro
+  class Engine < ::Rails::Engine
+    isolate_namespace Todoro
+
+    initializer "todoro.taskable" do
+      ActiveSupport.on_load(:active_record) do
+        extend Todoro::Taskable::ClassMethods
+      end
+    end
+  end
+end

data/lib/todoro/taskable.rb

@@ -0,0 +1,36 @@
+module Todoro
+  module Taskable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :task_lists, as: :taskable, class_name: "Todoro::TaskList", dependent: :destroy
+      has_many :tasks, through: :task_lists, class_name: "Todoro::Task"
+
+      after_initialize :ensure_taskable_registered
+    end
+
+    class_methods do
+      def acts_as_taskable
+        include Todoro::Taskable
+      end
+    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
+
+    private
+
+    def ensure_taskable_registered
+      # Placeholder for additional logic if needed in future (like logging)
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend Todoro::Taskable::ClassMethods
+end

data/lib/todoro/version.rb

@@ -0,0 +1,3 @@
+module Todoro
+  VERSION = "0.1.0"
+end

data/lib/todoro.rb

@@ -0,0 +1,6 @@
+require "todoro/version"
+require "todoro/engine"
+require "todoro/taskable"
+
+module Todoro
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: todoro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Despo Pentara
+- Evangelos Giataganas
+bindir: bin
+cert_chain: []
+date: 2025-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+description: A lightweight Rails engine that lets any model manage task lists and
+  tasks with a simple, flexible API.
+email:
+- despo@shift42.io
+- evangelos@shift42.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/todoro/application.css
+- app/controllers/todoro/application_controller.rb
+- app/controllers/todoro/task_lists_controller.rb
+- app/controllers/todoro/tasks_controller.rb
+- app/helpers/todoro/application_helper.rb
+- app/helpers/todoro/task_lists_helper.rb
+- 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
+- app/models/todoro/task_list.rb
+- app/views/layouts/todoro/application.html.erb
+- app/views/todoro/task_lists/_form.html.erb
+- app/views/todoro/task_lists/edit.html.erb
+- app/views/todoro/task_lists/index.html.erb
+- app/views/todoro/task_lists/new.html.erb
+- app/views/todoro/task_lists/show.html.erb
+- app/views/todoro/tasks/_form.html.erb
+- 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
+- lib/tasks/todoro_tasks.rake
+- lib/todoro.rb
+- lib/todoro/engine.rb
+- lib/todoro/taskable.rb
+- lib/todoro/version.rb
+homepage: https://github.com/shift42/todoro
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shift42/todoro
+  documentation_uri: https://rubydoc.info/github/shift42/todoro
+  changelog_uri: https://github.com/shift42/todoro/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/shift42/todoro
+  bug_tracker_uri: https://github.com/shift42/todoro/issues
+  wiki_uri: https://github.com/shift42/todoro/wiki
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.1
+specification_version: 4
+summary: Todoro is a lightweight Rails engine that makes it easy to add task lists
+  and tasks to any model. It integrates seamlessly into any Rails app, offering a
+  simple and flexible way to organize and track tasks.
+test_files: []