ghaki-ext-file 2011.12.01.1 → 2011.12.03.1

data/lib/ghaki/core_ext/file/spec_helper/fake_temp.rb

@@ -1,3 +1,6 @@
+require 'stringio'
+require 'ghaki/core_ext/file/with_temp'
+
 module Ghaki      #:nodoc:
 module CoreExt    #:nodoc:
 module File       #:nodoc:
@@ -6,9 +9,8 @@ module SpecHelper #:nodoc:
 module FakeTemp
 
   def setup_fake_tempfile
-    @fake_tempfile = stub_everything()
-    File.stubs(:with_opened_temp).yields(@fake_tempfile)
-    File.stubs(:with_named_temp).yields(@fake_tempfile)
+    @fake_tempfile = StringIO.new()
+    ::File.stubs(:with_opened_temp).yields(@fake_tempfile)
   end
 
 end

data/lib/ghaki/core_ext/file/with_temp.rb

@@ -5,29 +5,34 @@ module File    #:nodoc:
 # Helpers dealing with auto-cleaning up temp files.
 module WithTemp
 
-  # Calls block with temp filename then overwrites target filename if no exceptions occur.
-  def with_named_temp final_name
-    tmp_name = ::File.dirname(final_name) +
+  # Generate temp filename from given filename.
+  def make_temp_name final_name
+    ::File.dirname(final_name) +
       ::File::Separator + '_tmp_' + $$.to_s + '.' +
       ::File.basename(final_name)
+  end
+
+  # Calls block with temp filename then overwrites target filename if no exceptions occur.
+  def with_named_temp final_name
+    tmp_name = make_temp_name(final_name)
     yield tmp_name
-    ::File.rename tmp_name, final_name
+    ::File.rename tmp_name, final_name if ::File.exists?(tmp_name)
   ensure
     ::File.unlink tmp_name if ::File.exists?(tmp_name)
   end
 
   # Opens writable temp file, renames to proper name if no exceptions.
-  def with_opened_temp final_name, mode='w', perm=nil
+  def with_opened_temp final_name, mode='w', *args
     with_named_temp final_name do |tmp_name|
-      ::File.open(tmp_name,mode) do |tmp_file|
+      ::File.open(tmp_name,mode,*args) do |tmp_file|
         yield tmp_file
       end
     end
   end
 
   # Simple helper for dumping a string to an output file using a temp.
-  def dump_via_temp data_str, final_name, mode='w', perm=nil
-    with_opened_temp final_name, mode, perm do |tmp_file|
+  def dump_via_temp data_str, final_name, mode='w', *args
+    with_opened_temp final_name, mode, *args do |tmp_file|
       tmp_file.puts data_str
     end
   end

data/spec/ghaki/core_ext/file/spec_helper/fake_temp_spec.rb

@@ -0,0 +1,48 @@
+require 'ghaki/core_ext/file/spec_helper/fake_temp'
+
+describe Ghaki::CoreExt::File::SpecHelper::FakeTemp do
+  include Ghaki::CoreExt::File::SpecHelper::FakeTemp 
+
+  subject { self }
+  it { should respond_to :setup_fake_tempfile }
+
+  before(:each) do
+    setup_fake_tempfile
+  end
+
+  let(:final_name) { 'fake-final-name' }
+  let(:dump_data)  { 'testing-data' }
+
+  describe 'setup_fake_tempfile' do
+    it 'creates fake temp file' do
+      @fake_tempfile.should be_kind_of(StringIO)
+    end
+  end
+
+  describe 'File#with_opened_temp' do
+    it 'does not open temp file' do
+      File.expects(:open).never
+      File.with_opened_temp final_name do |put_file|
+        # do nothing
+      end
+    end
+    it 'yields fake temp file' do
+      File.with_opened_temp final_name do |put_file|
+        put_file.should == @fake_tempfile
+      end
+    end
+  end
+
+  describe 'File#dump_via_temp' do
+    it 'does not open temp file' do
+      File.expects(:open).never
+      File.dump_via_temp dump_data, final_name
+    end
+    it 'writes test data to fake output string' do
+      File.dump_via_temp dump_data, final_name
+      @fake_tempfile.rewind
+      @fake_tempfile.string.chomp.should == dump_data
+    end
+  end
+
+end

data/spec/ghaki/core_ext/file/with_temp_spec.rb

@@ -1,12 +1,103 @@
 require 'ghaki/core_ext/file/with_temp'
+require 'stringio'
 
 describe Ghaki::CoreExt::File::WithTemp do
 
   context 'using extended File' do
     subject { File }
-    it { should respond_to :with_named_temp }
-    it { should respond_to :with_opened_temp }
-    it { should respond_to :dump_via_temp }
+    it { should be_kind_of(Ghaki::CoreExt::File::WithTemp) }
+  end
+
+  let(:final_name) { File.join(File.dirname(__FILE__), 'my-fake-file' ) }
+  let(:temp_name)  { File.join(File.dirname(__FILE__), 'my-fake-temp' ) }
+
+  describe '#make_temp_name' do
+    subject { File.make_temp_name(final_name) }
+
+    it 'uses same dirname' do
+      File.dirname(subject).should == File.dirname(final_name)
+    end
+    it 'uses different basename' do
+      File.basename(subject).should_not == File.basename(final_name)
+    end
+  end
+
+  describe '#with_named_temp' do
+
+    before(:each) do
+      File.expects(:make_temp_name).returns(temp_name).once
+    end
+
+    it 'renames temp to final when successful' do
+      File.expects(:exists?).with(temp_name).returns(true,false).twice
+      File.expects(:rename).with(temp_name,final_name).once
+      File.expects(:unlink).never
+      File.with_named_temp final_name do
+        # do nothing
+      end
+    end
+
+    it 'calls unlink on temp after failure' do
+      File.expects(:exists?).with(temp_name).
+        returns(true).once
+      File.expects(:unlink).with(temp_name).once
+      File.expects(:rename).never
+      lambda do
+        File.with_named_temp final_name do
+          raise RuntimeError, 'testing'
+        end
+      end.should raise_error(RuntimeError)
+    end
+  end
+
+
+  describe '#with_opened_temp' do
+
+    before(:each) do
+      File.expects(:make_temp_name).returns(temp_name).once
+    end
+
+    it 'renames temp to final when successful' do
+      File.expects(:exists?).with(temp_name).returns(true,false).at_most(2)
+      File.expects(:rename).with(temp_name,final_name).once
+      File.expects(:open).with(temp_name,'w').once
+      File.with_opened_temp final_name do
+        # doing nothing
+      end
+    end
+
+    it 'opens temp file for writing' do
+      File.expects(:exists?).with(temp_name).returns(false).at_most(2)
+      File.expects(:open).with(temp_name,'w').once
+      File.with_opened_temp final_name do
+        # doing nothing
+      end
+    end
+
+  end
+
+  describe '#dump_via_temp' do
+
+    let(:dump_data) { 'data-to-dump' }
+
+    before(:each) do
+      File.expects(:make_temp_name).returns(temp_name).once
+      @tmp_file = StringIO.new
+      @tmp_file.expects(:puts).with(dump_data).once
+      File.expects(:open).with(temp_name,'w').yields(@tmp_file).once
+    end
+
+    it 'renames temp to final when successful' do
+      File.expects(:exists?).with(temp_name).returns(true,false).at_most(2)
+      File.expects(:rename).with(temp_name,final_name).once
+      File.dump_via_temp dump_data, final_name
+    end
+    
+    it 'dumps data to opened temp file' do
+      File.expects(:exists?).with(temp_name).returns(false).at_most(2)
+      File.dump_via_temp dump_data, final_name
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghaki-ext-file
 version: !ruby/object:Gem::Version
-  version: 2011.12.01.1
+  version: 2011.12.03.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-02 00:00:00.000000000Z
+date: 2011-12-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &84806470 !ruby/object:Gem::Requirement
+  requirement: &72774220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *84806470
+  version_requirements: *72774220
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &84806240 !ruby/object:Gem::Requirement
+  requirement: &72773990 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.9.4
   type: :development
   prerelease: false
-  version_requirements: *84806240
+  version_requirements: *72773990
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &84806010 !ruby/object:Gem::Requirement
+  requirement: &72773760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *84806010
+  version_requirements: *72773760
 description: Collection of extensions for the core File class
 email: gerald@kalafut.org
 executables: []
@@ -55,6 +55,7 @@ files:
 - lib/ghaki/core_ext/file/with_temp.rb
 - README
 - LICENSE
+- spec/ghaki/core_ext/file/spec_helper/fake_temp_spec.rb
 - spec/ghaki/core_ext/file/with_temp_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ghaki
@@ -82,5 +83,6 @@ signing_key:
 specification_version: 3
 summary: Core File extensions
 test_files:
+- spec/ghaki/core_ext/file/spec_helper/fake_temp_spec.rb
 - spec/ghaki/core_ext/file/with_temp_spec.rb
 - spec/spec_helper.rb