ReinH-track 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 REIN HENRICHS
+
+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/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+GEM = "track"
+GEM_VERSION = "1.0.0"
+AUTHOR = "Rein Henrichs"
+EMAIL = "reinh@reinh.com"
+HOMEPAGE = "http://github.com/ReinH/track"
+SUMMARY = "A gem that provides an awesome command line interface for time tracking that is awesome."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.rdoc Rakefile TODO) + Dir.glob("{bin,lib,spec}/**/*")
+  s.executables << 'track'
+end
+
+task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/TODO

@@ -0,0 +1 @@
+

data/bin/track

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+require 'lib/track'
+
+home = ENV['HOME']
+config_file = "#{home}/.track.yml"
+
+banner = <<-BANNER
+Usage: track command
+
+Available commands:
+
+  <project> <task> => start a task on a project
+  stop                   => stop a started task
+
+BANNER
+
+if ARGV.empty?
+  puts banner
+  exit 0
+elsif not File.exists?(config_file)
+  STDERR.puts "Create a #{home}/.track.yml file please."
+  exit 1
+else
+  options = YAML.load_file(config_file)
+  options ||= {}
+  Track.new(options).run(ARGV)
+end

data/lib/track.rb

@@ -0,0 +1,59 @@
+require 'date'
+
+class Track
+  attr_reader :options, :projects
+  def initialize(options={})
+    @options = options
+    @projects = @options['projects'] || {}
+  end
+
+  def run(argv)
+    argv.first == "stop" ? stop : start(*argv)
+  end
+
+  private
+
+  def start(*args)
+    stop
+    project_name = args.shift
+    description  = args.join(' ').strip
+    project      = projects[project_name] || project_name
+
+    write_line(project, description)
+  end
+
+  def stop
+    return unless File.size?(log_filename)
+    File.open(log_filename, 'r+') do |file|
+      lines = file.readlines
+      lines.last.sub!(placeholder, time_string)
+      file.rewind
+      file.write(lines.join)
+    end
+  end
+  
+  def write_line(project, description)
+    line = "* [#{time_string} - #{placeholder}] "
+    line << project if project
+    line << ":\t" << description unless description.empty?
+    File.open(log_filename, 'a') do |file|
+      file.puts(line)
+    end
+  end
+
+  def time_string(time = Time.now)
+    time.strftime('%H:%M')
+  end
+
+  def log_filename
+    str = options['filename'] || 'track'
+    str += '-'
+    str += Date.today.to_s
+    str += '.textile'
+    return str
+  end
+
+  def placeholder
+    "--:--"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'bin')
+load 'track'

data/spec/track_spec.rb

@@ -0,0 +1,132 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Track do
+  TMP_FILENAME = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'time_log.tmp'))
+
+  before do
+    @track = Track.new
+    @track.stub!(:log_filename).and_return(TMP_FILENAME)
+
+    @time = Time.now
+    @time.stub!(:now).and_return(@time)
+    @time_string = @time.strftime('%H:%M')
+  end
+
+  after do
+    File.unlink(TMP_FILENAME) if File.exists?(TMP_FILENAME)
+  end
+
+  def line_count
+    `wc -l #{TMP_FILENAME} 2>/dev/null`.to_i
+  end
+  private :line_count
+
+  def last_line
+    File.readlines(TMP_FILENAME).last.chomp
+  end
+
+  describe "#run" do
+    describe "when the first argument is \"stop\"" do
+      it "stops" do
+        @track.should_receive(:stop)
+        @track.run(["stop"])
+      end
+    end
+
+    describe "when the first argument is not stop" do
+      it "starts" do
+        @track.should_receive(:start)
+        @track.run(["tm"])
+      end
+
+      it "passes the arguments to start" do
+        @track.should_receive(:start).with(:one, :two)
+        @track.run([:one, :two])
+      end
+    end
+  end
+
+  describe "#start" do
+    it "stops any started task" do
+      @track.should_receive(:stop)
+      @track.send(:start)
+    end
+
+    it "appends a line to the log file" do
+      lambda do
+        @track.send(:start, "Project", "Description")
+      end.should change{line_count}
+    end
+
+  end
+
+  describe "#write_line" do
+    before do
+      @track.send(:write_line, "Project", "Description")
+    end
+
+    it "includes the start time" do
+      last_line.should include(@time_string)
+    end
+
+    it "includes a placeholder for the end time" do
+      last_line.should include('--:--')
+    end
+
+    it "wraps the times in []" do
+      last_line.should match(/\[.+\]/)
+    end
+
+    it "includes the project name followed by a \":\"" do
+      last_line.should include("Project:")
+    end
+
+    it "includes the description" do
+      last_line.should include("Project:")
+    end
+
+    describe "with project \"Project\" and description \"Description\"" do
+      it "looks like \"* [<time> - --:--] Project:	Description\"" do
+        last_line.should == "* [#{@time_string} - --:--] Project:\tDescription"
+      end
+    end
+  end
+
+  describe "#stop" do
+    it "replaced the end time placeholder with the end time" do
+      @track.send(:start)
+      @track.send(:stop)
+      last_line.should_not include('--:--')
+      last_line.should include("[#@time_string - #@time_string]")
+    end
+
+    it "does not change the last line if there is nothing to stop" do
+      @track.send(:start)
+      @track.send(:stop)
+      lambda {@track.send(:stop)}.should_not change{last_line}
+    end
+  end
+end
+
+describe Track do
+  before do
+    @track = Track.new
+  end
+
+  describe "#log_filename" do
+    it "starts with the filename specified in the options" do
+      @track.options['filename'] = 'file'
+      @track.send(:log_filename).should match(/^file/)
+    end
+
+    it "includes the current date" do
+      require 'date'
+      @track.send(:log_filename).should include(Date.today.to_s)
+    end
+
+    it "is a textile file" do
+      @track.send(:log_filename).should match(/\.textile$/)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: ReinH-track
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rein Henrichs
+autorequire: track
+bindir: bin
+cert_chain: []
+
+date: 2008-11-11 00:00:00 -08:00
+default_executable: track
+dependencies: []
+
+description: A gem that provides an awesome command line interface for time tracking that is awesome.
+email: reinh@reinh.com
+executables: 
+- track
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- bin/track
+- lib/track.rb
+- spec/fixtures
+- spec/spec_helper.rb
+- spec/track_spec.rb
+has_rdoc: true
+homepage: http://github.com/ReinH/track
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A gem that provides an awesome command line interface for time tracking that is awesome.
+test_files: []
+