dayrb 2.0.4 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9bd54d621f2ea27a6da4f10359e31ff7a365c9d1
-  data.tar.gz: 15e902f847d739d4d13fac1a05ec6e5ebe473e74
+SHA256:
+  metadata.gz: 9b6f1afc79261b757970a6e47e2da8bffc713f9821aac8e4a8a02510abb81a47
+  data.tar.gz: 7ef06747b200c3a5c8f3ac4689a08d9f4cc4a4568345160d3fa8653baf9c5fb8
 SHA512:
-  metadata.gz: 89b92e1d09a1501b9a12816f5661c299eebce95948cc1b838d6a212f54e1b60409c81a5bdc676b1c43116e0bcd996c9b758756223aa0d4c9952632cbe9c00b59
-  data.tar.gz: 4097d69eeb3ea33c1806db806c61dc92e3d271b1bf179eea1fc33c56dc675d0cb1bd60134c7fb9d39e5868dc8ade11f3c69aadc44f7b17e6dd4d5a68c80c880a
+  metadata.gz: b314afd5732ab2a55b7df56c2fc0ce54cc03a503ee8d9b171c19ba7a14d47c82a6fdf363687c51f243020272afcfacc0436e7c5e6ff0440088e782db909e7c5e
+  data.tar.gz: 5cc0177bfe74c6df42b5545dc7ea426ed9c1a0d4f5a38075adb7f25057a8af7ca2c67848d27ed25b81cc882f0873749fb86ee937e39f54fd1aee2a4aae013ce6

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.4
+2.0.6

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 2015
+# MIT License; See LICENSE file; Cam Carroll 2024
 
 require_relative '../lib/day/configuration'
 require_relative '../lib/day/tasklist'
@@ -14,14 +14,14 @@ require_relative '../lib/day/presenter'
 
 require 'fileutils'
 
-VERSION = '2.0.4'
+VERSION = '2.0.6'
 
 #-------------- 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/'
+CONFIG_FILE = CONFIG_DIR + 'dayrb_config_file'
 
 # Colorization:
 # Use ANSI color codes...
@@ -41,6 +41,8 @@ EDITOR = 'vim'
 #--------------
 
 #[CUT HERE] Used in build script. Please don't remove.
+# Note as of September 2024 - I don't remember what the build script was even supposed to do? Or where it is?
+# ?? I published the new version to Rubygems and it seemed to work, so I have no idea.
 
 #-------------- Monkey-Patch Definitions:
 
@@ -87,11 +89,9 @@ 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.
@@ -109,10 +109,10 @@ end
 
 # Easier (named) access to config and opts:
 new_context = opts[:task]
-current_context = config.data['context']
+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.data['entry_time'] if config.data['entry_time']
+old_time = Time.now - config.entry_time if config.entry_time
 
 # Take action based on operation:
 case opts[:operation]
@@ -137,7 +137,7 @@ when :leave
   Presenter.announce_leave_context(current_context, old_time)
   config.clear_context
 when :delete
-  confirmation = Presenter.confirm_deletion(new_context, config.data['tasks'][new_context]['description'])
+  confirmation = Presenter.confirm_deletion(new_context, config.tasks[new_context]['description'])
   if confirmation
     config.delete(new_context)
   end
@@ -145,5 +145,4 @@ else
   Presenter.print_error_unknown
 end
 
-config.save
-db.close
+config.save(CONFIG_FILE)

data/changelog.md

@@ -1,3 +1,9 @@
+2.0.5 (aka 2.0.6 because I'm dumb) -- 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
 -------------------
 
@@ -22,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

data/dayrb.gemspec

@@ -1,14 +1,15 @@
 Gem::Specification.new do |s|
   s.name        = 'dayrb'
-  s.version     = '2.0.4'
+  s.version     = '2.0.6'
+  s.required_ruby_version = '>= 3.0'
   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

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.
+# Provides convenience methods for database access and holds config data.
 #
-# MIT License; See LICENSE file; Cameron Carroll 2014
+# 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.
@@ -45,15 +56,15 @@ class Configuration
   #
   # @param next_key [String] the name of the task to switch to.
   def switch_to(next_key)
-    cap_current_fulfillment if @data['context']
-    @data['context'] = next_key if @data['tasks'].has_key?(next_key)
-    @data['entry_time'] = Time.now.getutc
+    cap_current_fulfillment if @context
+    @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

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/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,6 +1,6 @@
 day.rb
 ======
-(Version 2.0.4 -- March 2015)
+(Version 2.0.6 -- March 2024)
 
 A command-line to-do & time-tracking application.
 
@@ -9,7 +9,7 @@ A command-line to-do & time-tracking application.
 
 Requirements:
 -------------
-* Ruby (Tested with 2.1.2)
+* Ruby (Tested with 3.2.5 in Sept 2024 -- I set minimum ruby version arbitrarily at 3.0 because a lot of stuff needed fixing since the last version from ~2015, I'm not sure what the real minimum version is.)
 
 Installation:
 -------------
@@ -20,7 +20,7 @@ Installation:
 
 ### Method 2: Clone the Repository (Entire Folder)
 
-* Clone the repository to your favorite apps folder. (git clone https://github.com/sanarothe/day.git ~/apps)
+* Clone the repository to your favorite apps folder. (git clone https://github.com/CameronCarroll/day.git ~/apps)
 * 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)
 
@@ -66,6 +66,8 @@ Examples
     # Note 'vim' can be changed to any editor atop day.rb file.
     day.rb my_new_task vim
 
-Copyright 2015 - Cameron Carroll
+
+
+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.4
+  version: 2.0.6
 platform: ruby
 authors:
-- Cameron Carroll
-autorequire: 
+- Cam Carroll
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-22 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
@@ -44,16 +44,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.5.19
+signing_key:
 specification_version: 4
 summary: To-do & Time-Tracking CLI App
 test_files: