dead_simple_conf 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage/

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+
+# parameters:
+#  output     => the formatted to use
+#  backtrace  => number of lines, nil =  everything
+guard 'bacon', :output => "BetterOutput", :backtrace => 4 do
+  watch(%r{^lib/(.+)\.rb$})     { |m| "specs/lib/#{m[1]}_spec.rb" }
+  watch(%r{specs/.+\.rb$})
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Julien Ammous
+
+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.md

@@ -0,0 +1,94 @@
+
+This is my own implementation of a REALLY simple configuration library, and
+when I say simple I mean it ! Most of the library available out there are far
+too complicated.
+
+I decided to extract this code in a proper gem when I got tired of copying it over
+and over in my projects.
+
+# What this gem provides
+
+My requirements for a config parser are:
+
+- check that each line typed in the yaml file match a valid parameter
+  I spent far too much time debugging application loading just because
+  activerecord or any other gem did not warned me that a key was unknown
+  (like "size" instead of "pool_size", you get the idea).  
+  What I expect is to have some return, taise an error, throw me a brick, do something damn !
+
+- have a useable syntax to read the values
+- something minimal which can be extended as needed (look at the source
+  to really figure out how small this library is, there may even be more text
+  in this README ! )
+
+And honestly that's all, I don't want or need 100 different allowed formats
+with complex cases handled, so now that we are clear let's see how this
+thing works.
+
+
+
+# How it works
+
+You have this yaml file:
+
+```yaml
+
+logger:
+  level: debug
+  output: /tmp/file.log
+
+app:
+  data_path: /tmp
+  
+  server:
+    port: 9000
+    address: 127.0.0.1
+```
+
+Here is how you would use it:
+
+```ruby
+require 'bundler/setup'
+require 'dead_simple_conf'
+
+module ConfigLoader
+  class ServerConfig < DeadSimpleConf::ConfigBlock
+    attr_accessor :port, :address
+  end
+
+  class AppConfig < DeadSimpleConf::ConfigBlock
+    attr_accessor :data_path
+    sub_section :server, ServerConfig
+  
+  end
+
+  class LoggerConfig < DeadSimpleConf::ConfigBlock
+    attr_accessor :level, :output
+  end
+
+  class MyConfig < DeadSimpleConf::ConfigBlock
+    sub_section :app, AppConfig
+    sub_section :logger, LoggerConfig  
+  end
+  
+  def self.load(path)
+    raw_data = YAML.load_file(path)
+    MyConfig.new(raw_data)
+  end
+end
+
+conf = ConfigLoader.load("conf.yml")
+puts "conf.app.data_path    : #{conf.app.data_path}"
+puts "conf.app.server.port  : #{conf.app.server.port}"
+
+```
+
+You can see both files in the examples folder.
+
+
+# Extending it
+
+Since I am only using standard class with getter and setters you should be able to extend it
+without much trouble, one one the thing which comes in mind is to use activemodel validation
+to validate incoming entries.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+task :test do
+  require 'bacon'
+  ENV['COVERAGE'] = "1"
+  
+  # Bacon.summary_on_exit
+  
+  Dir[File.expand_path('../specs/**/*_spec.rb', __FILE__)].each do |file|
+    load(file)
+  end
+
+end

data/dead_simple_conf.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dead_simple_conf/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dead_simple_conf"
+  s.version     = DeadSimpleConf::VERSION
+  s.authors     = ["Julien Ammous"]
+  s.email       = []
+  s.homepage    = ""
+  s.summary     = %q{Config loader}
+  s.description = %q{YAML Config loader}
+
+  s.rubyforge_project = "dead_simple_conf"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- specs/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'schmurfy-bacon', '~> 1.2'
+  s.add_development_dependency 'guard-bacon',    '~> 1.0.2'
+  s.add_development_dependency "growl", '~> 1.0.3'
+  s.add_development_dependency "rb-fsevent", '~> 0.4.3'
+  s.add_development_dependency "mocha", '~> 0.10.0'
+  s.add_development_dependency "simplecov", '~> 0.5.3'
+  s.add_development_dependency "rake", '~> 0.9.2'
+    
+end

data/examples/conf.yml

@@ -0,0 +1,11 @@
+
+logger:
+  level: debug
+  output: /tmp/file.log
+
+app:
+  data_path: /tmp
+  
+  server:
+    port: 9000
+    address: 127.0.0.1

data/examples/test.rb

@@ -0,0 +1,43 @@
+require 'bundler/setup'
+require 'dead_simple_conf'
+
+# logger:
+#   level: debug
+#   output: /tmp/file.log
+# 
+# app:
+#   data_path: /tmp
+#   
+#   server:
+#     port: 9000
+#     address: 127.0.0.1
+
+module ConfigLoader
+  class ServerConfig < DeadSimpleConf::ConfigBlock
+    attr_accessor :port, :address
+  end
+
+  class AppConfig < DeadSimpleConf::ConfigBlock
+    attr_accessor :data_path
+    sub_section :server, ServerConfig
+  
+  end
+
+  class LoggerConfig < DeadSimpleConf::ConfigBlock
+    attr_accessor :level, :output
+  end
+
+  class MyConfig < DeadSimpleConf::ConfigBlock
+    sub_section :app, AppConfig
+    sub_section :logger, LoggerConfig  
+  end
+  
+  def self.load(path)
+    raw_data = YAML.load_file(path)
+    MyConfig.new(raw_data)
+  end
+end
+
+conf = ConfigLoader.load("conf.yml")
+puts "conf.app.data_path    : #{conf.app.data_path}"
+puts "conf.app.server.port  : #{conf.app.server.port}"

