one_inch_punch 0.0.1

data/spec/punch_spec.rb

@@ -0,0 +1,424 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Punch do
+  it 'should load data' do
+    Punch.should respond_to(:load)
+  end
+  
+  describe 'when loading data' do
+    before :each do
+      @data = <<-EOD
+      ---
+      rip: 
+      - out: 2008-05-19T18:34:39.00-05:00
+        log: 
+        - punch in @ 2008-05-19T17:09:05-05:00
+        - punch out @ 2008-05-19T18:34:39-05:00
+        total: "01:25:34"
+        in: 2008-05-19T17:09:05.00-05:00
+      - out: 2008-05-19T21:04:03.00-05:00
+        total: "00:50:22"
+        log: 
+        - punch in @ 2008-05-19T20:13:41-05:00
+        - punch out @ 2008-05-19T21:04:03-05:00
+        in: 2008-05-19T20:13:41.00-05:00
+      ps: 
+      - out: 2008-05-19T12:18:52.00-05:00
+        log: 
+        - punch in @ 2008-05-19T11:23:35-05:00
+        - punch out @ 2008-05-19T12:18:52-05:00
+        total: "00:55:17"
+        in: 2008-05-19T11:23:35.00-05:00
+      EOD
+      File.stubs(:read).returns(@data)
+      
+      Punch.instance_eval do
+        class << self
+          public :data
+        end
+      end
+      
+      Punch.reset
+    end
+    
+    it 'should read the ~/.punch.yml file' do
+      File.expects(:read).with(File.expand_path('~/.punch.yml')).returns(@data)
+      Punch.load
+    end
+    
+    describe 'when the file is found' do
+      it 'should load the data as yaml' do
+        Punch.load
+        Punch.data.should == YAML.load(@data)
+      end
+      
+      it 'should return true' do
+        Punch.load.should == true
+      end
+    end
+    
+    describe 'when no file is found' do
+      before :each do
+        File.stubs(:read).raises(Errno::ENOENT)
+      end
+      
+      it 'should leave the data blank' do
+        Punch.load
+        Punch.data.should be_nil
+      end
+      
+      it 'should return false' do
+        Punch.load.should == false
+      end
+    end
+  end
+  
+  it 'should reset itself' do
+    Punch.should respond_to(:reset)
+  end
+  
+  describe 'when resetting itself' do
+    before :each do
+      Punch.instance_eval do
+        class << self
+          public :data, :data=
+        end
+      end
+    end
+    
+    it 'should set its data to nil' do
+      Punch.data = { 'proj' => 'lots of stuff here' }
+      Punch.reset
+      Punch.data.should be_nil
+    end
+  end
+  
+  it 'should write data' do
+    Punch.should respond_to(:write)
+  end
+  
+  describe 'when writing data' do
+    before :each do
+      @file = stub('file')
+      File.stubs(:open).yields(@file)
+      @data = { 'proj' => 'data goes here' }
+      
+      Punch.instance_eval do
+        class << self
+          public :data=
+        end
+      end
+      Punch.data = @data
+    end
+    
+    it 'should open the data file for writing' do
+      File.expects(:open).with(File.expand_path('~/.punch.yml'), 'w')
+      Punch.write
+    end
+    
+    it 'should write the data to the file in YAML form' do
+      @file.expects(:puts).with(@data.to_yaml)
+      Punch.write
+    end
+  end
+  
+  it "should give a project's status" do
+    Punch.should respond_to(:status)
+  end
+  
+  describe "giving a project's status" do
+    before :each do
+      @now = Time.now
+      @projects = { 'out' => 'test-o', 'in' => 'testshank' }
+      @data = { 
+        @projects['out'] => [ { 'in' => @now, 'out' => @now + 12 } ],
+        @projects['in']  => [ { 'in' => @now } ]
+      }
+      
+      Punch.instance_eval do
+        class << self
+          public :data=
+        end
+      end
+      Punch.data = @data
+    end
+    
+    it 'should accept a project name' do
+      lambda { Punch.status('proj') }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require a project name' do
+      lambda { Punch.status }.should raise_error(ArgumentError)
+    end
+    
+    it "should return 'out' if the project is currently punched out" do
+      Punch.status(@projects['out']).should == 'out'
+    end
+    
+    it "should return 'in' if the project is currently punched in" do
+      Punch.status(@projects['in']).should == 'in'
+    end
+    
+    it 'should return nil if the project does not exist' do
+      Punch.status('other project').should be_nil
+    end
+    
+    it 'should return nil if the project has no time data' do
+      project = 'empty project'
+      @data[project] = []
+      Punch.data = @data
+      Punch.status(project).should be_nil
+    end
+    
+    it 'should use the last time entry for the status' do
+      @data[@projects['out']].unshift *[{ 'in' => @now - 100 }, { 'in' => @now - 90, 'out' => @now - 50 }]
+      @data[@projects['in']].unshift  *[{ 'in' => @now - 100, 'out' => @now - 90 }, { 'in' => @now - 50 }]
+      Punch.data = @data
+      
+      Punch.status(@projects['out']).should == 'out'
+      Punch.status(@projects['in']).should  == 'in'
+    end
+  end
+  
+  it 'should indicate whether a project is punched out' do
+    Punch.should respond_to(:out?)
+  end
+  
+  describe 'indicating whether a project is punched out' do
+    before :each do
+      @project = 'testola'
+    end
+    
+    it 'should accept a project name' do
+      lambda { Punch.out?('proj') }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require a project name' do
+      lambda { Punch.out? }.should raise_error(ArgumentError)
+    end
+        
+    it "should get the project's status" do
+      Punch.expects(:status).with(@project)
+      Punch.out?(@project)
+    end
+    
+    it "should return true if the project's status is 'out'" do
+      Punch.stubs(:status).returns('out')
+      Punch.out?(@project).should == true
+    end
+    
+    it "should return false if the project's status is 'in'" do
+      Punch.stubs(:status).returns('in')
+      Punch.out?(@project).should == false
+    end
+    
+    it "should return true if the project's status is nil" do
+      Punch.stubs(:status).returns(nil)
+      Punch.out?(@project).should == true
+    end
+  end
+  
+  it 'should indicate whether a project is punched in' do
+    Punch.should respond_to(:in?)
+  end
+  
+  describe 'indicating whether a project is punched in' do
+    before :each do
+      @project = 'testola'
+    end
+    
+    it 'should accept a project name' do
+      lambda { Punch.in?('proj') }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require a project name' do
+      lambda { Punch.in? }.should raise_error(ArgumentError)
+    end
+        
+    it "should get the project's status" do
+      Punch.expects(:status).with(@project)
+      Punch.in?(@project)
+    end
+    
+    it "should return false if the project's status is 'out'" do
+      Punch.stubs(:status).returns('out')
+      Punch.in?(@project).should == false
+    end
+    
+    it "should return true if the project's status is 'in'" do
+      Punch.stubs(:status).returns('in')
+      Punch.in?(@project).should == true
+    end
+    
+    it "should return false if the project's status is nil" do
+      Punch.stubs(:status).returns(nil)
+      Punch.in?(@project).should == false
+    end
+  end
+  
+  it 'should punch a project in' do
+    Punch.should respond_to(:in)
+  end
+  
+  describe 'punching a project in' do
+    before :each do
+      @now = Time.now
+      Time.stubs(:now).returns(@now)
+      @project = 'test project'
+      @data = { @project => [ {'in' => @now - 50, 'out' => @now - 25} ] }
+      
+      Punch.instance_eval do
+        class << self
+          public :data, :data=
+        end
+      end
+      Punch.data = @data
+      
+      @test = states('test').starts_as('setup')
+      Punch.stubs(:write).when(@test.is('setup'))
+    end
+    
+    it 'should accept a project name' do
+      lambda { Punch.in('proj') }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require a project name' do
+      lambda { Punch.in }.should raise_error(ArgumentError)
+    end
+    
+    it 'should check whether the project is already punched in' do
+      Punch.expects(:in?).with(@project)
+      Punch.in(@project)
+    end
+    
+    describe 'when the project is already punched in' do
+      before :each do
+        Punch.stubs(:in?).returns(true)
+      end
+      
+      it 'should not change the project data' do
+        Punch.in(@project)
+        Punch.data.should == @data
+      end
+      
+      it 'should not write the data' do
+        @test.become('test')
+        Punch.expects(:write).never.when(@test.is('test'))
+        Punch.in(@project)
+      end
+      
+      it 'should return false' do
+        Punch.in(@project).should == false
+      end
+    end
+    
+    describe 'when the project is not already punched in' do
+      before :each do
+        Punch.stubs(:in?).returns(false)
+      end
+      
+      it 'should add a time entry to the project data' do
+        Punch.in(@project)
+        Punch.data[@project].length.should == 2
+      end
+      
+      it 'should use now for the punch-in time' do
+        Punch.in(@project)
+        Punch.data[@project].last['in'].should == @now
+      end
+      
+      it 'should write the data' do
+        @test.become('test')
+        Punch.expects(:write).when(@test.is('test'))
+        Punch.in(@project)
+      end
+      
+      it 'should return true' do
+        Punch.in(@project).should == true
+      end
+    end
+  end
+  
+  it 'should punch a project out' do
+    Punch.should respond_to(:out)
+  end
+  
+  describe 'punching a project out' do
+    before :each do
+      @now = Time.now
+      Time.stubs(:now).returns(@now)
+      @project = 'test project'
+      @data = { @project => [ {'in' => @now - 50, 'out' => @now - 25} ] }
+      
+      Punch.instance_eval do
+        class << self
+          public :data, :data=
+        end
+      end
+      Punch.data = @data
+      
+      @test = states('test').starts_as('setup')
+      Punch.stubs(:write).when(@test.is('setup'))
+    end
+    
+    it 'should accept a project name' do
+      lambda { Punch.out('proj') }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require a project name' do
+      lambda { Punch.out }.should raise_error(ArgumentError)
+    end
+    
+    it 'should check whether the project is already punched out' do
+      Punch.expects(:out?).with(@project)
+      Punch.out(@project)
+    end
+    
+    describe 'when the project is already punched out' do
+      before :each do
+        Punch.stubs(:out?).returns(true)
+      end
+      
+      it 'should not change the project data' do
+        Punch.out(@project)
+        Punch.data.should == @data
+      end
+      
+      it 'should not write the data' do
+        @test.become('test')
+        Punch.expects(:write).never.when(@test.is('test'))
+        Punch.out(@project)
+      end
+      
+      it 'should return false' do
+        Punch.out(@project).should == false
+      end
+    end
+    
+    describe 'when the project is not already punched out' do
+      before :each do
+        Punch.stubs(:out?).returns(false)
+      end
+      
+      it 'should not add a time entry to the project data' do
+        Punch.out(@project)
+        Punch.data[@project].length.should == 1
+      end
+      
+      it 'should use now for the punch-out time' do
+        Punch.out(@project)
+        Punch.data[@project].last['out'].should == @now
+      end
+      
+      it 'should write the data' do
+        @test.become('test')
+        Punch.expects(:write).when(@test.is('test'))
+        Punch.out(@project)
+      end
+      
+      it 'should return true' do
+        Punch.out(@project).should == true
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+# this is my favorite way to require ever
+begin
+  require 'mocha'
+rescue LoadError
+  require 'rubygems'
+  gem 'mocha'
+  require 'mocha'
+end
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'punch'

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,9 @@
+# stubs for the website generation
+# To install the website framework:
+#   script/generate website
+
+task :website_generate
+
+task :website_upload
+
+task :website => :publish_docs

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: one_inch_punch
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Yossef Mendelssohn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-18 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: a simple time-tracking tool
+email: 
+- ymendel@pobox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- config/hoe.rb
+- config/requirements.rb
+- lib/punch.rb
+- lib/punch/version.rb
+- script/console
+- script/destroy
+- script/generate
+- setup.rb
+- spec/punch_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/deployment.rake
+- tasks/environment.rake
+- tasks/rspec.rake
+- tasks/website.rake
+has_rdoc: true
+homepage: http://yomendel.rubyforge.org
+post_install_message: ""
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: yomendel
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: a simple time-tracking tool
+test_files: []
+