ReinH-track 1.0.2 → 1.1.0

data/Rakefile

@@ -5,7 +5,7 @@ require 'date'
 require 'spec/rake/spectask'
 
 GEM = "track"
-GEM_VERSION = "1.0.2"
+GEM_VERSION = "1.1.0"
 AUTHOR = "Rein Henrichs"
 EMAIL = "reinh@reinh.com"
 HOMEPAGE = "http://github.com/ReinH/track"

data/bin/track

@@ -3,8 +3,7 @@
 require 'yaml'
 require File.join(File.dirname(__FILE__),'..','lib','track')
 
-home = ENV['HOME']
-config_file = "#{home}/.track.yml"
+config_file = File.join(ENV['HOME'], ".track.yml")
 
 banner = <<-BANNER
 Usage: track command
@@ -12,7 +11,8 @@ Usage: track command
 Available commands:
 
   <project> <task> => start a task on a project
-  stop                   => stop a started task
+  stop             => stop a started task
+  cat              => print the current timesheet
 
 BANNER
 
@@ -20,8 +20,8 @@ if ARGV.empty?
   puts banner
   exit 0
 else
-  options = nil
   options = YAML.load_file(config_file) if File.size?(config_file)
-  options ||= {}
-  Track.new(options).run(ARGV)
+  Store.open do |track|
+    track.run(ARGV,options)
+  end
 end

data/lib/track.rb

@@ -1,50 +1,33 @@
 require 'date'
 
+$:.unshift File.dirname(__FILE__)
+require 'track/store'
+require 'track/entry'
+
 class Track
-  attr_reader :options, :projects
-  def initialize(options={})
-    @options = options
-    @projects = @options['projects'] || {}
-  end
+  attr_reader :options, :projects, :entries
+  attr_writer :options
 
-  def run(argv)
-    argv.first == "stop" ? stop : start(*argv)
+  def initialize
+    @entries   = []
   end
 
-  private
-
-  def start(*args)
-    stop
-    project_name = args.shift
-    description  = args.join(' ').strip
-    project      = projects[project_name] || project_name
+  def options;   @options  ||= {} end
+  def projects;  @projects ||= options['projects'] || {} end
 
-    write_line(project, description)
+  def ==(other)
+    [self.options, self.entries] == [other.options, other.entries]
   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)
+  def run(argv, options=nil)
+    self.options = options
+    case argv.first
+    when 'stop' ; stop
+    when 'cat'  ; cat
+    else start(*argv)
     end
   end
 
-  def time_string(time = Time.now)
-    time.strftime('%H:%M')
-  end
-
   def log_filename
     str = options['filename'] || 'track'
     str += '-'
@@ -53,7 +36,30 @@ class Track
     return str
   end
 
-  def placeholder
-    "--:--"
+  def last_entry
+    entries.last
   end
+  
+  def add_entry(project, description=nil)
+    entry = Entry.new(Time.now, nil, project, description)
+    entries << entry
+    entry
+  end
+
+  def start(project, *description)
+    stop
+    description = description.join(' ')
+    project = projects[project] || project
+    add_entry(project, description)
+  end
+
+  def stop
+    return if entries.empty? || last_entry.stopped?
+    last_entry.stop
+  end
+
+  def cat
+    $stdout.puts(entries.map{|e|e.to_s}.join("\n"))
+  end
+
 end

data/lib/track/entry.rb

@@ -0,0 +1,46 @@
+class Entry
+  attr_reader :start_time, :stop_time, :project, :description
+  def initialize(start_time, stop_time, project, description)
+    @start_time  = start_time
+    @stop_time   = stop_time
+    @project     = project
+    @description = description
+  end
+
+  def stopped?
+    not stop_time.nil?
+  end
+
+  def stop
+    @stop_time = Time.now
+  end
+
+  def to_s
+    line = "[#{start_string} - #{stop_string}] "
+    line << project if project
+    line << ":\t" << description unless description.nil? || description.empty?
+    line
+  end
+
+  def start_string
+    time_string(start_time)
+  end
+
+  def stop_string
+    if stop_time
+      time_string(stop_time)
+    else
+      placeholder
+    end
+  end
+
+  private
+
+  def time_string(time = Time.now)
+    time.strftime('%H:%M')
+  end
+
+  def placeholder
+    "--:--"
+  end
+end

data/lib/track/store.rb

@@ -0,0 +1,30 @@
+module Store
+  class << self
+
+    def store(obj, options={})
+      File.open(db_filename,'w') do |file|
+        file.write Marshal.dump(obj)
+      end
+      return obj
+    end
+
+    def load
+      if File.size?(db_filename)
+        Marshal.load(File.read(db_filename))
+      else
+        Track.new
+      end
+    end
+
+    def open
+      track = load
+      yield track
+      store track
+    end
+
+    private
+    def db_filename
+      File.join(ENV['HOME'], '.trackdb')
+    end
+  end
+end

data/spec/spec_helper.rb

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

data/spec/track/entry_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Entry do
+
+  describe "#stopped?" do
+    it "should be false if the entry is not yet stopped" do
+      Entry.new(Time.now, nil, "Project", "description").stopped?.should be_false
+    end
+  end
+
+  describe "#stop" do
+    it "should stop the entry" do
+      started_entry = Entry.new(Time.now, nil, "Project", "description")
+      started_entry.stop
+      started_entry.should be_stopped
+    end
+  end
+  describe "#to_s" do
+    before do
+      @time = Time.now
+      @entry = Entry.new(@time, nil, "Project", "Description")
+    end
+
+    it "includes the start time" do
+      @entry.to_s.should include(@entry.start_string)
+    end
+
+    it "includes a placeholder for the end time" do
+      @entry.to_s.should include('--:--')
+    end
+
+    it "wraps the times in []" do
+      @entry.to_s.should match(/\[.+\]/)
+    end
+
+    it "includes the project name followed by a \":\"" do
+      @entry.to_s.should include("Project:")
+    end
+
+    it "includes the description" do
+      @entry.to_s.should include("Description")
+    end
+
+    describe "with project \"Project\" and description \"Description\"" do
+      it "looks like \"[<time> - --:--] Project:	Description\"" do
+        @entry.to_s.should == "[#{@entry.start_string} - --:--] Project:\tDescription"
+      end
+    end
+  end
+end

data/spec/track/store_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Store do
+  TMP_FILENAME = File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures', 'trackdb.tmp'))
+
+  before do
+    Store.stub!(:db_filename).and_return(TMP_FILENAME)
+    @track = Track.new
+
+    @time = Time.now
+  end
+
+  after do
+    File.unlink(TMP_FILENAME) if File.exists?(TMP_FILENAME)
+  end
+
+  describe "storing and loading an object" do
+    it "should store and load the object" do
+      Store.store(@track)
+      Store.load.should == @track
+    end
+  end
+
+  describe "opening a track from storage and adding an entry" do
+    it "should store the modified track" do
+      pending
+    end
+  end
+end

data/spec/track_spec.rb

@@ -1,28 +1,24 @@
 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
+  describe "#==" do
+    it "should be equal if the options are equal and the entries are equal" do
+      @track = Track.new
+      @track.options[:foo] = :foo
+      @track.entries << :foo
+      @track2 = Track.new
+      @track2.options[:foo] = :foo
+      @track2.entries << :foo
+      @track.should == @track2
+    end
   end
 
   describe "#run" do
@@ -46,87 +42,123 @@ describe Track do
     end
   end
 
-  describe "#start" do
-    it "stops any started task" do
-      @track.should_receive(:stop)
-      @track.send(:start)
+  describe "#last_entry" do
+    it "should return the last entry" do
+      entry = @track.add_entry('project')
+      @track.last_entry.should == entry
     end
+  end
 
-    it "appends a line to the log file" do
-      lambda do
-        @track.send(:start, "Project", "Description")
-      end.should change{line_count}
+  describe "#add_entry" do
+    it "should add a new entry" do
+      lambda{@track.add_entry('project', 'description')}.should change(@track.entries, :size)
     end
 
-  end
+    it "should return the new entry" do
+      @track.add_entry('project', 'description').should == @track.last_entry
+    end
 
-  describe "#write_line" do
-    before do
-      @track.send(:write_line, "Project", "Description")
+    it "should set the entry's start time to now" do
+      time = Time.now
+      Time.stub!(:now).and_return(time)
+      @track.add_entry('project', 'description').start_time.should == time
     end
 
-    it "includes the start time" do
-      last_line.should include(@time_string)
+    it "does not require a description" do
+      lambda{@track.add_entry('project')}.should_not raise_error
     end
+  end
 
-    it "includes a placeholder for the end time" do
-      last_line.should include('--:--')
+  describe "#start" do
+    it "should stop any started entry" do
+      @track.should_receive(:stop)
+      @track.start('project')
     end
 
-    it "wraps the times in []" do
-      last_line.should match(/\[.+\]/)
+    it "should create an new entry" do
+      lambda{@track.start('project')}.should change(@track.entries, :size)
     end
 
-    it "includes the project name followed by a \":\"" do
-      last_line.should include("Project:")
+    it "should map a project shortname" do
+      expected =  "Test Project"
+      @track.projects['test'] = expected
+      @track.start('test')
+      @track.last_entry.project.should == expected
     end
 
-    it "includes the description" do
-      last_line.should include("Project:")
+    it "should use the given project if it is not a shortname" do
+      expected = 'test'
+      @track.start(expected)
+      @track.last_entry.project.should == expected
     end
 
-    describe "with project \"Project\" and description \"Description\"" do
-      it "looks like \"[<time> - --:--] Project:	Description\"" do
-        last_line.should == "[#{@time_string} - --:--] Project:\tDescription"
-      end
+    it "should concatenate multiple description arguments" do
+      actual = %w(tacos are teh awesum)
+      expected = 'tacos are teh awesum'
+      @track.start('test', actual)
+      @track.last_entry.description.should == expected
     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]")
+    before do
+      @track = Track.new
     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}
+    describe "without any entries" do
+      it "should not change the entries" do
+        expected = @track.entries.dup
+        @track.stop
+        actual = @track.entries
+
+        actual.should == expected
+      end
     end
-  end
-end
 
-describe Track do
-  before do
-    @track = Track.new
-  end
+    describe "with a stopped entry" do
+      before do
+        @stopped_entry = Entry.new(Time.now, Time.now, '', '')
+        @track.entries << @stopped_entry
+      end
+
+      it "should not change the entries" do
+        expected = @track.entries.dup
+        @track.stop
+        actual = @track.entries
 
-  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/)
+        actual.should == expected
+      end
     end
 
-    it "includes the current date" do
-      require 'date'
-      @track.send(:log_filename).should include(Date.today.to_s)
+    describe "with a started entry" do
+      before do
+        @started_entry = Entry.new(Time.now, nil, '', '')
+        @track.entries << @started_entry
+      end
+
+      it "should stop the entry" do
+        @track.stop
+        @track.last_entry.should be_stopped
+      end
     end
+  end
 
-    it "is a text file" do
-      @track.send(:log_filename).should match(/\.txt$/)
+  describe "#cat" do
+    it "should output each entry as a string on a line to stdout" do
+      old, $stdout = $stdout, StringIO.new
+      @track.add_entry('project')
+      @track.cat
+      $stdout.rewind
+      $stdout.read.should == @track.last_entry.to_s + "\n"
+      $stdout = old
     end
+  end
+end
 
+describe Track do
+  before do
+    @track = Track.new
   end
+
+  describe "#log_filename"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ReinH-track
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Rein Henrichs
@@ -9,7 +9,7 @@ autorequire: track
 bindir: bin
 cert_chain: []
 
-date: 2008-11-17 00:00:00 -08:00
+date: 2008-11-26 00:00:00 -08:00
 default_executable: track
 dependencies: []
 
@@ -29,9 +29,15 @@ files:
 - Rakefile
 - TODO
 - bin/track
+- lib/track
+- lib/track/entry.rb
+- lib/track/store.rb
 - lib/track.rb
 - spec/fixtures
 - spec/spec_helper.rb
+- spec/track
+- spec/track/entry_spec.rb
+- spec/track/store_spec.rb
 - spec/track_spec.rb
 has_rdoc: true
 homepage: http://github.com/ReinH/track