filestore 0.0.14 → 0.0.19

data/lib/filestore/factory.rb

@@ -0,0 +1,211 @@
+#
+# store_factory.rb
+#
+# author: Thomas Stätter
+# date: 2014/01/06
+#
+module FileStore
+  #
+  # Base factory class
+  #
+  class BaseFactory
+    #
+    # Creates a new instance of the given class
+    #
+    # Arguments:
+    #   klass: The class to be instantiated
+    #   path: The path to be used wether for stores or managers
+    #   observable (optional): Determines wether this instance should support observation
+    #   logger (optional): The logging facility
+    #
+    # Returns:
+    #   A new instance of 'klass'
+    #
+    def self.create(klass, path, observable = false, logger = StdoutLogger)
+      logger.debug "Creating new instance of class #{klass} with path '#{path}'"
+      obj = klass.new path
+      
+      obj.logger = logger if not logger.nil?
+      
+      if observable then
+        logger.debug "Extending instance with module 'ObservedSubject'"
+        
+        obj.extend ObservedSubject
+        obj.initialize_obs 
+      end
+      
+      return obj
+    end
+    
+  end
+  #
+  # MetaManager factory class
+  #
+  class MemoryMetaFactory < BaseFactory
+    #
+    # Creates a memory meta-manager instance
+    #
+    # Arguments:
+    #   persist_file: The file where the manager will be persistet
+    #   observable (optional): Determines wether this instance should support observation
+    #   logger (optional): The logging facility
+    #
+    # Returns:
+    #   A new instance of MemoryMetaManager
+    #
+    def self.create(persist_file = MemoryMetaManager::FILE, observable = false, logger = StdoutLogger)
+      return super(MemoryMetaManager, persist_file, observable, logger)
+    end
+  end
+  #
+  # MultiTenantFileStore factory class
+  #
+  class MultiTenantStoreFactory < BaseFactory
+    #
+    # Creates a multi tenant store instance
+    #
+    # Arguments:
+    #   base_path: The directory of the multitenant store
+    #   observable (optional): Determines wether this instance should support observation
+    #   logger (optional): The logging facility
+    #
+    # Returns:
+    #   A new instance of MultiTenantStore
+    #
+    def self.create(base_path, observable = false, logger = StdoutLogger)
+      logger.debug "Creating new MultiTenantFileStore"
+      multi_store = super MultiTenantFileStore, base_path, observable, logger
+      
+      multi_store.stores = MultiTenantStoreFactory::recover_tenant_stores(base_path, observable, logger) if File.exists?(base_path)
+      
+      return multi_store
+    end
+    
+    #
+    # Recovers a multitenant store
+    #
+    # Arguments:
+    #   rootPath: The base path of the multitenant store
+    #   logger (optional): The logging facility
+    #
+    # Returns:
+    #   A hashset of file stores (with the user ID as key) recovered
+    #   from the given directory
+    #
+    def self.recover_tenant_stores(root_path, observable, logger)
+      raise FileStoreException, "Root path #{rootPath} isn't a valid multitenant store" if not File.directory?(root_path)
+      
+      stores = {}
+      
+      logger.debug "Trying to recover tenant stores"
+      
+      Dir.glob(File.join(root_path, "*")).each do |e|
+        begin
+          if File.directory?(e) then
+            tenant = File.basename(e)
+            tenant_path = File.absolute_path e
+            
+            logger.debug "Restoring tenant store in directory #{tenant_path}"
+            
+            sfs = SimpleStoreFactory::create tenant_path, observable, logger
+        
+            stores[tenant] = sfs
+          end
+        rescue Exception => e
+          logger.error "Couldn't create store for tenant #{tenant}.\n#{e}"
+        end
+      end
+      
+      return stores
+    end
+    
+  end
+  #
+  # SimpleFileStore factory class
+  #
+  class SimpleStoreFactory < BaseFactory
+    #
+    # Creates a simple file-store instance
+    #
+    # Arguments:
+    #   base_path: The base path directory
+    #   observable (optional): Determines wether this instance should support observation
+    #   logger (optional): The logging facility
+    #
+    # Returns:
+    #   A new instance of SimpleFileStore
+    #
+    def self.create(base_path, observable = false, logger = StdoutLogger)
+      store = super(SimpleFileStore, base_path, observable, logger)
+      mm = MemoryMetaFactory.create File.join(base_path, MemoryMetaManager::FILE), observable, logger
+      
+      store.meta_manager = mm
+      
+      begin
+        SimpleStoreFactory.recover_store(store)
+      rescue FileStoreException => e
+        logger.debug "Couldn't recover store.\nReason: #{e.message}\nTrying to create the store"
+        SimpleStoreFactory.create_store(store)
+      end
+      
+      return store
+    end
+    
+    #
+    # Setup for a new file store directory
+    #
+    # Arguments:
+    #   store: The file store instance to set up
+    #
+    def self.create_store(store)
+      # Try to create needed directories
+      begin
+        FileUtils.mkdir [store.store_path, store.deleted_path, store.rollback_path]
+      rescue Errno::ENOENT => e
+        raise FileStoreException, "One ore more system directories couldn't be created.\n#{e.message}"
+      end
+      #
+      # Try to create hidden meta file
+      #
+      begin
+        meta = { 
+          :created_at => Date.today.strftime('%d.%m.%Y %H:%M:%S:%L'), 
+          :store_path => store.store_path,
+          :deleted_path => store.deleted_path,
+          :rollback_path => store.rollback_path,
+          :created_by => Etc.getlogin
+        }
+        
+        File.open(store.meta_file, "wb+") do |fh|
+          YAML.dump(meta, fh)
+        end
+        #
+        # Creation was successful
+        #
+      rescue Exception => e
+        raise FileStoreException, "Store meta file #{store.meta_file} couldn't be created.\n#{e.message}"
+      end
+    end
+    #
+    # Recover an existing file store
+    #
+    # Arguments:
+    #   store: The file store instance to recover
+    #
+    def self.recover_store(store)
+      # trying to recover existing file store
+      begin
+        meta = YAML.load_file(store.meta_file)
+        
+        raise FileStoreException, "Store directory not found" if not File.directory?(meta[:store_path])
+        raise FileStoreException, "Deleted directory not found" if not File.directory?(meta[:deleted_path])
+        raise FileStoreException, "Rollback directory not found" if not File.directory?(meta[:rollback_path])
+        #
+        # Recovery was successful
+        #
+      rescue Exception => e
+        raise FileStoreException, "Unable to recover file store from path #{store.root_path}.\n#{e.message}"
+      end
+    end
+  end
+end

data/lib/filestore/memory_meta.rb

@@ -8,10 +8,9 @@ module FileStore
 	#
 	# Class implementing a memory based MetaManager
 	#
-	class MemoryMetaManager < MetaManager
+	class MemoryMetaManager
 	  include Logger
-	  include OberservedSubject
-	  
+
 		# Constant defining the default file path
 		FILE = 'meta.yaml'
 		# Accessor for the file to store data to
@@ -21,14 +20,13 @@ module FileStore
 		#
 		# Arguments:
 		# 	persistentFile: The file where the manager class is persisted to
+		#   logger: The logging facility
 		#
-		def initialize(persistentFile = '', logger)
+		def initialize(persistent_file = MemoryMetaManager::FILE, logger = StdoutLogger)
 		  @logger = logger
 			@data = Hash.new
 			@removed = Hash.new
-			@file = (persistentFile.nil? or persistentFile == '')? MemoryMetaManager::FILE : persistentFile
-			
-			self.initialize_obs
+			@file = (persistent_file.nil? or persistent_file == '') ? MemoryMetaManager::FILE : persistent_file
 			
 			begin
 				if File.exists?(@file)
@@ -62,8 +60,8 @@ module FileStore
 			
 			@data[id] = (@data.key?(id) ? @data[id].merge!(metaData) : @data[id] = metaData)
 			
-			self.inform ObserverAction.new(:type => ObserverAction::TYPE_META_ADD, 
-       :objects => [id, metaData], :msg => "Added/Updated file to meta store")
+			inform ObserverAction.new(:type => ObserverAction::TYPE_META_ADD, 
+       :objects => [id, metaData], :msg => "Added/Updated file to meta store")  if self.is_a?(ObservedSubject)
 		end
 		#
 		# see: MetaManager::remove
@@ -75,8 +73,8 @@ module FileStore
 			@removed[id] = @data[id]
 			@data.delete(id)
 			
-			self.inform ObserverAction.new(:type => ObserverAction::TYPE_META_REMOVE, 
-       :objects => [id], :msg => "Removed file to meta store")
+			inform ObserverAction.new(:type => ObserverAction::TYPE_META_REMOVE, 
+       :objects => [id], :msg => "Removed file to meta store") if self.is_a?(ObservedSubject)
 		end
 		#
 		# see: MetaManager::restore
@@ -88,26 +86,34 @@ module FileStore
 			@data[id] = @removed[id]
 			@removed.delete(id)
 			
-			self.inform ObserverAction.new(:type => ObserverAction::TYPE_META_RESTORE, 
-       :objects => [id], :msg => "Restored file in meta store")
+			inform ObserverAction.new(:type => ObserverAction::TYPE_META_RESTORE, 
+       :objects => [id], :msg => "Restored file in meta store") if self.is_a?(ObservedSubject)
 		end
 		#
-		# see: MetaManager::shutdown
+		# see: MetaManager::save
 		#
