to-do 1.1.2 → 1.2.0

data/Gemfile

@@ -7,8 +7,12 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 gem "shoulda", ">= 0"
 gem "rdoc", "~> 3.12"
+
 gem "bundler", "~> 1.0.0"
 gem "jeweler", "~> 1.8.4"
 gem "simplecov", ">= 0"
 gem "colorize", ">= 0"
 
+group :development do
+  gem "yard", ">= 0"
+end

data/README.md

@@ -1,16 +1,12 @@
-#to-do 1.1.2
+#to-do 1.2
 
 A simple command line todo application.
 
-##What's new in 1.1.2
-* Bug fixes
 
-##What's new in 1.1
-* Command shortcuts
-* Undo completing an item
-* Colored Display
-* Display list more often
-* Bug fixes
+##What's new in 1.2
+* Remove a list
+* Better usage messages
+* Better documentation using YARD
 
 ##Install
 	gem install to-do
@@ -24,6 +20,7 @@ A simple command line todo application.
 * Display list
 * Colored display
 * Undo completing
+* Removelists
 
 ##How to Use
 
@@ -34,7 +31,7 @@ A simple command line todo application.
 
 ###Add some tasks to the current list
 
-	todo add Cook dinner
+	todo add Cook Dinner
 	todo add Write Paper
 	todo a Do Laundy
 	todo a Clean Things
@@ -45,7 +42,7 @@ A simple command line todo application.
 	todo d
 
 	********************************
-	*       My New Todo List       *
+	        My New Todo List       
 	********************************
 
 	1. Cook Dinner
@@ -60,7 +57,7 @@ A simple command line todo application.
 	todo f Clean Things
 
 	********************************
-	*       My New Todo List       *
+	        My New Todo List       
 	********************************
 
 	    1. Cook Dinner
@@ -82,20 +79,28 @@ A simple command line todo application.
 
 	todo clear -a
 
+###Delete a list
+
+	todo remove My New Todo List
+	todo rm My Existing list
+
 ###View usage details
 
 	todo -h
 	todo --help
 
-###View verison
+###View version
 	todo -v
 	todo --version
 
 ##Future Plans
-* Delete list
 * Tags
 * Due Dates
 * Tab Completion
+* YAML Record
+* Sorting
+* Priorites
+* Reorganizing
 
 ##Contributing to to-do
 

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

data/lib/to-do/cli.rb

@@ -1,17 +1,40 @@
 require 'optparse'
 require 'yaml'
 require 'colorize'
-$data = ENV["HOME"]+"/.todo/lists/"
-$settings = ENV["HOME"]+"/.todo/config.yml"
 
-module Todo
-	module CLI
+module Todo 
+	# CLI is the module that contains the methods to display the list as well as
+	# the methods to parse command line arguments.
+	module CLI 
 		extend self
-		# Displays the given todo list
-		WORKING_LIST=YAML.load_file(File.join(Config[:lists_directory],
-			Config[:working_list_name]+'.yml')) if File.exists?(File.join(Config[:lists_directory],
-			Config[:working_list_name]+'.yml'))
+		WORKING_LIST =  ""
+		if File.exists?(File.join(Config[:lists_directory], Config[:working_list_name]+'.yml'))
+			# The current working list
+			WORKING_LIST=YAML.load_file(File.join(Config[:lists_directory], Config[:working_list_name]+'.yml'))
+		end
+
+		# The option flags 
+		OPTIONS = {
+			:is_num => false, 
+			:clear_all => false
+		}
 
+		# Displays the list in a human readable form:
+		#
+		# @example 
+		#     ********************************
+		#               List name
+		#     ********************************
+		# 
+		#      Todo:
+		#         1. Task 1
+		#         2. Task 2
+		#
+		#      Completed:                  2/4
+		#        3. Task 3
+		#        4. Task 4
+		#
+		# @param [List] list the list you want to display.
 		def display list = WORKING_LIST
 			puts "********************************".colorize(:light_red)
 			puts list.name.center(32).colorize(:light_cyan)
@@ -31,13 +54,9 @@ module Todo
 			puts
 		end
 
-		#use option parser to parse command line arguments
-		def parse
-			options = {
-					:is_num => false,
-					:clear_all => false
-				}
-			optparse = OptionParser.new do |opts|
+		# Helper method for parsing the options using OptionParser
+		def option_parser
+			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]"
@@ -47,36 +66,60 @@ module Todo
 				opts.separator "    finish, f [option] <task>        marks the task as completed"
 				opts.separator "    clear [option]                   clears completed tasks"
 				opts.separator "    undo, u [option] <task>          undos a completed task"
-				opts.separator "    create, switch <list_name>       creates a new list or switches to an existing one"
+				opts.separator "    create, switch <list name>       creates a new list or switches to an existing one"
+				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
-					options[:is_num] = true
+					OPTIONS[:is_num] = true
 				end
 				opts.on('-a', 'with clear, resets the entire list') do
-					options[:clear_all] = true
+					OPTIONS[:clear_all] = true
 				end
 				opts.on('-h', '--help', 'displays this screen' ) do
 					puts opts
-					return
+					exit
 				end
 				opts.on('-w', "displays the name of the current list") do
 					puts "Working list is #{WORKING_LIST.name}"
-					return
+					exit
 				end
 			end
-			optparse.parse!
+		end
+
+		# Helper method for parsing commands.
+		def commands_parser
 			if ARGV.count > 0
 				case ARGV[0]
 				when "add", "a"
-					ARGV.count > 1 ? WORKING_LIST.add(ARGV[1..-1].join(' ')) : puts("Invalid Command")
-					self.display 
+					if Config[:working_list_exists]
+						ARGV.count > 1 ? WORKING_LIST.add(ARGV[1..-1].join(' ')) : puts("Usage: todo add <task name>")
+						display 
+					else
+						puts "Working List does not exist yet.  Please create one"
+						puts "todo create <list name>"
+					end
 				when "finish", "f"
-					WORKING_LIST.finish ARGV[1..-1].join(' '), options[:is_num]
-					self.display 
+					if Config[:working_list_exists]
+						WORKING_LIST.finish ARGV[1..-1].join(' '), OPTIONS[:is_num]
+						display 
+					else
+						puts "Working List does not exist yet.  Please create one"
+						puts "todo create <list name>"
+					end
 				when "clear"
-					WORKING_LIST.clear options[:clear_all]
+					if Config[:working_list_exists]
+						WORKING_LIST.clear OPTIONS[:clear_all]
+					else
+						puts "Working List does not exist yet.  Please create one"
+						puts "todo create <list name>"
+					end
 				when "display", "d"
-					self.display 
+					if Config[:working_list_exists]
+						display 
+					else
+						puts "Working List does not exist yet.  Please create one"
+						puts "todo create <list name>"
+					end
 				when "create", "switch"
 					if File.exists?(File.join(Config[:lists_directory], ARGV[1..-1].join('_').downcase + '.yml'))
 						Config[:working_list_name] = ARGV[1..-1].join('_').downcase
@@ -84,24 +127,45 @@ module Todo
 						new_list = YAML.load_file(File.join(Config[:lists_directory], 
 						Config[:working_list_name]+'.yml')) if File.exists?(File.join(Config[:lists_directory], 
 						Config[:working_list_name]+'.yml'))
-						self.display new_list
+						display new_list
 					else 
-						ARGV.count > 1 ? List.new(ARGV[1..-1].join(' ')) : puts("Invalid Command")
+						ARGV.count > 1 ? List.new(ARGV[1..-1].join(' ')) : puts("Usage: todo create <list_name> ")
 						new_list = YAML.load_file(File.join(Config[:lists_directory], 
 						Config[:working_list_name]+'.yml')) if File.exists?(File.join(Config[:lists_directory], 
 						Config[:working_list_name]+'.yml'))
-						self.display new_list
+						display new_list
 					end
 				when "undo", "u"
-					WORKING_LIST.undo ARGV[1..-1].join(' '), options[:is_num]
-					self.display 
+					if Config[:working_list_exists]
+						WORKING_LIST.undo ARGV[1..-1].join(' '), OPTIONS[:is_num]
+					display 
+					else
+						puts "Working List does not exist yet.  Please create one"
+						puts "todo create <list name>"
+					end
+				when "remove", "r"
+					if ARGV.count > 1
+						List.remove ARGV[1..-1].join(' ')
+					end
 				else
-					puts "Invalid Command"
+					puts "Invalid command.  See todo -h for help."
 				end
 			else
-				#if no ARGs are given, do what "display" would do
-				self.display 
+				if Config[:working_list_exists]
+					display 
+				else
+					puts "Working List does not exist yet.  Please create one"
+					puts "todo create <list name>"
+				end
 			end
 		end
+
+		# Parses the commands and options
+		def parse
+			optparse = option_parser
+			optparse.parse!
+			commands_parser
+		end
+
 	end
 end

data/lib/to-do/config.rb

@@ -1,29 +1,47 @@
 require 'yaml'
-# The module that monitors the config.
-# similar to SSam Goldstein's config.rb for time trap
-# https://github.com/samg/timetrap/
+
 module Todo
+	# The module that contains the methods relevant to configurations and custom
+	# configuration in config.yml
+	#
+	# similar to Sam Goldstein's config.rb for timetrap
+	# @see https://github.com/samg/timetrap/
 	module Config
 		extend self
+		# The path to the the config file
 		PATH = File.join(ENV['HOME'], '.to-do', 'config.yml')
 
-		#default values
+		# Default config key value pairs
+		#
+		# @return [Hash<Symbol,Object>] the default configurations in a hash
 		def defaults
 			{
 				# the location of all all your list yaml files
 				:lists_directory => File.join(ENV["HOME"],".to-do","lists"),
 				# the current working list
-				:working_list_name => "default_list"
+				:working_list_name => "default_list", 
+				# does the working list actually exist
+				:working_list_exists => false
 			}
 		end
 
-		#accessor for values in the config
+		# Overloading [] operator
+		#
+		# Accessor for values in the config
+		#
+		# @param [Symbol] key the key in the config hash
+		# @return [Object] the value associated with that key
 		def [] key
 			fileval = YAML.load_file PATH
 			defaults.merge(fileval)[key]
 		end
 
-		#setter for keys in config
+		# Overloading []= operator
+		#
+		# Setter for values in the Config hash
+		# 
+		# @param [Symbol] key the key you are setting a value for
+		# @param [Object] value the value you associated with the key 
 		def []= key, value
 			fileval = YAML.load_file PATH
 			configs = defaults.merge(fileval)
@@ -33,7 +51,7 @@ module Todo
 			end
 		end
 
-		#writes the config file path
+		# Writes the configs to the file config.yml
 		def write
 			configs = if File.exist? PATH
 				defaults.merge(YAML.load_file PATH)

data/lib/to-do/list.rb

@@ -1,11 +1,15 @@
 require 'yaml'
 require File.join(File.dirname(__FILE__), 'config')
-
+require 'fileutils'
 module Todo
+
+	# The Class that represents a list of tasks
 	class List
 		attr_accessor :tasks, :completed_tasks, :count, :completed_count, :name
 
-		#Create a new list
+		# Creates a new list and sets it to be the working list
+		# 
+		# @param [String] name the name of the list
 		def initialize name
 			@tasks = Hash.new
 			@completed_tasks = Hash.new
@@ -17,11 +21,12 @@ module Todo
 			end
 			update
 			Config[:working_list_name] = name.downcase.gsub(/ /, '_')
+			Config[:working_list_exists] = true
 			Config.write
 			puts "Created List #{name}."
 		end
 
-		# updates the yaml
+		# Updates the yaml file
 		def update
 			path = File.join(Config[:lists_directory], @name.downcase.gsub(/ /, '_') +'.yml')
 			File.open(path, 'w') do |fh|
@@ -29,7 +34,9 @@ module Todo
 			end
 		end
 
-		# adds the tast to the list
+		# Adds the tast to the list
+		# 
+		# @param [String] task the task to add to the list
 		def add task
 			@count+=1
 			@tasks[@count] = task
@@ -38,7 +45,12 @@ module Todo
 		end
 
 		# finish the task. task is either a case insensitive task on the list or
-		# the task number
+		# the task number. Prints out either the task is not in the list or that i
+		# succesfully finished the task
+		#
+		# @param task either a task number or task name to finish
+		# @param [Bool] is_num if the task param represents the task number, true. 
+		# false if it is the task name
 		def finish task, is_num
 			if is_num
 				if !@tasks[task.to_i].nil?
@@ -69,6 +81,13 @@ module Todo
 			update
 		end
 
+		# undos finishing a task. task is either a case insensitive task on the list or
+		# the task number. Prints out either the task is not in the list or that i
+		# succesfully undoed finished the task
+		#
+		# @param task either a task number or task name to finish
+		# @param [Bool] is_num if the task param represents the task number, true. 
+		# false if it is the task name
 		def undo task, is_num
 			if is_num
 				if !@completed_tasks[task.to_i].nil?
@@ -99,13 +118,16 @@ module Todo
 			update
 		end
 
-		#clears the completed tasks
+		# clears just the completed tasks
 		def clear_completed
 			@completed_tasks = Hash.new
 			update
 		end
 
-		#clears all of the tasks and resets the count to 0
+		# clears the task in the list 
+		# 
+		# @param [Bool] clear_all if true, clears all completed and uncompleted tasks
+		# and resets the count. if false, just clears the completed tasks
 		def clear clear_all
 			clear_completed
 			if clear_all
@@ -118,6 +140,22 @@ module Todo
 			end
 			update
 		end
+
+		# Class method that removes a list from the your lists.
+		# 
+		# @param [string] name name of the list that you are trying to remove
+		def self.remove name
+			underscore_name = name.downcase.gsub(/ /, '_')
+			begin
+				FileUtils.rm File.join(Config[:lists_directory], underscore_name +'.yml')
+				puts "Removed list #{name}"
+			rescue
+				puts "List doesn't exist"
+			end
+			if underscore_name == Config[:working_list_name]
+				Config[:working_list_exists] = false
+			end
+		end
 	end
 end
 

data/lib/to-do.rb

@@ -1,9 +1,15 @@
+require 'rdoc'
 require File.join(File.dirname(__FILE__), 'to-do', 'config')
 require File.join(File.dirname(__FILE__), 'to-do', 'list')
 if !File.exists?(File.join(ENV['HOME'], '.to-do'))
 	Dir.mkdir(File.join(ENV['HOME'], '.to-do'))
 	Todo::Config.write
 	Dir.mkdir(Todo::Config[:lists_directory])
-	Todo::List.new "Default List"
+	#Todo::List.new "Default List"
 end
 require File.join(File.dirname(__FILE__), 'to-do', 'cli')
+
+# Todo is the main namespace that all of the other modules and classes are a 
+# part of
+module Todo
+end

data/test/test_to-do.rb

@@ -65,7 +65,7 @@ class TestToDo < Test::Unit::TestCase
 		end
 
 		teardown do
-			#remove list when I create that functionality
+			Todo::List.remove "Test List"
 			Todo::Config[:working_list_name] = @list_name
 		end
 	end

data/to-do.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "to-do"
-  s.version = "1.1.2"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristen Mills"]
-  s.date = "2012-07-14"
+  s.date = "2012-07-15"
   s.description = "A simple command line todo application"
   s.email = "kristen@kristen-mills.com"
   s.executables = ["todo"]
@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
@@ -50,6 +49,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_runtime_dependency(%q<simplecov>, [">= 0"])
       s.add_runtime_dependency(%q<colorize>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
@@ -57,6 +57,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<colorize>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 0"])
@@ -65,6 +66,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<colorize>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: to-do
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-14 00:00:00.000000000 Z
+date: 2012-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70122750458400 !ruby/object:Gem::Requirement
+  requirement: &70154354563460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70122750458400
+  version_requirements: *70154354563460
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70122750457900 !ruby/object:Gem::Requirement
+  requirement: &70154354562980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :runtime
   prerelease: false
-  version_requirements: *70122750457900
+  version_requirements: *70154354562980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70122750457400 !ruby/object:Gem::Requirement
+  requirement: &70154354562500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70122750457400
+  version_requirements: *70154354562500
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70122750456700 !ruby/object:Gem::Requirement
+  requirement: &70154354586060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *70122750456700
+  version_requirements: *70154354586060
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70122750455960 !ruby/object:Gem::Requirement
+  requirement: &70154354585580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70122750455960
+  version_requirements: *70154354585580
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &70122750455260 !ruby/object:Gem::Requirement
+  requirement: &70154354585100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70122750455260
+  version_requirements: *70154354585100
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70154354584620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70154354584620
 description: A simple command line todo application
 email: kristen@kristen-mills.com
 executables:
@@ -88,7 +99,6 @@ extra_rdoc_files:
 files:
 - .document
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -116,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3550105451253750040
+      hash: 3446128004627456738
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/Gemfile.lock

@@ -1,35 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    colorize (0.5.8)
-    git (1.2.5)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.3)
-    multi_json (1.3.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    shoulda (3.0.1)
-      shoulda-context (~> 1.0.0)
-      shoulda-matchers (~> 1.0.0)
-    shoulda-context (1.0.0)
-    shoulda-matchers (1.0.0)
-    simplecov (0.6.4)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  colorize
-  jeweler (~> 1.8.4)
-  rdoc (~> 3.12)
-  shoulda
-  simplecov