dayrb 2.0.2

data/lib/day/parser.rb

@@ -0,0 +1,168 @@
+# DayRB Parser Module
+#
+# Parses and validates ARGV.
+# After validation, we can confidently assume a specified task in opts exists.
+#
+# MIT License; See LICENSE file; Cameron Carroll 2014
+
+require 'abbrev'
+
+E_NO_SUCH_TASK = "I didn't find any task by that name."
+E_MUST_SPECIFY_TASK = "I need you to specify which task to delete."
+
+# DayRB Parser Module
+#
+# Scans and validates ARGV inputs and builds the opts hash.
+# (Performs argument validation, and checks that a specified task really exists.)
+module Parser
+  class << self
+
+    # Parse ARGV into opts hash
+    #
+    # @param config [Configuration] Entire configuration object, needed for task lookups.
+    def parse_options(config)
+      opts = {}
+      @config = config
+
+      opts[:operation] = case ARGV.first
+      when nil
+        :print
+      when "-a", "-A"
+        opts[:all] = true
+        :print
+      when "clear", "c"
+        :clear
+      when "delete", "rm"
+        :delete
+      when "info", "i"
+        :print_info
+      when "help"
+        :print_help
+      when "version"
+        :print_version
+      else
+        handle_non_command(ARGV.first) # could either be a new task or switch to an existing one
+      end
+
+      opts[:task] = case opts[:operation]
+      when :clear, :print_info
+        check_for_second_argument
+      when :delete
+        demand_second_argument
+      when :switch
+        task = lookup_task(ARGV.first)
+        if task && @config.data['context'] == task
+          opts[:operation] = :leave
+          nil
+        elsif task
+          task
+        else
+          raise ArgumentError, E_NO_SUCH_TASK
+        end
+      when :new
+        ARGV.first
+      end
+
+      if opts[:operation] == :new
+        opts = handle_new_task(opts)
+      end
+
+      opts.delete_if { |k, v| v.nil? }
+      return opts
+    end
+
+    private
+
+    # Determine if a non-command argument corresponds to a :switch or a :new task
+    def handle_non_command(argument)
+      if argument.number? || lookup_task(argument) # then we switch to that task index or name
+        :switch
+      else # then we assume it's a new task to be created.
+        :new
+      end
+    end
+
+    # Check for ARGV[1] but don't raise error if it doesn't exist.
+    # But if we find a task name/index, we make sure it is valid.
+    def check_for_second_argument
+      if ARGV[1]
+        task = lookup_task(ARGV[1])
+        if task
+          task
+        else
+          raise ArgumentError, E_NO_SUCH_TASK
+        end
+      end
+    end
+
+    # Checks for second argument, but raises error if it doesn't exist.
+    def demand_second_argument
+      argument = check_for_second_argument
+      if argument
+        argument
+      else
+        raise ArgumentError, E_MUST_SPECIFY_TASK
+      end
+    end
+
+    # Check config data either for a task name or index.
+    def lookup_task(name)
+      @config.lookup_task(name)
+    end
+
+    # Gather remaining options for a new task
+    # Checks for a description (or a mention of EDITOR),
+    # valid days, and a time estimate.
+    def handle_new_task(opts)
+      ARGV[1..-1].each do |arg|
+        if arg =~ /\(.+\)/
+          next if opts[:editor]
+          opts[:description] = arg
+        elsif arg.downcase == EDITOR
+          opts[:editor] = true
+          opts[:description] = ''
+          tempfile = 'dayrb_description.tmp'
+          system("#{EDITOR} #{tempfile}")
+          input = ""
+          begin
+            File.open(tempfile, 'r') do |tempfile|
+              while (line = tempfile.gets)
+                opts[:description] << line.chomp
+              end
+            end
+
+            File.delete tempfile
+          rescue => err
+            raise ArgumentError, err
+          end
+        elsif arg.downcase.nan?
+          opts[:days] ||= []
+          key = parse_day_argument(arg)
+          if opts[:days].include? key
+            raise ArgumentError, "You specified a single day (#{key}) more than once."
+          else
+            opts[:days] << key
+          end
+        else
+          if opts[:estimate]
+            raise ArgumentError, 'You specified more than one time estimate.'
+          else
+            opts[:estimate] = arg.to_i * 60# convert to seconds for storage
+          end
+        end
+      end
+
+      return opts
+    end
+
+    # Check a possible valid-day argument against abbreviation list.
+    def parse_day_argument(day)
+      abbreviations = Abbrev.abbrev(%w{sunday monday tuesday wednesday thursday friday saturday})
+      if abbreviations.has_key? day
+        return abbreviations[day].to_sym
+      else
+        raise ArgumentError, "Couldn't parse which days to enable task."
+      end
+    end
+  end
+end

data/lib/day/presenter.rb

@@ -0,0 +1,223 @@
+# DayRB Presentation Module
+#
+# Handles printouts and error messages.
+# Also adds colorization as specified in main file.
+#
+# MIT License; See LICENSE file; Cameron Carroll 2014
+
+module Presenter
+	class << self
+
+		# Prints out task list and current context, if applicable.
+		#
+		# @param tasklist [Hash] Hash of task_name => task_object pairs
+		# @param context [String] Name of current task context
+		# @param time [String] Elapsed time since starting current task.
+		def print_list(tasklist, context, time)
+			if tasklist.empty?
+				print_error_empty
+			else
+				print_task_list(tasklist)
+			end
+			if context
+				print_current_context(context, time)
+			end
+		end
+
+		# Prints info for a specific task if provided.
+		# If not, prints out every description for tasks that have one.
+		#
+		# @param tasklist [Hash] Hash of task_name => task_object pairs
+		# @param task [String] Name of specific task to print info for.
+		def print_info(tasklist, task)
+			if task
+				task_object = tasklist[task]
+				if task_object.description
+					print_description task, task_object
+				else
+					puts "There was no description for #{task}."
+				end
+			else
+				tasklist.each do |task_name, task_object|
+					print_description task_name, task_object if task_object.description
+				end
+			end
+		end
+
+		# Prints out program help string
+		def print_help
+	    puts <<-eos
+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.
+
+Refer to a task either by its name or index.
+See readme.md for a more detailed overview.
+	    eos
+	  end
+
+	  # Prints out the VERSION constant
+		def print_version
+	    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
+
+	  # Announces that either a task or all tasks have had fulfillment cleared.
+	  #
+	  # @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
+	  end
+
+	  # Announces a switch to a new task...
+	  # also prints the amount of time spent on the old one.
+	  #
+	  # @param task [String] Name of task to switch to
+	  # @param old_task [String] Name of current context, before switching
+	  # @param old_time [String] Time spent since starting old_task
+	  def announce_switch(task, old_task, old_time)
+	  	puts "Switching to #{task}"
+	  	if old_task && old_time
+	  		puts "(Spent #{convert_time_with_suffix old_time} on #{old_task})"
+	  	end
+	  end
+
+	  # Announces that we leave current context, prints out time spent.
+	  # Used when not starting a new task.
+	  #
+	  # @param old_task [String] Name of current context
+	  # @param old_time [String] Time spent since starting old_task
+	  def announce_leave_context(old_task, old_time)
+	  	puts "Stopping tracking for #{old_task}"
+	  	puts "(Spent #{convert_time_with_suffix old_time})"
+	  end
+
+	  # Announces the creation of a new task.
+	  #
+	  # @param task [String] Name of task to be added
+	  def announce_new_task(task)
+	  	puts "Added new task, #{task}"
+	  end
+
+		private
+
+		# Iterate through tasklist, printing index, name, description flag and fulfillment/estimate data.
+		#
+		# @param tasks [Hash] Collection of task_name => task_object pairs
+		def print_task_list(tasks)
+			ii = 0
+			# indexing the hash as an array
+			# task[0] contains key (task name)
+			# task[1] contains task object
+			tasks.each_with_index do |task, ii|
+				task_name = task[0]
+				task_object = task[1]
+				print ii.to_s.color_index + ': ' + task_name.color_task
+	      print "*".color_star if task_object.description
+	      print_fulfillment(task_object.fulfillment, task_object.time_estimate)
+	      puts "\n"
+			end
+		end
+
+		# Print/format fulfillment and estimate data.
+		#
+		# @param fulfillment [Integer] Time spent on task in seconds
+		# @param estimate [Integer] Estimated time for task in seconds
+		def print_fulfillment(fulfillment, estimate)
+			if fulfillment
+				if estimate
+					diff = fulfillment.to_f / estimate.to_f * 100
+					print " [#{convert_time(fulfillment)}".color_completion + "/#{convert_time_with_suffix(estimate)}]".color_text
+					print " [#{'%2.1f' % diff}%]".color_completion
+				else
+					print " [#{convert_time_with_suffix(fulfillment)}]"
+				end
+			elsif estimate
+				print " (#{convert_time_with_suffix(estimate)} estimate)"
+			end
+	  end
+
+	  # Print task name and description.
+	  #
+	  # @param task_name [String] Name of task
+	  # @param task_object [Task] Task object to print description for
+	  def print_description(task_name, task_object)
+	  	print "Description for #{task_name}: "
+	  	puts task_object.description
+	  end
+
+	  # Print information about the current task.
+	  #
+	  # @param context [String] Name of current task
+	  # @param time [Integer] Time spent on current task in seconds
+	  def print_current_context(context, time)
+	  	puts "Current task: #{context} (#{convert_time_with_suffix(time)})"
+	  end
+
+	  # Convert seconds into a more appropriate amount.
+	  # Hours and days also return the leftover minutes and hours, respectively.
+	  #
+	  # @param seconds [Integer] Time to be converted in seconds.
+	  def convert_time(seconds)
+	  	if seconds < 60
+	  		return ('%1.0f' % seconds)
+	  	elsif seconds >= 60 && seconds < 3600
+	  		return ('%2.1f' % (seconds/60))
+	  	elsif seconds >= 3600 && seconds < 86400
+	  		hours = seconds / 3600
+	      leftover_minutes = seconds % 3600 / 60
+	      return ('%1.0f' % hours), ('%2.1f' % leftover_minutes)
+	  	elsif seconds >= 86400
+	  		days = seconds / 86400
+	      leftover_hours = seconds % 86400 / 3600
+	      return ('%1.0f' % days), ('%2.1f' % leftover_hours)
+	  	end
+	  end
+
+	  # Formats the results of convert_time into a human-readable string.
+	  #
+	  # @param seconds [Integer] Time to be converted in seconds.
+	  def convert_time_with_suffix(seconds)
+	  	first_result, second_result = convert_time(seconds)
+	    if seconds < 60
+	      "#{first_result} seconds"
+	    elsif seconds >= 60 && seconds < 3600
+	      "#{first_result} minutes"
+	    elsif seconds >= 3600 && seconds < 86400
+	      "#{first_result} hours and #{second_result} minutes"
+	    elsif seconds >= 86400
+	      "#{first_result} days and #{second_result} hours"
+	    end
+	  end
+
+	  # Print empty-tasklist error.
+	  def print_error_empty()
+	  	puts "The task list is empty!"
+	  end
+
+	  # Print unknown error.
+		def print_error_unknown()
+			puts "Sorry, that command is not known. Try 'help'."
+		end
+	end
+end

data/lib/day/task.rb

@@ -0,0 +1,44 @@
+# DayRB Task Class
+#
+# Has essentially only one function, which is to perform valid_today? checks.
+# But maybe we'll just keep it and give it more responsibility later.
+#
+# MIT License; See LICENSE file; Cameron Carroll 2014
+
+class Task
+
+  attr_reader :name, :valid_days, :description, :time_estimate, :fulfillment
+
+  def initialize(name, description, valid_days, time_estimate, fulfillment)
+    @name = name
+    @valid_days = valid_days
+    @description = description
+    @time_estimate = time_estimate
+    @fulfillment = fulfillment
+  end
+
+  # Determine whether the task is valid today.
+  def valid_today?
+    if @valid_days
+      today = Time.new.wday #0 is sunday, 6 saturday
+
+      weekday_key = case today
+      when 0 then :sunday
+      when 1 then :monday
+      when 2 then :tuesday
+      when 3 then :wednesday
+      when 4 then :thursday
+      when 5 then :friday
+      when 6 then :saturday
+      end
+
+      if (@valid_days.include?(weekday_key) || @valid_days.empty?)
+        return true
+      else
+        return false
+      end 
+    else
+      return true # valid everyday
+    end
+  end
+end

data/lib/day/tasklist.rb

@@ -0,0 +1,44 @@
+# DayRB Tasklist Module
+#
+# MIT License; See LICENSE file; Cameron Carroll 2014
+
+require_relative 'task'
+
+# DayRB Tasklist Module
+#
+# Responsible for loading tasks.
+# Mainly to manage a list of tasks which are valid today,
+# but also allow us to use the '-a' option.
+class Tasklist
+	attr_reader :all_tasks, :valid_tasks
+
+	def initialize(config)
+		@config = config
+		@all_tasks = load_tasks(config.data['tasks'])
+		today = Time.new.strftime("%A").downcase.to_sym
+		@valid_tasks = @all_tasks.select do |task_name, task_object|
+			if task_object.valid_days
+				task_object.valid_days.include? today
+			else
+				true
+			end
+		end
+	end
+
+	private
+
+	# Build array of task objects from their DB records.
+	#
+	# @param tasks [Hash] Collection of task_name => task_hash pairs
+	def load_tasks(tasks)
+	  task_objects = {}
+	  unless tasks.empty?
+	    tasks.each do |task_name, task|
+	      task_objects[task_name] = Task.new(task_name, task['description'], task['valid_days'],
+	       task['estimate'], task['fulfillment'])
+	    end
+	  end
+
+	  return task_objects
+	end
+end

data/readme.md

@@ -0,0 +1,53 @@
+day.rb
+======
+(Version 2.0.1 -- August 2014)
+
+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.
+
+Requirements:
+-------------
+* Ruby (Tested with 2.1.2)
+
+Installation:
+-------------
+
+### Method 1: Download a Release (One File)
+
+* Head on over to the [Releases Page](https://github.com/sanarothe/day/releases)
+* Download the latest "one-file distributable" version of day.rb
+* Stick it in your favorite bin folder. (~/bin)
+* Chmod it to be executable (chmod +x ~/bin/day.rb)
+
+### Method 2: Clone the Repository (Entire Folder)
+
+* Clone the repository to your favorite apps folder. (git clone https://github.com/sanarothe/day.git ~/apps)
+* Symlink day.rb into your favorite bin folder. (ln -s ~/apps/day/day.rb ~/bin/day)
+* Chmod it to be executable (chmod +x ~/bin/day)
+
+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

data/spec/configuration_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+require 'fileutils'
+describe Configuration do
+
+	describe "#initialize" do
+		before :each do
+			bootstrap
+		end
+
+		it "accepts a file path and creates a DB file." do
+			expect(File.exists?(FULL_FILE_PATH)).to be(true)
+		end
+
+		it "bootstraps the DB" do
+			expect(@config.data['tasks'].class).to be(Hash)
+		end
+	end
+
+	describe "#new_task" do
+		before :each do
+			bootstrap
+		end
+
+		it "adds a task to the database" do
+			test_name = 'test_task_name'
+			opts = {:task => test_name, :description => 'some description'}
+			expect(@config.data['tasks'][test_name]).to be(nil)
+			@config.new_task(opts)
+			@config.reload
+			expect(@config.data['tasks'][test_name]).to be_truthy
+		end
+	end
+
+	describe "#switch_to" do
+		before :each do
+			bootstrap
+		end
+
+		it "should enter a new context (no current)" do
+			expect(@config.data['context']).to eq(nil)
+			@config.switch_to("test")
+			expect(@config.data['context']).to eq("test")
+		end
+
+		it "should enter a new context (given a current one)" do
+			bootstrap_task("test2")
+			@config.switch_to("test")
+			expect(@config.data['context']).to eq("test")
+			@config.switch_to("test2")
+			expect(@config.data['context']).to eq("test2")
+		end
+	end
+
+	describe "#delete" do
+		before :each do
+			bootstrap
+		end
+
+		it "should remove a task from data" do
+			expect(@config.data['tasks']['test']).to be_truthy
+			@config.delete("test")
+			expect(@config.data['tasks']['test']).not_to be_truthy
+		end
+	end
+
+	describe "#clear_context" do
+		before :each do
+			bootstrap
+		end
+
+		it "should clear context given a current one" do
+			@config.switch_to("test")
+			expect(@config.data['context']).to eq("test")
+			@config.reload
+			@config.clear_context
+			expect(@config.data['context']).to eq(nil)
+		end
+
+		it "should add time to the fulfillment" do
+			@config.switch_to("test")
+			@config.reload
+			@config.clear_context
+			expect(@config.data['tasks']['test']['fulfillment']).to be_truthy
+		end
+	end
+
+	describe "#clear_fulfillment" do
+		before :each do
+			bootstrap
+		end
+
+		it "should clear fulfillment for a specified task" do
+			@config.switch_to("test")
+			@config.reload
+			@config.clear_context
+			@config.reload
+			expect(@config.data['tasks']['test']['fulfillment']).to be_truthy
+			@config.clear_fulfillment("test")
+			@config.reload
+			expect(@config.data['tasks']['test']['fulfillment']).not_to be_truthy
+		end
+
+		it "should clear fulfillment for all tasks otherwise" do
+			@config.switch_to("test")
+			@config.reload
+			@config.clear_context
+			@config.reload
+			expect(@config.data['tasks']['test']['fulfillment']).to be_truthy
+			@config.clear_fulfillment(nil)
+			@config.reload
+			expect(@config.data['tasks']['test']['fulfillment']).not_to be_truthy
+		end
+	end
+
+	describe "#lookup_task" do
+		before :each do
+			bootstrap
+		end
+
+		it "should return a task name given a corresponding name" do
+			input = "test"
+			expect(@config.lookup_task(input)).to eq(input)
+		end
+
+		it "should return a task name given a corresponding index" do
+			input = "0"
+			expected = "test"
+			expect(@config.lookup_task(input)).to eq(expected)
+		end
+
+		it "should return nil given a non-task name" do
+			input = "non-task"
+			expect(@config.lookup_task(input)).to eq(nil)
+		end
+
+		it "should return nil given an out-of-bound index" do
+			input = "1"
+			expect(@config.lookup_task(input)).to eq(nil)
+		end
+	end
+
+end