data/lib/dead_simple_conf.rb

@@ -0,0 +1,36 @@
+require "dead_simple_conf/version"
+
+module DeadSimpleConf
+  
+  class ConfigBlock
+    
+    def self.sub_section(name, klass)
+      attr_reader(name)
+      
+      define_method("#{name}=") do |h|
+        instance_variable_set("@#{name}", klass.new(h))
+      end
+    end
+    
+    def initialize(attributes)
+      _load_data(attributes)
+    end
+
+    def _load_data(attributes)
+      unknown = attributes.reject do |key, value|
+        if respond_to?("#{key}=")
+          send("#{key}=", value)
+          true
+        else
+          false
+        end
+      end
+
+      unless unknown.empty?
+        fail "unknown parameter(s) in config block #{self.class}: #{unknown.inspect}"
+      end
+    end
+    
+  end
+  
+end

data/lib/dead_simple_conf/version.rb

@@ -0,0 +1,3 @@
+module DeadSimpleConf
+  VERSION = "1.0.0"
+end

data/specs/common.rb

@@ -0,0 +1,15 @@
+
+require 'bundler/setup'
+
+if ENV['COVERAGE'] && (RUBY_VERSION >= "1.9")
+  require 'simplecov'
+  SimpleCov.start do  
+    root File.expand_path('../..', __FILE__)
+  end
+end
+
+require 'mocha'
+require 'bacon'
+
+require 'dead_simple_conf'
+Bacon.summary_at_exit()

data/specs/lib/dead_simple_conf_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path('../../common', __FILE__)
+
+describe 'DeadSimpleConf' do
+  
+  describe 'one level config' do
+    before do
+      @conf_data = YAML.load(%{
+        login: user_login
+        path: /tmp
+      })
+    end
+
+    should 'raise an error on unknown parameter' do
+      parser_module = Module.new do
+        class MainBlock < DeadSimpleConf::ConfigBlock
+          attr_accessor :login
+        end
+
+        def self.load(data)
+          MainBlock.new(data)
+        end
+      end
+
+      proc {
+        result = parser_module.load(@conf_data)
+      }.should.raise(RuntimeError)
+
+    end
+
+    should 'parse successfully known parameter' do
+      parser_module = Module.new do
+        class MainBlock < DeadSimpleConf::ConfigBlock
+          attr_accessor :login, :path
+        end
+
+        def self.load(data)
+          MainBlock.new(data)
+        end
+      end
+
+      result = parser_module.load(@conf_data)
+      result.login.should == "user_login"
+      result.path.should == "/tmp"
+    end
+  end
+  
+  describe 'multi level config' do
+    before do
+      @conf_data = YAML.load(%{
+        login: user_login
+        path: /tmp
+        
+        server:
+          address: 127.0.0.1
+          port: 5000
+          
+          another_section:
+            name: out_of_ideas
+      })
+    end
+    
+    should 'parse it with correct loader' do
+      parser_module = Module.new do
+        class AnotherSectionBlock < DeadSimpleConf::ConfigBlock
+          attr_accessor :name
+        end
+        
+        class ServerBlock < DeadSimpleConf::ConfigBlock
+          attr_accessor :address, :port
+          sub_section :another_section, AnotherSectionBlock
+        end
+        
+        class MainBlock < DeadSimpleConf::ConfigBlock
+          attr_accessor :login, :path
+          sub_section :server, ServerBlock
+        end
+
+        def self.load(data)
+          MainBlock.new(data)
+        end
+      end
+      
+      result = parser_module.load(@conf_data)
+      result.login.should == "user_login"
+      result.path.should == "/tmp"
+      
+      result.server.address.should == "127.0.0.1"
+      result.server.port.should == 5000
+      
+      result.server.another_section.name.should == "out_of_ideas"
+      
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: dead_simple_conf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Julien Ammous
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: schmurfy-bacon
+  requirement: &70347746200320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: *70347746200320
+- !ruby/object:Gem::Dependency
+  name: guard-bacon
+  requirement: &70347746199760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: *70347746199760
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70347746198860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: *70347746198860
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70347746197820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :development
+  prerelease: false
+  version_requirements: *70347746197820
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70347746196760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70347746196760
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70347746195140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: *70347746195140
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70347746194040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70347746194040
+description: YAML Config loader
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- dead_simple_conf.gemspec
+- examples/conf.yml
+- examples/test.rb
+- lib/dead_simple_conf.rb
+- lib/dead_simple_conf/version.rb
+- specs/common.rb
+- specs/lib/dead_simple_conf_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: dead_simple_conf
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Config loader
+test_files:
+- specs/common.rb
+- specs/lib/dead_simple_conf_spec.rb