markdo 0.1.12.alpha → 0.2.0

data/spec/lib/commands/query_command_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'markdo/commands/star_command'
+
+module Markdo
+  describe QueryCommand do
+    it 'outputs tasks that match the given string, case insensitive' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+
+      command_support = build_command_support({
+        'MARKDO_ROOT' => 'spec/fixtures/query_command'
+      })
+
+      QueryCommand.new(command_support).run('asdf')
+
+      expect(command_support.stdout.string).to eq(<<-EOF)
+- [ ] ASDF in inbox
+- [ ] asdf in inbox
+- [ ] ASDF
+- [ ] asdf
+      EOF
+    end
+  end
+end

data/spec/lib/commands/star_command_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'markdo/commands/star_command'
+
+module Markdo
+  describe StarCommand do
+    it 'outputs tasks with the @star tag' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+
+      command_support = build_command_support_for_date_commands
+
+      StarCommand.new(command_support).run
+
+      expect(command_support.stdout.string).to eq(<<-EOF)
+- [ ] @star Starred in inbox
+- [ ] @star Starred
+      EOF
+    end
+  end
+end

data/spec/lib/commands/summary_command_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'markdo/commands/summary_command'
+
+module Markdo
+  describe SummaryCommand do
+    it 'outputs summary counts' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+
+      command_support = build_command_support_for_date_commands
+
+      SummaryCommand.new(command_support).run
+
+      expect(command_support.stdout.string).to eq(<<-XML)
+Overdue: 2
+Starred: 2
+Today: 2
+Tomorrow: 2
+Soon: 2
+Inbox: 6
+      XML
+    end
+  end
+end

data/spec/lib/commands/tag_command_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'markdo/commands/tag_command'
+
+module Markdo
+  describe TagCommand do
+    it 'outputs tasks with the given tag' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+
+      command_support = build_command_support({
+        'MARKDO_ROOT' => 'spec/fixtures/tag_command'
+      })
+
+      TagCommand.new(command_support).run('foo')
+
+      expect(command_support.stdout.string).to eq(<<-EOF)
+- [ ] Tagged @foo in inbox
+- [ ] Tagged @foo
+      EOF
+    end
+  end
+end

data/spec/lib/commands/today_command_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'markdo/commands/today_command'
+
+module Markdo
+  describe TodayCommand do
+    it 'outputs tasks due today' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+
+      command_support = build_command_support_for_date_commands
+
+      TodayCommand.new(command_support).run
+
+      expect(command_support.stdout.string).to eq(<<-EOF)
+- [ ] @due(2016-02-28) Due today in inbox
+- [ ] @due(2016-02-28) Due today
+      EOF
+    end
+  end
+end

data/spec/lib/commands/tomorrow_command_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'markdo/commands/tomorrow_command'
+
+module Markdo
+  describe TomorrowCommand do
+    it 'outputs tasks due tomorrow' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+
+      command_support = build_command_support_for_date_commands
+
+      TomorrowCommand.new(command_support).run
+
+      expect(command_support.stdout.string).to eq(<<-EOF)
+- [ ] @due(2016-02-29) Due tomorrow in inbox
+- [ ] @due(2016-02-29) Due tomorrow
+      EOF
+    end
+  end
+end

data/spec/lib/commands/week_command_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'markdo/commands/week_command'
+
+module Markdo
+  describe WeekCommand do
+    it 'outputs tasks due over the next week, including today and tomorrow' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+
+      command_support = build_command_support_for_date_commands
+
+      WeekCommand.new(command_support).run
+
+      expect(command_support.stdout.string).to eq(<<-EOF)
+- [ ] @due(2016-02-28) Due today in inbox
+- [ ] @due(2016-02-28) Due today
+- [ ] @due(2016-02-29) Due tomorrow in inbox
+- [ ] @due(2016-02-29) Due tomorrow
+- [ ] @due(2016-03-06) Due soon in inbox
+- [ ] @due(2016-03-06) Due soon
+      EOF
+    end
+  end
+end

data/spec/lib/ics_exporter_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'markdo/models/task_collection'
+require 'markdo/ics_exporter'
+
+module Markdo
+  describe IcsExporter do
+    it 'produces the body of an iCalendar (.ics) file for incomplete tasks with a valid due date' do
+      task_collection = TaskCollection.new([
+        '- [ ] Task with no tags',
+        '- [ ] @due(2016-04-01) Task with tag-style due date',
+        '- [ ] @due(2016-06-31) Task with invalid date',
+        '- [x] @due(2016-04-01) Completed task with tag-style due date',
+      ])
+      ics_exporter = IcsExporter.new(task_collection)
+
+      begin
+        Date.parse('2016-06-31')
+      rescue
+        # MRI raises an error, Opal pushes the date to the next valid one.
+        invalid_dates_raise_error = true
+      end
+
+      if invalid_dates_raise_error
+        expect(ics_exporter.to_ics).to eq(<<-ICS)
+BEGIN:VCALENDAR
+VERSION:2.0
+CALSCALE:GREGORIAN
+METHOD:PUBLISH
+X-WR-CALNAME:Markdo Due Dates
+BEGIN:VEVENT
+DTSTART;VALUE=DATE:20160401
+DTEND;VALUE=DATE:20160401
+SUMMARY:Task with tag-style due date
+END:VEVENT
+END:VCALENDAR
+ICS
+      else
+        expect(ics_exporter.to_ics).to eq(<<-ICS)
+BEGIN:VCALENDAR
+VERSION:2.0
+CALSCALE:GREGORIAN
+METHOD:PUBLISH
+X-WR-CALNAME:Markdo Due Dates
+BEGIN:VEVENT
+DTSTART;VALUE=DATE:20160401
+DTEND;VALUE=DATE:20160401
+SUMMARY:Task with tag-style due date
+END:VEVENT
+BEGIN:VEVENT
+DTSTART;VALUE=DATE:20160701
+DTEND;VALUE=DATE:20160701
+SUMMARY:Task with invalid date
+END:VEVENT
+END:VCALENDAR
+ICS
+      end
+    end
+  end
+end

data/spec/lib/models/task_attribute_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'markdo/models/task_attribute'
+
+module Markdo
+  describe TaskAttribute do
+    describe 'given no value' do
+      describe '#value' do
+        it 'is nil' do
+          expect(TaskAttribute.new('foo', nil).value).to be_nil
+        end
+      end
+
+      describe '#date_value' do
+        it 'is nil' do
+          expect(TaskAttribute.new('foo', nil).date_value).to be_nil
+        end
+      end
+
+      describe '#==' do
+        it 'is true when key and value are the same' do
+          assert_equality(TaskAttribute.new('foo', nil),
+                          TaskAttribute.new('foo', nil))
+        end
+
+        it 'is false when key is different' do
+          assert_inequality(TaskAttribute.new('foo', nil),
+                            TaskAttribute.new('bar', nil))
+        end
+      end
+    end
+
+    describe 'given a word value' do
+      describe '#value' do
+        it 'is that word' do
+          expect(TaskAttribute.new('foo', 'bar').value).to eq('bar')
+        end
+      end
+
+      describe '#date_value' do
+        it 'is nil' do
+          expect(TaskAttribute.new('foo', 'bar').date_value).to be_nil
+        end
+      end
+
+      describe '#==' do
+        it 'is true when key and value are the same' do
+          assert_equality(TaskAttribute.new('foo', 'bar'),
+                          TaskAttribute.new('foo', 'bar'))
+        end
+
+        it 'is false when key is different' do
+          assert_inequality(TaskAttribute.new('foo', 'bar'),
+                            TaskAttribute.new('bar', 'bar'))
+        end
+      end
+    end
+
+    describe 'given an ISO-8601-formatted date value' do
+      describe '#value' do
+        it 'is the string' do
+          expect(TaskAttribute.new('due', '2016-01-01').value).to eq('2016-01-01')
+        end
+      end
+
+      describe '#date_value' do
+        it 'is the date' do
+          expect(TaskAttribute.new('due', '2016-01-01').date_value).
+            to eq(Date.new(2016, 1, 1))
+        end
+      end
+
+      describe '#==' do
+        it 'is true when key and value are the same' do
+          assert_equality(TaskAttribute.new('foo', '2016-01-01'),
+                          TaskAttribute.new('foo', '2016-01-01'))
+        end
+
+        it 'is false when key is different' do
+          assert_inequality(TaskAttribute.new('foo', '2016-01-01'),
+                            TaskAttribute.new('bar', '2016-01-01'))
+        end
+      end
+    end
+  end
+end

data/spec/lib/models/task_collection_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+require 'markdo/models/task_collection'
+
+module Markdo
+  describe TaskCollection do
+    describe '#all' do
+      it 'returns all tasks' do
+        task_collection = TaskCollection.new([
+          '- [ ] Example 1',
+          '- [ ] Example 2',
+        ])
+
+        expect(task_collection.all).to eq([
+          Task.new('- [ ] Example 1'),
+          Task.new('- [ ] Example 2'),
+        ])
+      end
+    end
+
+    describe '#with_match' do
+      it 'returns tasks matching a regular expression' do
+        task_collection = TaskCollection.new([
+          '- [ ] Foo',
+          '- [ ] Bar',
+        ])
+
+        expect(task_collection.with_match(/foo/i)).to eq([
+          Task.new('- [ ] Foo'),
+        ])
+      end
+
+      it 'returns tasks matching a string' do
+        task_collection = TaskCollection.new([
+          '- [ ] Foo',
+          '- [ ] Bar',
+        ])
+
+        expect(task_collection.with_match(/Bar/)).to eq([
+          Task.new('- [ ] Bar'),
+        ])
+      end
+    end
+
+    describe '#with_tag' do
+      it 'returns tasks with the given tag' do
+        expect(build_task_collection.with_tag('tag')).to eq([
+          Task.new('- [ ] Example @tag'),
+        ])
+      end
+    end
+
+    describe '#starred' do
+      it 'returns tasks with the @star tag' do
+        expect(build_task_collection.starred).to eq([
+          Task.new('- [ ] Example @star'),
+        ])
+      end
+    end
+
+    describe '#with_attribute' do
+      it 'returns tasks with the given tag, with or without a value' do
+        expect(build_task_collection.with_attribute('priority')).to eq([
+          Task.new('- [ ] Example @priority'),
+          Task.new('- [ ] Example @priority(1)'),
+          Task.new('- [ ] Example @priority(2)'),
+        ])
+      end
+    end
+
+    describe '#due_on' do
+      it 'returns tasks due on the given date' do
+        expect(build_task_collection.due_on(Date.new(2016, 3, 3))).to eq([
+          Task.new('- [ ] Example @due(2016-03-03)'),
+        ])
+      end
+    end
+
+    describe '#due_between' do
+      it 'returns tasks due between the given begin date and end date' do
+        begin_date = Date.new(2016, 3, 3)
+        end_date = Date.new(2016, 3, 5)
+        tasks = build_task_collection.due_between(begin_date, end_date)
+
+        expect(tasks).to eq([
+          Task.new('- [ ] Example @due(2016-03-03)'),
+          Task.new('- [ ] Example @due(2016-03-04)'),
+          Task.new('- [ ] Example @due(2016-03-05)'),
+        ])
+      end
+    end
+
+    describe '#overdue' do
+      it 'returns tasks due before today' do
+        expect(build_task_collection.overdue).to eq([
+          Task.new('- [ ] Example @due(2016-02-27)'),
+        ])
+      end
+    end
+
+    describe '#due_today' do
+      it 'returns tasks due today' do
+        expect(build_task_collection.due_today).to eq([
+          Task.new('- [ ] Example @due(2016-02-28)'),
+        ])
+      end
+    end
+
+    describe '#due_tomorrow' do
+      it 'returns tasks due the day after today' do
+        expect(build_task_collection.due_tomorrow).to eq([
+          Task.new('- [ ] Example @due(2016-02-29)'),
+        ])
+      end
+    end
+
+    describe '#due_soon' do
+      it 'returns tasks due within a week of the day after today' do
+        expect(build_task_collection.due_soon).to eq([
+          Task.new('- [ ] Example @due(2016-03-01)'),
+          Task.new('- [ ] Example @due(2016-03-02)'),
+          Task.new('- [ ] Example @due(2016-03-03)'),
+          Task.new('- [ ] Example @due(2016-03-04)'),
+          Task.new('- [ ] Example @due(2016-03-05)'),
+          Task.new('- [ ] Example @due(2016-03-06)'),
+        ])
+      end
+    end
+
+    describe '#deferred_until_today' do
+      it 'returns tasks deferred up until and including today' do
+        expect(build_task_collection.deferred_until_today).to eq([
+          Task.new('- [ ] Example @defer(1996-01-01)'),
+          Task.new('- [ ] Example @defer(2016-02-27)'),
+          Task.new('- [ ] Example @defer(2016-02-28)'),
+        ])
+      end
+    end
+
+    def build_task_collection
+      today = Date.new(2016, 2, 28)
+
+      lines = [
+        '- [ ] No tags',
+        '- [ ] Example @tag',
+        '- [ ] Example @star',
+        '- [ ] Example @priority',
+        '- [ ] Example @priority(1)',
+        '- [ ] Example @priority(2)',
+        '- [ ] Example @due(2016-02-27)',
+        '- [ ] Example @due(2016-02-28)',
+        '- [ ] Example @due(2016-02-29)',
+        '- [ ] Example @due(2016-03-01)',
+        '- [ ] Example @due(2016-03-02)',
+        '- [ ] Example @due(2016-03-03)',
+        '- [ ] Example @due(2016-03-04)',
+        '- [ ] Example @due(2016-03-05)',
+        '- [ ] Example @due(2016-03-06)',
+        '- [ ] Example @due(2016-03-07)',
+        '- [ ] Example @defer(1996-01-01)',
+        '- [ ] Example @defer(2016-02-27)',
+        '- [ ] Example @defer(2016-02-28)',
+        '- [ ] Example @defer(2016-02-29)',
+      ]
+
+      TaskCollection.new(lines, today)
+    end
+  end
+end