mmtodo 1.0.0

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (C) 2012 Mike Mitrovich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,3 @@
+A simple command line todo app.
+Created to help me learn some ruby concepts.
+

data/bin/mmtodo

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+
+require_relative '../lib/mm_todo/todo_app.rb'
+
+
+myapp = MMToDo::ToDoApp.instance
+
+myapp.start# ["test"]

data/lib/mm_todo/todo_app.rb

@@ -0,0 +1,97 @@
+require 'singleton'
+require_relative 'todo_list'
+
+module MMToDo
+	class ToDoApp
+		include Singleton
+
+		attr_reader :file
+
+		def start (params=ARGV, dest = STDOUT)
+			check_params(params,dest)
+			@file = params.shift
+			@list = ToDoList.new @file
+			#@list.load if File.exist? File.join(File.dirname(__FILE__), '\..\bin\\' + @file + '.save')
+			@list.load if File.exist? File.join(File.expand_path("../../bin/", File.dirname(__FILE__)), @file + '.save')
+			@status = :menu
+			app_loop()
+		end
+
+		def check_params(params, dest)
+			unless params.size == 1
+			  puts "Wrong number of arguments."
+			  puts "Usage: ruby todo.rb list_name\n"
+			  exit
+			end
+		end
+
+		def app_loop
+			while @status != :quit
+				case @input
+				when "q","Q"
+					@status = :quit
+				when "a", "A"
+					add_item
+				when "d", "D"
+					mark_done
+				when "p", "P"
+					purge_done
+				else 
+					main_menu
+				end
+			end
+		end
+
+		def main_menu
+			@list.show_all
+			puts @error
+			@error = nil
+			puts "[Commands: q=quit, a=add, d=mark done, p=purge done items]"
+			@input = $stdin.gets.chomp
+		end
+
+		def add_item
+			@input.clear
+			puts "Description (leave blank to cancel):"
+			desc = $stdin.gets.chomp
+			@list.add desc
+			@error = "(Added: #{desc})"
+		end
+
+		def mark_done
+			@input.clear
+			puts "Which number?"
+			selection = $stdin.gets.chomp
+			check_selection(selection)
+		end
+
+		def check_selection(selection)
+			if selection !~ /^\d+$/
+				@error = "[Invalid selection] Just the number, please."
+				return
+			elsif selection.to_i == 0 || selection.to_i > @list.size
+				@error = "[Invalid selection] No todo with that number."
+				return
+			end
+			
+			index = selection.to_i
+			@error = "(Item completed: #{@list.select(index)})"
+			@list.select(index).do
+		end
+
+		def purge_done
+			@input.clear
+			puts "Are you sure?(y/n)"
+			answer = $stdin.gets.chomp
+			case answer
+			when "y", "Y"
+				@list.purge_done
+				@error = "(Done items purged)"
+			else
+				@error = "(purge cancelled)"
+			end
+		end
+
+	end
+end
+

data/lib/mm_todo/todo_item.rb

@@ -0,0 +1,18 @@
+
+module MMToDo
+	class ToDoItem
+
+		def initialize(desc, parent)
+			@description = desc
+			@parent_list = parent
+		end
+
+		def to_s
+			return @description
+		end
+
+		def do 
+			@parent_list.mark_done(self)
+		end
+	end
+end

data/lib/mm_todo/todo_list.rb

@@ -0,0 +1,94 @@
+require_relative 'todo_item'
+
+
+module MMToDo
+
+	class ToDoList
+		def initialize(save_file="unnamed")
+			@list = []
+			@done = []
+			#@save_file = File.join(File.dirname(__FILE__), '\..\bin\\' + @save_file + '.save')
+			@save_file = File.join(File.expand_path("../../bin/", File.dirname(__FILE__)), save_file + '.save')
+		end
+
+		def save
+			File.open(@save_file, 'w') {|f| f.write Marshal.dump([@list,@done]) }
+		end
+
+		def load
+			@list,@done = Marshal.load(File.read(@save_file))
+		end
+
+		def add(todo = "")
+			raise if todo =~ /^\s*$/
+			@list.push ToDoItem.new(todo, self)
+			save
+			rescue
+				puts "[Empty todo not added...]"
+		end
+
+		def size
+			return @list.size
+		end
+
+		def empty?
+			return @list.empty?
+		end
+
+		def show_todos(dest = STDOUT)
+			@list.each_index {|index| dest.puts "#{index + 1}. #{@list[index]}"}
+		end
+
+		def show_done(dest = STDOUT)
+			@done.each {|item| dest.puts item}
+		end
+
+		def select(index)
+			return @list[index - 1]
+		end
+
+		def mark_done(item)
+			@done.push item
+			@list.delete item
+			save
+		end
+
+	def show_all(dest = STDOUT)
+		puts "TODO:"
+		puts "=========="
+		show_todos
+		puts "\n\nDone:"
+		puts "=========="
+		show_done
+		puts "\n\n\n"
+	end
+
+	def purge_done
+		@done = []
+		save
+	end
+end
+end
+
+if __FILE__ == $0
+mylist = ToDoList.new
+
+mylist.add("feed the fish")
+mylist.add("go shopping")
+mylist.add("wash dishes")
+mylist.add "   "
+
+mylist.select(2).do
+
+mylist.show_all
+
+mylist.purge_done
+mylist.show_all
+
+File.open('mylist.save', 'w') {|f| f.write Marshal.dump(mylist) }
+
+newlist = Marshal.load File.read('mylist.save')
+
+puts "Newlist:"
+newlist.show_all
+end

data/spec/mm_todo/todo_app_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../lib/todo_app'
+require 'stringio'
+
+describe ToDoApp do
+	before do
+		@output = StringIO.new
+		@myapp = ToDoApp.instance
+	end
+
+	it "displays some help text if no commandline parameter given" do
+		@myapp.start([], @output)
+		@output.rewind
+		@output.read.should match /ToDoApp: Wrong number of parameters/
+	end
+
+	it "displays some help text if more than 1 commandline parameter given" do
+		@myapp.start(["item1", "item2"], @output)
+		@output.rewind
+		@output.read.should match /ToDoApp: Wrong number of parameters/
+	end
+	
+
+
+end

data/spec/mm_todo/todo_list_spec.rb

@@ -0,0 +1,155 @@
+require_relative '../lib/todo_list'
+require_relative '../lib/todo_item'
+require 'stringio'
+
+describe ToDoList do
+	before do
+		@output = StringIO.new
+		@mylist = ToDoList.new
+		@wash_dishes = "wash the dishes"
+		@trash = "take out the trash"
+	end
+	
+	it "starts with a list of 0" do
+		@mylist.size.should be 0
+	end
+
+	it "ititializes to empty" do
+		@mylist.should be_empty
+	end
+
+	it "does not add a todo composed of only whitespace" do
+		@mylist.add @wash_dishes
+		@mylist.add ""
+		@mylist.add "   "
+		@mylist.size.should == 1
+	end
+
+	context "with one todo added" do
+		before do
+			@mylist.add(@wash_dishes)
+		end
+		it "has a size of 1" do
+			@mylist.size.should be 1
+		end
+
+		it "reports that it is no longer empty" do
+			@mylist.should_not be_empty
+		end
+	end
+
+	context "with two todos added" do
+		it "has a size of 2" do
+			@mylist.add(@wash_dishes)
+			@mylist.add(@trash)
+			@mylist.size.should be 2
+		end
+	end
+	context "with a populated list" do
+		before do
+			@mylist.add "Wash the dog"
+			@mylist.add "Clean the table"
+			@mylist.add "Clean bathroom"
+		end
+
+		it "lists the current todo items" do
+			@mylist.show_todos(@output)
+			@output.seek(0)
+			@output.read.should match /1\. Wash the dog/
+		end
+
+		it "lets todos be selected by index" do
+			@output.print @mylist.select(2)
+			@output.seek 0
+			@output.read.should == "Clean the table"
+		end
+
+		it "tracks items that are done" do
+			@mylist.select(2).do
+			@mylist.show_done(@output)
+			@output.seek 0
+			@output.read.should == "Clean the table\n"
+		end
+
+		it "allows done items to be purged" do
+			@mylist.select(2).do
+			@mylist.purge_done
+			@mylist.show_done(@output)
+			@output.seek 0
+			@output.read.should == ""
+		end
+
+
+	end
+	context "saving / loading" do 
+		before do
+			@savetest = ToDoList.new("savetest")
+			@list1 = ToDoList.new("list1")
+			@todo1 = "go to work"
+			@todo2 = "pay bills"
+			@todo3 = "feed dog"
+		end
+
+		after do
+			files = ["savetest.save", "list1.save", "testlist.save", "unnamed.save"]
+			files.each do |file|
+				File.delete file if File.exist? file
+			end
+		end
+
+		it "initializes a save file" do
+			@savetest.save
+			File.exist?("savetest.save").should be_true
+			File.delete("savetest.save")
+		end
+
+		it "loads saved lists" do@list1.add @todo1 
+			@list1.add @todo2 
+			@list1.add @todo3
+			@list1.select(2).do
+			@list1.save
+
+			list2 = ToDoList.new("list1")
+			list2.load
+			list2.show_done(@output)
+			@output.rewind
+			@output.read.should == "pay bills\n"
+		end
+		it "updates the save file when adding new todos" do
+			@savetest.add @todo1
+
+			newlist = ToDoList.new("savetest")
+			newlist.load
+			newlist.show_todos(@output)
+			@output.rewind
+			@output.read.should == "1. go to work\n"
+		end
+
+		it "updates the save file when marking items done" do
+			@savetest.add @todo1
+			@savetest.add @todo2
+
+			@savetest.select(2).do
+
+			newlist = ToDoList.new("savetest")
+			newlist.load
+			newlist.show_done(@output)
+			@output.rewind
+			@output.read.should == "pay bills\n"
+		end
+
+		it "updates the save file when purging done items" do
+			@savetest.add @todo1
+			@savetest.add @todo2
+
+			@savetest.select(2).do
+			@savetest.purge_done
+
+			newlist = ToDoList.new("savetest")
+			newlist.load
+			newlist.show_done(@output)
+			@output.rewind
+			@output.read.should == ""
+		end
+	end # save/load context
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: mmtodo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Mike Mitrovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'A simple command line todo app.
+
+  Created to help me learn some ruby concepts.
+
+
+'
+email: mmitrovich@gmail.com
+executables:
+- mmtodo
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/mmtodo
+- lib/mm_todo/todo_app.rb
+- lib/mm_todo/todo_item.rb
+- lib/mm_todo/todo_list.rb
+- spec/mm_todo/todo_app_spec.rb
+- spec/mm_todo/todo_list_spec.rb
+- LICENSE
+- README
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple commandline based todo app to teach myself some ruby concepts
+test_files:
+- spec/mm_todo/todo_app_spec.rb
+- spec/mm_todo/todo_list_spec.rb