to-do 1.2.7 → 1.3.0

data/.travis.yml

@@ -3,7 +3,5 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - rbx-18mode
-  - rbx-19mode
 # uncomment this line if your project needs to run something other than `rake`:
 # script: bundle exec rspec spec

data/README.md

@@ -1,17 +1,10 @@
-#to-do 1.2.7 [![Build Status](https://secure.travis-ci.org/kristenmills/to-do.png?branch=master)](http://travis-ci.org/kristenmills/to-do)
+#to-do 1.3 [![Build Status](https://secure.travis-ci.org/kristenmills/to-do.png?branch=master)](http://travis-ci.org/kristenmills/to-do)
 
 A simple command line todo application written in Ruby.   
 
-##What's new in 1.2.7
-* Rewrote tests
-* Bug Fixes
-
-##What's new in 1.2
-* Remove a list
-* Better usage messages
-* Better documentation using YARD
-* Better layout
-* SQlite backend
+##What's new in 1.3
+* Priorities
+* Sorting
 
 ##Install
 	gem install to-do
@@ -26,8 +19,13 @@ A simple command line todo application written in Ruby.
 * Colored display
 * Undo Completing
 * Remove lists
+* Sortable 
+* Priorities
 
 ##How to Use
+This is just basic usage. For more information, view 
+	todo -h 
+	todo --help
 
 ###Create a new todo list or switch to an existing list
 
@@ -102,8 +100,6 @@ A simple command line todo application written in Ruby.
 * Tags
 * Due Dates
 * Tab Completion
-* Sorting
-* Priorites
 * Reorganizing
 
 ##Contributing to to-do

data/VERSION

@@ -1 +1 @@
-1.2.7
+1.3.0

data/lib/to-do/cli.rb

@@ -14,7 +14,23 @@ module Todo
 		# The option flags 
 		OPTIONS = {
 			:is_num => false, 
-			:clear_all => false
+			:clear_all => false,
+			:change_priority => false,
+			:priority => 1, 
+			:sort => "n"
+		}
+
+		# Usage messages for each of the commnands
+		USAGE = {
+			:default => "todo [COMMAND] [option] [arguments]", 
+			:create  => "todo create|switch <LIST NAME>", 
+			:display => "todo [display|d] [-s {p,n}]",
+			:add => "todo add|a [-p {high, medium, low}] <TASK>", 
+			:finish => "todo finish|f [-n <TASK_NUMBER>] [<TASK>]",
+			:undo => "todo undo|u [-n <TASK_NUMBER>] [<TASK>]",
+			:clear => "todo clear [-a]",
+			:remove => "todo remove|rm <LIST NAME>",
+			:set => "todo set|s [-p {high, medium, low}] [-n <TASK_NUMBER>] [<TASK>]"
 		}
 
 		# Displays the list in a human readable form:
@@ -34,11 +50,18 @@ module Todo
 		def display
 			tasks = DATABASE[:Tasks].join(:Task_list, :Tasks__id => :Task_list__Task_id).join(
 				:Lists, :Lists__id => :Task_list__List_id).select(:Tasks__Task_number, :Tasks__Name, 
-				:Tasks__Completed).filter(:Lists__Name => Config[:working_list_name])
-			tasks = tasks.order(:Task_number)
+				:Tasks__Completed, :Tasks__Priority).filter(:Lists__Name => Config[:working_list_name])
+			tasks = OPTIONS[:sort] == "n" ? tasks.order(:Task_number) : tasks.order(:Priority, :Task_number)
 			list = DATABASE[:Lists][:Name=>Config[:working_list_name]]
 			count = list.nil? ? 0 : list[:Total]
 			completed_count = tasks.filter(:Completed=>1).count
+
+			priority = {
+				0 => "**",
+				1 => "*",
+				2 => ""
+			}
+			#print out the header
 			Config[:width].times do 
 				print "*".colorize(:light_red)
 			end
@@ -52,23 +75,29 @@ module Todo
 			end
 			puts
 			puts
+
+			#prints out incomplete tasks
 			puts "Todo:".colorize(:light_green)
 			tasks.each do |task|
 				next if task[:Completed] == 1
-				printf "%4d. ".to_s.colorize(:light_yellow), task[:Task_number] 
-				split_v = split task[:Name], Config[:width] - 6
+				printf "%2s".colorize(:light_magenta), priority[task[:Priority]]
+				printf "%3d. ".colorize(:light_yellow), task[:Task_number] 
+				split_v = split task[:Name], Config[:width] - 7
 				puts split_v[0]
 				split_v.shift
 				split_v.each do |line|
 					printf "      %s\n", line
 				end
 			end
+
+			#Prints out complete tasks
 			print "\nCompleted:".colorize(:light_green)
 			printf "%#{Config[:width]+4}s\n", "#{completed_count}/#{count}".colorize(:light_cyan)
 			tasks.each do |task|
 				next if task[:Completed] == 0
-				printf "%4d. ".to_s.colorize(:light_yellow), task[:Task_number]
-				split_v = split task[:Name], Config[:width]-6
+				printf "%2s".colorize(:light_magenta), priority[task[:Priority]]
+				printf "%3d. ".to_s.colorize(:light_yellow), task[:Task_number]
+				split_v = split task[:Name], Config[:width]-7
 				puts split_v[0]
 				split_v.shift
 				split_v.each do |line|
@@ -83,26 +112,82 @@ module Todo
 			OptionParser.new do |opts|
 				version_path = File.expand_path("../../VERSION", File.dirname(__FILE__))
 				opts.version = File.exist?(version_path) ? File.read(version_path) : ""
-				opts.banner = "Usage: todo [COMMAND] [option] [arguments]"
-				opts.separator "Commands:"
-				opts.separator "    create, switch <list name>       creates a new list or switches to an existing one"
-				opts.separator "    <blank>, display, d              displays the current list"
-				opts.separator "    add, a <task>                    adds the task to the current list"
-				opts.separator "    finish, f [option] <task>        marks the task as completed"
-				opts.separator "    undo, u [option] <task>          undos a completed task"
-				opts.separator "    clear [option]                   clears completed tasks"
-				opts.separator "    remove, rm <list name>           removes the list completely (cannot undo)"
-				opts.separator "Options: "
-				opts.on('-n', 'with finish or undo, references a task by its number') do
+				opts.banner = "Todo: A simple command line todo application\n\n".colorize(:light_green) +
+				"    usage:".colorize(:light_cyan) + " todo [COMMAND] [option] [arguments]".colorize(:light_red)
+				opts.separator ""
+				opts.separator "Commands:".colorize(:light_green)
+
+				#todo create, switch
+				opts.separator "  *".colorize(:light_cyan)  + " create, switch".colorize(:light_yellow) +  " creates a new list or switches to an existing one".colorize(:light_magenta)
+				opts.separator "    usage: ".colorize(:light_cyan) + USAGE[:create].colorize(:light_red)
+				
+				# todo display, d
+				opts.separator ""
+				opts.separator "  *".colorize(:light_cyan)  + " display, d".colorize(:light_yellow) +  " displays the current list".colorize(:light_magenta)
+				opts.separator "    usage: ".colorize(:light_cyan) + USAGE[:display].colorize(:light_red)
+				opts.on('-s TYPE', [:p, :n], "sorts the task by ") do |s|
+					OPTIONS[:sort] = s
+				end
+
+				#todo add, a
+				opts.separator ""
+				opts.separator "  *".colorize(:light_cyan)  + " add, a".colorize(:light_yellow) +  " adds the task to the current list".colorize(:light_magenta)
+				opts.separator "    usage: ".colorize(:light_cyan) + USAGE[:add].colorize(:light_red)
+				opts.on('-p PRIORITY', ["high", "medium", "low"], 'set the priority of the task to one of the following.\n' + 
+				'                                                    Default is medium') do |p|
+					priorities = {
+						"high" => 0,
+						"medium" => 1,
+						"low" => 2
+					}
+					OPTIONS[:change_priority] = true
+					OPTIONS[:priority] = priorities[p]
+				end
+
+				#todo finish, f
+				opts.separator ""
+				opts.separator "  *".colorize(:light_cyan)  + " finish , f".colorize(:light_yellow) +  " marks a task as finished".colorize(:light_magenta)
+				opts.separator "    usage: ".colorize(:light_cyan) + USAGE[:finish].colorize(:light_red)
+				opts.on('-n',  'references a task by its number') do |n|
 					OPTIONS[:is_num] = true
 				end
