filestore 0.0.2

data/lib/action.rb

@@ -0,0 +1,56 @@
+#
+# action.rb
+# @author Thomas Stätter
+# @date 09.07.2012
+# @description Library using a file system as storage for arbitrary files
+#
+$:.unshift('.')
+
+require 'filestore.rb'
+
+module FileStore
+
+	class Action
+		@@DATE_FORMAT = '%d.%m.%Y %H:%M:%S:%L'
+		
+		@@STATUS_NOT_STARTED 	= "NOT STARTED"
+		@@STATUS_SUCCESS 		= "SUCCESS"
+		@@STATUS_FAILURE		= "FAILURE"
+		
+		@type = 'UNDEFINED'
+		
+		def initialize(id)
+			raise FileStoreException, "No identifier given for action" if id.nil?
+			raise FileStoreException, "Identifier can only be of type String or Numeric" if (not id.is_a?(String) and not id.is_a?(Numeric))
+			raise FileStoreException, "Identifier can't be empty" if id.is_a?(String) and id == ''
+			
+			@identifier = id
+			@status = @@STATUS_NOT_STARTED
+		end
+		
+		def execute(&block)
+			@start = Date.today.strftime @@DATE_FORMAT
+			
+			begin
+				block.call
+				@end = Date.today.strftime @@DATE_FORMAT
+			rescue Exception => e
+				@status = @@STATUS_FAILURE
+				raise FileStoreException, 'Caught exception while executing action', e.backtrace
+			else
+				@status = @@STATUS_SUCCESS
+			end
+		end
+		
+		def to_s
+			"#{@status} - #{@start} - #{self.class.name} - #{@msg} - #{@end} - #{@identifier}"
+		end
+	end
+	
+	class AddAction < Action
+	end
+	
+	class DeleteAction < Action
+	end
+
+end

data/lib/filestore.rb

@@ -0,0 +1,108 @@
+#
+# filestore.rb
+# @author Thomas Stätter
+# @date 09.07.2012
+# @description Library using a file system as storage for arbitrary files
+#
+
+$:.unshift('.')
+
+require 'uuidtools'
+require 'fileutils'
+require 'action.rb'
+require 'log.rb'
+require 'meta.rb'
+
+module FileStore
+
+	class FileStoreException < Exception
+	end
+
+	class FileStore
+		@@STORE_ROOT = 'filestore'
+		@@DELETED_ROOT = 'deleted'
+		
+		def initialize(basePath = ".", metaManager)
+			raise FileStoreException, "Invalid base path given" if (basePath.nil? or 
+				not File.exists?(basePath) or
+				not File.directory?(basePath) or
+				not basePath.is_a?(String) or
+				basePath == '')
+		
+			@storePath = File.join(basePath, @@STORE_ROOT)
+			@deletedPath = File.join(basePath, @@DELETED_ROOT)
+			
+			begin
+				FileUtils.mkdir_p(@storePath) if not Dir.exists?(@storePath)
+				FileUtils.mkdir_p(@deletedPath) if not Dir.exists?(@deletedPath)
+			rescue StandardError => e
+				raise FileStoreException, "Couldn't create store directories", e.backtrace
+			end
+			
+			# needs no specific exception handling dew to the fact, that the directories
+			# could be created
+			@logger = Log.new(basePath)
+			
+			raise FileStoreException, "No meta manager given" if not metaManager.is_a? MetaManager
+			@metaManager = metaManager
+		end
+		
+		def <<(path)
+			id = ''
+			
+			if File.exists?(path) and File.readable?(path) then
+				id = UUIDTools::UUID.random_create.to_s
+				action = AddAction.new(id)
+				
+				action.execute {
+					dstPath = move(@storePath, id, path)
+					
+					raise "Couldn't move file" if dstPath == ''
+					
+					@metaManager << MetaData.new(id, { MetaData::FIELD_PATH => dstPath })
+				}
+				
+				@logger << action
+			else
+				raise FileStoreException, "File is not readable"
+			end
+			
+			id
+		end
+		
+		def -(id)
+			if @metaManager[id] != nil then
+				action = DeleteAction.new(id)
+				
+				action.execute {
+					raise "Couldn't move file" if move(@deletedPath, id, @metaManager[id].path) == ''
+					@metaManager - id
+				}
+				
+				@logger << action
+			else
+				raise FileStoreException, "Key not found"
+			end
+		end
+		
+		private
+		
+		def move(basePath, id, srcPath)
+			dstPath = ''
+			
+			begin
+				date = Date.today
+				dstPath = File.join(basePath, date.year.to_s, date.month.to_s, date.day.to_s, id)
+				dstDir = File.dirname(dstPath)
+				
+				(FileUtils.mkdir_p(dstDir) and puts "creating #{dstDir}") if not Dir.exists?(dstDir)
+				FileUtils.mv(srcPath, dstPath)
+			rescue Exception => e
+				raise FileStoreException, "Couldn't move file", e.backtrace
+			ensure
+				return dstPath
+			end
+		end
+	end
+
+end

