settings-tree 0.2.0 → 0.2.1

data/README.rdoc

@@ -8,8 +8,11 @@ The good things over similar gems is the ability to have deep, recursive structu
 
 Example :
 
+  Settings.web_app.root_url               => 'localhost:3000'
+  
   Settings.web_app.infos.company_name     => 'Acme'
   Settings.web_app.infos.app_name         => 'Coffe maker'
+  
   Settings.web_app.engine.workers_count   => 3
 
 Those settings are read from a YAML file, like this one :
@@ -47,46 +50,44 @@ Those settings are read from a YAML file, like this one :
     engine:
       workers_count: 0
 
-Note : the settings must reside under a root named 'defaults'. Other roots ('production', 'development'...) will be picked depending on the environment. (more about thet later)
+The common settings reside under a root named 'defaults'. Other roots ('production', 'development'...) will be picked depending on the environment. (more about that later)
 
-This gem has more good features, keep reading for more.
+This gem has more good features, keep reading.
 
 Ideas taken from : http://kpumuk.info/ruby-on-rails/flexible-application-configuration-in-ruby-on-rails/
 
 == Installation
-Available as a gem
+Available as a gem in rubygems, the default gem repository :
   gem 'settings-tree'
-  
-Isn't it easy ?
+Isn't that easy ? (Thank you jeweler for making everything so easy)
 
 == Use
 
 You can uses several, independent 'groups'.
 
 Just register a settings group from a file :
-  Settings.register_settings_file('web_app', File.join(File.dirname(__FILE__), "config/config.yml"))
+  Settings.register_settings_file('web_app', File.join(File.dirname(__FILE__), "config/config_web_app.yml"))
 or for ruby on rails :
-  (in an initializer in config/initializer)
-  Settings.register_settings_file('web_app', File.join(::Rails.root.to_s, "config/config.yml"))
-
+  (put this line in an initializer in config/initializer)
+  Settings.register_settings_file('web_app', File.join(::Rails.root.to_s, "config/config_web_app.yml"))
 Note : of course, the group name must be a valid keyword, able to be converted to a sym.
 
 And now you can access your settings from anywhere :
-  puts Settings.web_app.infos.company_name
+  Settings.web_app.infos.company_name     => 'Acme'
 (considering the YAML file given previously)
 
 You can register any number of group you want :
-  Settings.register_settings_file('web_game', File.join(File.dirname(__FILE__), "config/another_config.yml"))
-for this file :
+  Settings.register_settings_file('web_game', File.join(File.dirname(__FILE__), "config/config_web_game.yml"))
+example, with this file :
   ####### Common / default values #######
   defaults:
     guild_name: 'gang'
     party_size: 4
-Giving :
+gives :
   puts Settings.web_game.guild_name   => 'gang'
 
 It's common to have settings that you don't want under version control (accounts, passwords).
-A solution is to use a complementary file not under version control (gitignore). Just use :
+A solution is to use a complementary file not under version control (thanks to a gitignore for example). Just use :
   Settings.register_settings_file('web_app', File.join(File.dirname(__FILE__), "config/config_complement.yml"))
 Since the 'web_app' group already exists, data will be merged, the new one taking precedence in case of conflicts. (Precedence is set according to the order of declaration.)
 (All the source files are memorized, this is a complement, not a replacement.)
@@ -94,14 +95,14 @@ Since the 'web_app' group already exists, data will be merged, the new one takin
 In case you want to reload the settings, you have two functions for that :
   Settings.reload_all
   Settings.reload_group('web_app')
-(You may want to do that in development mode)
+(You may need that in development mode)
 
 == Advanced use
 Note : since those functions are rarely used, they don't have 'Settings.' shortcuts. Don't mind, it's the same.
 === Environment
 In a rails app, the environment will be taken automatically from 'Rails.env'.
 If not under a rails app or if the environment is not available, you may want to set it manually :
-  SettingsHolder.instance.environment = 'test'
+  SettingsHolder.instance.set_environment('test')
 (The existing files/groups will automatically be reloaded to take that into account.)
 
 === Reset

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/settings_tree/settings_holder.rb

@@ -77,12 +77,17 @@ class SettingsHolder
 		end
 	end
 	
-	def environment=(env)
+	# Set the environment to be used for conditional settings.
+	def set_environment(env)
 		@environment = env
 		
 		# need to reload all
 		reload_all
 	end
+	# same same
+	def environment=(env)
+		set_environment(env)
+	end
 	
 	def reload_all
 		@settings_list.each do |key, value|
@@ -182,16 +187,17 @@ class SettingsHolder
 			case src[:type]
 			when :file
 				begin
-					   complete_config = YAML.load_file( src[:value] ) || {}
-					    default_config = complete_config['defaults'] || {}
+					complete_config    = YAML.load_file( src[:value] ) || {}
+					default_config     = complete_config['defaults'] || {}
 					specialized_config = @environment.nil? ? {} : (complete_config[@environment] || {})
 					
 					data = default_config.deep_merge(specialized_config)
 				rescue Errno::ENOENT => e
 					# no file, classic error.
-					# resend
+					# resend as is
 					raise e
 				rescue Exception => e
+					# unexpected error : add details.
 					#puts e.inspect
 					raise RuntimeError, "XXX There was a problem in parsing the file #{src[:value]}. Please investigate... #{e.message}"
 				end
@@ -202,5 +208,4 @@ class SettingsHolder
 			return data
 		end
 		
-		
 end

data/settings-tree.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{settings-tree}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Offirmo}]
-  s.date = %q{2011-05-25}
+  s.date = %q{2011-05-31}
   s.description = %q{This gem offers you a convenient settings structure for parameterizing your application.
 Those settings are read from a YAML file.
 Inheritance of settings (like in development modes) and multiple settings groups are available.

data/spec/settings_holder_spec.rb

@@ -57,7 +57,7 @@ describe "SettingsHolder" do
 			SettingsHolder.instance.environment.should be_nil
 			SettingsHolder.instance.get_settings(:web_app).engine.auto_manage_workers_redirect_output.should == true
 			# change environment (settings are automatically reloaded)
-			SettingsHolder.instance.environment = 'development'
+			SettingsHolder.instance.set_environment('development')
 			# after
 			SettingsHolder.instance.environment.should == 'development'
 			SettingsHolder.instance.get_settings(:web_app).engine.auto_manage_workers_redirect_output.should == false
@@ -68,7 +68,7 @@ describe "SettingsHolder" do
 			SettingsHolder.instance.get_settings(:web_app).engine.auto_manage_workers_redirect_output.should == false
 			SettingsHolder.instance.get_settings(:web_app).engine.workers_count.should == 3
 			# change environment (settings are automatically reloaded)
-			SettingsHolder.instance.environment = 'test'
+			SettingsHolder.instance.set_environment('test')
 			# after
 			SettingsHolder.instance.environment.should == 'test'
 			SettingsHolder.instance.get_settings(:web_app).engine.auto_manage_workers_redirect_output.should == true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: settings-tree
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-25 00:00:00.000000000Z
+date: 2011-05-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: recursive-open-struct
-  requirement: &88517810 !ruby/object:Gem::Requirement
+  requirement: &86541720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *88517810
+  version_requirements: *86541720
 - !ruby/object:Gem::Dependency
   name: hash-deep-merge
-  requirement: &88517570 !ruby/object:Gem::Requirement
+  requirement: &86541480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *88517570
+  version_requirements: *86541480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &88517310 !ruby/object:Gem::Requirement
+  requirement: &86541240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *88517310
+  version_requirements: *86541240
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &88517070 !ruby/object:Gem::Requirement
+  requirement: &86540980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *88517070
+  version_requirements: *86540980
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &88516830 !ruby/object:Gem::Requirement
+  requirement: &86540740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *88516830
+  version_requirements: *86540740
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &88516570 !ruby/object:Gem::Requirement
+  requirement: &86540500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *88516570
+  version_requirements: *86540500
 description: ! 'This gem offers you a convenient settings structure for parameterizing
   your application.
 
@@ -127,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 370010543
+      hash: -827487391
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: