dayrb 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c7ac0153612ed3373be609657a8bf1f728a02e3
-  data.tar.gz: b784f73c240adb63a1f1a09f4f029aa62f6c969e
+  metadata.gz: 9bd54d621f2ea27a6da4f10359e31ff7a365c9d1
+  data.tar.gz: 15e902f847d739d4d13fac1a05ec6e5ebe473e74
 SHA512:
-  metadata.gz: d1ab3833bda41a260a3f0981b147ccf08656cdc1db02f72e75107c4496af79f782c24257d902b53a33d7188a8ab0e2c0cd96603c050e11c48ed82dd4a1816ab8
-  data.tar.gz: 28a9b4dab170b478d43014df35b058df3e549c21ae02405a18513228d19cc9705812388d8099ac22e0cbc5eae6421672ab4f04d8dfb3992b15db5c69029b1828
+  metadata.gz: 89b92e1d09a1501b9a12816f5661c299eebce95948cc1b838d6a212f54e1b60409c81a5bdc676b1c43116e0bcd996c9b758756223aa0d4c9952632cbe9c00b59
+  data.tar.gz: 4097d69eeb3ea33c1806db806c61dc92e3d271b1bf179eea1fc33c56dc675d0cb1bd60134c7fb9d39e5868dc8ade11f3c69aadc44f7b17e6dd4d5a68c80c880a

data/VERSION

@@ -1 +1 @@
-2.0.3
+2.0.4

data/bin/day.rb

@@ -5,7 +5,7 @@
 # Created in July 2013
 # See 'day.rb help' for usage.
 #
-# MIT License; See LICENSE file; Cameron Carroll 2014
+# MIT License; See LICENSE file; Cameron Carroll 2015
 
 require_relative '../lib/day/configuration'
 require_relative '../lib/day/tasklist'
@@ -14,7 +14,7 @@ require_relative '../lib/day/presenter'
 
 require 'fileutils'
 
-VERSION = '2.0.3'
+VERSION = '2.0.4'
 
 #-------------- User Configuration:
 #-------------- Please DO edit the following to your liking:
@@ -23,7 +23,7 @@ VERSION = '2.0.3'
 CONFIG_DIR = ENV['HOME'] + '/.config/dayrb/'
 CONFIG_FILE = CONFIG_DIR + 'daytodo'
 
-# Colorization: 
+# Colorization:
 # Use ANSI color codes...
 # (See http://bluesock.org/~willg/dev/ansi.html for codes.)
 # (Change values back to 0 for no colorization.)
@@ -94,6 +94,7 @@ db = YAML::DBM.new(CONFIG_FILE)
 config = Configuration.new(db)
 opts = Parser.parse_options(config)
 
+# TODO: Simplify following logic, we don't need so many variables.
 # Build task objects and separate into two lists, valid today and all tasks.
 tasklist_object = Tasklist.new(config)
 all_tasks = tasklist_object.all_tasks
@@ -109,6 +110,8 @@ end
 # Easier (named) access to config and opts:
 new_context = opts[:task]
 current_context = config.data['context']
+# If we were already tracking a task when program was called,
+# this refers to the time spent in that task:
 old_time = Time.now - config.data['entry_time'] if config.data['entry_time']
 
 # Take action based on operation:
@@ -128,17 +131,19 @@ when :switch
   Presenter.announce_switch(new_context, current_context, old_time)
   config.switch_to(new_context)
 when :clear
-  Presenter.announce_clear(new_context)
-  config.clear_fulfillment(new_context)
+  confirmation = Presenter.confirm_clear(new_context)
+  config.clear_fulfillment(new_context) if confirmation
 when :leave
   Presenter.announce_leave_context(current_context, old_time)
   config.clear_context
 when :delete
-  Presenter.announce_deletion(new_context, config.data['tasks'][new_context]['description'])
-  config.delete(new_context)
+  confirmation = Presenter.confirm_deletion(new_context, config.data['tasks'][new_context]['description'])
+  if confirmation
+    config.delete(new_context)
+  end
 else
   Presenter.print_error_unknown
 end
 
 config.save
-db.close
+db.close

data/changelog.md

