dayrb 2.0.3 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5c7ac0153612ed3373be609657a8bf1f728a02e3
-  data.tar.gz: b784f73c240adb63a1f1a09f4f029aa62f6c969e
+SHA256:
+  metadata.gz: e50c30b0000ccc24e77b817926f38361c57d88dbce651c494807b4dd4e80418b
+  data.tar.gz: dcafa943ff153920c433c069aa4631badb97505a75601c19b5960a1ce95d4263
 SHA512:
-  metadata.gz: d1ab3833bda41a260a3f0981b147ccf08656cdc1db02f72e75107c4496af79f782c24257d902b53a33d7188a8ab0e2c0cd96603c050e11c48ed82dd4a1816ab8
-  data.tar.gz: 28a9b4dab170b478d43014df35b058df3e549c21ae02405a18513228d19cc9705812388d8099ac22e0cbc5eae6421672ab4f04d8dfb3992b15db5c69029b1828
+  metadata.gz: 4f097fefc6b32690049cecf2c1ba8a9adb21c64f8a8274c235915383faef462e67d7ae73b4b06234105648194d1e2066bb9b6cb2bb069a585bc9f636dcf8324e
+  data.tar.gz: 22fce23b5c01a6376065ed6054b35a8d1128a767f114916fc1b82f07f1159d91168a7aeac2f7b7aaeaca11a4cf28ac9471154ca4000ecc90aaa2d696a7b2a40d

data/LICENSE

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright © 2014 Cameron Carroll, http://ckcarroll.herokuapp.com
+Copyright © 2024 Cam Carroll, http://ieve.me
 
 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:
 

data/VERSION

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

data/bin/day.rb

@@ -2,10 +2,10 @@
 
 # DayRB Main File
 # Day.rb is a minimalistic command-line to-do and time-tracking application.
-# Created in July 2013
+# Created in July 2013, last updated September 2024
 # See 'day.rb help' for usage.
 #
-# MIT License; See LICENSE file; Cameron Carroll 2014
+# MIT License; See LICENSE file; Cam Carroll 2024
 
 require_relative '../lib/day/configuration'
 require_relative '../lib/day/tasklist'
@@ -14,16 +14,19 @@ require_relative '../lib/day/presenter'
 
 require 'fileutils'
 
-VERSION = '2.0.3'
+VERSION = '2.0.5'
+
+require 'pry-byebug'
 
 #-------------- User Configuration:
 #-------------- Please DO edit the following to your liking:
 
 # Configuration File: Stores tasks and their data
-CONFIG_DIR = ENV['HOME'] + '/.config/dayrb/'
-CONFIG_FILE = CONFIG_DIR + 'daytodo'
+#CONFIG_DIR = ENV['HOME'] + '/.config/dayrb/'
+CONFIG_DIR = '/home/cam/wip/day/'
+CONFIG_FILE = CONFIG_DIR + 'config_dayrb'
 
-# Colorization: 
+# Colorization:
 # Use ANSI color codes...
 # (See http://bluesock.org/~willg/dev/ansi.html for codes.)
 # (Change values back to 0 for no colorization.)
@@ -87,13 +90,12 @@ class String
 end
 
 #-------------- Application Logic:
+FileUtils.mkdir_p(CONFIG_DIR) unless Dir.exist? CONFIG_DIR
 
-FileUtils.mkdir_p(CONFIG_DIR) unless Dir.exists? CONFIG_DIR
-
-db = YAML::DBM.new(CONFIG_FILE)
-config = Configuration.new(db)
+config = Configuration.new(CONFIG_FILE)
 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
@@ -108,8 +110,10 @@ end
 
 # Easier (named) access to config and opts:
 new_context = opts[:task]
-current_context = config.data['context']
-old_time = Time.now - config.data['entry_time'] if config.data['entry_time']
+current_context = config.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.entry_time if config.entry_time
 
 # Take action based on operation:
 case opts[:operation]
@@ -128,17 +132,18 @@ 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.tasks[new_context]['description'])
+  if confirmation
+    config.delete(new_context)
+  end
 else
   Presenter.print_error_unknown
 end
 
-config.save
-db.close
+config.save(CONFIG_FILE)

data/changelog.md

@@ -1,3 +1,16 @@
+2.0.5 -- 09/18/2024
+-------------------
+* Bug fix: Replaced deprecated File.exists? method with .exist?
+* Bug fix: Replaced (seemingly) deprecated yaml/dbm library - using psych directly instead to load config yaml file.
+* Bug fix: Reorganized YAML file bootstrapping code to ensure we always load config data (previously a bootstrap run would not initialize config data class variables)
+
+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
 ------------------
 
@@ -15,7 +28,7 @@
 
 ### Bug Fixes:
 
-* Changed shebang to user /usr/bin/env ruby instead of /usr/bin/ruby.
+* Changed shebang to use /usr/bin/env ruby instead of /usr/bin/ruby.
 * Fixed some spec regressions.
 
 2.0.1 -- 08/12/14
@@ -117,4 +130,3 @@
 -------------------
 
 * Task list printout will now give progress on current task.
-

data/dayrb.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name        = 'dayrb'
-  s.version     = '2.0.3'
+  s.version     = '2.0.5'
   s.summary     = "To-do & Time-Tracking CLI App"
   s.description = "Create and track time on tasks via command-line."
-  s.authors     = ["Cameron Carroll"]
+  s.authors     = ["Cam Carroll"]
   s.email       = 'ckcarroll4@gmail.com'
   s.files       = `git ls-files`.split($/)
   s.executables =  s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.homepage    =
-    'http://github.com/sanarothe/day'
+    'http://github.com/CameronCarroll/day'
   s.license       = 'MIT'
-end
+end

data/lib/day/configuration.rb

@@ -1,10 +1,10 @@
 # DayRB Configuration (Data-Access Layer) Module
 #
-# Provides convenience methods for database access and holds db data.
-# 
-# MIT License; See LICENSE file; Cameron Carroll 2014
+# Provides convenience methods for database access and holds config data.
+#
+# MIT License; See LICENSE file; Cameron Carroll 2024
 
-require 'yaml/dbm'
+require 'psych'
 
 # Config class handles access to our config file, which mostly just provides a data-access layer.
 # Schema:
@@ -22,15 +22,26 @@ require 'yaml/dbm'
 #   }
 
 class Configuration
-  attr_reader :data, :context, :entry_time
+  attr_reader :tasks, :context, :entry_time
 
-  # Load DB data and bootstrap it if empty.
+  # Load config data from file -- bootstrap it if empty.
   #
-  # @param db [PSYCH::DBM] database (hash-like) initialized and closed by caller.
-  def initialize(db)
-    @db = db
-    @data = @db.to_hash
-    bootstrap_db if @data.empty?
+  # @param data_file Location of task data file on local drive.
+  def initialize(data_file)
+
+    unless File.exist? data_file
+      bootstrap_db(data_file)
+      puts "day.rb created new config file " + CONFIG_FILE
+    end
+
+    if File.exist? data_file
+      loaded_data = Psych.safe_load_file(data_file, permitted_classes: [Time, Symbol])
+      @context = loaded_data[:context]
+      @entry_time = loaded_data[:entry_time]
+      @tasks = loaded_data[:tasks]
+    else
+      puts "Error creating / loading config file"
+    end
   end
 
   # Interface to save_task which decomposes opts hash.
@@ -46,14 +57,14 @@ class Configuration
   # @param next_key [String] the name of the task to switch to.
   def switch_to(next_key)
     cap_current_fulfillment if @context
-    @data['context'] = next_key if @data['tasks'].has_key?(next_key)
-    @data['entry_time'] = Time.now.getutc
+    @context = next_key if @tasks.has_key?(next_key)
+    @entry_time = Time.now.getutc
   end
 
   # Exit context without switching to a new one.
   def clear_context()
     cap_current_fulfillment
-    @data['context'], @data['entry_time'] = nil, nil
+    @context, @entry_time = nil, nil
   end
 
   # Clear fulfillment for one or all tasks.
@@ -63,7 +74,7 @@ class Configuration
     if task
       clear_fulfillment_for task
     else
-      @data['tasks'].each do |task, task_data|
+      @tasks.each do |task, task_data|
         clear_fulfillment_for task
       end
     end
@@ -76,20 +87,26 @@ class Configuration
   #
   # @param task_key [String] Valid task name to delete.
   def delete(task_key)
-    @data['tasks'].delete task_key
+    @tasks.delete task_key
   end
 
   # Reload class objects from config data.
   # (Used during testing.)
   def reload()
-    @context = @data['context']
-    @entry_time = @data['entry_time']
+    @context = @context
+    @entry_time = @entry_time
 
   end
 
-  # To be called at the very end of the script to write data back into YAML::DBM
-  def save()
-    @db.replace(@data)
+  # To be called at the very end of the script to write data back into YAML
+  def save(data_file)
+    data = {
+      context: @context,
+      entry_time: @entry_time,
+      tasks: @tasks }
+    File.open(data_file, 'w') do |file|
+      file.write(Psych.dump(data))
+    end
   end
 
   # Used to verify that a task actually exists and to cross-reference indices to names
@@ -97,9 +114,9 @@ class Configuration
   # @param task [String] name or index reference to task
   def lookup_task(task)
     if task.number?
-      @data['tasks'].keys[task.to_i]
+      @tasks.keys[task.to_i]
     else
-      task if @data['tasks'].has_key? task
+      task if @tasks.has_key? task
     end
   end
 
@@ -113,28 +130,33 @@ class Configuration
   # @param estimate [String] a time estimate in integer minutes.
   def save_task(task, description, valid_days, estimate)
     if task
-      @data['tasks'][task] = {'description' => description, 'valid_days' => valid_days,
+      @tasks[task] = {'description' => description, 'valid_days' => valid_days,
        'estimate' => estimate, 'fulfillment' => nil}
     end
   end
 
   # Builds initial structure for the database file.
-  def bootstrap_db
-    @data['context'] = nil
-    @data['entry_time'] = nil
-    @data['tasks'] = {}
+  def bootstrap_db(data_file)
+    data = {
+      context: nil,
+      entry_time: nil,
+      tasks: {} }
+
+    File.open(data_file, 'w') do |file|
+      file.write(Psych.dump(data))
+    end
   end
 
    # Add the elapsed time since entering a context. (Used when exiting that context.)
   def cap_current_fulfillment
-    @data['tasks'][@data['context']]['fulfillment'] ||= 0
-    @data['tasks'][@data['context']]['fulfillment'] += Time.now - @data['entry_time']
+    @tasks[@context]['fulfillment'] ||= 0
+    @tasks[@context]['fulfillment'] += Time.now - @entry_time
   end
 
   # Actually modify fulfillment data for a task.
   #
   # @param task [String] Valid task name to verify data for.
   def clear_fulfillment_for(task)
-    @data['tasks'][task]['fulfillment'] = nil
+    @tasks[task]['fulfillment'] = nil
   end
-end
+end

data/lib/day/parser.rb

@@ -51,7 +51,7 @@ module Parser
         demand_second_argument
       when :switch
         task = lookup_task(ARGV.first)
-        if task && @config.data['context'] == task
+        if task && @config.context == task
           opts[:operation] = :leave
           nil
         elsif task

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/lib/day/tasklist.rb

@@ -14,7 +14,7 @@ class Tasklist
 
 	def initialize(config)
 		@config = config
-		@all_tasks = load_tasks(config.data['tasks'])
+		@all_tasks = load_tasks(config.tasks)
 		today = Time.new.strftime("%A").downcase.to_sym
 		@valid_tasks = @all_tasks.select do |task_name, task_object|
 			if task_object.valid_days

data/readme.md

@@ -1,15 +1,15 @@
 day.rb
 ======
-(Version 2.0.3 -- August 2014)
+(Version 2.0.5 -- March 2024)
 
 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:
 -------------
-* Ruby (Tested with 2.1.2)
+* Ruby (Tested with 3.2.5)
 
 Installation:
 -------------
@@ -24,27 +24,50 @@ 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 2024 - Cam 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.5
 platform: ruby
 authors:
-- Cameron Carroll
-autorequire: 
+- Cam Carroll
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-17 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies: []
 description: Create and track time on tasks via command-line.
 email: ckcarroll4@gmail.com
@@ -32,11 +32,11 @@ files:
 - spec/configuration_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/sanarothe/day
+homepage: http://github.com/CameronCarroll/day
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,13 +51,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.5.19
+signing_key:
 specification_version: 4
 summary: To-do & Time-Tracking CLI App
 test_files:
 - spec/configuration_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
-has_rdoc: