milkmaid 0.1.1 → 0.2.0

data/README.rdoc

@@ -30,6 +30,7 @@ number appears at the beginning.
 
 $ milkmaid list
 
+
 Complete a task
 
 $ milkmaid complete <task number>
@@ -39,6 +40,11 @@ Postpone a task
 
 $ milkmaid postpone <task number>
 
+
+Delete a task
+
+$ milkmaid delete <task number>
+
 Add a task (Use single quotes to contain the task name)
 
 Adding a task supports Remember the Milk's Smart Add feature. With it you
@@ -46,6 +52,22 @@ can set properties such as the due date, priority, etc.
 
 $ milkmaid add '<task name>'
 
+== Version history
+
+=== 0.2.0
+
+* New delete command
+* Friendlier usage information
+
+=== 0.1.1
+
+* Fixed an issue when listing tasks with recurrences that were completed
+
+=== 0.1.0
+
+* Initial version
+
+
 == Contributing to Milkmaid
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/bin/milkmaid

@@ -11,18 +11,28 @@ def milkmaid
 end
 
 Main {
+  description "Milkmaid command-line client for Remember the Milk\n" +
+    "If this is your first time running this, use the auth command to connect to your account."
+
   def run
     help!
   end
 
   mode :list do
+    description "Lists all inactive tasks. Tasks that repeat are marked with a (R).\n" +
+      "If there is a due date, it appears to the right of the task. Tasks are color\n" +
+      "coded by priority the same when viewed on the web. Tasks due today are in bold\n" +
+      "while tasks that are overdue are underlined.\n" +
+      "Use this command to assign a number to tasks so you may perform other actions."
+
     def run
       begin
         milkmaid.incomplete_tasks.each_with_index do |taskseries, i|
+          task = Milkmaid::last_task taskseries
           text = "#{i+1}: #{taskseries['name']}"
           text << "(R)" unless taskseries['rrule'].nil?
-          text << " #{Time.parse(taskseries['task'].as_array.last['due']).getlocal.strftime(
-          "%A %b %d, %Y %I:%M %p")}" unless taskseries['task'].as_array.last['due'].empty?
+          text << " #{Time.parse(Milkmaid::last_task(taskseries)['due']).getlocal.strftime(
+          "%A %b %d, %Y %I:%M %p")}" unless task['due'].empty?
           color = {
             '1'=>[234, 82, 0], 
             '2'=>[0, 96, 191], 
@@ -30,14 +40,14 @@ Main {
             'N'=>:nothing
           }
           mode1 = mode2 = nil
-          case Date.today <=> Date.parse(taskseries['task'].as_array.last['due'])
+          case Date.today <=> Date.parse(task['due'])
           when 0
             mode1 = :bold
           when 1
             mode1 = :bold
             mode2 = :underline
-          end unless taskseries['task'].as_array.last['due'].empty?
-          puts Paint[text, color[taskseries['task'].as_array.last['priority']], mode1, mode2]
+          end unless task['due'].empty?
+          puts Paint[text, color[task['priority']], mode1, mode2]
         end
       rescue RTM::NoTokenException
         puts "Authentication token not found. Run `#{__FILE__} auth start`"
@@ -46,8 +56,11 @@ Main {
   end
 
   mode :complete do
+    description "Marks a task as complete."
+
     argument(:tasknum) {
       cast :int
+      description "The number of the task as printed by the list command."
     }
 
     def run
@@ -63,8 +76,11 @@ Main {
   end
 
   mode :postpone do
+    description "Extends the due date of a task."
+
     argument(:tasknum) {
       cast :int
+      description "The number of the task as printed by the list command."
     }
 
     def run
@@ -79,6 +95,26 @@ Main {
     end
   end
 
+  mode :delete do
+    description "Gets rid of a task."
+
+    argument(:tasknum) {
+      cast :int
+      description "The number of the task as printed by the list command."
+    }
+
+    def run
+      begin
+        milkmaid.delete_task params['tasknum'].value
+      rescue Milkmaid::TaskNotFound
+        puts "Task ##{params['tasknum'].value} not found. Run `#{__FILE__} list` " +
+          "to load a list of tasks."
+      rescue RTM::NoTokenException
+        puts "Authentication token not found. Run `#{__FILE__} auth start`"
+      end
+    end
+  end
+
   mode :add do
     argument(:taskname) 
 
@@ -92,7 +128,12 @@ Main {
   end
         
   mode :auth do
+    description "Auth commands are used to connect Milkmaid to your account."
+
     mode :start do
+      description "Use this command to generate an authentication link.\n" +
+        "Follow the link before issuing the auth finish command."
+
       def run
         puts '1. Visit the URL to authorize the application to access your account.'
         puts "2. Run `#{__FILE__} auth finish`"
@@ -102,6 +143,8 @@ Main {
     end
 
     mode :finish do
+      description "Use this command to complete authentication to your account."
+
       def run
         begin
           milkmaid.auth_finish

data/lib/milkmaid.rb

@@ -23,13 +23,13 @@ class Milkmaid
       if !items['taskseries'].nil?
         items['taskseries'].as_array.each do |taskseries|
           taskseries['list_id'] = list_id
-          entries << taskseries if taskseries['task'].as_array.last['completed'].empty?
+          entries << taskseries if Milkmaid::last_task(taskseries)['completed'].empty?
         end
       end
     end
     entries.sort! do |a, b|
-      taska = a['task'].as_array.last
-      taskb = b['task'].as_array.last
+      taska = Milkmaid::last_task a
+      taskb = Milkmaid::last_task b
       result = taska['priority'] <=> taskb['priority']
       if result == 0
         if taska['due'].empty?
@@ -46,7 +46,7 @@ class Milkmaid
     entries.each_with_index do |taskseries, i|
       @config["#{i+1}list_id"] = taskseries['list_id']
       @config["#{i+1}taskseries_id"] = taskseries['id']
-      @config["#{i+1}task_id"] = taskseries['task'].as_array.last['id']
+      @config["#{i+1}task_id"] = Milkmaid::last_task(taskseries)['id']
     end
     save_config
     entries
@@ -62,6 +62,11 @@ class Milkmaid
     call_rtm_api :postpone, tasknum
   end
 
+  def delete_task(tasknum)
+    check_task_ids tasknum
+    call_rtm_api :delete, tasknum
+  end
+
   def add_task(name)
     @rtm.tasks.add :name=>name, :parse=>'1', :timeline=>@timeline
   end
@@ -81,6 +86,10 @@ class Milkmaid
   class TaskNotFound < StandardError
   end
 
+  def self.last_task(taskseries)
+    taskseries['task'].as_array.last
+  end
+
   private
   def save_config
     File.open(@config_file, 'w') { |f| YAML.dump(@config, f) }

data/milkmaid.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "milkmaid"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marius Grigoriu"]

data/spec/milkmaid_spec.rb

@@ -81,7 +81,8 @@ describe "Milkmaid" do
   describe "working with existing tasks" do
     it "raises an error when unable to find the desired task in config" do
       lambda { lib.complete_task 1 }.should raise_error(Milkmaid::TaskNotFound)
-      lambda { lib.postpone_task 1 }.should raise_error(Milkmaid::TaskNotFound)
+      lambda { lib.postpone_task 2 }.should raise_error(Milkmaid::TaskNotFound)
+      lambda { lib.delete_task 3 }.should raise_error(Milkmaid::TaskNotFound)
     end
 
     it "marks the task as complete" do
@@ -93,6 +94,11 @@ describe "Milkmaid" do
       should_call_rtm_api(:postpone, 2)
       lib.postpone_task 2
     end
+
+    it "deletes a task" do
+      should_call_rtm_api(:delete, 3)
+      lib.delete_task 3
+    end
   end
 
   it "adds a task to the inbox using Smart Add" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: milkmaid
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Marius Grigoriu