one_inch_punch 0.1.4 → 0.2.0

data/History.txt

@@ -1,3 +1,9 @@
+== 0.2.0 2008-11-05
+
+* 2 enhancements:
+  * Ensures data is loaded when needed
+  * Can be instantiated with a project (useful if many operations are to be performed on a single project)
+
 == 0.1.4 2008-10-23
 
 * punch command enhancements:

data/Manifest.txt

@@ -10,12 +10,14 @@ lib/punch.rb
 lib/punch/core_ext.rb
 lib/punch/core_ext/fixnum.rb
 lib/punch/version.rb
+lib/punch/instance.rb
 script/console
 script/destroy
 script/generate
 setup.rb
 spec/fixnum_spec.rb
 spec/punch_command_spec.rb
+spec/punch_instance_spec.rb
 spec/punch_spec.rb
 spec/spec.opts
 spec/spec_helper.rb

data/README.txt

@@ -40,6 +40,19 @@ One-inch punch: Smaller, more effective
   $ echo 'working, really'
   $ punch out proj
   $ punch status
+  
+  or!
+  
+  require 'punch'
+  
+  proj = Punch.new('my project')
+  proj.status                     # => 'out'
+  proj.in
+  proj.status                     # => 'in'
+  # do some work
+  proj.out
+  proj.out?                       # => true
+  Punch.write
 
 == REQUIREMENTS:
 

data/lib/punch.rb

@@ -3,11 +3,18 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 require 'yaml'
 require 'punch/core_ext'
+require 'punch/instance'
 
-module Punch
+class Punch
   class << self
     private
-    attr_accessor :data
+    attr_writer :data
+    
+    def data
+      load unless @data
+      @data
+    end
+    
     
     public
     
@@ -28,7 +35,7 @@ module Punch
     
     def write
       File.open(File.expand_path('~/.punch.yml'), 'w') do |file|
-        file.puts @data.to_yaml
+        file.puts data.to_yaml
       end
     end
     

data/lib/punch/instance.rb

@@ -0,0 +1,39 @@
+class Punch
+  attr_reader :project
+  
+  def initialize(project)
+    @project = project
+  end
+  
+  def status
+    self.class.status(project)
+  end
+  
+  def out?
+    self.class.out?(project)
+  end
+  
+  def in?
+    self.class.in?(project)
+  end
+  
+  def in(options = {})
+    self.class.in(project, options)
+  end
+  
+  def out(options = {})
+    self.class.out(project, options)
+  end
+  
+  def list(options = {})
+    self.class.list(project, options)
+  end
+  
+  def total(options = {})
+    self.class.total(project, options)
+  end
+  
+  def log(message)
+    self.class.log(project, message)
+  end
+end

data/lib/punch/version.rb

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

data/spec/punch_instance_spec.rb

@@ -0,0 +1,312 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Punch, 'instance' do
+  before :each do
+    @project = 'proj'
+    @punch = Punch.new(@project)
+  end
+  
+  describe 'when initialized' do
+    it 'should accept a project' do
+      lambda { Punch.new(@project) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require a project' do
+      lambda { Punch.new }.should raise_error(ArgumentError)
+    end
+    
+    it 'should save the project for later use' do
+      Punch.new(@project).project.should == @project
+    end
+  end
+  
+  it 'should give project status' do
+    @punch.should respond_to(:status)
+  end
+  
+  describe 'giving project status' do
+    before :each do
+      @status = 'status val'
+      Punch.stubs(:status).returns(@status)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.expects(:status)
+      @punch.status
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.expects(:status).with(@project)
+      @punch.status
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.status.should == @status
+    end
+  end
+  
+  it 'should indicate whether the project is punched out' do
+    @punch.should respond_to(:out?)
+  end
+  
+  describe 'indicating whether the project is punched out' do
+    before :each do
+      @out = 'out val'
+      Punch.stubs(:out?).returns(@out)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.expects(:out?)
+      @punch.out?
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.expects(:out?).with(@project)
+      @punch.out?
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.out?.should == @out
+    end
+  end
+  
+  it 'should indicate whether the project is punched in' do
+    @punch.should respond_to(:in?)
+  end
+  
+  describe 'indicating whether the project is punched in' do
+    before :each do
+      @in = 'in val'
+      Punch.stubs(:in?).returns(@in)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.expects(:in?)
+      @punch.in?
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.expects(:in?).with(@project)
+      @punch.in?
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.in?.should == @in
+    end
+  end
+  
+  it 'should punch the project in' do
+    @punch.should respond_to(:in)
+  end
+  
+  describe 'punching the project in' do
+    before :each do
+      @in = 'in val'
+      Punch.stubs(:in).returns(@in)
+    end
+    
+    it 'should accept options' do
+      lambda { @punch.in(:time => Time.now) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should not require options' do
+      lambda { @punch.in }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.expects(:in)
+      @punch.in
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.expects(:in).with(@project, anything)
+      @punch.in
+    end
+    
+    it 'should pass the options when delegating to the class' do
+      options = { :time => Time.now }
+      Punch.expects(:in).with(anything, options)
+      @punch.in(options)
+    end
+    
+    it 'should pass an empty hash if no options given' do
+      Punch.expects(:in).with(anything, {})
+      @punch.in
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.in.should == @in
+    end
+  end
+  
+  it 'should punch the project out' do
+    @punch.should respond_to(:out)
+  end
+  
+  describe 'punching the project out' do
+    before :each do
+      @out = 'out val'
+      Punch.stubs(:out).returns(@out)
+    end
+    
+    it 'should accept options' do
+      lambda { @punch.out(:time => Time.now) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should not require options' do
+      lambda { @punch.out }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.expects(:out)
+      @punch.out
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.expects(:out).with(@project, anything)
+      @punch.out
+    end
+    
+    it 'should pass the options when delegating to the class' do
+      options = { :time => Time.now }
+      Punch.expects(:out).with(anything, options)
+      @punch.out(options)
+    end
+    
+    it 'should pass an empty hash if no options given' do
+      Punch.expects(:out).with(anything, {})
+      @punch.out
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.out.should == @out
+    end
+  end
+  
+  it 'should list the project data' do
+    @punch.should respond_to(:list)
+  end
+  
+  describe 'listing the project data' do
+    before :each do
+      @list = 'list val'
+      Punch.stubs(:list).returns(@list)
+    end
+    
+    it 'should accept options' do
+      lambda { @punch.list(:time => Time.now) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should not require options' do
+      lambda { @punch.list }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.expects(:list)
+      @punch.list
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.expects(:list).with(@project, anything)
+      @punch.list
+    end
+    
+    it 'should pass the options when delegating to the class' do
+      options = { :time => Time.now }
+      Punch.expects(:list).with(anything, options)
+      @punch.list(options)
+    end
+    
+    it 'should pass an empty hash if no options given' do
+      Punch.expects(:list).with(anything, {})
+      @punch.list
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.list.should == @list
+    end
+  end
+  
+  it 'should get the project total' do
+    @punch.should respond_to(:total)
+  end
+  
+  describe 'getting the project total' do
+    before :each do
+      @total = 'total val'
+      Punch.stubs(:total).returns(@total)
+    end
+    
+    it 'should accept options' do
+      lambda { @punch.total(:time => Time.now) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should not require options' do
+      lambda { @punch.total }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.expects(:total)
+      @punch.total
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.expects(:total).with(@project, anything)
+      @punch.total
+    end
+    
+    it 'should pass the options when delegating to the class' do
+      options = { :time => Time.now }
+      Punch.expects(:total).with(anything, options)
+      @punch.total(options)
+    end
+    
+    it 'should pass an empty hash if no options given' do
+      Punch.expects(:total).with(anything, {})
+      @punch.total
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.total.should == @total
+    end
+  end
+  
+  it 'should log information about the project' do
+    @punch.should respond_to(:log)
+  end
+  
+  describe 'logging information about the project' do
+    before :each do
+      @log = 'log val'
+      @message = 'some log message'
+      Punch.stubs(:log).returns(@log)
+    end
+    
+    it 'should accept a log message' do
+      lambda { @punch.log(@message) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require a log message' do
+      lambda { @punch.log }.should raise_error(ArgumentError)
+    end
+    
+    it 'should delegate to the class' do
+      Punch.expects(:log)
+      @punch.log(@message)
+    end
+    
+    it 'should pass the project when delegating to the class' do
+      Punch.expects(:log).with(@project, anything)
+      @punch.log(@message)
+    end
+    
+    it 'should pass the message when delegating to the class' do
+      Punch.expects(:log).with(anything, @message)
+      @punch.log(@message)
+    end
+    
+    it 'should return the value returned by the class method' do
+      @punch.log(@message).should == @log
+    end
+  end
+end

data/spec/punch_spec.rb

@@ -34,7 +34,7 @@ describe Punch do
       
       Punch.instance_eval do
         class << self
-          public :data
+          public :data, :data=
         end
       end
       
@@ -71,6 +71,19 @@ describe Punch do
         Punch.load.should == false
       end
     end
+    
+    describe 'and returning data' do
+      it 'should return the data if set' do
+        val = { 'rip' => [] }
+        Punch.data = val
+        Punch.data.should == val
+      end
+      
+      it 'should load the data if not set' do
+        Punch.data = nil
+        Punch.data.should == YAML.load(@data)
+      end
+    end
   end
   
   it 'should reset itself' do
@@ -89,7 +102,7 @@ describe Punch do
     it 'should set its data to nil' do
       Punch.data = { 'proj' => 'lots of stuff here' }
       Punch.reset
-      Punch.data.should be_nil
+      Punch.instance_variable_get('@data').should be_nil
     end
   end
   
@@ -363,7 +376,7 @@ describe Punch do
       
       it 'should create the project' do
         Punch.in(@project)
-        Punch.data.should include(@project)
+        Punch.data.should have_key(@project)
       end
       
       it 'should add a time entry to the project data' do
@@ -607,7 +620,7 @@ describe Punch do
     describe 'when the project exists' do
       it 'should remove the project data' do
         Punch.delete(@project)
-        Punch.data.should_not include(@project)
+        Punch.data.should_not have_key(@project)
       end
       
       it 'should return true' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: one_inch_punch
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-23 00:00:00 -05:00
+date: 2008-11-05 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,12 +67,14 @@ files:
 - lib/punch/core_ext.rb
 - lib/punch/core_ext/fixnum.rb
 - lib/punch/version.rb
+- lib/punch/instance.rb
 - script/console
 - script/destroy
 - script/generate
 - setup.rb
 - spec/fixnum_spec.rb
 - spec/punch_command_spec.rb
+- spec/punch_instance_spec.rb
 - spec/punch_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -103,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yomendel
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: a simple time-tracking tool