one_inch_punch 0.2.3 → 0.2.4

data/History.txt

@@ -1,6 +1,12 @@
+== 0.2.4 2008-12-17
+
+* 1 tiny enhancement:
+  * Status can now be retrieved as simple (only the status) or 'full' (status + time)
+    * punch command displays status as YAML unless only retrieving simple status for a single project
+
 == 0.2.3 2008-12-11
 
-* 1 enhancements:
+* 1 enhancement:
   * Logging a message now automatically adds a time
     * A time can be specified for the log message (with now as a default)
     * punch command takes options for message logging

data/bin/punch

@@ -33,6 +33,8 @@ BANNER
           "Use the given time to punch in/out") { |time|  OPTIONS[:time] = Time.parse(time) }
   opts.on('-m', '--message [MESSAGE]', String,
           "Add the given log message when punching in/out") { |message|  OPTIONS[:message] = message }
+  opts.on('--full',
+          "Show full output for the command") { |full|  OPTIONS[:full] = true }
   opts.on("-h", "--help",
           "Show this help message.") { puts opts; exit }
   opts.parse!(ARGV)
@@ -55,11 +57,11 @@ Punch.load
 
 commands = {
   'status' => lambda do |project|
-    result = Punch.status(project)
-    if project
-      puts result.inspect
-    else
+    result = Punch.status(project, OPTIONS)
+    if project.nil? or OPTIONS[:full]
       puts result.to_yaml
+    else
+      puts result.inspect
     end
   end,
   'total'  => lambda do |project|

data/lib/punch/instance.rb

@@ -5,8 +5,8 @@ class Punch
     @project = project
   end
   
-  def status
-    self.class.status(project)
+  def status(options = {})
+    self.class.status(project, options)
   end
   
   def out?

data/lib/punch/version.rb

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

data/lib/punch.rb

@@ -39,14 +39,22 @@ class Punch
       end
     end
     
-    def status(project = nil)
-      return data.keys.inject({}) { |hash, project|  hash.merge(project => status(project)) } unless project
+    def status(project = nil, options = {})
+      if project.is_a?(Hash)
+        options = project
+        project = nil
+      end
+      
+      return data.keys.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
-      time_data['out'] ? 'out' : 'in'
+      status = time_data['out'] ? 'out' : 'in'
+      return status unless options[:full]
+      
+      { :status => status, :time => time_data[status] }
     end
     
     def out?(project)

data/spec/punch_command_spec.rb

@@ -147,12 +147,12 @@ describe 'punch command' do
     end
     
     it 'should get the status for the requested project' do
-      Punch.should.receive(:status).with(@project)
+      Punch.should.receive(:status).with(@project, {})
       run_command('status', @project)
     end
     
     it 'should get the status for all projects if none given' do
-      Punch.should.receive(:status).with(nil)
+      Punch.should.receive(:status).with(nil, {})
       run_command('status')
     end
     
@@ -170,6 +170,30 @@ describe 'punch command' do
       run_command('status')
     end
     
+    it 'should pass a true full option if specified on the command line (with --full)' do
+      Punch.should.receive(:status).with(@project, :full => true)
+      run_command('status', @project, '--full')
+    end
+    
+    it 'should pass a true full option if specified on the command line (with --full) and no project given' do
+      Punch.should.receive(:status).with(nil, :full => true)
+      run_command('status', '--full')
+    end
+    
+    it 'should output the status as YAML if a full option is given' do
+      result = 'status data'
+      Punch.stub!(:status).and_return(result)
+      self.should.receive(:puts).with(result.to_yaml)
+      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
+      result = 'status data'
+      Punch.stub!(:status).and_return(result)
+      self.should.receive(:puts).with(result.to_yaml)
+      run_command('status', '--full')
+    end
+    
     it 'should not write the data' do
       Punch.should.receive(:write).never
       run_command('status')

data/spec/punch_instance_spec.rb

@@ -30,13 +30,38 @@ describe Punch, 'instance' do
       Punch.stub!(:status).and_return(@status)
     end
     
+    it 'should accept options' do
+      lambda { @punch.status(:full => true) }.should.not.raise(ArgumentError)
+    end
+    
+    it 'should not require options' do
+      lambda { @punch.status }.should.not.raise(ArgumentError)
+    end
+    
     it 'should delegate to the class' do
       Punch.should.receive(:status)
       @punch.status
     end
     
     it 'should pass the project when delegating to the class' do
-      Punch.should.receive(:status).with(@project)
+      Punch.should.receive(:status) do |proj, _|
+        proj.should == @project
+      end
+      @punch.status
+    end
+    
+    it 'should pass the options when delegating to the class' do
+      options = { :full => true }
+      Punch.should.receive(:status) do |_, opts|
+        opts.should == options
+      end
+      @punch.status(options)
+    end
+    
+    it 'should pass an empty hash if no options given' do
+      Punch.should.receive(:status) do |_, opts|
+        opts.should == {}
+      end
       @punch.status
     end
     

data/spec/punch_spec.rb

@@ -210,6 +210,38 @@ describe Punch do
     it 'should return the status of all projects if no project name given' do
       Punch.status.should == { @projects['out'] => 'out', @projects['in'] => 'in' }
     end
+    
+    it 'should accept options' do
+      lambda { Punch.status('proj', :full => true) }.should.not.raise(ArgumentError)
+    end
+    
+    describe 'when given a :full option' do
+      it 'should return the status and the time of that status if the project is currently punched in' do
+        Punch.status(@projects['in'], :full => true).should == { :status => 'in', :time => @now }
+      end
+      
+      it 'should return the status and the time of that status if the project is currently punched out' do
+        Punch.status(@projects['out'], :full => true).should == { :status => 'out', :time => @now + 12 }
+      end
+      
+      it 'should return nil if project does not exist' 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
+        Punch.status(nil, :full => true).should == {
+          @projects['out'] => { :status => 'out', :time => @now + 12 },
+          @projects['in']  => { :status => 'in',  :time => @now }
+        }
+      end
+      
+      it 'should return the full status if all projects if no project given' do
+        Punch.status(:full => true).should == {
+          @projects['out'] => { :status => 'out', :time => @now + 12 },
+          @projects['in']  => { :status => 'in',  :time => @now }
+        }
+      end
+    end
   end
   
   it 'should indicate whether a project is punched out' do

metadata

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