mockfs 0.1.1 → 0.1.2

data/lib/mockfs/override.rb

@@ -0,0 +1,55 @@
+require 'mockfs'
+
+MockFS.mock = true
+
+Object.send( :remove_const, :FileUtils )
+module FileUtils
+	def self.method_missing( symbol, *args, &action )
+		MockFS.file_utils.send( symbol, *args, &action )
+	end
+end
+
+getwd = Dir.getwd
+Object.send( :remove_const, :Dir )
+module Dir
+	def self.method_missing( symbol, *args, &action )
+		MockFS.dir.send( symbol, *args, &action )
+	end
+end
+Dir.module_eval "def self.getwd; '#{ getwd }'; end"
+
+$join_method = File.method :join
+$file_constants = {}
+File.constants.map do |const_str|
+	$file_constants[const_str] = File.const_get const_str.to_sym
+end
+Object.send( :remove_const, :File )
+module File
+	$file_constants.each do |const_str, const_val|
+		self.const_set( const_str, const_val )
+	end
+	
+	def self.join( *args )
+		$join_method.call *args
+	end
+
+	def self.method_missing( symbol, *args, &action )
+		MockFS.file.send( symbol, *args, &action )
+	end
+end
+
+$orig_require = Kernel.method :require
+def require( library_name )
+	begin
+		super
+	rescue LoadError => err
+		file = library_name
+		file += '.rb' unless library_name =~ /\.rb$/
+		if File.exist? file
+			contents = File.open( file ) do |f| f.gets( nil ); end
+			eval contents
+		else
+			raise
+		end
+	end
+end

data/lib/mockfs/override.rb~

@@ -0,0 +1,32 @@
+require 'mockfs'
+
+MockFS.mock = true
+
+Object.send( :remove_const, :FileUtils )
+module FileUtils
+	def self.method_missing( symbol, *args )
+		MockFS.file_utils.send( symbol, *args )
+	end
+end
+
+getwd = Dir.getwd
+Object.send( :remove_const, :Dir )
+module Dir
+	def self.method_missing( symbol, *args )
+		MockFS.dir.send( symbol, *args )
+	end
+end
+Dir.module_eval "def self.getwd; '#{ getwd }'; end"
+
+$join_method = File.method :join
+Object.send( :remove_const, :File )
+module File
+	def self.join( *args )
+		$join_method.call *args
+	end
+
+	def self.method_missing( symbol, *args )
+		MockFS.file.send( symbol, *args )
+	end
+end
+

data/lib/mockfs.rb

@@ -2,12 +2,12 @@
 # It provides mock objects that clone the functionality of File, FileUtils, 
 # Dir, and other in-Ruby file-access libraries.
 # 
-# To use MockFS in your production code, call MockFS.get_[ class ].
+# To use MockFS in your production code, call MockFS.[ class ].
 #
-#   MockFS.get_file               => File
-#   MockFS.get_file_utils         => FileUtils
-#   MockFS.get_dir                => Dir
-#   MockFS.get_dir.entries( '.' ) => [".", "..", ...]
+#   MockFS.file               => File
+#   MockFS.file_utils         => FileUtils
+#   MockFS.dir                => Dir
+#   MockFS.dir.entries( '.' ) => [".", "..", ...]
 #
 # Then, to turn these into mock instances for a test case, simply call
 #
@@ -16,14 +16,75 @@
 # When you've done this, the normal calls will actually return adapters that
 # pretend to be the class in question:
 #
-#   MockFS.get_file               => MockFS::FileAdapter
-#   MockFS.get_file_utils         => MockFS::FileUtilsAdapter
-#   MockFS.get_dir                => MockFS::DirAdapter
-#   MockFS.get_dir.entries( '.' ) => [".", "..", ...]
+#   MockFS.file               => MockFS::FileAdapter
+#   MockFS.file_utils         => MockFS::FileUtilsAdapter
+#   MockFS.dir                => MockFS::DirAdapter
+#   MockFS.dir.entries( '.' ) => [".", "..", ...]
 #
 # You can get direct access to the enclosed MockFileSystem by calling 
 # MockFS.mock_file_system.
 #
+# == Testing example
+#
+# For example, let's test a simple function that moves a log file into
+# somebody's home directory.
+#
+#   require 'mockfs'
+#
+#   def move_log
+#     MockFS.file_utils.mv( '/var/log/httpd/access_log', '/home/francis/logs/' )
+#   end
+#
+# A test of this functionality might look like this:
+#
+#   require 'test/unit'
+#
+#   class TestMoveLog < Test::Unit::TestCase
+#     def test_move_log
+#       # Set MockFS to use the mock file system
+#       MockFS.mock = true
+#
+#       # Fill certain directories
+#       MockFS.fill_path '/var/log/httpd/'
+#       MockFS.fill_path '/home/francis/logs/'
+#
+#       # Create the access log
+#       MockFS.file.open( '/var/log/httpd/access_log', File::CREAT ) do |f|
+#         f.puts "line 1 of the access log"
+#       end
+#
+#       # Run the method
+#       move_log
+#
+#       # Test that it was moved, along with its contents
+#       assert( MockFS.file.exist?( '/home/francis/logs/access_log' ) )
+#       assert( !MockFS.file.exist?( '/var/log/httpd/access_log' ) )
+#       contents = MockFS.file.open( '/home/francis/logs/access_log' ) do |f|
+#         f.gets( nil )
+#       end
+#       assert_equal( "line 1 of the access log\n", contents )
+#     end
+#   end
+#
+# This test will be successful, and it won't litter your real file-system with 
+# testing files.
+#
+# == override.rb
+#
+# Reading the testing example above, you may be struck by one thing: Using
+# MockFS requires you to remember to reference it everywhere, making calls such
+# as MockFS.file_utils.mv instead of just FileUtils.mv. As another option, you
+# can use File, FileUtils, and Dir directly, and then in your tests, substitute 
+# them by including mockfs/override.rb. I'd recommend using these with caution;
+# substituting these low-level classes can have unpredictable results.
+#
+# Including override.rb also allows Kernel.require to look in your
+# mock file system for mock Ruby files to include. You might find this useful
+# if you have configuration files written in Ruby, and you'd like to swap them
+# out for tests. This is pretty experimental, too.
+#
+# == Project page
+#
 # You can view the Rubyforge project page at
 # http://rubyforge.org/projects/mockfs.
 
@@ -33,30 +94,23 @@ require 'fileutils'
 require 'singleton'
 
 module MockFS
-	Version = '0.1.1'
+	Version = '0.1.2'
 
 	@@mock = false
 	
 	def self.method_missing( symbol, *args ) #:nodoc:
 		class_name = nil
 		if symbol.id2name =~ /^get_(.*)/
-			class_name = $1.capitalize
-			class_name.gsub!( /_(\w)/ ) { |s| $1.capitalize }
-			unless %w( Dir File FileUtils ).include?( class_name )
-				class_name = nil
-			end
-		end
-		if class_name
-			if @@mock
-				return_class = Class.by_name( 'MockFS::' + class_name + 'Adapter' )
+			result = self.send( $1, *args )
+			warn "MockFS.#{ symbol.id2name } is deprecated, use #{ $1 } instead"
+			result
+		else
+			klass = real_class_or_mock_class symbol
+			if klass
+				klass
 			else
-				return_class = Class.by_name( class_name )
+				@@mock ? mock_file_system.send( symbol, *args ) : super
 			end
-			return_class || super
-		elsif @@mock
-			mock_file_system.send( symbol, *args )
-		else
-			super
 		end
 	end
 	
@@ -70,6 +124,20 @@ module MockFS
 		@@mock ? MockFileSystem.instance : ( raise RuntimeError )
 	end
 	
+	def self.real_class_or_mock_class( symbol ) #:nodoc:
+		class_name = symbol.id2name.capitalize
+		class_name.gsub!( /_(\w)/ ) { |s| $1.capitalize }
+		if %w( Dir File FileUtils ).include?( class_name )
+			if @@mock
+				Class.by_name( 'MockFS::' + class_name + 'Adapter' )
+			else
+				Class.by_name( class_name )
+			end
+		else
+			nil
+		end
+	end
+	
 	module Adapter #:nodoc:
 		@@delegated_methods = [ :delete, :entries, :mtime ]
 	
@@ -101,7 +169,10 @@ module MockFS
 			unless get_node( dirname ).class == MockFileSystem::MockDir
 				raise Errno::ENOTDIR 
 			end
+			@dirname = dirname
 		end
+		
+		def entries; self.class.entries( @dirname ); end
 	end
 	
 	class FileAdapter #:nodoc:
@@ -124,38 +195,53 @@ module MockFS
 			alias_method :exists?, :exist?
 		end
 		
-		def self.open( fd, mode_string = File::RDONLY, &action )
-			if mode_string.class == String
-				if mode_string == 'w'
-					mode_string = File::WRONLY
-				end
-			end
-			if mode_string == File::RDONLY
-				node = get_node( fd )
-				if node && node.permissions && node.permissions[0] == 0
-					raise Errno::EACCES
-				end
-				result = action.call( node )
-				node.rewind
-				result
+		def self.get_mock_file( fd, mode ) #:nodoc:
+			if mode.read_only?
+				mock_file = get_node( fd )
+				raise Errno::EACCES if mock_file and !mock_file.readable?
 			else
 				path = Path.new( fd ).absolute
 				dir = get_node( path.parent )
-				if ( mode_string & File::APPEND > 0 )
+				if mode.append?
 					mock_file = get_node( fd )
 				else
 					mock_file = MockFileSystem::MockFile.new( dir, path.node, '' )
 				end
-				if ( mode_string & File::APPEND == File::APPEND )
-					mock_file.pos = mock_file.size
-				end
-				action.call( mock_file )
+			end
+			mock_file
+		end
+		
+		def self.open( fd, mode_string = File::RDONLY, &action )
+			mode = Mode.new mode_string
+			mock_file = get_mock_file( fd, mode )
+			mock_file.pos = mock_file.size if mode.append?
+			if action
+				result = action.call( mock_file )
 				mock_file.rewind
-				if ( mode_string & File::APPEND == 0 )
-					dir[path.node] = mock_file
+				if !mode.read_only? and !mode.append?
+					mock_file.parent[Path.new( fd ).absolute.node] = mock_file
 				end
+				result
+			else
+				mock_file
 			end
 		end
+		
+		class Mode
+			def initialize( string_or_bitwise )
+				if string_or_bitwise.is_a?( String )
+					if string_or_bitwise == 'w'
+						@bitwise = File::WRONLY
+					end
+				else
+					@bitwise = string_or_bitwise
+				end
+			end
+			
+			def append?; @bitwise & File::APPEND == File::APPEND; end
+			
+			def read_only?; @bitwise == File::RDONLY; end
+		end
 	end
 	
 	class FileUtilsAdapter #:nodoc:
@@ -164,17 +250,27 @@ module MockFS
 		def self.cp( src, dest, options = {} )
 			file = get_node( src ).clone
 			dest_path = Path.new( dest ).absolute
-			dest_dir = get_node( dest_path.parent )
+			if MockFS.file.exist?( dest )
+				maybe_dest_dir = get_node dest_path
+				if maybe_dest_dir.is_a? MockFileSystem::MockDir
+					dest_path << ( '/' + Path.new( src ).absolute.node )
+				end
+			end
+			dest_dir = get_node dest_path.parent
 			dest_dir[dest_path.node] = file
 			file.name = dest_path.node
 			file.parent = dest_dir
 		end
 		
-		def self.mv( src, dest, options = {} )
-			cp( src, dest, options )
-			MockFS.get_file.delete( src )
+		class << self
+			def mv( src, dest, options = {} )
+				cp( src, dest, options )
+				MockFS.file.delete( src )
+			end
+
+			alias_method :move, :mv
 		end
-	
+		
 		def self.touch( file )
 			begin
 				get_node( file ).mtime = Time.now
@@ -215,6 +311,10 @@ module MockFS
 		
 		module Node #:nodoc:
 			attr_accessor :mtime, :name, :parent, :permissions
+			
+			def readable?
+				!permissions or permissions[0] != 0
+			end
 		end
 		
 		class MockDir < DelegateClass( Hash ) #:nodoc:
@@ -264,8 +364,12 @@ module MockFS
 			
 			def fill_path( dirname )
 				if dirname.size > 1
-					dir = fill_dir( dirname.first )
-					dir.fill_path( dirname[1..-1] )
+					if dirname.first != '..'
+						dir = fill_dir( dirname.first )
+						dir.fill_path( dirname[1..-1] )
+					else
+						parent.fill_path( dirname[1..-1] )
+					end
 				else
 					fill_dir( dirname )
 				end
@@ -290,6 +394,8 @@ module MockFS
 				clone.mtime = @mtime
 				clone
 			end
+			
+			def close; rewind; end
 
 			def delete; parent.delete( self ); end
 			

data/lib/mockfs.rb~

@@ -2,12 +2,12 @@
 # It provides mock objects that clone the functionality of File, FileUtils, 
 # Dir, and other in-Ruby file-access libraries.
 # 
-# To use MockFS in your production code, call MockFS.get_[ class ].
+# To use MockFS in your production code, call MockFS.[ class ].
 #
-#   MockFS.get_file               => File
-#   MockFS.get_file_utils         => FileUtils
-#   MockFS.get_dir                => Dir
-#   MockFS.get_dir.entries( '.' ) => [".", "..", ...]
+#   MockFS.file               => File
+#   MockFS.file_utils         => FileUtils
+#   MockFS.dir                => Dir
+#   MockFS.dir.entries( '.' ) => [".", "..", ...]
 #
 # Then, to turn these into mock instances for a test case, simply call
 #
@@ -16,14 +16,75 @@
 # When you've done this, the normal calls will actually return adapters that
 # pretend to be the class in question:
 #
-#   MockFS.get_file               => MockFS::FileAdapter
-#   MockFS.get_file_utils         => MockFS::FileUtilsAdapter
-#   MockFS.get_dir                => MockFS::DirAdapter
-#   MockFS.get_dir.entries( '.' ) => [".", "..", ...]
+#   MockFS.file               => MockFS::FileAdapter
+#   MockFS.file_utils         => MockFS::FileUtilsAdapter
+#   MockFS.dir                => MockFS::DirAdapter
+#   MockFS.dir.entries( '.' ) => [".", "..", ...]
 #
 # You can get direct access to the enclosed MockFileSystem by calling 
 # MockFS.mock_file_system.
 #
+# == Testing example
+#
+# For example, let's test a simple function that moves a log file into
+# somebody's home directory.
+#
+#   require 'mockfs'
+#
+#   def move_log
+#     MockFS.file_utils.mv( '/var/log/httpd/access_log', '/home/francis/logs/' )
+#   end
+#
+# A test of this functionality might look like this:
+#
+#   require 'test/unit'
+#
+#   class TestMoveLog < Test::Unit::TestCase
+#     def test_move_log
+#       # Set MockFS to use the mock file system
+#       MockFS.mock = true
+#
+#       # Fill certain directories
+#       MockFS.fill_path '/var/log/httpd/'
+#       MockFS.fill_path '/home/francis/logs/'
+#
+#       # Create the access log
+#       MockFS.file.open( '/var/log/httpd/access_log', File::CREAT ) do |f|
+#         f.puts "line 1 of the access log"
+#       end
+#
+#       # Run the method
+#       move_log
+#
+#       # Test that it was moved, along with its contents
+#       assert( MockFS.file.exist?( '/home/francis/logs/access_log' ) )
+#       assert( !MockFS.file.exist?( '/var/log/httpd/access_log' ) )
+#       contents = MockFS.file.open( '/home/francis/logs/access_log' ) do |f|
+#         f.gets( nil )
+#       end
+#       assert_equal( "line 1 of the access log\n", contents )
+#     end
+#   end
+#
+# This test will be successful, and it won't litter your real file-system with 
+# testing files.
+#
+# == override.rb
+#
+# Reading the testing example above, you may be struck by one thing: Using
+# MockFS requires you to remember to reference it everywhere, making calls such
+# as MockFS.file_utils.mv instead of just FileUtils.mv. As another option, you
+# can use File, FileUtils, and Dir directly, and then in your tests, substitute 
+# them by including mockfs/override.rb. I'd recommend using these with caution;
+# substituting these low-level classes can have unpredictable results.
+#
+# Including override.rb also allows Kernel.require to look in your
+# mock file system for mock Ruby files to include. You might find this useful
+# if you have configuration files written in Ruby, and you'd like to swap them
+# out for tests. This is pretty experimental, too.
+#
+# == Project page
+#
 # You can view the Rubyforge project page at
 # http://rubyforge.org/projects/mockfs.
 
@@ -33,30 +94,23 @@ require 'fileutils'
 require 'singleton'
 
 module MockFS
-	Version = '0.1.0'
+	Version = '0.1.1'
 
 	@@mock = false
 	
 	def self.method_missing( symbol, *args ) #:nodoc:
 		class_name = nil
 		if symbol.id2name =~ /^get_(.*)/
-			class_name = $1.capitalize
-			class_name.gsub!( /_(\w)/ ) { |s| $1.capitalize }
-			unless %w( Dir File FileUtils ).include?( class_name )
-				class_name = nil
-			end
-		end
-		if class_name
-			if @@mock
-				return_class = Class.by_name( 'MockFS::' + class_name + 'Adapter' )
+			result = self.send( $1, *args )
+			warn "MockFS.#{ symbol.id2name } is deprecated, use #{ $1 } instead"
+			result
+		else
+			klass = real_class_or_mock_class symbol
+			if klass
+				klass
 			else
-				return_class = Class.by_name( class_name )
+				@@mock ? mock_file_system.send( symbol, *args ) : super
 			end
-			return_class || super
-		elsif @@mock
-			mock_file_system.send( symbol, *args )
-		else
-			super
 		end
 	end
 	
@@ -70,6 +124,20 @@ module MockFS
 		@@mock ? MockFileSystem.instance : ( raise RuntimeError )
 	end
 	
+	def self.real_class_or_mock_class( symbol ) #:nodoc:
+		class_name = symbol.id2name.capitalize
+		class_name.gsub!( /_(\w)/ ) { |s| $1.capitalize }
+		if %w( Dir File FileUtils ).include?( class_name )
+			if @@mock
+				Class.by_name( 'MockFS::' + class_name + 'Adapter' )
+			else
+				Class.by_name( class_name )
+			end
+		else
+			nil
+		end
+	end
+	
 	module Adapter #:nodoc:
 		@@delegated_methods = [ :delete, :entries, :mtime ]
 	
@@ -101,7 +169,10 @@ module MockFS
 			unless get_node( dirname ).class == MockFileSystem::MockDir
 				raise Errno::ENOTDIR 
 			end
+			@dirname = dirname
 		end
+		
+		def entries; self.class.entries( @dirname ); end
 	end
 	
 	class FileAdapter #:nodoc:
@@ -124,38 +195,53 @@ module MockFS
 			alias_method :exists?, :exist?
 		end
 		
-		def self.open( fd, mode_string = File::RDONLY, &action )
-			if mode_string.class == String
-				if mode_string == 'w'
-					mode_string = File::WRONLY
-				end
-			end
-			if mode_string == File::RDONLY
-				node = get_node( fd )
-				if node && node.permissions && node.permissions[0] == 0
-					raise Errno::EACCES
-				end
-				result = action.call( node )
-				node.rewind
-				result
+		def self.get_mock_file( fd, mode ) #:nodoc:
+			if mode.read_only?
+				mock_file = get_node( fd )
+				raise Errno::EACCES if mock_file and !mock_file.readable?
 			else
 				path = Path.new( fd ).absolute
 				dir = get_node( path.parent )
-				if ( mode_string & File::APPEND > 0 )
+				if mode.append?
 					mock_file = get_node( fd )
 				else
 					mock_file = MockFileSystem::MockFile.new( dir, path.node, '' )
 				end
-				if ( mode_string & File::APPEND == File::APPEND )
-					mock_file.pos = mock_file.size
-				end
-				action.call( mock_file )
+			end
+			mock_file
+		end
+		
+		def self.open( fd, mode_string = File::RDONLY, &action )
+			mode = Mode.new mode_string
+			mock_file = get_mock_file( fd, mode )
+			mock_file.pos = mock_file.size if mode.append?
+			if action
+				result = action.call( mock_file )
 				mock_file.rewind
-				if ( mode_string & File::APPEND == 0 )
-					dir[path.node] = mock_file
+				if !mode.read_only? and !mode.append?
+					mock_file.parent[Path.new( fd ).absolute.node] = mock_file
 				end
+				result
+			else
+				mock_file
 			end
 		end
+		
+		class Mode
+			def initialize( string_or_bitwise )
+				if string_or_bitwise.is_a?( String )
+					if string_or_bitwise == 'w'
+						@bitwise = File::WRONLY
+					end
+				else
+					@bitwise = string_or_bitwise
+				end
+			end
+			
+			def append?; @bitwise & File::APPEND == File::APPEND; end
+			
+			def read_only?; @bitwise == File::RDONLY; end
+		end
 	end
 	
 	class FileUtilsAdapter #:nodoc:
@@ -164,17 +250,27 @@ module MockFS
 		def self.cp( src, dest, options = {} )
 			file = get_node( src ).clone
 			dest_path = Path.new( dest ).absolute
-			dest_dir = get_node( dest_path.parent )
+			if MockFS.file.exist?( dest )
+				maybe_dest_dir = get_node dest_path
+				if maybe_dest_dir.is_a? MockFileSystem::MockDir
+					dest_path << ( '/' + Path.new( src ).absolute.node )
+				end
+			end
+			dest_dir = get_node dest_path.parent
 			dest_dir[dest_path.node] = file
 			file.name = dest_path.node
 			file.parent = dest_dir
 		end
 		
-		def self.mv( src, dest, options = {} )
-			cp( src, dest, options )
-			MockFS.get_file.delete( src )
+		class << self
+			def mv( src, dest, options = {} )
+				cp( src, dest, options )
+				MockFS.file.delete( src )
+			end
+
+			alias_method :move, :mv
 		end
-	
+		
 		def self.touch( file )
 			begin
 				get_node( file ).mtime = Time.now
@@ -215,6 +311,10 @@ module MockFS
 		
 		module Node #:nodoc:
 			attr_accessor :mtime, :name, :parent, :permissions
+			
+			def readable?
+				!permissions or permissions[0] != 0
+			end
 		end
 		
 		class MockDir < DelegateClass( Hash ) #:nodoc:
@@ -264,8 +364,12 @@ module MockFS
 			
 			def fill_path( dirname )
 				if dirname.size > 1
-					dir = fill_dir( dirname.first )
-					dir.fill_path( dirname[1..-1] )
+					if dirname.first != '..'
+						dir = fill_dir( dirname.first )
+						dir.fill_path( dirname[1..-1] )
+					else
+						parent.fill_path( dirname[1..-1] )
+					end
 				else
 					fill_dir( dirname )
 				end
@@ -290,6 +394,8 @@ module MockFS
 				clone.mtime = @mtime
 				clone
 			end
+			
+			def close; rewind; end
 
 			def delete; parent.delete( self ); end
 			

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.1
+rubygems_version: 0.8.6
 specification_version: 1
 name: mockfs
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2005-02-23
+  version: 0.1.2
+date: 2005-09-19
 summary: MockFS is a test-obsessed library for mocking out the entire file system.
 require_paths: 
   - lib
-author: Francis Hwang
 email: sera@fhwang.net
 homepage: http://mockfs.rubyforge.org/
 rubyforge_project: 
@@ -27,9 +26,14 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
         version: 0.0.0
   version: 
 platform: ruby
+authors: 
+  - Francis Hwang
 files: 
+  - lib/mockfs
   - lib/mockfs.rb
   - lib/mockfs.rb~
+  - lib/mockfs/override.rb
+  - lib/mockfs/override.rb~
 test_files: []
 rdoc_options: []
 extra_rdoc_files: []