working_class 0.1.1

data/lib/working_class/tasklist.rb

@@ -0,0 +1,57 @@
+module WorkingClass
+
+  # A represantation of a Tasklist
+  #
+  # @attr_reader name [String] the name of the Tasklist
+  # @attr_reader tasks [Array<WorkingClass::Task>] the tasks of the Tasklist
+  class Tasklist
+
+    attr_reader :name
+
+    attr_reader :tasks
+
+    # Initializes a new Tasklist with a name and optional Tasks
+    #
+    # @param name [String] the tasklist name
+    # @param tasks [Array<WorkingClass::Task>] an array with Tasks
+    # @return [WorkingClass::Tasklist] the actual Tasklist object
+    #
+    def initialize(name, tasks = [])
+      @name = name
+      @tasks = tasks
+    end
+
+    # Returns all the upcoming tasks
+    #
+    # @return [Array<WorkingClass::Task>] an Array with the upcoming tasks
+    #
+    def upcoming_tasks
+      @tasks.select { |task| task.is_upcoming }
+    end
+
+    # Returns all the tasks that are due tomorrow
+    #
+    # @return [Array<WorkingClass::Task>] an Array with the tasks due tomorrow
+    #
+    def tasks_due_tomorrow
+      @tasks.select { |task| task.is_tomorrow }
+    end
+
+    # Returns all the finished tasks
+    #
+    # @return [Array<WorkingClass::Task>] an Array the finished tasks
+    #
+    def finished_tasks
+      @tasks.select { |task| task.is_finished }
+    end
+
+    # Returns all the unfinished tasks
+    #
+    # @return [Array<WorkingClass::Task>] an Array with the unfinished tasks
+    #
+    def unfinished_tasks
+      @tasks.select { |task| !task.is_finished }
+    end
+
+  end
+end

data/lib/working_class/version.rb

@@ -0,0 +1,5 @@
+module WorkingClass
+  # The version of the gem.
+  # We use semantic versioning
+  VERSION = "0.1.1"
+end

data/test/examples/example_1.txt

@@ -0,0 +1,3 @@
+A cool todolist
+---
+[ ] My Task Number 1

data/test/examples/example_2.txt

@@ -0,0 +1,3 @@
+Groceries List
+---
+[X] My finished Task

data/test/examples/example_3.txt

@@ -0,0 +1,4 @@
+Development Todolist
+---
+[ ]{12.12.15} Release WorkingClass
+[x]{12.02.15} Yolo

data/test/examples/example_4.txt

@@ -0,0 +1,4 @@
+Shopping List
+---
+[ ]{12.01.2015} Buy some Jeans
+[ ]{5.7.16}() Buy more Jeans

data/test/examples/example_5.txt

@@ -0,0 +1,5 @@
+Another List Another Day
+---
+[X](15.2.15) Yolo
+[X]{16.2.15}(15.2.15 13:00) Yolo in the house
+

data/test/examples/example_6.txt

@@ -0,0 +1,5 @@
+Yeah more examples
+---
+[ ]{17.03.12}(-1) Twitter Downtime
+[ ]{12.5.15}(-2 5:00) Another Task
+[X]{12.3.15}(5:00) Remind me!!

data/test/parser_test.rb

@@ -0,0 +1,185 @@
+require File.expand_path('../test_helper.rb', __FILE__)
+
+class ParserTest < Minitest::Test
+
+  include WorkingClass
+
+  def load_example(example_name)
+    path = File.expand_path("../examples/#{example_name}.txt", __FILE__)
+    File.open(path, 'r').read()
+  end
+
+  def test_initialize
+    text = load_example('example_1')
+    parser = Parser.new(text)
+    assert_instance_of(Parser, parser)
+  end
+
+  def test_to_a_simple_task
+    text = load_example('example_1')
+    parser = Parser.new(text)
+    output = parser.to_h
+
+    assert_instance_of(Hash, output)
+    assert_instance_of(Array, output[:tasks])
+    assert_instance_of(Hash, output[:tasks].first)
+
+    assert_equal('A cool todolist', output[:name])
+    assert_equal(1, output[:tasks_count])
+    assert_equal('My Task Number 1', output[:tasks].first[:name])
+
+    assert(!output[:tasks].first[:is_finished])
+    assert_nil(output[:tasks].first[:date])
+    assert_nil(output[:tasks].first[:reminder])
+  end
+
+  def test_to_a_simple_finished_task
+    text = load_example('example_2')
+    parser = Parser.new(text)
+    output = parser.to_h
+
+    assert_instance_of(Hash, output)
+    assert_instance_of(Array, output[:tasks])
+    assert_instance_of(Hash, output[:tasks].first)
+
+    assert_equal('Groceries List', output[:name])
+    assert_equal(1, output[:tasks_count])
+
+    assert_equal('My finished Task', output[:tasks].first[:name])
+    assert(output[:tasks].first[:is_finished])
+    assert_nil(output[:tasks].first[:date])
+    assert_nil(output[:tasks].first[:reminder])
+  end
+
+  def test_to_a_task_with_date
+    text = load_example('example_3')
+    parser = Parser.new(text)
+    output = parser.to_h
+    task_1 = output[:tasks].first
+    task_2 = output[:tasks].last
+
+    assert_instance_of(Hash, output)
+    assert_instance_of(Array, output[:tasks])
+    assert_instance_of(Hash, task_1)
+    assert_instance_of(Hash, task_2)
+
+    assert_equal('Development Todolist', output[:name])
+    assert_equal(2, output[:tasks_count])
+
+    assert_equal('Release WorkingClass', task_1[:name])
+    assert(!task_1[:is_finished])
+    assert_equal(Date.new(2015, 12, 12), task_1[:date])
+    assert_nil(task_1[:reminder])
+
+    assert_equal('Yolo', task_2[:name])
+    assert(task_2[:is_finished])
+    assert_equal(Date.new(2015, 2, 12), task_2[:date])
+    assert_nil(task_2[:reminder])
+  end
+
+  def test_to_a_task_with_full_date
+    text = load_example('example_4')
+    parser = Parser.new(text)
+    output = parser.to_h
+    task_1 = output[:tasks].first
+    task_2 = output[:tasks].last
+
+    assert_instance_of(Hash, output)
+    assert_instance_of(Array, output[:tasks])
+    assert_instance_of(Hash, task_1)
+    assert_instance_of(Hash, task_2)
+
+    assert_equal('Shopping List', output[:name])
+    assert_equal(2, output[:tasks_count])
+
+    assert_equal('Buy some Jeans', task_1[:name])
+    assert(!task_1[:is_finished])
+    assert_equal(Date.new(2015, 1, 12), task_1[:date])
+    assert_nil(task_1[:reminder])
+
+    assert_equal('Buy more Jeans', task_2[:name])
+    assert(!task_2[:is_finished])
+    assert_equal(Date.new(2016, 7 ,5), task_2[:date])
+    assert_equal(DateTime.new(2016, 7, 5, 9, 0), task_2[:reminder])
+  end
+
+  def test_to_a_task_with_absolute_reminder
+    text = load_example('example_5')
+    parser = Parser.new(text)
+    output = parser.to_h
+    task_1 = output[:tasks].first
+    task_2 = output[:tasks].last
+
+    assert_instance_of(Hash, output)
+    assert_instance_of(Array, output[:tasks])
+    assert_instance_of(Hash, task_1)
+    assert_instance_of(Hash, task_2)
+
+    assert_equal('Another List Another Day', output[:name])
+    assert_equal(2, output[:tasks_count])
+
+    assert_equal('Yolo', task_1[:name])
+    assert(task_1[:is_finished])
+    assert_nil(task_1[:date])
+    assert_equal(DateTime.new(2015, 2, 15, 9, 0) ,task_1[:reminder])
+
+    assert_equal('Yolo in the house', task_2[:name])
+    assert(task_2[:is_finished])
+    assert_equal(Date.new(2015, 2, 16), task_2[:date])
+
+    assert_equal(DateTime.new(2015, 2, 15, 13, 0), task_2[:reminder])
+  end
+
+  def test_to_a_task_with_relative_reminder
+    text = load_example('example_6')
+    parser = Parser.new(text)
+    output = parser.to_h
+    task_1 = output[:tasks][0]
+    task_2 = output[:tasks][1]
+    task_3 = output[:tasks][2]
+
+    assert_instance_of(Hash, output)
+    assert_instance_of(Array, output[:tasks])
+    assert_instance_of(Hash, task_1)
+    assert_instance_of(Hash, task_2)
+
+    assert_equal('Yeah more examples', output[:name])
+    assert_equal(3, output[:tasks_count])
+
+    assert_equal('Twitter Downtime', task_1[:name])
+    assert(!task_1[:is_finished])
+    assert_equal(Date.new(2012, 3, 17), task_1[:date])
+    assert_equal(DateTime.new(2012, 3, 16, 9, 0) ,task_1[:reminder])
+
+    assert_equal('Another Task', task_2[:name])
+    assert(!task_2[:is_finished])
+    assert_equal(Date.new(2015, 5, 12), task_2[:date])
+    assert_equal(DateTime.new(2015, 5, 10, 5, 0) ,task_2[:reminder])
+
+    assert_equal('Remind me!!', task_3[:name])
+    assert(task_3[:is_finished])
+    assert_equal(Date.new(2015, 3, 12), task_3[:date])
+    assert_equal(DateTime.new(2015, 3, 12, 5, 0), task_3[:reminder])
+  end
+
+  def test_to_tasklist
+    text = load_example('example_5')
+    parser = Parser.new(text)
+    tasklist = parser.to_tasklist
+    task_1 = tasklist.tasks.first
+    task_2 = tasklist.tasks.last
+
+    assert_instance_of(Tasklist, tasklist)
+    assert_equal(2, tasklist.tasks.length)
+    assert_equal("Another List Another Day", tasklist.name)
+
+    assert_equal('Yolo', task_1.name)
+    assert(task_1.is_finished)
+    assert_nil(task_1.date)
+
+    assert_equal('Yolo in the house', task_2.name)
+    assert(task_2.is_finished)
+    assert_equal(Date.new(2015, 2, 16), task_2.date)
+
+  end
+end

data/test/task_test.rb

@@ -0,0 +1,108 @@
+require File.expand_path('../test_helper.rb', __FILE__)
+
+class TaskTest < Minitest::Test
+
+  include WorkingClass
+
+
+  def test_initialize
+    task = Task.new "Buy oranges"
+
+    assert_instance_of(Task, task)
+    assert_equal "Buy oranges", task.name
+    assert !task.is_finished?
+    assert_nil task.date
+    assert_nil task.reminder
+  end
+
+  def test_initialize_with_options
+    task = Task.new "Buy even more oranges", :is_finished => true, :reminder => DateTime.new, 
+                                             :date => Date.new
+
+    assert_equal "Buy even more oranges", task.name
+    assert task.is_finished?
+    assert_instance_of DateTime, task.reminder
+    assert_instance_of Date, task.date
+  end
+
+  def test_is_upcoming_today
+    task = Task.new "Futurama Marathon", :date => Date.today
+
+    assert(task.is_upcoming)
+  end
+
+  def test_is_upcoming_tomorrow
+    task = Task.new "Eat healthy", :date => Date.today + 1
+
+    assert(task.is_upcoming)
+  end
+
+  def test_is_upcoming_yesterday
+    task = Task.new "task lists are great", :date => Date.today - 1
+
+    assert(!task.is_upcoming)
+  end
+
+  def test_is_upcoming_already_finished
+    task = Task.new "Backup all the files", :is_finished => true, :date => Date.today
+
+    assert(!task.is_upcoming)
+  end
+
+  def test_is_upcoming_already_finished_tomorrow
+    task = Task.new "Eat chips", :is_finished => true, :date => Date.today + 1
+
+    assert(!task.is_upcoming)
+  end
+
+  def test_is_upcoming_without_date
+    task = Task.new "Backup all the files"
+
+    assert(task.is_upcoming)
+  end
+
+  def test_is_tomorrow
+    task = Task.new "Eat chips", :date => Date.today + 1
+
+    assert(task.is_tomorrow)
+  end
+
+  def test_is_tomorrow_was_actually_yesterday
+    task = Task.new "Eat chips", :date => Date.today - 1
+
+    assert(!task.is_tomorrow)
+  end
+
+  def test_is_tomorrow_is_actually_next_week
+    task = Task.new "Eat chips", :date => Date.today + 9
+
+    assert(!task.is_tomorrow)
+  end
+
+  def test_is_tomorrow_without_a_date
+    task = Task.new "Eat chips"
+
+    assert(task.is_tomorrow)
+  end
+
+  def test_is_tomorrow_already_finished
+    task = Task.new "Eat chips", :is_finished => true, :date => Date.today + 1
+
+    assert(!task.is_tomorrow)
+  end
+
+  def test_alias_methods
+
+    task = Task.new "my awesome task"
+
+    assert_respond_to(task, :is_finished?)
+    assert_respond_to(task, :finished?)
+
+    assert_respond_to(task, :is_tomorrow?)
+    assert_respond_to(task, :tomorrow?)
+
+    assert_respond_to(task, :is_upcoming?)
+    assert_respond_to(task, :upcoming?)
+  end
+
+end

data/test/tasklist_test.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../test_helper.rb', __FILE__)
+
+class TasklistTest < Minitest::Test
+
+  include WorkingClass
+
+  def test_initialize
+    tasklist = Tasklist.new('my list')
+
+    assert_instance_of(Array, tasklist.tasks)
+    assert_equal('my list', tasklist.name)
+    assert_equal(0, tasklist.tasks.length)
+  end
+
+  def test_upcoming_tasks
+    task_1 = Task.new("Task 1", :is_finished => true, :date => Date.today + 2)
+    task_2 = Task.new("Task 2", :date => Date.today)
+    task_3 = Task.new("Task 3", :is_finished => true, :date => Date.today - 1)
+    tasks = [task_1, task_2, task_3]
+
+    tasklist = Tasklist.new("example_task_list", tasks)
+    expected = [task_2]
+
+    assert_equal(expected, tasklist.upcoming_tasks)
+
+  end
+
+  def test_finished_tasks
+    task_1 = Task.new("Task 1", :is_finished => true)
+    task_2 = Task.new("Task 2")
+    task_3 = Task.new("Task 3", :is_finished => true)
+    tasks = [task_1, task_2, task_3]
+
+    tasklist = Tasklist.new("example_task_list", tasks)
+    expected = [task_1, task_3]
+
+    assert_equal(expected, tasklist.finished_tasks)
+  end
+
+  def test_tasks_due_tomorrow
+    task_1 = Task.new("Task 1", :is_finished => true, :date => Date.today + 1)
+    task_2 = Task.new("Task 2")
+    task_3 = Task.new("Task 3", :date => Date.today + 2)
+    task_4 = Task.new("Task 4", :date => Date.today + 1 )
+
+    tasks = [task_1, task_2, task_3, task_4]
+
+    tasklist = Tasklist.new("example_task_list", tasks)
+    expected = [task_2, task_4]
+
+    assert_equal(expected, tasklist.tasks_due_tomorrow)
+  end
+
+  def test_unfinished_tasks
+    task_1 = Task.new("Task 1", :is_finished => true)
+    task_2 = Task.new("Task 2")
+    task_3 = Task.new("Task 3")
+    task_4 = Task.new("Task 4", :is_finished => true)
+
+    tasks = [task_1, task_2, task_3, task_4]
+
+    tasklist = Tasklist.new("example_task_list", tasks)
+    expected = [task_2, task_3]
+
+    assert_equal(expected, tasklist.unfinished_tasks)
+  end
+
+
+end