awesome_conf 0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+0.1.0 (November 07, 2010)
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano
+
+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,58 @@
+= AwesomeConf
+
+AwesomeConf is a really simple and powerful ruby gem built with performance in mind, it's the easiest and the cleanest way to add some configuration variables to any ruby project.
+
+It does almost nothing, it just give you the ability to create and use easily a configuration class for any of your ruby project.
+
+It's like an Hash but it's not an Hash.
+
+It's like an OpenStruct but it's not an OpenStruct, it's faster.
+
+It's like a bird, but it's not a bird.
+
+== AwesomeConf example
+
+  require 'awesome_conf'
+  
+  ac = AwesomeConf.new(:key => 'value')
+  ac.key # => 'value'
+  
+Ok, nothing is magic here, it can be any easy ruby tricks returning the value of this hash, like using method_missing[http://apidock.com/ruby/Kernel/method_missing] or using an OpenStruct[http://apidock.com/ruby/OpenStruct].
+But this is not, it's a real brand new method created dynamically returning a constant.
+
+<b>Why? For speed, and to be as faster as hash[:key] and two times faster than hash['key']</b> (at least using the classic ruby VM 1.8 and 1.9, with jRuby: hash['key'] is faster than everything !)
+
+So to conclude, AwesomeConf is just an easy replacement of conf['my_conf_variable'] to conf.my_conf_variable without <b>sacrificing performance</b>. (benchmarks are available in the specs)
+
+== Other use cases:
+
+=== AwesomeConf with YAML
+
+  AwesomeConf.new('path_to_a_yaml_file.yaml')
+
+
+=== AwesomeConf and strict mode
+
+  ac = AwesomeConf.new({:key => 'value'})
+  ac.key # => 'value'
+  ac.something_not_set # => nil
+  
+  # After enabling the strict mode:
+
+  ac.strict!
+  ac.something_not_set # Raise an exception
+
+=== AwesomeConf with inheritance
+
+  class MyConfClass < AwesomeConf
+  
+    def initialize(an_hash)
+      super(an_hash)
+    end
+    
+    ... your_awesome_custom_methods ...
+  
+  end
+
+
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano, released under the MIT license

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+
+desc "Run specs for current Rails version"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c --format specdoc"]
+end
+
+task :default => :spec

data/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'awesome_conf'

data/lib/awesome_conf.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+
+class AwesomeConf
+  @@strict = false
+
+  # Create a new conf object
+  # You can instantiate a conf object with an Hash
+  # Or with the path of a YAML file
+  def initialize(hash)
+    
+    begin
+      hash = YAML::load_file(hash) if String === hash
+    rescue Exception => e
+      raise e.class.new("AwesomeConf: Error loading yaml file: #{hash} (#{e})")
+    end
+
+    m = Module.new do
+      instance_methods.each { |selector| remove_method(selector) }
+
+      hash.each do |k, v|
+        const_set('AC_' + k.to_s, v)
+        module_eval <<-END_EVAL, __FILE__, __LINE__ + 1
+          def #{k}
+            #{'AC_'+ k.to_s}
+          end
+        END_EVAL
+      end
+
+    end
+
+    extend m
+    freeze
+  end
+
+  # Set to strict in order to raise when using an unfound conf variable
+  def strict!
+    @@strict = true
+    self
+  end
+  
+  def method_missing(m)
+    raise "AwesomeConf: trying to access an inexisting configuration variable in a strict configuration environment: #{m}" if @@strict
+    nil
+  end
+end

data/spec/awesome_conf/awesome_conf_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe :awesome_conf do
+  context 'initialization' do
+    it 'with a hash' do
+      AwesomeConf.new(:key => 'value').key.should == 'value'
+    end
+    
+    it 'with a yaml path file' do
+      path = File.join(File.dirname(__FILE__), '../conf/sample.yml')
+      AwesomeConf.new(path).key.should == 'value'
+    end
+    
+    it 'raise correctly with a mal formed yaml file' do
+      path = File.join(File.dirname(__FILE__), '../conf/mal_formed.yml')
+      e = nil
+      begin
+        AwesomeConf.new(path)
+      rescue Exception => e
+      end
+      e.to_s.index('AwesomeConf: Error').should_not be_nil
+    end
+    
+    it 'raise correctly with a non extising yaml file' do
+      e = nil
+      begin
+        AwesomeConf.new('not_existing.yaml')
+      rescue Exception => e
+      end
+      e.to_s.index('AwesomeConf: Error').should_not be_nil
+    end
+    
+  end
+  
+  context 'normal behavior' do
+    before :all do
+      path = File.join(File.dirname(__FILE__), '../conf/sample.yml')
+      @ac = AwesomeConf.new(path)
+    end
+    
+    it 'works with a string' do
+      @ac.key.should == 'value'
+    end
+    
+    it 'works with a symbol' do
+      @ac.sym_key.should == 'value'
+      @ac.sym_key_s.should == :sym_value
+    end
+    
+    it 'works with an array' do
+      @ac.array.last.should == 3
+      @ac.array[0].should == 1
+    end
+    
+    it 'works with a hash' do
+      @ac.hash['k1'].should == 'val'
+      @ac.hash[:k2].should == 'val2'
+    end
+    
+    
+  end
+  
+  context 'method missing behavior' do
+    it 'should return nil when a method does not exists' do
+      AwesomeConf.new(:key => 'value').no.should == nil
+    end
+    
+    it 'should raise when a method does not exists in a strict env' do
+      e = nil
+      begin
+        AwesomeConf.new(:key => 'value').strict!.no
+      rescue Exception => e
+      end
+      e.should_not be_nil
+    end
+    
+  end
+  
+  context 'benchmark (500 000 times)' do
+    @h = {:key => 'value', 'kes' => 'value_s'}
+    @a = AwesomeConf.new(@h)
+    
+    class ProxyConf
+      def initialize(h)
+        @h = h
+      end
+    
+      def key
+        @h[:key]
+      end
+    end
+    
+    @c = ProxyConf.new(@h)
+    
+    b_h_s =   Benchmark.measure { 500_000.times { @h[:key] } }.to_s.strip
+    b_h_str = Benchmark.measure { 500_000.times { @h['kes'] } }.to_s.strip
+    b_a =     Benchmark.measure { 500_000.times { @a.key } }.to_s.strip
+    b_c =     Benchmark.measure { 500_000.times { @c.key } }.to_s.strip
+    
+    it "awesome_conf.key:   #{b_a}" do
+    end
+    
+    it "h[:key]:            #{b_h_s}" do
+    end
+
+    it "h['key']:           #{b_h_str}" do
+    end
+
+    it "proxy_h_class.key:  #{b_c}" do
+    end
+
+  end
+end

data/spec/conf/mal_formed.yml

@@ -0,0 +1,2 @@
+key: value
+misskey error

data/spec/conf/sample.yml

@@ -0,0 +1,10 @@
+key: value
+:sym_key: value
+:sym_key_s: :sym_value
+:hash:
+  k1: val
+  :k2: val2
+array:
+  - 1
+  - 2
+  - 3

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'spec'
+require 'benchmark'
+
+
+require File.dirname(__FILE__) + '/../init.rb'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: awesome_conf
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Guillaume Luccisano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-07 01:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: The easiest and the cleanest way to add some configuration variables to any ruby project.
+email: guillaume.luccisano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/awesome_conf.rb
+- spec/awesome_conf/awesome_conf_spec.rb
+- spec/conf/mal_formed.yml
+- spec/conf/sample.yml
+- spec/spec_helper.rb
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/kwi/awesome_conf
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: awesome_conf
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: The easiest and the cleanest way to add some configuration variables to any ruby project.
+test_files: []
+