settings-tree 0.1.1 → 0.2.0

data/Gemfile.lock

@@ -10,7 +10,7 @@ GEM
       rake
     rake (0.9.0)
     rcov (0.9.9)
-    recursive-open-struct (0.1.0)
+    recursive-open-struct (0.2.0)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)

data/README.rdoc

@@ -15,7 +15,7 @@ Example :
 Those settings are read from a YAML file, like this one :
 
   # YAML private config file
-  # XXX Beware ! This YAML : indention with spaces only ! XXX
+  # XXX Beware ! This is YAML : indention with spaces only ! XXX
   
   ####### Common / default values #######
   defaults:
@@ -60,40 +60,58 @@ Available as a gem
 Isn't it 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"))
 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"))
 
+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
-
-Note : of course, the group name must be a valid keyword, able to be converted to a sym.
+(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"))
-And then :
-  puts Settings.web_game.guild_name.should == 'gang'
+for this file :
+  ####### Common / default values #######
+  defaults:
+    guild_name: 'gang'
+    party_size: 4
+Giving :
+  puts Settings.web_game.guild_name   => 'gang'
 
-It's common to have settings that you don't want to stay under version control (accounts, passwords).
-A solution is to use a complementary file not under version control. Just use :
+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 :
   Settings.register_settings_file('web_app', File.join(File.dirname(__FILE__), "config/config_complement.yml"))
-And data will be merged, the new one taking precedence in case of conflicts.
+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.)
 
 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)
 
 == 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, set it manually :
+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'
-The files will automatically be reloaded to take that into account.
+(The existing files/groups will automatically be reloaded to take that into account.)
 
+=== Reset
 You may also want to reset all the settings (everything will be forgotten) :
   SettingsHolder.instance.reset
-  
+
+=== Debug
+A convenient debug function to see all the settings and their values :
+  SettingsHolder.instance.debug_inspect
+
 == Contributing to settings-tree
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/settings_tree/settings_holder.rb

@@ -31,7 +31,18 @@ class SettingsHolder
 		initialize
 	end
 	
-	#
+	# a convenience function which displays the datas
+	def debug_inspect
+		puts "*** Current settings :"
+		#puts @settings_list.inspect
+		@settings_list.each do |key, value|
+			puts "Settings.#{key}."
+			@settings_list[key][:data].debug_inspect(1)
+		end
+	end
+	
+	# Register a source file for a group.
+	# The group will be created if not already existing.
 	def register_settings_file(name, file)
 		
 		group_just_created = false
@@ -55,6 +66,7 @@ class SettingsHolder
 		return res
 	end
 	
+	# Return this group of settings as an openstruct
 	def get_settings(name)
 		#puts name.inspect
 		#puts @settings_list.inspect

data/settings-tree.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{settings-tree}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Offirmo}]

data/spec/settings_holder_spec.rb

@@ -28,6 +28,9 @@ describe "SettingsHolder" do
 		end
 		
 		it "should load all settings" do
+			
+			SettingsHolder.instance.debug_inspect
+			
 			# and now let's query all the expected settings
 			SettingsHolder.instance.get_settings(:web_app).root_url.should == 'localhost:3000'
 			SettingsHolder.instance.get_settings(:web_app).public_access.should be_true

data/spec/test_files/config.yml

@@ -1,7 +1,7 @@
 # YAML private config file
 # http://kpumuk.info/ruby-on-rails/flexible-application-configuration-in-ruby-on-rails/
 
-# XXX Beware ! This YAML : indention with spaces only ! XXX
+# XXX Beware ! This is YAML : indention with spaces only ! XXX
 
 
 ####### Common / default values #######

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: settings-tree
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-05-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: recursive-open-struct
-  requirement: &79882210 !ruby/object:Gem::Requirement
+  requirement: &88517810 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79882210
+  version_requirements: *88517810
 - !ruby/object:Gem::Dependency
   name: hash-deep-merge
-  requirement: &79881970 !ruby/object:Gem::Requirement
+  requirement: &88517570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79881970
+  version_requirements: *88517570
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &79881730 !ruby/object:Gem::Requirement
+  requirement: &88517310 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79881730
+  version_requirements: *88517310
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &79881490 !ruby/object:Gem::Requirement
+  requirement: &88517070 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79881490
+  version_requirements: *88517070
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &79881250 !ruby/object:Gem::Requirement
+  requirement: &88516830 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79881250
+  version_requirements: *88516830
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &79881010 !ruby/object:Gem::Requirement
+  requirement: &88516570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79881010
+  version_requirements: *88516570
 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: 228111425
+      hash: 370010543
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: