tlog 0.2.0 → 0.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWY4Y2M1ZmFlOGRmOTUzMzVjMDY0MmZiZTIyMzAyOTAzYjY3ZGE0OA==
+    ZmJmMGNhZmU4MDBlZTg2NmNkOGIzYTNlNWE4MGVjZDBmZjIwZGQxNA==
   data.tar.gz: !binary |-
-    NDExZWNlMzcxY2Y1YTkwYmI4MTU4MWQ3ZjJiNGViOTEwNWFjMDYzNg==
+    OWJkODdkOGRhZGZlNDBmNTc1NmUxMjY4MzQ3N2UzZDNjMzFlNGQ1Mg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MzNiMzZiODgzY2QyOTc3NWY3MzU3MmIwY2U0YmUyNmQ4NTQzNGMyYmY0ZDE5
-    NTA3ODkzMzYxYTVmMTVkMGM2MjllNzQ4OTRiNGZjMzUzODk3YWNhOTNlY2Fj
-    NGMxNzllMjdlOWJhYzk4Mjk0Y2Q3YzhiNjhhNjQ5MjcyZGFhYjY=
+    YzBkNDY2NDVhNGMwNDYyNzFjYWEzYjE2ZWQwM2JhMjAzZjlkMmY4MTY3YmZi
+    MjU5OWIxNzNjYmNjZjUyOTlhMTg4NWJhNDAyOTdlMGE1YjczNGZiNGU0MmMy
+    YjU1YjgxMmRmY2U5MjY1NTFiMjE1NzQ3MjQ5MzgyMDhkNGFlOWM=
   data.tar.gz: !binary |-
-    M2M1ZWVlZjI2YjljZGIzNTFhNjNlYjgyZDNmYTQwZjQ1NDA0NDY5NmMzNGI0
-    MTdmMzFiZDQ5ZjFjMGMwY2MxNjFmNWU3NGRmZTI2NjEyOTc5OTkzMDdlZjQ4
-    MTU4ZjIwNzgzNGFiYTk1NzNmMTcyYzI0ODM2M2M4ZjJiMDA2MTU=
+    YjkwODIzMWI5N2RhODcxZDg3ZGE5ZGFmMWI5YTVmMjYxZjc2MmViY2JkYTA4
+    NjhjOTIwNGI4Y2Y4MGFlNmMyM2ExNjY5MDVhNTQ5MzQxYjM4Y2ZlMzIwYjBj
+    MWUzMmJlYjg3ZmY2YmQ0YWIxOWU0OTM4MTA5OGQxOTgwOTI4YzE=

data/README.md

@@ -8,68 +8,210 @@ A git-based CLI to help you with time tracking on your projects.
 $ sudo gem install tlog
 ```
 
-## Usage
+# Usage
 * Navigate to a directory that has a git repo
 
-### Create a time log
+## Create a time log
+
+#### Create a default time log with no goal
 ```bash
 $ tlog create example 
 ```
 
-### Check out a time log
+#### Create a time log with a time goal
 ```bash
-$ tlog checkout example
+$ tlog create example --goal 4hr
 ```
 
-### Create a time log with a time goal
+#### Create a new time log with a state and a points value
 ```bash
-$ tlog create example --goal 4hr
+$ tlog create example --state OPEN --points 10
 ```
+## Displaying time logs
 
-### Start a new task on a time log
+#### Display all time logs
 ```bash
-$ tlog start example -d "My task description"
+$ tlog display
+Log:    bugfix
+State:  open
+Points: 10
+Owner:  andrew
+	Start               End                    Duration          Description
+	June 06, 12:45PM   June 06, 12:46PM        1:00:27           fixing really bad bug
+	June 07, 
+----------------------------------------------------------------------------------------------------
+	Total                                      1:00:27 
+	Time left:                                 0:59:33
+Log:    important
+State:  closed
+Points: 0
+Owner:  chris
+	Start               End                    Duration          Description
+----------------------------------------------------------------------------------------------------
+	Total                                      0:00:00 
+Log:    feature1
+State:  hold
+Points: 5
+Owner:  peter
+	Start               End                    Duration          Description
+	June 13, 12:32PM   June 13, 12:33PM        0:00:34           making sure new feature works
+	June 13, 12:29PM   June 13, 12:32PM        0:02:30           working on new feature
+----------------------------------------------------------------------------------------------------
+	Total                                      0:03:04 
+	Time left:                                 3:56:56
+``` 
+
+#### Display a specific time log
+```bash
+$ tlog display feature1
+Log:    feature1
+State:  hold
+Points: 5
+Owner:  peter
+	Start               End                    Duration          Description
+	June 13, 12:32PM   June 13, 12:33PM        0:00:34           making sure new feature works
+	June 13, 12:29PM   June 13, 12:32PM        0:02:30           working on new feature
+----------------------------------------------------------------------------------------------------
+	Total                                      0:03:04 
+	Time left:                                 3:56:56
 ```
 
-### Stop the current task
+#### Constrain displayed time logs to only ones with specified states
 ```bash
-$ tlog stop example
+$ tlog display -s open,hold
+Log:    bugfix
+State:  open
+Points: 10
+Owner:  andrew
+	Start               End                    Duration          Description
+	June 06, 12:45PM   June 06, 12:46PM        1:00:27           fixing really bad bug
+	June 07, 
+----------------------------------------------------------------------------------------------------
+	Total                                      1:00:27 
+	Time left:                                 0:59:33
+Log:    feature1
+State:  hold
+Points: 5
+Owner:  peter
+	Start               End                    Duration          Description
+	June 13, 12:32PM   June 13, 12:33PM        0:00:34           making sure new feature works
+	June 13, 12:29PM   June 13, 12:32PM        0:02:30           working on new feature
+----------------------------------------------------------------------------------------------------
+	Total                                      0:03:04 
+	Time left:                                 3:56:56
+```
+#### Constrain displayed time logs to only ones with specified owners
+```bash
+$ tlog display -o chris,peter
+Log:    important
+State:  closed
+Points: 0
+Owner:  chris
+	Start               End                    Duration          Description
+----------------------------------------------------------------------------------------------------
+	Total                                      0:00:00 
+Log:    feature1
+State:  hold
+Points: 5
+Owner:  peter
+	Start               End                    Duration          Description
+	June 13, 12:32PM   June 13, 12:33PM        0:00:34           making sure new feature works
+	June 13, 12:29PM   June 13, 12:32PM        0:02:30           working on new feature
+----------------------------------------------------------------------------------------------------
+	Total                                      0:03:04 
+	Time left:                                 3:56:56
+```
+
+#### Contrain displayed time logs to only ones that have points values >= the specified points value
+```bash
+$ tlog display -p 10
+Log:    bugfix
+State:  open
+Points: 10
+Owner:  andrew
+	Start               End                    Duration          Description
+	June 06, 12:45PM   June 06, 12:46PM        1:00:27           fixing really bad bug
+	June 07, 
+----------------------------------------------------------------------------------------------------
+	Total                                      1:00:27 
+	Time left:                                 0:59:33
 ```
 
-### Show active time logs and label the current one, if it exists
+#### Constrain displayed time logs to only ones that have less than the specified amount of time left to finish
+```bash
+$ tlog display -g 1hr
+Log:    bugfix
+State:  open
+Points: 10
+Owner:  andrew
+	Start               End                    Duration          Description
+	June 06, 12:45PM   June 06, 12:46PM        1:00:27           fixing really bad bug
+	June 07, 
+----------------------------------------------------------------------------------------------------
+	Total                                      1:00:27 
+	Time left:                                 0:59:33
+```
+
+#### Show active time logs and label the checked-out log or the in-progress log
 ```bash
 $ tlog active
 All Time Logs:
 testing
-feature1(current)
+feature1(in-progress)
 bug fix
 feature2
 ```
- 
-### Display all the current time logs and their tasks, total time logged and time left.
+
+## Using time logs
+
+#### Check out a time log
+```bash
+$ tlog checkout example
+```
+
+#### Start a new task the checked-out time log
 ```bash
-$ tlog display
-Log: example1
-	Start               End                    Duration        Owner          Description
-	May 29, 11:57PM    May 29, 11:58PM         0:01:13         chriwend       My Description
-----------------------------------------------------------------------------------------------------
-	Total                                      0:01:13 
-Log: example2
-	Start               End                    Duration        Owner          Description
-	May 30, 12:00AM                            0:02:26         chriwend       Fixing bug
-	May 30, 12:00AM    May 30, 12:00AM         0:00:10         chriwend       (no description)
-----------------------------------------------------------------------------------------------------
-	Total                                      0:02:36 
-	Time left:                                 3:57:24
-``` 
+$ tlog start -d "My task description"
+```
+
+#### Update the state of the checked-out time log
+```bash
+$ tlog state CLOSED
+```
+
+#### Update the points value of the checked-out time log
+```bash
+$ tlog points 10
+```
 
-### Delete a time log
+#### Update the owner of the checked-out time log
+```bash
+$ tlog owner cewendel
+```
+
+#### Stop the current task
+```bash
+$ tlog stop example
+```
+
+#### Delete a time log
 ```bash
 $ tlog delete example
 ```
 
 ## Collaboration
-More to come on this after I test it...
+
+tlog makes for easy time and ticket tracking when working with a team. Assuming you have a remote repo that you and others are pushing to, use the `tlog push` and `tlog pull` commands to keep your time logs up to date.
+
+### Pull in new or updated time logs from upstream
+```bash
+$ tlog pull
+```
+
+### Push new or updated time logs upstream
+```bash
+$ tlog push
+```
 
 ## Contributing
 

data/TODO

@@ -1,4 +1,5 @@
 - tests
 - rakefile
 - time zones....
+- command aliases
 - display update speicifc states, points values, owners. goal times

data/lib/tlog/application.rb

@@ -1,61 +1,61 @@
 
 class Tlog::Application
 
-	def initialize(input, output)
-		@input = input
-		@output = output
-	end
-
-	def run
-		command_name = ""
-		outcome = false
-		begin
-			command_name = @input.args.shift
-			command = find(command_name)
-			prepare_command(command)
-			outcome = run_command(command)
-		rescue OptionParser::InvalidOption, OptionParser::MissingArgument
-			@output.error($!)
-			@output.error(@optparse.to_s)
-		rescue Tlog::Error::CommandInvalid
-			@output.error(command_name + " command invalid: " + $!.message)
-			@output.error(@optparse.to_s)
-		rescue Tlog::Error::CommandNotFound, OptionParser::MissingArgument
-			@output.error($!)
-			@output.error(@optparse.to_s)
-		rescue
-			@output.error($!)
-		end
-		return outcome
-	end
-
-	private
-
-	def find(command_name)
-		commands = Tlog::Command_Suite.commands
-		command = nil
-		commands.each do |cmd|
-			return cmd if cmd.name == command_name
-		end
-		command
-	end
-
-	def prepare_command(command)
-		if !command.nil?
-			@optparse = OptionParser.new do |parser|
-				command.options(parser, @input.options)
-			end
-			@optparse.parse!(@input.args)
-		end
-	end
-
-	def run_command(command)
-		if !command.nil?
-			command.execute(@input, @output)
-			true
-		else
-			raise Tlog::Error::CommandNotFound, "Command not found, use 'tlog help' for list of commands"
-		end
-	end
+  def initialize(input, output)
+    @input = input
+    @output = output
+  end
+
+  def run
+    command_name = ""
+    outcome = false
+    begin
+      command_name = @input.args.shift
+      command = find(command_name)
+      prepare_command(command)
+      outcome = run_command(command)
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+      @output.error($!)
+      @output.error(@optparse.to_s)
+    rescue Tlog::Error::CommandInvalid
+      @output.error(command_name + " command invalid: " + $!.message)
+      @output.error(@optparse.to_s)
+    rescue Tlog::Error::CommandNotFound, OptionParser::MissingArgument
+      @output.error($!)
+      @output.error(@optparse.to_s)
+    rescue
+      @output.error($!)
+    end
+    return outcome
+  end
+
+  private
+
+  def find(command_name)
+    commands = Tlog::Command_Suite.commands
+    command = nil
+    commands.each do |cmd|
+      return cmd if cmd.name == command_name
+    end
+    command
+  end
+
+  def prepare_command(command)
+    if !command.nil?
+      @optparse = OptionParser.new do |parser|
+        command.options(parser, @input.options)
+      end
+      @optparse.parse!(@input.args)
+    end
+  end
+
+  def run_command(command)
+    if !command.nil?
+      command.execute(@input, @output)
+      true
+    else
+      raise Tlog::Error::CommandNotFound, "Command not found, use 'tlog help' for list of commands"
+    end
+  end
 
 end

data/lib/tlog/command/active.rb

@@ -1,53 +1,53 @@
 
 class Tlog::Command::Active < Tlog::Command
 
-	def name 
-		"active"
-	end 
-
-	def description
-		"prints out all active time logs, the time log in-progress if there is one. Or the currently checked-out time log"
-	end
-
-	def execute(input, output)
-		print_time_entry(output)
-	end
-
-	def options(parser, options)
-		parser.banner = "usage: tlog active"
-	end
-
-	private
-
-	def print_time_entry(output)
-		storage.in_branch do |wd|
-			all_logs = @storage.all_log_dirs
-			active_logs = []
-			all_logs.each do |log|
-				log_name = log.basename.to_s
-				active_log = Tlog::Entity::Active_Log.new(log_name)
-				active_log.current = true if storage.current_log_name == log_name
-				active_log.checked_out = true if storage.checkout_value == log_name
-				active_logs.push(active_log)
-			end
-			output.line_yellow("All Time Logs:")
-			print_logs(active_logs, output)
-		end
-	end
-
-	def print_logs(active_logs, output)
-		active_logs.each do |active_log|
-			out_line = active_log.name
-			if active_log.current
-				out_line << " (in-progress)"
-				output.line_red(out_line);
-			elsif active_log.checked_out
-				out_line << " (checked_out)"
-				output.line_blue(out_line)
-			else
-				output.line(out_line)
-			end
-		end
-	end
+  def name 
+    "active"
+  end 
+
+  def description
+    "prints out all active time logs, the time log in-progress if there is one. Or the currently checked-out time log"
+  end
+
+  def execute(input, output)
+    print_time_entry(output)
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: tlog active"
+  end
+
+  private
+
+  def print_time_entry(output)
+    storage.in_branch do |wd|
+      all_logs = @storage.all_log_dirs
+      active_logs = []
+      all_logs.each do |log|
+        log_name = log.basename.to_s
+        active_log = Tlog::Entity::Active_Log.new(log_name)
+        active_log.current = true if storage.current_log_name == log_name
+        active_log.checked_out = true if storage.checkout_value == log_name
+        active_logs.push(active_log)
+      end
+      output.line_yellow("All Time Logs:")
+      print_logs(active_logs, output)
+    end
+  end
+
+  def print_logs(active_logs, output)
+    active_logs.each do |active_log|
+      out_line = active_log.name
+      if active_log.current
+        out_line << " (in-progress)"
+        output.line_red(out_line);
+      elsif active_log.checked_out
+        out_line << " (checked_out)"
+        output.line_blue(out_line)
+      else
+        output.line(out_line)
+      end
+    end
+  end
 
 end

data/lib/tlog/command/checkout.rb

@@ -1,36 +1,36 @@
 
 class Tlog::Command::Checkout < Tlog::Command
 
-	def name
-		"checkout"
-	end
-
-	def description 
-		"checkouts a time log in order to start tasks on"
-	end
-
-	def execute(input, output)
-		raise Tlog::Error::CommandInvalid, "Must specify log name" unless input.args[0]
-		checkout(input.args[0])
-		output.line("Checked-out log '#{input.args[0]}'");
-	end
-
-	def options(parser, options)
-		parser.banner = "usage: tlog checkout <log_name>"
-	end
-
-	private
-
-	def checkout(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
-			checked_out_log = storage.checkout_value
-			if checked_out_log == log.name
-				raise Tlog::Error::CommandInvalid, "Time log '#{log_name}' is currently checked out " 
-			end
-			storage.checkout_log(log)
-		end
-	end
+  def name
+    "checkout"
+  end
+
+  def description 
+    "checkouts a time log in order to start tasks on"
+  end
+
+  def execute(input, output)
+    raise Tlog::Error::CommandInvalid, "Must specify log name" unless input.args[0]
+    checkout(input.args[0])
+    output.line("Checked-out log '#{input.args[0]}'");
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: tlog checkout <log_name>"
+  end
+
+  private
+
+  def checkout(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
+      checked_out_log = storage.checkout_value
+      if checked_out_log == log.name
+        raise Tlog::Error::CommandInvalid, "Time log '#{log_name}' is currently checked out " 
+      end
+      storage.checkout_log(log)
+    end
+  end
 
 end

data/lib/tlog/command/create.rb

@@ -1,44 +1,44 @@
 
 class Tlog::Command::Create < Tlog::Command
 
-	def name
-		"create"
-	end
-
-	def description 
-		"creates a new time log either with no goal or with a goal"
-	end
-
-	def execute(input, output)
-		raise Tlog::Error::CommandInvalid, "Must specify log name" unless input.args[0]
-
-		log = Tlog::Entity::Log.new
-		log.name = input.args[0];
-		create_log(log, input.options)
-		output.line("Created log '#{log.name}'")
-	end
-
-	def options(parser, options)
-		parser.banner = "usage: tlog create <log_name>"
-
-		parser.on("-g", "--goal <goal_length>") do |goal|
-			options[:goal] = goal
-		end
-
-		parser.on("-s", "--state <initial_state>") do |state|
-			options[:state] = state
-		end
-
-		parser.on("-p", "--points <initial_points_value>") do |points|
-			options[:points] = points
-		end
-	end
-
-	private
-
-	def create_log(log, options)
-		storage.in_branch do |wd|
-			raise Tlog::Error::CommandInvalid, "Time log '#{log.name}' already exists" unless storage.create_log(log, options)
-		end
-	end
+  def name
+    "create"
+  end
+
+  def description 
+    "creates a new time log either with no goal or with a goal"
+  end
+
+  def execute(input, output)
+    raise Tlog::Error::CommandInvalid, "Must specify log name" unless input.args[0]
+
+    log = Tlog::Entity::Log.new
+    log.name = input.args[0];
+    create_log(log, input.options)
+    output.line("Created log '#{log.name}'")
+  end
+
+  def options(parser, options)
+    parser.banner = "usage: tlog create <log_name>"
+
+    parser.on("-g", "--goal <goal_length>") do |goal|
+      options[:goal] = goal
+    end
+
+    parser.on("-s", "--state <initial_state>") do |state|
+      options[:state] = state
+    end
+
+    parser.on("-p", "--points <initial_points_value>") do |points|
+      options[:points] = points
+    end
+  end
+
+  private
+
+  def create_log(log, options)
+    storage.in_branch do |wd|
+      raise Tlog::Error::CommandInvalid, "Time log '#{log.name}' already exists" unless storage.create_log(log, options)
+    end
+  end
 end