yaml-config-parser 0.1.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+pkg/*
+rdoc/

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mario Fernandez
+
+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.markdown

@@ -0,0 +1,78 @@
+# YAML Config Parser
+
+This gem allows to parse multiple YAML configuration files into one
+Config object. It attempts to solve two different problems:
+
+* Having multiple environments types. For example, you might want to
+  parse the config choosing between the common __development__,
+  __test__ and __production__ envs. But sometimes that is not
+  enough. If you want to have different settings for your _local_
+  machine and your _integration_ one, and each of them can run in
+  more than one mode, using just one selector doesn't solve it. For
+  that reason, this gem allows to use a hierarchy, so that you can
+  choose something like _local_ > __development__.
+  
+* For many projects, the configuration settings can get very big, and
+  thus you might want multiple configuration files, with the
+  convenience of having only one object with all the settings,
+  separated in namespaces (like 'db' or 'logging'). This gem uses one
+  main file, where the usual settings are saved, but also other
+  configuration files can be used.
+
+## Usage
+
+The Parser is created by passing a path and a list of environments,
+like this:
+
+    YAMLConfig::Parser.new(File.expand_path('../config', __FILE__), :env => ['local', 'development'])
+
+The first argument is a path to a directory. It is expected to contain
+a main settings file, _config.yml_, and optionally multiple extra
+settings file, in the form of _config.*.yml_. Valid files would be
+_config.db.yml_ or _config.logging.yml_.
+
+The second argument defines the environments used to select the
+contents of the configuration files. For the given example, each
+configuration file is expected to contain a _local_ key, which should
+contain a _development_ key inside it as well.
+
+The settings of the main file are taken without change. For the extra
+files, a hash with the name of the file (_logging_ for
+_config.logging.yml_) is built with all the settings, and this hash is
+put in the result file.
+
+## Example
+
+If the given directory contains a _config.yml_ file like:
+
+    local:
+        development:
+            key1 : true
+    
+        test:
+            key1 : false
+
+    integration:
+        production:
+            key2 : 3
+            
+and a _config.logging.yml_ file like:            
+
+    local:
+        development:
+            level : DEBUG
+    
+        test:
+            level : WARN
+
+    integration:
+        production:
+            active : false
+            
+The result of calling the __load__ method would create an
+__OpenStruct__ object equivalent to the following hash:
+
+    {
+        'key1' => true,
+        'logging' => { 'level' => 'DEBUG' }
+    }

data/Rakefile

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'rake'
+
+# Helpers
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+# Tasks
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern   = "spec/**/*_spec.rb"
+  t.verbose   = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.markdown"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Packaging
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{gem_file}"
+end
+
+task :build => :validate do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/lib/yaml-config-parser.rb

@@ -0,0 +1,84 @@
+require 'yaml'
+require 'ostruct'
+
+module YAMLConfig
+  VERSION = '0.1.3'
+
+  class Parser
+
+    attr_reader :environment
+    attr_accessor :path, :main, :extra
+
+    # Instantiate a new configuration parser.
+    #
+    # path - The directory where the configuration files are stored
+    # :env - (optional) The list of environments used to choose the
+    #        right keys. If there is only one environment it can be passed as
+    #        a String. Default is 'development'
+    def initialize(path, args = {})
+      @path = path
+      # TODO: make main and extra files configurable
+      @main = 'config.yml'
+      @extra = 'config.*.yml'
+      self.environment = args[:env] || 'development'
+    end
+
+    # Loads all the config files that can be found under the
+    # given path, chooses the right environments, and merges them
+    # into a new OpenStruct object
+    #
+    # Returns an OpenStruct with the configuration keys
+    def load
+      OpenStruct.new merge_config_files
+    end
+
+    def environment=(env)
+      if env.class == String
+        env = [env]
+      end
+      @environment = env
+    end
+
+    # Gets the path for all the configuration files. The main file is
+    # put first
+    #
+    # Returns an Array of Strings, each one being a path to a
+    # configuration file.
+    def find_config_files
+      main = File.join(@path, @main)
+      raise ArgumentError.new("Main config file #{main} does not exist") unless File.exists? main
+      extra = Dir.glob(File.join(@path, @extra))
+      ([main] + extra).uniq
+    end
+
+    private
+
+    def file_to_hash file_name
+      h = YAML.load_file file_name
+      @environment.each do |env|
+        h = h[env]
+        raise ArgumentError.new("Environment #{env} does not exist in the file. Are you sure the order of the environments is correct?") if h.nil?
+      end
+      h
+    end
+
+    def choose_key_for_extra_file file_name
+      file_name.gsub(/.yml$/, '').split('.')[-1]
+    end
+
+    def add_to_hash(hash, key, extra)
+      hash.merge!({key => extra}) do |key,_,_|
+        raise ArgumentError.new("The key #{key} is duplicated")
+      end
+    end
+
+    def merge_config_files
+      files = find_config_files
+      h = file_to_hash(files.shift)
+      files.each do |file_name|
+        add_to_hash(h, choose_key_for_extra_file(file_name), file_to_hash(file_name))
+      end
+      h
+    end
+  end
+end

data/spec/data/config.db.yml

@@ -0,0 +1,37 @@
+defaults: &defaults
+  database: db
+  port: 27017
+  
+local:
+  defaults: &local_defaults
+    <<: *defaults
+
+    host: localhost
+
+  development:
+    <<: *local_defaults
+
+  test:
+    <<: *local_defaults
+
+    database: db_test
+
+integration:
+  defaults: &integration_defaults
+    <<: *defaults
+
+    host: integration.host.com
+
+  test:
+    <<: *integration_defaults
+
+    database: db_test
+
+  production:
+    <<: *integration_defaults
+
+live:
+  production:
+    <<: *defaults
+
+    host: host.com

data/spec/data/config.logging.yml

@@ -0,0 +1,32 @@
+defaults: &defaults
+  is_global: true
+  
+local:
+  defaults: &local_defaults
+    <<: *defaults
+
+    level: DEBUG
+
+  development:
+    <<: *local_defaults
+
+  test:
+    <<: *local_defaults
+
+integration:
+  defaults: &integration_defaults
+    <<: *defaults
+
+    level: WARN
+
+  test:
+    <<: *integration_defaults
+
+  production:
+    <<: *integration_defaults
+
+live:
+  production:
+    <<: *defaults
+
+    level: INFO

data/spec/data/config.yml

@@ -0,0 +1,26 @@
+defaults: &defaults
+  is_global: true
+  
+local:
+  defaults: &local_defaults
+    <<: *defaults
+
+  development:
+    <<: *local_defaults
+
+  test:
+    <<: *local_defaults
+
+integration:
+  defaults: &integration_defaults
+    <<: *defaults
+
+  test:
+    <<: *integration_defaults
+
+  production:
+    <<: *integration_defaults
+
+live:
+  production:
+    <<: *defaults

data/spec/yaml-config-parser_spec.rb

@@ -0,0 +1,56 @@
+require 'yaml-config-parser'
+
+
+describe YAMLConfig do
+
+  before(:each) do
+    @parser = YAMLConfig::Parser.new(File.expand_path('../data', __FILE__), :env => ['local', 'development'])
+    @files = @parser.find_config_files
+  end
+
+  it 'should return an OpenStruct object' do
+    @parser.load.should be_a_kind_of OpenStruct
+  end
+
+  it 'should find the files to parse' do
+    @parser.find_config_files.count.should == 3
+  end
+
+  it 'should fail if the main configuration file does not exist' do
+    @parser.main = 'doesnt_exist'
+    lambda { @parser.find_config_files }.should raise_error ArgumentError
+  end
+
+  it 'should put the main file first' do
+    @parser.find_config_files.first.should satisfy {|f| f.include? 'config.yml' }
+  end
+
+  it 'should be able to deal with a single environment' do
+    @parser.environment = 'local'
+    @parser.environment.should == ['local']
+  end
+
+  it 'should convert a yml to a hash, using the environments to choose the part of the yml to take' do
+    @parser.send(:file_to_hash, @files.first).should == {"is_global"=>true}
+  end
+
+  it 'should fail when trying to use an environment that is not present in the yml file' do
+    @parser.environment = 'NO'
+    lambda { @parser.send(:file_to_hash, @files.first)}.should raise_error ArgumentError
+  end
+
+  it 'should fail when trying to use the same key twice for the hash' do
+    lambda { @parser.send(:add_to_hash, { 'a' => 1}, 'a', {})}.should raise_error ArgumentError
+  end
+
+  it 'should merge all configuration files to one hash' do
+    @parser.send(:merge_config_files).keys.should == ['is_global', 'db', 'logging']
+  end
+
+  it 'should produce a valid OpenStruct object with all the data from the config files' do
+    cfg = @parser.load
+    cfg.is_global.should == true
+    cfg.db.should == {"database"=>"db", "port"=>27017, "host"=>"localhost"}
+    cfg.logging.should == {"is_global"=>true, "level"=>"DEBUG"}
+  end
+end

data/yaml-config-parser.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'yaml-config-parser'
+
+Gem::Specification.new do |s|
+  s.name        = 'yaml-config-parser'
+  s.version     = YAMLConfig::VERSION
+  s.authors     = ['Mario Fernandez']
+
+  s.homepage    = 'http://github.com/sirech/parse-yaml-config'
+  s.summary     = 'Load settings in one or multiple yaml config files'
+  s.description = 'Parse a number of yaml config files, building one config object. Multiple keys can be specified to choose which part of the file to load'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: yaml-config-parser
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Mario Fernandez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Parse a number of yaml config files, building one config object. Multiple keys can be specified to choose which part of the file to load
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/yaml-config-parser.rb
+- spec/data/config.db.yml
+- spec/data/config.logging.yml
+- spec/data/config.yml
+- spec/yaml-config-parser_spec.rb
+- yaml-config-parser.gemspec
+has_rdoc: true
+homepage: http://github.com/sirech/parse-yaml-config
+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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Load settings in one or multiple yaml config files
+test_files: 
+- spec/data/config.db.yml
+- spec/data/config.logging.yml
+- spec/data/config.yml
+- spec/yaml-config-parser_spec.rb