brendan-simpleconfig 0.0.1

data/Manifest.txt

@@ -0,0 +1,16 @@
+lib
+lib/simpleconfig.rb
+Rakefile
+README
+spec
+spec/fixtures
+spec/fixtures/folder1
+spec/fixtures/folder1/data.yml
+spec/fixtures/folder1/erbified.yml
+spec/fixtures/folder1/other_data.yml
+spec/fixtures/folder2
+spec/fixtures/folder2/data.yml
+spec/fixtures/folder2/only_in_folder2.yml
+spec/fixtures/folder2/other_data.yml
+spec/simpleconfig_spec.rb
+spec/spec_helper.rb

data/Rakefile

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'rubygems'
+require './lib/simpleconfig.rb'
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Generates the gemspec, Manifest.txt and builds the gem."
+task :gem => ["gem:gemspec","gem:manifest"]
+
+namespace :gem do
+  desc "Generates the simpleconfig.gemspec file"
+  task :gemspec do
+    gemspec_code = <<-gemspec
+      Gem::Specification.new do |s|
+        s.name = %q{simpleconfig}
+        s.version = #{SimpleConfig::VERSION.inspect}
+
+        s.specification_version = 2 if s.respond_to? :specification_version=
+
+        s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+        s.authors = #{SimpleConfig::AUTHORS.inspect}
+        s.date = #{Time.now.strftime('%Y-%m-%d').inspect}
+        s.default_executable = nil
+        s.description = #{SimpleConfig::DESCRIPTION.inspect}
+        s.email = #{SimpleConfig::EMAIL.inspect}
+        s.executables = []
+        s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+        s.files = #{SimpleConfig::MANIFEST.inspect}
+        s.has_rdoc = true
+        s.homepage = #{SimpleConfig::HOMEPAGE.inspect}
+        s.rdoc_options = ["--main", "README.txt"]
+        s.require_paths = ["lib"]
+        s.rubygems_version = %q{1.1.1}
+        s.summary = #{SimpleConfig::DESCRIPTION.inspect}
+      end
+    gemspec
+    gemspec = File.open(File.join(File.dirname(__FILE__),'simpleconfig.gemspec'),'w')
+    gemspec.write(gemspec_code)
+    gemspec.close
+  end
+  desc "Generates the Manifest.txt file"
+  task :manifest do
+    manifest = File.open(File.join(File.dirname(__FILE__),'Manifest.txt'),'w')
+    manifest.write(SimpleConfig::MANIFEST.join("\n")<<"\n")
+    manifest.close
+  end
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs and stake out all files/folders for changes, running rake spec upon change"
+  task :auto => 'spec' do
+
+    # This task assumes you are running on a Mac, with growl installed.  Perhaps
+    # there will be a better way to abstract this, but it works for us now.
+    def growl(title, msg, img, pri=0, sticky="")
+      system "growlnotify -n autotest --image ~/.autotest_images/#{img} -p #{pri} -m #{msg.inspect} #{title} #{sticky}"
+    end
+    def self.growl_fail(output)
+      growl "FAIL", "#{output}", "fail.png", 2
+    end
+    def self.growl_pass(output)
+      growl "Pass", "#{output}", "pass.png"
+    end
+
+    command = 'rake spec'
+    files = {}
+
+    def files.reglob
+      Dir['**/*.rb'].each {|file| self[file] ||= File.mtime(file)}
+    end
+
+    files.reglob
+
+    puts "Watching #{files.keys.join(', ')}\n\nFiles: #{files.keys.length}"
+
+    trap('INT') do
+      puts "\nQuitting..."
+      exit
+    end
+
+    loop do
+
+      sleep 3
+
+      files.reglob
+
+      changed_file, last_changed = files.find do |file, last_changed|
+        begin
+          File.mtime(file) > last_changed
+        rescue
+          files.delete(file)
+        end
+      end
+
+      if changed_file
+        files[changed_file] = File.mtime(changed_file)
+        puts "=> #{changed_file} changed, running #{command}"
+        results = `#{command}`
+        puts results
+
+        if results.include? 'tests'
+          output = results.slice(/(\d+)\s+tests?,\s*(\d+)\s+assertions?,\s*(\d+)\s+failures?(,\s*(\d+)\s+errors)?/)
+          if output
+            $~[3].to_i + $~[5].to_i > 0 ? growl_fail(output) : growl_pass(output)
+          end
+        else
+          output = results.slice(/(\d+)\s+examples?,\s*(\d+)\s+failures?(,\s*(\d+)\s+not implemented)?/)
+          if output
+            $~[2].to_i > 0 ? growl_fail(output) : growl_pass(output)
+          end
+        end
+        # TODO Generic growl notification for other actions
+
+        puts "=> done"
+      end
+
+    end
+     
+  end
+end

