one_inch_punch 0.4.1 → 0.4.2

data/History.txt

@@ -1,3 +1,11 @@
+== 0.4.2 2010-08-16
+
+* 1 tiny enhancement:
+  * adding some date handling for list/total/summary:
+    * can now take an :on option, to restrict the operation to the given date
+    * 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
 
 * 1 tiny enhancement:

data/bin/punch

@@ -29,6 +29,8 @@ 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('--on [DATE]', String,
+          "Restrict command to only on the given date") { |date|  OPTIONS[:on] = Date.parse(date) }
   opts.on('--at [TIME]', '--time [TIME]', String,
           "Use the given time") { |time|  OPTIONS[:time] = Time.parse(time) }
   opts.on('-m', '--message [MESSAGE]', String,

data/config/hoe.rb

@@ -8,7 +8,7 @@ RUBYFORGE_PROJECT = 'yomendel' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 EXTRA_DEPENDENCIES = [
-#  ['activesupport', '>= 1.3.1']
+  ['timely', '>= 0.0.1']
 ]    # An array of rubygem dependencies [name, version]
 EXTRA_DEV_DEPENDENCIES = [
   ['bacon', '>= 1.1.0'],

data/lib/punch/version.rb

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

data/lib/punch.rb

@@ -3,6 +3,8 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 require 'yaml'
 require 'time'
+require 'date'
+require 'timely'
 require 'enumerator'
 require 'punch/core_ext'
 require 'punch/instance'
@@ -193,6 +195,7 @@ class Punch
     
     def do_list_single(project, options)
       return nil unless project_data = data[project]
+      options = fix_range_options(options)
       project_data = project_data.select { |t|  t['in']                > options[:after] }  if options[:after]
       project_data = project_data.select { |t|  (t['out'] || Time.now) < options[:before] } if options[:before]
       project_data
@@ -209,6 +212,16 @@ class Punch
       options[:time] || options[:at] || Time.now
     end
     
+    def fix_range_options(options)
+      if date = options[:on]
+        options[:after]  = date
+        options[:before] = date + 1
+      end
+      [:after, :before].each { |k|  options[k] = options[k].at_time(0) if options[k].respond_to?(:at_time) }
+      
+      options
+    end
+    
     def projects
       data.keys
     end

data/spec/punch_command_spec.rb

@@ -117,6 +117,16 @@ describe 'punch command' do
         run_command('total', '--before', time_option)
       end
       
+      it "should pass on an 'on' date option given by --on" do
+        date_option = '2008-08-23'
+        date = Date.new(2008, 8, 23)
+        Punch.should.receive(:total) do |proj, options|
+          proj.should == @project
+          options[:on].should == date
+        end
+        run_command('total', @project, '--on', date_option)
+      end
+      
       it 'should also pass the formatting option' do
         time_option = '2008-08-26 09:47'
         Punch.should.receive(:total) do |proj, options|
@@ -722,6 +732,16 @@ describe 'punch command' do
         end
         run_command('list', '--before', time_option)
       end
+      
+      it "should pass on an 'on' date option given by --on" do
+        date_option = '2008-08-23'
+        date = Date.new(2008, 8, 23)
+        Punch.should.receive(:list) do |proj, options|
+          proj.should == @project
+          options[:on].should == date
+        end
+        run_command('list', @project, '--on', date_option)
+      end
     end
     
     it 'should not write the data' do
@@ -785,6 +805,16 @@ describe 'punch command' do
         run_command('summary', @project, '--before', time_option)
       end
       
+      it "should pass on an 'on' date option given by --on" do
+        date_option = '2008-08-23'
+        date = Date.new(2008, 8, 23)
+        Punch.should.receive(:summary) do |proj, options|
+          proj.should == @project
+          options[:on].should == date
+        end
+        run_command('summary', @project, '--on', date_option)
+      end
+      
       it 'should also pass the formatting option' do
         time_option = '2008-08-23'
         Punch.should.receive(:summary) do |proj, options|
@@ -816,7 +846,7 @@ describe 'punch command' do
         run_command('summary')
       end
 
-      it 'should not punch in' do
+      it 'should not get a summary' do
         Punch.should.receive(:summary).never
         run_command('summary')
       end

data/spec/punch_spec.rb

@@ -1085,6 +1085,48 @@ describe Punch do
         Punch.list(@project, :after => @now - 2001, :before => @now - 999).should == Punch.data[@project][1, 1]
       end
       
+      describe 'handling date options' do
+        before do
+          # yay ugly setup!
+          @date = Date.today - 4
+          morning = Time.local(@date.year, @date.month, @date.day, 0, 0, 1)
+          night   = Time.local(@date.year, @date.month, @date.day, 23, 59, 59)
+          earlier_date = @date - 2
+          earlier_time = Time.local(earlier_date.year, earlier_date.month, earlier_date.day, 13, 43)
+          early_date   = @date - 1
+          early_time   = Time.local(early_date.year, early_date.month, early_date.day, 11, 25)
+          later_date   = @date + 1
+          later_time   = Time.local(later_date.year, later_date.month, later_date.day, 3, 12)
+          
+          @data = { @project => [
+            {'in' => earlier_time - 50, 'out' => earlier_time + 100},
+            {'in' => early_time   - 60, 'out' => early_time   + 70},
+            {'in' => morning,           'out' => morning + 200},
+            {'in' => night - 500,       'out' => night},
+            {'in' => later_time   - 30, 'out' => later_time + 70}
+            ]
+          }
+          
+          Punch.data = @data
+        end
+        
+        it 'should accept an :on shortcut option to restrict returned data to times only on a certain day' do
+          Punch.list(@project, :on => @date).should == Punch.data[@project][2, 2]
+        end
+        
+        it 'should allow the :on option to override the before/after options' do
+          Punch.list(@project, :on => @date, :before => @now - 2525, :after => @now - 7575).should == Punch.data[@project][2, 2]
+        end
+        
+        it 'should allow the :after option to be a date instead of time' do
+          Punch.list(@project, :after => @date).should == Punch.data[@project][2..-1]
+        end
+        
+        it 'should allow the :before option to be a date instead of time' do
+          Punch.list(@project, :before => @date).should == Punch.data[@project][0, 2]
+        end
+      end
+      
       describe 'and is punched in' do
         before do
           @data[@project].push({ 'in' => @now - 25 })
@@ -1242,6 +1284,48 @@ describe Punch do
         Punch.total(@project, :format => true).should == "1:05:00"
       end
       
+      describe 'handling date options' do
+        before do
+          # yay ugly setup!
+          @date = Date.today - 4
+          morning = Time.local(@date.year, @date.month, @date.day, 0, 0, 1)
+          night   = Time.local(@date.year, @date.month, @date.day, 23, 59, 59)
+          earlier_date = @date - 2
+          earlier_time = Time.local(earlier_date.year, earlier_date.month, earlier_date.day, 13, 43)
+          early_date   = @date - 1
+          early_time   = Time.local(early_date.year, early_date.month, early_date.day, 11, 25)
+          later_date   = @date + 1
+          later_time   = Time.local(later_date.year, later_date.month, later_date.day, 3, 12)
+          
+          @data = { @project => [
+            {'in' => earlier_time - 50, 'out' => earlier_time + 100},
+            {'in' => early_time   - 60, 'out' => early_time   + 70},
+            {'in' => morning,           'out' => morning + 200},
+            {'in' => night - 500,       'out' => night},
+            {'in' => later_time   - 30, 'out' => later_time + 70}
+            ]
+          }
+          
+          Punch.data = @data
+        end
+        
+        it 'should accept an :on shortcut option to restrict returned amount to times only on a certain day' do
+          Punch.total(@project, :on => @date).should == 700
+        end
+        
+        it 'should allow the :on option to override the before/after options' do
+          Punch.total(@project, :on => @date, :before => @now - 2525, :after => @now - 7575).should == 700
+        end
+        
+        it 'should allow the :after option to be a date instead of time' do
+          Punch.total(@project, :after => @date).should == 800
+        end
+        
+        it 'should allow the :before option to be a date instead of time' do
+          Punch.total(@project, :before => @date).should == 280
+        end
+      end
+      
       describe 'and is punched in' do
         before do
           @data[@project].push({ 'in' => @now - 25 })
@@ -1599,6 +1683,48 @@ describe Punch do
         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
+        
+        describe 'handling date options' do
+          before do
+            # yay ugly setup!
+            @date = Date.today - 4
+            morning = Time.local(@date.year, @date.month, @date.day, 0, 0, 1)
+            night   = Time.local(@date.year, @date.month, @date.day, 23, 59, 59)
+            earlier_date = @date - 2
+            earlier_time = Time.local(earlier_date.year, earlier_date.month, earlier_date.day, 13, 43)
+            early_date   = @date - 1
+            early_time   = Time.local(early_date.year, early_date.month, early_date.day, 11, 25)
+            later_date   = @date + 1
+            later_time   = Time.local(later_date.year, later_date.month, later_date.day, 3, 12)
+
+            @data = { @project => [
+              {'in' => earlier_time - 50, 'out' => earlier_time + 100},
+              {'in' => early_time   - 60, 'out' => early_time   + 70},
+              {'in' => morning,           'out' => morning + 200},
+              {'in' => night - 500,       'out' => night},
+              {'in' => later_time   - 30, 'out' => later_time + 70}
+              ]
+            }
+
+            Punch.data = @data
+          end
+
+          it 'should accept an :on shortcut option to restrict the summary to times only on a certain day' do
+            Punch.summary(@project, :on => @date).should == { 'unspecified' => 700 }
+          end
+
+          it 'should allow the :on option to override the before/after options' do
+            Punch.summary(@project, :on => @date, :before => @now - 2525, :after => @now - 7575).should == { 'unspecified' => 700 }
+          end
+          
+          it 'should allow the :after option to be a date instead of time' do
+            Punch.summary(@project, :after => @date).should == { 'unspecified' => 800 }
+          end
+
+          it 'should allow the :before option to be a date instead of time' do
+            Punch.summary(@project, :before => @date).should == { 'unspecified' => 280 }
+          end
+        end
       end
       
       describe 'when the project is currently punched in' do

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: one_inch_punch
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  hash: 11
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,39 +15,73 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-26 00:00:00 -05:00
+date: 2010-08-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: timely
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bacon
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: facon
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
         version: 0.4.1
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id004
 description: a simple time-tracking tool
 email: 
 - ymendel@pobox.com
@@ -91,21 +131,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: yomendel
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: a simple time-tracking tool