timesheet 0.2.0

data/spec/timesheet_parser_spec.rb

@@ -0,0 +1,235 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'chronic'
+
+describe TimesheetParser do
+
+  context "when given empty parameters" do
+
+    before :each do
+    end
+
+    it "should show usage" do
+      lambda {TimesheetParser.parse([])}.should raise_error SystemExit
+    end
+
+  end
+
+  context "when parsing in general" do
+    
+    it "should dump the options hash if the debug flag is set" do
+
+      outstream = StringIO.new
+      hash = TimesheetParser.parse(%w[--debug add -p a\ project\ name --start 12/1/2009\ at\ 11:00\ am --end 12/1/2009\ at\ 2:00\ pm --comment a\ comment], outstream)
+      outstream.string().should include("Command-line options hash...")
+    end
+
+    it "should report an error if the entire command line is not parsed" do
+      lambda {TimesheetParser.parse(%w[edit -r 100 -p a\ project\ name fiddle-dee-dee])}.should raise_error ArgumentError
+    end
+
+  end
+
+  context "when parsing add command" do
+
+    before :each do
+    end
+
+    it "should fail on a bare add" do
+      lambda {TimesheetParser.parse(["add"])}.should raise_error SystemExit
+    end
+
+    it "should parse a valid complete add command" do
+      hash = TimesheetParser.parse(%w[add -p a\ project\ name --start 12/1/2009\ at\ 11:00\ am --end 12/1/2009\ at\ 2:00\ pm --comment a\ comment])
+      hash[:command].should eql(:add)
+      hash[:project].should eql("a project name")
+      hash[:start].should eql(Time.local(2009, 12, 1, 11, 0, 0))
+      hash[:end].should eql(Time.local(2009, 12, 1, 14, 0, 0))
+      hash[:comment].should eql("a comment")
+    end
+
+    it "should allow comment to be optional" do
+      hash = TimesheetParser.parse(%w[add -p a\ project\ name --start 12/1/2009\at\ 11:00\ am --end 12/1/2009\ at\ 2:00\ pm])
+      hash[:command].should eql(:add)
+      hash[:project].should eql("a project name")
+      hash[:start].should eql(Time.local(2009, 12, 1, 11, 0, 0))
+      hash[:end].should eql(Time.local(2009, 12, 1, 14, 0, 0))
+    end
+
+    it "should require project" do
+      lambda {TimesheetParser.parse(%w[add --start 12/1/2009\at\ 11:00\ am --end 12/1/2009\ at\ 2:00\ pm])}.should raise_error SystemExit
+    end
+
+    it "should require start time" do
+      lambda {TimesheetParser.parse(%w[add -p a\ project\ name --end 12/1/2009\ at\ 2:00\ pm --comment a\ comment])}.should raise_error SystemExit
+    end
+
+    it "should require end time" do
+      lambda {TimesheetParser.parse(%w[add -p a\ project\ name --start 12/1/2009\at\ 11:00\ am --comment a\ comment])}.should raise_error SystemExit
+    end
+
+  end
+
+  context "when parsing list command" do
+
+    before :each do
+    end
+
+    it "should accept a bare list" do
+      lambda {TimesheetParser.parse(["list"])}.should_not raise_error SystemExit
+    end
+
+    it "should accept a start and end time" do
+      hash = TimesheetParser.parse(%w[list --start 12/1/2009\at\ 11:00\ am --end 12/1/2009\ at\ 2:00\ pm])
+      hash[:command].should eql(:report)
+      hash[:detail].should be_true
+      hash[:start].should eql(Time.local(2009, 12, 1, 11, 0, 0))
+      hash[:end].should eql(Time.local(2009, 12, 1, 14, 0, 0))
+    end
+
+    it "should accept --today" do      
+      hash = TimesheetParser.parse(%w[list --today])
+      hash[:command].should eql(:report)
+      hash[:detail].should be_true
+      hash[:start].should eql(Chronic.parse('today at 12 am'))
+      hash[:end].should eql(Chronic.parse('tomorrow at 12 am'))
+    end
+
+    it "should fail if start date and --today are used" do
+      lambda {TimesheetParser.parse(%w[list --today --start 12/1/2009\at\ 11:00\ am --end 12/1/2009\ at\ 2:00\ pm])}.should raise_error SystemExit
+    end
+
+    it "should fail if start date is missing end date" do
+      lambda {TimesheetParser.parse(%w[list --start 12/1/2009\at\ 11:00\ am])}.should raise_error SystemExit
+    end
+
+  end
+
+  context "when parsing edit command" do
+
+    before :each do
+    end
+
+    it "should fail on a bare edit" do
+      lambda {TimesheetParser.parse(["edit"])}.should raise_error SystemExit
+    end
+
+    it "should parse a valid complete edit command" do
+      hash = TimesheetParser.parse(%w[edit -r 100 -p a\ project\ name --start 12/1/2009\at\ 11:00\ am --end 12/1/2009\ at\ 2:00\ pm --comment a\ comment])
+      hash[:command].should eql(:edit)
+      hash[:record_number].should eql(100)
+      hash[:project].should eql("a project name")
+      hash[:start].should eql(Time.local(2009, 12, 1, 11, 0, 0))
+      hash[:end].should eql(Time.local(2009, 12, 1, 14, 0, 0))
+      hash[:comment].should eql("a comment")
+    end
+
+    it "should allow just comment" do
+      hash = TimesheetParser.parse(%w[edit -r 12 -c a\ new\ comment])
+      hash[:command].should eql(:edit)
+      hash[:record_number].should eql(12)
+      hash[:project].should be_nil
+      hash[:start].should be_nil
+      hash[:end].should be_nil
+      hash[:comment].should eql("a new comment")
+    end
+
+    it "should allow just project" do
+      hash = TimesheetParser.parse(%w[edit --record-number 200 --project a\ new\ project])
+      hash[:command].should eql(:edit)
+      hash[:record_number].should eql(200)
+      hash[:project].should eql("a new project")
+      hash[:start].should be_nil
+      hash[:end].should be_nil
+      hash[:comment].should be_nil
+    end
+
+    it "should allow just start time" do
+      hash = TimesheetParser.parse(%w[edit -r 1 -s 12/1/2009\at\ 11:00\ am])
+      hash[:command].should eql(:edit)
+      hash[:record_number].should eql(1)
+      hash[:project].should be_nil
+      hash[:start].should eql(Time.local(2009, 12, 1, 11, 0, 0))
+      hash[:end].should be_nil
+      hash[:comment].should be_nil
+    end
+
+    it "should allow just end time" do
+      hash = TimesheetParser.parse(%w[edit -r 1 -e 12/1/2009\at\ 2:00\ pm])
+      hash[:command].should eql(:edit)
+      hash[:record_number].should eql(1)
+      hash[:project].should be_nil
+      hash[:start].should be_nil 
+      hash[:end].should eql(Time.local(2009, 12, 1, 14, 0, 0))
+      hash[:comment].should be_nil
+    end
+
+  end
+
+  context "when parsing delete command" do
+
+    before :each do
+    end
+
+    it "should fail on a bare delete" do
+      lambda {TimesheetParser.parse(["delete"])}.should raise_error SystemExit
+    end
+
+    it "should parse a valid delete command" do
+      hash = TimesheetParser.parse(%w[delete -r 100])
+      hash[:command].should eql(:delete)
+      hash[:record_number].should eql(100)
+    end
+
+  end
+
+  context "when parsing report command" do
+
+    before :each do
+    end
+
+    it "should accept a bare report" do
+      lambda {TimesheetParser.parse(["report"])}.should_not raise_error SystemExit
+    end
+
+    it "should parse a valid complete report command" do
+      hash = TimesheetParser.parse(%w[report --summary --start 12/1/2009\at\ 11:00\ am --end 12/1/2009\ at\ 2:00\ pm])
+      hash[:command].should eql(:report)
+      hash[:summary].should be_true
+      hash[:detail].should be_false
+      hash[:byday].should be_false
+      hash[:start].should eql(Time.local(2009, 12, 1, 11, 0, 0))
+      hash[:end].should eql(Time.local(2009, 12, 1, 14, 0, 0))
+    end
+
+    it "should reject conflicting parameters" do
+      lambda {TimesheetParser.parse(%w[report --summary --detail])}.should raise_error SystemExit
+    end
+
+    it "should reject start without end" do
+      lambda {TimesheetParser.parse(%w[report --summary --start 12/1/2009\at\ 11:00\ am ])}.should raise_error SystemExit
+    end
+
+    it "should allow shortcuts" do
+      hash = TimesheetParser.parse(%w[report --byday --yesterday])
+      hash[:command].should eql(:report)
+      hash[:summary].should be_false
+      hash[:detail].should be_false
+      hash[:byday].should be_true
+      hash[:start].should eql(Chronic.parse('yesterday at 12 am'))
+      hash[:end].should eql(Chronic.parse('today at 12 am'))
+    end
+
+  end
+
+  context "when given nonsense" do
+
+    before :each do
+    end
+
+    it "should reject unknown commands" do
+      lambda {TimesheetParser.parse(%w[trundlebug])}.should raise_error SystemExit
+    end
+
+  end
+
+end

data/spec/timesheet_spec.rb

@@ -0,0 +1,188 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Timesheet do
+
+  context "when being invoked" do
+
+    it "should print an error when no environment values are defined" do
+
+      params = mock("ARGV")
+      command_hash = mock("command_hash")
+
+      TimesheetParser.should_receive(:parse).with(params).once.and_return(command_hash)
+
+      ENV.should_receive(:[]).with("TIMESHEET_DATA_FILE").once.and_return(nil)
+      ENV.should_receive(:[]).with("HOME").once.and_return(nil)
+
+      command_hash.should_receive(:[]).with(:debug).once.and_return(nil)
+
+      Timesheet.should_receive(:puts).with("Cannot determine location for data. Try timesheet --help for details.").once.and_return(nil)
+
+      Timesheet.run(params)
+
+    end
+
+    it "should use the environment value for TIMESHEET_DATA_FILE if it is defined" do
+
+      params = mock("ARGV")
+      command_hash = mock("command_hash")
+      store = mock("store")
+      time_log = mock("time_log")
+      time_sheet = mock("time_sheet")
+      timesheet_data_file = mock('ENV["TIMESHEET_DATA_FILE"]')
+
+      expected_timesheet_data_file = "/somepath/someotherpath/somefile.someext"
+      expected_timesheet_data_file_path = "/somepath/someotherpath"
+
+      TimesheetParser.should_receive(:parse).with(params).once.and_return(command_hash)
+
+      ENV.should_receive(:[]).with("TIMESHEET_DATA_FILE").twice.and_return(expected_timesheet_data_file)
+
+      File.should_receive(:dirname).with(expected_timesheet_data_file).once.and_return(expected_timesheet_data_file_path)
+      FileUtils.should_receive(:makedirs).with(expected_timesheet_data_file_path).once.and_return(expected_timesheet_data_file_path)
+
+      YAML::Store.should_receive(:new).with(expected_timesheet_data_file).once.and_return(store)
+      TimeLog.should_receive(:new).with(store).once.and_return(time_log)
+      Timesheet.should_receive(:new).with(time_log).once.and_return(time_sheet)
+      time_sheet.should_receive(:process).with(command_hash)
+
+      Timesheet.run(params)
+
+    end
+
+    it "should use the environment value for HOME if it is defined and TIMESHEET_DATA_FILE is not" do
+
+      params = mock("ARGV")
+      command_hash = mock("command_hash")
+      store = mock("store")
+      time_log = mock("time_log")
+      time_sheet = mock("time_sheet")
+
+      expected_home = "/Users/someuser"
+      expected_data_file = "/Users/someuser/.timesheet/store.yaml"
+      expected_data_file_path = "/Users/someuser/.timesheet"
+
+      TimesheetParser.should_receive(:parse).with(params).once.and_return(command_hash)
+
+      ENV.should_receive(:[]).with("TIMESHEET_DATA_FILE").twice.and_return(nil)
+      ENV.should_receive(:[]).with("HOME").twice.and_return(expected_home)
+
+      File.should_receive(:dirname).with(expected_data_file).once.and_return(expected_data_file_path)
+      FileUtils.should_receive(:makedirs).with(expected_data_file_path).once.and_return(expected_data_file_path)
+
+      YAML::Store.should_receive(:new).with(expected_data_file).once.and_return(store)
+      TimeLog.should_receive(:new).with(store).once.and_return(time_log)
+      Timesheet.should_receive(:new).with(time_log).once.and_return(time_sheet)
+      time_sheet.should_receive(:process).with(command_hash)
+
+      Timesheet.run(params)
+
+    end
+
+  end
+
+  context "when processing command" do
+
+    before :each do
+      @command = mock("command")
+      @timelog = mock("timelog")
+      @timesheet = Timesheet.new(@timelog)
+    end
+
+    it "should dispatch to the proper command handler" do
+      valid_dispatch_cases = {
+              :add => :process_add_command,
+              :edit => :process_edit_command,
+              :report => :process_report_command}
+
+      valid_dispatch_cases.each do |key, value|
+        @command.should_receive(:[]).with(:command).once.and_return(key)
+        @timesheet.should_receive(value).with(@command).once
+        @timesheet.process(@command)
+      end
+    end
+
+    it "should raise error when the command is not understood" do
+      @command.should_receive(:[]).with(:command).once.and_return("invalid_command")
+      lambda { @timesheet.process(@command) }.should raise_error RuntimeError
+    end
+
+  end
+
+  context "when processing add command" do
+
+    it "should perform an add" do
+      command = mock("add command")
+      timelog = mock("timelog")
+      timesheet = Timesheet.new(timelog)
+
+      project = mock("project")
+      start_time = mock("start time")
+      end_time = mock("end time")
+      entry = mock("time entry")
+
+      command.should_receive(:[]).with(:project).once.and_return(project)
+      command.should_receive(:[]).with(:start).once.and_return(start_time)
+      command.should_receive(:[]).with(:end).once.and_return(end_time)
+      command.should_receive(:[]).with(:comment).once.and_return(nil)
+      TimeEntry.should_receive(:new).with(project, start_time, end_time, nil).and_return(entry)
+      timelog.should_receive(:add).with(entry)
+      
+      timesheet.process_add_command(command)
+    end
+
+  end
+
+  context "when processing edit command" do
+
+    it "should perform an edit" do
+      command = mock("edit command")
+      timelog = mock("timelog")
+      timesheet = Timesheet.new(timelog)
+
+      command.should_receive(:delete).with(:record_number).once.and_return(100)
+      timelog.should_receive(:update).with(100, command)
+
+      timesheet.process_edit_command(command)
+    end
+
+  end
+
+  context "when processing delete command" do
+
+    it "should perform a delete" do
+      command = mock("delete command")
+      timelog = mock("timelog")
+      timesheet = Timesheet.new(timelog)
+
+      command.should_receive(:delete).with(:record_number).once.and_return(100)
+      timelog.should_receive(:delete).with(100)
+
+      timesheet.process_delete_command(command)
+    end
+
+  end
+
+  context "when processing report command" do
+
+    it "should produce a report" do
+      command = mock("report command")
+      timelog = mock("timelog")
+      start_time = mock("start time")
+      end_time = mock("end time")
+      entries = mock("entries")
+      time_report = mock("time report")
+      timesheet = Timesheet.new(timelog)
+
+      command.should_receive(:[]).with(:start).once.and_return(start_time)
+      command.should_receive(:[]).with(:end).once.and_return(end_time)
+      timelog.should_receive(:extract_entries).with(start_time, end_time).once.and_return(entries)
+      TimeReport.should_receive(:new).with(entries).once.and_return(time_report)
+      time_report.should_receive(:report).with(command)
+
+      timesheet.process_report_command(command)      
+    end
+
+  end
+
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,274 @@
+--- !ruby/object:Gem::Specification 
+name: timesheet
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- John F. Schank III
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: archive-tar-minitar
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: chronic
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: color
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: pdf-writer
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rich_units
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubigen
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: syntax
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: transaction-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.4.0
+    version: 
+description: |-
+  <i>Timesheet</i> is simple ruby application for tracking time spent on projects.
+  It is a console application that uses a simple text file storage back-end (YAML::Store)
+  
+  The main idea is to be able to produce reports of hours spent, such that I can use geektool to display the reports.
+email: 
+- jschank@mac.com
+executables: 
+- timesheet
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/timesheet
+- lib/timesheet.rb
+- lib/timesheet/range_extensions.rb
+- lib/timesheet/time_entry.rb
+- lib/timesheet/time_log.rb
+- lib/timesheet/time_report.rb
+- lib/timesheet/timesheet_parser.rb
+- lib/timesheet/trollop.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/range_extensions_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/time_entry_spec.rb
+- spec/time_log_spec.rb
+- spec/time_report_spec.rb
+- spec/timesheet_parser_spec.rb
+- spec/timesheet_spec.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/jschank/timesheet
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: timesheet
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: <i>Timesheet</i> is simple ruby application for tracking time spent on projects
+test_files: []
+