one_inch_punch 0.1.2 → 0.1.3

data/History.txt

@@ -1,3 +1,10 @@
+== 0.1.3 2008-09-30
+
+* 3 enhancements:
+  * Punching in and out can take a time (with now as a default)
+  * Punching in and out can take a message (in addition to the auto-generated time-based message)
+  * punch command options for in/out time and message
+
 == 0.1.2 2008-08-28
 
 * 1 tiny enhancement:

data/bin/punch

@@ -29,6 +29,10 @@ BANNER
           "Restrict command to only after the given time") { |time|  OPTIONS[:after] = Time.parse(time) }
   opts.on('--before [TIME]', String,
           "Restrict command to only before the given time") { |time|  OPTIONS[:before] = Time.parse(time) }
+  opts.on('--at [TIME]', '--time [TIME]', String,
+          "Use the given time to punch in/out") { |time|  OPTIONS[:time] = Time.parse(time) }
+  opts.on('-m', '--message [MESSAGE]', String,
+          "Add the given log message when punching in/out") { |message|  OPTIONS[:message] = message }
   opts.on("-h", "--help",
           "Show this help message.") { puts opts; exit }
   opts.parse!(ARGV)
@@ -54,7 +58,7 @@ commands = {
   'total'  => lambda { |project|  puts Punch.total(project, OPTIONS.merge(:format => true)).inspect },
   'in'     => lambda do |project|
     if project
-      if Punch.in(project)
+      if Punch.in(project, OPTIONS)
         Punch.write
       else
         puts "Already punched in to '#{project}'"
@@ -72,7 +76,7 @@ commands = {
     end
   end,
   'out' => lambda do |project|
-    if Punch.out(project)
+    if Punch.out(project, OPTIONS)
       Punch.write
     else
       message = 'Already punched out of '

data/lib/punch/version.rb

@@ -2,7 +2,7 @@ module Punch
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/punch.rb

@@ -50,20 +50,23 @@ module Punch
       status(project) == 'in'
     end
     
-    def in(project)
+    def in(project, options = {})
       return false if in?(project)
       data[project] ||= []
-      time = Time.now
+      time = time_from_options(options)
       data[project].push({'in' => time})
       log(project, "punch in @ #{time.strftime('%Y-%m-%dT%H:%M:%S%z')}")
+      log(project, options[:message]) if options[:message]
       true
     end
     
-    def out(project = nil)
+    def out(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      project = args.first
       if project
-        return false unless do_out_single(project)
+        return false unless do_out_single(project, options)
       else
-        return false unless data.keys.collect { |project|  do_out_single(project) }.any?
+        return false unless data.keys.collect { |project|  do_out_single(project, options) }.any?
       end
       true
     end
@@ -105,9 +108,10 @@ module Punch
     
     private
     
-    def do_out_single(project)
+    def do_out_single(project, options)
       return false if out?(project)
-      time = Time.now
+      time = time_from_options(options)
+      log(project, options[:message]) if options[:message]
       log(project, "punch out @ #{time.strftime('%Y-%m-%dT%H:%M:%S%z')}")
       data[project].last['out'] = time
     end
@@ -124,5 +128,9 @@ module Punch
       return total unless options[:format]
       total.elapsed_time
     end
+    
+    def time_from_options(options)
+      options[:time] || options[:at] || Time.now
+    end
   end
 end

data/spec/punch_command_spec.rb

@@ -156,10 +156,36 @@ describe 'punch command' do
     end
     
     it 'should punch in to the given project' do
-      Punch.expects(:in).with(@project)
+      Punch.expects(:in).with(@project, {})
       run_command('in', @project)
     end
     
+    it 'should pass a time if specified on the command line (with --time)' do
+      time_option = '2008-08-23 15:39'
+      time = Time.local(2008, 8, 23, 15, 39)
+      Punch.expects(:in).with(@project, has_entry(:time => time))
+      run_command('in', @project, '--time', time_option)
+    end
+    
+    it 'should pass a time if specified on the command line (with --at)' do
+      time_option = '2008-08-23 15:39'
+      time = Time.local(2008, 8, 23, 15, 39)
+      Punch.expects(:in).with(@project, has_entry(:time => time))
+      run_command('in', @project, '--at', time_option)
+    end
+    
+    it 'should pass a message if specified on the command line (with --message)' do
+      message = 'About to do some amazing work'
+      Punch.expects(:in).with(@project, has_entry(:message => message))
+      run_command('in', @project, '--message', message)
+    end
+    
+    it 'should pass a message if specified on the command line (with -m)' do
+      message = 'About to do some amazing work'
+      Punch.expects(:in).with(@project, has_entry(:message => message))
+      run_command('in', @project, '-m', message)
+    end
+    
     describe 'when punched in successfully' do
       before :each do
         Punch.stubs(:in).returns(true)
@@ -226,13 +252,67 @@ describe 'punch command' do
     end
     
     it 'should punch out of the given project' do
-      Punch.expects(:out).with(@project)
+      Punch.expects(:out).with(@project, {})
       run_command('out', @project)
     end
     
-    it 'should punch out of all projects if none given' do
-      Punch.expects(:out).with(nil)
-      run_command('out')
+    it 'should pass a time if specified on the command line (with --time)' do
+      time_option = '2008-08-23 15:39'
+      time = Time.local(2008, 8, 23, 15, 39)
+      Punch.expects(:out).with(@project, has_entry(:time => time))
+      run_command('out', @project, '--time', time_option)
+    end
+    
+    it 'should pass a time if specified on the command line (with --at)' do
+      time_option = '2008-08-23 15:39'
+      time = Time.local(2008, 8, 23, 15, 39)
+      Punch.expects(:out).with(@project, has_entry(:time => time))
+      run_command('out', @project, '--at', time_option)
+    end
+    
+    it 'should pass a message if specified on the command line (with --message)' do
+      message = 'Finished doing some stellar work'
+      Punch.expects(:out).with(@project, has_entry(:message => message))
+      run_command('out', @project, '--message', message)
+    end
+    
+    it 'should pass a message if specified on the command line (with -m)' do
+      message = 'Finished doing some stellar work'
+      Punch.expects(:out).with(@project, has_entry(:message => message))
+      run_command('out', @project, '-m', message)
+    end
+    
+    describe 'if no project given' do
+      it 'should punch out of all projects' do
+        Punch.expects(:out).with(nil, {})
+        run_command('out')
+      end
+      
+      it 'should pass a time if specified on the command line (with --time)' do
+        time_option = '2008-08-23 15:39'
+        time = Time.local(2008, 8, 23, 15, 39)
+        Punch.expects(:out).with(nil, has_entry(:time => time))
+        run_command('out', '--time', time_option)
+      end
+      
+      it 'should pass a time if specified on the command line (with --at)' do
+        time_option = '2008-08-23 15:39'
+        time = Time.local(2008, 8, 23, 15, 39)
+        Punch.expects(:out).with(nil, has_entry(:time => time))
+        run_command('out', '--at', time_option)
+      end
+      
+      it 'should pass a message if specified on the command line (with --message)' do
+        message = 'Finished doing some stellar work'
+        Punch.expects(:out).with(nil, has_entry(:message => message))
+        run_command('out', '--message', message)
+      end
+      
+      it 'should pass a message if specified on the command line (with -m)' do
+        message = 'Finished doing some stellar work'
+        Punch.expects(:out).with(nil, has_entry(:message => message))
+        run_command('out', '-m', message)
+      end
     end
     
     describe 'when punched out successfully' do

data/spec/punch_spec.rb

@@ -287,6 +287,10 @@ describe Punch do
       lambda { Punch.in }.should raise_error(ArgumentError)
     end
     
+    it 'should accept options' do
+      lambda { Punch.in('proj', :time => Time.now) }.should_not raise_error(ArgumentError)
+    end
+    
     describe 'when the project is already punched in' do
       before :each do
         @data = { @project => [ {'in' => @now - 50, 'out' => @now - 25}, {'in' => @now - 5} ] }
@@ -321,6 +325,32 @@ describe Punch do
         Punch.in(@project)
       end
       
+      it 'should use a different time if given' do
+        time = @now + 50
+        Punch.in(@project, :time => time)
+        Punch.data[@project].last['in'].should == time
+      end
+      
+      it 'should log a message using the given time' do
+        time = @now + 75
+        time_str = time.strftime('%Y-%m-%dT%H:%M:%S%z')
+        Punch.expects(:log).with(@project, "punch in @ #{time_str}")
+        Punch.in(@project, :time => time)
+      end
+      
+      it 'should log an additional message if given' do
+        Punch.stubs(:log)  # for the time-based message
+        message = 'working on some stuff'
+        Punch.expects(:log).with(@project, message)
+        Punch.in(@project, :message => message)
+      end
+      
+      it "should allow the different time to be specified using :at" do
+        time = @now + 50
+        Punch.in(@project, :at => time)
+        Punch.data[@project].last['in'].should == time
+      end
+      
       it 'should return true' do
         Punch.in(@project).should == true
       end
@@ -352,6 +382,19 @@ describe Punch do
         Punch.in(@project)
       end
       
+      it 'should use a different time if given' do
+        time = @now + 50
+        Punch.in(@project, :time => time)
+        Punch.data[@project].last['in'].should == time
+      end
+      
+      it 'should log a message using the given time' do
+        time = @now + 75
+        time_str = time.strftime('%Y-%m-%dT%H:%M:%S%z')
+        Punch.expects(:log).with(@project, "punch in @ #{time_str}")
+        Punch.in(@project, :time => time)
+      end
+      
       it 'should return true' do
         Punch.in(@project).should == true
       end
@@ -385,6 +428,14 @@ describe Punch do
       lambda { Punch.out }.should_not raise_error(ArgumentError)
     end
     
+    it 'should accept a project name and options' do
+      lambda { Punch.out('proj', :time => Time.now) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should accept options without a project name' do
+      lambda { Punch.out(:time => Time.now) }.should_not raise_error(ArgumentError)
+    end
+    
     describe 'when the project is already punched out' do
       it 'should not change the project data' do
         old_data = @data.dup
@@ -413,12 +464,38 @@ describe Punch do
         Punch.data[@project].last['out'].should == @now
       end
       
-      it 'should log a message about punch-in time' do
+      it 'should log a message about punch-out time' do
         time = @now.strftime('%Y-%m-%dT%H:%M:%S%z')
         Punch.expects(:log).with(@project, "punch out @ #{time}")
         Punch.out(@project)
       end
       
+      it 'should use a different time if given' do
+        time = @now + 50
+        Punch.out(@project, :time => time)
+        Punch.data[@project].last['out'].should == time
+      end
+      
+      it 'should log a message using the given time' do
+        time = @now + 75
+        time_str = time.strftime('%Y-%m-%dT%H:%M:%S%z')
+        Punch.expects(:log).with(@project, "punch out @ #{time_str}")
+        Punch.out(@project, :time => time)
+      end
+      
+      it 'should log an additional message if given' do
+        Punch.stubs(:log)  # for the time-based message
+        message = 'finished working on some stuff'
+        Punch.expects(:log).with(@project, message)
+        Punch.out(@project, :message => message)
+      end
+      
+      it "should allow the different time to be specified using :at" do
+        time = @now + 50
+        Punch.out(@project, :at => time)
+        Punch.data[@project].last['out'].should == time
+      end
+      
       it 'should return true' do
         Punch.out(@project).should == true
       end
@@ -449,6 +526,30 @@ describe Punch do
         Punch.out
       end
       
+      it 'should use a different time if given' do
+        time = @now + 50
+        Punch.out(:time => time)
+        Punch.data[@projects[0]].last['out'].should == @now - 25
+        Punch.data[@projects[1]].last['out'].should == time
+        Punch.data[@projects[2]].last['out'].should == time
+      end
+      
+      it 'should log messages using the given time' do
+        time = @now + 75
+        time_str = time.strftime('%Y-%m-%dT%H:%M:%S%z')
+        Punch.expects(:log).with(@projects[1], "punch out @ #{time_str}")
+        Punch.expects(:log).with(@projects[2], "punch out @ #{time_str}")
+        Punch.out(:time => time)
+      end
+      
+      it 'should log an additional message if given' do
+        Punch.stubs(:log)  # for the time-based messages
+        message = 'finished working on some stuff'
+        Punch.expects(:log).with(@projects[1], message)
+        Punch.expects(:log).with(@projects[2], message)
+        Punch.out(:message => message)
+      end
+      
       it 'should return true' do
         Punch.out.should == true
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: one_inch_punch
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-28 00:00:00 -05:00
+date: 2008-09-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency