one_inch_punch 0.0.3 → 0.1.0

data/History.txt

@@ -1,3 +1,13 @@
+== 0.1.0 2008-08-26
+
+* 1 enhancement:
+  * punch command, for the following operations at the command line:
+    * status
+    * in/out
+    * log
+    * total
+    * delete
+
 == 0.0.3 2008-08-25
 
 * 5 enhancements:

data/Manifest.txt

@@ -3,6 +3,7 @@ License.txt
 Manifest.txt
 README.txt
 Rakefile
+bin/punch
 config/hoe.rb
 config/requirements.rb
 lib/punch.rb
@@ -11,6 +12,7 @@ script/console
 script/destroy
 script/generate
 setup.rb
+spec/punch_command_spec.rb
 spec/punch_spec.rb
 spec/spec.opts
 spec/spec_helper.rb

data/README.txt

@@ -17,8 +17,10 @@ One-inch punch: Smaller, more effective
 * Can delete a project
 * Can list project data
 * Can give total time for a project
+* Can be used command-line
 
-* Cannot be used command-line (yet)
+* Command-line does not give access to the list operation
+* Command-line output is ugly
 * More, since this is unfinished
 
 == SYNOPSIS:
@@ -33,6 +35,13 @@ One-inch punch: Smaller, more effective
   Punch.out('my project')
   Punch.out?('my project')    # => true
   Punch.write
+  
+  or!
+  
+  $ punch in proj
+  $ echo 'working, really'
+  $ punch out proj
+  $ punch status
 
 == REQUIREMENTS:
 
@@ -47,4 +56,5 @@ One-inch punch: Smaller, more effective
 
   * Ara T. Howard, for making punch in the first place
   * Kevin Barnes, for the name suggestion
+  * Bruce Lee, for having been a bad-ass
   * The Kool-Aid Man, for busting through my wall. Oh yeah!

data/bin/punch

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-8-25.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'punch'
+require 'optparse'
+require 'time'
+
+OPTIONS = {}
+MANDATORY_OPTIONS = %w[]
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+This application is wonderful because...
+
+Usage: #{File.basename($0)} [options]
+
+Options are:
+BANNER
+  opts.separator ''
+  opts.on('-v', '--version',
+          "Show the #{File.basename($0)} version number and exit") { require 'punch/version'; puts "#{File.basename($0)} #{Punch::VERSION::STRING}"; exit  }
+  opts.on('--after [TIME]', String,
+          "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("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
+
+command = ARGV[0]
+
+unless command
+  puts "Usage: #{File.basename($0)} [command] <project>"
+  exit
+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)
+      puts result.inspect
+    else
+      puts "Message required"
+    end
+  else
+    puts "Project required"
+  end
+end

data/lib/punch/version.rb

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

data/spec/punch_command_spec.rb

@@ -0,0 +1,392 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'punch command' do
+  def run_command(*args)
+    Object.const_set(:ARGV, args)
+    begin
+      eval File.read(File.join(File.dirname(__FILE__), *%w[.. bin punch]))
+    rescue SystemExit
+    end
+  end
+  
+  before :each do
+    [:ARGV, :OPTIONS, :MANDATORY_OPTIONS].each do |const|
+      Object.send(:remove_const, const) if Object.const_defined?(const)
+    end
+    
+    self.stubs(:puts)
+    
+    Punch.stubs(:load)
+    @test = states('test').starts_as('setup')
+    Punch.stubs(:write).when(@test.is('setup'))
+    @project = 'myproj'
+  end
+  
+  it 'should exist' do
+    lambda { run_command }.should_not raise_error(Errno::ENOENT)
+  end
+  
+  it 'should require a command' do
+    self.expects(:puts).with(regexp_matches(/usage.+command/i))
+    run_command
+  end
+  
+  describe "when the command is 'total'" do
+    before :each do
+      Punch.stubs(:total)
+    end
+    
+    it 'should load punch data' do
+      Punch.expects(:load)
+      run_command('total', @project)
+    end
+    
+    it 'should get the total for the requested project' do
+      Punch.expects(:total).with(@project, anything)
+      run_command('total', @project)
+    end
+    
+    it 'should get the total for all projects if none given' do
+      Punch.expects(:total).with(nil, anything)
+      run_command('total')
+    end
+    
+    it 'should output the total' do
+      result = 'total data'
+      Punch.stubs(:total).returns(result)
+      self.expects(:puts).with(result.inspect)
+      run_command('total')
+    end
+    
+    it 'should not write the data' do
+      @test.become('test')
+      Punch.expects(:write).never.when(@test.is('test'))
+      run_command('total')
+    end
+    
+    describe 'when options specified' do
+      it "should pass on an 'after' time option given by --after" do
+        time_option = '2008-08-26 09:47'
+        time = Time.local(2008, 8, 26, 9, 47)
+        Punch.expects(:total).with(@project, has_entry(:after => time))
+        run_command('total', @project, '--after', time_option)
+      end
+      
+      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.expects(:total).with(@project, has_entry(:before => time))
+        run_command('total', @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.expects(:total).with(@project, has_entry(:before => time))
+        run_command('total', @project, '--before', time_option)
+      end
+      
+      it 'should accept time options if no project given' do
+        time_option = '2008-08-26 09:47'
+        time = Time.local(2008, 8, 26, 9, 47)
+        Punch.expects(:total).with(nil, has_entry(:before => time))
+        run_command('total', '--before', time_option)
+      end
+    end
+    
+    it 'should pass no options if none specified' do
+      Punch.expects(:total).with(@project, {})
+      run_command('total', @project)
+    end
+  end
+
+  describe "when the command is 'status'" do
+    before :each do
+      Punch.stubs(:status)
+    end
+    
+    it 'should load punch data' do
+      Punch.expects(:load)
+      run_command('status', @project)
+    end
+    
+    it 'should get the status for the requested project' do
+      Punch.expects(:status).with(@project)
+      run_command('status', @project)
+    end
+    
+    it 'should get the status for all projects if none given' do
+      Punch.expects(:status).with(nil)
+      run_command('status')
+    end
+    
+    it 'should output the status' do
+      result = 'status data'
+      Punch.stubs(:status).returns(result)
+      self.expects(:puts).with(result.inspect)
+      run_command('status')
+    end
+    
+    it 'should not write the data' do
+      @test.become('test')
+      Punch.expects(:write).never.when(@test.is('test'))
+      run_command('status')
+    end
+  end
+  
+  describe "when the command is 'in'" do
+    before :each do
+      Punch.stubs(:in).when(@test.is('setup'))
+    end
+    
+    it 'should load punch data' do
+      Punch.expects(:load)
+      run_command('in', @project)
+    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)
+      run_command('in', @project)
+    end
+    
+    describe 'when punched in successfully' do
+      it 'should write the data' do
+        @test.become('test')
+        Punch.stubs(:in).returns(true)
+        Punch.expects(:write).when(@test.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')
+        Punch.stubs(:in).returns(false)
+        Punch.expects(:write).never.when(@test.is('test'))
+        run_command('in', @project)
+      end
+    end
+    
+    describe 'when no project given' do
+      it 'should display an error message' do
+        self.expects(:puts).with(regexp_matches(/project.+require/i))
+        run_command('in')
+      end
+      
+      it 'should not punch in' do
+        @test.become('test')
+        Punch.stubs(:write)
+        Punch.expects(:in).never.when(@test.is('test'))
+        run_command('in')
+      end
+      
+      it 'should not write the data' do
+        @test.become('test')
+        Punch.expects(:write).never.when(@test.is('test'))
+        run_command('in')
+      end
+    end
+  end
+
+  describe "when the command is 'out'" do
+    before :each do
+      Punch.stubs(:out)
+    end
+    
+    it 'should load punch data' do
+      Punch.expects(:load)
+      run_command('out', @project)
+    end
+    
+    it 'should punch out of the given project' do
+      Punch.expects(:out).with(@project)
+      run_command('out', @project)
+    end
+    
+    it 'should punch out of all projects if none given' do
+      Punch.expects(:out).with(nil)
+      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')
+        Punch.stubs(:out).returns(true)
+        Punch.expects(:write).when(@test.is('test'))
+        run_command('out', @project)
+      end
+    end
+    
+    describe 'when not punched out successfully' do
+      it 'should not write the data' do
+        @test.become('test')
+        Punch.stubs(:out).returns(false)
+        Punch.expects(:write).never.when(@test.is('test'))
+        run_command('out', @project)
+      end
+    end
+  end
+  
+  describe "when the command is 'delete'" do
+    before :each do
+      Punch.stubs(:delete).when(@test.is('setup'))
+    end
+    
+    it 'should load punch data' do
+      Punch.expects(:load)
+      run_command('delete', @project)
+    end
+    
+    it 'should delete the given project' do
+      @test.become('test')
+      Punch.stubs(:write)
+      Punch.expects(:delete).with(@project).when(@test.is('test'))
+      run_command('delete', @project)
+    end
+    
+    it 'should output the result' do
+      result = 'result'
+      Punch.stubs(:delete).returns(result)
+      self.expects(:puts).with(result.inspect)
+      run_command('delete', @project)
+    end
+    
+    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'))
+        run_command('delete', @project)
+      end
+    end
+    
+    describe 'when not deleted successfully' do
+      it 'should not write the data' do
+        @test.become('test')
+        Punch.stubs(:delete).returns(nil)
+        Punch.expects(:write).never.when(@test.is('test'))
+        run_command('delete', @project)
+      end
+    end
+    
+    describe 'when no project given' do
+      it 'should display an error message' do
+        self.expects(:puts).with(regexp_matches(/project.+require/i))
+        run_command('delete')
+      end
+      
+      it 'should not delete' do
+        @test.become('test')
+        Punch.stubs(:write)
+        Punch.expects(:delete).never.when(@test.is('test'))
+        run_command('delete')
+      end
+      
+      it 'should not write the data' do
+        @test.become('test')
+        Punch.expects(:write).never.when(@test.is('test'))
+        run_command('delete')
+      end
+    end
+  end
+  
+  describe "when the command is 'log'" do
+    before :each do
+      Punch.stubs(:log).when(@test.is('setup'))
+      @message = 'log message'
+    end
+    
+    it 'should load punch data' do
+      Punch.expects(:load)
+      run_command('log', @project, @message)
+    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)
+      run_command('log', @project, @message)
+    end
+    
+    describe 'when logged successfully' do
+      it 'should write the data' do
+        @test.become('test')
+        Punch.stubs(:log).returns(true)
+        Punch.expects(:write).when(@test.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')
+        Punch.stubs(:log).returns(false)
+        Punch.expects(:write).never.when(@test.is('test'))
+        run_command('log', @project, @message)
+      end
+    end
+    
+    describe 'when no project given' do
+      it 'should display an error message' do
+        self.expects(:puts).with(regexp_matches(/project.+require/i))
+        run_command('log')
+      end
+      
+      it 'should not log' do
+        @test.become('test')
+        Punch.stubs(:write)
+        Punch.expects(:log).never.when(@test.is('test'))
+        run_command('log')
+      end
+      
+      it 'should not write the data' do
+        @test.become('test')
+        Punch.expects(:write).never.when(@test.is('test'))
+        run_command('log')
+      end
+    end
+    
+    describe 'when no message given' do
+      it 'should display an error message' do
+        self.expects(:puts).with(regexp_matches(/message.+require/i))
+        run_command('log', @project)
+      end
+      
+      it 'should not log' do
+        @test.become('test')
+        Punch.stubs(:write)
+        Punch.expects(:log).never.when(@test.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'))
+        run_command('log', @project)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: one_inch_punch
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-25 00:00:00 -05:00
+date: 2008-08-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,8 +25,8 @@ dependencies:
 description: a simple time-tracking tool
 email: 
 - ymendel@pobox.com
-executables: []
-
+executables: 
+- punch
 extensions: []
 
 extra_rdoc_files: 
@@ -40,6 +40,7 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
+- bin/punch
 - config/hoe.rb
 - config/requirements.rb
 - lib/punch.rb
@@ -48,6 +49,7 @@ files:
 - script/destroy
 - script/generate
 - setup.rb
+- spec/punch_command_spec.rb
 - spec/punch_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb