File and File Container Wrapper

UPDATED WIKI: Home

bsimser — Wed, 19 Dec 2007 21:21:05 GMT

Project Description
This is a set of interfaces, tests, and sample implementations for wrapping up file systems and file containers.

How many times have you written some code to test simple file systems? Or folders? Or zip files?

This library is a lightweight set of components for making working with file systems (or things that contain files) easier, testable, and flexible. The components demonstrate a use case for abstraction, polymorphism, interface-based programming, and the Strategy Pattern as each implementation of the contract described here is a strategy.

The API documentation contains the interfaces with documentation for each method. The Sample Usage contains implementations of the IFile and IFileContainer using Files, Folders, and a Zip File (which implements IFileContainer) using SharpZipLib to do the work of the zipping of files.

The solution consists of three projects:

FileStrategyLib.Interface contains the IFile and IFileContainer interfaces.
FileStrategyLib.Test contains the unit tests for the file, folder, and zip file wrappers
FileStrategyLib contains the implementation of the interfaces for files (IFile), folders (IFileContainer) and zip files (IFileContainer)

The Unit Test project provides tests for creating files and directories as well as excercising the zip implementation. The Unit Tests are self contained and clean up after themselves.

You can download the latest release from here.

API Documentation
Sample Usage

What could you do with this? There are lots of things you can consider to treat like a file/file container. For example:

SharePoint Document Libraries
Database blobs that contain Documents
Other types of file compressors (Zip, RAR, CAB, etc.)
FTP sites

Have fun and please feel free to expand or extend this. The original code was written for a simple project where all that was needed was add and delete. Of course you may need additional functionality like extracting files from a container, etc.

Feel free to submit patches to the library or samples for additional usage.

UPDATED WIKI: Home

bsimser — Wed, 19 Dec 2007 21:20:52 GMT

FileStrategyLib.Interface contains the IFile and IFileContainer interfaces.
FileStrategyLib.Test contains the unit tests for the file, folder, and zip file wrappers
FileStrategyLib contains the implementation of the interfaces for files (IFile), folders (IFileContainer) and zip files (IFileContainer)

The Unit Test project provides tests for creating files and directories as well as excercising the zip implementation. The Unit Tests are self contained and clean up after themselves.

You can download the latest release from here.

API Documentation
Sample Usage

What could you do with this? There are lots of things you can consider to treat like a file/file container. For example:

SharePoint Document Libraries
Database blobs that contain Documents
Other types of file compressors (Zip, RAR, CAB, etc.)
FTP sites

Source code checked in

bsimser — Tue, 18 Dec 2007 01:24:42 GMT

Bound solution and projects to source contro. TFS sucks the big one.

Source code checked in

bsimser — Tue, 18 Dec 2007 01:22:37 GMT

Initial checkin of source tree.

UPDATED WIKI: Home

bsimser — Mon, 17 Dec 2007 19:15:45 GMT

FileStrategyLib.Interface contains the IFile and IFileContainer interfaces.
FileStrategyLib.Test contains the unit tests for the file, folder, and zip file wrappers
FileStrategyLib contains the implementation of the interfaces for files (IFile), folders (IFileContainer) and zip files (IFileContainer)

The Unit Test project provides tests for creating files and directories as well as excercising the zip implementation. The Unit Tests are self contained and clean up after themselves.

You can download the latest release from here.

API Documentation
Sample Usage

What could you do with this? There are lots of things you can consider to treat like a file/file container. For example:

SharePoint Document Libraries
Database blobs that contain Documents
Other types of file compressors (Zip, RAR, CAB, etc.)
FTP sites

UPDATED WIKI: Sample Usage

bsimser — Mon, 17 Dec 2007 18:52:46 GMT

Sample Usage

        public void Create(string name)
        {
            FileStream stream = File.Create(name);
            stream.Close();
        }
 
        public void Delete(string name)
        {
            File.Delete(name);
        }

IFileContainer implementation using the local file system
This implementation of the IFileContainer interface lets you add/remove files from a folder and get information about the files in the folder. This is included in the FileStrategyLib.dll:

        public void Create(string name)
        {
            _directoryName = name;
            Directory.CreateDirectory(_directoryName);
        }
 
        public void Delete(string name)
        {
            Directory.Delete(name, true);
        }
 
        public void Add(string sourceFile)
        {
            string destinationFile = formatFullPath(sourceFile);
            File.Copy(sourceFile, destinationFile, true);
        }
 
        public void Add(string sourceFile, bool useCompression)
        {
            throw new NotImplementedException();
        }
 
        public int FileCount
        {
            get { return Directory.GetFiles(_directoryName).Length; }
        }
 
        public long GetSizeFor(string fileName)
        {
            byte[] bytes = File.ReadAllBytes(formatFullPath(fileName));
            return bytes.Length;
        }

