todolist_app 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7f3a095080e16013a4021af29758e915152f5038d25bc0927cf4ab6f6ffb1f7
+  data.tar.gz: 0bf89ef2a32b7393338f3132b9191fd813f4e22195161a91635a6737a8b07113
+SHA512:
+  metadata.gz: 013a180e9fc59a2e3fbf0c266740ca42d68a02911081f7aa33f41e6e7d0ca0f8bb11cc81dfdd930cfc54128508a30f89880ded435c1d6daf506641dc2ed05398
+  data.tar.gz: 89b5c94545d30d5daf08afdac310f0ef68178bc307bca0ffbcbda1f1eb71fe98538285bc81252c5c9389a944ee98b57e4cd9445d083fbb8bc5f1691fa3ce7193

data/lib/todolist.rb

@@ -0,0 +1,163 @@
+# This class represents a todo item and its associated
+# data: name and description. There's also a "done"
+# flag to show whether this todo item is done.
+require 'bundler/setup'
+require 'stamp'
+
+class Todo
+  DONE_MARKER = 'X'
+  UNDONE_MARKER = ' '
+
+  attr_accessor :title, :description, :done, :due_date
+
+  def initialize(title, due_date=nil, description='')
+    @title = title
+    @description = description
+    @done = false
+    @due_date = due_date
+  end
+
+  def done!
+    self.done = true
+  end
+
+  def done?
+    done
+  end
+
+  def undone!
+    self.done = false
+  end
+
+  def to_s
+    result = "[#{done? ? DONE_MARKER : UNDONE_MARKER}] #{title}"
+    result += due_date.stamp(' (Due: Friday January 6)') if due_date
+    result
+  end
+
+  def ==(otherTodo)
+    title == otherTodo.title &&
+      description == otherTodo.description &&
+      done == otherTodo.done
+  end
+end
+
+# This class represents a collection of Todo objects.
+# You can perform typical collection-oriented actions
+# on a TodoList object, including iteration and selection.
+
+class TodoList
+  attr_accessor :title
+
+  def initialize(title)
+    @title = title
+    @todos = []
+  end
+
+  def size
+    @todos.size
+  end
+
+  def first
+    @todos.first
+  end
+
+  def last
+    @todos.last
+  end
+
+  def shift
+    @todos.shift
+  end
+
+  def pop
+    @todos.pop
+  end
+
+  def done?
+    @todos.all? { |todo| todo.done? }
+  end
+
+  def <<(todo)
+    raise TypeError, 'can only add Todo objects' unless todo.instance_of? Todo
+
+    @todos << todo
+  end
+  alias_method :add, :<<
+
+  def item_at(idx)
+    @todos.fetch(idx)
+  end
+
+  def mark_done_at(idx)
+    item_at(idx).done!
+  end
+
+  def mark_undone_at(idx)
+    item_at(idx).undone!
+  end
+
+  def done!
+    @todos.each_index do |idx|
+      mark_done_at(idx)
+    end
+  end
+
+  def remove_at(idx)
+    @todos.delete(item_at(idx))
+  end
+
+  def to_s
+    text = "---- #{title} ----\n"
+    text << @todos.map(&:to_s).join("\n")
+    text
+  end
+
+  def to_a
+    @todos.clone
+  end
+
+  def each
+    @todos.each do |todo|
+      yield(todo)
+    end
+    self
+  end
+
+  def select
+    list = TodoList.new(title)
+    each do |todo|
+      list.add(todo) if yield(todo)
+    end
+    list
+  end
+
+  # returns first Todo by title, or nil if no match
+  def find_by_title(title)
+    select { |todo| todo.title == title }.first
+  end
+
+  def all_done?
+    select { |todo| todo.done? }
+  end
+
+  def all_not_done?
+    select { |todo| !todo.done? }
+  end
+
+  def mark_done(title)
+    find_by_title(title) && find_by_title(title).done!
+  end
+
+  def mark_all_done
+    each { |todo| todo.done! }
+  end
+
+  def mark_all_undone
+    each { |todo| todo.undone! }
+  end
+
+  def clear
+    @todos = []
+  end
+end

data/test/todolist_test.rb

