dayrb 2.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24d90143cff6a871b07c09646fcd44dbb01e4fe0
+  data.tar.gz: 13093c6ae051e3c92a97b8f2bc4411d87f12ef71
+SHA512:
+  metadata.gz: 28521616cd3e8ef9641d9729a19663a5b059f049a56ea652be9a5a2e24b507162d8629005e69b6cc6e44e067f0cd6642363e20eb719e4750bdd411f4cd8e6b11
+  data.tar.gz: 474459e87e7a6e9b3a09d1511407f179c86b160f8be7fcb924a0b014a0331b60700f6ee4ec056730f78a21ec0b2abda1807e4bc724875ca5156db479b8078ea8

data/.gitignore

@@ -0,0 +1,11 @@
+Gemfile.lock
+TODO
+test.rb
+clear.rb
+build/
+*.db
+tmp/
+test/
+doc/
+.yardoc/
+test_db*

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2014 Cameron Carroll, http://ckcarroll.herokuapp.com
+
+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/Rakefile

@@ -0,0 +1,118 @@
+# Rakefile for day.rb
+# Author: Cameron Carroll; December 2013
+# Purpose: Compiles a single-file version of the program for easy distribution and installation.
+#          Also increments version numbers based on VERSION file.
+
+puts "Day.rb Build Tool"
+puts "-----------------"
+
+task :default => [:update_version, :compile]
+
+task :update_version do
+  current_version = nil
+  open('VERSION', 'r') do |file|
+    current_version = file.gets
+  end
+
+  puts "Current Version: #{current_version}"
+
+  split_version = current_version.split('.')
+
+  next_patch_version = update_patch(split_version, 1)
+  previous_patch_version = update_patch(split_version, -1)
+
+  next_minor_version = update_minor(split_version, 1)
+  previous_minor_version = update_minor(split_version, -1)
+
+  next_major_version = update_major(split_version, 1)
+  previous_major_version = update_major(split_version, -1)
+
+  previous_versions = [previous_patch_version, previous_minor_version, previous_major_version]
+  next_versions = [next_patch_version, next_minor_version, next_major_version]
+
+  # Unlikely to happen, but if the source files get ahead of VERSION file we should warn and break.
+  next_versions.each do |version|
+    next_version_in_dayrb = `grep #{version} day.rb`.length > 0
+    next_version_in_readme = `grep #{version} readme.md`.length > 0
+
+    if next_version_in_dayrb || next_version_in_readme
+      puts "VERSION file is behind source files! Breaking; Please fix manually."
+      abort
+    end
+  end
+
+  
+  old_version_in_readme, old_version_in_dayrb, old_version = nil, nil, nil
+
+  # Check authoritative version source (VERSION file) against source files.
+  # If source files have an older version, update it.
+  previous_versions.each do |version|
+    unless old_version_in_dayrb && old_version_in_readme
+      old_version_in_dayrb = `grep #{version} day.rb`.length > 0
+      old_version_in_readme = `grep #{version} readme.md`.length > 0
+      old_version = version if old_version_in_readme || old_version_in_dayrb
+      puts "Version in question: " + version if old_version
+    end
+  end
+  
+
+  if old_version_in_dayrb
+    puts "Replacing version #{old_version} with #{current_version} in day.rb"
+    `sed -i 's/#{old_version}/#{current_version}/g' day.rb`
+  end
+
+  if old_version_in_readme
+    today_date = Time.new.strftime("%m/%d/%y")
+    puts "Replacing version #{old_version} with #{current_version} in readme.md"
+    puts "Replacing old date with #{today_date} in day.rb"
+    `sed -i 's/#{old_version}/#{current_version}/g' readme.md`
+    `sed -i 's%[0-9][0-9]/[0-9][0-9]/[0-9][0-9])%#{today_date})%' readme.md`
+  end
+
+  if !old_version_in_dayrb && !old_version_in_readme
+    puts "Didn't find any version errors."
+  end
+end
+
+task :compile do
+  `mkdir -p "build"`
+  target = "build/day.rb"
+
+  `cat /dev/null > #{target}`
+
+  # First we need to find out where to cut day.rb...
+  cut_line = `grep -n "CUT HERE" day.rb`.split(':').first
+
+  # Then we need to get the first chunk of day.rb, which includes intro comments
+  # and user configuration. 
+  # But we want to strip off the require statements and the whitespace leftover.
+  `awk 'NR >= 1 && NR <= #{cut_line}' day.rb | sed 's/require_relative.*//g' | uniq >> #{target}`
+
+  # Add all library files:
+  FileList['lib/*.rb'].each do |source|
+    `cat #{source} >> #{target}`
+    `echo "\n" >> #{target}`
+  end
+
+  # Now finally we want to add the remaining body of day.rb
+  lines_in_dayrb = `wc -l day.rb`.to_i
+  `awk 'NR >= #{cut_line} && NR <= #{lines_in_dayrb+1}' day.rb >> #{target}`
+end
+
+def update_patch(split_version, increment)
+  different_patch = split_version[2].to_i + increment
+  different_patch_version = split_version[0..1].push(different_patch)
+  different_patch_version.join('.')
+end
+
+def update_minor(split_version, increment)
+  different_minor = split_version[1].to_i + increment
+  different_minor_version = [split_version[0],different_minor,split_version[2]]
+  different_minor_version.join('.')
+end
+
+def update_major(split_version, increment)
+  different_major = split_version[0].to_i + increment
+  different_major_version = split_version[1,2].unshift(different_major)
+  different_major_version.join('.')
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.1

data/bin/day.rb

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+
+# DayRB Main File
+# Day.rb is a minimalistic command-line to-do and time-tracking application.
+# Created in July 2013
+# See 'day.rb help' for usage.
+#
+# MIT License; See LICENSE file; Cameron Carroll 2014
+
+require_relative '../lib/day/configuration'
+require_relative '../lib/day/tasklist'
+require_relative '../lib/day/parser'
+require_relative '../lib/day/presenter'
+
+require 'fileutils'
+
+VERSION = '2.0.1'
+
+#-------------- 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'
+
+# Colorization: 
+# Use ANSI color codes...
+# (See http://bluesock.org/~willg/dev/ansi.html for codes.)
+# (Change values back to 0 for no colorization.)
+COMPLETION_COLOR = 0 # -- Used for completion printouts
+CONTEXT_SWITCH_COLOR = 0 # -- Used to declare `Enter/Exit Context'
+STAR_COLOR = 0 # -- Used for the description indicator star
+TITLE_COLOR = 0 # -- Used for any titles
+TEXT_COLOR = 0 # -- Used for basically everything that doesn't fit under the others.
+INDEX_COLOR = 0 # -- Used for the index key which refers to tasks.
+TASK_COLOR = 0 # -- Used for task name in printouts.
+
+# Editor constant. Change to your preferred editor for adding descriptions.
+EDITOR = 'vim'
+
+#--------------
+
+#[CUT HERE] Used in build script. Please don't remove.
+
+#-------------- Monkey-Patch Definitions:
+
+class String
+  def nan?
+    self !~ /^\s*[+-]?((\d+_?)*\d+(\.(\d+_?)*\d+)?|\.(\d+_?)*\d+)(\s*|([eE][+-]?(\d+_?)*\d+)\s*)$/
+  end
+
+  def number?
+    !self.nan?
+  end
+
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def color_completion
+    colorize(COMPLETION_COLOR)
+  end
+
+  def color_context_switch
+    colorize(CONTEXT_SWITCH_COLOR)
+  end
+
+  def color_star
+    colorize(STAR_COLOR)
+  end
+
+  def color_title
+    colorize(TITLE_COLOR)
+  end
+
+  def color_text
+    colorize(TEXT_COLOR)
+  end
+
+  def color_index
+    colorize(INDEX_COLOR)
+  end
+
+  def color_task
+    colorize(TASK_COLOR)
+  end
+end
+
+#-------------- Application Logic:
+
+FileUtils.mkdir_p(CONFIG_DIR) unless Dir.exists? CONFIG_DIR
+
+db = YAML::DBM.new(CONFIG_FILE)
+config = Configuration.new(db)
+opts = Parser.parse_options(config)
+
+# Build task objects and separate into two lists, valid today and all tasks.
+tasklist_object = Tasklist.new(config)
+all_tasks = tasklist_object.all_tasks
+valid_tasks = tasklist_object.valid_tasks
+
+# Include either all days ("-a" flag) or just valid daily tasks:
+if opts[:all]
+  tasklist = all_tasks
+else
+  tasklist = valid_tasks
+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']
+
+# Take action based on operation:
+case opts[:operation]
+when :print
+  Presenter.print_list(tasklist, current_context, old_time)
+when :print_info
+  Presenter.print_info(tasklist, new_context)
+when :print_help
+  Presenter.print_help
+when :print_version
+  Presenter.print_version
+when :new
+  Presenter.announce_new_task(new_context)
+  config.new_task(opts)
+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)
+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)
+else
+  Presenter.print_error_unknown
+end
+
+config.save
+db.close