-		def shutdown
-			begin
-				File.open(@file, "wb+") do |fh|
-					YAML.dump({:current => @data, :removed => @removed}, fh)
-				end
-				
-				@data = nil
-				
-				self.inform ObserverAction.new(:type => ObserverAction::TYPE_META_SHUTDOWN, 
-          :msg => "Restored file in meta store")
-			rescue Exception => e
-				raise FileStoreException, "Couldn't serialize meta manager to file #{@file}.\n#{e.message}"
-			end
-		end
+		def save
+		  begin
+        @logger.info "Persisting meta store to #{@file}"
+        
+        File.open(@file, "wb+") do |fh|
+          YAML.dump({:current => @data, :removed => @removed}, fh)
+        end
+                
+        inform ObserverAction.new(:type => ObserverAction::TYPE_META_SHUTDOWN, 
+          :msg => "Shut down meta manager") if self.is_a?(ObservedSubject)
+      rescue Exception => e
+        raise FileStoreException, "Couldn't persist meta manager to file #{@file}.\n#{e.message}"
+      end
+    end
+    #
+    # see: MetaManager::shutdown
+    #
+    def shutdown
+      save
+      
+      @data = @removed = nil
+    end
 		#
 		# see: MetaManager::has_id?
 		#

data/lib/filestore/meta_manager.rb

@@ -47,6 +47,11 @@ module FileStore
 		def add_or_update(id, metaData)
 		end
 		#
+    # Saves the meta data in the current state
+    #
+		def save
+		end
+		#
 		# Shuts down the manager class and clears all used resources
 		#
 		def shutdown

data/lib/filestore/multitenant_store.rb

@@ -4,40 +4,22 @@
 # author: Thomas Stätter
 # date: 2012/11/21
 #
-require 'filestore'
-
 module FileStore
 	#
-	# Singleton class implementing a multitenant file store
+	# Class implementing a multitenant file store
 	#
 	class MultiTenantFileStore
 	  include Logger
-	  include OberservedSubject
-		# Make this class a singleton class
-		include Singleton
 		# Accessors
-		attr_reader :stores, :rootPath
+		attr_reader :rootPath
+		attr_accessor :stores
 		#
 		# Initializes a new instance of MultiTenantFileStore
 		#
-		def initialize()
-			@rootPath = Dir.getwd
+		def initialize(root_path = ".", logger = StdoutLogger)
+			@rootPath = root_path
 			@stores = {}
-			
-			self.initialize_obs
-		end
-		#
-		# Sets the root path of the multitenant store. As FileStore::MultiTenantFileStore
-		# is a singleton class, this method must be used before any other
-		#
-		# 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)
-			
-			@rootPath = rootPath
-			@stores = MultiTenantFileStore.recover(rootPath, @logger)
+			@logger = logger
 		end
 		#
 		# Creates a new file store for a tenant
@@ -55,13 +37,12 @@ module FileStore
 			begin
 				path = File.join(@rootPath, id)
 				FileUtils.mkdir path if not File.directory?(path)
-				mm = MemoryMetaManager.new File.join(path, "meta.yaml"), @logger
-				sfs = SimpleFileStore.new mm, path, @logger
+				sfs = SimpleStoreFactory::create path, self.is_a?(ObservedSubject), @logger
 			
 				@stores[id] = sfs
 				
-				self.inform ObserverAction.new(:type => ObserverAction::TYPE_MSTORE_CREATE, 
-          :msg => "Created new tenant store")
+				inform ObserverAction.new(:type => ObserverAction::TYPE_MSTORE_CREATE, 
+          :msg => "Created new tenant store") if self.is_a?(ObservedSubject)
 			rescue Exception => e
 				raise FileStoreException, "Couldn't create multitenant store.\n#{e.message}"
 			end
@@ -106,13 +87,18 @@ module FileStore
 		# 	file: The file to be added
 		# 	md: Optional meta data
 		#
+		# Returns:
+		#   The file ID
+		#
 		def add_to_tenant(tenant, file, md = {})
 			raise FileStoreException, "Tenant #{tenant} not registered. File #{file} can't be added." if not @stores.key?(tenant)
 			
-			@stores[tenant].add(file, md)
+			f_id = @stores[tenant].add(file, md)
 			
-			self.inform ObserverAction.new(:type => ObserverAction::TYPE_MSTORE_ADD, 
-          :objects => [tenant, file], :msg => "Added file to tenant")
+			inform ObserverAction.new(:type => ObserverAction::TYPE_MSTORE_ADD, 
+          :objects => [tenant, file, f_id], :msg => "Added file to tenant #{tenant} with ID #{f_id}") if self.is_a?(ObservedSubject)
+          
+      return f_id
 		end
 		#
 		# Removes a file from the tenant's store
@@ -156,39 +142,14 @@ module FileStore
 		#
 		def shutdown
 			# Shut down any tenant store
-			@stores.values.each do |s|
-				s.shutdown
+			@stores.each do |id, store|
+			  @logger.info "Shutting down file store for tenant #{id}"
+				store.shutdown
 			end
 		end
 		
 		private
-		#
-		# Recovers a multitenant store
-		#
-		# Arguments:
-		# 	rootPath: The base path of the multitenant store
-		#
-		def self.recover(rootPath, logger)
-			raise FileStoreException, "Root path #{rootPath} isn't a valid multitenant store" if not File.directory?(rootPath)
-			
-			stores = {}
-			
-			Dir.glob(File.join(rootPath, "*")).each { |e|
-				begin
-					if File.directory?(e)
-						tenant = File.basename(e)
-						mm = MemoryMetaManager.new File.join(e, MemoryMetaManager::FILE), logger
-						sfs = SimpleFileStore.new mm, e, @logger
-				
-						stores[tenant] = sfs
-					end
-				rescue Exception => e
-					logger.error "Couldn't create store for tenant #{tenant}.\n#{e.message}"
-				end
-			}
-			
-			return stores
-		end
+		
 	end
 
 end

data/lib/filestore/observer.rb

@@ -50,10 +50,10 @@ module FileStore
     end
   end
   #
-  # Module FileStore::OberservedSubject can be mixed in to implement an 
+  # Module FileStore::ObservedSubject can be mixed in to implement an 
   # observed object. 
   #
-  module OberservedSubject
+  module ObservedSubject
     #
     # Reader for collection of observers
     #
@@ -82,7 +82,7 @@ module FileStore
     def register(obj)
       if obj.is_a?(Observer) and not obj.nil? and not @observers.include?(obj) then
         @observers << obj
-        self.logger.debug "Added #{obj} to observers" if not self.logger.nil?
+        @logger.debug "Added #{obj} to observers" if not self.logger.nil?
       else
         raise FileStoreException, "Only instances of FileStore::Observer can be registered"
       end
@@ -97,7 +97,7 @@ module FileStore
     def unregister(obj)
       if @observers.include?(obj) then 
         @observers.delete_at(@observers.index(obj))
-        self.logger.debug "Removed observing object #{obj} from the list" if not self.logger.nil?
+        @logger.debug "Removed observing object #{obj} from the list" if not self.logger.nil?
       else
         raise FileStoreException, "Object #{obj} isn't a registered observer"
       end

data/lib/filestore/simple_store.rb

@@ -5,21 +5,13 @@
 # date: 2012/11/07
 #
 module FileStore
-	#
-	# Base exception class used for errors occurring in this module
-	#
-	class FileStoreException < Exception
-	end
 	#
 	# Main library class implementing a simple file store used for storing and managing 
 	# arbitrary files
 	#
 	class SimpleFileStore
 	  include Logger
-	  include OberservedSubject
 	  
-		# Name of the lock file
-		STORE_LOCK_FILE = ".locked"
 		# Name of the meta file describing the current file store
 		META_FILE = "filestore.yaml"
 		# The base name of the file store directory
@@ -32,41 +24,28 @@ module FileStore
 		#
 		# Accessors for important properties
 		#
-		attr_reader :metaManager, :rootPath, :storePath, :deletedPath, :rollbackPath, :metaFile
+		attr_accessor :meta_manager
+		attr_reader :root_path, :store_path, :deleted_path, :meta_file
+		#
+		# Rollback path will be used in future versions
+		#
+		attr_reader :rollback_path
 		#
 		# Initializes a new instance of SimpleFileStore
 		#
 		# 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 = '.', logger)
-			raise FileStoreException, "Root path already locked" if SimpleFileStore.is_directory_locked?(rootPath)		
-			raise FileStoreException, "FileStore root path #{rootPath} doesn't exist" if not File.directory?(rootPath)
-			raise FileStoreException, "FileStore root path #{rootPath} isn't writable" if not File.writable?(rootPath)
-			raise FileStoreException, "No meta data manager given" if metaManager.nil?
-			raise FileStoreException, "Meta data manager must be of type FileStore::MetaManager" if not metaManager.is_a?(MetaManager)
-			
-			@metaManager = metaManager
-			@rootPath = rootPath
-			@storePath = File.join(@rootPath, STORE_ROOT)
-			@deletedPath = File.join(@rootPath, DELETED_ROOT)
-			@rollbackPath = File.join(@rootPath, ROLLBACK_ROOT)
-			@metaFile = File.join(@rootPath, META_FILE)
-			@locked = false
-			@logger = logger
-			
-			self.initialize_obs
-			
-			begin
-				# Try to recover existing store
-				SimpleFileStore.recover_store(self)
-			rescue FileStoreException => e
-				# Recovery failed, trying to create the store
-				SimpleFileStore.create_store(self)
-			end
-			
-			lock
+		# 	root_path: The path where the file store resides
+		#   logger: The logging facility
+		#
+		def initialize(root_path, logger = StdoutLogger)
+			raise FileStoreException, "FileStore root path #{root_path} doesn't exist" if not File.directory?(root_path)
+			raise FileStoreException, "FileStore root path #{root_path} isn't writable" if not File.writable?(root_path)
+			
+			@root_path = root_path
+      @store_path = File.join(@root_path, STORE_ROOT)
+      @deleted_path = File.join(@root_path, DELETED_ROOT)
+      @rollback_path = File.join(@root_path, ROLLBACK_ROOT)
+      @meta_file = File.join(@root_path, SimpleFileStore::META_FILE)
 		end
 		#
 		# Adds a file to the store
@@ -88,7 +67,7 @@ module FileStore
 			id = ""
 			
 			begin
-				dir = SimpleFileStore.get_daily_directory(@storePath)
+				dir = SimpleFileStore.get_daily_directory(@store_path)
 				@logger.info "Adding file #{file} to directory #{dir}"
 				id = SimpleFileStore.get_id(self)
 				@logger.info "Using file id #{id}"
@@ -98,14 +77,14 @@ module FileStore
 				shouldMove ? (@logger.info("Moving file"); FileUtils.mv(file, dstPath)) : 
 					(@logger.info("Copying file"); FileUtils.copy_file(file, dstPath))
 				
-				self.inform ObserverAction.new(:type => ObserverAction::TYPE_STORE_ADD, 
-          :objects => [file, meta], :msg => "Added file to file store")
+				inform ObserverAction.new(:type => ObserverAction::TYPE_STORE_ADD, 
+          :objects => [file, meta], :msg => "Added file to file store") if self.is_a?(ObservedSubject)
 			rescue Exception => e
 				raise FileStoreException, "Couldn't add file #{file} to store.", e.backtrace
 			end
 			
 			meta[:path] = dstPath
-			@metaManager.add_or_update(id, meta)
+			@meta_manager.add_or_update(id, meta)
 			
 			return id
 		end
@@ -121,15 +100,15 @@ module FileStore
 		#
 		def get(id)
 			raise FileStoreException, "No ID given" if id.nil? or id == ''
-			raise FileStoreException, "No file for ID #{id} found" if not @metaManager.has_id?(id)
+			raise FileStoreException, "No file for ID #{id} found" if not @meta_manager.has_id?(id)
 			
-			md = @metaManager.get_data(id)
+			md = @meta_manager.get_data(id)
 			path = md[:path]
 
 			raise FileStoreException, "No valid meta data found for ID #{id}" if md.nil? or not File.exists?(path)
 			
-			self.inform ObserverAction.new :type => ObserverAction::TYPE_STORE_GET, 
-        :objects => [id], :msg => "Returning file from file store"
+			inform ObserverAction.new(:type => ObserverAction::TYPE_STORE_GET, 
+        :objects => [id], :msg => "Returning file from file store")  if self.is_a?(ObservedSubject)
 			
 			return { :path => File.new(path), :data => md }
 		end
@@ -141,20 +120,20 @@ module FileStore
 		#
 		def remove(id)
 			raise FileStoreException, "No file ID given for removal" if id == '' or id.nil?
-			raise FileStoreException, "File ID for removal not found in store" if not @metaManager.has_id?(id)
+			raise FileStoreException, "File ID for removal not found in store" if not @meta_manager.has_id?(id)
 			
-			file = @metaManager.get_data(id)[:path]
+			file = @meta_manager.get_data(id)[:path]
 			
 			begin
-				@metaManager.remove(id)
+				@meta_manager.remove(id)
 				
-				dir = SimpleFileStore.get_daily_directory(@deletedPath)
+				dir = SimpleFileStore.get_daily_directory(@deleted_path)
 				dstPath = File.join(dir, id)
 				
 				FileUtils.move(file, dstPath)
 				
-				self.inform ObserverAction.new :type => ObserverAction::TYPE_STORE_REMOVE, 
-          :objects => [id], :msg => "Deleted file from store"
+				inform ObserverAction.new(:type => ObserverAction::TYPE_STORE_REMOVE, 
+          :objects => [id], :msg => "Deleted file from store") if self.is_a?(ObservedSubject)
 			rescue Exception => e
 				raise FileStoreException, "Couldn't move file #{file} to deleted store.\n#{e.message}"
 			end
@@ -169,74 +148,36 @@ module FileStore
 			raise FileStoreException, "No file ID given for restore" if id == '' or id.nil?
 			
 			begin
-			  md = @metaManager.restore id
+			  md = @meta_manager.restore id
         @logger.debug "Restoring meta data #{md}"
         file = md[:path]
         
-				dir = SimpleFileStore.get_daily_directory(@storePath)
+				dir = SimpleFileStore.get_daily_directory(@store_path)
 				dstPath = File.join(dir, id)
 				
 				FileUtils.move(file, dstPath)
 				
-				self.inform ObserverAction.new :type => ObserverAction::TYPE_STORE_RESTORE, 
-          :objects => [id], :msg => "Restored file from store"
+				inform ObserverAction.new(:type => ObserverAction::TYPE_STORE_RESTORE, 
+          :objects => [id], :msg => "Restored file from store") if self.is_a?(ObservedSubject)
 			rescue Exception => e
 				raise FileStoreException, "Couldn't restore file #{file} from deleted store.\n#{e.message}"
 				#
 				# Delete restored entry from metaManager
-				@metaManager.delete(id)
+				#
+				@meta_manager.delete(id)
 			end
 		end
 		#
 		# Shuts down the file store
 		#
 		def shutdown
-			@metaManager.shutdown
-			
-			release_lock
+			@meta_manager.shutdown
 			
-			self.inform ObserverAction.new :type => ObserverAction::TYPE_STORE_SHUTDOWN, 
-        :msg => "File store shutdown"
-		end
-		#
-		# Determines wether this store is locked
-		#
-		def locked?
-			return @locked
+			inform ObserverAction.new(:type => ObserverAction::TYPE_STORE_SHUTDOWN, 
+        :msg => "File store shutdown")  if self.is_a?(ObservedSubject)
 		end
 		
 		private
-		
-		#
-		# Release the lock from the store
-		#
-		def release_lock
-			begin
-				File.delete File.join(@rootPath, STORE_LOCK_FILE)
-				@locked = false
-			rescue Exception => e
-				raise FileStoreException, "Couldn't release lock from #{@storePath}.\n#{e.message}"
-			end
-		end
-		#
-		# Locks the current instance of file store as well as the corresponding path on
-		# the file system using a hidden file
-		#
-		def lock
-			begin
-				FileUtils.touch File.join(@rootPath, STORE_LOCK_FILE)
-				@locked = true
-			rescue Exception => e
-				raise FileStoreException, "Couldn't lock the store in path #{@storePath}.\n#{e.message}"
-			end
-		end
-		#
-		# Determines wether the store path is already locked by another instance
-		# of SimpleFileStore
-		#
-		def self.is_directory_locked?(rootPath)
-			return File.exists?(File.join(rootPath, SimpleFileStore::STORE_LOCK_FILE))
-		end
 		#
 		# Creates a new file ID
 		#
@@ -247,7 +188,7 @@ module FileStore
 			for i in 0..2 do	
 				id = UUIDTools::UUID.random_create.to_s
 				
-				return id if not store.metaManager.has_id?(id) 
+				return id if not store.meta_manager.has_id?(id) 
 			end
 			
 			raise FileStoreException, "Couldn't find unique ID"
@@ -268,61 +209,6 @@ module FileStore
 			raise FileStoreException, "Daily directory #{dir} isn't writable" if not File.writable?(dir)
 			return dir
 		end
-		#
-		# Setup for a new file store directory
-		#
-		# Arguments:
-		# 	store: The file store instance to set up
-		#
-		def self.create_store(store)
-			# Try to create needed directories
-			begin
-				FileUtils.mkdir [store.storePath, store.deletedPath, store.rollbackPath]
-			rescue Errno::ENOENT => e
-				raise FileStoreException, "One ore more system directories couldn't be created.\n#{e.message}"
-			end
-			# Try to create hidden meta file
-			begin
-				meta = { :created_at => Date.today.strftime('%d.%m.%Y %H:%M:%S:%L'), 
-					:storePath => store.storePath,
-					:deletedPath => store.deletedPath,
-					:rollbackPath => store.rollbackPath,
-					:created_by => Etc.getlogin
-				}
-				
-				File.open(store.metaFile, "w+") do |fh|
-					YAML.dump(meta, fh)
-				end
-				
-				#
-				# Creation was successful
-				#
-			rescue Exception => e
-				raise FileStoreException, "Meta file #{store.metaFile} couldn't be created.\n#{e.message}"
-			end
-		end
-		#
-		# Recover an existing file store
-		#
-		# Arguments:
-		# 	store: The file store instance to recover
-		#
-		def self.recover_store(store)
-			# trying to recover existing file store
-			begin
-				meta = YAML.load_file(store.metaFile)
-				
-				raise FileStoreException, "Store directory not found" if not File.directory?(meta[:storePath])
-				raise FileStoreException, "Deleted directory not found" if not File.directory?(meta[:deletedPath])
-				raise FileStoreException, "Rollback directory not found" if not File.directory?(meta[:rollbackPath])
-				
-				#
-				# Recovery was successful
-				#
-			rescue Exception => e
-				raise FileStoreException, "Unable to recover file store from path #{store.rootPath}.\n#{e.message}"
-			end
-		end
 		
 	end
 

data/lib/filestore.rb

@@ -4,6 +4,14 @@
 # @date 2012/11/26
 # @description
 #
+module FileStore
+  #
+  # Base exception class used for errors occurring in this module
+  #
+  class FileStoreException < Exception
+  end
+end
+
 LIBS = [
   #
   # Required 3rd party libs
@@ -11,8 +19,7 @@ LIBS = [
   'uuidtools',
   'fileutils',
   'yaml',
-  'etc',
-  'singleton'
+  'etc'
 ]
 FILESTORE_FILES = [
   #
@@ -23,7 +30,8 @@ FILESTORE_FILES = [
   'log',
   'memory_meta',
   'simple_store',
-  'multitenant_store'
+  'multitenant_store',
+  'factory'
 ]
 #
 # Loads required 3rd party libs as defined in FileStore::LIBS

data/test/classes.rb

@@ -12,16 +12,22 @@ class FileStoreTest < Test::Unit::TestCase
   
   def setup
     # create test directory and file
-    @basePath = "#{Dir.getwd}/store_test"
-    @testFile = File.join(@basePath, "testfile.txt")
+    @uid = Etc.getlogin
+    @basePathSimple = "#{Dir.getwd}/simple_store_test"
+    @basePathMulti = "#{Dir.getwd}/multi_store_test"
+    @testFileSimple = File.join(@basePathSimple, "testfile.txt")
+    @testFileMulti = File.join(@basePathMulti, "testfile.txt")
      
-    FileUtils.mkdir(@basePath) if not File.exists?(@basePath)
-    FileUtils.touch(@testFile) if not File.exists?(@testFile)
+    FileUtils.mkdir(@basePathSimple) if not File.exists?(@basePathSimple)
+    FileUtils.mkdir(@basePathMulti) if not File.exists?(@basePathMulti)
+    FileUtils.touch(@testFileSimple)
+    FileUtils.touch(@testFileMulti)
   end
   
   def teardown
-    # remove test directory and file
-    FileUtils.remove_dir(@basePath, true) if File.exists?(@basePath)
+    # remove test directories and file
+    FileUtils.remove_dir(@basePathSimple, true) if File.exists?(@basePathSimple)
+    FileUtils.remove_dir(@basePathMulti, true) if File.exists?(@basePathMulti)
   end
   
 end

data/test/tc_filestore.rb

@@ -3,7 +3,6 @@
 # @author Thomas Stätter
 # @date 2012/11/14
 #
-# require 'filestore'
 require './classes.rb'
 require 'test/unit'
 
@@ -16,14 +15,12 @@ class TestFileStore < FileStoreTest
     puts "TestFileStore::test_init_shutdown"
     puts "=" * 80
     
-    mm = MemoryMetaManager.new File.join(@basePath, "meta.yaml"), StdoutLogger
-    sfs = nil
-    
     assert_nothing_raised(FileStoreException) {
-      sfs = SimpleFileStore.new mm, @basePath, StdoutLogger
+      SimpleStoreFactory::create @basePathSimple
     }
-    assert_not_nil(sfs)
+    assert_not_nil(SimpleStoreFactory::create @basePathSimple)
     assert_nothing_raised(FileStoreException) {
+      sfs = SimpleStoreFactory::create @basePathSimple
       sfs.shutdown
     }
   end
@@ -33,8 +30,7 @@ class TestFileStore < FileStoreTest
     puts "TestFileStorage::test_registration_observer"
     puts "=" * 80
     
-    mm = MemoryMetaManager.new File.join(@basePath, "meta.yaml"), StdoutLogger
-    sfs = SimpleFileStore.new mm, @basePath, StdoutLogger
+    sfs = SimpleStoreFactory::create @basePathSimple, true
     o1 = OtherObserverClass.new
     o2 = ObserverClass.new
     
@@ -56,14 +52,13 @@ class TestFileStore < FileStoreTest
     
     o1 = ObserverClass.new    
     o1.logger = StdoutLogger
-    mm = MemoryMetaManager.new File.join(@basePath, "meta.yaml"), StdoutLogger
-    sfs = SimpleFileStore.new mm, @basePath, StdoutLogger
+    sfs = SimpleStoreFactory::create @basePathSimple, true
     id = nil
     
     sfs.register o1
     
     assert_nothing_raised(FileStoreException) { 
-      id = sfs.add @testFile, { :original_file => @testFile }, false
+      id = sfs.add @testFileSimple, { :original_file => @testFileSimple }, false
     }
     assert_nothing_raised(FileStoreException) { file = sfs.get id }
     assert_not_nil(sfs.get(id))

data/test/tc_meta.rb

@@ -14,11 +14,13 @@ class TestMetaManager < FileStoreTest
     puts "=" * 80
     puts "TestMetaManager::test_init_shutdown"
     puts "=" * 80
+    
     assert_nothing_raised(FileStoreException) {
-      MemoryMetaManager.new File.join(@basePath, "meta.yaml"), StdoutLogger
+      mm = MemoryMetaFactory::create File.join(@basePathSimple, MemoryMetaManager::FILE)
     }
+    assert_not_nil(MemoryMetaFactory::create File.join(@basePathSimple, MemoryMetaManager::FILE))
     assert_nothing_raised(FileStoreException) {
-      mm = MemoryMetaManager.new File.join(@basePath, "meta.yaml"), StdoutLogger
+      mm = MemoryMetaFactory::create File.join(@basePathSimple, MemoryMetaManager::FILE)
       
       mm.shutdown
     }
@@ -35,19 +37,19 @@ class TestMetaManager < FileStoreTest
     o1.logger = StdoutLogger
     o2.logger = StdoutLogger
     
-    mm = MemoryMetaManager.new(File.join(@basePath, "meta.yaml"), StdoutLogger)
+    mm = MemoryMetaFactory::create File.join(@basePathSimple, MemoryMetaManager::FILE), true
     
     assert_nothing_raised(FileStoreException) {
       mm.register o1
       mm.register o2
     }
-    assert_raise(FileStoreException) { mm.register o1 }
+    assert_raise(FileStoreException) { mm.register "" }
     assert_nothing_raised(FileStoreException) {
       mm.unregister(o1)
       mm.unregister(o2)
     }
   end
-  
+   
   def test_actions_with_observer
     puts "=" * 80
     puts "TestMetaManager::test_actions_with_observer"
@@ -55,14 +57,15 @@ class TestMetaManager < FileStoreTest
     
     o1 = ObserverClass.new    
     o1.logger = StdoutLogger
-    mm = MemoryMetaManager.new(File.join(@basePath, "meta.yaml"), StdoutLogger)
+    mm = MemoryMetaFactory::create File.join(@basePathSimple, MemoryMetaManager::FILE), true
     
     mm.register o1
     
-    assert_nothing_raised(Exception) { mm.add_or_update "1", {} }
-    assert_nothing_raised(Exception) { mm.add_or_update "1", {} }
-    assert_nothing_raised(Exception) { mm.remove "1" }
-    assert_nothing_raised(Exception) { mm.restore "1" }
-    assert_nothing_raised(Exception) { mm.shutdown }
+    assert_nothing_raised(FileStoreException) { mm.add_or_update "1", {} }
+    assert_nothing_raised(FileStoreException) { mm.add_or_update "1", {} }
+    assert_nothing_raised(FileStoreException) { mm.remove "1" }
+    assert_nothing_raised(FileStoreException) { mm.restore "1" }
+    assert_nothing_raised(FileStoreException) { mm.shutdown }
   end
+  
 end

data/test/tc_module.rb

@@ -12,13 +12,18 @@ class TestModule < Test::Unit::TestCase
     puts "=" * 80
     puts "TestModule::test_inclusion"
     puts "=" * 80
+    
     assert_nothing_raised(NameError) { ObserverAction }
-    assert_nothing_raised(NameError) { OberservedSubject }
+    assert_nothing_raised(NameError) { ObservedSubject }
     assert_nothing_raised(NameError) { Observer }
     assert_nothing_raised(NameError) { SimpleFileStore }
     assert_nothing_raised(NameError) { MultiTenantFileStore }
     assert_nothing_raised(NameError) { MemoryMetaManager }
     assert_nothing_raised(NameError) { MetaManager }
     assert_nothing_raised(NameError) { FileStoreException }
+    assert_nothing_raised(NameError) { BaseFactory }
+    assert_nothing_raised(NameError) { MemoryMetaFactory }
+    assert_nothing_raised(NameError) { MultiTenantStoreFactory }
+    assert_nothing_raised(NameError) { SimpleStoreFactory }
   end
 end

data/test/tc_multitenant.rb

@@ -12,38 +12,56 @@ include FileStore
 
 class TestMultiTenantFileStore < FileStoreTest
   
-  def test_registration_observer
+  def test_init_shutdown
     puts "=" * 80
-    puts "TestMultiTenantFileStore::test_registration_observer"
+    puts "TestMultiTenantFileStore::test_init"
     puts "=" * 80
     
-    MultiTenantFileStore.instance.set_root_path @basePath
-    MultiTenantFileStore.instance.logger = StdoutLogger
-    tenant = MultiTenantFileStore.instance.create_tenant_store
-    o1 = OtherObserverClass.new
-    o2 = ObserverClass.new
-    
     assert_nothing_raised(FileStoreException) {
-      MultiTenantFileStore.instance.register o1
-      MultiTenantFileStore.instance.register o2
+      MultiTenantStoreFactory::create @basePathMulti
+    }
+    assert_not_nil(MultiTenantStoreFactory::create @basePathMulti)
+    assert(MultiTenantStoreFactory::create(@basePathMulti).is_a?(MultiTenantFileStore))
+    assert_nothing_raised(FileStoreException) {
+      m_store = MultiTenantStoreFactory::create @basePathMulti
+      
+      m_store.shutdown
     }
   end
   
+  def test_observer_registration
+    puts "=" * 80
+    puts "TestMultiTenantFileStore::test_observer_registration"
+    puts "=" * 80
+    
+    assert_nothing_raised(Exception) {
+      o1 = ObserverClass.new
+      o1.logger = StdoutLogger
+      m_store = MultiTenantStoreFactory::create @basePathMulti, true
+      
+      m_store.register o1
+      m_store.inform "Some test message"
+      m_store.shutdown
+    }
+  end
+
   def test_actions_with_observer
     puts "=" * 80
     puts "TestMultiTenantFileStore::test_actions_with_observer"
     puts "=" * 80
     
-    MultiTenantFileStore.instance.set_root_path @basePath
-    MultiTenantFileStore.instance.logger = StdoutLogger
     o1 = OtherObserverClass.new
     o1.logger = StdoutLogger
-    MultiTenantFileStore.instance.register o1
+
+    m_store = MultiTenantStoreFactory::create @basePathMulti, true
+    m_store.register o1
     
     assert_nothing_raised(FileStoreException) {
-      tenant = MultiTenantFileStore.instance.create_tenant_store
-      MultiTenantFileStore.instance.add_to_tenant tenant, 
-        @testFile, { :original_file => @testFile }
+      tenant_id = m_store.create_tenant_store @uid
+      f_id = m_store.add_to_tenant tenant_id, 
+        @testFileMulti, { :original_file => @testFileMulti }
+      m_store.remove_from_tenant tenant_id, f_id
+      m_store.shutdown
     }
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filestore
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -39,6 +39,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/filestore/factory.rb
 - lib/filestore/log.rb
 - lib/filestore/memory_meta.rb
 - lib/filestore/meta_manager.rb