taskmeister 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9765c5b79d2cce230bd4cdc78b11aba686f91adc
-  data.tar.gz: 7a1f828b681135fbedb8fc8209c6cd799fdf804d
+  metadata.gz: 591ce55195a674c8070990555d81b0adb170bbfb
+  data.tar.gz: ba6c0b5b60a931b6b88ed9b1fbd4972593ddd6cc
 SHA512:
-  metadata.gz: 3e92cac2efc981db979f8723c8a0a4590f5e42674779e1393d234523846c1b23574d6f91ac1042821c58a08e94df5f15c49c7d147f47e4722571cb913a22507a
-  data.tar.gz: 193f0e2d6df20a5961622d1d4c0be8e5183773b4ba9a4b8ed149fa5fffd37cd85d0cc76567c46213731f9712e2066a56d72af97f8dfcb4f43fc22cf56680e7f7
+  metadata.gz: e6b26c40298e84d9849c7938ffe0b9e0eeb7c75d8eece34a3d3f056383d6e1f5d6b740a0a420c53a7c2e5840f9813865754a5f5ce7656ab64e30bde23c3b2b11
+  data.tar.gz: aa049e066b54e142feee77aea27e427e71c61557bfca4891f859ba7f499c680695dac19cd96f5d340b0533c65f8e8c58ed2257884b98932d960105ae6ade0664

data/README.md

@@ -49,7 +49,8 @@ Specific options:
                                        A project directory is found by walking up from the current directory and stopping if a .git or .hg directory is found.
     -d, --done TASK_ID               Finish a task
     -s, --show TASK_ID               Show a task list item and its notes
-    -e, --edit TASK_ID               Edit a task in Vim
+    -e, --edit [TASK_ID]             Edit task list in Vim
+                                       Will search for a specific task if TASK_ID is provided
     -r, --replace TASK_ID            Replace a task description
 
 Common options:

data/Rakefile

@@ -9,4 +9,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => [:spec, :cucumber]

data/features/add.feature

@@ -1,6 +1,6 @@
 Feature: taskmeister adds a task to the list
 
-  Scenario: Project directory with task list
+  Scenario: Add a task to the list
     Given a file named "mylist.md" with:
       """
 Task one - [id](aaf83a9b-02f7-4cc0-8ee1-4d98b98903b8)
@@ -15,3 +15,8 @@ Task three - [id](a5d4d3a9-2b9a-427a-9047-b47c6aec8f93)
     And I successfully run `taskmeister --list mylist.md`
     Then the output should contain "A new task"
 
+  Scenario: Add a task to an empty list
+    When I successfully run `taskmeister --list mylist.md A new task`
+    And I successfully run `taskmeister --list mylist.md`
+    Then the output should contain "A new task"
+    And a file named "mylist.md" should exist

data/features/done.feature

@@ -1,6 +1,6 @@
 Feature: taskmeister removes finished tasks from the list
 
-  Scenario: Project directory with task list
+  Scenario: Complete a task in the list
     Given a file named "mylist.md" with:
       """
 Task one - [id](aaf83a9b-02f7-4cc0-8ee1-4d98b98903b8)
@@ -15,3 +15,14 @@ Task three - [id](a5d4d3a9-2b9a-427a-9047-b47c6aec8f93)
     And I successfully run `taskmeister --list mylist.md`
     Then the output should not contain "Task one"
 
+  Scenario: Delete the task list when you remove the last task
+    Given a file named "mylist.md" with:
+      """
+Task one - [id](aaf83a9b-02f7-4cc0-8ee1-4d98b98903b8)
+
+> Notes line one
+> Notes line two
+      """
+    When I successfully run `taskmeister --list mylist.md --done a`
+    Then the file "mylist.md" should not exist
+

data/features/edit.feature

@@ -0,0 +1,34 @@
+Feature: taskmeister opens vim to edit your task list
+
+  Scenario: Edit entire task list
+    Given a file named "mylist.md" with:
+      """
+Task one - [id](aaf83a9b-02f7-4cc0-8ee1-4d98b98903b8)
+
+> Notes line one
+> Notes line two
+
+Task two - [id](ae0cce15-456d-48c0-a2e2-69d5f567e092)
+Task three - [id](a5d4d3a9-2b9a-427a-9047-b47c6aec8f93)
+      """
+    And I double `vim`
+    When I run `taskmeister --list mylist.md --edit`
+    Then the double `vim` should have been run with file "mylist.md"
+    And the exit status should be 0
+
+  Scenario: Edit specific task in the list
+    Given a file named "mylist.md" with:
+      """
+Task one - [id](aaf83a9b-02f7-4cc0-8ee1-4d98b98903b8)
+
+> Notes line one
+> Notes line two
+
+Task two - [id](ae0cce15-456d-48c0-a2e2-69d5f567e092)
+Task three - [id](a5d4d3a9-2b9a-427a-9047-b47c6aec8f93)
+      """
+    And I double `vim`
+    When I run `taskmeister --list mylist.md --edit a`
+    Then the double `vim` should have been run with "+/aaf83a9b-02f7-4cc0-8ee1-4d98b98903b8" and file "mylist.md"
+    And the exit status should be 0
+

data/features/list.feature

@@ -1,6 +1,6 @@
 Feature: taskmeister lists the contents of a task list
 
-  Scenario: Normal directory with explicit task list
+  Scenario: List tasks in list
     Given a file named "mylist.md" with:
       """
 Task one - [id](aaf83a9b-02f7-4cc0-8ee1-4d98b98903b8)

data/features/project_dir.feature

@@ -1,6 +1,6 @@
 Feature: taskmeister infers the name of your task list from your current project directory
 
-  Scenario: Project directory with task list
+  Scenario: List tasks in list found from project directory
     Given a directory named "project"
     And a directory named "project/.git"
     And a directory named "project/child"

data/features/replace.feature

@@ -1,6 +1,6 @@
 Feature: taskmeister replaces a task in the list
 
-  Scenario: Project directory with task list
+  Scenario: Replace text of task in list
     Given a file named "mylist.md" with:
       """
 Task one - [id](aaf83a9b-02f7-4cc0-8ee1-4d98b98903b8)

data/features/show.feature

@@ -1,6 +1,6 @@
 Feature: taskmeister shows the details of a task in the list
 
-  Scenario: Project directory with task list
+  Scenario: Show task in list
     Given a file named "mylist.md" with:
       """
 Task one - [id](aaf83a9b-02f7-4cc0-8ee1-4d98b98903b8)

data/features/step_definitions/command_double_steps.rb

@@ -0,0 +1,12 @@
+
+Then(/^the double `([^`]*)` should have been run with file "(.*?)"$/) do |cmd, file|
+  in_current_dir {
+    expect(history).to include [cmd, Pathname.new(file).expand_path.to_s]
+  }
+end
+
+Then(/^the double `([^`]*)` should have been run with "(.*?)" and file "(.*?)"$/) do |cmd, arg, file|
+  in_current_dir {
+    expect(history).to include [cmd, arg, Pathname.new(file).expand_path.to_s]
+  }
+end

data/features/support/env.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'aruba/cucumber'
+require 'aruba-doubles/cucumber'
 
 $LOAD_PATH << File.expand_path('../../../lib', __FILE__)
 require 'taskmeister'

data/lib/taskmeister/cli/main.rb

@@ -10,67 +10,66 @@ module Taskmeister
       def execute!
         options = Options.new(@stdout, @kernel).parse(@argv)
 
-        task_list_path = Pathname.new(options.task_dir) + task_list_name(options)
+        task_list = Taskmeister::TaskListReader.from_markdown_file(task_list_path(options))
 
-        task_list = Taskmeister::TaskListReader.from_markdown_file(task_list_path)
-
-        run_command(options, task_list_path, task_list)
+        run_command(options, task_list)
       end
 
       private
 
-      def task_list_name(options)
-        task_list_name = options.list || TaskListName.from_project_dir(Pathname.getwd)
-
-        unless task_list_name
-          @stdout.puts "Could not find a project directory. Please specify a task list."
-          @kernel.exit 1
-        end
-
-        task_list_name
-      end
-
-      def run_command(options, task_list_path, task_list)
+      def run_command(options, task_list)
         case options.command
         when Commands::LIST
           @stdout.puts task_list.to_short_list
 
         when Commands::SHOW
 
-          @stdout.puts task_list.details(options.task_id)
+          @stdout.puts task_list.markdown_for(options.task_id)
 
         when Commands::EDIT
 
           task = task_list[options.task_id]
 
           search_path = task ? "+/#{task.id} " : ""
-          system "vim #{search_path}#{task_list_path}"
+          system "vim #{search_path}#{task_list.file_path}"
 
         when Commands::ADD
 
-          update_task_list(task_list, task_list_path) {
-            task_list.add(Taskmeister::Task.create(options.task_text))
-          }
+          task_list.add(Taskmeister::Task.create(options.task_text))
+          update task_list
 
         when Commands::DONE
 
-          update_task_list(task_list, task_list_path) {
-            task_list.complete options.task_id
-          }
+          task_list.complete(options.task_id)
+          update task_list
 
         when Commands::REPLACE
 
-          update_task_list(task_list, task_list_path) {
-            task_list.replace options.task_id, options.task_text
-          }
+          task_list.replace(options.task_id, options.task_text)
+          update task_list
 
         end
 
         @kernel.exit 0
       end
 
-      def update_task_list(task_list, file_path)
-        Taskmeister::TaskListWriter.to_markdown_file(task_list, file_path) if yield
+      def task_list_path(options)
+        Pathname.new(options.task_dir) + task_list_name(options)
+      end
+
+      def task_list_name(options)
+        task_list_name = options.list || TaskListName.from_project_dir(Pathname.getwd)
+
+        unless task_list_name
+          @stderr.puts "Could not find a project directory. Please specify a task list."
+          @kernel.exit 1
+        end
+
+        task_list_name
+      end
+
+      def update(task_list)
+        Taskmeister::TaskListWriter.to_markdown_file(task_list)
       end
     end
   end

data/lib/taskmeister/cli/options.rb

@@ -86,8 +86,8 @@ module Taskmeister
 
         options.task_text = task_text.join(" ") unless task_text.empty?
 
-        # If there is task text and the default command hasn't been overwritten
-        # by the user, make the command add
+        # If there is TASK TEXT and the default command hasn't been overwritten
+        # by the user, set the command to ADD
         if !task_text.empty? and options.command == Commands::LIST
           options.command = Commands::ADD
         end

data/lib/taskmeister/task_list.rb

@@ -1,11 +1,17 @@
 module Taskmeister
   class TaskList
-    def initialize(tasks)
+    attr_reader :file_path
+
+    def initialize(tasks, file_path)
+      @file_path = file_path
+
       @hash = {}
 
       tasks.each do |t|
         add(t)
       end
+
+      @dirty = false
     end
 
     def to_short_list
@@ -24,13 +30,23 @@ module Taskmeister
       @hash[key]
     end
 
+    def empty?
+      @hash.empty?
+    end
+
+    def dirty?
+      @dirty
+    end
+
     def add(task)
       prefix = assign_short_code_to_task(task)
       @hash[prefix] = task
+      @dirty = true
     end
 
     def complete(short_id)
-      @hash.delete(short_id)
+      removed_val = @hash.delete(short_id)
+      @dirty = true if removed_val
     end
 
     def replace(short_id, new_text)
@@ -38,9 +54,10 @@ module Taskmeister
       return unless task
 
       @hash[short_id] = Task.new(new_text, task.id, task.notes)
+      @dirty = true
     end
 
-    def details(short_id)
+    def markdown_for(short_id)
       return [] unless @hash.has_key?(short_id)
 
       self[short_id].to_markdown

data/lib/taskmeister/task_list_reader.rb

@@ -1,6 +1,6 @@
 module Taskmeister
   class TaskListReader
-    def self.from_markdown(file_lines)
+    def self.from_markdown(file_lines, file_path)
       grouped_lines = \
         file_lines.map(&:chomp)
                   .reject(&:empty?)
@@ -10,16 +10,16 @@ module Taskmeister
                     acc
                   end
 
-      tasks = grouped_lines.map do |l|
-        Task.from_markdown(l)
+      tasks = grouped_lines.map do |ls|
+        Task.from_markdown ls
       end
 
-      TaskList.new tasks
+      TaskList.new tasks, file_path
     end
 
-    def self.from_markdown_file(path)
-      lines = File.exist?(path) ? File.readlines(path) : []
-      from_markdown lines
+    def self.from_markdown_file(file_path)
+      lines = File.exist?(file_path) ? File.readlines(file_path) : []
+      self.from_markdown lines, file_path
     end
   end
 end

data/lib/taskmeister/task_list_writer.rb

@@ -4,9 +4,13 @@ module Taskmeister
       task_list.tasks.map(&:to_markdown).flatten
     end
 
-    def self.to_markdown_file(task_list, file_path)
+    def self.to_markdown_file(task_list)
+      return unless task_list.dirty?
+
+      return task_list.file_path.delete if task_list.empty? && File.exist?(task_list.file_path)
+
       lines = self.to_markdown(task_list)
-      File.open(file_path, "w") do |f|
+      File.open(task_list.file_path, "w") do |f|
         f.puts lines
       end
     end

data/lib/taskmeister/version.rb

@@ -1,3 +1,3 @@
 module Taskmeister
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/spec/lib/taskmeister/task_list_reader_spec.rb

@@ -11,14 +11,14 @@ module Taskmeister
         allow(TaskList).to receive(:new).and_return(double(TaskList))
       end
 
-      let(:it) { described_class.from_markdown(lines) }
+      let(:it) { described_class.from_markdown(lines, "fake file") }
 
       describe "passed an empty list of lines" do
         let(:lines) { [] }
 
         it "creates an empty task list" do
           expect(Task).not_to receive(:from_markdown)
-          expect(TaskList).to receive(:new).with([])
+          expect(TaskList).to receive(:new).with([], "fake file")
           it
         end
       end

data/spec/lib/taskmeister/task_list_spec.rb

@@ -16,7 +16,15 @@ module Taskmeister
       task1, task2, task3, task4, task5, task6, task7
     ]}
 
-    let(:list) { described_class.new(tasks) }
+    let(:list) { described_class.new(tasks, "fake file") }
+
+    it "saves its file path" do
+      expect(list.file_path).to eq "fake file"
+    end
+
+    it "is initially clean" do
+      expect(list.dirty?).to eq false
+    end
 
     describe "#[]" do
       it "uses the shortest common prefix to index a task" do
@@ -49,34 +57,58 @@ module Taskmeister
     describe "#complete" do
       it "removes the identified task" do
         expect(list["7"]).to eq task1
-        result = list.complete("7")
-        expect(result).to be_truthy
+        list.complete("7")
         expect(list["7"]).to be_nil
       end
 
-      it "ignores non-existent tasks" do
-        result = list.complete("345")
-        expect(result).to be_falsy
-        expect(list.tasks.size).to eq tasks.size
+      it "marks the list as dirty" do
+        list.complete("7")
+        expect(list.dirty?).to eq true
+      end
+
+      context "when removing a non-existent task" do
+        before do
+          list.complete("345")
+        end
+
+        it "doesn't change the list" do
+          expect(list.tasks.size).to eq tasks.size
+        end
+
+        it "is not marked as dirty" do
+          expect(list.dirty?).to eq false
+        end
       end
     end
 
     describe "#replace" do
       it "replaces the text of the specified task" do
-        result = list.replace("7", "A new task text")
-        expect(result).to be_truthy
+        list.replace("7", "A new task text")
         task = list["7"]
         expect(task.text).to eq "A new task text"
       end
 
-      it "ignores a non-existent task" do
-        result = list.replace("345", "A new task text")
-        expect(result).to be_falsy
-        expect(list.tasks.size).to eq tasks.size
+      it "marks the list as dirty" do
+        list.replace("7", "A new task text")
+        expect(list.dirty?).to eq true
+      end
+
+      context "when removing a non-existent task" do
+        before do
+          list.replace("345", "A new task text")
+        end
+
+        it "doesn't change the list" do
+          expect(list.tasks.size).to eq tasks.size
+        end
+
+        it "is not marked as dirty" do
+          expect(list.dirty?).to eq false
+        end
       end
     end
 
-    describe "#details" do
+    describe "#markdown_for" do
       before do
         allow_any_instance_of(Task).to receive(:to_markdown).and_return([
           "line 1",
@@ -85,22 +117,29 @@ module Taskmeister
       end
 
       it "returns an empty list if the id doesn't exist" do
-        expect(list.details("34")).to eq []
+        expect(list.markdown_for("34")).to eq []
       end
 
       it "returns the lines of a task" do
-        expect(list.details("7")).to eq ["line 1", "line 2"]
+        expect(list.markdown_for("7")).to eq ["line 1", "line 2"]
       end
     end
 
     describe "#add" do
+      let(:task8) { Task.new("task 8", "f23891df0-97a5-4310-9b01-374983416af7", nil) }
+
+      before do
+        list.add(task8)
+      end
+
       it "adds the task and assigns it a short id" do
-        task8 = Task.new("task 8", "f23891df0-97a5-4310-9b01-374983416af7", nil)
-        result = list.add(task8)
-        expect(result).to be_truthy
         expect(list.tasks.size).to eq 8
         expect(list["f23"]).to eq task8
       end
+
+      it "marks the list as dirty" do
+        expect(list.dirty?).to eq true
+      end
     end
   end
 end

data/taskmeister.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["ray.grasso@gmail.com"]
   spec.summary       = %q{Another command line task manager.}
   spec.description   = %q{Another command line task manager. You know, because I'm special.}
-  spec.homepage      = "https://www.github.com/grassdog/taskmeister"
+  spec.homepage      = "https://github.com/grassdog/taskmeister"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "aruba", "~> 0.6"
+  spec.add_development_dependency "aruba-doubles", "~> 1.2"
   spec.add_development_dependency "pry-byebug", "~> 1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taskmeister
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ray Grasso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: aruba-doubles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -98,10 +112,12 @@ files:
 - bin/taskmeister
 - features/add.feature
 - features/done.feature
+- features/edit.feature
 - features/list.feature
 - features/project_dir.feature
 - features/replace.feature
 - features/show.feature
+- features/step_definitions/command_double_steps.rb
 - features/support/env.rb
 - lib/taskmeister.rb
 - lib/taskmeister/cli/main.rb
@@ -118,7 +134,7 @@ files:
 - spec/lib/taskmeister/task_spec.rb
 - spec/spec_helper.rb
 - taskmeister.gemspec
-homepage: https://www.github.com/grassdog/taskmeister
+homepage: https://github.com/grassdog/taskmeister
 licenses:
 - MIT
 metadata: {}
@@ -145,10 +161,12 @@ summary: Another command line task manager.
 test_files:
 - features/add.feature
 - features/done.feature
+- features/edit.feature
 - features/list.feature
 - features/project_dir.feature
 - features/replace.feature
 - features/show.feature
+- features/step_definitions/command_double_steps.rb
 - features/support/env.rb
 - spec/lib/taskmeister/task_list_reader_spec.rb
 - spec/lib/taskmeister/task_list_spec.rb