kale 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kale.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Charles Stuart
+
+MIT License
+
+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.md

@@ -0,0 +1,26 @@
+# Kale
+
+A command line application to to keep track of time spent on projects.
+
+Uses [sequel](http://sequel.rubyforge.org/index.html) for sqlite database access.
+
+## Installation
+
+    $ gem install kale
+
+## Usage
+
+    $ kale
+
+## TODO
+
+- ~~add ability to export an invoice~~
+- ~~add ability to track earnings~~
+- add ability to delete sessions
+- add ability to modify sessions
+- add PDF invoice exporting
+- add ability to mark sessions as "paid"
+
+## Screenshot
+
+![screenshot](http://d.pr/i/Dna5+)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/kale

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'kale'

data/kale.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kale/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "kale"
+  gem.version       = Kale::VERSION
+  gem.authors       = ["Charles Stuart"]
+  gem.email         = ["cs@enure.net"]
+  gem.description   = %q{Track time spent on projects, your earnings and export invoices.}
+  gem.summary       = %q{Keep track of time spent on projects.}
+  gem.homepage      = "https://github.com/enure/kale"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_runtime_dependency "sequel", "~> 4.1.1"
+  
+end

data/lib/kale.rb

@@ -0,0 +1,15 @@
+require "rubygems"
+require "sequel"
+
+require "kale/version"
+require "kale/db"
+require "kale/util"
+require "kale/html_invoice_exporter"
+require "kale/stopwatch"
+require "kale/project"
+require "kale/session"
+require "kale/ui"
+
+module Kale
+
+end

data/lib/kale/db.rb

@@ -0,0 +1,20 @@
+DB = Sequel.connect("sqlite://#{Dir.home}/Dropbox/Timer/timer.db")
+
+unless DB.table_exists? :projects
+  DB.create_table :projects do
+    primary_key :id
+    String :name
+    Integer :rate_per_hour
+  end
+end
+
+unless DB.table_exists? :sessions
+  DB.create_table :sessions do
+    primary_key :id
+    Integer  :project_id
+    String   :description
+    DateTime :start_time
+    DateTime :end_time
+    Integer  :elapsed_time
+  end
+end

data/lib/kale/html_invoice_exporter.rb

@@ -0,0 +1,82 @@
+class HTMLInvoiceExporter
+  
+  def initialize project
+    @project = project
+
+    self.prefix
+    self.body
+    self.suffix
+    
+    self.write
+  end
+  
+  protected
+  
+  def prefix
+    @html = %Q(
+      <!doctype html>
+      <html>
+        <head>
+          <title>
+            #{@project.name} Invoice
+          </title>
+        </head>
+      <body>
+    )
+  end
+  
+  def body
+    self.body_builder
+  end
+
+  def suffix
+    @html += "</body></html>"
+  end
+  
+  def write
+    filename = "#{@project.name}.html"
+    file = File.open filename, 'w+'
+    file.write @html
+    file.close
+    puts "Created an invoice - #{filename}"
+  end
+  
+  def body_builder
+    @html += %Q(
+      <h1>#{@project.name}</h1>
+      <table>
+        <thead>
+          <tr>
+            <th>Work</th>
+            <th>Time</th>
+          </tr>
+        </thead>
+        <tbody>
+    )
+    
+    @project.sessions.each do |session|
+      @html += %Q(
+        <tr>
+          <td>#{session.description}</td>
+          <td>#{session.elapsed_time}</td>
+        </tr>
+      )
+    end
+
+    @html += %Q(
+      </tbody>
+      <tfoot>
+        <tr>
+          <td>
+            #{seconds_to_hms(@project.total_time)}
+          </td>
+          <td>
+            #{@project.total_earned}
+          </td>
+        </tr>
+      </tfoot>
+    </table>
+    )
+  end
+
+end

data/lib/kale/project.rb

@@ -0,0 +1,14 @@
+class Project < Sequel::Model
+
+  one_to_many :sessions
+    
+  def total_time
+    times = self.sessions.collect { |s| s[:elapsed_time] }
+    times.inject{ |sum,x| sum + x }
+  end
+  
+  def total_earned
+    "$" + sprintf("%.2f", self.rate_per_hour.to_f * (total_time.to_f / 3600))
+  end
+
+end

data/lib/kale/session.rb

@@ -0,0 +1,27 @@
+class Session < Sequel::Model
+
+  many_to_one :project
+
+  def initialize
+    @stopwatch = Stopwatch.new
+    @stopwatch.start
+    
+    super
+  end
+  
+  def stop opts
+    @stopwatch.stop
+
+    self.start_time   = @stopwatch.start_time
+    self.end_time     = @stopwatch.end_time
+    self.elapsed_time = @stopwatch.elapsed_time
+    self.description  = opts[:description]
+    self.project      = opts[:project]
+    self.save
+  end
+  
+  def earned
+    "$" + sprintf("%.2f", self.project.rate_per_hour.to_f * (self.elapsed_time.to_f / 3600))
+  end
+
+end

data/lib/kale/stopwatch.rb

@@ -0,0 +1,17 @@
+class Stopwatch
+  
+  attr_accessor :start_time, :end_time
+
+  def start
+    self.start_time = Time.now
+  end
+
+  def stop
+    self.end_time = Time.now
+  end
+  
+  def elapsed_time
+    self.end_time - self.start_time
+  end
+
+end

data/lib/kale/ui.rb

@@ -0,0 +1,277 @@
+class Screen
+  
+  @@project = nil
+
+  def initialize
+    @menu = []
+
+    system "clear"
+    info
+    puts
+    puts "-------"
+    puts
+    menu
+    handle_menu
+  end
+
+  def menu
+    @menu.each_with_index do |item, idx|
+      puts "#{idx + 1}) #{item}"
+    end
+  end
+
+  protected
+
+  def show_projects show_id
+    if Project.all.length == 0
+      puts "No projects yet."
+    else
+      puts "## Your Projects\n\n"
+      Project.all.each do |p|
+        if show_id
+          puts "- #{p.name} (#{p.id})"
+        else
+          puts "- #{p.name}"
+        end
+      end
+    end
+  end
+
+  def show_project_heading
+    puts "You are working on #{@@project.name}"
+  end
+
+end
+
+class WelcomeScreen < Screen
+
+  def info
+    show_projects false
+  end
+
+  def menu
+    if Project.all.length > 0
+      @menu.push "New project"
+      @menu.push "Choose project"
+    else
+      @menu.push "New project"
+    end
+    super
+  end
+
+  def handle_menu
+    answer = gets.chomp
+
+    if answer == "1"
+      CreateProjectScreen.new
+    elsif answer == "2"
+      ChooseProjectScreen.new
+    end
+  end
+
+end
+
+class ChooseProjectScreen < Screen
+
+  def info
+    show_projects true
+  end
+
+  def menu
+    puts "Type the number or name of the project"
+  end
+
+  def handle_menu
+    answer = gets.chomp
+
+    if answer.length == 1
+      @@project = Project[:id => answer]
+    else
+      @@project = Project[:name => answer]
+    end
+
+    if @@project
+      ShowProjectScreen.new
+    else
+      system "clear"
+      puts "You are a bad typer, or maybe that project does not exist."
+      sleep(2)
+      ChooseProjectScreen.new
+    end
+  end
+
+end
+
+class CreateProjectScreen < Screen
+
+  def info
+    puts ""
+  end
+
+  def menu
+    puts "Type the name of your new project"
+  end
+
+  def handle_menu
+    name = gets.chomp
+    
+    system "clear"
+
+    puts "Type the rate per hour for this project (ex: 60)"
+    rate = gets.chomp
+
+    @@project = Project.create(:name => name, :rate_per_hour => rate)
+    ShowProjectScreen.new
+  end
+
+end
+
+class ShowProjectScreen < Screen
+
+  def info
+    show_project_heading
+  end
+
+  def menu
+    @menu.push "Start a work session"
+    @menu.push "Show work completed"
+    @menu.push "Create invoice"
+    @menu.push "Go to welcome screen"
+    @menu.push "Delete this project"
+    super
+  end
+
+  def handle_menu
+    answer = gets.chomp
+
+    if answer == "1"
+      DoWorkScreen.new
+    elsif answer == "2"
+      ShowSessionsForProjectScreen.new
+    elsif answer == "3"
+      CreateInvoiceScreen.new
+    elsif answer == "4"
+      WelcomeScreen.new
+    elsif answer == "5"
+      DeleteProjectScreen.new
+    end
+  end
+
+end
+
+class DoWorkScreen < Screen
+
+  def initialize
+    @session = Session.new
+    super
+  end
+
+  def info
+    show_project_heading
+  end
+
+  def menu
+    @menu.push "Stop Working"
+    @menu.push "Do not record this work."
+    super
+  end
+
+  def handle_menu
+    answer = gets.chomp
+
+    if answer == "1"
+      puts "Enter a description for the work you just completed."
+      description = gets.chomp
+      @session.stop({ :description => description, :project => @@project })
+      system "clear"
+      puts "You worked for #{seconds_to_hms(@session.elapsed_time)} on \"#{@session.description}\" and earned #{@session.earned}"
+      sleep(4)
+
+      ShowProjectScreen.new
+    elsif answer == "2"
+      # TODO put in check to verify user wants to discard work
+      ShowProjectScreen.new
+    end
+  end
+
+end
+
+class ShowSessionsForProjectScreen < Screen
+
+  def info
+    show_project_heading
+
+    puts
+
+    if @@project.sessions.length > 0
+      puts "## Work Completed\n"
+      @@project.sessions.each do |s|
+        puts "#{s.description} \t #{seconds_to_hms(s.elapsed_time)} \t #{s.earned}"
+      end
+
+      puts "\n## Total"
+      puts "#{seconds_to_hms(@@project.total_time)} \t #{@@project.total_earned}"
+    else
+      puts "You haven't worked on this project yet."
+    end
+  end
+
+  def menu
+    @menu.push "Go back to project"
+    super
+  end
+
+  def handle_menu
+    answer = gets.chomp
+
+    if answer == "1"
+      ShowProjectScreen.new
+    end
+  end
+
+end
+
+class DeleteProjectScreen < Screen
+
+  def info
+    puts "Are you sure you want to delete #{@@project.name}"
+  end
+
+  def menu
+    @menu.push "Yes"
+    @menu.push "NO"
+    super
+  end
+
+  def handle_menu
+    answer = gets.chomp
+
+    if answer == "1"
+      @@project.delete
+      WelcomeScreen.new
+    else
+      ShowProjectScreen.new
+    end
+  end
+
+end
+
+class CreateInvoiceScreen < Screen
+
+  def info
+    HTMLInvoiceExporter.new @@project
+  end
+  
+  def menu
+    @menu.push "Back to project"
+    super
+  end
+  
+  def handle_menu
+    answer = gets.chomp
+    ShowProjectScreen.new
+  end
+
+end
+
+WelcomeScreen.new

data/lib/kale/util.rb

@@ -0,0 +1,3 @@
+def seconds_to_hms seconds
+  Time.at(seconds).gmtime.strftime('%Hhr %Mm %Ss')
+end

data/lib/kale/version.rb

@@ -0,0 +1,3 @@
+module Kale
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: kale
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Charles Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+description: Track time spent on projects, your earnings and export invoices.
+email:
+- cs@enure.net
+executables:
+- kale
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/kale
+- kale.gemspec
+- lib/kale.rb
+- lib/kale/db.rb
+- lib/kale/html_invoice_exporter.rb
+- lib/kale/project.rb
+- lib/kale/session.rb
+- lib/kale/stopwatch.rb
+- lib/kale/ui.rb
+- lib/kale/util.rb
+- lib/kale/version.rb
+homepage: https://github.com/enure/kale
+licenses: []
+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.8.23
+signing_key: 
+specification_version: 3
+summary: Keep track of time spent on projects.
+test_files: []