file_resources_manager 1.0

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Branden Giacoletto
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README

@@ -0,0 +1,31 @@
+# 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])
+

data/lib/file_resources_manager.rb

@@ -0,0 +1,121 @@
+# 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])
+
+
+
+require 'fileutils'
+require 'yaml'
+
+class FileResourcesManager
+	# Loads the file that is referred to by <file_resources_name>
+	def self.get file_resources_name
+		ensure_main_file_resources_file_exists
+
+		file_resources_file = if file_resources_name == "main_file_resources"
+					main_file_resources_filename
+				else
+					# BTW example of a-b-c recursion
+					get_file_resources_location(file_resources_name)
+				end
+
+		if File.exists?(file_resources_file)
+			return YAML::load(File.read(file_resources_file))
+		else
+			# a NO_SETTINGS_ERROR could be raised here
+			# but I will let the implementer decide on
+			# the validation
+			return nil
+		end
+	end
+	# Saves the file that is referred to by <file_resources_name>
+	def self.set(file_resources_name,file_resources)
+		ensure_main_file_resources_file_exists
+
+		file_resources_file = if file_resources_name == "main_file_resources"
+					main_file_resources_filename
+				else
+					get_file_resources_location(file_resources_name)
+				end
+
+		File.open(file_resources_file,"w"){|f| f << file_resources.to_yaml }
+		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")
+	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[file_resources_name] = location
+		set("main_file_resources",main_file_resources)
+		self
+	end
+
+	class << self
+		alias file_resources_location get_file_resources_location
+	end
+	
+	def self.file_resources_location=(args)
+		set_file_resources_location(*args)
+	end
+
+
+	# gets the directory where the main file_resources file is saved
+	def self.main_file_resources_file_location
+		ENV["APP_SETTING"] || File.join(Dir.home,".app_file_resources")
+	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")
+	end
+
+	# guarantees the directory exists and a file is present at the location the main file_resources file should be at
+	def self.ensure_main_file_resources_file_exists
+		filename = main_file_resources_filename
+		if !File.file?(filename) then 
+			FileUtils.mkdir_p(File.dirname(filename))
+			File.open(filename,"w"){|f| f << {}.to_yaml }
+		end
+	end
+end
+
+#turns out ruby < 1.9 doesn't have Dir::home
+#here is an 80% solution, (Checking for $HOME on a rescue would maybe
+#cover more edge cases, next would be username in a /home or /User
+#directory 
+if Dir.respond_to?(:home) == false
+	class Dir
+		def self.home
+			File.expand_path("~/")
+		end
+	end
+end

data/tests/test_file_resources_manager.rb

@@ -0,0 +1,28 @@
+require 'settings_manager'
+require 'test/unit'
+
+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")
+	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) 
+		end
+		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")
+	end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: file_resources_manager
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "1.0"
+platform: ruby
+authors: 
+- Branden Giacoletto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-16 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yaml
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        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!
+email: 
+- branden@carbondatacomputers.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/file_resources_manager.rb
+- tests/test_file_resources_manager.rb
+- LICENSE
+- README
+has_rdoc: true
+homepage: http://JockOfCode.com/FileResourcesManager
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: file_resources_manager
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Keeps your app file_resources in a central location
+test_files: []
+