r2do 0.0.6 → 0.0.7

data/README.md

@@ -63,6 +63,10 @@ To view the information regarding a Task:
 
     r2do task --display
 
+To edit a Task:
+
+    r2do task --edit
+
 To complete a Task:
 
     r2do task --done
@@ -91,10 +95,7 @@ To see all the available commands:
 
 There are many features presently missing from r2do, which will be implemented in future versions but there is one thing which must be noted here.
 
-1) The ability to edit a Category or a Task is lacking at present. It is the top priority, but please note that it is missing.
-
-If you need to edit a Task you can delete the old one and re-create it.
-The same goes for a Category, although this is more annoying as you will loose your Tasks when you delete a Category.
+1) The ability to edit a Category is lacking at present.
 
 2) The ability to move a Task from one Category to another is also missing.
 

data/lib/r2do/handlers/handle_category.rb

@@ -76,7 +76,10 @@ module R2do
       end
     end
 
-
+    # Creates a new Category or selects an already existing one.
+    #
+    # @param [Array] args the argumets passed to the app by the user.
+    # @return [void]
     def parse_category(args)
       extra = ''
       category_name = args[1]
@@ -94,7 +97,9 @@ module R2do
       UI.status("Switched to #{extra}category '#{category_name}'")
     end
 
-
+    # Ensures that a category is selected.
+    #
+    # @return [void]
     def require_selected_category()
       if not @state.current_category
         raise CategoryNotSelectedError, "This action requires a selected category."

data/lib/r2do/handlers/handle_task.rb

@@ -24,6 +24,7 @@ module R2do
     COMPLETED = "--done"
     DISPLAY   = "--display"
     DELETE    = "--delete"
+    EDIT      = "--edit"
 
     # Creates a new task or makes a task current in the current category if a task with the
     # same name already exists
@@ -45,6 +46,9 @@ module R2do
       if option.eql?(DISPLAY)
         require_selected_task()
         show_current_task(args)
+      elsif option.eql?(EDIT)
+        require_selected_task()
+        edit_current_task(args)
       elsif option.eql?(COMPLETED)
         require_selected_task()
         mark_as_complete(args)
@@ -52,13 +56,35 @@ module R2do
         require_selected_task()
         delete_task(args)
       elsif option.start_with?("--")
-        raise InvalidOptionError
+        raise InvalidOptionError, "Invalid argument for the command. See 'r2do -h'."
       else
         parse_task(args)
       end
     end
 
+    # Edit the current task.
+    #
+    # @param [Array] args the arguments passed to the app by the user.
+    # @return [void]
+    def edit_current_task(args)
+      UI.status("Are you sure you want to edit the task:")
+      UI.status("   #{@state.current_category.current_task.description}")
+      UI.new_line()
+      value = UI.input("Continue? [Yn]")
+      if value == YES
+        desc = UI.input("Enter new description:")
+        task = @state.current_category.current_task
+        task.rename(desc)
+        @modified = true
+
+        UI.status("The task as been modified.")
+      end
+    end
 
+    # Delete the currently selected task.
+    #
+    # @param [Array] args the arguments passed to the app by the user.
+    # @return [void]
     def delete_task(args)
       UI.status("Are you sure you want to delete the task:")
       UI.status("   #{@state.current_category.current_task.description}")
@@ -74,15 +100,18 @@ module R2do
       end
     end
 
-
+    # Displays the information of the currently selected task.
+    #
+    # @param [Array] args the arguments passed to the app by the user.
+    # @return [void]
     def show_current_task(args)
       task = @state.current_category.current_task
       UI.status(task.display())
     end
 
-    # Marks a task as completed
+    # Marks a task as completed.
     #
-    # @param [Array] args the arguments passed to the app by the user
+    # @param [Array] args the arguments passed to the app by the user.
     # @return [void]
     def mark_as_complete(args)
       task = @state.current_category.current_task
@@ -92,7 +121,10 @@ module R2do
       UI.status("Task '%s' has been marked as completed." % task.description)
     end
 
-
+    # Creates a new task or select an already existing one.
+    #
+    # @param [Array] args the arguments passed to the app by the user.
+    # @return [void]
     def parse_task(args)
       extra = ''
       task_description = args[1]
@@ -111,6 +143,9 @@ module R2do
       UI.status("Selected task '#{task_description}'")
     end
 
+    # Checks that a task is currently selected.
+    #
+    # @return [void]
     def require_selected_task()
       if not @state.current_category.current_task
         raise TaskNotSelectedError, "This action requires a selected task."

data/lib/r2do/task.rb

@@ -34,6 +34,14 @@ module R2do
       @date_done = nil
     end
 
+    # Renames this Task
+    #
+    # @param [String] description the new value for the task
+    # @return [void]
+    def rename(description)
+      @description = description
+    end
+
     # Gets the completed status of the specific task.
     #
     # @return [bool] true if the task is completed.
@@ -64,6 +72,9 @@ module R2do
       return "[%s] %-30s %s" % [completed, @description, date]
     end
 
+    # Returns information regarding the state of this task.
+    #
+    # @return [String] the metadata for this task.
     def display()
       date = format_date(@date_created)
 
@@ -82,7 +93,10 @@ module R2do
       return result.string
     end
 
-
+    # Formats the date
+    #
+    # @param [DateTime] date the date to parse
+    # @return [String] the formatted date
     def format_date(date)
       date.strftime('%a %b %e, %Y')
     end

data/lib/r2do/ui.rb

@@ -26,6 +26,14 @@ module R2do
       puts message
     end
 
+    # Displays a status message to the user
+    #
+    # @param [String] message the message to display to the user
+    # @return [void]
+    def self.rescue(exception)
+      puts "abort: #{exception.message}"
+    end
+
     # Adds a new empty line on the display
     #
     # @return [void]

data/lib/r2do/version.rb

@@ -15,5 +15,5 @@
 #
 
 module R2do
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/r2do.rb

@@ -27,7 +27,6 @@ require 'r2do/handlers/handle_category'
 require 'r2do/handlers/handle_task'
 require 'r2do/handlers/handle_init'
 require 'r2do/handlers/handle_categories'
-require 'r2do/handlers/handle_current'
 require 'r2do/utility'
 
 
@@ -58,7 +57,11 @@ module R2do
       if @args.length > 0
         cmd = find_command(option)
         if not cmd.nil?
-          cmd.execute(@args)
+          begin
+            cmd.execute(@args)
+          rescue Exception => e
+            UI.rescue(e)
+          end
         else
           invalid_command(option)
         end

data/r2do.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["christiangiacomi@gmail.com"]
   gem.description   = %q{A simple todo gem}
   gem.summary       = %q{A simple todo gem}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/cgiacomi/r2do"
 
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: r2do
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -112,7 +112,6 @@ files:
 - lib/r2do/exceptions.rb
 - lib/r2do/handlers/handle_categories.rb
 - lib/r2do/handlers/handle_category.rb
-- lib/r2do/handlers/handle_current.rb
 - lib/r2do/handlers/handle_init.rb
 - lib/r2do/handlers/handle_task.rb
 - lib/r2do/state.rb
@@ -127,7 +126,7 @@ files:
 - spec/r2do/r2do_spec.rb
 - spec/r2do/task_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/cgiacomi/r2do
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -141,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3996115367842685634
+      hash: -972365083019823289
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -150,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3996115367842685634
+      hash: -972365083019823289
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/lib/r2do/handlers/handle_current.rb

@@ -1,22 +0,0 @@
-#
-#  Copyright 2012 Christian Giacomi http://www.christiangiacomi.com
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-#
-
-module R2do
-  module Handlers
-
-
-  end
-end