-				opts.on('-a', 'with clear, resets the entire list') do
+
+				#todo undo, u
+				opts.separator ""
+				opts.separator "  *".colorize(:light_cyan)  + " undo, u".colorize(:light_yellow) +  " undos a completed task".colorize(:light_magenta)
+				opts.separator "    usage: ".colorize(:light_cyan) + USAGE[:undo].colorize(:light_red)
+				opts.separator "    -n                               references a task by its number"
+
+				#todo clear
+				opts.separator ""
+				opts.separator "  *".colorize(:light_cyan)  + " clear".colorize(:light_yellow) +  " clears a completed tasks".colorize(:light_magenta)
+				opts.separator "    usage: ".colorize(:light_cyan) + USAGE[:clear].colorize(:light_red)
+				opts.on('-a', 'resets the entire list') do
 					OPTIONS[:clear_all] = true
 				end
+
+				#todo remove, rm
+				opts.separator ""
+				opts.separator "  *".colorize(:light_cyan)  + " remove, rm".colorize(:light_yellow) +  " removes the list completely.".colorize(:light_magenta)
+				opts.separator "    usage: ".colorize(:light_cyan) + USAGE[:remove].colorize(:light_red)
+
+				#todo set, s
+				opts.separator ""
+				opts.separator "  *".colorize(:light_cyan) + " set, s".colorize(:light_yellow) + " adds additional information to a task".colorize(:light_magenta)
+				opts.separator "    usage: ".colorize(:light_cyan) + USAGE[:set].colorize(:light_red)
+				opts.separator "    -p TYPE                          set the priority of the task to one of the following.\n" + 
+				"                                     Default is medium"
+				opts.separator "    -n                               references a task by its number"
+
+				opts.separator ""
+				opts.separator "Other Options: ".colorize(:light_green)
+
+				#todo -h
 				opts.on('-h', '--help', 'displays this screen' ) do
 					puts opts
 					exit
 				end
+				#todo -w
 				opts.on('-w', "displays the name of the current list") do
 					if Config[:working_list_exists]
 						puts "Working list is #{Config[:working_list_name]}"
@@ -112,6 +197,7 @@ module Todo
 					end
 					exit
 				end
+
 			end
 		end
 
@@ -124,7 +210,7 @@ module Todo
 						display 
 					else
 						puts "Working List does not exist yet.  Please create one"
-						puts "todo create <list name>"
+						puts "Usage: #{USAGE[:create]}"
 					end
 				when "create", "switch"
 					if ARGV.count > 0
@@ -135,34 +221,34 @@ module Todo
 						puts
 						display
 					else
-						puts "Usage: todo #{ARGV[0]} <listname>"
+						puts "Usage: #{USAGE[:create]}"
 					end		
 				when "add", "a"
 					if Config[:working_list_exists]
-						ARGV.count > 1 ? Tasks.add(ARGV[1..-1].join(' ')) : puts("Usage: todo add <task name>")
+						ARGV.count > 1 ? Tasks.add(ARGV[1..-1].join(' '), OPTIONS[:priority]) : puts("Usage: #{USAGE[:add]}")
 						puts
 						display 
 					else
 						puts "Working List does not exist yet.  Please create one"
-						puts "todo create <list name>"
+						puts "Usage: #{USAGE[:create]}"
 					end
 				when "finish", "f"
 					if Config[:working_list_exists]
-						ARGV.count > 1 ? Tasks.finish(ARGV[1..-1].join(' '), OPTIONS[:is_num]) : puts("Usage: todo finish <task name>")
+						ARGV.count > 1 ? Tasks.finish(ARGV[1..-1].join(' '), OPTIONS[:is_num]) : puts("Usage: #{USAGE[:finish]}")
 						puts
 						display 
 					else
 						puts "Working List does not exist yet.  Please create one"
-						puts "todo create <list name>"
+						puts "Usage: #{USAGE[:create]}"
 					end
 				when "undo", "u"
 					if Config[:working_list_exists]
-						ARGV.count > 1 ? Tasks.undo(ARGV[1..-1].join(' '), OPTIONS[:is_num]) : puts("Usage: todo undo <task name>")
+						ARGV.count > 1 ? Tasks.undo(ARGV[1..-1].join(' '), OPTIONS[:is_num]) : puts("Usage: #{USAGE[:undo]}")
 						puts
 						display 
 					else
 						puts "Working List does not exist yet.  Please create one"
-						puts "todo create <list name>"
+						puts "Usage: #{USAGE[:create]}"
 					end
 				when "clear"
 					if Config[:working_list_exists]
@@ -171,14 +257,28 @@ module Todo
 						display
 					else
 						puts "Working List does not exist yet.  Please create one"
-						puts "todo create <list name>"
+						puts "Usage: #{USAGE[:create]}"
 					end	
 				when "remove", "r"
 					if ARGV.count > 1
 						Tasks.clear true, ARGV[1..-1].map{|word| word.capitalize}.join(' ')
 					else 
-						puts "Usage todo remove <list name>"
+						puts "Usage: #{USAGE[:remove]}"
 					end
+				when "set", "s"
+					if Config[:working_list_exists]
+						if ARGV.count > 1
+							if OPTIONS[:change_priority]
+								Tasks.set_priority OPTIONS[:priority], ARGV[1..-1].join(' '), OPTIONS[:is_num]
+							end
+							display
+						else 
+							puts "Usage: #{USAGE[:set]}"
+						end
+					else
+						puts "Working List does not exist yet.  Please create one"
+						puts "Usage: #{USAGE[:create]}"
+					end	
 				else
 					puts "Invalid command.  See todo -h for help."
 				end
@@ -187,7 +287,7 @@ module Todo
 					display 
 				else
 					puts "Working List does not exist yet.  Please create one"
-					puts "todo create <list name>"
+					puts "Usage: #{USAGE[:create]}"
 				end
 			end
 		end
@@ -198,7 +298,7 @@ module Todo
 			begin
 				optparse.parse!
 				commands_parser
-			rescue OptionParser::InvalidOption => e
+			rescue OptionParser::InvalidOption, OptionParser::InvalidArgument => e
 				puts "#{e}. See todo -h for help."
 			end
 		end
@@ -239,5 +339,4 @@ module Todo
 		end
 
 	end
-end
-
+end

data/lib/to-do/dbmigrations/003_priorities.rb

@@ -0,0 +1,7 @@
+require 'sequel'
+
+Sequel.migration do
+	change do 
+		add_column :Tasks, :Priority, :Integer, :default=>1
+	end
+end

data/lib/to-do/tasks.rb

@@ -3,21 +3,24 @@ module Todo
 	# The module that contains methods for manipulating the database
 	module Tasks
 		extend self
+
+		# The Database
 		DATABASE = Sequel.sqlite Todo::Config[:task_database]
 
 		# Adds the tast to the list
 		# 
 		# @param [String] task the task to add to the list
-		def add task
+		# @param [Integer] priority the priority of the task
+		def add task, priority=1
 			list = DATABASE[:Lists].select(:Total, :Id)[:Name=>Todo::Config[:working_list_name]]
 			if !list
 				DATABASE[:Lists] << {:Name => Config[:working_list_name], :Total => 0}
 				list = DATABASE[:Lists].select(:Total, :Id)[:Name=>Todo::Config[:working_list_name]]
 			end
 			count = list[:Total]+1
-			DATABASE[:Tasks] << {:Task_number => count, :Name => task, :Completed => 0}
+			DATABASE[:Tasks] << {:Task_number => count, :Name => task, :Completed => 0, :Priority => priority}
 			list_id = list[:Id]
-			task_id = DATABASE[:Tasks][:Name=>task][:Id]
+			task_id = DATABASE[:Tasks].with_sql("SELECT last_insert_rowid() FROM Tasks")
 			DATABASE[:Task_list] << {:Task_id => task_id, :List_id => list_id}
 			DATABASE[:Lists].filter(:Id => list_id).update(:Total => count)
 		end
@@ -103,5 +106,33 @@ module Todo
 				end
 			end
 		end
+
+		# Sets the priority of a task
+		# 
+		# @param priority [Integer] the new priority
+		# @param tasks either a task number or a task name to change the priority of 
+		# @param [Bool] is_num if the task param represents the task number, true. 
+		# false if it is the task name
+		def set_priority priority, task, is_num
+			list_id = DATABASE[:Lists][:Name => Config[:working_list_name]][:Id]
+			names =DATABASE[:Tasks].join(:Task_list, :Tasks__Id => :Task_list__Task_Id).join(
+				:Lists, :Lists__Id => :Task_list__List_id).select(:Tasks__Id, :Tasks__Task_number, 
+				:Tasks__Name).filter(:Lists__Name => Config[:working_list_name])
+			if is_num
+				found_task = names[:Task_number => task]
+				if found_task
+					DATABASE[:Tasks].filter(:Id => found_task[:Id]).update(:Priority => priority)
+				else
+					puts "Task ##{task} is not in the list."
+				end
+			else
+				found_task = names.with_sql("SELECT * FROM :table WHERE Name = :task COLLATE NOCASE",:table=>names, :task=>task).first
+				if found_task
+					DATABASE[:Tasks].filter(:Id => found_task[:Id]).update(:Priority => priority)
+				else
+					puts "Task '#{task}' is not in the list."
+				end
+			end
+		end
 	end	
 end

data/to-do.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "to-do"
-  s.version = "1.2.7"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristen Mills"]
-  s.date = "2012-07-27"
+  s.date = "2012-07-30"
   s.description = "A simple command line todo application"
   s.email = "kristen@kristen-mills.com"
   s.executables = ["todo"]
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "lib/to-do/config.rb",
     "lib/to-do/dbmigrations/001_create_tables.rb",
     "lib/to-do/dbmigrations/002_rename_name_column.rb",
+    "lib/to-do/dbmigrations/003_priorities.rb",
     "lib/to-do/old/list.rb",
     "lib/to-do/tasks.rb",
     "test/helper.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: to-do
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70314823379720 !ruby/object:Gem::Requirement
+  requirement: &70152148957820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70314823379720
+  version_requirements: *70152148957820
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70314823378420 !ruby/object:Gem::Requirement
+  requirement: &70152148957040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70314823378420
+  version_requirements: *70152148957040
 - !ruby/object:Gem::Dependency
   name: sequel
-  requirement: &70314823376420 !ruby/object:Gem::Requirement
+  requirement: &70152148972400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '3.12'
   type: :runtime
   prerelease: false
-  version_requirements: *70314823376420
+  version_requirements: *70152148972400
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70314823405820 !ruby/object:Gem::Requirement
+  requirement: &70152148971900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70314823405820
+  version_requirements: *70152148971900
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70314823404800 !ruby/object:Gem::Requirement
+  requirement: &70152148971240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *70314823404800
+  version_requirements: *70152148971240
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70314823403820 !ruby/object:Gem::Requirement
+  requirement: &70152148970480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70314823403820
+  version_requirements: *70152148970480
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &70314823402360 !ruby/object:Gem::Requirement
+  requirement: &70152148969680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70314823402360
+  version_requirements: *70152148969680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70314823401780 !ruby/object:Gem::Requirement
+  requirement: &70152148968700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314823401780
+  version_requirements: *70152148968700
 description: A simple command line todo application
 email: kristen@kristen-mills.com
 executables:
@@ -121,6 +121,7 @@ files:
 - lib/to-do/config.rb
 - lib/to-do/dbmigrations/001_create_tables.rb
 - lib/to-do/dbmigrations/002_rename_name_column.rb
+- lib/to-do/dbmigrations/003_priorities.rb
 - lib/to-do/old/list.rb
 - lib/to-do/tasks.rb
 - test/helper.rb
@@ -141,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2924756363788007628
+      hash: -4015950886949104978
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: