timesheet 0.2.0

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/timesheet.rb'}"
+puts "Loading timesheet gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/range_extensions_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Range do
+
+  it "should detect overlaps" do
+    (1..5).overlap?(4..8).should be_true
+    (1...5).overlap?(5..10).should be_false
+  end
+
+  it "should allow include?" do
+    (1..5).include?(2..3).should be_true
+    (1..5).include?(4..8).should be_false
+    (1..5).include?(3).should be_true
+    (1..5).include?(6).should be_false
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'timesheet'
+
+
+#Spec::Runner.configure do |config|
+#  config.mock_with :mocha
+#end
+

data/spec/time_entry_spec.rb

@@ -0,0 +1,137 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe TimeEntry do
+
+  context "Construction" do
+
+    it "should allow initialization of fields" do
+      lambda { TimeEntry.new("Project", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 17, 0, 0)) }.should_not raise_error()
+    end
+
+    it "should raise ArgumentError if end time is before start time" do
+      lambda { TimeEntry.new("Project", Time.local(2009, 12, 1, 17, 0, 0), Time.local(2009, 12, 1, 9, 0, 0)) }.should raise_error(ArgumentError)
+    end
+
+  end
+
+  context "Basic Features" do
+
+    before :each do
+      @time_entry = TimeEntry.new("Project", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+    end
+
+
+    it "should know its initial project" do
+      @time_entry.project.should == "Project"
+    end
+
+    it "should have an know its initial start time" do
+      @time_entry.start_time.should == Time.local(2009, 12, 1, 9, 0, 0)
+    end
+
+    it "should know its initial end time" do
+      @time_entry.end_time.should == Time.local(2009, 12, 1, 17, 0, 0)
+    end
+
+    it "should have an initial comment of nil" do
+      @time_entry.comment.should == nil
+    end
+
+    it "should calculate its duration from start and end times" do
+      @time_entry.duration.should == 8.hours
+    end
+
+    it "should remember its assigned project" do
+      @time_entry.project = "Project2"
+      @time_entry.project.should == "Project2"
+    end
+
+    it "should raise an ArgumentError if a start_time is assigned that is after the end_time" do
+      lambda { @time_entry.start_time = Time.local(2009, 12, 1, 18, 0 , 0) }.should raise_error(ArgumentError)
+    end
+
+    it "should raise an ArgumentError if an end_time is assigned that is before the start_time" do
+      lambda { @time_entry.end_time = Time.local(2009, 12, 1, 8, 0 , 0) }.should raise_error(ArgumentError)
+    end
+
+    it "should remember its assigned start time" do
+      time = Time.local(2009, 12, 1, 12, 0, 0)
+      @time_entry.start_time = time
+      @time_entry.start_time.should == time
+    end
+
+    it "should remember its assigned end time" do
+      time = Time.local(2009, 12, 1, 12, 0, 0)
+      @time_entry.end_time = time
+      @time_entry.end_time.should == time
+    end
+
+    it "should remember its assigned comment" do
+      @time_entry.comment = "Comment"
+      @time_entry.comment.should == "Comment"
+    end
+
+    it "should not allow assignment to duration" do
+      @time_entry.should_not respond_to :duration=
+    end
+
+  end
+
+  context "comparison and sorting" do
+    before :each do
+      @early_entry = TimeEntry.new("Project", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 12, 0, 0))
+      @late_entry = TimeEntry.new("Project", Time.local(2009, 12, 1, 13, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+    end
+
+    it "should be comparable to other time entries" do
+      @early_entry.should respond_to :<=>
+    end
+
+    it "should order before an entry with a later start time" do
+      lambda { @early_entry < @late_entry}.should be_true
+    end
+
+    it "should order after an entry with an earlier start time" do
+      lambda { @late_entry > @early_entry}.should be_true
+    end
+  end
+
+  context "Conflict detection" do
+
+    it "these should not conflict" do
+      entry1 = TimeEntry.new("Project1", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+      entry2 = TimeEntry.new("Project2", Time.local(2009, 12, 2, 9, 0, 0), Time.local(2009, 12, 2, 17, 0, 0))
+
+      entry1.conflict?(entry2).should be_false
+      entry2.conflict?(entry1).should be_false
+    end
+
+
+    it "should conflict" do
+      entry1 = TimeEntry.new("Project1", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+      entry2 = TimeEntry.new("Project2", Time.local(2009, 12, 1, 12, 0, 0), Time.local(2009, 12, 1, 20, 0, 0))
+
+      entry1.conflict?(entry2).should be_true
+      entry2.conflict?(entry1).should be_true
+    end
+
+    it "should conflict" do
+      entry1 = TimeEntry.new("Project1", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+      entry2 = TimeEntry.new("Project2", Time.local(2009, 12, 1, 12, 0, 0), Time.local(2009, 12, 1, 14, 0, 0))
+
+      entry1.conflict?(entry2).should be_true
+      entry2.conflict?(entry1).should be_true
+    end
+
+    it "should not conflict if its start time is the same as another entries end time" do
+      entry1 = TimeEntry.new("Project1", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 12, 0, 0))
+      entry2 = TimeEntry.new("Project2", Time.local(2009, 12, 1, 12, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+
+      entry1.conflict?(entry2).should be_false
+      entry2.conflict?(entry1).should be_false
+
+    end
+
+  end
+
+end

data/spec/time_log_spec.rb

@@ -0,0 +1,164 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+TEST_FILE = "/var/tmp/timesheet_test.pstore"
+
+describe TimeLog do
+
+  after :all do
+    File.delete(TEST_FILE) if File.exists?(TEST_FILE)
+  end
+
+  context "adding items" do
+
+    before :all do
+      File.delete(TEST_FILE) if File.exists?(TEST_FILE)
+      @store = YAML::Store.new(TEST_FILE)
+      @time_log = TimeLog.new(@store)
+    end
+
+
+    it "should have no entries initially" do
+      @time_log.count.should == 0
+    end
+
+    it "should allow time entries to be added" do
+      t = Time.now
+      entry = TimeEntry.new("Project1", t.hours_ago(2), t)
+      entry.record_number.should == nil
+      @time_log.add entry
+      @time_log.count.should == 1
+      entry.record_number.should == 1
+    end
+  end
+
+  context "finding items" do
+
+    before :all do
+      File.delete(TEST_FILE) if File.exists?(TEST_FILE)
+      @store = YAML::Store.new(TEST_FILE)
+      @time_log = TimeLog.new(@store)
+
+      @time_log.add TimeEntry.new("Project1", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project2", Time.local(2009, 12, 2, 9, 0, 0), Time.local(2009, 12, 2, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project3", Time.local(2009, 12, 3, 9, 0, 0), Time.local(2009, 12, 3, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project4", Time.local(2009, 12, 4, 9, 0, 0), Time.local(2009, 12, 4, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project5", Time.local(2009, 12, 5, 9, 0, 0), Time.local(2009, 12, 5, 17, 0, 0))
+    end
+
+
+    it "should raise an error if attempting to find with an unknown index" do
+      lambda{@time_log.find(100)}.should raise_error(ArgumentError)
+      @time_log.count.should == 5
+    end
+
+    it "should not allow finding by record number" do
+      entry = @time_log.find(2)
+      entry.project.should eql("Project2")
+    end
+
+  end
+
+  context "deleting items" do
+
+    before :all do
+      File.delete(TEST_FILE) if File.exists?(TEST_FILE)
+      @store = YAML::Store.new(TEST_FILE)
+      @time_log = TimeLog.new(@store)
+
+      @time_log.add TimeEntry.new("Project1", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project2", Time.local(2009, 12, 2, 9, 0, 0), Time.local(2009, 12, 2, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project3", Time.local(2009, 12, 3, 9, 0, 0), Time.local(2009, 12, 3, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project4", Time.local(2009, 12, 4, 9, 0, 0), Time.local(2009, 12, 4, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project5", Time.local(2009, 12, 5, 9, 0, 0), Time.local(2009, 12, 5, 17, 0, 0))
+    end
+
+
+    it "should raise an error if attempting to delete an unknown index" do
+      lambda{@time_log.delete(100)}.should raise_error(ArgumentError)
+      @time_log.count.should == 5
+    end
+
+    it "should not allow conflicting entries to be added" do
+      conflicting_entry = TimeEntry.new("Conflicting", Time.local(2009, 12, 2, 12, 0, 0), Time.local(2009, 12, 2, 13, 0, 0))
+      lambda { @time_log.add conflicting_entry }.should raise_error(ArgumentError) 
+      @time_log.count.should == 5
+    end
+
+  end
+
+  context "editing items" do
+
+    before :all do
+      File.delete(TEST_FILE) if File.exists?(TEST_FILE)
+      @store = YAML::Store.new(TEST_FILE)
+      @time_log = TimeLog.new(@store)
+
+      @time_log.add TimeEntry.new("Project1", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project2", Time.local(2009, 12, 2, 9, 0, 0), Time.local(2009, 12, 2, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project3", Time.local(2009, 12, 3, 9, 0, 0), Time.local(2009, 12, 3, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project4", Time.local(2009, 12, 4, 9, 0, 0), Time.local(2009, 12, 4, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project5", Time.local(2009, 12, 5, 9, 0, 0), Time.local(2009, 12, 5, 17, 0, 0))
+    end
+
+    it "should notify with an error if the edited item's index cannot be found" do
+      properties = { :project => "New Project" }
+      lambda{@time_log.update(100, properties)}.should raise_error(ArgumentError)
+    end
+
+    it "should allow updating of existing items" do
+      properties = {:project => "some new project"}
+      @time_log.update(2, properties)
+      @time_log.count.should == 5
+
+      entry = @time_log.find(2)
+      entry.project.should eql("some new project")
+    end
+
+    it "should allow updating of existing item start time" do
+      properties = {:start => Time.local(2009, 12, 2, 7, 0, 0)}
+      @time_log.update(2, properties)
+      @time_log.count.should == 5
+
+      entry = @time_log.find(2)
+      entry.start_time.should eql( Time.local(2009, 12, 2, 7, 0, 0))
+    end
+
+    it "should notify with an error if the new times will overlap with existing items" do
+      properties = {:end => Time.local(2009, 12, 3, 10, 0, 0)}
+      lambda{@time_log.update(2, properties)}.should raise_error(ArgumentError)
+    end
+
+  end
+
+  context "extracting items" do
+
+    before :all do
+      File.delete(TEST_FILE) if File.exists?(TEST_FILE)
+      @store = YAML::Store.new(TEST_FILE)
+      @time_log = TimeLog.new(@store)
+
+      @time_log.add TimeEntry.new("Project1", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project2", Time.local(2009, 12, 2, 9, 0, 0), Time.local(2009, 12, 2, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project3", Time.local(2009, 12, 3, 9, 0, 0), Time.local(2009, 12, 3, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project4", Time.local(2009, 12, 4, 9, 0, 0), Time.local(2009, 12, 4, 17, 0, 0))
+      @time_log.add TimeEntry.new("Project5", Time.local(2009, 12, 5, 9, 0, 0), Time.local(2009, 12, 5, 17, 0, 0))
+    end
+
+    it "should return an empty array if no items are in the range" do
+      entries = @time_log.extract_entries( Time.local(2009, 11, 1, 9, 0, 0), Time.local(2009, 11, 10, 17, 0, 0))
+      entries.should be_empty
+    end
+
+    it "should return a collection of items that are covered by the range" do
+      entries = @time_log.extract_entries( Time.local(2009, 12, 2, 12, 0, 0), Time.local(2009, 12, 4, 12, 0, 0))
+      entries.count.should == 3
+    end
+
+    it "should notify with an error if the new times will overlap with existing items" do
+      properties = {:end => Time.local(2009, 12, 3, 10, 0, 0)}
+      lambda{@time_log.update(2, properties)}.should raise_error(ArgumentError)
+    end
+
+  end
+
+end

data/spec/time_report_spec.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe TimeReport do
+
+  before :each do
+    @entries =
+            [TimeEntry.new("ProjectA", Time.local(2009, 12, 1, 9, 0, 0), Time.local(2009, 12, 1, 12, 0, 0), "comment 1"),
+             TimeEntry.new("ProjectB", Time.local(2009, 12, 1, 1, 0, 0), Time.local(2009, 12, 1, 17, 0, 0), "comment 2"),
+             TimeEntry.new("ProjectA", Time.local(2009, 12, 3, 9, 0, 0), Time.local(2009, 12, 3, 17, 0, 0), "comment 3"),
+             TimeEntry.new("ProjectB", Time.local(2009, 12, 4, 9, 0, 0), Time.local(2009, 12, 4, 17, 0, 0), "comment 4"),
+             TimeEntry.new("ProjectC", Time.local(2009, 12, 5, 9, 0, 0), Time.local(2009, 12, 5, 17, 0, 0), "comment 5")]
+    @time_report = TimeReport.new(@entries)
+  end
+
+  it "should be able to trim its entries to a specific time span" do
+    @time_report.trim(Time.local(2009, 12, 1, 11, 0, 0), Time.local(2009, 12, 5, 12, 0, 0))
+    @time_report.entries[0].start_time.should eql(Time.local(2009, 12, 1, 11, 0, 0))
+    @time_report.entries[-1].end_time.should eql(Time.local(2009, 12, 5, 12, 0, 0))
+  end
+
+  it "should leave entries alone when the trim span is outside the entry range" do
+    @time_report.trim(Time.local(2009, 11, 1, 0, 0, 0), Time.local(2009, 12, 31, 0, 0, 0))
+    @time_report.entries[0].start_time.should eql(Time.local(2009, 12, 1, 9, 0, 0))
+    @time_report.entries[-1].end_time.should eql(Time.local(2009, 12, 5, 17, 0, 0))
+  end
+
+  it "should be able to produce a detail report" do
+    command_options = {:detail => true, :start => Time.local(2009, 12, 1), :end => Time.local(2009, 12, 6)}
+    stream = StringIO.new
+    @time_report.report(command_options, stream)
+    stream.string.should eql( <<EOS
++----------------------------------------------------------------------------+
+|  Id   | Project  |            Start - Stop            | Hours  |  Comment  |
++----------------------------------------------------------------------------+
+|     0 | ProjectB | 12/01/2009 at 01:00 AM to 05:00 PM | 16h 0m | comment 2 |
+|     0 | ProjectA | 12/01/2009 at 09:00 AM to 12:00 PM | 3h 0m  | comment 1 |
+|     0 | ProjectA | 12/03/2009 at 09:00 AM to 05:00 PM | 8h 0m  | comment 3 |
+|     0 | ProjectB | 12/04/2009 at 09:00 AM to 05:00 PM | 8h 0m  | comment 4 |
+|     0 | ProjectC | 12/05/2009 at 09:00 AM to 05:00 PM | 8h 0m  | comment 5 |
++----------------------------------------------------------------------------+
+EOS
+)
+  end
+
+  it "should be able to produce a detail report" do
+    command_options = {:detail => true, :start => Time.local(2009, 11, 1), :end => Time.local(2009, 12, 31)}
+    stream = StringIO.new
+    @time_report.report(command_options, stream)
+    stream.string.should eql( <<EOS
++----------------------------------------------------------------------------+
+|  Id   | Project  |            Start - Stop            | Hours  |  Comment  |
++----------------------------------------------------------------------------+
+|     0 | ProjectB | 12/01/2009 at 01:00 AM to 05:00 PM | 16h 0m | comment 2 |
+|     0 | ProjectA | 12/01/2009 at 09:00 AM to 12:00 PM | 3h 0m  | comment 1 |
+|     0 | ProjectA | 12/03/2009 at 09:00 AM to 05:00 PM | 8h 0m  | comment 3 |
+|     0 | ProjectB | 12/04/2009 at 09:00 AM to 05:00 PM | 8h 0m  | comment 4 |
+|     0 | ProjectC | 12/05/2009 at 09:00 AM to 05:00 PM | 8h 0m  | comment 5 |
++----------------------------------------------------------------------------+
+EOS
+)
+  end
+
+  it "should be able to produce a summary report" do
+    command_options = {:summary => true, :start => Time.local(2009, 12, 1), :end => Time.local(2009, 12, 6)}
+    stream = StringIO.new
+    @time_report.report(command_options, stream)
+    stream.string.should eql( <<EOS
+ProjectA  11h  0m
+ProjectB  24h  0m
+ProjectC   8h  0m
+-----------------
+   Total  43h  0m
+EOS
+)
+  end
+
+  it "should be able to produce a byday report" do
+    @entries << TimeEntry.new("ProjectB", Time.local(2009, 12, 1, 17, 0, 0), Time.local(2009, 12, 1, 19, 0, 0), "another comment")
+
+    command_options = {:byday => true, :start => Time.local(2009, 12, 1), :end => Time.local(2009, 12, 6)}
+    stream = StringIO.new
+    @time_report.report(command_options, stream)
+    stream.string.should eql( <<EOS
+12/01/09
+	ProjectA 3h 0m
+	 - comment 1
+	ProjectB 18h 0m
+	 - comment 2
+	 - another comment
+12/03/09
+	ProjectA 8h 0m
+	 - comment 3
+12/04/09
+	ProjectB 8h 0m
+	 - comment 4
+12/05/09
+	ProjectC 8h 0m
+	 - comment 5
+EOS
+)
+
+  end
+
+end