rconfig 0.4.2 → 0.4.3

data/lib/rconfig.rb

@@ -65,7 +65,7 @@ require 'rconfig/core_ext/hash'
 require 'rconfig/core_ext/nil'
 
 module RConfig
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 
   autoload :Socket,                    'socket'
   autoload :YAML,                      'yaml'

data/lib/rconfig/load_paths.rb

@@ -21,6 +21,7 @@ module RConfig
     def add_load_path(path)
       if path = parse_load_paths(path).first # only accept first one.
         self.load_paths << path
+        self.load_paths.uniq!
         return reload(true)  # Load Paths have changed so force a reload
       end
       false
@@ -30,7 +31,6 @@ module RConfig
     # If the paths are made up of a delimited string, then parse out the
     # individual paths. Verify that each path is valid.
     def parse_load_paths(paths)
-      return [] unless paths
       if paths.is_a? String
         path_sep = (paths =~ /;/) ? ';' : ':'
         paths = paths.split(/#{path_sep}+/)
@@ -39,7 +39,7 @@ module RConfig
       raise ArgumentError, "Must provide at least one load path: [#{paths.inspect}]" if paths.empty?
       paths.each do |dir|
         dir = CONFIG_ROOT if dir == 'CONFIG_ROOT'
-        raise RConfig::InvalidConfigPathError, "This directory is invalid: [#{dir.inspect}]" unless Dir.exists?(dir)
+        raise InvalidLoadPathError, "This directory is invalid: [#{dir.inspect}]" unless Dir.exists?(dir)
       end
       paths
     end

data/lib/tasks/rdoc.rake

@@ -1,11 +1,10 @@
-namespace :rdoc do
+require 'rdoc/task'
 
-  Rake::RDocTask.new(:build) do |rdoc|
+namespace :rdoc do
+  RDoc::Task.new(:build) do |rdoc|
     rdoc.rdoc_dir = "doc"
     rdoc.main = "README.rdoc"
     rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
     rdoc.options << "--all"
   end
- 
 end
-

data/rconfig.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.version       = RConfig::VERSION
   s.authors       = ['Rahmal Conda']
   s.email         = ['rahmal@gmail.com']
-  s.homepage      = 'http://www.rahmalconda.com'
+  s.homepage      = 'http://rahmal.github.com/rconfig'
   s.description   = %q{Configuration management library for Ruby applications.}
   s.summary       = %q{The complete solution for Ruby Configuration Management. RConfig is a Ruby library that manages configuration within Ruby applications. It bridges the gap between yaml, xml, and key/value based properties files, by providing a centralized solution to handle application configuration from one location. It provides the simplicity of hash-based access, that Rubyists have come to know and love, supporting your configuration style of choice, while providing many new features, and an elegant API.}
   s.licenses      = ['MIT']
@@ -21,13 +21,15 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
   # Dependencies
   s.add_dependency 'activesupport',       '~>   3.0'
 
+  # Development Dependencies
   s.add_development_dependency 'rspec',   '~> 2.3.0'
   s.add_development_dependency 'bundler', '~> 1.0.0'
   s.add_development_dependency 'jeweler', '~> 1.6.4'
+  s.add_development_dependency 'i18n'
 end
 

data/spec/config/erb_contents.yml

@@ -0,0 +1,3 @@
+admin:
+  name: <%= ENV['USER'] %>
+  home: <%= ENV['HOME'] %>

data/spec/config/props_config.conf

@@ -0,0 +1,18 @@
+[admin]
+name="Harry Potter"
+email="harry@hogwarts.com"
+
+[server]
+host=127.0.0.1
+port=8080
+
+[teams "alpha"]
+name="Alpha Squad"
+location="San Francisco, CA"
+num_members=12
+
+[teams "beta"]
+name="Beta Squad"
+location="New York, NY"
+num_members=10
+

data/spec/config/spec.yml

@@ -0,0 +1,17 @@
+admin:
+  name: 'Harry Potter'
+  email: 'harry@hogwarts.com'
+
+server:
+  host: 127.0.0.1
+  port: 8080
+
+teams:
+  alpha:
+    name: 'Alpha Squad'
+    location: 'San Francisco, CA'
+    num_members: 12
+  beta:
+    beta: 'Beta Squad'
+    location: 'New York, NY'
+    num_members: 10

data/spec/config/xml_config.xml

@@ -0,0 +1,22 @@
+<xml_config>
+  <admin>
+    <name>Harry Potter</name>
+    <email>harry@hogwarts.com</email>
+  </admin>
+  <server>
+    <host>127.0.0.1</host>
+    <port>8080</port>
+  </server>
+  <teams>
+    <alpha>
+      <name>Alpha Squad</name>
+      <location>San Francisco, CA</location>
+      <num_members>12</num_members>
+    </alpha>
+    <beta>
+      <name>Beta Squad</name>
+      <location>New York, NY</location>
+      <num_members>10</num_members>
+    </beta>
+  </teams>
+</xml_config>

data/spec/rconfig/load_paths_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe RConfig do
+  before :each do
+    RConfig.load_paths = ['spec/config']
+  end
+
+  context 'load paths' do
+    it 'should have a valid load path' do
+      RConfig.load_paths.should_not be_blank
+      RConfig.load_paths.all?{|path| File.exists?(path) }.should be_true
+    end
+
+    it 'should allow multiple load paths' do
+      lambda { RConfig.add_load_path('spec/config2') }.should_not raise_error
+      RConfig.load_paths.size.should == 2
+    end
+
+    it 'should not allow duplicate load paths' do
+      RConfig.add_load_path('spec/config')
+      RConfig.load_paths.size.should == 1
+    end
+
+    it 'should not allow nil paths' do
+      lambda { RConfig.add_load_path(nil) }.should raise_error(ArgumentError)
+    end
+
+    it 'should not allow blank paths' do
+      lambda { RConfig.add_load_path('') }.should raise_error(ArgumentError)
+    end
+
+    it 'shoud not allow paths that do not exist' do
+      lambda { RConfig.add_load_path('/bad/path') }.should raise_error(RConfig::InvalidLoadPathError)
+    end
+  end
+
+end

data/spec/rconfig/reload_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe RConfig do
+  before :each do
+    RConfig.load_paths = ['spec/config']
+  end
+
+  context 'reload' do
+    it 'should reload when path is added' do
+      RConfig.should_receive(:reload).with(true).and_return(true)
+      RConfig.add_load_path('spec')
+    end
+
+    it 'should reload if reload enabled' do
+      RConfig.enable_reload = true
+      RConfig.reload.should be_true
+    end
+
+    it 'should not reload if reload disabled' do
+      RConfig.enable_reload = false
+      RConfig.reload.should be_false
+    end
+
+    it 'should reload if forced' do
+      RConfig.enable_reload = false
+      RConfig.reload(true).should be_true
+    end
+
+    it 'should flush cache on reload' do
+      RConfig.should_receive(:flush_cache)
+      RConfig.reload(true)
+      RConfig.cache.should == {}
+    end
+
+  end
+
+end

data/spec/rconfig_spec.rb

@@ -1,7 +1,65 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "RConfig" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe RConfig do
+  before :each do
+    RConfig.load_paths = ['spec/config']
+  end
+
+  context 'reading config' do
+    it 'should read config for the specified file' do
+      RConfig.spec.should == CONFIG
+    end
+
+    it 'should read xml files' do
+      RConfig.xml_config.should == CONFIG2
+    end
+
+    it 'should read property files' do
+      RConfig.props_config.should == CONFIG2
+    end
+
+    it 'accept string keys' do
+      RConfig.spec['admin'].should == CONFIG['admin']
+    end
+
+    it 'should accept symbol keys' do
+      RConfig.spec[:admin].should == CONFIG['admin']
+    end
+
+    it 'should accept keys by method invocation' do
+      RConfig.spec.admin.should == CONFIG['admin']
+    end
+
+    it 'should return empty config for bad file names' do
+      RConfig.bad.should be_blank
+    end
+
+    it 'should return nil for bad properties' do
+      RConfig.spec.bad.should be_nil
+    end
+
+    it 'should parse erb contents' do
+      RConfig.erb_contents.admin.name.should == ENV['USER']
+      RConfig.erb_contents.admin.home.should == ENV['HOME']
+    end
+  end
+
+  context 'parsing files' do
+    it 'should raise error for bad file types' do
+      contents = %Q{{"admin"=>{"name"=>"/Users/rahmal", "home"=>"rahmal"}}}
+      lambda { RConfig.parse(contents, 'some_file', :bad) }.should raise_error(RConfig::ConfigError)
+    end
+
+    it 'should parse properties files with PropertiesFile parser' do
+      contents = %Q{{"admin"=>{"name"=>"/Users/rahmal", "home"=>"rahmal"}}}
+      RConfig::PropertiesFile.should_receive(:parse).with(contents)
+      RConfig.parse(contents, 'props_file', :conf)
+    end
+
+    it 'should parse xml files with activesupport hash' do
+      contents = "<admin><name>/Users/rahmal</name><home>rahmal</home></admin>"
+      Hash.should_receive(:from_xml).with(contents)
+      RConfig.parse(contents, 'xml_file', :xml)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,16 +1,20 @@
 ROOT_DIR = File.expand_path(File.dirname(__FILE__))
-CONF_DIR = File.join(ROOT_DIR, '..', 'test', 'config_files')
-
-STDOUT.puts "ROOT_DIR: #{ROOT_DIR}"
-STDOUT.puts "CONF_DIR: #{CONF_DIR}"
+CONF_DIR = File.join(ROOT_DIR, 'config')
 
 # Loads the rconfig library
 $LOAD_PATH << File.join(ROOT_DIR, '..', 'lib')
 
+require 'yaml'
+require 'active_support'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/hash/conversions'
 require 'rconfig'
 
-RConfig.initialize CONF_DIR, nil, true, true
-
-# Requires supporting files in ./support/ and its subdirectories.
-#Dir["#{ROOT_DIR}/support/**/*.rb"].each {|f| require f}
+RConfig.setup do |config|
+  config.load_paths = ['spec/config']
+  config.file_types = [:yml, :xml, :conf]
+  config.logger = RConfig::DisabledLogger.new
+end
 
+CONFIG  = YAML.load_file(CONF_DIR + '/spec.yml')
+CONFIG2 = Hash.from_xml(File.read(CONF_DIR + '/xml_config.xml'))['xml_config']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rconfig
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000Z
+date: 2012-05-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70268560044680 !ruby/object:Gem::Requirement
+  requirement: &70353384810220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70268560044680
+  version_requirements: *70353384810220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70268560044100 !ruby/object:Gem::Requirement
+  requirement: &70353384803680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70268560044100
+  version_requirements: *70353384803680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70268560043620 !ruby/object:Gem::Requirement
+  requirement: &70353384799540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70268560043620
+  version_requirements: *70353384799540
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70268560043160 !ruby/object:Gem::Requirement
+  requirement: &70353384798380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,18 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70268560043160
+  version_requirements: *70353384798380
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70353384798000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70353384798000
 description: Configuration management library for Ruby applications.
 email:
 - rahmal@gmail.com
@@ -77,32 +88,51 @@ files:
 - demo/demo.rb
 - demo/demo.xml
 - demo/demo.yml
-- doc/classes/ClassVariables.html
-- doc/classes/ConfigError.html
-- doc/classes/ConfigHash.html
-- doc/classes/Constants.html
-- doc/classes/Hash.html
-- doc/classes/InvalidConfigPathError.html
-- doc/classes/Object.html
-- doc/classes/PropertiesFileParser.html
-- doc/classes/RConfig.html
+- doc/Array.html
+- doc/Hash.html
+- doc/NilClass.html
+- doc/RConfig.html
+- doc/RConfig/Callbacks.html
+- doc/RConfig/Cascade.html
+- doc/RConfig/Config.html
+- doc/RConfig/ConfigError.html
+- doc/RConfig/Constants.html
+- doc/RConfig/CoreMethods.html
+- doc/RConfig/DisabledLogger.html
+- doc/RConfig/Exceptions.html
+- doc/RConfig/Generators.html
+- doc/RConfig/Generators/InstallGenerator.html
+- doc/RConfig/InvalidLoadPathError.html
+- doc/RConfig/LoadPaths.html
+- doc/RConfig/Logger.html
+- doc/RConfig/PropertiesFile.html
+- doc/RConfig/Reload.html
+- doc/RConfig/Settings.html
+- doc/RConfig/Utils.html
+- doc/README_rdoc.html
+- doc/String.html
 - doc/created.rid
-- doc/files/README_rdoc.html
-- doc/files/lib/rconfig/class_variables_rb.html
-- doc/files/lib/rconfig/config_hash_rb.html
-- doc/files/lib/rconfig/constants_rb.html
-- doc/files/lib/rconfig/core_ext/hash_rb.html
-- doc/files/lib/rconfig/core_ext/object_rb.html
-- doc/files/lib/rconfig/core_ext_rb.html
-- doc/files/lib/rconfig/exceptions_rb.html
-- doc/files/lib/rconfig/properties_file_parser_rb.html
-- doc/files/lib/rconfig/rconfig_rb.html
-- doc/files/lib/rconfig_rb.html
-- doc/fr_class_index.html
-- doc/fr_file_index.html
-- doc/fr_method_index.html
 - doc/index.html
-- doc/rdoc-style.css
+- doc/lib/generators/rconfig/install_generator_rb.html
+- doc/lib/generators/rconfig/templates/rconfig_rb.html
+- doc/lib/rconfig/callbacks_rb.html
+- doc/lib/rconfig/cascade_rb.html
+- doc/lib/rconfig/config_rb.html
+- doc/lib/rconfig/constants_rb.html
+- doc/lib/rconfig/core_ext/array_rb.html
+- doc/lib/rconfig/core_ext/hash_rb.html
+- doc/lib/rconfig/core_ext/nil_rb.html
+- doc/lib/rconfig/core_ext/string_rb.html
+- doc/lib/rconfig/core_methods_rb.html
+- doc/lib/rconfig/exceptions_rb.html
+- doc/lib/rconfig/load_paths_rb.html
+- doc/lib/rconfig/logger_rb.html
+- doc/lib/rconfig/properties_file_rb.html
+- doc/lib/rconfig/reload_rb.html
+- doc/lib/rconfig/settings_rb.html
+- doc/lib/rconfig/utils_rb.html
+- doc/lib/rconfig_rb.html
+- doc/rdoc.css
 - lib/generators/rconfig/install_generator.rb
 - lib/generators/rconfig/templates/rconfig.rb
 - lib/rconfig.rb
@@ -122,15 +152,19 @@ files:
 - lib/rconfig/reload.rb
 - lib/rconfig/settings.rb
 - lib/rconfig/utils.rb
-- lib/tasks/gem.rake
 - lib/tasks/rdoc.rake
-- lib/tasks/spec.rake
 - rconfig.gemspec
-- spec/core_ext/object_spec.rb
+- spec/config/erb_contents.yml
+- spec/config/props_config.conf
+- spec/config/spec.yml
+- spec/config/xml_config.xml
+- spec/config2/.gitkeep
+- spec/rconfig/load_paths_spec.rb
+- spec/rconfig/reload_spec.rb
 - spec/rconfig_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-homepage: http://www.rahmalconda.com
+homepage: http://rahmal.github.com/rconfig
 licenses:
 - MIT
 post_install_message: 
@@ -143,6 +177,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1353132617575235595
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -162,8 +199,13 @@ summary: The complete solution for Ruby Configuration Management. RConfig is a R
   your configuration style of choice, while providing many new features, and an elegant
   API.
 test_files:
-- spec/core_ext/object_spec.rb
+- spec/config/erb_contents.yml
+- spec/config/props_config.conf
+- spec/config/spec.yml
+- spec/config/xml_config.xml
+- spec/config2/.gitkeep
+- spec/rconfig/load_paths_spec.rb
+- spec/rconfig/reload_spec.rb
 - spec/rconfig_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: