appcfg 0.1.1 → 0.2.0

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - ree

data/Gemfile

@@ -1,13 +1,8 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem 'simplecov', '>= 0.4.0', :require => false
+  gem "rspec"
+  gem "bundler"
+  gem "jeweler"
+  gem 'simplecov'
 end

data/README.rdoc

@@ -14,6 +14,8 @@ A gem for centralizing different sources of application configuration data. Supp
 
 [From hash object]          AppCfg::Source.add({:some_key => 'value'})
 
+[From .properties file (features missing! Refer to pending tests)]     AppCfg::Source.add('/path/to/configuration.properties')
+
 === Accessing configuration values
 
 Configuration data can be accessed via both object and hash syntax, called on AppCfg module:
@@ -48,6 +50,10 @@ Configuration values are cached at the moment of being added. If sources are mod
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+== Contributors
+
+* lorrin (Lorrin Nelson)
+
 == Copyright
 
 Copyright (c) 2011 Toms Mikoss. See LICENSE.txt for

data/Rakefile

@@ -38,13 +38,3 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
 end
 
 task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "appcfg #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

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

data/lib/appcfg.rb

@@ -3,6 +3,7 @@ require 'appcfg/retrieval'
 require 'appcfg/source'
 require 'appcfg/sources/yaml_source'
 require 'appcfg/sources/model_source'
+require 'appcfg/sources/properties_source'
 
 module AppCfg
   @@cache = {}

data/lib/appcfg/source.rb

@@ -5,24 +5,28 @@ module AppCfg
 
   class Source
     @@sources = []
-    
+
     def initialize(options={})
       @hash = options
     end
-    
+
     def to_hash
       @hash
     end
-    
+
     def reload_data!
       #Do nothing
     end
-    
+
     def self.add(source_object, options={})
       if source_object.is_a?(String) && source_object[-4..-1] == '.yml'
         #YAML
         raise "File #{source_object} could not be located" unless File.exist? source_object
         add_source(YamlSource.new(options.merge(:file => source_object)))
+      elsif source_object.is_a?(String) && source_object[-11..-1] == '.properties'
+        #.properties
+        raise "File #{source_object} could not be located" unless File.exist? source_object
+        add_source(PropertiesSource.new(options.merge(:file => source_object)))
       elsif source_object.is_a?(Class) && source_object.respond_to?(:all)
         #AR Model
         add_source(ModelSource.new(options.merge(:class => source_object)))
@@ -38,44 +42,58 @@ module AppCfg
       @@sources = []
       reload_sources!
     end
-    
+
     def self.list
       @@sources
     end
-    
+
     def self.reload_sources!
       cache = {}
-      
+
       @@sources.each do |source|
         source.reload_data!
-        cache = cache.merge(source.to_hash)
+        cache = recursive_merge(cache, source.to_hash)
       end
-      
-      AppCfg.set_cache hash_to_object(cache)
+
+      AppCfg.set_cache add_key_methods cache
     end
-    
+
     private
-    
+
     def self.add_source(source)
       @@sources << source
       reload_sources!
     end
-    
-    #Credit to http://blog.jayfields.com/2008/01/ruby-hashtomod.html
-    def self.hash_to_object(hash)
+
+    def self.recursive_merge(base, other)
+      other.each do |key, value|
+        if base[key].is_a?(Hash) && value.is_a?(Hash)
+          base[key] = recursive_merge(base[key], value)
+        else
+          base[key] = value
+        end
+      end
+
+      base
+    end
+
+    def self.add_key_methods(base)
       mod = Module.new do
-        hash.each_pair do |key, value|
+        base.each do |key, value|
           define_method key do
-            value.is_a?(Hash) ? AppCfg::Source.hash_to_object(value) : value
+            value
           end
         end
       end
-      
-      new_hash = hash.dup
-      
-      new_hash.extend mod
-      
-      new_hash
+
+      base.extend mod
+
+      base.each do |key, value|
+        next unless value.is_a? Hash
+        base[key] = add_key_methods(value)
+      end
+
+      base
     end
   end
 end

data/lib/appcfg/sources/properties_source.rb

@@ -0,0 +1,61 @@
+module AppCfg
+
+  # TODO: consider treating . in properties names as a nesting operatator. E.g. maven.groupId=xyz creates AppCfg['maven'] = { 'groupId' => 'xyz' }
+  # TODO: environment support? Perhaps file-name convention or also with .-delimited properties names? E.g. maven.groupId.test
+
+  class PropertiesSource < Source
+    def initialize(options = {})
+      @filename = options[:file]
+      @namespace = options[:env]
+    end
+
+    def reload_data!
+      properties = JavaProperties.new(@filename)
+      @hash = properties.properties
+    end
+  end
+
+
+  # JavaProperties class from https://github.com/axic/rsnippets/blob/master/javaproperties.rb (originally from
+  # https://devender.wordpress.com/2006/05/01/reading-and-writing-java-property-files-with-ruby/)
+  #
+  # Consider splitting into own project and including as a gem. Some features missing: escape handling
+  # error handling, perhaps whitespace edge cases as well.
+  #
+  # Consider checking for presence of JRuby and invoking java.util.Properties if available.
+  class JavaProperties
+    attr_accessor :filename, :properties
+
+    def initialize(filename)
+      @filename = filename
+      @properties = {}
+
+      IO.foreach(@filename) do |line|
+        @properties[$1.strip] = $2 if line = ~ /([^=]*)=(.*)\/\/(.*)/ || line =~ /([^=]*)=(.*)/
+      end
+    end
+
+    def to_s
+      output = "File name #{@file}\n"
+      @properties.each { |key, value| output += " #{key} = #{value}\n" }
+      output
+    end
+
+    def add(key, value = nil)
+      return unless key.length > 0
+      @properties[key] = value
+    end
+
+    def remove(key)
+      return unless key.length > 0
+      @properties.delete(key)
+    end
+
+    def save
+      file = File.new(@filename, "w+")
+      @properties.each { |key, value| file.puts "#{key}=#{value}\n" }
+      file.close
+    end
+  end
+
+end

data/lib/appcfg/sources/yaml_source.rb

@@ -6,8 +6,8 @@ module AppCfg
     end
     
     def reload_data!
-      yaml_structure = YAML.load(File.open @filename)
-      @hash          = @namespace ? yaml_structure[@namespace] : yaml_structure
+      yaml_structure = YAML.load(File.open @filename) || {} # empty hash instead of false when file is empty
+      @hash          = @namespace ? yaml_structure[@namespace]||{} : yaml_structure
     end
   end
 end

data/spec/properties_source_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AppCfg retrieval from Properties" do
+  describe "not environment namespaced" do
+    before(:each) do
+      AppCfg::Source.add(@sample_properties_file_path)
+    end
+
+    it "should support hash syntax for access" do
+      AppCfg['app_name'].should == 'AppCfg'
+    end
+
+    it "should support object syntax for access" do
+      AppCfg.app_name.should == 'AppCfg'
+    end
+
+    it "should return nil on non-existent key, hash syntax" do
+      AppCfg['wrong_key'].should be_nil
+    end
+
+    it "should raise error on non-existent key, object syntax" do
+      lambda {
+        AppCfg.wrong_key
+      }.should raise_error
+    end
+
+    it "Should not trim trailing spaces" do
+      AppCfg['has'].should == "five trailing spaces     "
+    end
+
+    context "TODO" do
+      before { pending "not yet supported" }
+      
+      it "should allow multi-level access with hash syntax" do
+        AppCfg['admin_credentials']['username'].should == 'admin'
+      end
+      
+      it "should allow multi-level access with object syntax" do
+        AppCfg.admin_credentials.username.should == 'admin'
+      end
+      
+      it "should support colon-delimited properties" do
+        AppCfg['colon'].should == "another delimiter"
+      end
+      
+      it "should trim spaces around delimiter" do
+        AppCfg["website"].should == "http://en.wikipedia.org/"
+      end
+      
+      it "should support multi-line values" do
+        AppCfg["message"].should == "Welcome to         Wikipedia!"
+      end
+      
+      it "should support keys with spaces" do
+        AppCfg["key with spaces"].should == 'This is the value that could be looked up with the key "key with spaces".'
+      end
+      
+      it "should support Unicode escapes" do
+        AppCfg["tab"].should == "\t"
+      end
+    end
+  end
+end
+
+describe "AppCfg retrieval from empty properties" do
+  describe "not environment namespaced" do
+    before(:each) do
+      AppCfg::Source.add(@sample_properties_empty_file_path)
+    end
+
+    it "should load but be empty" do
+      AppCfg['app_name'].should == nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -15,10 +15,14 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   config.before(:each) do
     AppCfg::Source.clear
-    @sample_env_yaml_file_path = File.expand_path(File.dirname(__FILE__) + '/support/sample_env_config.yml')
-    @sample_yaml_file_path     = File.expand_path(File.dirname(__FILE__) + '/support/sample_config.yml')
+    @sample_env_yaml_file_path         = File.expand_path(File.dirname(__FILE__) + '/support/sample_env_config.yml')
+    @sample_yaml_file_path             = File.expand_path(File.dirname(__FILE__) + '/support/sample_config.yml')
+    @sample_yaml_empty_file_path       = File.expand_path(File.dirname(__FILE__) + '/support/sample_empty_config.yml')
+    @sample_properties_file_path       = File.expand_path(File.dirname(__FILE__) + '/support/sample_config.properties')
+    @sample_properties_empty_file_path = File.expand_path(File.dirname(__FILE__) + '/support/sample_empty_config.properties')
+    @sample_overlapping_file_path      = File.expand_path(File.dirname(__FILE__) + '/support/sample_overlapping_config.yml')
   end
-  
+
   config.after(:each) do
     SampleConfig.reset_storage!
   end

data/spec/support/sample_config.properties

@@ -0,0 +1,19 @@
+# From: https://secure.wikimedia.org/wikipedia/en/wiki/.properties
+# You are reading the ".properties" entry.
+! The exclamation mark can also mark text as comments.
+website = http://en.wikipedia.org/
+language = English
+# The backslash below tells the application to continue reading
+# the value onto the next line.
+message = Welcome to \
+          Wikipedia!
+# Add spaces to the key
+key\ with\ spaces = This is the value that could be looked up with the key "key with spaces".
+# Unicode
+tab : \u0009
+
+
+# More additions
+colon:another delimiter
+has=five trailing spaces     
+app_name=AppCfg

data/spec/support/sample_empty_config.yml

@@ -0,0 +1 @@
+# Nothing in here. YAML.load for this file will return false

data/spec/support/sample_overlapping_config.yml

@@ -0,0 +1,4 @@
+admin_credentials:
+  enabled: false
+  password: newpass
+worker_count: 4

data/spec/yaml_source_spec.rb

@@ -5,63 +5,110 @@ describe "AppCfg retrieval from YAML" do
     before(:each) do
       AppCfg::Source.add(@sample_yaml_file_path)
     end
-    
+
     it "should support hash syntax for access" do
       AppCfg['app_name'].should == 'AppCfg'
     end
-    
+
     it "should support object syntax for access" do
       AppCfg.app_name.should == 'AppCfg'
     end
-    
+
     it "should allow multi-level access with hash syntax" do
       AppCfg['admin_credentials']['username'].should == 'admin'
     end
-    
+
     it "should allow multi-level access with object syntax" do
       AppCfg.admin_credentials.username.should == 'admin'
     end
-    
+
     it "should return nil on non-existent key, hash syntax" do
       AppCfg['wrong_key'].should be_nil
     end
-    
+
     it "should raise error on non-existent key, object syntax" do
       lambda {
         AppCfg.wrong_key
       }.should raise_error
     end
   end
-  
+
   describe "environment namespaced" do
     before(:each) do
       AppCfg::Source.add(@sample_env_yaml_file_path, :env => 'test')
     end
-    
+
     it "should support hash syntax for access" do
       AppCfg['app_name'].should == 'AppCfg'
     end
-    
+
     it "should support object syntax for access" do
       AppCfg.app_name.should == 'AppCfg'
     end
-    
+
     it "should allow multi-level access with hash syntax" do
       AppCfg['admin_credentials']['password'].should == 'testpass'
     end
-    
+
     it "should allow multi-level access with object syntax" do
       AppCfg.admin_credentials.password.should == 'testpass'
     end
-    
+
     it "should return nil on non-existent key, hash syntax" do
       AppCfg['wrong_key'].should be_nil
     end
-    
+
     it "should raise error on non-existent key, object syntax" do
       lambda {
         AppCfg.wrong_key
       }.should raise_error
     end
   end
+  describe "environment namespaced (but namespace not found)" do
+    before(:each) do
+      AppCfg::Source.add(@sample_env_yaml_file_path, :env => 'bogus')
+    end
+
+    it "should load but be empty" do
+      AppCfg['app_name'].should == nil
+    end
+  end
+
+  describe "overlapping config files" do
+    before(:each) do
+      AppCfg::Source.add(@sample_yaml_file_path)
+      AppCfg::Source.add(@sample_overlapping_file_path)
+    end
+
+    it "should merge hashes" do
+      AppCfg.admin_credentials.username.should == 'admin'
+      AppCfg.admin_credentials.enabled.should be_false
+    end
+
+    it "should overwrite values" do
+      AppCfg.worker_count.should eq 4
+      AppCfg.admin_credentials.password.should == 'newpass'
+    end
+  end
+end
+describe "AppCfg retrieval from empty YAML" do
+  describe "not environment namespaced" do
+    before(:each) do
+      AppCfg::Source.add(@sample_yaml_empty_file_path)
+    end
+
+    it "should load but be empty" do
+      AppCfg['app_name'].should == nil
+    end
+  end
+
+  describe "environment namespaced" do
+    before(:each) do
+      AppCfg::Source.add(@sample_yaml_empty_file_path, :env => 'test')
+    end
+
+    it "should load but be empty" do
+      AppCfg['app_name'].should == nil
+    end
+  end
 end

metadata

@@ -1,75 +1,93 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: appcfg
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Toms Mikoss
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-29 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.3.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.5.2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.4.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-description: A gem for centralizing different sources of application configuration data. Supports YAML files, ActiveRecord models and simple hashes as data sources.
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem for centralizing different sources of application configuration
+  data. Supports YAML files, ActiveRecord models and simple hashes as data sources.
 email: toms.mikoss@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - .document
 - .rspec
+- .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
@@ -78,49 +96,47 @@ files:
 - lib/appcfg/retrieval.rb
 - lib/appcfg/source.rb
 - lib/appcfg/sources/model_source.rb
+- lib/appcfg/sources/properties_source.rb
 - lib/appcfg/sources/yaml_source.rb
 - spec/hash_source_config_spec.rb
 - spec/model_source_spec.rb
+- spec/properties_source_spec.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb
 - spec/support/classes/sample_config.rb
+- spec/support/sample_config.properties
 - spec/support/sample_config.yml
+- spec/support/sample_empty_config.properties
+- spec/support/sample_empty_config.yml
 - spec/support/sample_env_config.yml
+- spec/support/sample_overlapping_config.yml
 - spec/yaml_source_spec.rb
 homepage: http://github.com/tmikoss/appconfig
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -3676381599097783147
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -1033711763
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A gem for centralizing different sources of application configuration data.
-test_files: 
-- spec/hash_source_config_spec.rb
-- spec/model_source_spec.rb
-- spec/source_spec.rb
-- spec/spec_helper.rb
-- spec/support/classes/sample_config.rb
-- spec/yaml_source_spec.rb
+test_files: []

data/Gemfile.lock

@@ -1,30 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.8.7)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    simplecov (0.4.2)
-      simplecov-html (~> 0.4.4)
-    simplecov-html (0.4.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
-  rspec (~> 2.3.0)
-  simplecov (>= 0.4.0)