one_inch_punch 0.2.4 → 0.3.0

data/History.txt

@@ -1,3 +1,12 @@
+== 0.3.0 2008-04-05
+
+* 1 minor enhancement:
+  * Can now have 'sub-projects', or projects with names of the form 'parent/child'
+    * A parent will be checked in if a child is checked in
+    * Punching out of a parent project will punch the real checked-in project out
+    * Listing time and getting totals for a parent project will include child time
+  * Some small convenience methods probably nobody cares about, so they aren't included in the total number of enchancements above
+
 == 0.2.4 2008-12-17
 
 * 1 tiny enhancement:

data/README.txt

@@ -12,13 +12,8 @@ One-inch punch: Smaller, more effective
 == FEATURES/PROBLEMS:
 
 * Can load and write .punch.yml data compatibly with Ara's punch gem
-* Can punch in and out of projects (including creating a project by punching in)
-* Can query project status
-* Can delete a project
-* Can list project data
-* Can give total time for a project
-* Can be used command-line
-* Command-line output is less ugly
+* Things you may expect from a time-tracking program, like punching in and out and getting time data
+* The ability to be punched in to multiple projects at once, because double-billing is awesome
 * More, since this is unfinished
 
 == SYNOPSIS:

data/bin/punch

@@ -66,10 +66,10 @@ commands = {
   end,
   'total'  => lambda do |project|
     result = Punch.total(project, OPTIONS.merge(:format => true))
-    if project
-      puts result.inspect
-    else
+    if result.is_a?(Hash)
       puts result.to_yaml
+    else
+      puts result.inspect
     end
   end,
   'in'     => lambda do |project|

data/lib/punch.rb

@@ -45,14 +45,19 @@ class Punch
         project = nil
       end
       
-      return data.keys.inject({}) { |hash, project|  hash.merge(project => status(project, options)) } unless project
+      return projects.inject({}) { |hash, project|  hash.merge(project => status(project, options)) } unless project
       
       project_data = data[project]
-      return nil if !project_data or project_data.empty?
+      time_data = (project_data || []).last
+      
+      if time_data
+        status = time_data['out'] ? 'out' : 'in'
+      end
+      
+      status, time_data = check_child_status(project, status, time_data)
       
-      time_data = project_data.last
-      status = time_data['out'] ? 'out' : 'in'
       return status unless options[:full]
+      return status if status.nil?
       
       { :status => status, :time => time_data[status] }
     end
@@ -81,7 +86,7 @@ class Punch
       if project
         return false unless do_out_single(project, options)
       else
-        return false unless data.keys.collect { |project|  do_out_single(project, options) }.any?
+        return false unless projects.collect { |project|  do_out_single(project, options) }.any?
       end
       true
     end
@@ -94,10 +99,17 @@ class Punch
     def list(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
       project = args.first
+      
       if project
-        do_list_single(project, options)
+        list_projects = child_projects(project) + [project]
       else
-        data.keys.inject({}) { |hash, project|  hash.merge(project => do_list_single(project, options)) }
+        list_projects = projects
+      end
+      
+      if list_projects.length == 1
+        do_list_single(list_projects.first, options)
+      else
+        list_projects.inject({}) { |hash, project|  hash.merge(project => do_list_single(project, options)) }
       end
     end
     
@@ -127,6 +139,7 @@ class Punch
     
     def do_out_single(project, options)
       return false if out?(project)
+      project = in_child(project) || project
       time = time_from_options(options)
       log(project, options[:message], :time => time) if options[:message]
       log(project, 'punch out', :time => time)
@@ -149,5 +162,29 @@ class Punch
     def time_from_options(options)
       options[:time] || options[:at] || Time.now
     end
+    
+    def projects
+      data.keys
+    end
+    
+    def child_projects(project)
+      projects.select { |proj|  proj.match(/^#{Regexp.escape(project)}/) } - [project]
+    end
+    
+    def in_child(project)
+      child_projects(project).detect { |proj|  status(proj) == 'in' }
+    end
+    
+    def check_child_status(project, status, time_data)
+      if status != 'in'
+        in_child = in_child(project)
+        if in_child
+          status = 'in'
+          time_data = data[in_child].last
+        end
+      end
+      
+      return status, time_data
+    end
   end
 end

data/lib/punch/instance.rb

@@ -36,4 +36,13 @@ class Punch
   def log(message, options = {})
     self.class.log(project, message, options)
   end
+  
+  def ==(other)
+    project == other.project
+  end
+  
+  def child_projects
+    Punch.send(:child_projects, project).collect { |proj|  Punch.new(proj) }
+  end
+  alias_method :children, :child_projects
 end

data/lib/punch/version.rb

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

data/spec/punch_command_spec.rb

@@ -64,11 +64,11 @@ describe 'punch command' do
       run_command('total', @project)
     end
     
-    it 'should output the total as YAML if no project given' do
-      result = 'total data'
+    it 'should output the total as YAML if the total data is a Hash' do
+      result = { :some_project => 'total data', :some_other_project => 'other total data' }
       Punch.stub!(:total).and_return(result)
       self.should.receive(:puts).with(result.to_yaml)
-      run_command('total')
+      run_command('total', @project)
     end
     
     it 'should not write the data' do
@@ -187,7 +187,7 @@ describe 'punch command' do
       run_command('status', @project, '--full')
     end
     
-    it 'should output the status as YAML if not project given even if a full option is given' do
+    it 'should output the status as YAML if no project given even if a full option is given' do
       result = 'status data'
       Punch.stub!(:status).and_return(result)
       self.should.receive(:puts).with(result.to_yaml)

data/spec/punch_instance_spec.rb

@@ -381,4 +381,52 @@ describe Punch, 'instance' do
       @punch.log(@message).should == @log
     end
   end
+  
+  describe 'equality' do
+    it 'should be equal to another instance for the same project' do
+      Punch.new('proj').should == Punch.new('proj')
+    end
+    
+    it 'should not be equal to an instance for a different project' do
+      Punch.new('proj').should.not == Punch.new('other')
+    end
+  end
+  
+  it 'should return child projects' do
+    @punch.should.respond_to(:child_projects)
+  end
+  
+  describe 'returning child projects' do
+    before do
+      Punch.instance_eval do
+        class << self
+          public :data, :data=
+        end
+      end
+      
+      @projects = {}
+      @projects['parent'] = 'daddy'
+      @projects['child']  = @projects['parent'] + '/sugar'
+      @projects['kid']    = @projects['parent'] + '/object'
+      
+      @data = { @projects['parent'] => [], @projects['child'] => [], @projects['kid'] => [] }
+      Punch.data = @data
+    end
+    
+    it 'should return instances for each child project' do
+      children = Punch.new(@projects['parent']).child_projects
+      expected = [Punch.new(@projects['child']), Punch.new(@projects['kid'])]
+      children.sort_by { |c|  c.project }.should == expected.sort_by { |e|  e.project }
+    end
+    
+    it "should provide 'children' as an alias" do
+      children = Punch.new(@projects['parent']).children
+      expected = [Punch.new(@projects['child']), Punch.new(@projects['kid'])]
+      children.sort_by { |c|  c.project }.should == expected.sort_by { |e|  e.project }
+    end
+    
+    it 'should return an empty array if the project has no child projects' do
+      @punch.child_projects.should == []
+    end
+  end
 end

data/spec/punch_spec.rb

@@ -242,6 +242,115 @@ describe Punch do
         }
       end
     end
+    
+    describe 'handling a sub-project' do
+      before do
+        @projects['parent'] = 'daddy'
+        @projects['child'] = @projects['parent'] + '/sugar'
+      end
+      
+      it "should return 'in' for a non-existent parent project if the sub-project is punched in" do
+        @data[@projects['child']] = [ { 'in' => @now } ]
+        Punch.data = @data
+        Punch.status(@projects['parent']).should == 'in'
+      end
+      
+      it "should return 'in' for an empty parent project if the sub-project is punched in" do
+        @data[@projects['parent']] = []
+        @data[@projects['child']] = [ { 'in' => @now } ]
+        Punch.data = @data
+        Punch.status(@projects['parent']).should == 'in'
+      end
+      
+      it "should return 'in' for a punched-out parent project if the sub-project is punched in" do
+        @data[@projects['parent']] = [ { 'in' => @now - 13, 'out' => @now - 5 } ]
+        @data[@projects['child']] = [ { 'in' => @now } ]
+        Punch.data = @data
+        Punch.status(@projects['parent']).should == 'in'
+      end
+      
+      it "should use the sub-project's punch-in time for the parent project when returning full status" do
+        @data[@projects['child']] = [ { 'in' => @now } ]
+        Punch.data = @data
+        Punch.status(@projects['parent'], :full => true).should == { :status => 'in', :time => @now }
+        
+        @data[@projects['parent']] = []
+        Punch.data = @data
+        Punch.status(@projects['parent'], :full => true).should == { :status => 'in', :time => @now }
+        
+        @data[@projects['parent']] = [ { 'in' => @now - 13, 'out' => @now - 5 } ]
+        Punch.data = @data
+        Punch.status(@projects['parent'], :full => true).should == { :status => 'in', :time => @now }
+      end
+      
+      it "should return nil for a non-existent parent project if the sub-project does not exist" do
+        Punch.status(@projects['parent']).should.be.nil
+      end
+      
+      it "should return nil for an empty parent project if the sub-project does not exist" do
+        @data[@projects['parent']] = []
+        Punch.data = @data
+        Punch.status(@projects['parent']).should.be.nil
+      end
+      
+      it "should return nil for a non-existent parent project if the sub-project is empty" do
+        @data[@projects['child']] = []
+        Punch.data = @data
+        Punch.status(@projects['parent']).should.be.nil
+      end
+      
+      it "should return nil for an empty parent project if the sub-project is empty" do
+        @data[@projects['parent']] = []
+        @data[@projects['child']] = []
+        Punch.data = @data
+        Punch.status(@projects['parent']).should.be.nil
+      end
+      
+      it "should return nil for the parent project when returning full status" do
+        Punch.status(@projects['parent'], :full => true).should.be.nil
+        
+        @data[@projects['parent']] = []
+        Punch.data = @data
+        Punch.status(@projects['parent'], :full => true).should.be.nil
+        
+        @data.delete(@projects['parent'])
+        @data[@projects['child']] = []
+        Punch.data = @data
+        Punch.status(@projects['parent'], :full => true).should.be.nil
+        
+        @data[@projects['parent']] = []
+        @data[@projects['child']] = []
+        Punch.data = @data
+        Punch.status(@projects['parent'], :full => true).should.be.nil
+      end
+      
+      it "should return 'out' for a punched-out parent project if the sub-project does not exist" do
+        @data[@projects['parent']] = [ { 'in' => @now - 13, 'out' => @now - 5 } ]
+        Punch.data = @data
+        Punch.status(@projects['parent']).should == 'out'
+      end
+      
+      it "should return 'out' for a punched-out parent project if the sub-project is empty" do
+        @data[@projects['parent']] = [ { 'in' => @now - 13, 'out' => @now - 5 } ]
+        @data[@projects['child']] = []
+        Punch.data = @data
+        Punch.status(@projects['parent']).should == 'out'
+      end
+      
+      it "should use the parent project's punch-out time for the parent project when returning full status" do
+        @data[@projects['parent']] = [ { 'in' => @now - 13, 'out' => @now - 5 } ]
+        Punch.data = @data
+        Punch.status(@projects['parent'], :full => true).should == { :status => 'out', :time => @now - 5 }
+        
+        @data[@projects['child']] = []
+        Punch.data = @data
+        Punch.status(@projects['parent'], :full => true).should == { :status => 'out', :time => @now - 5 }
+        
+        @data[@projects['child']] = [ { 'in' => @now - 4, 'out' => @now - 1 } ]
+        Punch.data = @data
+        Punch.status(@projects['parent'], :full => true).should == { :status => 'out', :time => @now - 5 }
+      end
+    end
   end
   
   it 'should indicate whether a project is punched out' do
@@ -674,6 +783,45 @@ describe Punch do
         end
       end
     end
+    
+    describe 'handling a sub-project' do
+      before do
+        @projects = {}
+        @projects['parent'] = 'daddy'
+        @projects['child'] = @projects['parent'] + '/sugar'
+      end
+      
+      it 'should actually punch out the sub-project when told to punch out the parent project' do
+        @data[@projects['parent']] = [ { 'in' => @now - 100, 'out' => @now - 50 } ]
+        @data[@projects['child']] = [ { 'in' => @now - 20 } ]
+        Punch.data = @data
+        Punch.out(@projects['parent'])
+        Punch.data[@projects['child']].last['out'].should == @now
+      end
+      
+      it 'should not change the punch-out time for the parent project' do
+        @data[@projects['parent']] = [ { 'in' => @now - 100, 'out' => @now - 50 } ]
+        @data[@projects['child']] = [ { 'in' => @now - 20 } ]
+        Punch.data = @data
+        Punch.out(@projects['parent'])
+        Punch.data[@projects['parent']].last['out'].should == @now - 50
+      end
+      
+      it 'should not add data for a non-existent parent project' do
+        @data[@projects['child']] = [ { 'in' => @now - 20 } ]
+        Punch.data = @data
+        Punch.out(@projects['parent'])
+        Punch.data[@projects['parent']].should.be.nil
+      end
+      
+      it 'should not add data for an empty parent project' do
+        @data[@projects['parent']] = []
+        @data[@projects['child']] = [ { 'in' => @now - 20 } ]
+        Punch.data = @data
+        Punch.out(@projects['parent'])
+        Punch.data[@projects['parent']].should == []
+      end
+    end
   end
 
   it 'should delete a project' do
@@ -830,6 +978,41 @@ describe Punch do
         Punch.data.should == old_data
       end
     end
+    
+    describe 'handling a sub-project' do
+      before do
+        @projects = {}
+        @projects['parent'] = 'daddy'
+        @projects['child'] = @projects['parent'] + '/sugar'
+        @data[@projects['parent']] = [ { 'in' => @now - 100, 'out' => @now - 50 } ]
+        @data[@projects['child']] = [ { 'in' => @now - 20 } ]
+        Punch.data = @data
+      end
+      
+      it 'should return data for the parent and sub-project' do
+        list_data = { @projects['parent'] => @data[@projects['parent']], @projects['child'] => @data[@projects['child']] }
+        Punch.list(@projects['parent']).should == list_data
+      end
+      
+      it 'should respect options' do
+        list_data = { @projects['parent'] => [], @projects['child'] => @data[@projects['child']] }
+        Punch.list(@projects['parent'], :after => @now - 21).should == list_data
+      end
+      
+      describe 'when do project is given' do
+        before do
+          @projects = ['test project', 'out project', 'other project']
+          @data[@projects[0]] = [ {'in' => @now - 50, 'out' => @now - 25} ]
+          @data[@projects[1]] = [ {'in' => @now - 300, 'out' => @now - 250}, {'in' => @now - 40, 'out' => @now - 20} ]
+          @data[@projects[2]] = [ {'in' => @now - 50, 'out' => @now - 35} ]
+          Punch.data = @data
+        end
+        
+        it 'should return data for all projects' do
+          Punch.list.should == @data
+        end
+      end
+    end
   end
 
   it 'should get the total time for a project' do
@@ -930,15 +1113,51 @@ describe Punch do
       end
       
       it 'should give totals for all projects' do
-        Punch.total.should == { @projects[0] => 25, @projects[1] => 70, @projects[2] => 15}
+        Punch.total.should == { @projects[0] => 25, @projects[1] => 70, @projects[2] => 15 }
       end
       
       it 'should respect options' do
-        Punch.total(:after => @now - 51).should == { @projects[0] => 25, @projects[1] => 20, @projects[2] => 15}
+        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"}
+        Punch.total(:format => true).should == { @projects[0] => "00:25", @projects[1] => "01:10", @projects[2] => "00:15" }
+      end
+    end
+    
+    describe 'handling a sub-project' do
+      before do
+        @projects = {}
+        @projects['parent'] = 'daddy'
+        @projects['child'] = @projects['parent'] + '/sugar'
+        @data[@projects['parent']] = [ { 'in' => @now - 100, 'out' => @now - 50 } ]
+        @data[@projects['child']] = [ { 'in' => @now - 20, 'out' => @now - 10 } ]
+        Punch.data = @data
+      end
+      
+      it 'should return data for the parent and sub-project' do
+        total_data = { @projects['parent'] => 50, @projects['child'] => 10 }
+        Punch.total(@projects['parent']).should == total_data
+      end
+      
+      it 'should respect options' do
+        total_data = { @projects['parent'] => 0, @projects['child'] => 10 }
+        Punch.total(@projects['parent'], :after => @now - 21).should == total_data
+      end
+      
+      describe 'when do project is given' do
+        before do
+          @extra_projects = ['test project', 'out project', 'other project']
+          @data[@extra_projects[0]] = [ {'in' => @now - 50, 'out' => @now - 25} ]
+          @data[@extra_projects[1]] = [ {'in' => @now - 300, 'out' => @now - 250}, {'in' => @now - 40, 'out' => @now - 20} ]
+          @data[@extra_projects[2]] = [ {'in' => @now - 50, 'out' => @now - 35} ]
+          Punch.data = @data
+        end
+        
+        it 'should give totals for all projects' do
+          total_data = { @extra_projects[0] => 25, @extra_projects[1] => 70, @extra_projects[2] => 15, @projects['parent'] => 50, @projects['child'] => 10 }
+          Punch.total.should == total_data
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: one_inch_punch
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-17 00:00:00 -06:00
+date: 2009-04-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency