filestore 0.0.5 → 0.0.6

data/lib/filestore.rb

@@ -1,8 +1,8 @@
 #
 # filestore.rb
-# @author Thomas Stätter
-# @date 2012/11/07
-# @description
+#
+# author: Thomas Stätter
+# date: 2012/11/07
 #
 
 require 'meta_manager.rb'
@@ -40,8 +40,10 @@ module FileStore
 		attr_reader :metaManager, :rootPath, :storePath, :deletedPath, :rollbackPath, :metaFile
 		#
 		# Initializes a new instance of SimpleFileStore
-		# @param metaManager The meta data manager instance to be used by this store
-		# @param rootPath The path where the file store resides
+		#
+		# Arguments:
+		# 	metaManager: The meta data manager instance to be used by this store
+		# 	rootPath: The path where the file store resides
 		#
 		def initialize(metaManager, rootPath = '.')
 			raise FileStoreException, "Root path already locked" if SimpleFileStore.is_directory_locked?(rootPath)		
@@ -70,10 +72,14 @@ module FileStore
 		end
 		#
 		# Adds a file to the store
-		# @param file The file to be stored
-		# @param meta Optional meta data to be stored along with the physical file
-		# @param shouldMove Determines wether to original file should be deleted
-		# @returns The newly created ID for the file
+		#
+		# Arguments:
+		# 	file: The file to be stored
+		# 	meta: Optional meta data to be stored along with the physical file
+		# 	shouldMove: Determines wether to original file should be deleted
+		#
+		# Returns:
+		#	The newly created ID for the file
 		#
 		def add(file, meta = {}, shouldMove = true)
 			raise FileStoreException, "File #{file} not found" if not File.exists?(file)
@@ -104,8 +110,12 @@ module FileStore
 		end
 		#
 		# Retrieves a file identified by it's ID
-		# @param id The files ID to retrieve
-		# @returns A hash of file object (:path) and corresponding meta data (:data)
+		#
+		# Arguments:
+		# 	id: The files ID to retrieve
+		#
+		# Returns: 
+		#	A hash of file object (:path) and corresponding meta data (:data)
 		#			representing the file in the store
 		#
 		def get(id)
@@ -121,7 +131,9 @@ module FileStore
 		end
 		#
 		# Moves a file from the current to the deleted store
-		# @param id The ID identifying the file to be moved
+		#
+		# Arguments:
+		# 	id: The ID identifying the file to be moved
 		#
 		def remove(id)
 			raise FileStoreException, "No file ID given for removal" if id == '' or id.nil?
@@ -142,7 +154,9 @@ module FileStore
 		end
 		#
 		# Restores a file identified by it's id
-		# @param id The file ID
+		#
+		# Arguments:
+		# 	id: The file ID
 		#
 		def restore(id)
 			raise FileStoreException, "No file ID given for restore" if id == '' or id.nil?
@@ -211,7 +225,9 @@ module FileStore
 		end
 		#
 		# Creates a new file ID
-		# @returns A string representing the file's ID
+		#
+		# Returns:
+		# 	A string representing the file's ID
 		#
 		def self.get_id(store)
 			for i in 0..2 do	
@@ -240,7 +256,9 @@ module FileStore
 		end
 		#
 		# Setup for a new file store directory
-		# @param store The file store instance to set up
+		#
+		# Arguments:
+		# 	store: The file store instance to set up
 		#
 		def self.create_store(store)
 			Logger.instance.logger.info "Trying to create store in #{store.storePath}"
@@ -272,7 +290,9 @@ module FileStore
 		end
 		#
 		# Recover an existing file store
-		# @param store The file store instance to recover
+		#
+		# Arguments:
+		# 	store: The file store instance to recover
 		#
 		def self.recover_store(store)
 			# trying to recover existing file store

data/lib/log.rb

@@ -1,8 +1,8 @@
 #
 # log.rb
-# @author Thomas Stätter
-# @date 2012/11/07
-# @description 
+#
+# author: Thomas Stätter
+# date: 2012/11/07 
 #
 require 'date'
 require 'log4r'
@@ -10,7 +10,7 @@ require 'singleton'
 
 module FileStore
 	#
-	# Logging facility class
+	# Singleton logging facility class
 	#
 	class Logger
 		include Singleton

data/lib/memory_meta.rb

@@ -1,8 +1,8 @@
 #
 # memory_meta.rb
-# @author Thomas Stätter
-# @date 2012/11/08
-# @description
+#
+# author: Thomas Stätter
+# date: 2012/11/08
 #
 require 'yaml'
 require 'filestore.rb'
@@ -15,17 +15,19 @@ module FileStore
 	#
 	class MemoryMetaManager < MetaManager
 		# Constant defining the default file path
-		@@FILE = './meta.yaml'
+		FILE = 'meta.yaml'
 		# Accessor for the file to store data to
 		attr_reader :file
 		#
 		# Creates a new instance of MemoryMetaManager
-		# @param persistentFile The file where the manager class is persisted to
+		#
+		# Arguments:
+		# 	persistentFile: The file where the manager class is persisted to
 		#
 		def initialize(persistentFile = '')
 			@data = Hash.new
 			@removed = Hash.new
-			@file = (persistentFile.nil? or persistentFile == '')? @@FILE : persistentFile
+			@file = (persistentFile.nil? or persistentFile == '')? MemoryMetaManager::FILE : persistentFile
 			
 			begin
 				if File.exists?(@file)
@@ -43,7 +45,7 @@ module FileStore
 				
 		end
 		#
-		# @see MetaManager::get_data
+		# see: MetaManager::get_data
 		#
 		def get_data(id)
 			raise FileStoreException, "No meta data available for ID #{id}" if not @data.key?(id)
@@ -51,7 +53,7 @@ module FileStore
 			return @data[id]
 		end
 		#
-		# @see MetaManager::add_or_update
+		# see: MetaManager::add_or_update
 		#
 		def add_or_update(id, metaData)
 			raise FileStoreException, "Only hashsets can be added" if not metaData.is_a?(Hash)
@@ -60,7 +62,7 @@ module FileStore
 			@data[id] = (@data.key?(id) ? @data[id].merge!(metaData) : @data[id] = metaData)
 		end
 		#
-		# @see MetaManager::remove
+		# see: MetaManager::remove
 		#
 		def remove(id)
 			raise FileStoreException, "Only Strings can be used as keys" if not id.is_a?(String)
@@ -70,7 +72,7 @@ module FileStore
 			@data.delete(id)
 		end
 		#
-		# @see MetaManager::restore
+		# see: MetaManager::restore
 		#
 		def restore(id)
 			raise FileStoreException, "Only Strings can be used as keys" if not id.is_a?(String)
@@ -80,7 +82,7 @@ module FileStore
 			@removed.delete(id)
 		end
 		#
-		# see MetaManager::shutdown
+		# see: MetaManager::shutdown
 		#
 		def shutdown
 			begin
@@ -94,7 +96,7 @@ module FileStore
 			end
 		end
 		#
-		# @see MetaManager::has_id?
+		# see: MetaManager::has_id?
 		#
 		def has_id?(id)
 			@data.key?(id)

data/lib/meta_manager.rb

@@ -1,8 +1,8 @@
 #
 # meta_manager.rb
-# @author Thomas Stätter
-# @date 2012/11/08
-# @description
+#
+# author: Thomas Stätter
+# date: 2012/11/08
 #
 
 module FileStore
@@ -13,27 +13,37 @@ module FileStore
 	class MetaManager
 		#
 		# Returns the data set identified by the given id
-		# @param ID The ID to be looked for
-		# @returns A hashset containing all stored meta data
+		#
+		# Arguments:
+		#	id: The ID to be looked for
+		#
+		# Returns:
+		#	A hashset containing all stored meta data
 		#
 		def get_data(id)
 		end
 		#
 		# Removes a dataset from the collection
-		# @param id The key to identify the data to be deleted
+		#
+		# Arguments:
+		#	id: The key to identify the data to be deleted
 		#
 		def remove(id)
 		end
 		#
 		# Restores a previously deleted meta data set
-		# @param id The ID of the meta data set to be restored
+		#
+		# Arguments:
+		#	id: The key to identify the data to be deleted
 		#
 		def restore(id)
 		end
 		#
 		# Adds/updates a dataset to/in the collection
-		# @param id The key to identify the data
-		# @param metaData The actual meta data to store
+		#
+		# Arguments:
+		#	id: The key to identify the data to be deleted
+		# 	metaData: The actual meta data to store
 		#
 		def add_or_update(id, metaData)
 		end
@@ -44,7 +54,9 @@ module FileStore
 		end
 		#
 		# Determines wether a given ID is already in use
-		# @param id The ID to be tested
+		#
+		# Arguments:
+		# 	id: The ID to be tested
 		#
 		def has_id?(id)
 		end

data/lib/multitenant_filestore.rb

@@ -1,8 +1,8 @@
 #
 # multitenant_filestore.rb
-# @author Thomas Stätter
-# @date 2012/11/21
-# @description
+#
+# author: Thomas Stätter
+# date: 2012/11/21
 #
 
 require 'filestore.rb'
@@ -32,7 +32,9 @@ module FileStore
 		#
 		# Sets the root path of the multitenant store. As FileStore::MultiTenantFileStore
 		# is a singleton class, this method must be used before any other
-		# @param rootPath The path to be used
+		#
+		# Arguments:
+		# 	rootPath: The path to be used
 		#
 		def set_root_path(rootPath)
 			raise FileStoreException, "Root path #{rootPath} doesn't exist" if not File.exists?(rootPath)
@@ -42,16 +44,20 @@ module FileStore
 		end
 		#
 		# Creates a new file store for a tenant
-		# @param id The optional ID of the tenant. If omitted, an ID will be created
+		#
+		# Arguments:
+		# 	id: The optional ID of the tenant. If omitted, an ID will be created
 		#			automatically
-		# @returns The tenants ID
+		#
+		# Returns:
+		#	The tenants ID
 		#
 		def create_tenant_store(id = '')
 			id = UUIDTools::UUID.random_create.to_s if id == '' or id.nil?
 			
 			begin
 				path = File.join(@rootPath, id)
-				FileUtils.mkdir path
+				FileUtils.mkdir path if not File.directory?(path)
 				mm = MemoryMetaManager.new(File.join(path, "meta.yaml"))
 				sfs = SimpleFileStore.new(mm, path)
 			
@@ -64,7 +70,9 @@ module FileStore
 		end
 		#
 		# Permanently removes a tenant's store
-		# @param id The tenant's ID
+		#
+		# Arguments:
+		# 	id: The tenant's ID
 		#
 		def remove_tenant_store(id)
 			raise FileStoreException, "Tenant #{id} can't be removed. Not registered." if not @stores.key?(id)
@@ -78,8 +86,12 @@ module FileStore
 		end
 		#
 		# Returns the complete file store for a given tenant
-		# @param id The tenant's id
-		# @returns An instance of FileStore::SimpleFileStore
+		#
+		# Arguments:
+		# 	id: The tenant's ID
+		#
+		# Returns:
+		#	An instance of FileStore::SimpleFileStore
 		#
 		def get_tenant_store(id)
 			raise FileStoreException, "Tenant #{id} not registered. No file store given." if not @stores.key?(id)
@@ -88,30 +100,38 @@ module FileStore
 		end
 		#
 		# Adds a file to the tenant's store
-		# @param tenant The tenant's ID
-		# @param file The file to be added
-		# @param md Optional meta data
+		#
+		# Arguments:
+		# 	tenant: The tenant's ID
+		# 	file: The file to be added
+		# 	md: Optional meta data
 		#
 		def add_to_tenant(tenant, file, md = {})
-			raise FileStoreException, "Tenant #{id} not registered. File can't be added." if not @stores.key?(tenant)
+			raise FileStoreException, "Tenant #{tenant} not registered. File #{file} can't be added." if not @stores.key?(tenant)
 			
 			@stores[tenant].add(file, md)
 		end
 		#
 		# Removes a file from the tenant's store
-		# @param tenant The tenant's ID
-		# @param id The ID of the file to be removed
+		#
+		# Arguments:
+		# 	tenant: The tenant's ID
+		# 	id: The ID of the file to be removed
 		#
 		def remove_from_tenant(tenant, id)
-			raise FileStoreException, "Tenant #{id} not registered. File can't be removed." if not @stores.key?(tenant)
+			raise FileStoreException, "Tenant #{tenant} not registered. File with ID {id} can't be removed." if not @stores.key?(tenant)
 			
 			@stores[tenant].remove(id)
 		end
 		#
 		# Retrieves a file from the tenant's store
-		# @param tenant The tenant's ID
-		# @param id The file's ID
-		# @returns A hash containing the file object (:path) and the corresponding meta
+		#
+		# Arguments:
+		# 	tenant: The tenant's ID
+		# 	file: The file to be retrieved
+		#
+		# Returns:
+		#	A hash containing the file object (:path) and the corresponding meta
 		# 			data (:data)
 		#
 		def get_from_tenant(tenant, id)
@@ -121,9 +141,12 @@ module FileStore
 		end
 		#
 		# Determines wether a tenant is registered
-		# @param id The ID of the tenant to be tested
+		#
+		# Arguments:
+		# 	tenant: The tenant's ID to be tested
 		#
 		def has_tenant?(id)
+			return @stores.key?(id)
 		end
 		#
 		# Shuts down this multitenant store
@@ -138,7 +161,9 @@ module FileStore
 		private
 		#
 		# Recovers a multitenant store
-		# @param rootPath The base path of the multitenant store
+		#
+		# Arguments:
+		# 	rootPath: The base path of the multitenant store
 		#
 		def self.recover(rootPath)
 			raise FileStoreException, "Root path #{rootPath} isn't a valid multitenant store" if not File.directory?(rootPath)
@@ -149,7 +174,7 @@ module FileStore
 				begin
 					if File.directory?(e)
 						tenant = File.basename(e)
-						mm = MemoryMetaManager.new(File.join(e, "meta.yaml"))
+						mm = MemoryMetaManager.new(File.join(e, MemoryMetaManager::FILE))
 						sfs = SimpleFileStore.new(mm, e)
 				
 						stores[tenant] = sfs

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filestore
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-22 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -69,7 +69,8 @@ files:
 - lib/multitenant_filestore.rb
 - test/tc_filestore.rb
 - test/tc_multitenant.rb
-homepage: https://www.xing.com/profile/thomas.staetter
+- test/testfile.txt
+homepage: https://github.com/tstaetter/filestore-gem
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -97,3 +98,4 @@ summary: Simple file storage
 test_files:
 - test/tc_filestore.rb
 - test/tc_multitenant.rb
+- test/testfile.txt