tlog 0.2.0 → 0.2.1

data/lib/tlog/command/delete.rb

@@ -1,30 +1,30 @@
 class Tlog::Command::Delete < Tlog::Command
 
-	def name
-		"delete"
-	end
+  def name
+    "delete"
+  end
 
-	def description
-		"deletes a time log"
-	end
+  def description
+    "deletes a time log"
+  end
 
-	def execute(input, output)
-		raise Tlog::Error::CommandInvalid, "Task does not exist" unless delete(input.args[0])
-		output.line("Deleted log '#{input.args[0]}'")
-	end
+  def execute(input, output)
+    raise Tlog::Error::CommandInvalid, "Task does not exist" unless delete(input.args[0])
+    output.line("Deleted log '#{input.args[0]}'")
+  end
 
-	def options(parser, options)
-		parser.banner = "usage: tlog delete <tlog_name>"
-	end
+  def options(parser, options)
+    parser.banner = "usage: tlog delete <tlog_name>"
+  end
 
-	private
+  private
 
-	def delete(log_name)
-		storage.in_branch do |wd|
-			log = storage.require_log(log_name)
-			raise Tlog::Error::TimeLogNotFound, "Time log '#{log_name}' does not exist" unless log
-			storage.delete_log(log) 
-		end
-	end
+  def delete(log_name)
+    storage.in_branch do |wd|
+      log = storage.require_log(log_name)
+      raise Tlog::Error::TimeLogNotFound, "Time log '#{log_name}' does not exist" unless log
+      storage.delete_log(log) 
+    end
+  end
 
 end

data/lib/tlog/command/display.rb

@@ -1,152 +1,199 @@
 
-# I will forever love whoever re-writes this class (badly needed) 
+# I will forever love whoever re-writes this class
 class Tlog::Command::Display < Tlog::Command
 
-	def name
-		"display"
-	end
-
-	def description
-		"displays shit"
-	end 
-
-	def execute(input, output)
-		raise Tlog::Error::CommandInvalid, "Logging invalid" unless display(input.args[0], input.options[:length], output)
-	end
-
-	def options(parser, options)
-		parser.banner = "usage: tlog log <log_name>"
-
-		parser.on("-l", "--length <length_threshold>") do |length|
-			options[:length] = length
-		end
-	end
-
-	private
-
-	def display(log_name, length_threshold, output)
-		storage.in_branch do |wd|
-			if storage.all_log_dirs
-				if log_name
-					display_log(log_name, length_threshold, output)
-				else	
-					display_all(length_threshold, output)
-				end 
-			else
-				output.line("No time logs yet");
-			end
-		end
-	end
-
-	def display_log(log_name, length_threshold, output)
-		log = storage.require_log(log_name)
-		log_length = log.goal_length
-		entries = log.entries
-		if storage.start_time_string && is_current_log_name?(log_name)
-			start_time = Time.parse(storage.start_time_string)
-		end
-		return if length_exceeds_threshold?(log_length, length_threshold)
-		print_log_info(log, output)
-		print_header(output)
-		print_current(log_name, log_length, start_time, output)
-		display_entries(entries, output) if entries
-		print_footer(log, log_length, output)
-	end
-
-	def display_all(length_threshold, output)
-		storage.all_log_dirs.each do |log_path|
-			log_basename = log_path.basename.to_s
-			display_log(log_basename, length_threshold, output)
-		end
-	end
-
-	def display_entries(entries, output)
-		if entries.size > 0
-			entries.each do |entry|
-				out_str = "\t%-4s   %16s %14s           %s" % [
-					date_time_format.timestamp(entry.time[:start]),
-					date_time_format.timestamp(entry.time[:end]),
-					seconds_format.duration(entry.length.to_s),
-					entry.description,
-				]
-				output.line(out_str)
-			end
-		end
-	end
-
-	def print_footer(log, log_length, output)
-		output.line "-" * 100
-		print_total(log, output)
-		print_time_left(log, output)
-	end
-
-	def print_header(output)
-		output.line("\tStart               End                    Duration          Description")
-	end 
-
-	def print_total(log, output)
-		#output.line("-") * 52
-		duration = log.duration
-		if storage.current_log_name == log.name
-			duration += storage.time_since_start
-		end
-		output.line("\tTotal%45s " % seconds_format.duration(duration))
-	end
-
-	def print_log_info(log, output)
-		out_str = "Log:    #{log.name}\nState:  #{log.state}\nPoints: #{log.points}\nOwner:  #{log.owner}"
-		output.line_yellow(out_str)
-	end
-
-	def print_time_left(log, output)
-		if log.goal
-			log_goal = log.goal
-			if (storage.current_log_name == log.name)
-				current_time = Time.now - storage.cur_start_time
-				log_goal -= current_time.to_i
-			end
-			log_goal = 0 if log_goal < 0
-			output.line_red("\tTime left: %39s" % seconds_format.duration(log_goal)) 
-		end
-	end
-
-	#should be added to entries array, not its own seperate thing
-	def print_current(log_name, log_length, current_start_time, output)
-		if is_current_log_name?(log_name)
-			formatted_length = seconds_format.duration storage.time_since_start
-			out_str = out_str = "\t%-4s  %16s  %14s           %s" % [
-				date_time_format.timestamp(current_start_time),
-				nil,
-				formatted_length,
-				storage.cur_entry_description, 
-			]
-			output.line(out_str)
-			storage.time_since_start
-		end
-	end
-
-	def length_exceeds_threshold?(log_length, length_threshold)
-		if length_threshold and log_length
-			length_threshold = ChronicDuration.parse(length_threshold)
-			if log_length - length_threshold > 0
-				true
-			else
-				false
-			end
-		else
-			false
-		end
-	end
-
-	def update_log_length(log_length)
-		log_length - storage.time_since_start if log_length
-	end
-
-	def is_current_log_name?(log_name)
-		if storage.current_log_name == log_name
-			true
-		else
-			false
-		end
-	end
+  def name
+    "display"
+  end
+
+  def description
+    "displays information about time logs. command options contrain which time logs are displayed"
+  end 
+
+  def execute(input, output)
+    display(input.args[0], input.options, output)
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: tlog display #{$0} [options]"
+
+    parser.on("-g", "--goal <goal_threshold>") do |goal|
+      options[:goal] = goal
+    end
+
+    parser.on("-o", "--owner a,b,c", Array, "Array of owners to display") do |owners|
+      options[:owners] = owners
+    end
+
+    parser.on("-p", "--points <points_threshold>") do |points|
+      options[:points] = points.to_i
+    end
+
+    parser.on("-s", "--state a,b,c", Array, "Array of states to display") do |states|
+      options[:states] = states
+    end
+
+  end
+
+  # Methods that filter which logs should be displayed
+
+  def log_goal_valid(log, thresholds)
+    goal_threshold = thresholds[:goal]
+    goal_threshold = ChronicDuration.parse(goal_threshold)
+    return false unless log.goal
+    goal_threshold >= log.goal ? valid = true : valid = false
+    valid
+  end
+
+  def log_owners_valid(log, thresholds)
+    owners = thresholds[:owners]
+    owners.each do |owner|
+      return true if log.owner == owner
+    end
+    false
+  end
+
+  def log_points_valid(log, thresholds)
+    points_value = thresholds[:points]
+    log.points >= points_value ? valid = true : valid = false
+    valid
+  end
+
+  def log_states_valid(log, thresholds)
+    states = thresholds[:states]
+    states.each do |state|
+      return true if log.state.downcase == state.downcase
+    end
+    false
+  end
+
+  private
+
+  def display(log_name, options, output)
+    storage.in_branch do |wd|
+      if storage.all_log_dirs
+        if log_name
+          display_log(log_name, options, output)
+        else  
+          display_all(options, output)
+        end 
+      else
+        output.line("No time logs yet");
+      end
+    end
+  end
+
+  def display_log(log_name, options, output)
+    log = storage.require_log(log_name)
+    raise Tlog::Error::CommandInvalid, "Time log '#{log_name}' does not exist" unless log
+    
+    log_length = log.goal_length
+    entries = log.entries
+    if storage.start_time_string && is_current_log_name?(log_name)
+      start_time = Time.parse(storage.start_time_string)
+    end
+    return unless log_valid?(log, options)
+
+    # Print out time log information
+    print_log_info(log, output)
+    print_header(output)
+    print_current(log_name, log_length, start_time, output)
+    display_entries(entries, output) if entries
+    print_footer(log, log_length, output)
+  end
+
+  def display_all(options, output)
+    storage.all_log_dirs.each do |log_path|
+      log_basename = log_path.basename.to_s
+      display_log(log_basename, options, output)
+    end
+  end
+
+  def log_valid?(log, thresholds = {})
+    thresholds.each do |key, value|
+      attribute_value = key.to_s
+      log_valid_method = "log_#{attribute_value}_valid"
+      if respond_to?(log_valid_method)
+        return false unless self.send(log_valid_method, log, thresholds)
+      end
+    end
+    true
+  end
+
+  def display_entries(entries, output)
+    if entries.size > 0
+      entries.each do |entry|
+        out_str = "\t%-4s   %16s %14s           %s" % [
+          date_time_format.timestamp(entry.time[:start]),
+          date_time_format.timestamp(entry.time[:end]),
+          seconds_format.duration(entry.length.to_s),
+          entry.description,
+        ]
+        output.line(out_str)
+      end
+    end
+  end
+
+  def print_footer(log, log_length, output)
+    output.line "-" * 100
+    print_total(log, output)
+    print_time_left(log, output)
+  end
+
+  def print_header(output)
+    output.line("\tStart               End                    Duration          Description")
+  end 
+
+  def print_total(log, output)
+    #output.line("-") * 52
+    duration = log.duration
+    if storage.current_log_name == log.name
+      duration += storage.time_since_start
+    end
+    output.line("\tTotal%45s " % seconds_format.duration(duration))
+  end
+
+  def print_log_info(log, output)
+    out_str = "Log:    #{log.name}\nState:  #{log.state}\nPoints: #{log.points}\nOwner:  #{log.owner}"
+    output.line_yellow(out_str)
+  end
+
+  def print_time_left(log, output)
+    if log.goal
+      log_goal = log.goal
+      if (storage.current_log_name == log.name)
+        current_time = Time.now - storage.cur_start_time
+        log_goal -= current_time.to_i
+      end
+      log_goal = 0 if log_goal < 0
+      output.line_red("\tTime left: %39s" % seconds_format.duration(log_goal)) 
+    end
+  end
+
+  #should be added to entries array, not its own seperate thing
+  def print_current(log_name, log_length, current_start_time, output)
+    if is_current_log_name?(log_name)
+      formatted_length = seconds_format.duration storage.time_since_start
+      out_str = out_str = "\t%-4s  %16s  %14s           %s" % [
+        date_time_format.timestamp(current_start_time),
+        nil,
+        formatted_length,
+        storage.cur_entry_description, 
+      ]
+      output.line(out_str)
+      storage.time_since_start
+    end
+  end
+
+  def update_log_length(log_length)
+    log_length - storage.time_since_start if log_length
+  end
+
+  def is_current_log_name?(log_name)
+    if storage.current_log_name == log_name
+      true
+    else
+      false
+    end
+  end
 end

data/lib/tlog/command/help.rb

@@ -1,38 +1,38 @@
 
 class Tlog::Command::Help < Tlog::Command
 
-	def name
-		"help"
-	end
-
-	def description
-		"outputs lists of commands and their descriptions"
-	end
-
-	def execute(input, output)
-		commands = Tlog::Command_Suite.commands
-		commands.sort! {|a,b| a.name <=> b.name}
-		max_name_length = 0
-
-		commands.each do |command|
-			name_length = command.name.length
-			max_name_length = name_length if name_length > max_name_length 
-		end
-
-		output.line("usage: tlog <command>")
-		output.line(nil)
-
-		commands.each do |command|
-			line = sprintf("%-#{max_name_length}s  %s", command.name, command.description)
-			output.line(line)
-		end
-
-		output.line(nil)
-		return true
-	end
-
-	def options(parser, options)
-		parser.banner = "usage: tlog help"
-	end
+  def name
+    "help"
+  end
+
+  def description
+    "outputs lists of commands and their descriptions"
+  end
+
+  def execute(input, output)
+    commands = Tlog::Command_Suite.commands
+    commands.sort! {|a,b| a.name <=> b.name}
+    max_name_length = 0
+
+    commands.each do |command|
+      name_length = command.name.length
+      max_name_length = name_length if name_length > max_name_length 
+    end
+
+    output.line("usage: tlog <command>")
+    output.line(nil)
+
+    commands.each do |command|
+      line = sprintf("%-#{max_name_length}s  %s", command.name, command.description)
+      output.line(line)
+    end
+
+    output.line(nil)
+    return true
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: tlog help"
+  end
 
 end

data/lib/tlog/command/owner.rb

@@ -1,34 +1,34 @@
 
 class Tlog::Command::Owner < Tlog::Command
 
-	def name 
-		"owner"
-	end 
+  def name 
+    "owner"
+  end 
 
-	def description
-		"changes the owner of the checked-out time log"
-	end
+  def description
+    "changes the owner of the checked-out time log"
+  end
 
-	def execute(input, output)
-		new_owner = input.args[0]
-		updated_log = change_owner(new_owner)
-		output.line("Changed owner of '#{updated_log.name}' to #{new_owner}")
-	end
+  def execute(input, output)
+    new_owner = input.args[0]
+    updated_log = change_owner(new_owner)
+    output.line("Changed owner of '#{updated_log.name}' to #{new_owner}")
+  end
 
-	def options(parser, options)
-		parser.banner = "usage: tlog owner <new_owner>"
-	end
+  def options(parser, options)
+    parser.banner = "usage: tlog owner <new_owner>"
+  end
 
-	private
+  private
 
-	def change_owner(new_owner)
-		storage.in_branch do |wd|
-			checked_out_log = storage.checkout_value
-			raise Tlog::Error::CheckoutInvalid, "No time log is checked out" unless checked_out_log
-			log = storage.require_log(checked_out_log)
-			raise Tlog::Error::TimeLogNotFound, "Time log '#{checked_out_log}' does not exist" unless log
-			storage.change_log_owner(log, new_owner)
-			log
-		end
-	end
+  def change_owner(new_owner)
+    storage.in_branch do |wd|
+      checked_out_log = storage.checkout_value
+      raise Tlog::Error::CheckoutInvalid, "No time log is checked out" unless checked_out_log
+      log = storage.require_log(checked_out_log)
+      raise Tlog::Error::TimeLogNotFound, "Time log '#{checked_out_log}' does not exist" unless log
+      storage.change_log_owner(log, new_owner)
+      log
+    end
+  end
 end

data/lib/tlog/command/points.rb

@@ -1,34 +1,34 @@
 
 class Tlog::Command::Points < Tlog::Command
 
-	def name 
-		"points"
-	end 
+  def name 
+    "points"
+  end 
 
-	def description
-		"changes the point value of the checked-out time log"
-	end
+  def description
+    "changes the point value of the checked-out time log"
+  end
 
-	def execute(input, output)
-		new_points_value = input.args[0]
-		update_log = change_state(new_points_value)
-		output.line("Changed points of '#{updated_log.name}' to #{new_points_value}")
-	end
+  def execute(input, output)
+    new_points_value = input.args[0]
+    update_log = change_state(new_points_value)
+    output.line("Changed points of '#{updated_log.name}' to #{new_points_value}")
+  end
 
-	def options(parser, options)
-		parser.banner = "usage: tlog points <new_points_value>"
-	end
+  def options(parser, options)
+    parser.banner = "usage: tlog points <new_points_value>"
+  end
 
-	private
+  private
 
-	def change_state(points)
-		storage.in_branch do |wd|
-			checked_out_log = storage.checkout_value
-			raise Tlog::Error::CheckoutInvalid, "No time log is checked out" unless checked_out_log
-			log = storage.require_log(checked_out_log)
-			raise Tlog::Error::TimeLogNotFound, "Time log '#{checked_out_log}' does not exist" unless log
-			storage.change_log_points(log, points)
-			log
-		end
-	end
+  def change_state(points)
+    storage.in_branch do |wd|
+      checked_out_log = storage.checkout_value
+      raise Tlog::Error::CheckoutInvalid, "No time log is checked out" unless checked_out_log
+      log = storage.require_log(checked_out_log)
+      raise Tlog::Error::TimeLogNotFound, "Time log '#{checked_out_log}' does not exist" unless log
+      storage.change_log_points(log, points)
+      log
+    end
+  end
 end

data/lib/tlog/command/pull.rb

@@ -1,27 +1,27 @@
 
 class Tlog::Command::Pull < Tlog::Command
 
-	def name
-		"pull"
-	end
+  def name
+    "pull"
+  end
 
-	def description 
-		"pulls time logs from upstream"
-	end
+  def description 
+    "pulls time logs from upstream"
+  end
 
-	def execute(input, output)
-		pull_logs
-	end
+  def execute(input, output)
+    pull_logs
+  end
 
-	def options(parser, options)
-		parser.banner = "usage: tlog pull"
-	end
+  def options(parser, options)
+    parser.banner = "usage: tlog pull"
+  end
 
-	private
+  private
 
-	def pull_logs
-		storage.in_branch do |wd|
-			storage.pull_logs
-		end
-	end
+  def pull_logs
+    storage.in_branch do |wd|
+      storage.pull_logs
+    end
+  end
 end