data/lib/log.rb

@@ -0,0 +1,40 @@
+#
+# log.rb
+# @author Thomas Stätter
+# @date 09.07.2012
+# @description Library using a file system as storage for arbitrary files
+#
+$:.unshift('.')
+
+require 'filestore.rb'
+
+module FileStore
+
+	class Log
+		FILE = 'filestore-actions.log'
+		
+		def initialize(path = '.')
+			begin
+				@logPath = File.join(path, FILE)
+				@logFile = File.new(@logPath, 'a+')
+			rescue StandardError => e
+				raise FileStoreException, "Initialization of logger failed", e.backtrace
+			end
+		end
+		
+		def <<(action)
+			return if not action.is_a? Action				
+			
+			@logFile.puts action.to_s
+		end
+		
+		def close
+			begin
+				@logFile.close
+			rescue StandardError => e
+				raise FileStoreException, "Couldn't properly close the logger", e.backtrace
+			end
+		end
+	end
+
+end

data/lib/meta.rb

@@ -0,0 +1,81 @@
+#
+# meta.rb
+# @author Thomas Stätter
+# @date 10.07.2012
+# @description Library using a file system as storage for arbitrary files
+#
+$:.unshift('.')
+
+require 'filestore.rb'
+
+module FileStore
+
+	class MetaManager
+		
+		def initialize 
+			yield 
+		end
+		
+		def <<(md)
+		end
+		
+		def -(id)
+		end
+		
+	end
+	
+	class MemoryMetaManager < MetaManager
+		
+		def initialize
+			# must be a hash object
+			@mgmt = super
+			
+			raise FileStoreException, "MemoryMetamanager needs a not nil hash object for initialization" if not @mgmt.is_a?(Hash) or @mgmt.nil?
+		end
+		
+		def <<(md)
+			raise FileStoreException, "Can't add 'nil' to the store" if md.nil?
+			raise FileStoreException, "Only objects of type 'FileStore::MetaData' can be added to the store" if not md.instance_of?(MetaData)
+			
+			@mgmt[md.key] = md
+		end
+		
+		def -(id)
+			raise FileStoreException, "Can't remove 'nil' from the store" if id.nil?
+			
+			@mgmt.delete(id) if @mgmt.has_key?(id)
+		end
+		
+		def [](id)
+			raise FileStoreException, "Can't read 'nil' from the store" if id.nil?
+			
+			return @mgmt[id] if @mgmt.has_key?(id)
+			nil
+		end
+		
+	end
+	
+	class MetaData
+		FIELD_PATH 		= 'path'
+		FIELD_FILENAME 	= 'filename'
+	
+		attr_reader :key, :data
+	
+		def initialize(key, data)
+			raise FileStoreException, "No identifier given for meta data" if key.nil?
+			raise FileStoreException, "Identifier can only be of type String or Numeric" if (not key.is_a?(String) and not key.is_a?(Numeric))
+			raise FileStoreException, "No data given" if data.nil?
+			raise FileStoreException, "Data can only be of type Hash" if not data.is_a?(Hash)
+			raise FileStoreException, "Identifier can't be empty" if key.is_a?(String) and key == ''
+			
+			@key = key
+			@data = data
+		end
+		
+		def path
+			@data[FIELD_PATH]
+		end
+				
+	end
+
+end

data/test/tc_action.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+#
+# tc_action.rb
+# @author Thomas Stätter
+# @date 10.07.2012
+# @description Unit test for classes in meta.rb
+#
+
+# execute test using: ruby -I ../lib/ tc_action.rb
+
+require "test/unit"
+require "../lib/filestore.rb"
+
+class TestAction < Test::Unit::TestCase
+
+	def test_init
+		# initialization of an instance of FileStore::Action should raise an
+		# exception if no identifier is given or the identifier is not a string or
+		# numeric
+		assert_raise(FileStore::FileStoreException, ArgumentError) { FileStore::Action.new }
+		assert_raise(FileStore::FileStoreException, ArgumentError) { FileStore::Action.new(nil) }
+		assert_raise(FileStore::FileStoreException, ArgumentError) { FileStore::Action.new([]) }
+		# identifier can't be an empty string if it's a String
+		assert_raise(FileStore::FileStoreException) { FileStore::Action.new('') }
+		assert_nothing_raised(Exception) { FileStore::Action.new("asdf") }
+		assert_nothing_raised(Exception) { FileStore::Action.new(213123) }
+	end
+	
+	def test_execute
+		# execution should fail if no block is given
+		assert_raise(TypeError, FileStore::FileStoreException) {
+			action = FileStore::Action.new("asdf")
+			action.execute
+		}
+	end
+	
+	def test_string
+		# execution shouldn't fail in any case
+		assert_nothing_raised(Exception) { FileStore::Action.new("asdf").to_s }
+		assert_nothing_raised(Exception) { FileStore::Action.new(123).to_s }
+		assert_nothing_raised(Exception) { 
+			action = FileStore::Action.new("asdf")
+			action.execute {}
+			action.to_s
+		}
+	end
+
+end

data/test/tc_filestore.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+#
+# tc_filestore.rb
+# @author Thomas Stätter
+# @date 10.07.2012
+# @description Unit test for classes in filestore.rb
+#
+# execute test using: ruby -I ../lib/ tc_filestore.rb
+
+require "test/unit"
+require '../lib/filestore.rb'
+
+class TestFileStore < Test::Unit::TestCase
+	BASE_PATH = "./data"
+	
+	def test_init
+		# should work
+		assert_nothing_raised { FileStore::FileStore.new(BASE_PATH, FileStore::MemoryMetaManager.new {{}}) }
+		# shouldn't work, invalid path
+		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new("/some/invalid/path", FileStore::MemoryMetaManager.new {{}}) }
+		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new("", FileStore::MemoryMetaManager.new {{}}) }
+		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new(nil, FileStore::MemoryMetaManager.new {{}}) }
+		# shouldn't work, invalid MetaManager
+		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new(BASE_PATH, {}) }
+		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new(BASE_PATH, nil) }
+	end
+	
+	def test_add
+		mm = FileStore::MemoryMetaManager.new {
+			data = {}
+			
+			Dir.glob(File.join(BASE_PATH, "**", "*")).each { |f|
+				if not File.directory?(f) and File.basename(f) != FileStore::Log::FILE then
+					data[File.basename(f)] = File.absolute_path(f)
+				end
+			}
+			
+			data
+		}
+		fs = FileStore::FileStore.new(BASE_PATH, mm)
+		id = fs << './move_from/test-file-to-move'
+	
+		assert_not_nil(id, "Returned ID can't be nil")	
+		assert_not_same(id, '', "Returned ID can't be empty")
+		assert_instance_of(String, id, "Weird ID returned: #{id}")
+		# should raise an exception
+		assert_raise(FileStore::FileStoreException) { fs << '/some/invalid/file' }
+		
+		# restore the test file
+		`touch ./move_from/test-file-to-move`
+	end
+	
+	def test_remove
+		fs = FileStore::FileStore.new(BASE_PATH, FileStore::MemoryMetaManager.new {{}})
+		
+		# should raise an exception
+		assert_raise(FileStore::FileStoreException) { fs - 'adsfasdf' }
+	end
+	
+end

data/test/tc_log.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+#
+# tc_log.rb
+# @author Thomas Stätter
+# @date 10.07.2012
+# @description Unit test for classes in log.rb
+#
+
+# execute test using: ruby -I ../lib/ tc_log.rb
+
+require "test/unit"
+require "../lib/filestore.rb"
+
+class TestLog < Test::Unit::TestCase
+	
+	def test_init
+		# should be working, default path would be '.'
+		assert_nothing_raised { FileStore::Log.new }
+		# should raise an error, because the path is invalid
+		assert_raise(FileStore::FileStoreException){ FileStore::Log.new('/some/invalid/path')  }
+	end
+	
+	def test_log
+		# shouldn't raise any error (but nothing will happen to the log)
+		logger = FileStore::Log.new
+		
+		assert_nothing_raised { 
+			logger << "asdf" 
+			logger << 2343
+			logger << []
+			logger << FileStore::DeleteAction.new("asdf")
+		}
+	end
+	
+	def test_close
+		logger = FileStore::Log.new
+		
+		assert_nothing_raised { logger.close }
+	end
+end

data/test/tc_meta.rb

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+#
+# tc_meta.rb
+# @author Thomas Stätter
+# @date 10.07.2012
+# @description Unit test for classes in meta.rb
+#
+
+# execute test using: ruby -I ../lib/ tc_meta.rb
+
+require "test/unit"
+require "../lib/filestore.rb"
+
+# Test cases for FileStore::MetaData
+class TestMetaData < Test::Unit::TestCase
+	def test_init
+		# arguments 'key' and 'data' must be provided
+		assert_raise(ArgumentError) { FileStore::MetaData.new }
+		# argument 'key' must be of type String or Numeric
+		assert_raise(FileStore::FileStoreException) { FileStore::MetaData.new({},{}) }
+		assert_nothing_raised(FileStore::FileStoreException) { FileStore::MetaData.new('asdf',{}) }
+		assert_nothing_raised(FileStore::FileStoreException) { FileStore::MetaData.new(234,{}) }
+		# identifier may not be an empty string
+		assert_raise(FileStore::FileStoreException) { FileStore::MetaData.new('',{}) }
+		# data argument may not be nil
+		assert_raise(FileStore::FileStoreException) { FileStore::MetaData.new('asdf',nil) }
+	end
+	
+	def test_accessors
+		# attr_readers for key and data may not return nil
+		md = FileStore::MetaData.new(234,{})
+		
+		assert_not_nil(md.key, "Key can't be nil")
+		assert_not_nil(md.data, "Key can't be nil")
+	end
+	
+	def test_path
+		md = FileStore::MetaData.new(234,{ FileStore::MetaData::FIELD_PATH => '/some/path' })
+		# path may only return a string
+		assert_instance_of(String, md.path, "Path can only be of type string")
+		
+		md = FileStore::MetaData.new(234,{})
+		# path may be nil
+		assert_nil(md.path, "Path is not given although it should be there")
+	end
+end
+
+# Test cases for FileStore::MetaManager
+class TestMetaManager < Test::Unit::TestCase
+	def test_init
+		# should raise a type error if no initialize code is given
+		assert_raise(LocalJumpError) { FileStore::MetaManager.new }
+		assert_nothing_raised(Exception) { FileStore::MetaManager.new {} }
+	end
+end
+
+# Test cases for FileStore::MemoryMetaManager
+class TestMemoryMetaManager < Test::Unit::TestCase
+	def test_init
+		# the init block may only return a not nil hash object 
+		assert_raise(FileStore::FileStoreException){ FileStore::MemoryMetaManager.new {""} }
+		assert_raise(FileStore::FileStoreException){ FileStore::MemoryMetaManager.new { } }
+		assert_nothing_raised(FileStore::FileStoreException){ FileStore::MemoryMetaManager.new {{}} }
+	end
+	
+	def test_add
+		mm = FileStore::MemoryMetaManager.new {{}}
+		
+		assert_raise(FileStore::FileStoreException){ mm << nil }
+		assert_raise(FileStore::FileStoreException){ mm << "asdfasdf" }
+		assert_nothing_raised(FileStore::FileStoreException){ 
+			md = FileStore::MetaData.new(234,{})
+			mm << md
+		}
+	end
+	
+	def test_remove
+		mm = FileStore::MemoryMetaManager.new {{}}
+		
+		assert_raise(FileStore::FileStoreException){ mm - nil }
+		assert_nothing_raised(Exception){ 
+			mm - "asdf"
+			mm - 123123
+			mm - []
+			mm - {}
+			mm - FileStore::MetaData.new(234,{})
+		}
+	end
+	
+	def test_read
+		mm = FileStore::MemoryMetaManager.new {{}}
+		
+		assert_raise(FileStore::FileStoreException){ mm[nil] }
+		assert_nothing_raised(Exception){ 
+			mm[[]] 
+			mm["asdf"]
+			mm[2421]
+		}
+		assert_nil(mm[2343], "Nil wasn't returned althought the given key wasn't existing")
+	end
+end

data/test/ts_gem.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+#
+# ts_gem.rb
+# @author Thomas Stätter
+# @date 10.07.2012
+# @description Test suite for the complete gem
+#
+
+# execute test using: ruby -I../lib/ -I. ts_gem.rb
+$:.unshift('.')
+$:.unshift('../lib')
+
+require "test/unit"
+require 'tc_action.rb'
+require 'tc_meta.rb'
+require 'tc_log.rb'
+require 'tc_filestore.rb'

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: filestore
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Stätter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Organizes a file storage using the file system and some meta data
+email: thomas.staetter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/filestore.rb
+- lib/action.rb
+- lib/log.rb
+- lib/meta.rb
+- test/ts_gem.rb
+- test/tc_action.rb
+- test/tc_log.rb
+- test/tc_meta.rb
+- test/tc_filestore.rb
+- test/move_from/test-file-to-move
+homepage: https://www.xing.com/profile/thomas.staetter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- gem uuidtools
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Simple file storage
+test_files:
+- test/ts_gem.rb
+- test/tc_action.rb
+- test/tc_log.rb
+- test/tc_meta.rb
+- test/tc_filestore.rb
+- test/move_from/test-file-to-move