markdo 0.1.12.alpha → 0.2.0

data/lib/markdo/version.rb

@@ -1,3 +1,3 @@
 module Markdo
-  VERSION = "0.1.12.alpha"
+  VERSION = '0.2.0'
 end

data/markdo.gemspec

@@ -21,4 +21,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rake"
+  spec.add_development_dependency "opal"
+  spec.add_development_dependency "opal-rspec"
 end

data/script/build

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -xe
+rm -rf pkg
+mkdir -p pkg
+rake build
+gem install --no-ri --no-rdoc pkg/*.gem
+markdo version
+markdo help

data/spec/fixtures/date_commands/Inbox.md

@@ -0,0 +1,6 @@
+- [ ] @due(2016-01-01) Overdue in inbox
+- [ ] @star Starred in inbox
+- [ ] @due(2016-02-28) Due today in inbox
+- [ ] @due(2016-02-29) Due tomorrow in inbox
+- [ ] @due(2016-03-06) Due soon in inbox
+- [ ] @due(2016-03-07) Not due soon in inbox

data/spec/fixtures/date_commands/Sprint.md

@@ -0,0 +1,6 @@
+- [ ] @due(2016-01-01) Overdue
+- [ ] @star Starred
+- [ ] @due(2016-02-28) Due today
+- [ ] @due(2016-02-29) Due tomorrow
+- [ ] @due(2016-03-06) Due soon
+- [ ] @due(2016-03-07) Not due soon

data/spec/fixtures/inbox_command/Inbox.md

@@ -0,0 +1,2 @@
+- [ ] Example 1 in inbox
+- [ ] Example 2 in inbox

data/spec/fixtures/inbox_command/Sprint.md

@@ -0,0 +1,2 @@
+- [ ] Example 3
+- [ ] Example 4

data/spec/fixtures/query_command/Inbox.md

@@ -0,0 +1,4 @@
+- [ ] ASDF in inbox
+- [ ] asdf in inbox
+- [ ] Foo in inbox
+- [ ] Bar in inbox

data/spec/fixtures/query_command/Sprint.md

@@ -0,0 +1,4 @@
+- [ ] ASDF
+- [ ] asdf
+- [ ] Foo
+- [ ] Bar

data/spec/fixtures/tag_command/Inbox.md

@@ -0,0 +1,2 @@
+- [ ] Tagged @foo in inbox
+- [ ] Tagged @bar in inbox

data/spec/fixtures/tag_command/Sprint.md

@@ -0,0 +1,2 @@
+- [ ] Tagged @foo
+- [ ] Tagged @bar

data/spec/lib/cli_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'markdo/cli'
+
+module Markdo
+  describe CLI do
+    describe 'given "version"' do
+      it 'prints the version' do
+        command_support = build_command_support
+
+        CLI.new(command_support).run('version')
+
+        assert_version_printed command_support.stdout
+      end
+    end
+
+    describe 'given "--version"' do
+      it 'prints the version' do
+        command_support = build_command_support
+
+        CLI.new(command_support).run('--version')
+
+        assert_version_printed command_support.stdout
+      end
+    end
+
+    describe 'given "--help"' do
+      it 'prints help text' do
+        command_support = build_command_support
+        expect(Kernel).to receive(:exit).with(1)
+
+        CLI.new(command_support).run('--help')
+
+        assert_help_printed command_support.stderr
+      end
+    end
+
+    describe 'given "starred"' do
+      it 'delegates to StarCommand' do
+        command_support = build_command_support
+        expect(StarCommand).to receive(:new).and_return(FakeCommand.new)
+
+        CLI.new(command_support).run('starred')
+      end
+    end
+
+    describe 'given "q"' do
+      it 'delegates to StarCommand' do
+        command_support = build_command_support
+        expect(QueryCommand).to receive(:new).and_return(FakeCommand.new)
+
+        CLI.new(command_support).run('q')
+      end
+    end
+
+    describe 'given an unknown command' do
+      it 'defaults to help text' do
+        command_support = build_command_support
+        expect(Kernel).to receive(:exit).with(1)
+
+        CLI.new(command_support).run('asdf')
+
+        assert_help_printed command_support.stderr
+      end
+    end
+
+    def assert_version_printed(io)
+      expect(io.string).to match(/v[0-9.]+[a-z0-9]+\n/)
+    end
+
+    def assert_help_printed(io)
+      expect(io.string).to match(/^Markdown-based task manager\./)
+    end
+
+    class FakeCommand
+      def run
+      end
+    end
+  end
+end

data/spec/lib/commands/add_command_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'markdo/commands/add_command'
+
+module Markdo
+  describe AddCommand do
+    before do
+      skip 'Could not access fixtures' unless File.exists?('spec/fixtures/')
+    end
+
+    it 'appends to the inbox' do
+      clear_inbox
+      markdo_add 'Example task'
+      expect(read_inbox).to eq([
+        '- [ ] Example task',
+      ])
+      markdo_add 'Another example task'
+      expect(read_inbox).to eq([
+        '- [ ] Example task',
+        '- [ ] Another example task',
+      ])
+    end
+
+    describe 'given a nil' do
+      it 'appends to the inbox' do
+        clear_inbox
+        markdo_add nil
+        assert_inbox_empty
+      end
+    end
+
+    describe 'given an empty string' do
+      it 'appends to the inbox' do
+        clear_inbox
+        markdo_add ''
+        assert_inbox_empty
+      end
+    end
+
+    describe 'given a blank string' do
+      it 'appends to the inbox' do
+        clear_inbox
+        markdo_add ' '
+        assert_inbox_empty
+      end
+    end
+
+    def clear_inbox
+      File.write('spec/fixtures/add_command/Inbox.md', '')
+    end
+
+    def read_inbox
+      File.
+        readlines('spec/fixtures/add_command/Inbox.md').
+        map { |line| line.chomp }
+    end
+
+    def markdo_add(task_body)
+      command_support = build_command_support({
+        'MARKDO_ROOT' => 'spec/fixtures/add_command',
+        'MARKDO_INBOX' => 'Inbox.md',
+      })
+
+      AddCommand.new(command_support).run(task_body)
+    end
+
+    def assert_inbox_empty
+      expect(read_inbox).to be_empty
+    end
+  end
+end

data/spec/lib/commands/edit_command_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'markdo/commands/inbox_command'
+
+module Markdo
+  describe EditCommand do
+    it 'edits the Markdo root in your preferred editor' do
+      skip 'Shellwords not supported' unless defined?(Shellwords)
+
+      command_support = build_command_support({
+        'EDITOR' => 'aneditor',
+        'MARKDO_ROOT' => 'spec/fixtures/'
+      })
+
+      expect(Kernel).to receive(:system).with('aneditor spec/fixtures/')
+
+      EditCommand.new(command_support).run
+    end
+
+    it 'does not allow unsafe values for MARKDO_ROOT' do
+      skip 'Shellwords not supported' unless defined?(Shellwords)
+
+      command_support = build_command_support({
+        'EDITOR' => 'aneditor',
+        'MARKDO_ROOT' => '`ruin everything`'
+      })
+
+      expect(Kernel).to receive(:system).with('aneditor \`ruin\ everything\`')
+
+      EditCommand.new(command_support).run
+    end
+  end
+end

data/spec/lib/commands/forecast_command_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'markdo/commands/forecast_command'
+
+module Markdo
+  describe ForecastCommand do
+    it 'outputs forecast counts' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+
+      command_support = build_command_support_for_date_commands
+
+      ForecastCommand.new(command_support).run
+
+      expect(command_support.stdout.string).to eq(<<-XML)
+Tu: 0
+We: 0
+Th: 0
+Fr: 0
+Sa: 0
+Su: 2
+Next: 4
+      XML
+    end
+  end
+end

data/spec/lib/commands/ics_command_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'markdo/commands/ics_command'
+
+module Markdo
+  describe IcsCommand do
+    it 'outputs an iCalendar feed from the input Markdown, skipping invalid dates' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+      
+      command_support = build_command_support({
+        'MARKDO_ROOT' => 'spec/fixtures/ics_command'
+      })
+
+      IcsCommand.new(command_support).run
+
+      expect(command_support.stdout.string).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
+    end
+  end
+end

data/spec/lib/commands/inbox_command_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'markdo/commands/inbox_command'
+
+module Markdo
+  describe InboxCommand do
+    it 'outputs inbox' do
+      skip 'File.readlines not supported' unless File.respond_to?(:readlines)
+
+      command_support = build_command_support({
+        'MARKDO_ROOT' => 'spec/fixtures/inbox_command',
+        'MARKDO_INBOX' => 'Inbox.md'
+      })
+
+      InboxCommand.new(command_support).run
+
+      expect(command_support.stdout.string).to eq(<<-XML)
+- [ ] Example 1 in inbox
+- [ ] Example 2 in inbox
+      XML
+    end
+  end
+end

data/spec/lib/commands/overdue_command_spec.rb

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

data/spec/lib/commands/overview_command_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'markdo/commands/overview_command'
+
+module Markdo
+  describe OverviewCommand do
+    it 'outputs tasks overdue, starred, due today, and due tomorrow' do
+      skip 'Dir.glob not supported' unless Dir.respond_to?(:glob)
+
+      command_support = build_command_support_for_date_commands
+
+      OverviewCommand.new(command_support).run
+
+      expect(command_support.stdout.string).to eq(<<-EOF)
+- [ ] @due(2016-01-01) Overdue in inbox
+- [ ] @due(2016-01-01) Overdue
+- [ ] @star Starred in inbox
+- [ ] @star Starred
+- [ ] @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
+      EOF
+    end
+  end
+end

data/spec/lib/commands/process_command_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+require 'markdo/commands/process_command'
+
+module Markdo
+  describe ProcessCommand do
+    before do
+      skip 'Could not access fixtures' unless File.exists?('spec/fixtures/')
+    end
+
+    after do
+      clear_all
+    end
+
+    describe 'given the "h" subcommand' do
+      it 'prints help to stdout and makes no changes' do
+        original_content = ['- [ ] Example']
+        write_inbox(original_content)
+
+        stdout = markdo_process(%w(h h))
+
+        expect(stdout.string).to eq(<<-EOF)
+- [ ] Example
+File [hisbma]? 
+i - inbox (keep in inbox)
+s - sprint
+b - backlog
+m - maybe
+a - abort; make no changes
+- [ ] Example
+File [hisbma]? 
+i - inbox (keep in inbox)
+s - sprint
+b - backlog
+m - maybe
+a - abort; make no changes
+- [ ] Example
+File [hisbma]? 
+        EOF
+        
+        expect(read_lines('Inbox')).to eq(original_content)
+        expect(read_lines('Sprint')).to eq([])
+        expect(read_lines('Backlog')).to eq([])
+        expect(read_lines('Maybe')).to eq([])
+      end
+    end
+    
+    describe 'given the "i" subcommand' do
+      it 'keeps the task in the inbox' do
+        original_content = ['- [ ] Example']
+        write_inbox(original_content)
+
+        stdout = markdo_process(%w(i))
+
+        assert_prompt_shown(stdout)
+        expect(read_lines('Inbox')).to eq(original_content)
+        expect(read_lines('Sprint')).to eq([])
+        expect(read_lines('Backlog')).to eq([])
+        expect(read_lines('Maybe')).to eq([])
+      end
+    end
+
+    describe 'given the "a" subcommand' do
+      it 'makes no changes' do
+        original_content = ['- [ ] Example']
+        write_inbox(original_content)
+
+        stdout = markdo_process(%w(a))
+
+        assert_prompt_shown(stdout)
+        expect(read_lines('Inbox')).to eq(original_content)
+        expect(read_lines('Sprint')).to eq([])
+        expect(read_lines('Backlog')).to eq([])
+        expect(read_lines('Maybe')).to eq([])
+      end
+    end
+
+    describe 'given the "s" subcommand' do
+      it 'moves the line to "Sprint.md"' do
+        write_inbox(['- [ ] Example'])
+
+        stdout = markdo_process(%w(s))
+
+        assert_prompt_shown(stdout)
+        expect(read_lines('Inbox')).to eq([])
+        expect(read_lines('Sprint')).to eq([
+          '',
+          '## Processed on 2016-06-01',
+          '',
+          '- [ ] Example'
+        ])
+        expect(read_lines('Backlog')).to eq([])
+        expect(read_lines('Maybe')).to eq([])
+      end
+    end
+
+    describe 'given the "b" subcommand' do
+      it 'moves the line to "Backlog.md"' do
+        write_inbox(['- [ ] Example'])
+
+        stdout = markdo_process(%w(b))
+
+        assert_prompt_shown(stdout)
+        expect(read_lines('Inbox')).to eq([])
+        expect(read_lines('Sprint')).to eq([])
+        expect(read_lines('Backlog')).to eq([
+          '',
+          '## Processed on 2016-06-01',
+          '',
+          '- [ ] Example'
+        ])
+        expect(read_lines('Maybe')).to eq([])
+      end
+    end
+
+    describe 'given the "m" subcommand' do
+      it 'moves the line to "Maybe.md"' do
+        write_inbox(['- [ ] Example'])
+
+        stdout = markdo_process(%w(m))
+
+        assert_prompt_shown(stdout)
+        expect(read_lines('Inbox')).to eq([])
+        expect(read_lines('Sprint')).to eq([])
+        expect(read_lines('Backlog')).to eq([])
+        expect(read_lines('Maybe')).to eq([
+          '',
+          '## Processed on 2016-06-01',
+          '',
+          '- [ ] Example'
+        ])
+      end
+    end
+
+    def clear_all
+      %w(Backlog Inbox Maybe Sprint).each do |filename|
+        File.write("spec/fixtures/process_command/#{filename}.md", '')
+      end
+    end
+
+    def write_inbox(content)
+      File.write('spec/fixtures/process_command/Inbox.md', content.join("\n"))
+    end
+
+    def markdo_process(subcommands)
+      raw_input = subcommands.map { |s| "#{s}\n" }.join
+      stdin = StringIO.new(raw_input)
+      stdout = StringIO.new
+      stderr = StringIO.new
+      today = Date.new(2016, 6, 1)
+      env = {
+        'MARKDO_ROOT' => 'spec/fixtures/process_command',
+        'MARKDO_INBOX' => 'Inbox.md',
+      }
+      command_support = CommandSupport.new(stdin: stdin,
+                                           stdout: stdout,
+                                           stderr: stderr,
+                                           today: today,
+                                           env: env)
+
+      ProcessCommand.new(command_support).run
+
+      command_support.stdout
+    end
+
+    def read_lines(filename)
+      File.
+        readlines("spec/fixtures/process_command/#{filename}.md").
+        map { |line| line.chomp }
+    end
+
+    def assert_prompt_shown(io)
+      expect(io.string).to eq(<<-EOF)
+- [ ] Example
+File [hisbma]? 
+      EOF
+    end
+  end
+end