@@ -0,0 +1,195 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'date'
+require_relative '../lib/todolist'
+
+Minitest::Reporters.use!
+
+class TodoListTest < Minitest::Test
+
+  def setup
+    @todo1 = Todo.new("Buy milk")
+    @todo2 = Todo.new("Clean room")
+    @todo3 = Todo.new("Go to gym")
+    @todos = [@todo1, @todo2, @todo3]
+
+    @list = TodoList.new("Today's Todos")
+    @list.add(@todo1)
+    @list.add(@todo2)
+    @list.add(@todo3)
+  end
+
+  def test_to_a
+    assert_equal(@todos, @list.to_a)
+  end
+
+  def test_size
+    assert_equal(@list.size, @todos.size)
+  end
+
+  def test_first
+    assert_equal(@list.first, @todos.first)
+  end
+
+  def test_last
+    assert_equal(@list.last, @todos.last)
+  end
+
+  def test_shift
+    assert_equal(@list.shift, @todos.first)
+    assert_equal(@list.size, @todos.size - 1)
+  end
+
+  def test_pop
+    assert_equal(@list.pop, @todos.last)
+    assert_equal(@list.size, @todos.size - 1)
+  end
+
+  def test_done_question
+    assert_equal(false, @list.done?)
+    @list.done!
+    assert_equal(true, @list.done?)
+  end
+
+  def test_add_raise_error
+    assert_raises(TypeError) { @list.add(1) }
+    assert_raises(TypeError) { @list.add("Hello") }
+  end
+
+  def test_shovel_operator
+    assert_equal(@list.size, @todos.size)
+    @list << Todo.new('Do dishes')
+    assert_equal(@list.size, @todos.size + 1)
+  end
+
+  def test_add_alias
+    assert_equal(@list.size, @todos.size)
+    @list.add Todo.new('Do dishes')
+    assert_equal(@list.size, @todos.size + 1)
+  end
+
+  def test_item_at
+    assert_equal(@list.item_at(0), @todos.first)
+    assert_equal(@list.item_at(2), @todos.last)
+    assert_raises(IndexError) { @list.item_at(3) }
+  end
+
+  def test_mark_done_at
+    assert_raises(IndexError) { @list.mark_done_at(3) }
+    assert_raises(IndexError) { @list.mark_done_at(100) }
+
+    @list.mark_done_at(0)
+    assert(@todos.first.done?)
+    @list.mark_done_at(1)
+    assert(@todos[1].done?)
+  end
+
+  def test_mark_undone_at
+    @list.done!
+    assert_equal(@todos.first.done?, true)
+
+    @list.mark_undone_at(0)
+    assert_equal(@todos.first.done?, false)
+  end
+
+  def test_done_bang
+    assert_equal(@todos[0].done?, false)
+    assert_equal(@todos[1].done?, false)
+    assert_equal(@todos[2].done?, false)
+    @list.done!
+    assert(@todos[0].done?)
+    assert(@todos[1].done?)
+    assert(@todos[2].done?)
+    assert(@list.done?)
+  end
+
+  def test_remove_at
+    assert_raises(IndexError) { @list.remove_at(100) }
+
+    assert_equal(3, @list.size)
+    @list.remove_at(1)
+    assert_equal([@todos[0], @todos[2]], @list.to_a)
+  end
+
+  def test_to_s
+    @todo2.due_date = Date.civil(2021, 11, 6)
+    output = <<~OUTPUT.chomp
+    ---- Today's Todos ----
+    [ ] Buy milk
+    [ ] Clean room (Due: Saturday November 6)
+    [ ] Go to gym
+    OUTPUT
+    assert_equal(output, @list.to_s)
+  end
+
+  def test_to_s_again
+    @list.mark_done_at(0)
+    output = <<~OUTPUT.chomp
+    ---- Today's Todos ----
+    [X] Buy milk
+    [ ] Clean room
+    [ ] Go to gym
+    OUTPUT
+
+    assert_equal(output, @list.to_s)
+  end
+
+  def test_to_s_all_marked
+    @list.done!
+    output = <<~OUTPUT.chomp
+    ---- Today's Todos ----
+    [X] Buy milk
+    [X] Clean room
+    [X] Go to gym
+    OUTPUT
+    assert_equal(output, @list.to_s)
+  end
+
+  def test_each
+    result = []
+    @list.each { |todo| result << todo }
+    assert_equal([@todo1, @todo2, @todo3], result)
+  end
+
+  def test_each_returns_self
+    list = @list.each { |todo| }
+    assert_equal(list, @list)
+  end
+
+  def test_select
+    @todo1.done!
+    list = TodoList.new(@list.title)
+    list.add(@todo1)
+
+    assert_equal(list.title, @list.title)
+    assert_equal(list.to_s, @list.select{ |todo| todo.done? }.to_s)
+  end
+
+  def test_all_not_done
+    @list.mark_all_done
+    assert(@list.done?)
+    @list.mark_all_undone
+    assert(@list.all_not_done?)
+  end
+
+  def test_mark_done_by_title
+    @list.mark_done(@todo1.title)
+    assert(@list.first.done?)
+  end
+
+  def test_mark_all_done
+    @list.mark_all_done
+    assert(@list.all_done?)
+  end
+
+  def test_no_due_date
+    assert_nil(@todo1.due_date)
+  end
+
+  def test_due_date
+    due_date = Date.today + 3
+    @todo1.due_date = due_date
+    assert_equal(due_date, @todo1.due_date)
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: todolist_app
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Augustine
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-04 00:00:00.000000000 Z
+dependencies: []
+description: This is a simple todo list manager!
+email: mtcameron5@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/todolist.rb
+- test/todolist_test.rb
+homepage: https://github.com/mtcameron5/todolist_app_ruby
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.30
+signing_key:
+specification_version: 4
+summary: Todo List Manager!
+test_files: []