todo-fede 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58ded6bb5a70de8630f77cfa4e978fbdc2439de65024019dfc6f7a6de82c6744
+  data.tar.gz: cdf5570db57cea5f4adde6ba8496c0d4cbb69016e1381c7030caf0738d8c514e
+SHA512:
+  metadata.gz: 3bb3dd42868f82c75beb57206adfb5eadd1849b07f2eb99c97d555e20c3c6ed4b43889a523300ed8ccad347185ef31f3dba7be1a19cf2c7a579a96ed8f0b25dd
+  data.tar.gz: ce42f10559aa1f28e41cef9a7d00e4190ca9aca8469be37481ede30e242dc8353c600e545bd6a30046d1a78706e9a054e36019fdcf5099806711b31ae89959cc

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+Dir['./lib/**/*.rb'].each { |f| require(f) }
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/todo

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Dir['./lib/**/*.rb'].each { |f| require(f) }
+
+TodoList.load
+Main.start(ARGV)
+TodoList.dump

data/lib/errors/todo_not_found_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Error to be raised when there is no registry of a todo with certain ID.
+class TodoNotFoundError < StandardError
+  def message
+    'Sorry, there is no Todo item with such ID'
+  end
+end

data/lib/helpers/main_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# This module provides helper methods to display
+# informative messages to the user
+module MainHelper
+  def display_description_needed_message
+    puts 'You must provide a description for the task'
+  end
+
+  def display_something_went_wrong_message(msg)
+    puts "Sorry, something went wrong: #{msg}"
+  end
+
+  def display_created_task_message(idx)
+    puts "Created task #{idx}"
+  end
+
+  def confirm_deletion_message(idx, todo)
+    "Permanently delete task #{idx + 1} #{todo.description}?  (yes/no)"
+  end
+
+  def print_successfull_deletion_message
+    puts 'To-Do successfully deleted'
+  end
+end

data/lib/helpers/todo_helper.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# This module provides helper methods to display the
+# information of the TodoList instance to the user.
+module TodoHelper
+  def display_all_todos(undone:, done:)
+    if undone.any? || done.any?
+      _display_todos(undone)
+      _display_done_todos(done)
+      _display_todos_count_message(undone)
+    else
+      _display_no_matches
+    end
+  end
+
+  def display_undone_todos(todos_list)
+    if todos_list.any?
+      _display_todos(todos_list)
+      _display_todos_count_message(todos_list)
+    else
+      _display_no_matches
+    end
+  end
+
+  def _display_done_todos(todos_list)
+    todos_list.each do |todo|
+      puts "*  ~~#{todo.description}~~"
+    end
+  end
+
+  def _display_todos(todos_list)
+    puts 'ID Description'
+    puts '-- -----------'
+    todos_list.each_with_index do |todo, idx|
+      puts "#{_two_characters_format(idx + 1)} #{todo.description}"
+    end
+  end
+
+  def _display_todos_count_message(todos_list)
+    todos_count = todos_list.length
+    if todos_count > 1
+      puts "\n#{todos_count} tasks."
+    else
+      puts "\n#{todos_count} task."
+    end
+  end
+
+  def _two_characters_format(number)
+    return number.to_s if number > 9
+
+    "#{number} "
+  end
+
+  def _display_no_matches
+    puts 'No matches'
+  end
+end

data/lib/main.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative 'helpers/todo_helper'
+require_relative 'helpers/main_helper'
+
+# It's responsible for the application initialization and
+# for the client communication interface.
+class Main < Thor
+  include TodoHelper
+  include MainHelper
+
+  desc 'add TASK DESCRIPTION', 'Add tasks to a todo list'
+  def add(*description)
+    return unless validate_description_presence(description)
+
+    todo_idx = with_rescue do
+      todos_controller.add(description: description.join(' '))
+    end
+    display_created_task_message(todo_idx)
+  end
+
+  desc 'done IDX', 'Mark the todo with the provided <<IDX>> as done'
+  def done(idx)
+    with_rescue do
+      todos_controller.done(idx.to_i - 1)
+    end
+  end
+
+  desc 'delete IDX', 'Delete the task with the given IDX'
+  def delete(idx)
+    with_rescue do
+      index = idx.to_i - 1
+      todo = todos_controller.find(index)
+      if require_deletion_confirmation(index, todo)
+        todos_controller.delete(index)
+        print_successfull_deletion_message
+      end
+    end
+  end
+
+  desc 'list', 'Display a list of the tasks'
+  option :all
+  def list
+    todos = with_rescue do
+      todos_controller.list
+    end
+
+    if options['all']
+      display_all_todos(undone: todos[:undone_items], done: todos[:done_items])
+    else
+      display_undone_todos(todos[:undone_items])
+    end
+  end
+
+  class << self
+    def exit_on_failure?
+      true
+    end
+  end
+
+  private
+
+  def validate_description_presence(description)
+    return true if description.count.positive?
+
+    display_description_needed_message
+    false
+  end
+
+  def todos_controller
+    TodosController.new
+  end
+
+  def require_deletion_confirmation(idx, todo)
+    confirm = nil
+    until %w[y n].include?(confirm)
+      confirm = ask(confirm_deletion_message(idx, todo))
+    end
+
+    confirm == 'y'
+  end
+
+  def with_rescue
+    yield
+  rescue TodoNotFoundError => e
+    puts e.message.to_s
+  rescue StandardError => e
+    display_something_went_wrong_message(e.message)
+  end
+end

data/lib/singleton_storer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Mixin module, adds the ability to persist a Singleton class in a
+# local file and also de ability to load the Singleton class from that file.
+# In order to work properply the class that include this modules must also
+# include the ruby module Singleton
+module SingletonStorer
+  # This module allows to embed class methods as part of the mixin.
+  module ClassMethods
+    def dump
+      instance._dump
+    end
+
+    def load
+      instance._load
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def _load
+    return unless File.exist?(persistence_file_name)
+
+    attributes = Marshal.load(File.read(persistence_file_name))
+    attributes.each do |attr, value|
+      instance_variable_set("@#{attr}".to_sym, value)
+    end
+  end
+
+  def _dump
+    File.write(persistence_file_name, Marshal.dump(attrs_to_hash))
+  end
+
+  def persistence_file_name
+    "#{self.class.name.downcase}.mp"
+  end
+
+  def attrs_to_hash
+    attrs = {}
+    self.class::PERSISTED_ATTRIBUTES.each do |attr|
+      attrs[attr] = send(attr)
+    end
+
+    attrs
+  end
+end

data/lib/todo.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Representation of the main entity of the program, a to do item.
+class Todo
+  attr_accessor(:description)
+
+  def initialize(description:)
+    @description = description
+  end
+
+  def update(**attrs)
+    attrs.each do |attr, value|
+      instance_variable_set("@#{attr}".to_sym, value)
+    end
+  end
+end

data/lib/todo_list.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'singleton_storer'
+
+# Singleton class resposible for managing the CRUD operations related
+# to a Todo instance.
+class TodoList
+  PERSISTED_ATTRIBUTES = %i[undone_todos done_todos].freeze
+
+  include Singleton
+  include SingletonStorer
+
+  def initialize
+    set_defaults
+  end
+
+  def add(todo)
+    @undone_todos << todo
+  end
+
+  def move_to_done(idx)
+    raise TodoNotFoundError unless in_range?(idx)
+
+    @done_todos << remove_from_undone(idx)
+  end
+
+  def done
+    @done_todos
+  end
+
+  def undone
+    @undone_todos
+  end
+
+  def undone_count
+    @undone_todos.length
+  end
+
+  def find(idx)
+    raise TodoNotFoundError unless in_range?(idx)
+
+    @undone_todos[idx]
+  end
+
+  def delete(idx)
+    remove_from_undone idx
+  end
+
+  private
+
+  attr_accessor(*PERSISTED_ATTRIBUTES)
+
+  def set_defaults
+    @undone_todos = []
+    @done_todos = []
+  end
+
+  def remove_from_undone(idx)
+    raise TodoNotFoundError unless in_range?(idx)
+
+    @undone_todos.delete_at(idx)
+  end
+
+  def in_range?(idx)
+    (0..(@undone_todos.length - 1)).include?(idx)
+  end
+end

data/lib/todos_controller.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Plays the role of intermediary between the Main class and the Todo class
+class TodosController
+  def add(description:)
+    todo = Todo.new(description: description)
+    todo_list.add(todo)
+    todo_list.undone_count
+  end
+
+  def list
+    {
+      done_items: todo_list.done,
+      undone_items: todo_list.undone
+    }
+  end
+
+  def done(idx)
+    todo_list.move_to_done(idx)
+  end
+
+  def delete(idx)
+    todo_list.delete(idx)
+  end
+
+  def find(idx)
+    todo_list.find(idx)
+  end
+
+  private
+
+  def todo_list
+    TodoList.instance
+  end
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Version
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: todo-fede
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Federico Moya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: 
+email:
+- federicomoyamartin@gmail.com
+executables:
+- console
+- setup
+- todo
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- bin/setup
+- bin/todo
+- lib/errors/todo_not_found_error.rb
+- lib/helpers/main_helper.rb
+- lib/helpers/todo_helper.rb
+- lib/main.rb
+- lib/singleton_storer.rb
+- lib/todo.rb
+- lib/todo_list.rb
+- lib/todos_controller.rb
+- lib/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Cool todo app
+test_files: []