configy 0.0.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gabe Varela
+
+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.rdoc

@@ -0,0 +1,49 @@
+== Configy
+
+== Description
+
+It allows to have a file (config/config.yml) with application configuration parameters.
+It should have a "common" section with all parameters along with default values and can also
+contain a section for each of the rails environments (development, test, production, or 
+your custom one). The values from the current environment section will override the values in the 
+"common" section.
+
+If some developer needs his own specific values for his working copy, he can simply create 
+a config/config.local.yml file and override any value there, again having a "common" section 
+and a section for each environment. 
+
+Nothing is mandatory (files, sections) you just have what you really need. The files are parsed with ERB,
+so they can contain some Ruby. It also checks for file modifications so you don't have to restart the server to pick up new values on production.
+
+== Usage
+
+An example of a config file (config.yml):
+
+  common:
+    admin_email: admin@domain.com
+    xml_rpc_url: http://domain.com:8000/
+    media_path: <%= RAILS_ROOT %>/tmp/media
+
+  development:
+    xml_rpc_url: http://localhost:8000/
+
+  test:
+    xml_rpc_url: http://localhost:8008/
+  
+In an initializer
+  Configy.create(:config)
+
+Then, in the application you can use the config parameters like this:
+
+  Config.xml_rpc_url
+
+So it means that you've got a Config object which holds all the configuration parameters defined. 
+It doesn't allow to change the values in the application code, BTW.
+
+== Authors
+Gabe Varela
+
+The Configy gem based on the AppConfig plugin which was evolved from the original plugin by Eugene Bolshakov, eugene.bolshakov@gmail.com, http://www.taknado.com
+
+The plugin is based on the idea described here:
+http://kpumuk.info/ruby-on-rails/flexible-application-configuration-in-ruby-on-rails/lang-pref/en/

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "configy"
+    gem.summary = %Q{simple application configuration}
+    gem.email = "gvarela@gmail.com"
+    gem.homepage = "http://github.com/gvarela/configy"
+    gem.authors = ["Gabe Varela"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "configy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/configy.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{configy}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gabe Varela"]
+  s.date = %q{2009-10-08}
+  s.email = %q{gvarela@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "configy.gemspec",
+     "lib/configy.rb",
+     "lib/configy/configuration.rb",
+     "test/configy_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/gvarela/configy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{simple application configuration}
+  s.test_files = [
+    "test/configy_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/configy.rb

@@ -0,0 +1,2 @@
+require 'configy/configuration'
+

data/lib/configy/configuration.rb

@@ -0,0 +1,123 @@
+require 'erb'
+
+module Configy
+  @@load_path = nil
+  @@section = nil
+  
+  def self.load_path=(val)
+    @@load_path = val
+  end
+  
+  def self.section=(val)
+    @@section = val
+  end
+  
+  def self.load_path
+    if @@load_path
+      return @@load_path
+    elsif defined? RAILS_ROOT 
+      return "#{RAILS_ROOT}/config"
+    elsif defined? RACK_ROOT
+      return "#{RACK_ROOT}/config"
+    else
+      return 'config'
+    end
+  end
+  
+  def self.section
+    if @@section
+      return @@section
+    elsif defined? RAILS_ENV 
+      return RAILS_ENV
+    elsif defined? RACK_ENV
+      return RACK_ENV
+    else
+      return 'development'
+    end
+  end
+  
+  def self.camelize(phrase)
+    camelized = phrase.gsub(/^[a-z]|\s+[a-z]|_+[a-z]|-+[a-z]/i) { |a| a.upcase }
+    camelized.gsub!(/\s/, '')
+    camelized.gsub!(/_/, '')
+    camelized.gsub!(/-/, '')
+    return camelized
+  end
+  
+  
+  def self.create(file)
+    instance_eval <<-"end;"
+      module ::#{camelize(file.to_s)}
+        class << self
+          @app_config
+          @file_mtime
+          @local_file_mtime
+          
+          def file_path
+            File.join(Configy.load_path, "#{file.to_s}.yml")
+          end
+          
+          def local_file_path
+            File.join(Configy.load_path, "#{file.to_s}.local.yml")
+          end
+
+          def method_missing(param)
+            build_config if can_build_config?
+            @app_config.send(param)
+          end
+          
+          def can_build_config?
+            @app_config.nil? || 
+            @file_mtime && @file_mtime < File.mtime(file_path) ||
+            @local_file_mtime && @local_file_mtime < File.mtime(local_file_path)
+          end
+
+          def build_config
+            @app_config = Configy::Configuration.new
+            @app_config.use_file!(file_path)
+            @file_mtime = File.mtime(file_path)
+            
+            if File.exists?(local_file_path)
+              @app_config.use_file!(local_file_path) 
+              @local_file_mtime = File.mtime(local_file_path)
+            end
+            
+            @app_config.use_section!(Configy.section)
+          end  
+        end          
+      end
+    end;
+  end
+  
+  class Configuration
+  
+    def initialize(file = nil)
+      @sections = {}
+      @params = {}
+      use_file!(file) if file
+    end
+  
+    def use_file!(file)
+      begin
+        hash = YAML::load(ERB.new(IO.read(file)).result)       
+        @sections.merge!(hash) {|key, old_val, new_val| (old_val || new_val).merge new_val }
+        @params.merge!(@sections['common'])
+      rescue; end    
+    end
+  
+    def use_section!(section)
+      @params.merge!(@sections[section.to_s]) if @sections.key?(section.to_s)
+    end
+  
+    def method_missing(param)
+      param = param.to_s
+      if @params.key?(param)
+        @params[param]
+      else
+        raise "Invalid Configy::Configuration Parameter " + param
+      end
+    end
+  
+  end
+
+end

data/test/configy_test.rb

@@ -0,0 +1,124 @@
+require 'test_helper'
+
+class ConfigyTest < Test::Unit::TestCase
+  def setup
+    @dir = File.dirname(__FILE__) + "/"
+    @files = []
+  end
+  
+  def test_should_read_from_yml
+    test_config 'common' => {'a' => '1', 'b' => '2'} do |file, hash|
+      config = Configy::Configuration.new(file)
+      assert_equal_with_hash config, hash['common']
+    end
+  end
+  
+  def test_should_ignore_non_existent_file
+    config = Configy::Configuration.new('nonexsistentfile')
+    assert_not_nil config
+  end
+  
+  def test_should_igonre_non_existent_section
+    test_config 'common' => {'a' => '1', 'b' => '2' } do |file, hash|
+      config = Configy::Configuration.new(file)
+      config.use_section!('nonexistentsection')
+      assert_equal config.b, '2'
+    end    
+  end
+  
+  def test_should_parse_yaml_with_erb
+    test_config 'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>' } do |file, hash|
+      config = Configy::Configuration.new(file)
+      assert_equal config.b, 4
+    end
+  end
+  
+  def test_should_override_params_with_given_section
+    test_config 'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>'}, 
+                 'special' => {'a' => 1, 'b' => 5 } do |file, hash|
+      config = Configy::Configuration.new(file)
+      config.use_section!('special')
+      assert_equal_with_hash config, hash['special']
+    end
+    test_config 'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>'}, 
+                'special' => {'b' => 5 } do |file, hash|
+      config = Configy::Configuration.new(file)
+      config.use_section!('special')
+      assert_equal_with_hash config, {'a' => '1', 'b' => 5}
+    end    
+  end
+  
+  def test_should_ovveride_params_with_another_file
+    test_config({'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>'}, 
+                 'special' => {'b' => 5 }}, 'config') do |file1, hash1|
+      test_config({'common' => {'a' => '2'}, 
+                   'special' => {'b' => 8 }}, 'config.local') do |file2, hash2|                
+        config = Configy::Configuration.new(file1)
+        assert_equal_with_hash config, {'a' => '1', 'b' => 4}
+        config.use_file!(file2)
+        assert_equal_with_hash config, {'a' => '2', 'b' => 4}
+      end
+    end        
+  end
+  
+  def test_should_ovveride_params_with_another_file_and_use_proper_section
+    test_config({'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>', 'c' => 2}, 
+                 'special' => {'b' => 5, 'd' => 6 },
+                 'extra' => {'f' => 4, 'a' => 8}}, 'config') do |file1, hash1|
+      test_config({'common' => {'a' => '2'}, 
+                   'special' => {'b' => 8 }}, 'config.local') do |file2, hash2|                
+        config = Configy::Configuration.new
+        config.use_file!(file1)
+        config.use_file!(file2)
+        config.use_section!('special')
+        assert_equal_with_hash config, {'a' => '2', 'b' => 8, 'c' => 2, 'd' => 6}
+      end
+    end        
+  end 
+  
+  def test_camelize
+    assert_equal 'Config', Configy.camelize('config')
+    assert_equal 'SomeConfig', Configy.camelize('some_config')
+    assert_equal 'SomeOtherConfig', Configy.camelize('some-other_config')
+  end
+  
+  def test_should_create_configuration_via_create
+    Configy.load_path = @dir
+    test_config( {'common' => {'a' => '1', 'b' => '2' }}, 'some_config' ) do |file, hash|
+      Configy.create('some_config')
+      assert_equal SomeConfig.b, '2'
+    end
+  end 
+  
+  def teardown
+    begin
+      FileUtils.rm @files
+    rescue
+    end
+  end
+  
+  protected
+  
+    def file_path(file)
+      @dir + file + '.yml'
+    end
+  
+    def create_config_file(file, hash) 
+      file = @dir + file + '.yml'
+      @files << file
+      File.open(file, 'w') do |f|
+        f.write hash.to_yaml        
+      end
+    end
+    
+    def assert_equal_with_hash(config, hash)    
+      hash.each do |key, value|
+        assert_equal config.send(key), value
+      end
+    end
+    
+    def test_config(hash, file = 'config', &blk)
+      create_config_file file, hash
+      blk.call(file_path(file), hash)
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'configy'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: configy
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Gabe Varela
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-08 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: gvarela@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- configy.gemspec
+- lib/configy.rb
+- lib/configy/configuration.rb
+- test/configy_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/gvarela/configy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: simple application configuration
+test_files: 
+- test/configy_test.rb
+- test/test_helper.rb