data/changelog.md

@@ -0,0 +1,100 @@
+2.0.1 -- 08/12/14
+------------------
+
+* Makes sure data store directory exists.
+
+2.0.0 -- 08/11/14
+------------------
+
+### Feature Additions:
+
+* Added "-a" / "-A" flag, for "all tasks." This allows you to see tasks that aren't enabled for today.
+* You can now refer to tasks by name rather than only by numerical index.
+
+### Deprecations:
+
+* Removed DESCRIPTION flag and deprecated its functionality, which would print full descriptions instead of asterisk in the tasklist.
+
+### Internal Changes:
+
+* Major internal rewrite; Disassembled god class (List) and also significantly simplified the configuration. (One module and YAML/DBM instead of three modules and hand-rolled YAML file access.)
+* Separated all printing logic into presenter module.
+* Separated all DB access logic into configuration module.
+* Created Tasklist to manage task objects and maintain lists of valid tasks and all tasks.
+* Wrote specs for Configuration and Parser.
+* Added YARD-style documentation to all methods and classes.
+
+1.9.1 -- 1/21/14
+-------------------
+
+* Added editor-based descriptions: Define EDITOR in user config section and then include it in the new_task arglist to launch editor and capture description.
+* Times printed out in certain places are converted to minutes/hours/days as appropriate.
+* Added colorization on index key and task names in printout.
+* Some internal upgrades (refactoring, spacing issues, etc.)
+
+1.8.1 -- 12/30/13
+-------------------
+
+* Add "(No tasks in list.)" declaration so that the program always has SOME output.
+* Removed extra newline after task list printout. (Just trying to make thins look cleaner and more compact.)
+* Fixed build tool; Added a CUT HERE comment to day.rb which the build tool uses to split the file.
+* Updated build tool :update_version task to handle SemVer.
+
+1.8 -- 12/28/13
+-------------------
+
+* Removed unused 'commit' command code.
+* Added VERSION file to act as authoritative version source.
+* Added Rakefile to build project, incrementing version and date and also building one-file distributable.
+* Added string helper String.number? to avoid !nan? double negative & clarifying intention.
+* Added a general 'info' command which prints out all descriptions.
+* Updated options parsing when creating a new task so that everything after task name can be in any order. (Previously, the description had to come first.)
+* Added a very rudimentary help command and version printout command.
+* Added task-specific fulfillment clear function rather than forcing clear on all of them.
+
+1.7 -- 12/18/13
+-------------------
+
+* Changed 'info' command behavior to print out task title instead of just declaring `Description:'.
+* Added aliases: 'c' for clear, 'i' for info and 'rm' for delete
+* Added colorized output, but it's off by default. (I didn't want to make any assumptions regarding readability.) Colored output can be configured for titles, enter/exits, completion printouts, and the description-indicating star specifically, as well as all of the remaining text generally.
+* Cleaned up some cosmetic issues in code and comments, and a tiny typo in readme.
+* Updated error messages for clarity, verbosity, and style.
+* Extended list of enabled-day glyphs to include more partial-spellings of day names.
+
+1.6 -- 11/05/13
+-------------------
+
+* Removed bundler dependency, deleted Gemfile. (Literally the only dependency was bundler itself. I guess hardly anyone will NOT have bundler, but nevertheless it's useless and gone.)
+
+1.5 -- 10/29/13
+-------------------
+
+* Changed wording in program to use estimates instead of commitments.
+* Added optional descriptions for tasks.
+* Added info command to print out descriptions without checking-in.
+
+1.4 -- 9/13/13
+-------------------
+
+* Fixed daily fulfillments. Previously every time you exited a context it would reset the daily fulfillment counter.
+* Changed all time printouts to use 1 digit past the decimal.
+* Tracks and displays daily fulfillment for tasks that don't have commitments.
+
+1.3 -- 8/27/13
+-------------------
+
+* Printout will now clearly show tasks with commitments but no fulfillments.
+* Only update fulfillment on tasks that actually have commitments
+* Added day_fulfillment property on all tasks which resets every day and prints out how much progress you've made today.
+
+1.2 -- 8/23/13
+-------------------
+
+* Only display tasks if their specified days are blank or include today
+
+1.1 -- 8/23/13
+-------------------
+
+* Task list printout will now give progress on current task.
+

data/dayrb.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = 'dayrb'
+  s.version     = '2.0.2'
+  s.summary     = "To-do & Time-Tracking CLI App"
+  s.description = "Create and track time on tasks via command-line."
+  s.authors     = ["Cameron 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'
+  s.license       = 'MIT'
+end

data/lib/day/configuration.rb

@@ -0,0 +1,140 @@
+# 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'
+
+# Config class handles access to our config file, which mostly just provides a data-access layer.
+# Schema:
+#   configuration = {
+#       context = :task_key,
+#       entry_time = :task_start_time
+#       tasks = {
+#         :key => {
+#           :description => (string),
+#           :active_days => [(keys of active days)],
+#           :estimate => (integer in minutes),
+#           :fulfillment => (integer in minutes)
+#         }
+#       }
+#   }
+
+class Configuration
+  attr_reader :data, :context, :entry_time
+
+  # Load DB data and 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?
+  end
+
+  # Interface to save_task which decomposes opts hash.
+  #
+  # @param opts [Hash] options hash containing input data
+  def new_task(opts)
+    save_task(opts[:task], opts[:description], opts[:days], opts[:estimate])
+  end
+
+  # Change context to a different task.
+  # (Saves fulfillment for previous task.)
+  #
+  # @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
+  end
+
+  # Exit context without switching to a new one.
+  def clear_context()
+    cap_current_fulfillment
+    @data['context'], @data['entry_time'] = nil, nil
+  end
+
+  # Clear fulfillment for one or all tasks.
+  #
+  # @param task [String] valid task name to specify action for (defaults to all otherwise)
+  def clear_fulfillment(task)
+    if task
+      clear_fulfillment_for task
+    else
+      @data['tasks'].each do |task, task_data|
+        clear_fulfillment_for task
+      end
+    end
+  end
+
+  # Remove a task from config object data.
+  # (Note that this doesn't persist to the DBM files by itself...
+  # And again, the responsibility for calling save() and closing DB lies
+  # with the consumer of this class.)
+  #
+  # @param task_key [String] Valid task name to delete.
+  def delete(task_key)
+    @data['tasks'].delete task_key
+  end
+
+  # Reload class objects from config data.
+  # (Used during testing.)
+  def reload()
+    @context = @data['context']
+    @entry_time = @data['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)
+  end
+
+  # Used to verify that a task actually exists and to cross-reference indices to names
+  #
+  # @param task [String] name or index reference to task
+  def lookup_task(task)
+    if task.number?
+      @data['tasks'].keys[task.to_i]
+    else
+      task if @data['tasks'].has_key? task
+    end
+  end
+
+  private
+
+  # Add a new task to the DB.
+  #
+  # @param task [String] the task name
+  # @param description [String] a text description (optional)
+  # @param valid_days [Array] contains keys corresponding to the valid days, ie ['monday', 'tuesday'] (optional)
+  # @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,
+       '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'] = {}
+  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']
+  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
+  end
+end