one_inch_punch 0.4.2 → 0.5.0

data/History.txt

@@ -1,3 +1,11 @@
+== 0.5.0 2010-11-18
+
+* 1 minor enhancement:
+  * added 'age' command
+    * moves project data to an old-version name, e.g. project -> project_old/1
+    * cascades old-version project data, e.g. project -> project_old/1, project_old/1 -> project_old/2
+    * can take a :before option to only move a subset of data
+
 == 0.4.2 2010-08-16
 
 * 1 tiny enhancement:
@@ -6,13 +14,13 @@
     * option can be given on command-line with --on
     * :before and :after can also take dates now, converting them to times
 
-== 0.4.1 2008-08-26
+== 0.4.1 2009-08-26
 
 * 1 tiny enhancement:
   * allowing command-line log message to be specified with --message
     (will take precedence over normal message argument if both are specified)
 
-== 0.4.0 2008-08-17
+== 0.4.0 2009-08-17
 
 * 1 minor enhancement:
   * added 'summary' command
@@ -23,24 +31,24 @@
 * 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
+== 0.3.3 2009-06-25
 
 * 1 tiny enhancement:
   * added 'short' status, which only displays what's currently punched in (or 'out' if nothing)
     * punch command displays status as YAML if it's a hash, like it does for total
 
-== 0.3.2 2008-06-01
+== 0.3.2 2009-06-01
 
 * 1 tiny bugfix enhancement:
   * sub-projects now truly restricting to the naming form of 'parent/child',
     not 'parent_child' or even simply 'parentseriouslythisisnotachild'
 
-== 0.3.1 2008-04-06
+== 0.3.1 2009-04-06
 
 * 1 tiny bugfix enhancement:
   * Total no longer erroring on non-existent parent project
 
-== 0.3.0 2008-04-05
+== 0.3.0 2009-04-05
 
 * 1 minor enhancement:
   * Can now have 'sub-projects', or projects with names of the form 'parent/child'

data/bin/punch

@@ -126,6 +126,14 @@ commands = {
     else
       puts "Project required"
     end
+  end,
+  'age' => lambda do |project|
+    if project
+      Punch.write if result = Punch.age(project, OPTIONS)
+      puts result.inspect
+    else
+      puts "Project required"
+    end
   end
 }
 

data/lib/punch.rb

@@ -158,21 +158,22 @@ class Punch
       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
+        if (time_data['log'] || []).empty?
           summary['unspecified'] += ((time_data['out'] || Time.now) - time_data['in']).to_i
+          next
+        end
+        
+        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
       end
       
@@ -181,6 +182,27 @@ class Punch
       summary
     end
     
+    def age(project, options = {})
+      raise ":after option makes no sense for aging" if options[:after]
+      return nil unless projects.include?(project)
+      
+      if project.match(%r{_old/\d+$})
+        aged_project = project.succ
+      else
+        aged_project = "#{project}_old/1"
+      end
+      
+      age(aged_project)
+      if options[:before]
+        data[aged_project], data[project] = data[project].partition { |d|  d['out'] < options[:before] }
+        [project, aged_project].each { |proj|  data.delete(proj) if data[proj].empty? }
+      else
+        data[aged_project] = data.delete(project)
+      end
+      
+      true
+    end
+    
     
     private
     

data/lib/punch/instance.rb

@@ -41,6 +41,10 @@ class Punch
     self.class.summary(project, options)
   end
   
+  def age(options = {})
+    self.class.age(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 = 4
-    TINY  = 2
+    MINOR = 5
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/punch_command_spec.rb

@@ -853,6 +853,90 @@ describe 'punch command' do
     end
   end
   
+  describe "when the command is 'age'" do
+    before do
+      Punch.stub!(:age)
+    end
+    
+    it 'should load punch data' do
+      Punch.should.receive(:load)
+      run_command('age', @project)
+    end
+    
+    it 'should age the given project' do
+      Punch.stub!(:write)
+      Punch.should.receive(:age) do |proj, _|
+        proj.should == @project
+      end
+      run_command('age', @project)
+    end
+    
+    describe 'when options specified' do
+      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(:age) do |proj, options|
+          proj.should == @project
+          options[:before].should == time
+        end
+        run_command('age', @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(:age) do |proj, options|
+          proj.should == @project
+          options[:before].should == time
+        end
+        run_command('age', @project, '--before', time_option)
+      end
+    end
+    
+    it 'should output the result' do
+      result = 'result'
+      Punch.stub!(:age).and_return(result)
+      self.should.receive(:puts).with(result.inspect)
+      run_command('age', @project)
+    end
+    
+    describe 'when aged successfully' do
+      it 'should write the data' do
+        Punch.stub!(:age).and_return(true)
+        Punch.should.receive(:write)
+        run_command('age', @project)
+      end
+    end
+    
+    describe 'when not aged successfully' do
+      it 'should not write the data' do
+        Punch.stub!(:age).and_return(nil)
+        Punch.should.receive(:write).never
+        run_command('age', @project)
+      end
+    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('age')
+      end
+      
+      it 'should not age' do
+        Punch.stub!(:write)
+        Punch.should.receive(:age).never
+        run_command('age')
+      end
+      
+      it 'should not write the data' do
+        Punch.should.receive(:write).never
+        run_command('age')
+      end
+    end
+  end
+  
   describe 'when the command is unknown' do
     it 'should not error' do
       lambda { run_command('bunk') }.should.not.raise
@@ -871,7 +955,7 @@ describe 'punch command' do
     end
     
     it 'should not run any punch command' do
-      [:in, :out, :delete, :status, :total, :log, :list, :summary].each do |command|
+      [:in, :out, :delete, :status, :total, :log, :list, :summary, :age].each do |command|
         Punch.should.receive(command).never
       end
       run_command('bunk')

data/spec/punch_instance_spec.rb

@@ -432,6 +432,56 @@ describe Punch, 'instance' do
     end
   end
   
+  it 'should age the project' do
+    @punch.should.respond_to(:age)
+  end
+  
+  describe 'aging project' do
+    before do
+      @age = 'age val'
+      Punch.stub!(:age).and_return(@age)
+    end
+    
+    it 'should accept options' do
+      lambda { @punch.age(:before => Time.now) }.should.not.raise(ArgumentError)
+    end
+    
+    it 'should not require options' do
+      lambda { @punch.age }.should.not.raise(ArgumentError)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.should.receive(:age)
+      @punch.age
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.should.receive(:age) do |proj, _|
+        proj.should == @project
+      end
+      @punch.age
+    end
+    
+    it 'should pass the options when delegating to the class' do
+      options = { :before => Time.now }
+      Punch.should.receive(:age) do |_, opts|
+        opts.should == options
+      end
+      @punch.age(options)
+    end
+    
+    it 'should pass an empty hash if no options given' do
+      Punch.should.receive(:age) do |_, opts|
+        opts.should == {}
+      end
+      @punch.age
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.age.should == @age
+    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

@@ -1576,10 +1576,6 @@ describe Punch do
   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
@@ -1766,4 +1762,105 @@ describe Punch do
       end
     end
   end
+  
+  it 'should age a project' do
+    Punch.should.respond_to(:age)
+  end
+  
+  describe 'aging a project' do
+    before do
+      @now = Time.now
+      Time.stub!(:now).and_return(@now)
+      @project = 'pro-ject'
+      @data = { @project => [ {'in' => @now - 3000} ] }
+      
+      Punch.instance_eval do
+        class << self
+          public :data, :data=
+        end
+      end
+      Punch.data = @data
+    end
+    
+    it 'should accept a project name' do
+      lambda { Punch.age('proj') }.should.not.raise(ArgumentError)
+    end
+    
+    it 'should require a project name' do
+      lambda { Punch.age }.should.raise(ArgumentError)
+    end
+    
+    it 'should accept options' do
+      lambda { Punch.age('proj', :before => @now - 5000) }.should.not.raise(ArgumentError)
+    end
+    
+    describe 'when the project exists' do
+      it 'should move the project to #{project}_old/1' do
+        Punch.age(@project)
+        Punch.data.should == { "#{@project}_old/1" => [ {'in' => @now - 3000} ] }
+      end
+      
+      it 'should simply increment the number of a project name in the x_old/1 format' do
+        @data = { 'some_old/1' => [ {'in' => @now - 3900} ] }
+        Punch.data = @data
+        
+        Punch.age('some_old/1')
+        Punch.data.should == { "some_old/2" => [ {'in' => @now - 3900} ] }
+      end
+      
+      it 'should cascade aging a project to older versions' do
+        @data["#{@project}_old/1"] = [ {'in' => @now - 50000, 'out' => @now - 40000} ]
+        @data["#{@project}_old/2"] = [ {'in' => @now - 90000, 'out' => @now - 85000} ]
+        Punch.data = @data
+        
+        Punch.age(@project)
+        Punch.data.should == { "#{@project}_old/1" => [ {'in' => @now - 3000} ], "#{@project}_old/2" => [ {'in' => @now - 50000, 'out' => @now - 40000} ], "#{@project}_old/3" => [ {'in' => @now - 90000, 'out' => @now - 85000} ] }
+      end
+      
+      it 'should return true' do
+        Punch.age(@project).should == true
+      end
+      
+      describe 'when options given' do
+        before do
+          @data = { @project => [ {'in' => @now - 5000, 'out' => @now - 4000}, {'in' => @now - 3500, 'out' => @now - 3000}, {'in' => @now - 1500, 'out' => @now - 900}, {'in' => @now - 500, 'out' => @now - 400} ] }
+          Punch.data = @data
+        end
+        
+        it 'should only move the appropriate data to the old-version project' do
+          expected = {   @project         => [ {'in' => @now - 1500, 'out' => @now - 900},  {'in' => @now - 500,  'out' => @now - 400} ],
+                      "#{@project}_old/1" => [ {'in' => @now - 5000, 'out' => @now - 4000}, {'in' => @now - 3500, 'out' => @now - 3000} ]
+                     }
+          Punch.age(@project, :before => @now - 1500)
+          Punch.data.should == expected
+        end
+        
+        it 'should not create an old project if no data would be moved' do
+          expected = { @project => [ {'in' => @now - 5000, 'out' => @now - 4000}, {'in' => @now - 3500, 'out' => @now - 3000}, {'in' => @now - 1500, 'out' => @now - 900}, {'in' => @now - 500, 'out' => @now - 400} ] }
+          Punch.age(@project, :before => @now - 50000)
+          Punch.data.should == expected
+        end
+        
+        it 'should remove the project if all data would be moved' do
+          expected = { "#{@project}_old/1" => [ {'in' => @now - 5000, 'out' => @now - 4000}, {'in' => @now - 3500, 'out' => @now - 3000}, {'in' => @now - 1500, 'out' => @now - 900}, {'in' => @now - 500, 'out' => @now - 400} ] }
+          Punch.age(@project, :before => @now - 10)
+          Punch.data.should == expected
+        end
+        
+        it 'should not accept an after option' do
+          lambda { Punch.age(@project, :after => @now - 500) }.should.raise
+        end
+      end
+    end
+    
+    describe 'when the project does not exist' do
+      before do
+        @project = 'no dice'
+      end
+      
+      it 'should return nil' do
+        Punch.age(@project).should.be.nil
+      end
+    end
+  end
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-16 00:00:00 -05:00
+date: 2010-11-18 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,12 +74,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 19
         segments: 
         - 2
         - 6
-        - 1
-        version: 2.6.1
+        - 2
+        version: 2.6.2
   type: :development
   version_requirements: *id004
 description: a simple time-tracking tool