@@ -1,3 +1,10 @@
+2.0.4 -- 03/20/14
+-------------------
+
+* Updated help documentation to be more clear about abbreviated commands and descriptions, and also added some examples.
+* Added confirmation for delete and clear commands.
+* Fixed a problem where switching directly between two tasks didn't save fulfillment data for the first.
+
 2.0.3 -- 08/17/14
 ------------------
 
@@ -117,4 +124,3 @@
 -------------------
 
 * Task list printout will now give progress on current task.
-

data/dayrb.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'dayrb'
-  s.version     = '2.0.3'
+  s.version     = '2.0.4'
   s.summary     = "To-do & Time-Tracking CLI App"
   s.description = "Create and track time on tasks via command-line."
   s.authors     = ["Cameron Carroll"]
@@ -11,4 +11,4 @@ Gem::Specification.new do |s|
   s.homepage    =
     'http://github.com/sanarothe/day'
   s.license       = 'MIT'
-end
+end

data/lib/day/configuration.rb

@@ -1,7 +1,7 @@
 # DayRB Configuration (Data-Access Layer) Module
 #
 # Provides convenience methods for database access and holds db data.
-# 
+#
 # MIT License; See LICENSE file; Cameron Carroll 2014
 
 require 'yaml/dbm'
@@ -45,7 +45,7 @@ class Configuration
   #
   # @param next_key [String] the name of the task to switch to.
   def switch_to(next_key)
-    cap_current_fulfillment if @context
+    cap_current_fulfillment if @data['context']
     @data['context'] = next_key if @data['tasks'].has_key?(next_key)
     @data['entry_time'] = Time.now.getutc
   end
@@ -137,4 +137,4 @@ class Configuration
   def clear_fulfillment_for(task)
     @data['tasks'][task]['fulfillment'] = nil
   end
-end
+end

data/lib/day/presenter.rb

@@ -54,12 +54,22 @@ Commands:
   (nonexisting task)  Creates a new task
   (existing task)     Start tracking time for named task.
   delete (task)       Remove a task
+	rm (task)						(Synonym for delete.)
   info                Print all descriptions
   info (task)         Print a specific description
+	i (task)						(Synonym for info.)
   clear               Clear fulfillment for all tasks.
   clear (task)        Clear fulfillment for a specific task.
+	c (task)						(Synonym for clear.)
+
+Flags:
+	-a									Print all tasks, including those not enabled today.
+
+Tips:
+	Refer to a task either by its name or index.
+	Jump directly between tasks.
+	Include "vim" or your editor constant when creating new task to add a description.
 
-Refer to a task either by its name or index.
 See readme.md for a more detailed overview.
 	    eos
 	  end
@@ -69,24 +79,45 @@ See readme.md for a more detailed overview.
 	    puts "Day.rb v#{VERSION}"
 	  end
 
-	  # Announces task has been deleted and prints its description if applicable.
-	  #
-	  # @param task [String] Name of task to be deleted
-	  # @param description [String] Description of task (optional)
-	  def announce_deletion(task, description)
-	  	puts "Deleted #{task}".color_text
-	  	puts "Description was: #{description}".color_text if description
-	  end
+		# Asks whether the user is sure that they want to delete something.
+		#
+		# @param task [String] Name of task
+		# @param description [String] Description of task (optional)
+		def confirm_deletion(task, description)
+			puts "Are you sure you want to delete '#{task}'?: (Y/N)"
+			puts "It's description was #{description}: (Y/N)" if description
+			case confirmation = get_confirmation
+			when true
+				puts "Deleted #{task}".color_text
+				puts "Description was: #{description}".color_text if description
+			when false
+				puts "Didn't delete '#{task}.'".color_text
+			end
+			return confirmation
+		end
 
-	  # Announces that either a task or all tasks have had fulfillment cleared.
+	  # Asks the user whether they're sure they want to clear fulfillment.
 	  #
 	  # @param task [String] Name of task to be cleared
-	  def announce_clear(task)
-	  	if task
-	  		puts "Cleared fulfillment for #{task}".color_text
-	  	else
-	  		puts "Cleared fulfillment for all tasks".color_text
-	  	end
+	  def confirm_clear(task)
+			if task
+				puts "Are you sure you want to clear fulfillment for #{task}?"
+			else
+				puts "Are you sure you want to clear all fulfillment data?"
+			end
+			
+			case answer = get_confirmation
+			when true
+		  	if task
+		  		puts "Cleared fulfillment for #{task}".color_text
+		  	else
+		  		puts "Cleared fulfillment for all tasks".color_text
+		  	end
+			when false
+				puts "Didn't clear fulfillment."
+			end
+
+			return answer
 	  end
 
 	  # Announces a switch to a new task...
@@ -121,6 +152,20 @@ See readme.md for a more detailed overview.
 
 		private
 
+		def get_confirmation
+			loop do
+				print " (Y/N) -->: "
+				case input = $stdin.gets
+				when /y/i, /yes/i
+					return true
+				when /n/i, /no/i
+					return false
+				else
+					p "Sorry, didn't catch that. Try 'yes' or 'no'."
+				end
+			end
+		end
+
 		# Iterate through tasklist, printing index, name, description flag and fulfillment/estimate data.
 		#
 		# @param tasks [Hash] Collection of task_name => task_object pairs
@@ -220,4 +265,4 @@ See readme.md for a more detailed overview.
 			puts "Sorry, that command is not known. Try 'help'."
 		end
 	end
-end
+end

data/readme.md

@@ -1,11 +1,11 @@
 day.rb
 ======
-(Version 2.0.3 -- August 2014)
+(Version 2.0.4 -- March 2015)
 
 A command-line to-do & time-tracking application.
 
 * Define & describe tasks, and set time estimates for yourself.
-* Check in or out of tasks to track time spent.
+* Check in and out of tasks to track time spent.
 
 Requirements:
 -------------
@@ -24,27 +24,48 @@ Installation:
 * Symlink day.rb into your favorite bin folder. (ln -s ~/apps/day/bin/day.rb ~/bin/day)
 * Chmod it to be executable (chmod +x ~/bin/day)
 
-Usage Overview: 
+Usage Overview:
 ---------------
-
     Usage: day.rb <command> [<args>]
 
     Commands:
-    (no command)        Prints out task list for the day
-    (nonexisting task)  Creates a new task
-    (existing task)     Start tracking time for named task
-    delete (task)       Remove a task
-    info                Print all descriptions
-    info (task)         Print a specific description
-    clear               Clear fulfillment for all tasks.
-    clear (task)        Clear fulfillment for a specific task.
-    
-    (From 'day.rb help')
-    
-* Use the '-a' flag (with no command) to print out tasks that aren't enabled for the day
-* Jump directly from task to task
-* Stores data by default in ~/.config/day/ -- Edit the constant at top of script to change this.
-
-Copyright 2014 - Cameron Carroll
-
-License: MIT
+      (no command)        Prints out task list for the day
+      (nonexisting task)  Creates a new task
+      (existing task)     Start tracking time for named task.
+      delete (task)       Remove a task
+      rm (task)           (Synonym for delete.)
+      info                Print all descriptions
+      info (task)         Print a specific description
+      i (task)            (Synonym for info.)
+      clear               Clear fulfillment for all tasks.
+      clear (task)        Clear fulfillment for a specific task.
+      c (task)            (Synonym for clear.)
+
+    Flags:
+      -a                  Also print tasks not enabled today.
+
+    Tips:
+      Refer to a task either by its name or index.
+      Jump directly between tasks.
+      Include "vim" or your editor constant when creating new task to add a description.
+      Configuration data is stored at the top of 'day.rb.'
+
+Examples
+--------
+    # Create a new task:
+    day.rb my_new_task
+
+    # Create task enabled on monday & wednesday, with a 45 minute estimate:
+    day.rb my_new_task m w 45
+
+    # Create a task with in-line description:
+    # Note parenthesis and quotations are mandatory.
+    day.rb my_new_task "(some description)"
+
+    # Create a task with editor description:
+    # Note 'vim' can be changed to any editor atop day.rb file.
+    day.rb my_new_task vim
+
+Copyright 2015 - Cameron Carroll
+
+License: MIT

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dayrb
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Cameron Carroll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-17 00:00:00.000000000 Z
+date: 2015-03-22 00:00:00.000000000 Z
 dependencies: []
 description: Create and track time on tasks via command-line.
 email: ckcarroll4@gmail.com
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: To-do & Time-Tracking CLI App
@@ -60,4 +60,3 @@ test_files:
 - spec/configuration_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
-has_rdoc: