virtfs-camcorderfs 0.0.1

data/lib/virtfs/camcorderfs/fs/dir_class_methods.rb

@@ -0,0 +1,38 @@
+module VirtFS::CamcorderFS # rubocop:disable Style/ClassAndModuleChildren
+  #
+  # Directory class methods - called by VirtFS::Dir.
+  # Makes recordable call to corresponding CcDelegate method.
+  #
+  class FS
+    module DirClassMethods
+      def dir_delete(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def dir_chdir(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def dir_entries(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def dir_exist?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def dir_foreach(p, &block)
+        return_enum(dir_entries(p), block)
+      end
+
+      def dir_mkdir(p, permissions)
+        ccd_call(__method__, apply_root(p), permissions)
+      end
+
+      def dir_new(fs_rel_path, hash_args, open_path, cwd)
+        instance_handle = ccd_call(__method__, apply_root(fs_rel_path), hash_args, open_path, cwd)
+        VirtFS::CamcorderFS::Dir.new(self, instance_handle, hash_args)
+      end
+    end
+  end
+end

data/lib/virtfs/camcorderfs/fs/dir_instance_methods.rb

@@ -0,0 +1,20 @@
+module VirtFS::CamcorderFS # rubocop:disable Style/ClassAndModuleChildren
+  #
+  # Directory instance methods - called by CamcorderFS::Dir instances - thick interface.
+  # Makes recordable call to corresponding CcDelegate method.
+  #
+  class FS
+    module DirInstanceMethods
+      #
+      # Dir instance methods - delegate to CcDelegate.
+      #
+      def dir_i_close(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def dir_i_each(instance_handle, block, rv)
+        return_enum(ccd_call(__method__, instance_handle), block, rv)
+      end
+    end
+  end
+end

data/lib/virtfs/camcorderfs/fs/file_class_methods.rb

@@ -0,0 +1,179 @@
+module VirtFS::CamcorderFS # rubocop:disable Style/ClassAndModuleChildren
+  #
+  # File class methods - called by VirtFS::File.
+  # Makes recordable call to corresponding CcDelegate method.
+  #
+  class FS
+    module FileClassMethods
+      def file_atime(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_blockdev?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_chardev?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_chmod(permission, p)
+        ccd_call(__method__, permission, apply_root(p))
+      end
+
+      def file_chown(owner, group, p)
+        ccd_call(__method__, owner, group, apply_root(p))
+      end
+
+      def file_ctime(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_delete(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_directory?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_executable?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_executable_real?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_exist?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_file?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_ftype(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_grpowned?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_identical?(p1, p2)
+        ccd_call(__method__, apply_root(p1), apply_root(p2))
+      end
+
+      def file_lchmod(permission, p)
+        ccd_call(__method__, permission, apply_root(p))
+      end
+
+      def file_lchown(owner, group, p)
+        ccd_call(__method__, owner, group, apply_root(p))
+      end
+
+      def file_link(p1, p2)
+        ccd_call(__method__, apply_root(p1), apply_root(p2))
+      end
+
+      def file_lstat(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_mtime(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_owned?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_pipe?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_readable?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_readable_real?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_readlink(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_rename(p1, p2)
+        ccd_call(__method__, apply_root(p1), apply_root(p2))
+      end
+
+      def file_setgid?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_setuid?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_size(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_socket?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_stat(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_sticky?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_symlink(oname, p)
+        #
+        # We don't apply_root to oname, because it's either an
+        # absolute path in the global FS namespace, or a path
+        # relative to the location of the new link.
+        #
+        ccd_call(__method__, oname, apply_root(p))
+      end
+
+      def file_symlink?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_truncate(p, len)
+        ccd_call(__method__, apply_root(p), len)
+      end
+
+      def file_utime(atime, mtime, p)
+        ccd_call(__method__, atime, mtime, apply_root(p))
+      end
+
+      def file_world_readable?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_world_writable?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_writable?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_writable_real?(p)
+        ccd_call(__method__, apply_root(p))
+      end
+
+      def file_new(fs_rel_path, parsed_args, open_path, cwd)
+        instance_handle = ccd_call(__method__, apply_root(fs_rel_path), parsed_args, open_path, cwd)
+        VirtFS::CamcorderFS::File.new(self, instance_handle, parsed_args)
+      end
+    end
+  end
+end

data/lib/virtfs/camcorderfs/fs/file_instance_methods.rb

@@ -0,0 +1,144 @@
+module VirtFS::CamcorderFS # rubocop:disable Style/ClassAndModuleChildren
+  #
+  # File instance methods - called by CamcorderFS::File instances - thick interface.
+  # Makes recordable call to corresponding CcDelegate method.
+  #
+  class FS
+    module FileInstanceMethods
+      #
+      # File instance methods - delegate to CcDelegate.
+      #
+      def file_i_atime(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_chmod(instance_handle, permission)
+        ccd_call(__method__, instance_handle, permission)
+      end
+
+      def file_i_chown(instance_handle, owner, group)
+        ccd_call(__method__, instance_handle, owner, group)
+      end
+
+      def file_i_ctime(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_flock(instance_handle, locking_constant)
+        ccd_call(__method__, instance_handle, locking_constant)
+      end
+
+      def file_i_lstat(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_mtime(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_size(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_truncate(instance_handle, to_size)
+        ccd_call(__method__, instance_handle, to_size)
+      end
+
+      #
+      # IO instance methods.
+      #
+      def file_i_close(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_close_on_exec?(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_close_on_exec=(instance_handle, bool_val)
+        ccd_call(__method__, instance_handle, bool_val)
+      end
+
+      def file_i_close_read(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_close_write(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_fcntl(instance_handle, cmd, arg)
+        ccd_call(__method__, instance_handle, cmd, arg)
+      end
+
+      def file_i_fdatasync(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_fileno(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_flush(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_fsync(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_ioctl(instance_handle, cms, arg)
+        ccd_call(__method__, instance_handle, cms, arg)
+      end
+
+      def file_i_isatty(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_pid(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_raw_read(instance_handle, start_byte, num_bytes)
+        rv = ccd_call(__method__, instance_handle, start_byte, num_bytes)
+        rv.force_encoding('ASCII-8BIT') # Needed when loaded from YAML.
+      end
+
+      def file_i_raw_write(instance_handle, start_byte, buf)
+        ccd_call(__method__, instance_handle, start_byte, buf)
+      end
+
+      def file_i_readpartial(instance_handle, limit, result)
+        ccd_call(__method__, instance_handle, limit, result)
+      end
+
+      def file_i_read_nonblock(instance_handle, limit, result)
+        ccd_call(__method__, instance_handle, limit, result)
+      end
+
+      def file_i_stat(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_sync(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_sync=(instance_handle, bool_val)
+        ccd_call(__method__, instance_handle, bool_val)
+      end
+
+      def file_i_to_i(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_tty?(instance_handle)
+        ccd_call(__method__, instance_handle)
+      end
+
+      def file_i_write_nonblock(instance_handle, buf)
+        ccd_call(__method__, instance_handle, buf)
+      end
+    end
+  end
+end

data/lib/virtfs/camcorderfs/real_dir.rb

@@ -0,0 +1,27 @@
+#
+# When recording calls to instance methods of File and Dir, a reference to
+# the instance is passed to the method call being recorded. During the "record"
+# phase, the target of the call is an instance of "real" File (or Dir).
+#
+# During VirtFS activation, The File constant is mapped to VirtFS::vFile,
+# and a reference to the "real" File class is saved in the VfsRealFile constant.
+#
+# When instanitating an instance of the File class, we need to ensure we always
+# use the "real" File class (as opposed to VirtFS::vFile). However, if we use
+# the VfsRealFile constant to do this, it results in recording an ambiguous
+# instance reference to the cassette. This is because:
+#
+#    VfsRealFile.class.name == File          (not VfsRealFile)
+#    File.class.name        == File          (when not activated)
+#    File.class.name        == VirtFS::vFile (when activated)
+#
+# This results in failed cassette playback during activation because it won't
+# be able to find a VirtFS::vFile entry in the cassette.
+#
+# Using a proper subclass of the "real" File class solves this problem, because:
+#    CcRealFile.class.name == CcRealFile
+#
+module VirtFS::CamcorderFS # rubocop:disable Style/ClassAndModuleChildren
+  class RealDir < VfsRealDir
+  end
+end

data/lib/virtfs/camcorderfs/real_file.rb

@@ -0,0 +1,27 @@
+#
+# When recording calls to instance methods of File and Dir, a reference to
+# the instance is passed to the method call being recorded. During the "record"
+# phase, the target of the call is an instance of "real" File (or Dir).
+#
+# During VirtFS activation, The File constant is mapped to VirtFS::vFile,
+# and a reference to the "real" File class is saved in the VfsRealFile constant.
+#
+# When instanitating an instance of the File class, we need to ensure we always
+# use the "real" File class (as opposed to VirtFS::vFile). However, if we use
+# the VfsRealFile constant to do this, it results in recording an ambiguous
+# instance reference to the cassette. This is because:
+#
+#    VfsRealFile.class.name == File          (not VfsRealFile)
+#    File.class.name        == File          (when not activated)
+#    File.class.name        == VirtFS::vFile (when activated)
+#
+# This results in failed cassette playback during activation because it won't
+# be able to find a VirtFS::vFile entry in the cassette.
+#
+# Using a proper subclass of the "real" File class solves this problem, because:
+#    CcRealFile.class.name == CcRealFile
+#
+module VirtFS::CamcorderFS # rubocop:disable Style/ClassAndModuleChildren
+  class RealFile < VfsRealFile
+  end
+end

data/lib/virtfs/camcorderfs/version.rb

@@ -0,0 +1,5 @@
+module VirtFS
+  module CamcorderFS
+    VERSION = "0.0.1"
+  end
+end