one_inch_punch 0.3.3 → 0.4.0

data/History.txt

@@ -1,3 +1,14 @@
+== 0.4.0 2008-08-17
+
+* 1 minor enhancement:
+  * added 'summary' command
+    * shows a breakdown of time spent on a project, using the times in log messages to indicate activities
+    * accepts before/after options
+* 1 tiny enhancement
+  * full status now includes the last log message if the project is punched in
+* 1 tiny bugfix
+  * full status now works with "short" (only display what's punched-in) instead of always showing 'out'
+
 == 0.3.3 2008-06-25
 
 * 1 tiny enhancement:

data/bin/punch

@@ -118,6 +118,13 @@ commands = {
     end
   end,
   'list' => lambda { |project|  puts Punch.list(project, OPTIONS).to_yaml },
+  'summary' => lambda do |project|
+    if project
+      puts Punch.summary(project, OPTIONS.merge(:format => true)).to_yaml
+    else
+      puts "Project required"
+    end
+  end
 }
 
 if command_code = commands[command]

data/lib/punch.rb

@@ -2,6 +2,8 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'yaml'
+require 'time'
+require 'enumerator'
 require 'punch/core_ext'
 require 'punch/instance'
 
@@ -49,7 +51,8 @@ class Punch
         stats = {}
         projects.each { |project|  stats[project] = status(project, options) }
         if options[:short]
-          stats.reject! { |k, v|  v != 'in' }
+          stats.reject! { |k, v|  v.nil? }
+          stats.reject! { |k, v|  v != 'in' and v[:status] != 'in' }
           stats = 'out' if stats.empty?
         end
         return stats
@@ -67,7 +70,13 @@ class Punch
       return status unless options[:full]
       return status if status.nil?
       
-      { :status => status, :time => time_data[status] }
+      if status == 'in'
+        message = (time_data['log'] || []).last
+      end
+      
+      result = { :status => status, :time => time_data[status] }
+      result[:message] = message if message
+      result
     end
     
     def out?(project)
@@ -142,6 +151,34 @@ class Punch
       true
     end
     
+    def summary(project, options = {})
+      return unless list_data = list(project, options)
+      summary = Hash.new(0)
+      
+      list_data.each do |time_data|
+        unless (time_data['log'] || []).empty?
+          log = time_data['log'].collect do |l|
+            msg, time = l.split('@')
+            msg = msg.strip
+            msg = 'unspecified' if msg == 'punch in'
+            { :msg => msg, :time => Time.parse(time) }
+          end
+          
+          log << { :msg => 'punch out', :time => Time.now } unless log.last[:msg] == 'punch out'
+      
+          log.each_cons(2) do |a, b|
+            summary[a[:msg]] += (b[:time] - a[:time]).to_i
+          end
+        else
+          summary['unspecified'] += ((time_data['out'] || Time.now) - time_data['in']).to_i
+        end
+      end
+      
+      summary.reject! { |k, v|  v == 0 }
+      summary.each { |k, v|  summary[k] = v.elapsed_time } if options[:format]
+      summary
+    end
+    
     
     private
     

data/lib/punch/instance.rb

@@ -37,6 +37,10 @@ class Punch
     self.class.log(project, message, options)
   end
   
+  def summary(options = {})
+    self.class.summary(project, options)
+  end
+  
   def ==(other)
     project == other.project
   end

data/lib/punch/version.rb

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

data/spec/punch_command_spec.rb

@@ -190,6 +190,11 @@ describe 'punch command' do
       run_command('status', '--short')
     end
     
+    it 'should handle both --short and --full options together' do
+      Punch.should.receive(:status).with(nil, :short => true, :full => true)
+      run_command('status', '--short', '--full')
+    end
+    
     it 'should not write the data' do
       Punch.should.receive(:write).never
       run_command('status')
@@ -706,6 +711,99 @@ describe 'punch command' do
     end
   end
   
+  describe "when the command is 'summary'" do
+    before do
+      Punch.stub!(:summary)
+    end
+    
+    it 'should load punch data' do
+      Punch.should.receive(:load)
+      run_command('summary', @project)
+    end
+    
+    it 'should get the summary for the requested project' do
+      Punch.should.receive(:summary) do |proj, _|
+        proj.should == @project
+      end
+      run_command('summary', @project)
+    end
+    
+    it 'should output the summary' do
+      result = 'summary data'
+      Punch.stub!(:summary).and_return(result)
+      self.should.receive(:puts).with(result.to_yaml)
+      run_command('summary', @project)
+    end
+    
+    describe 'when options specified' do
+      it "should pass on an 'after' time option given by --after" do
+        time_option = '2008-08-26 09:47'
+        time = Time.local(2008, 8, 26, 9, 47)
+        Punch.should.receive(:summary) do |proj, options|
+          proj.should == @project
+          options[:after].should == time
+        end
+        run_command('summary', @project, '--after', time_option)
+      end
+      
+      it "should pass on a 'before' time option given by --before" do
+        time_option = '2008-08-23 15:39'
+        time = Time.local(2008, 8, 23, 15, 39)
+        Punch.should.receive(:summary) do |proj, options|
+          proj.should == @project
+          options[:before].should == time
+        end
+        run_command('summary', @project, '--before', time_option)
+      end
+      
+      it 'should handle a time option given as a date' do
+        time_option = '2008-08-23'
+        time = Time.local(2008, 8, 23)
+        Punch.should.receive(:summary) do |proj, options|
+          proj.should == @project
+          options[:before].should == time
+        end
+        run_command('summary', @project, '--before', time_option)
+      end
+      
+      it 'should also pass the formatting option' do
+        time_option = '2008-08-23'
+        Punch.should.receive(:summary) do |proj, options|
+          proj.should == @project
+          options[:format].should == true
+        end
+        run_command('summary', @project, '--before', time_option)
+      end
+    end
+    
+    it 'should pass only the formatting option if no options specified' do
+      Punch.should.receive(:summary) do |proj, options|
+        proj.should == @project
+        options[:format].should == true
+      end
+      run_command('summary', @project)
+    end
+    
+    it 'should not write the data' do
+      Punch.should.receive(:write).never
+      run_command('summary')
+    end
+    
+    describe 'when no project given' do
+      it 'should display an error message' do
+        self.should.receive(:puts) do |output|
+          output.should.match(/project.+require/i)
+        end
+        run_command('summary')
+      end
+
+      it 'should not punch in' do
+        Punch.should.receive(:summary).never
+        run_command('summary')
+      end
+    end
+  end
+  
   describe 'when the command is unknown' do
     it 'should not error' do
       lambda { run_command('bunk') }.should.not.raise

data/spec/punch_instance_spec.rb

@@ -382,6 +382,56 @@ describe Punch, 'instance' do
     end
   end
   
+  it 'should give project summary' do
+    @punch.should.respond_to(:summary)
+  end
+  
+  describe 'giving project summary' do
+    before do
+      @summary = 'summary val'
+      Punch.stub!(:summary).and_return(@summary)
+    end
+    
+    it 'should accept options' do
+      lambda { @punch.summary(:format => true) }.should.not.raise(ArgumentError)
+    end
+    
+    it 'should not require options' do
+      lambda { @punch.summary }.should.not.raise(ArgumentError)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.should.receive(:summary)
+      @punch.summary
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.should.receive(:summary) do |proj, _|
+        proj.should == @project
+      end
+      @punch.summary
+    end
+    
+    it 'should pass the options when delegating to the class' do
+      options = { :format => true }
+      Punch.should.receive(:summary) do |_, opts|
+        opts.should == options
+      end
+      @punch.summary(options)
+    end
+    
+    it 'should pass an empty hash if no options given' do
+      Punch.should.receive(:summary) do |_, opts|
+        opts.should == {}
+      end
+      @punch.summary
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.summary.should == @summary
+    end
+  end
+  
   describe 'equality' do
     it 'should be equal to another instance for the same project' do
       Punch.new('proj').should == Punch.new('proj')

data/spec/punch_spec.rb

@@ -228,7 +228,7 @@ describe Punch do
         Punch.status('other project', :full => true).should.be.nil
       end
       
-      it 'should return the full status if all projects if nil is given as the project' do
+      it 'should return the full status of all projects if nil is given as the project' do
         Punch.status(nil, :full => true).should == {
           @projects['out'] => { :status => 'out', :time => @now + 12 },
           @projects['in']  => { :status => 'in',  :time => @now }
@@ -242,68 +242,150 @@ describe Punch do
         }
       end
       
-      describe 'when given a :short option' do
-        it "should return 'in' if the project is currently punched in" do
-          Punch.status(@projects['in'], :short => true).should == 'in'
+      it 'should include a message for a punched-in project with log messages' do
+        message = 'some test message'
+        @data[@projects['in']].last['log'] = [message]
+        Punch.status(@projects['in'], :full => true).should == { :status => 'in', :time => @now, :message => message }
+      end
+      
+      it 'should use the last log message for punched-in projects' do
+        message = 'some test message'
+        @data[@projects['in']].last['log'] = ['some other message', message]
+        Punch.status(@projects['in'], :full => true).should == { :status => 'in', :time => @now, :message => message }
+      end
+      
+      it 'should not include a message for a punched-out project with log messages' do
+        @data[@projects['out']].last['log'] = ['some message']
+        Punch.status(@projects['out'], :full => true).should == { :status => 'out', :time => @now + 12 }
+      end
+    end
+    
+    describe 'when given a :short option' do
+      it "should return 'in' if the project is currently punched in" do
+        Punch.status(@projects['in'], :short => true).should == 'in'
+      end
+      
+      it "should return 'out' if the project is currently punched out" do
+        Punch.status(@projects['out'], :short => true).should == 'out'
+      end
+      
+      it 'should return nil if project does not exist' do
+        Punch.status('other project', :short => true).should.be.nil
+      end
+      
+      describe 'handling multiple projects' do
+        before do
+          @projects['in2']  = 'bingbang'
+          @projects['out2'] = 'boopadope'
+          @data[@projects['in2']]  = [ { 'in' => @now - 5 } ]
+          @data[@projects['out2']] = [ { 'in' => @now - 500, 'out' => @now - 20 } ]
+          Punch.data = @data
         end
         
-        it "should return 'out' if the project is currently punched out" do
-          Punch.status(@projects['out'], :short => true).should == 'out'
+        it 'should return just the punched-in projects if nil is given as the project' do
+          Punch.status(nil, :short => true).should == {
+            @projects['in']  => 'in',
+            @projects['in2'] => 'in'
+          }
         end
         
-        it 'should return nil if project does not exist' do
-          Punch.status('other project', :short => true).should.be.nil
+        it 'should return just the punched-in projects if no project given' do
+          Punch.status(:short => true).should == {
+            @projects['in']  => 'in',
+            @projects['in2'] => 'in'
+          }
         end
         
-        describe 'handling multiple projects' do
-          before do
-            @projects['in2']  = 'bingbang'
-            @projects['out2'] = 'boopadope'
-            @data[@projects['in2']]  = [ { 'in' => @now - 5 } ]
-            @data[@projects['out2']] = [ { 'in' => @now - 500, 'out' => @now - 20 } ]
-            Punch.data = @data
-          end
+        it 'should not include empty projects' do
+          @data['empty_project'] = []
+          Punch.data = @data
           
-          it 'should return just the punched-in projects if nil is given as the project' do
-            Punch.status(nil, :short => true).should == {
-              @projects['in']  => 'in',
-              @projects['in2'] => 'in'
-            }
-          end
+          Punch.status(:short => true).should == {
+            @projects['in']  => 'in',
+            @projects['in2'] => 'in'
+          }
+        end
+        
+        it "should return 'out' if all projects are punched out" do
+          @data.delete(@projects['in'])
+          @data.delete(@projects['in2'])
+          Punch.data = @data
           
-          it 'should return just the punched-in projects if no project given' do
-            Punch.status(:short => true).should == {
-              @projects['in']  => 'in',
-              @projects['in2'] => 'in'
-            }
-          end
+          Punch.status(:short => true).should == 'out'
+        end
+        
+        it "should return 'out' if all projects are punched out or empty" do
+          @data.delete(@projects['in'])
+          @data.delete(@projects['in2'])
+          @data['empty_project'] = []
+          Punch.data = @data
+          
+          Punch.status(:short => true).should == 'out'
+        end
+      end
+    end
+    
+    describe 'when given both :short and :full options' do
+      it 'should return the full status of a punched-in project' do
+        Punch.status(@projects['in'], :short => true, :full => true).should == { :status => 'in', :time => @now }
+      end
+      
+      it 'should return the full status of a punched-out project' do
+        Punch.status(@projects['out'], :short => true, :full => true).should == { :status => 'out', :time => @now + 12 }
+      end
+      
+      it 'should return nil if project does not exist' do
+        Punch.status('other project', :short => true, :full => true).should.be.nil
+      end
+      
+      describe 'handling multiple projects' do
+        before do
+          @projects['in2']  = 'bingbang'
+          @projects['out2'] = 'boopadope'
+          @data[@projects['in2']]  = [ { 'in' => @now - 5 } ]
+          @data[@projects['out2']] = [ { 'in' => @now - 500, 'out' => @now - 20 } ]
+          Punch.data = @data
+        end
+        
+        it 'should return the full status of just the punched-in projects if nil is given as the project' do
+          Punch.status(nil, :short => true, :full => true).should == {
+            @projects['in']  => { :status => 'in', :time => @now },
+            @projects['in2'] => { :status => 'in', :time => @now - 5 }
+          }
+        end
+        
+        it 'should return the full status of just the punched-in projects if no project given' do
+          Punch.status(:short => true, :full => true).should == {
+            @projects['in']  => { :status => 'in', :time => @now },
+            @projects['in2'] => { :status => 'in', :time => @now - 5 }
+          }
+        end
+        
+        it 'should not include empty projects' do
+          @data['empty_project'] = []
+          Punch.data = @data
           
-          it 'should not include empty projects' do
-            @data['empty_project'] = []
-            Punch.data = @data
-            
-            Punch.status(:short => true).should == {
-              @projects['in']  => 'in',
-              @projects['in2'] => 'in'
-            }
-          end
+          Punch.status(:short => true, :full => true).should == {
+            @projects['in']  => { :status => 'in', :time => @now },
+            @projects['in2'] => { :status => 'in', :time => @now - 5 }
+          }
+        end
+        
+        it "should return 'out' if all projects are punched out" do
+          @data.delete(@projects['in'])
+          @data.delete(@projects['in2'])
+          Punch.data = @data
           
-          it "should return 'out' if all projects are punched out" do
-            @data.delete(@projects['in'])
-            @data.delete(@projects['in2'])
-            Punch.data = @data
-            
-            Punch.status(:short => true).should == 'out'
-          end
+          Punch.status(:short => true, :full => true).should == 'out'
+        end
+        
+        it "should return 'out' if all projects are punched out or empty" do
+          @data.delete(@projects['in'])
+          @data.delete(@projects['in2'])
+          @data['empty_project'] = []
+          Punch.data = @data
           
-          it "should return 'out' if all projects are punched out or empty" do
-            @data.delete(@projects['in'])
-            @data.delete(@projects['in2'])
-            @data['empty_project'] = []
-            Punch.data = @data
-            
-            Punch.status(:short => true).should == 'out'
-          end
+          Punch.status(:short => true, :full => true).should == 'out'
         end
       end
     end
@@ -1404,4 +1486,158 @@ describe Punch do
       end
     end
   end
+  
+  it 'should provide a summary of project time use' do
+    Punch.should.respond_to(:summary)
+  end
+  
+  describe 'providing a summary of project time use' do
+    def format_time(time)
+      time.strftime()
+    end
+    
+    before do
+      @message = 'test usage'
+      @now = Time.now
+      Time.stub!(:now).and_return(@now)
+      @project = 'test project'
+      @data = { @project => [ {'in' => @now - 500, 'out' => @now - 100} ] }
+      @time_data = @data[@project].last
+      @time_format = '%Y-%m-%dT%H:%M:%S%z'
+      @time_data['log'] = ["punch in @ #{@time_data['in'].strftime(@time_format)}", "#{@message} @ #{@time_data['in'].strftime(@time_format)}", "punch out @ #{@time_data['out'].strftime(@time_format)}"]
+      
+      Punch.instance_eval do
+        class << self
+          public :data, :data=
+        end
+      end
+      Punch.data = @data
+    end
+    
+    it 'should accept a project name' do
+      lambda { Punch.summary('proj') }.should.not.raise(ArgumentError)
+    end
+    
+    it 'should require a project name' do
+      lambda { Punch.summary }.should.raise(ArgumentError)
+    end
+    
+    describe 'when the project exists' do
+      it 'should use the log message to indicate time usage' do
+        Punch.summary(@project).should == { @message => 400 }
+      end
+      
+      it 'should break down a punched-in time based on log message times' do
+        other_message = 'some other message'
+        @time_data['log'][-1,0] = "#{other_message} @ #{(@time_data['out'] - 100).strftime(@time_format)}"
+        Punch.summary(@project).should == { @message => 300, other_message => 100 }
+      end
+      
+      it 'should leave out any messages with empty times' do
+        other_message = 'some other message'
+        @time_data['log'][-1,0] = "#{other_message} @ #{(@time_data['out'] - 100).strftime(@time_format)}"
+        @time_data['log'][-1,0] = "some third message @ #{(@time_data['out']).strftime(@time_format)}"
+        Punch.summary(@project).should == { @message => 300, other_message => 100 }
+      end
+      
+      it 'should record unspecified time use' do
+        @time_data['log'][1] = "#{@message} @ #{(@time_data['in'] + 100).strftime(@time_format)}"
+        Punch.summary(@project).should == { @message => 300, 'unspecified' => 100 }
+      end
+      
+      it 'should record the block of time as unspecified if there are no log messages' do
+        @time_data['log'] = []
+        Punch.summary(@project).should == { 'unspecified' => 400 }
+      end
+      
+      it 'should record the block of time as unspecified if there is no log' do
+        @time_data.delete('log')
+        Punch.summary(@project).should == { 'unspecified' => 400 }
+      end
+      
+      it 'should summarize and combine all time data for the project' do
+        other_message = 'some other message'
+        @data = { @project => [ 
+          {'in' => @now - 650, 'out' => @now - 600, 'log' => ["punch in @ #{(@now - 650).strftime(@time_format)}", "#{@message} @ #{(@now - 650).strftime(@time_format)}", "punch out @ #{(@now - 600).strftime(@time_format)}"]},
+          {'in' => @now - 400, 'out' => @now - 350, 'log' => ["punch in @ #{(@now - 400).strftime(@time_format)}", "punch out @ #{(@now - 350).strftime(@time_format)}"]},
+          {'in' => @now - 300, 'out' => @now - 150, 'log' => ["punch in @ #{(@now - 300).strftime(@time_format)}", "#{@message} @ #{(@now - 200).strftime(@time_format)}", "punch out @ #{(@now - 150).strftime(@time_format)}"]},
+          {'in' => @now - 100, 'out' => @now + 250, 'log' => ["punch in @ #{(@now - 100).strftime(@time_format)}", "#{other_message} @ #{(@now - 50).strftime(@time_format)}", "punch out @ #{(@now + 250).strftime(@time_format)}"]}
+        ] }
+        Punch.data = @data
+        
+        Punch.summary(@project).should == { 'unspecified' => 200, @message => 100, other_message => 300 }
+      end
+      
+      it 'should allow options' do
+        lambda { Punch.summary('proj', :after => Time.now) }.should.not.raise(ArgumentError)
+      end
+      
+      describe 'handling options' do
+        before do
+          @other_message = 'some other message'
+          @data = { @project => [ 
+            {'in' => @now - 650, 'out' => @now - 600, 'log' => ["punch in @ #{(@now - 650).strftime(@time_format)}", "#{@message} @ #{(@now - 650).strftime(@time_format)}", "punch out @ #{(@now - 600).strftime(@time_format)}"]},
+            {'in' => @now - 400, 'out' => @now - 350, 'log' => ["punch in @ #{(@now - 400).strftime(@time_format)}", "punch out @ #{(@now - 350).strftime(@time_format)}"]},
+            {'in' => @now - 300, 'out' => @now - 150, 'log' => ["punch in @ #{(@now - 300).strftime(@time_format)}", "#{@message} @ #{(@now - 200).strftime(@time_format)}", "punch out @ #{(@now - 150).strftime(@time_format)}"]},
+            {'in' => @now - 100, 'out' => @now + 250, 'log' => ["punch in @ #{(@now - 100).strftime(@time_format)}", "#{@other_message} @ #{(@now - 50).strftime(@time_format)}", "punch out @ #{(@now + 250).strftime(@time_format)}"]}
+          ] }
+          Punch.data = @data
+        end
+        
+        it 'should restrict the summary to times only after a certain time' do
+          Punch.summary(@project, :after => @now - 401).should == { 'unspecified' => 200, @message => 50, @other_message => 300 }
+        end
+        
+        it 'should restrict the summary to times only before a certain time' do
+          Punch.summary(@project, :before => @now - 149).should == { 'unspecified' => 150, @message => 100 }
+        end
+        
+        it 'should restrict the summary to times only within a time range' do
+          Punch.summary(@project, :after => @now - 401, :before => @now - 149).should == { 'unspecified' => 150, @message => 50 }
+        end
+        
+        it 'should format the time spent if passed a format option' do
+          Punch.summary(@project, :format => true).should == { 'unspecified' => '03:20', @message => '01:40', @other_message => '05:00' }
+        end
+      end
+      
+      describe 'when the project is currently punched in' do
+        before do
+          @data = { @project => [ {'in' => @now - 500} ] }
+          @time_data = @data[@project].last
+          @time_data['log'] = ["punch in @ #{@time_data['in'].strftime(@time_format)}", "#{@message} @ #{(@time_data['in'] + 200).strftime(@time_format)}"]
+          Punch.data = @data
+        end
+        
+        it 'should summarize time up to now' do
+          Punch.summary(@project).should == { 'unspecified' => 200, @message => 300 }
+        end
+        
+        it 'should handle time data with no specific log messages' do
+          @time_data['log'].pop
+          Punch.summary(@project).should == { 'unspecified' => 500 }
+        end
+        
+        it 'should handle time data with no log messages' do
+          @time_data['log'] = []
+          Punch.summary(@project).should == { 'unspecified' => 500 }
+        end
+        
+        it 'should handle time data with no log' do
+          @time_data.delete('log')
+          Punch.summary(@project).should == { 'unspecified' => 500 }
+        end
+      end
+    end
+    
+    describe 'when the project does not exist' do
+      before do
+        @project = 'non-existent project'
+      end
+      
+      it 'should return nil' do
+        Punch.summary(@project).should.be.nil
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: one_inch_punch
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-25 00:00:00 -05:00
+date: 2009-08-17 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
+        version: 2.3.3
     version: 
 description: a simple time-tracking tool
 email: 
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yomendel
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: a simple time-tracking tool