IFileContainer implementation using the SharpZipLib library for creating zip files
This a more advanced implementation of IFileContainer where the purpose is to create zip files. It implements the same interfaces as the the Folder class but uses the SharpZipLib ZipFile object to hold it's information about files (rather than folders or some other container).

        private ZipFile _zipfile;
 
        public void Add(string sourceFile)
        {
            Add(sourceFile, true);
        }
 
        public void Add(string sourceFile, bool useCompression)
        {
            _zipfile.BeginUpdate();
            if (useCompression)
                _zipfile.Add(sourceFile, CompressionMethod.Deflated);
            else
                _zipfile.Add(sourceFile, CompressionMethod.Stored);
            _zipfile.CommitUpdate();
        }
 
        public int FileCount
        {
            get { return Convert.ToInt32(_zipfile.Count); }
        }
 
        public long GetSizeFor(string fileName)
        {
            ZipEntry entry = _zipfile.GetEntry(fileName);
            return entry.CompressedSize;
        }
 
        public void Create(string name)
        {
            _zipfile = ZipFile.Create(name);
        }
 
        public void Delete(string name)
        {
            _zipfile.Close();
            File.Delete(name);
        }

UPDATED WIKI: Sample Usage

bsimser — Mon, 17 Dec 2007 18:52:28 GMT

Sample Usage

        public void Create(string name)
        {
            FileStream stream = File.Create(name);
            stream.Close();
        }
 
        public void Delete(string name)
        {
            File.Delete(name);
        }

        public void Create(string name)
        {
            _directoryName = name;
            Directory.CreateDirectory(_directoryName);
        }
 
        public void Delete(string name)
        {
            Directory.Delete(name, true);
        }
 
        public void Add(string sourceFile)
        {
            string destinationFile = formatFullPath(sourceFile);
            File.Copy(sourceFile, destinationFile, true);
        }
 
        public void Add(string sourceFile, bool useCompression)
        {
            throw new NotImplementedException();
        }
 
        public int FileCount
        {
            get { return Directory.GetFiles(_directoryName).Length; }
        }
 
        public long GetSizeFor(string fileName)
        {
            byte[] bytes = File.ReadAllBytes(formatFullPath(fileName));
            return bytes.Length;
        }

IFileContainer implementation using the SharpZipLib library for creating zip files
This a more advanced implementation of IFileContainer where the purpose is to create zip files. It implements the same interfaces as the the Folder class but uses the SharpZipLib ZipFile object to hold it's information about files (rather than folders or some other container).

        private ZipFile _zipfile;
 
        public void Add(string sourceFile)
        {
            Add(sourceFile, true);
        }
 
        public void Add(string sourceFile, bool useCompression)
        {
            _zipfile.BeginUpdate();
            if (useCompression)
                _zipfile.Add(sourceFile, CompressionMethod.Deflated);
            else
                _zipfile.Add(sourceFile, CompressionMethod.Stored);
            _zipfile.CommitUpdate();
        }
 
        public int FileCount
        {
            get { return Convert.ToInt32(_zipfile.Count); }
        }
 
        public long GetSizeFor(string fileName)
        {
            ZipEntry entry = _zipfile.GetEntry(fileName);
            return entry.CompressedSize;
        }
 
        public void Create(string name)
        {
            _zipfile = ZipFile.Create(name);
        }
 
        public void Delete(string name)
        {
            _zipfile.Close();
            File.Delete(name);
        }

UPDATED WIKI: Sample Usage

bsimser — Mon, 17 Dec 2007 18:50:34 GMT

Sample Usage

        public void Create(string name)
        {
            FileStream stream = File.Create(name);
            stream.Close();
        }
 
        public void Delete(string name)
        {
            File.Delete(name);
        }

        public void Create(string name)
        {
            _directoryName = name;
            Directory.CreateDirectory(_directoryName);
        }
 
        public void Delete(string name)
        {
            Directory.Delete(name, true);
        }
 
        public void Add(string sourceFile)
        {
            string destinationFile = formatFullPath(sourceFile);
            File.Copy(sourceFile, destinationFile, true);
        }
 
        public void Add(string sourceFile, bool useCompression)
        {
            throw new NotImplementedException();
        }
 
        public int FileCount
        {
            get { return Directory.GetFiles(_directoryName).Length; }
        }
 
        public long GetSizeFor(string fileName)
        {
            byte[] bytes = File.ReadAllBytes(formatFullPath(fileName));
            return bytes.Length;
        }

UPDATED WIKI: Home

bsimser — Mon, 17 Dec 2007 18:44:09 GMT

FileStrategyLib.Interface contains the IFile and IFileContainer interfaces.
FileStrategyLib.Test contains the unit tests for the file, folder, and zip file wrappers
FileStrategyLib contains the implementation of the interfaces for files (IFile), folders (IFileContainer) and zip files (IFileContainer)

The Unit Test project provides tests for creating files and directories as well as excercising the zip implementation. The Unit Tests are self contained and clean up after themselves.

You can download the latest release from here.

API Documentation
Sample Usage

Have fun and please feel free to expand or extend this. The original code was written for a simple project where all that was needed was add and delete. Of course you may need additional functionality like extracting files from a container, etc.

Feel free to submit patches to the library or samples for additional usage.

RELEASED: 1.0 (Dec 17, 2007)

Mon, 17 Dec 2007 18:41:44 GMT

Initial release.

UPDATED RELEASE: 1.0 (Dec 17, 2007)

Mon, 17 Dec 2007 18:41:44 GMT

Initial release.

UPDATED WIKI: Sample Usage

bsimser — Mon, 17 Dec 2007 18:39:37 GMT

Sample Usage

Here are some sample implementations of the interfaces. These implementations are available in the binary package as FileStrategyLib.dll and in the source solution under the FileStrategyLib project.

IFile implementation using the local file system
TODO: provide sample documentation

IFileContainer implementation using the local file system
TODO: provide sample documentation

IFileContainer implementation using the SharpZipLib library for creating zip files
This a more advanced implementation of IFileContainer where the purpose is to create zip files.

TODO: provide sample documentation

UPDATED WIKI: Home

bsimser — Mon, 17 Dec 2007 18:38:49 GMT

FileStrategyLib.Interface contains the IFile and IFileContainer interfaces.
FileStrategyLib.Test contains the unit tests for the file, folder, and zip file wrappers
FileStrategyLib contains the implementation of the interfaces for files (IFile), folders (IFileContainer) and zip files (IFileContainer)

The Unit Test project provides tests for creating files and directories as well as excercising the zip implementation. The Unit Tests are self contained and clean up after themselves.

(TODO: add release links for downloading the source and binary packages)

API Documentation
Sample Usage

Have fun and please feel free to expand or extend this. The original code was written for a simple project where all that was needed was add and delete. Of course you may need additional functionality like extracting files from a container, etc.

Feel free to submit patches to the library or samples for additional usage.

UPDATED WIKI: Sample Usage

bsimser — Mon, 17 Dec 2007 17:27:27 GMT

Sample Usage

Here are some sample implementations of the interfaces. These implementations are available in the binary package as BilSimser.FileStrategy.dll and in the source solution under the BilSimser.FileStrategy project.

IFile implementation using the local file system
TODO: provide sample documentation

IFileContainer implementation using the local file system
TODO: provide sample documentation

IFileContainer implementation using the SharpZipLib library for creating zip files
This a more advanced implementation of IFileContainer where the purpose is to create zip files.

TODO: provide sample documentation

UPDATED WIKI: Home

bsimser — Mon, 17 Dec 2007 17:24:01 GMT

BilSimser.FileStrategy.Interface contains the IFile and IFileContainer interfaces.
BilSimser.FileStrategy.Test contains the unit tests for the file, folder, and zip file wrappers
BilSimser.FileStrategy contains the implementation of the interfaces for files (IFile), folders (IFileContainer) and zip files (IFileContainer)

The Unit Test project provides tests for creating files and directories as well as excercising the zip implementation. The Unit Tests are self contained and clean up after themselves.

(TODO: add release links for downloading the source and binary packages)

API Documentation
Sample Usage

Have fun and please feel free to expand or extend this. The original code was written for a simple project where all that was needed was add and delete. Of course you may need additional functionality like extracting files from a container, etc.

Feel free to submit patches to the library or samples for additional usage.

UPDATED WIKI: Home

bsimser — Mon, 17 Dec 2007 17:23:03 GMT

Project Description
This is a set of interfaces, tests, and sample implementations for wrapping up file systems and file containers.

How many times have you written some code to test simple file systems? Or folders? Or zip files?

This library is a lightweight set of components for making working with file systems (or things that contain files) easier, testable, and flexible. The components demonstrate a use case for abstraction, polymorphism, interface-based programming, and the Strategy Pattern as each implementation of the contract described here is a strategy.

The API documentation contains the interfaces with documentation for each method. The Sample Usage contains implementations of the IFile and IFileContainer using Files, Folders, and a Zip File (which implements IFileContainer) using http://www.icsharpcode.net/OpenSource/SharpZipLib/ to do the work of the zipping of files.

The solution consists of three projects:

BilSimser.FileStrategy.Interface contains the IFile and IFileContainer interfaces.
BilSimser.FileStrategy.Test contains the unit tests for the file, folder, and zip file wrappers
BilSimser.FileStrategy contains the implementation of the interfaces for files (IFile), folders (IFileContainer) and zip files (IFileContainer)

The Unit Test project provides tests for creating files and directories as well as excercising the zip implementation. The Unit Tests are self contained and clean up after themselves.

(TODO: add release links for downloading the source and binary packages)

API Documentation
Sample Usage

Have fun and please feel free to expand or extend this. The original code was written for a simple project where all that was needed was add and delete. Of course you may need additional functionality like extracting files from a container, etc.

Feel free to submit patches to the library or samples for additional usage.

UPDATED WIKI: API Documentation

bsimser — Mon, 17 Dec 2007 17:15:18 GMT

API Documentation

The API for the system is very simple. Any file wrapper or file container wrapper must implement the following interfaces:

    public interface IFile
    {
        void Create(string name);
        void Delete(string name);
    }

    public interface IFileContainer : IFile
    {
        int FileCount { get; }
        void Add(string sourceFile);
        void Add(string sourceFile, bool useCompression);
        long GetSizeFor(string fileName);
    }

Below is a description for each interface method:

IFile.Create(string filename)
This creates a new file with the supplied filename.

IFile.Delete(string filename)
This deletes a file from the system based on the supplied filename.

IFileContainer.FileCount
This is a property that will return the number of files in the container.

IFileContainer.Add(string filename)
This method adds an existing file to the container.

IFileContainer.Add(string filename, bool useCompression)
This method adds an existing file to the container but uses compression. This was added to the interface for the purpose of supporting containers that support compression. It is left unimplemented for a folder and will throw a System.NotImplementedException exception.

IFileContainer.GetSizeFor(string filename)

For sample implemenations of the wrappers see FileStrategy, FolderStrategy, and SharpLibZipFileStrategy in the source code and here on this wiki.

Note: As IFileContainer inherits its interface from IFile, you must provide implementations the Create and Delete methods in your container.

UPDATED WIKI: API Documentation

bsimser — Mon, 17 Dec 2007 17:14:56 GMT

API Documentation

The API for the system is very simple. Any file wrapper or file container wrapper must implement the following interfaces:

    public interface IFile
    {
        void Create(string name);
        void Delete(string name);
    }

    public interface IFileContainer : IFile
    {
        int FileCount { get; }
        void Add(string sourceFile);
        void Add(string sourceFile, bool useCompression);
        long GetSizeFor(string fileName);
    }

UPDATED WIKI: Home

bsimser — Mon, 17 Dec 2007 17:06:04 GMT

Project Description
This is a set of interfaces, tests, and sample implementations for wrapping up file systems and file containers.

How many times have you written some code to test simple file systems? Or folders? Or zip files?

This is a set of components for making working with file systems (or things that contain files) easier, testable, and flexible. The components demonstrate a use case for abstraction, polymorphism, interface-based programming, and the Strategy Pattern as each implementation of the contract described here is a strategy.

API Documentation
Sample Usage

Have fun and please feel free to expand or extend this. The original code was written for a simple project where all that was needed was add and delete. Of course you may need additional functionality like extracting files from a container, etc.

UPDATED WIKI: Home

bsimser — Mon, 17 Dec 2007 17:05:17 GMT

Project Description
This is a set of interfaces, tests, and sample implementations for wrapping up file systems and file containers.

How many times have you written some code to test simple file systems? Or folders? Or zip files?

This is a set of components for making working with file systems (or things that contain files) easier, testable, and flexible. The components demonstrate a use case for abstraction, polymorphism, interface-based programming, and the Strategy Pattern as each implementation of the contract described here is a strategy.

code and examples

In your own applications, you could use an IoC tool like Windsor.Container to resolve the interfaces to real objects like this:

example

Have fun and please feel free to expand or extend this. The original code was written for a simple project where all that was needed was add and delete. Of course you may need additional functionality like extracting files from a container, etc.