timecard 0.0.1

data/CHANGELOG

@@ -0,0 +1,5 @@
+= 0.0.1 (2011-07-04)
+
+* Initial release
+* Basic CLI Interface (I assume it won't work on Windows due to TTY tricks)
+* Automatically pauses when the computer sleeps

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright  (c) 2011 Gabe da Silveira
+
+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/README.rdoc

@@ -0,0 +1,30 @@
+= Timecard
+
+This is a simple CLI time tracker.  You start it, you type in a task and it displays a running timer which can be
+paused.  When you are finished it will output a summary of tasks with individual time segments broken down.
+
+== Installation
+
+  gem install timecard
+
+== Usage
+
+The a binary utility is installed with the gem, simply call:
+
+  timecard
+
+And you're off to the races.  Note that the interactive text goes to STDERR while the final summary goes to STDOUT, so
+you can redirect to a log for future reference:
+
+  timecard > time.log
+
+== TODO
+
+* Separate the state machine and core functionality from the CLI interface so it can be plugged into a web UI or
+  something that works on Windows.
+* Write some meaningful specs.  Obviously this will be much easier when CLI concerns aren't woven throughout the core
+  logic.
+
+== Copyright
+
+Copyright (c) 2011 Gabe da Silveira. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "timecard"
+  gem.homepage = "http://github.com/dasil003/timecard"
+  gem.license = "MIT"
+  gem.summary = "Simple CLI time tracker"
+  gem.description = "Simple UNIX shell time tracker"
+  gem.email = "gabe@websaviour.com"
+  gem.authors = ["Gabe da Silveira"]
+
+  gem.bindir = 'bin'
+
+  gem.add_development_dependency "rspec", "~> 2.3.0"
+  gem.add_development_dependency "jeweler", "~> 1.6.3"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "timecard #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/timecard

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'timecard'
+
+Timecard.invoke

data/lib/timecard.rb

@@ -0,0 +1,151 @@
+module Timecard
+  DEBUG = false
+
+  class << self
+    def invoke
+      $stderr.puts "=== Welcome to Ruby Timecard! ==="
+
+      @tasks = []
+      @new_input = nil
+
+      Signal.trap("INT") do
+        dump_tasks
+        exit(0)
+      end
+
+      state_loop(:ask_task)
+    end
+
+    def state_loop(state)
+      loop do
+        $stderr.puts "Entering state #{state}..." if DEBUG
+        state = send(state)
+      end
+    end
+
+    def ask_task
+      $stderr.print "What will you work on now? "
+
+      @task_name = $stdin.readline.chomp
+      @tasks << {:name => @task_name, :time_pairs => []}
+
+      :time_loop
+    end
+
+    def time_loop
+      @start_time = @last_time = Time.now
+
+      await_input
+
+      loop do
+        if (Time.now - @last_time) > 5.0
+          $stderr.puts "#{clearline}Detected Sleep Auto-Pausing for #{format_seconds(Time.now - @last_time)}"
+          @tasks.last[:time_pairs] << [@start_time, @last_time]
+          @start_time = Time.now
+        end
+
+        next_state = process_input { |input| time_loop_transition(input) }
+        return next_state if next_state
+
+        elapsed = Time.now - @start_time
+        $stderr.print "#{clearline}*#{format_seconds(sum_time_pairs(@tasks.last) + elapsed)} * #{@task_name} (p: pause   f: next task   q: finish & quit)"
+        @last_time = Time.now
+        sleep(0.5)
+      end
+    end
+
+    def time_loop_transition(command)
+      @tasks.last[:time_pairs] << [@start_time, Time.now]
+      @start_time = nil
+
+      case command
+      when 'p'
+        :pause_task
+      when 'f'
+        :finish_task
+      when 'q'
+        :finish_and_quit
+      end
+    end
+
+    def pause_task
+      $stderr.print "#{clearline}*#{format_seconds(sum_time_pairs(@tasks.last))} * #{@task_name} (paused, any key to resume)"
+
+      await_input
+
+      loop do
+        next_state = process_input { |input| :time_loop }
+        return next_state if next_state
+
+        sleep(0.5)
+      end
+    end
+
+    def finish_task
+      $stderr.print clearline
+      $stderr.puts ">#{format_seconds(sum_time_pairs(@tasks.last))} #{@tasks.last[:name]}"
+      return :ask_task
+    end
+
+    def finish_and_quit
+      $stderr.print clearline
+      $stderr.puts ">#{format_seconds(sum_time_pairs(@tasks.last))} #{@tasks.last[:name]}"
+      dump_tasks
+      exit(0)
+    end
+
+    def dump_tasks
+      if @tasks.any?
+        puts "\n"
+        i = 0
+        @tasks.each do |task|
+          i += 1
+          puts "Task ##{i}: #{task[:name]} #{format_seconds(sum_time_pairs(task))}"
+          task[:time_pairs].each { |pair| puts "  " + pair.inspect + " " + format_seconds(pair.last - pair.first) }
+        end
+      end
+    end
+
+    private
+
+    def format_seconds(seconds)
+      seconds = seconds.to_i
+      minutes = seconds / 60
+      seconds = seconds % 60
+      hours = minutes / 60
+      minutes = minutes % 60
+      sprintf("%2d:%02d:%02d", hours, minutes, seconds)
+    end
+
+    def await_input
+      Thread.start do
+        @new_input = get_char
+        $stdin.flush
+      end
+    end
+
+    def get_char
+      system("stty raw -echo") #=> Raw mode, no echo
+      char = $stdin.getc
+      system("stty -raw echo") #=> Reset terminal mode
+      Process.kill("INT", $$) if char == "\u0003"
+      char
+    end
+
+    def clearline
+      "\r\e[0K"
+    end
+
+    def sum_time_pairs(task)
+      task[:time_pairs].inject(0){ |sum,p| sum + (p.last - p.first) }
+    end
+
+    def process_input
+      if @new_input
+        input = @new_input
+        @new_input = nil
+        yield(input)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'timecard'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/timecard_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Timecard" do
+  it "has DEBUG disabled" do
+    Timecard::DEBUG.should == false
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: timecard
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gabe da Silveira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.3
+  type: :development
+  version_requirements: *id002
+description: Simple UNIX shell time tracker
+email: gabe@websaviour.com
+executables: 
+- timecard
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- CHANGELOG
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/timecard
+- lib/timecard.rb
+- spec/spec_helper.rb
+- spec/timecard_spec.rb
+homepage: http://github.com/dasil003/timecard
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Simple CLI time tracker
+test_files: []
+