one_inch_punch 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,11 @@
+== 0.1.1 2008-08-28
+
+* 3 enhancements:
+  * Can format total time as "elapsed time" instead of only getting the number of seconds
+  * punch command gives improved output for some commands:
+    * in/out/log: either silent or gives a message explaining a failure
+    * total: shows "elapsed time" instead of number of seconds
+
 == 0.1.0 2008-08-26
 
 * 1 enhancement:

data/bin/punch

@@ -18,9 +18,7 @@ MANDATORY_OPTIONS = %w[]
 
 parser = OptionParser.new do |opts|
   opts.banner = <<BANNER
-This application is wonderful because...
-
-Usage: #{File.basename($0)} [options]
+Usage: #{File.basename($0)} [command] <project>
 
 Options are:
 BANNER
@@ -50,30 +48,57 @@ end
 project = ARGV[1]
 
 Punch.load
-case command
-when 'status'
-  puts Punch.status(project).inspect
-when 'total'
-  puts Punch.total(project, OPTIONS).inspect
-when 'in', 'delete'
-  if project
-    Punch.write if result = Punch.send(command, project)
-    puts result.inspect
-  else
-    puts "Project required"
-  end
-when 'out'
-  Punch.write if result = Punch.out(project)
-  puts result.inspect
-when 'log'
-  if project
-    if message = ARGV[2]
-      Punch.write if result = Punch.log(project, message)
+
+commands = {
+  'status' => lambda { |project|  puts Punch.status(project).inspect },
+  'total'  => lambda { |project|  puts Punch.total(project, OPTIONS.merge(:format => true)).inspect },
+  'in'     => lambda do |project|
+    if project
+      if Punch.in(project)
+        Punch.write
+      else
+        puts "Already punched in to '#{project}'"
+      end
+    else
+      puts "Project required"
+    end
+  end,
+  'delete' => lambda do |project|
+    if project
+      Punch.write if result = Punch.delete(project)
       puts result.inspect
     else
-      puts "Message required"
+      puts "Project required"
+    end
+  end,
+  'out' => lambda do |project|
+    if Punch.out(project)
+      Punch.write
+    else
+      message = 'Already punched out of '
+      message += project ? "'#{project}'" : 'all projects'
+      puts message
+    end
+  end,
+  'log' => lambda do |project|
+    if project
+      if message = ARGV[2]
+        if Punch.log(project, message)
+          Punch.write
+        else
+          puts "Not punched in to '#{project}'"
+        end
+      else
+        puts "Message required"
+      end
+    else
+      puts "Project required"
     end
-  else
-    puts "Project required"
   end
+}
+
+if command_code = commands[command]
+  command_code.call(project)
+else
+  puts "Command '#{command}' unknown"
 end

data/lib/punch.rb

@@ -2,6 +2,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'yaml'
+require 'punch/core_ext'
 
 module Punch
   class << self
@@ -83,12 +84,13 @@ module Punch
     end
     
     def total(*args)
+      options = args.last.is_a?(Hash) ? args.last : {}
       list_data = list(*args)
       if list_data.is_a?(Hash)
-        list_data.inject({}) { |hash, (project, project_data)|  hash.merge(project => do_total_time(project_data)) }
+        list_data.inject({}) { |hash, (project, project_data)|  hash.merge(project => do_total_time(project_data, options)) }
       else
         return nil unless list_data
-        do_total_time(list_data)
+        do_total_time(list_data, options)
       end
     end
     
@@ -117,8 +119,10 @@ module Punch
       project_data
     end
     
-    def do_total_time(list_data)
-      list_data.collect { |t|  ((t['out'] || Time.now) - t['in']).to_i }.inject(0) { |sum, t|  sum + t }
+    def do_total_time(list_data, options)
+      total = list_data.collect { |t|  ((t['out'] || Time.now) - t['in']).to_i }.inject(0) { |sum, t|  sum + t }
+      return total unless options[:format]
+      total.elapsed_time
     end
   end
 end

data/lib/punch/version.rb

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

data/spec/punch_command_spec.rb

@@ -14,11 +14,15 @@ describe 'punch command' do
       Object.send(:remove_const, const) if Object.const_defined?(const)
     end
     
-    self.stubs(:puts)
+    @states = {}
+    %w[puts load write].each do |state|
+      @states[state] = states(state).starts_as('setup')
+    end
+    
+    self.stubs(:puts).when(@states['puts'].is('setup'))
+    Punch.stubs(:load).when(@states['load'].is('setup'))
+    Punch.stubs(:write).when(@states['write'].is('setup'))
     
