file_resources_manager 1.0 → 1.0.1

data/lib/file_resources_manager.rb

@@ -9,10 +9,10 @@
 # first get or set or if you call FileResourcesManager.ensure_main_file_resources_file_exists
 
 # Usage:
-#      FileResourcesManager.set("business_database",{:adapter => "mysql",:host => "database",...})
+#      FileResourcesManager.set("business_database",{:adapter => "mysql",:host => "database",...}.to_yaml)
 #       saves the business database file_resources to the business_database.yml file
 #        in the ~/.app_file_resources directory
-#      FileResourcesManager.get("business_database")[:adapter]       => "mysql
+#      YAML.load(FileResourcesManager.get("business_database"))[:adapter]       => "mysql
 #       retrieves all the file_resources from the file
 #
 #      FileResourcesManager.set_file_resources_location("business_database","/var/myapp/values.yml")
@@ -23,10 +23,10 @@
 #       require 'rubygems' #if not in path and ruby version before 1.9.*
 #       require 'file_resources_manager'
 #       FileResourcesManager.set_file_resources_location("my_login","~/.login_info")
-#       FileResourcesManager.set("my_login",{ :username => "JockOfCode",:password => "1235711"})
+#       FileResourcesManager.set("my_login",{ :username => "JockOfCode",:password => "1235711"}.to_yaml)
 #       ...
 #       #later in program, or in another program...
-#       info = FileResourcesManager.get("my_login")
+#       info = YAML::load(FileResourcesManager.get("my_login"))
 #       SomeWebbyThingie.login(info[:username],info[:password])
 
 
@@ -47,7 +47,7 @@ class FileResourcesManager
 				end
 
 		if File.exists?(file_resources_file)
-			return YAML::load(File.read(file_resources_file))
+			return File.read(file_resources_file)
 		else
 			# a NO_SETTINGS_ERROR could be raised here
 			# but I will let the implementer decide on
@@ -65,18 +65,18 @@ class FileResourcesManager
 					get_file_resources_location(file_resources_name)
 				end
 
-		File.open(file_resources_file,"w"){|f| f << file_resources.to_yaml }
+		File.open(file_resources_file,"w"){|f| f << file_resources }
 		return file_resources
 	end
 	# gets the full path and filename that is loaded when you read <file_resources_name>
 	def self.get_file_resources_location(file_resources_name)
-		get("main_file_resources")[file_resources_name] || File.join(main_file_resources_file_location, file_resources_name + ".yml")
+		YAML::load(get("main_file_resources"))[file_resources_name] || File.join(main_file_resources_file_location, file_resources_name)
 	end
 	# sets the full path and filename that is referred to by <setting_name> to <location>
 	def self.set_file_resources_location(file_resources_name,location)
-		main_file_resources = get("main_file_resources")
+		main_file_resources = YAML::load(get("main_file_resources"))
 		main_file_resources[file_resources_name] = location
-		set("main_file_resources",main_file_resources)
+		set("main_file_resources",main_file_resources.to_yaml)
 		self
 	end
 
@@ -95,7 +95,7 @@ class FileResourcesManager
 	end
 	# gets the full path and filename of the main file_resources file
 	def self.main_file_resources_filename
-		File.join(main_file_resources_file_location,".main_file_resources.yaml")
+		File.join(main_file_resources_file_location,".main_file_resources.yml")
 	end
 
 	# guarantees the directory exists and a file is present at the location the main file_resources file should be at

data/lib/settings_manager.rb

@@ -0,0 +1,87 @@
+require 'file_resources_manager'
+
+class SettingsManager
+	attr_accessor :name,:file_type,:file_location,:filename,:data
+
+	def initialize(settings_name)
+		@name = settings_name
+		@data,@file_type,@file_location,@filename = nil
+		load_data
+	end
+
+	def load_data
+		smd = SettingsManager.settings_manager_data[@name]
+		@file_location = Dir.pwd
+		@filename = @name 
+		@file_type = :yaml
+		if smd then
+			@file_type = smd["file_type"].to_sym
+			@file_location = smd["file_location"] || Dir.pwd
+			@filename = smd["filename"] || @name 
+
+			data = File.read(File.join(@file_location,@filename))
+			@data=self.send("decode_" + @file_type.to_s,data)
+		else
+			@data={}	
+		end
+		self
+	end
+
+	def save_data
+		File.open(File.join(@file_location,@filename),"w"){|f|
+			case @file_type
+			when nil
+				@file_type = :yaml
+				f << @data.to_yaml
+			else
+				f << self.send("encode_" + @file_type.to_s,data)
+			end
+		}
+		file_data = {}
+		file_data["file_type"] = @file_type.to_s if @file_type
+		file_data["file_location"] = @file_location if @file_location
+		file_data["filename"] = @filename if @filename
+		smd = SettingsManager.settings_manager_data
+		smd[@name] = file_data
+		SettingsManager.settings_manager_data=smd
+	end
+	def self.create_encoder(datatype,&encode_method)
+		define_method("encode_" + datatype.to_s,&encode_method)
+	end
+
+	def self.create_decoder(datatype,&encode_method)
+		define_method("decode_" + datatype.to_s,&encode_method)
+	end
+
+	def []=(key,value)
+		@data[key]=value
+	end
+
+	def [](key)
+		@data[key]
+	end
+
+	def self.settings(settings_name)
+		self.new(settings_name)
+	end
+
+	def self.settings_manager_data
+		YAML::load(FileResourcesManager::get(".settings")||{}.to_yaml)
+	end
+
+	def self.settings_manager_data=(data)
+		FileResourcesManager::set(".settings",data.to_yaml)
+		self
+	end
+end
+
+SettingsManager.create_encoder(:yaml){|data| data.to_yaml }
+SettingsManager.create_decoder(:yaml){|data| YAML::load(data) }
+
+# I think my encoder for csv is wonked, will fix someother time, dinner time!!
+SettingsManager.create_encoder(:csv){|data| lines = []; data.each{|k,v| lines << [k,v].join(",") }; lines.join("\n") }
+SettingsManager.create_decoder(:csv){|data| data.split.inject({}){|hash,line| hash[line.split(",").first] = line.split(",").last } }
+
+
+SettingsManager.create_encoder(:csv){|data| data.to_yaml }
+SettingsManager.create_decoder(:csv){|data| YAML::load(data) }

data/tests/test_file_resources_manager.rb

@@ -1,28 +1,39 @@
-require 'settings_manager'
-require 'test/unit'
+require 'file_resources_manager'
+require 'minitest/unit'
+
+class TestFileResourcesManager < Test::Unit::TestCase
+	@@test_directory_location = File.join(Dir.pwd,"file_resources_location_test")
 
-class TestSettingsManager < Test::Unit::TestCase
 	def test_get
-		assert_nil(SettingsManager::get("some_non_existing_settings"),"There is none so it should most definately fail")
+		assert_nil(FileResourcesManager::get("some_non_existing_file_resources"),"There is none so it should most definately fail")
 	end
-	def test_system_settings
-		test_directory_location = File.join(Dir.pwd,"settings_location_test")
-		if File.directory?(test_directory_location) 
-			(Dir.entries(test_directory_location) - [".",".."]).each{|f| File.delete(File.join(test_directory_location,f)) }
-			Dir.rmdir(test_directory_location) 
+	def remove_test_directory
+		if File.directory?(@@test_directory_location) 
+			(Dir.entries(@@test_directory_location) - [".",".."]).each{|f| File.delete(File.join(@@test_directory_location,f)) }
+			Dir.rmdir(@@test_directory_location) 
 		end
+	end
+	def setup
+		remove_test_directory
+	end
+	def teardown
+		remove_test_directory
+	end
+	
+	def test_system_file_resources
 		ENV.delete "APP_SETTING"
-		assert_equal(SettingsManager::main_settings_file_location,File.expand_path("~/.app_settings"),"if none exist then this should be $HOME/.app_settings")
-		ENV["APP_SETTING"] = test_directory_location 
-		assert_equal(SettingsManager::main_settings_file_location,test_directory_location,"Main Setting File Location Should be set to the current directory + settings_location_test")
-		SettingsManager::ensure_main_settings_file_exists
-		assert_equal(File.exists?(File.join(test_directory_location,".main_settings.yaml")),true,"settings file should have been created")
-		assert_equal(SettingsManager::get_settings_location("test_kv"),File.join(test_directory_location,"test_kv.yml"),"test settings file location should match")
-		SettingsManager::set("test_kv",{:name => "jockofcode",:occupation => "rubyist" })
-		assert_equal(SettingsManager::get("test_kv")[:name],"jockofcode","should have retreived 'jockofcode' from settings")
-		SettingsManager::set_settings_location("test_kv",File.join(test_directory_location,"not_the_default_kv.yml"))
-		assert_nil(SettingsManager::get("test_kv"),"It should not be getting the value from test_kv.yml anymore")
-		SettingsManager::set("test_kv",{:name => "john",:occupation => "kneeder"})
-		assert_equal(SettingsManager::get("test_kv")[:name],"john","should now be john, not jockofcode")
+		assert_equal(FileResourcesManager::main_file_resources_file_location,File.expand_path("~/.app_file_resources"),"if none exist then this should be $HOME/.app_file_resources")
+		ENV["APP_SETTING"] = @@test_directory_location 
+		assert_equal(FileResourcesManager::main_file_resources_file_location,@@test_directory_location,"Main Setting File Location Should be set to the current directory + file_resources_location_test")
+		FileResourcesManager::ensure_main_file_resources_file_exists
+		assert_equal(File.exists?(File.join(@@test_directory_location,".main_file_resources.yml")),true,"file_resources file should have been created")
+		assert_equal(FileResourcesManager::get_file_resources_location("test_kv"),File.join(@@test_directory_location,"test_kv"),"test file_resources file location should match")
+		FileResourcesManager::set("test_kv",{:name => "jockofcode",:occupation => "rubyist" }.to_yaml)
+		assert_equal(YAML::load(FileResourcesManager::get("test_kv"))[:name],"jockofcode","should have retreived 'jockofcode' from file_resources")
+		FileResourcesManager::set_file_resources_location("test_kv",File.join(@@test_directory_location,"not_the_default_kv.yml"))
+		assert_equal(FileResourcesManager::get_file_resources_location("test_kv"),File.join(@@test_directory_location,"not_the_default_kv.yml"),"test file_resources file location should match not_the_default_kv.yml")
+		assert_nil(FileResourcesManager::get("test_kv"),"It should not be getting the value from test_kv anymore")
+		FileResourcesManager::set("test_kv",{:name => "john",:occupation => "kneeder"}.to_yaml)
+		assert_equal(YAML::load(FileResourcesManager::get("test_kv"))[:name],"john","should now be john, not jockofcode")
 	end
 end

data/tests/test_settings_manager.rb

@@ -0,0 +1,54 @@
+require 'settings_manager'
+require 'minitest/unit'
+require 'fileutils'
+
+
+class TestSettingsManager < Test::Unit::TestCase
+	@@test_directory_location = File.join(Dir.pwd,"file_resources_location_test")
+	def setup
+		puts "setup called"
+		remove_test_directory
+		FileUtils.mkdir_p(@@test_directory_location)
+	end
+	def remove_test_directory
+			if File.directory?(@@test_directory_location) #if the directory already exists then delete all the files out
+			(Dir.entries(@@test_directory_location) - [".",".."]).each{|f| 
+				File.delete(File.join(@@test_directory_location,f)) 
+			}
+			Dir.rmdir(@@test_directory_location) # then remove the directory
+		end
+	end
+	def test_initialization
+		ENV["APP_SETTING"] = @@test_directory_location
+		settings_name = "test_database_info"
+		settings = SettingsManager.settings(settings_name)
+		settings.file_location = @@test_directory_location
+		assert_not_equal(settings,nil,"an empty settings file should not be nil")
+		assert_equal(settings.name,settings_name, "just the settings name is set")
+		assert_equal(settings.file_type,:yaml,"should be defaulted to yaml")
+		settings["server"] = "127.0.0.1"
+		assert_equal(settings["server"],"127.0.0.1","server address should match 127.0.0.1")
+		assert_equal(settings.file_location,@@test_directory_location ,"should be equal to the current directory")
+		assert_equal(settings.filename,settings.name,"should equal the name test_database_info")
+		settings.save_data
+		
+		settings = nil
+		settings = SettingsManager.settings(settings_name)
+		assert_equal(settings["file_type"],nil,"file_type should still equal nil")
+		assert_equal(settings["server"],"127.0.0.1","it should still equal home")
+
+		settings2 = SettingsManager.settings(settings_name+"2")
+		settings2.file_location = @@test_directory_location
+		settings2.file_type = :csv
+		settings2["server"] = "1.1.1.1"
+		settings2.save_data
+		settings2 = nil
+		settings2 = SettingsManager.settings(settings_name+"2")
+		assert_equal(settings2["server"],"1.1.1.1","should equal 1.1.1.1")
+
+	end
+	def teardown
+		puts "teardown called"
+		remove_test_directory
+	end
+end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: file_resources_manager
 version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
-  version: "1.0"
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Branden Giacoletto
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 -06:00
+date: 2011-06-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,10 +26,13 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id001
-description: Instead of having to constantly use YAML::load(File.read('some/dir/with/file_resources/database_blah.yml')) in every app you write, now you can simply use FileResourcesManager::get('database') to get your file resources and the rest is automagically managed for you!
+description: Instead of having to constantly use YAML::load(File.read('some/dir/with/file_resources/database_blah.yml')) in every app you write, now you can simply use s = SettingsManager::settings('database');puts s["my_setting"] to get your file resources and the rest is automagically managed for you!
 email: 
 - branden@carbondatacomputers.com
 executables: []
@@ -35,9 +43,10 @@ extra_rdoc_files: []
 
 files: 
 - lib/file_resources_manager.rb
+- lib/settings_manager.rb
 - tests/test_file_resources_manager.rb
+- tests/test_settings_manager.rb
 - LICENSE
-- README
 has_rdoc: true
 homepage: http://JockOfCode.com/FileResourcesManager
 licenses: []
@@ -52,17 +61,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.6
+      hash: 23
+      segments: 
+      - 1
+      - 0
+      - 0
+      version: 1.0.0
 requirements: []
 
 rubyforge_project: file_resources_manager
-rubygems_version: 1.6.2
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Keeps your app file_resources in a central location

data/README

@@ -1,31 +0,0 @@
-# FileResourcesManager helps manage global application file_resources stored in 
-# a file by giving the application a central location and
-# consistent interface no matter where the data is stored
-
-# FileResourcesManager needs a central place to store it's file, the default
-# is in the ~/.app_file_resources directory, but it will use the
-# APP_SETTINGS environment variable for the directory instead
-# if the directory does not exist it will be created on the 
-# first get or set or if you call FileResourcesManager.ensure_main_file_resources_file_exists
-
-# Usage:
-#      FileResourcesManager.set("business_database",{:adapter => "mysql",:host => "database",...})
-#       saves the business database file_resources to the business_database.yml file
-#        in the ~/.app_file_resources directory
-#      FileResourcesManager.get("business_database")[:adapter]       => "mysql
-#       retrieves all the file_resources from the file
-#
-#      FileResourcesManager.set_file_resources_location("business_database","/var/myapp/values.yml")
-#       sets the location for future file_resources to the file "values.yml" at /var/myapp
-#
-#
-#       Full Example:
-#       require 'rubygems' #if not in path and ruby version before 1.9.*
-#       require 'file_resources_manager'
-#       FileResourcesManager.set_file_resources_location("my_login","~/.login_info")
-#       FileResourcesManager.set("my_login",{ :username => "JockOfCode",:password => "1235711"})
-#       ...
-#       #later in program, or in another program...
-#       info = FileResourcesManager.get("my_login")
-#       SomeWebbyThingie.login(info[:username],info[:password])
-