data/lib/simpleconfig.rb

@@ -0,0 +1,104 @@
+require 'erb'
+require 'yaml'
+
+class SimpleConfig < Hash
+  
+  VERSION='0.0.1'
+  AUTHORS=["Brendan Baldwin"]
+  EMAIL=["brendan@usergenic.com"]
+  DESCRIPTION=%q{This is a really simple system for getting configuration data into your app.  See the wiki at http://github.com/brendan/simpleconfig/wikis for usage.}
+  FOLDER=File.expand_path(File.join(File.dirname(__FILE__),'..'))
+  MANIFEST=Dir.glob(File.join(FOLDER,'**','*')).map{|path|path[FOLDER.size+1..-1]}
+  HOMEPAGE="http://github.com/brendan/simpleconfig/wikis"
+  
+  def [](key)
+    super key.to_s
+  end
+  
+  def []=(key,value)
+    value = self.class.new.replace(value) if value.is_a?(Hash) and !value.is_a?(self.class)
+    super key.to_s, value
+  end
+
+  def fetch(key, default=nil, &block)
+    super(key.to_s, default, &block)
+  end
+  
+  def freeze
+    values.each do |value|
+      value.freeze if value.respond_to?(:freeze)
+    end
+    super
+  end
+  
+  def has_key?(key)
+    super key.to_s
+  end
+  
+  def key?(key)
+    super key.to_s
+  end
+  
+  def merge!(other)
+    other.each do |key, value|
+      if self[key].is_a?(Hash) and value.is_a?(Hash)
+        self[key].merge!(value)
+      else
+        self[key] = value
+      end
+    end
+  end
+  
+  def replace(other)
+    clear
+    other.each do |key, value|
+      self[key] = value
+    end
+    self
+  end
+  
+  protected
+  
+  def methodize_keys_and_freeze
+    keys.each do |key|
+      value = send(key)
+      value.methodize_keys_and_freeze if value.is_a?(Hash)
+    end
+    freeze
+    self
+  end
+  
+  private
+
+  def initialize(*folders)
+    @folders = folders unless folders.empty?
+  end
+
+  def load_and_merge(paths)
+    merged_data = nil
+    paths.each do |path|
+      if File.exists?(path)
+        data = YAML.load(ERB.new(File.read(path)).result)
+        data = self.class.new.replace(data) if data.is_a?(Hash)
+        if merged_data.is_a?(Hash)
+          merged_data.merge!(data)
+        else
+          merged_data = data
+        end
+      end
+    end
+    merged_data.methodize_keys_and_freeze if merged_data.is_a?(Hash)
+    merged_data
+  end
+
+  def method_missing(method_id, *arguments, &block)
+    if defined?(@folders)
+      data = load_and_merge(@folders.reverse.map {|f| File.join(f,"#{method_id}.yml")})
+      self[method_id] = data unless data == nil
+    end
+    return super unless key?(method_id)
+    class << self; self; end.send(:define_method, method_id) { self[method_id] }
+    send(method_id)
+  end
+
+end

data/spec/fixtures/folder1/data.yml

@@ -0,0 +1,4 @@
+some_key : some_value
+some_other_key : some_other_value
+some_key_with_hash_value :
+  some_subkey : some_subvalue

data/spec/fixtures/folder1/erbified.yml

@@ -0,0 +1 @@
+<%= %w{a dynamic key}.join('_') %> : some_<%='dynamic'%>_content

data/spec/fixtures/folder1/other_data.yml

@@ -0,0 +1 @@
+definitely_not_a_hash

data/spec/fixtures/folder2/data.yml

@@ -0,0 +1,4 @@
+some_key : this_will_be_ignored
+some_key_with_hash_value : 
+  some_subkey : will_also_be_ignored
+  some_other_subkey : some_other_subvalue

data/spec/fixtures/folder2/only_in_folder2.yml

@@ -0,0 +1 @@
+i_am_so_uniq

data/spec/fixtures/folder2/other_data.yml

@@ -0,0 +1 @@
+not_a_hash

data/spec/simpleconfig_spec.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "SimpleConfig" do
+  
+  def fixture_folders
+    %w{folder1 folder2}.map{|f|File.join(File.dirname(__FILE__),'fixtures',f)}
+  end
+  
+  describe ".new" do
+
+    it "creates a new SimpleConfig hash and sets the @folders instance_variable to the list of arguments provided." do
+      config = SimpleConfig.new('x','y','z')
+      config.instance_variable_get('@folders').should == ['x','y','z']
+    end
+
+  end
+  
+  describe "#method_missing" do
+
+    it "when a key matching the method_id string is present, defines a singleton_method named for the key to return the value and calls it." do
+      config = SimpleConfig.new
+      config['some_key']=1
+      config.should be_key('some_key')
+      config.methods.should_not include('some_key')
+      config.some_key.should == 1
+      config.methods.should include('some_key')
+      config.some_key.should == 1
+    end
+
+    it "delegates to method_missing super if no matching key is found" do
+      config = SimpleConfig.new
+      config[:this_method_does_exist] = "good_for_you"
+      proc{config.this_method_does_not_exist}.should raise_error(NoMethodError)
+      proc{config.this_method_does_exist}.should_not raise_error(NoMethodError)
+    end
+
+  end
+  
+  describe "when all is said and done" do
+    
+    it "performs a load_and_merge for all files named data.yml in specified folders, giving preference to first" do
+      config = SimpleConfig.new(*fixture_folders)
+      config.data.some_key.should == 'some_value'
+      config.data.some_other_key.should == 'some_other_value'
+      config.data.some_key_with_hash_value.some_subkey.should == 'some_subvalue'
+      config.data.some_key_with_hash_value.some_other_subkey.should == 'some_other_subvalue'
+      config.should == {
+        'data' => {
+          'some_key' => 'some_value',
+          'some_other_key' => 'some_other_value',
+          'some_key_with_hash_value' => {
+            'some_subkey' => 'some_subvalue',
+            'some_other_subkey' => 'some_other_subvalue' }}}
+    end
+
+    it "runs file content through ERB before parsing with YAML" do
+      config = SimpleConfig.new(*fixture_folders)
+      config.erbified.a_dynamic_key.should == 'some_dynamic_content'
+      config.should == {'erbified' => {'a_dynamic_key' => 'some_dynamic_content'}}
+    end
+
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+ENV['LOG_NAME'] = 'spec'
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+
+require 'simpleconfig'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: brendan-simpleconfig
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brendan Baldwin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This is a really simple system for getting configuration data into your app.  See the wiki at http://github.com/brendan/simpleconfig/wikis for usage.
+email: 
+- brendan@usergenic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- lib
+- lib/simpleconfig.rb
+- Rakefile
+- README
+- spec
+- spec/fixtures
+- spec/fixtures/folder1
+- spec/fixtures/folder1/data.yml
+- spec/fixtures/folder1/erbified.yml
+- spec/fixtures/folder1/other_data.yml
+- spec/fixtures/folder2
+- spec/fixtures/folder2/data.yml
+- spec/fixtures/folder2/only_in_folder2.yml
+- spec/fixtures/folder2/other_data.yml
+- spec/simpleconfig_spec.rb
+- spec/spec_helper.rb
+- History.txt
+- Manifest.txt
+- README.txt
+has_rdoc: true
+homepage: http://github.com/brendan/simpleconfig/wikis
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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.2.0
+signing_key: 
+specification_version: 2
+summary: This is a really simple system for getting configuration data into your app.  See the wiki at http://github.com/brendan/simpleconfig/wikis for usage.
+test_files: []
+