-    Punch.stubs(:load)
-    @test = states('test').starts_as('setup')
-    Punch.stubs(:write).when(@test.is('setup'))
     @project = 'myproj'
   end
   
@@ -59,8 +63,8 @@ describe 'punch command' do
     end
     
     it 'should not write the data' do
-      @test.become('test')
-      Punch.expects(:write).never.when(@test.is('test'))
+      @states['write'].become('test')
+      Punch.expects(:write).never.when(@states['write'].is('test'))
       run_command('total')
     end
     
@@ -92,10 +96,16 @@ describe 'punch command' do
         Punch.expects(:total).with(nil, has_entry(:before => time))
         run_command('total', '--before', time_option)
       end
+      
+      it 'should also pass the formatting option' do
+        time_option = '2008-08-26 09:47'
+        Punch.expects(:total).with(@project, has_entry(:format => true))
+        run_command('total', @project, '--before', time_option)
+      end
     end
     
-    it 'should pass no options if none specified' do
-      Punch.expects(:total).with(@project, {})
+    it 'should pass only the formatting option if no options specified' do
+      Punch.expects(:total).with(@project, {:format => true})
       run_command('total', @project)
     end
   end
@@ -128,15 +138,16 @@ describe 'punch command' do
     end
     
     it 'should not write the data' do
-      @test.become('test')
-      Punch.expects(:write).never.when(@test.is('test'))
+      @states['write'].become('test')
+      Punch.expects(:write).never.when(@states['write'].is('test'))
       run_command('status')
     end
   end
   
   describe "when the command is 'in'" do
     before :each do
-      Punch.stubs(:in).when(@test.is('setup'))
+      @states['in'] = states('in').starts_as('setup')
+      Punch.stubs(:in).when(@states['write'].is('setup'))
     end
     
     it 'should load punch data' do
@@ -145,33 +156,40 @@ describe 'punch command' do
     end
     
     it 'should punch in to the given project' do
-      @test.become('test')
-      Punch.stubs(:write)
-      Punch.expects(:in).with(@project).when(@test.is('test'))
-      run_command('in', @project)
-    end
-    
-    it 'should output the result' do
-      result = 'result'
-      Punch.stubs(:in).returns(result)
-      self.expects(:puts).with(result.inspect)
+      Punch.expects(:in).with(@project)
       run_command('in', @project)
     end
     
     describe 'when punched in successfully' do
-      it 'should write the data' do
-        @test.become('test')
+      before :each do
         Punch.stubs(:in).returns(true)
-        Punch.expects(:write).when(@test.is('test'))
+      end
+      
+      it 'should write the data' do
+        Punch.expects(:write)
+        run_command('in', @project)
+      end
+      
+      it 'should not print anything' do
+        @states['puts'].become('test')
+        self.expects(:puts).never.when(@states['puts'].is('test'))
         run_command('in', @project)
       end
     end
     
     describe 'when not punched in successfully' do
-      it 'should not write the data' do
-        @test.become('test')
+      before :each do
         Punch.stubs(:in).returns(false)
-        Punch.expects(:write).never.when(@test.is('test'))
+      end
+      
+      it 'should not write the data' do
+        @states['write'].become('test')
+        Punch.expects(:write).never.when(@states['write'].is('test'))
+        run_command('in', @project)
+      end
+      
+      it 'should print a message' do
+        self.expects(:puts).with(regexp_matches(/already.+in/i))
         run_command('in', @project)
       end
     end
@@ -183,15 +201,15 @@ describe 'punch command' do
       end
       
       it 'should not punch in' do
-        @test.become('test')
+        @states['in'].become('test')
         Punch.stubs(:write)
-        Punch.expects(:in).never.when(@test.is('test'))
+        Punch.expects(:in).never.when(@states['in'].is('test'))
         run_command('in')
       end
       
       it 'should not write the data' do
-        @test.become('test')
-        Punch.expects(:write).never.when(@test.is('test'))
+        @states['write'].become('test')
+        Punch.expects(:write).never.when(@states['write'].is('test'))
         run_command('in')
       end
     end
@@ -217,35 +235,60 @@ describe 'punch command' do
       run_command('out')
     end
     
-    it 'should output the result' do
-      result = 'result'
-      Punch.stubs(:out).returns(result)
-      self.expects(:puts).with(result.inspect)
-      run_command('out', @project)
-    end
-    
     describe 'when punched out successfully' do
-      it 'should write the data' do
-        @test.become('test')
+      before :each do
         Punch.stubs(:out).returns(true)
-        Punch.expects(:write).when(@test.is('test'))
+      end
+      
+      it 'should write the data' do
+        Punch.expects(:write)
         run_command('out', @project)
       end
+      
+      it 'should not print anything' do
+        @states['puts'].become('test')
+        self.expects(:puts).never.when(@states['puts'].is('test'))
+        run_command('out', @project)
+      end
+      
+      describe 'and no project given' do
+        it 'should not print anything' do
+          @states['puts'].become('test')
+          self.expects(:puts).never.when(@states['puts'].is('test'))
+          run_command('out')
+        end
+      end
     end
     
     describe 'when not punched out successfully' do
-      it 'should not write the data' do
-        @test.become('test')
+      before :each do
         Punch.stubs(:out).returns(false)
-        Punch.expects(:write).never.when(@test.is('test'))
+      end
+      
+      it 'should not write the data' do
+        @states['write'].become('test')
+        Punch.expects(:write).never.when(@states['write'].is('test'))
         run_command('out', @project)
       end
+      
+      it 'should print a message' do
+        self.expects(:puts).with(regexp_matches(/already.+out/i))
+        run_command('out', @project)
+      end
+      
+      describe 'and no project given' do
+        it 'should print a message' do
+          self.expects(:puts).with(regexp_matches(/already.+out/i))
+          run_command('out')
+        end
+      end
     end
   end
   
   describe "when the command is 'delete'" do
     before :each do
-      Punch.stubs(:delete).when(@test.is('setup'))
+      @states['delete'] = states('delete').starts_as('setup')
+      Punch.stubs(:delete).when(@states['write'].is('setup'))
     end
     
     it 'should load punch data' do
@@ -254,9 +297,8 @@ describe 'punch command' do
     end
     
     it 'should delete the given project' do
-      @test.become('test')
       Punch.stubs(:write)
-      Punch.expects(:delete).with(@project).when(@test.is('test'))
+      Punch.expects(:delete).with(@project)
       run_command('delete', @project)
     end
     
@@ -269,18 +311,17 @@ describe 'punch command' do
     
     describe 'when deleted successfully' do
       it 'should write the data' do
-        @test.become('test')
         Punch.stubs(:delete).returns(true)
-        Punch.expects(:write).when(@test.is('test'))
+        Punch.expects(:write)
         run_command('delete', @project)
       end
     end
     
     describe 'when not deleted successfully' do
       it 'should not write the data' do
-        @test.become('test')
+        @states['write'].become('test')
         Punch.stubs(:delete).returns(nil)
-        Punch.expects(:write).never.when(@test.is('test'))
+        Punch.expects(:write).never.when(@states['write'].is('test'))
         run_command('delete', @project)
       end
     end
@@ -292,15 +333,15 @@ describe 'punch command' do
       end
       
       it 'should not delete' do
-        @test.become('test')
+        @states['delete'].become('test')
         Punch.stubs(:write)
-        Punch.expects(:delete).never.when(@test.is('test'))
+        Punch.expects(:delete).never.when(@states['delete'].is('test'))
         run_command('delete')
       end
       
       it 'should not write the data' do
-        @test.become('test')
-        Punch.expects(:write).never.when(@test.is('test'))
+        @states['write'].become('test')
+        Punch.expects(:write).never.when(@states['write'].is('test'))
         run_command('delete')
       end
     end
@@ -308,7 +349,8 @@ describe 'punch command' do
   
   describe "when the command is 'log'" do
     before :each do
-      Punch.stubs(:log).when(@test.is('setup'))
+      @states['log'] = states('log').starts_as('setup')
+      Punch.stubs(:log).when(@states['log'].is('setup'))
       @message = 'log message'
     end
     
@@ -318,33 +360,41 @@ describe 'punch command' do
     end
     
     it 'should log a message for the given project' do
-      @test.become('test')
       Punch.stubs(:write)
-      Punch.expects(:log).with(@project, @message).when(@test.is('test'))
-      run_command('log', @project, @message)
-    end
-        
-    it 'should output the result' do
-      result = 'result'
-      Punch.stubs(:log).returns(result)
-      self.expects(:puts).with(result.inspect)
+      Punch.expects(:log).with(@project, @message)
       run_command('log', @project, @message)
     end
     
     describe 'when logged successfully' do
-      it 'should write the data' do
-        @test.become('test')
+      before :each do
         Punch.stubs(:log).returns(true)
-        Punch.expects(:write).when(@test.is('test'))
+      end
+      
+      it 'should write the data' do
+        Punch.expects(:write)
+        run_command('log', @project, @message)
+      end
+      
+      it 'should not print anything' do
+        @states['puts'].become('test')
+        self.expects(:puts).never.when(@states['write'].is('test'))
         run_command('log', @project, @message)
       end
     end
     
     describe 'when not deleted successfully' do
-      it 'should not write the data' do
-        @test.become('test')
+      before :each do
         Punch.stubs(:log).returns(false)
-        Punch.expects(:write).never.when(@test.is('test'))
+      end
+      
+      it 'should not write the data' do
+        @states['write'].become('test')
+        Punch.expects(:write).never.when(@states['write'].is('test'))
+        run_command('log', @project, @message)
+      end
+      
+      it 'should print a message' do
+        self.expects(:puts).with(regexp_matches(/not.+in/i))
         run_command('log', @project, @message)
       end
     end
@@ -356,15 +406,15 @@ describe 'punch command' do
       end
       
       it 'should not log' do
-        @test.become('test')
+        @states['log'].become('test')
         Punch.stubs(:write)
-        Punch.expects(:log).never.when(@test.is('test'))
+        Punch.expects(:log).never.when(@states['log'].is('test'))
         run_command('log')
       end
       
       it 'should not write the data' do
-        @test.become('test')
-        Punch.expects(:write).never.when(@test.is('test'))
+        @states['write'].become('test')
+        Punch.expects(:write).never.when(@states['write'].is('test'))
         run_command('log')
       end
     end
@@ -376,17 +426,41 @@ describe 'punch command' do
       end
       
       it 'should not log' do
-        @test.become('test')
+        @states['log'].become('test')
         Punch.stubs(:write)
-        Punch.expects(:log).never.when(@test.is('test'))
+        Punch.expects(:log).never.when(@states['log'].is('test'))
         run_command('log', @project)
       end
       
       it 'should not write the data' do
-        @test.become('test')
-        Punch.expects(:write).never.when(@test.is('test'))
+        @states['write'].become('test')
+        Punch.expects(:write).never.when(@states['write'].is('test'))
         run_command('log', @project)
       end
     end
   end
+  
+  describe 'when the command is unknown' do
+    it 'should not error' do
+      lambda { run_command('bunk') }.should_not raise_error
+    end
+    
+    it 'should print a message' do
+      self.expects(:puts).with(regexp_matches(/command.+unknown/i))
+      run_command('bunk')
+    end
+    
+    it 'should not write the data' do
+      @states['write'].become('test')
+      Punch.expects(:write).never.when(@states['write'].is('test'))
+      run_command('bunk')
+    end
+    
+    it 'should not run any punch command' do
+      [:in, :out, :delete, :status, :total, :log].each do |command|
+        Punch.expects(command).never
+      end
+      run_command('bunk')
+    end
+  end
 end

data/spec/punch_spec.rb

@@ -375,9 +375,6 @@ describe Punch do
         end
       end
       Punch.data = @data
-      
-      @test = states('test').starts_as('setup')
-      Punch.stubs(:write).when(@test.is('setup'))
     end
     
     it 'should accept a project name' do
@@ -496,9 +493,6 @@ describe Punch do
         end
       end
       Punch.data = @data
-      
-      @test = states('test').starts_as('setup')
-      Punch.stubs(:write).when(@test.is('setup'))
     end
     
     it 'should accept a project name' do
@@ -668,6 +662,10 @@ describe Punch do
         Punch.total(@project, :after => @now - 2001, :before => @now - 999).should == 1000
       end
       
+      it 'should format the time spent if passed a format option' do
+        Punch.total(@project, :format => true).should == "1:05:00"
+      end
+      
       describe 'and is punched in' do
         before :each do
           @data[@project].push({ 'in' => @now - 25 })
@@ -708,6 +706,10 @@ describe Punch do
       it 'should respect options' do
         Punch.total(:after => @now - 51).should == { @projects[0] => 25, @projects[1] => 20, @projects[2] => 15}
       end
+      
+      it 'should format the time spent if passed a format option' do
+        Punch.total(:format => true).should == { @projects[0] => "00:25", @projects[1] => "01:10", @projects[2] => "00:15"}
+      end
     end
   end
   

metadata

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