rtt 0.0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2007, 2008, 2009 Blake Mizerany
+
+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/Manifest

@@ -0,0 +1,28 @@
+LICENSE
+Manifest
+README.rdoc
+Rakefile
+USAGE.txt
+bin/rtt
+db/rtt.sqlite3
+db/test.sqlite3
+db/test.sqlite3-journal
+init.sh
+lib/rtt.rb
+lib/rtt/client.rb
+lib/rtt/cmd_line_interpreter.rb
+lib/rtt/hash_extensions.rb
+lib/rtt/project.rb
+lib/rtt/query_builder.rb
+lib/rtt/report_generator.rb
+lib/rtt/storage.rb
+lib/rtt/task.rb
+lib/rtt/user.rb
+lib/rtt/user_configurator.rb
+rtt.gemspec
+rtt_report
+spec/datamapper_spec_helper.rb
+spec/lib/rtt/task_spec.rb
+spec/lib/rtt_spec.rb
+tasks/rtt.rake
+todo.txt

data/README.rdoc

@@ -0,0 +1,78 @@
+RTT - Ruby Time Tracker
+-----------------------
+-----------------------
+
+RTT is a tool for tracking time. It's primary extend is to be used from command line. It could be used by simple typing:
+
+$ rtt start <task-name> 
+
+If no <task-name> is specified the last paused one is activated, otherwise a task with 'Default task' name would be created.
+
+Then to stop the timer, you can do:
+
+$ rtt stop
+
+Also, by just typying: 'rtt start', without specifying the task, it would default to the previous task.
+
+If you start a task with the same name as one already stored for the very same day, then the elapsed time for both activities will be sum into just one task.
+
+Installation
+------------
+
+[sudo] gem install rtt
+
+After installing the gem you will need to setup some basic information of yours (data to be printed in the reports). With the following command:
+
+$ rtt user <user-nick-name>
+
+Then you will be prompt for First name, Last name, country, city, e-mail, site, etc. Information that will be used to fill-in the reports. 
+
+The only required field is the Nickname, which identifies the user.
+
+How to start a task?
+--------------------
+
+$ rtt '<task-name>' ( or the more explicit way: 'rtt start <task-name>')
+..
+
+That simple!
+
+More about the API
+------------------
+
+Task can be grouped in Projects. For that you must set the project before starting the timer, in the following way:
+
+$ rtt project <project-name>
+..
+
+Anagolous, you can define a Client for the current project by typing:
+
+$ rtt client <client-name>
+
+To list all task you can use
+
+$ rtt list
+
+Also, if you have added times for different projects or clients and you may want to filtered this list by one of those dimensions. Then you can do that, by using environment variables like this:
+
+$ CLIENT=MyClient PROJECT=SomeProject rtt list
+
+This command will list all tasks that belongs to the client called 'MyClient' and to the project called 'SomeProject'.
+
+Report
+-------
+
+RTT allow you to build a pdf document with all the entries using the following command:
+
+$ rtt report <output-filename>
+
+Also, you can filter the entries of this report in a similar manner as you would do for 'list' command. For example:
+
+$ PROJECT=SomeProject rtt report
+
+This will generate a report for the project 'SomeProject'.
+
+Questions/Comments
+------------------
+
+Feel free to email {Marcelo Andrés Giorgi Martínez}[mailto:marklazz.uy@gmail.com] for any comment or question.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'echoe'
+
+# PACKAGING ============================================================
+
+Echoe.new('rtt', '0.0.0.1') do |p|
+  p.description = 'RTT is a tool for tracking time'
+  p.url = 'http://www.marklazz.com'
+  p.author = 'Marcelo Giorgi'
+  p.email = 'marklazz.uy@gmail.com'
+  p.ignore_pattern = [ 'tmp/*', 'script/*' ]
+  p.runtime_dependencies = [ ['highline', ">= 1.5.2"], ['activesupport', '>= 2.3.0'], ['prawn', '>= 0.8.0'], ['dm-core', '>= 1.0.0'], [ 'dm-migrations', '>= 1.0.0'] ]
+  p.development_dependencies = [ 'spec' ]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/USAGE.txt

@@ -0,0 +1,13 @@
+RTT is a tool for tracking time. It's primary extend is to be used from command line.
+
+Usage:
+
+ rtt start <task-name>
+ rtt pause
+ rtt stop
+ rtt user <nickname>
+ rtt client <client-name>
+ rtt project <project-name>
+ rtt rename <new-name-current-task>
+ rtt list
+ rtt report <filename>.pdf

data/bin/rtt

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# The command line Haml parser.
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rtt'
+Rtt.init
+command = Rtt.capture(ARGV)
+Rtt.execute(command)

data/init.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+rm db/rtt.sqlite3
+bin/rtt client 'Emex'
+bin/rtt project 'Emex'
+bin/rtt user #'marklazz' 'Marcelo' 'Giorgi' 'marklazz' 'marklazz.uy@gmail.com' 'Uruguay' 'Montevideo' 'Palermo 5626/302' '+598 2 6000437' 'www.marklazz.com'

data/lib/rtt.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby -w
+%w( rubygems spec dm-core dm-validations dm-migrations active_support highline/import).each { |lib| require lib }
+Dir[File.expand_path(File.join(File.dirname(__FILE__), 'rtt', '*'))].each { |lib| require lib; }
+
+module Rtt
+
+  VERSION = '1.0'
+
+  extend self
+
+  class << self
+    
+    include CmdLineInterpreter
+    include QueryBuilder
+    include ReportGenerator
+    include Storage
+
+    def current_user
+      User.first :active => true
+    end
+
+    def set_user(nickname = nil)
+      current_user.deactivate if current_user
+      if nickname && (user = User.first(:nickname => nickname)).present?
+        user.activate
+      else
+        extend(UserConfigurator)
+        configure_user(nickname)
+      end
+    end
+
+    # Change the name of the current task.
+    #
+    # Usage
+    #
+    # rename 'new_timer_name' => Doesn't change task#start_at
+
+    def rename task_name
+      task = current_task
+      if task
+        task.name = task_name
+        task.save
+      end
+    end
+
+    # Lists all entries filtered by parameters
+    #
+    # For example:
+    #   Rtt.list :from => '2010-5-3', :to => '2010-5-20'
+    #
+    def list options = {}
+      puts 'Task List'
+      puts '========='
+      query(options).each do |task|
+        puts "Name: #{task.name} elapsed time: #{task.duration} #{'[ACTIVE]' if task.active}"
+      end
+    end
+
+
+    # Used to set the client at system level.
+    #
+    # Usage
+    #
+    # pause
+    def pause
+      current_task.pause if current_task
+    end
+    
+    #
+    # Used to set the client at system level.
+    #
+    # Usage
+    #
+    # set_client name
+    def set_client name
+      deactivate_current_client if current_client
+      client = client(name)
+      client.activate
+    end
+
+    def set_project project_name, client_name = nil
+      deactivate_current_project if current_project
+      client = client(client_name) unless client_name.nil?
+      project = Project.first_or_create :name => project_name, :description => project_name
+      project.activate_with_client(client)
+    end
+
+    # Starts a new timer. It stops the current task if there is any.
+    #
+    # Usage
+    #
+    # start a time new:
+    #
+    # start 'new_task'
+    # TODO: Make it start PAUSED TASKS!
+    def start(task_name = nil)
+      current_task.stop if current_task.present? && task_name.present?
+      Task::task(task_name).start
+    end
+
+    # Stops the current task.
+    #
+    def stop
+      current_task.stop if current_task
+    end
+
+    private
+
+    def client(name)
+      Client.first_or_create :name => name, :description => name
+    end
+
+    def deactivate_current_client
+      client = current_client
+      client.active = false
+      client.save
+    end
+
+    def deactivate_current_project
+      project = current_project
+      project.active = false
+      project.save
+    end
+
+    def current_client
+      Client.first :active => true
+    end
+
+    def current_project
+      Project.first :active => true
+    end
+
+    def current_task
+      Task.first :active => true
+    end
+  end
+end

data/lib/rtt/client.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+module Rtt
+  class Client
+    include DataMapper::Resource
+
+    DEFAULT_NAME = 'default'
+    DEFAULT_DESCRIPTION = 'Default Client'
+
+    property :id, Serial
+    property :name, String, :required => true, :unique => true, :default => DEFAULT_NAME
+    property :description, String, :default => DEFAULT_DESCRIPTION
+    property :active, Boolean, :default => false
+    has n, :projects #, :through => Resource
+
+    def self.default
+      first_or_create :active => true
+    end
+
+    def activate
+      self.active = true
+      self.save
+      self
+    end
+  end
+end

data/lib/rtt/cmd_line_interpreter.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby -w
+module Rtt
+  class Command
+    attr_accessor :name, :optional
+  end
+  class PauseCommand < Command
+    NUMBER_OF_PARAM_REQUIRED = 0
+  end
+  class SetProjectCommand < Command
+    NUMBER_OF_PARAM_REQUIRED = 1
+  end
+  class SetUserCommand < Command
+    NUMBER_OF_PARAM_REQUIRED = 0
+  end
+  class SetClientCommand < Command
+    NUMBER_OF_PARAM_REQUIRED = 1
+  end
+  class StartCommand < Command
+    NUMBER_OF_PARAM_REQUIRED = 0
+  end
+  class StopCommand < Command
+    NUMBER_OF_PARAM_REQUIRED = 0
+  end
+  class RenameCommand < Command
+    NUMBER_OF_PARAM_REQUIRED = 1
+  end
+  class ReportCommand < Command
+    NUMBER_OF_PARAM_REQUIRED = 0
+  end
+  class QueryCommand < Command
+    NUMBER_OF_PARAM_REQUIRED = 0
+  end
+  class CommandNotFoundError < StandardError; end
+  class TaskNotStartedError < StandardError; end
+
+  module CmdLineInterpreter
+
+    COMMAND_MAPPING = {
+     :project => SetProjectCommand,
+     :client => SetClientCommand,
+     :report => ReportCommand,
+     :stop => StopCommand,
+     :start => StartCommand,
+     :rename => RenameCommand,
+     :list => QueryCommand,
+     :pause => PauseCommand,
+     :resume => StartCommand,
+     :user => SetUserCommand
+    }
+
+    def capture(arguments)
+      unless arguments.length == 0
+        operation = arguments.shift.to_sym
+        if COMMAND_MAPPING.keys.include?(operation)
+          klazz = COMMAND_MAPPING[operation]
+          if arguments.length >= klazz::NUMBER_OF_PARAM_REQUIRED
+            command = klazz.new
+            command.name = arguments.shift
+            command.optional = arguments if arguments.present?
+            Array(command)
+          end
+        elsif operation.present?
+          command = StartCommand.new
+          command.name = operation
+          command.optional = arguments if arguments.present?
+          Array(command)
+        end
+      end
+    end
+
+    def env_filters
+      [ 'client', 'project' ].inject({}) do |filters, key|
+        filters[key.to_sym] = env_variable(key) if env_variable(key).present?
+        filters
+      end
+    end
+
+    def env_variable(key)
+      ENV[key] || ENV[key.upcase] || ENV[key.downcase]
+    end
+
+    def execute(cmds)
+      cmds.each { |cmd| execute_single(cmd) }
+      puts "Operation(s) succeded."
+    rescue => e
+      handle_error(e)
+    end
+
+    def execute_single(cmd)
+      case cmd
+        when SetProjectCommand
+          client = cmd.optional if cmd.optional.present?
+          set_project(cmd.name, client)
+        when SetClientCommand
+          set_client(cmd.name)
+        when StartCommand
+          start(cmd.name)
+        when PauseCommand
+          if current_task.present?
+              pause
+          else
+            raise TaskNotStartedError
+          end
+        when StopCommand
+          stop
+        when ReportCommand
+          options = env_filters.merge!(:pdf => cmd.name)
+          report(options)
+        when QueryCommand
+          list(env_filters)
+        when SetUserCommand
+          set_user(cmd.name)
+        else
+          raise CommandNotFoundError
+      end
+    end
+
+    def handle_error(e)
+      case e
+        when CommandNotFoundError
+          return puts_usage
+        when TaskNotStartedError
+          puts "There is no active task. Pause is not valid at this point."
+      end
+    end
+
+    def puts_usage
+      puts
+      File.open("USAGE.txt") do |file|
+        while content = file.gets
+          puts content
+        end
+      end
+      puts
+    end
+  end
+end