yaml_pack 0.0.1.alpha

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+bin/*
+.rspec
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in yaml_pack.gemspec
+gemspec

data/README.md

@@ -0,0 +1 @@
+# YamlPack

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/core_ext/hash.rb

@@ -0,0 +1,17 @@
+# Extend Hash with recursive merging abilities
+class Hash
+  # Deep merge method. Silly name prevents overwriting other implementations.
+  #
+  # Inspired from:
+  # http://www.gemtacular.com/gemdocs/cerberus-0.2.2/doc/classes/Hash.html
+  # File lib/cerberus/utils.rb, line 42
+  def yaml_pack_deep_merge!(second)
+    second.each_pair do |k,v|
+      if self[k].is_a?(Hash) and second[k].is_a?(Hash)
+        self[k].yaml_pack_deep_merge!(second[k])
+      else
+        self[k] = second[k]
+      end
+    end
+  end
+end

data/lib/yaml_pack.rb

@@ -0,0 +1,85 @@
+require 'core_ext/hash'
+
+class YamlPack
+  VERSION = "0.0.1.alpha"
+
+  KEY_CONVERTERS = {
+    :symbolize => Proc.new{|key, previous_keys| key.respond_to?(:to_sym) ? key.to_sym : key }
+  }.freeze
+  
+  attr_reader :files, :base_dir
+
+  def self.load_deep_merged(files, opts = {})
+    new(files, opts).load_deep_merged
+  end
+
+  def initialize(files, opts = {})
+    @files = [files].flatten
+
+    @base_dir      = opts.fetch(:base_dir,      nil)
+    @with_erb      = opts.fetch(:erb,           true)
+    @key_converter = opts.fetch(:key_converter, nil)
+    @header_file   = opts.fetch(:header_file,   nil)
+
+    if KEY_CONVERTERS.has_key?(@key_converter)
+      @key_converter = KEY_CONVERTERS[@key_converter]
+    end
+  end
+
+  def load_deep_merged
+    hsh = {}
+    
+    files.select{|f| File.exists?(f) }.each do |f|
+      content = self.content(f)
+      content = ERB.new(content).result(binding) if @with_erb
+      
+      result = YAML::load(content) || {}
+      result = prepend_subfolders(f, result) if @base_dir
+      result = convert_keys_recursive(result) if @key_converter
+      
+      hsh.yaml_pack_deep_merge!(result)
+    end
+
+    hsh
+  end
+
+  def content(file_path)
+    body   = File.read(file_path) || ""
+    header + body
+  end
+
+  def header
+    (@header_file && File.exists?(@header_file)) ? File.read(@header_file) : ""
+  end
+
+  def self.subfolders(base_dir, file_path)
+    base_dir = "#{base_dir}/".gsub("//", '/') # hack to always have a trailing /
+    file_path.gsub(/^#{base_dir}/, '').split('/')[0...-1]
+  end
+
+protected
+
+
+  def convert_keys_recursive(result, previous_keys = [])
+    if result.is_a?(Hash)
+      hsh = {}
+      result.each do |key, value|
+        converted_key = @key_converter.call(key, previous_keys)
+        hsh[converted_key] = convert_keys_recursive(value, [*previous_keys, key])
+      end
+      hsh
+    else # If it's not a hash, return the object itself (end of recursion)
+      result
+    end
+  end
+
+  def prepend_subfolders(file_path, object)
+    subfolders(file_path).inject(object) do |object, subfolder|
+      {subfolder => object}
+    end
+  end
+
+  def subfolders(file_path)
+    self.class.subfolders(base_dir, file_path)
+  end
+end

data/spec/fixtures/yaml_pack/countries/sweden.yml

@@ -0,0 +1,3 @@
+se:
+  name: Sweden
+  population: 11

data/spec/fixtures/yaml_pack/names.yml

@@ -0,0 +1,9 @@
+countries:
+  ch: 
+    name: Switzerland
+  de: 
+    name: Germany
+  fr:
+    name: France
+  pl:
+    name: Poland

data/spec/fixtures/yaml_pack/names_german.yml

@@ -0,0 +1,3 @@
+countries:
+  ch: 
+    name: Schweiz

data/spec/fixtures/yaml_pack/population.yml

@@ -0,0 +1,9 @@
+countries:
+  ch: 
+    population: 8
+  de: 
+    population: 80
+  fr:
+    population: 55
+  it:
+    population: 56

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'yaml_pack'

data/spec/yaml_pack/yaml_pack_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+
+describe YamlPack do
+  it "should load empty file and return empty hash" do
+    result = YamlPack.new('spec/fixtures/yaml_pack/empty.yml').load_deep_merged
+    
+    result.should == {}
+  end
+
+  it "should load one yaml file" do
+    result = YamlPack.new('spec/fixtures/yaml_pack/names.yml').load_deep_merged
+    
+    result['countries']['ch']['name'].should == 'Switzerland'
+  end
+
+  it "should convert keys" do
+    f = 'spec/fixtures/yaml_pack/names.yml'
+    toolbox = YamlPack.new(f, :key_converter => Proc.new{|k| k.to_sym})
+    result = toolbox.load_deep_merged
+    result[:countries][:ch][:name].should == 'Switzerland'
+  end
+
+
+  it "should allow for key_converters with previous keys" do
+    f = 'spec/fixtures/yaml_pack/names.yml'
+    toolbox = YamlPack.new(f, :key_converter => Proc.new{|key, previous_keys| [previous_keys, key].flatten.join("_")})
+    result = toolbox.load_deep_merged
+    result['countries']['countries_ch']['countries_ch_name'].should == 'Switzerland'
+  end
+
+
+  it "should merge two yaml files" do
+    files = [
+      'spec/fixtures/yaml_pack/names.yml',
+      'spec/fixtures/yaml_pack/population.yml'
+    ]
+    
+    result = YamlPack.new(files).load_deep_merged
+
+    # deep merge ch
+    result['countries']['ch']['name'].should == 'Switzerland'
+    result['countries']['ch']['population'].should == 8
+    # items specific to population.yml
+    result['countries']['it']['population'].should == 56
+    # items specific to names.yml
+    result['countries']['pl']['name'].should == 'Poland'
+  end
+
+  it "files should overwrite previous files" do
+    files = [
+      'spec/fixtures/yaml_pack/names.yml',
+      'spec/fixtures/yaml_pack/names_german.yml'
+    ]
+    
+    result = YamlPack.new(files).load_deep_merged
+    result['countries']['ch']['name'].should == 'Schweiz'
+  end
+
+  it "replicate nesting of subfolders into resulting hash" do
+    files = [
+      'spec/fixtures/yaml_pack/names.yml',
+      'spec/fixtures/yaml_pack/countries/sweden.yml'
+    ]
+    
+    result = YamlPack.new(files, :base_dir => 'spec/fixtures/yaml_pack').load_deep_merged
+    result['countries']['ch']['name'].should == 'Switzerland'
+    result['countries']['se']['name'].should == 'Sweden'
+  end
+
+
+  it "#subfolders" do
+    YamlPack.subfolders("/foo/", "/foo/baz.yml").should == []
+    YamlPack.subfolders("/foo/", "/foo/bar/baz.yml").should == ['bar']
+    YamlPack.subfolders("/foo/", "/foo/bar/baz/lorem.yml").should == ['bar', 'baz']
+
+    YamlPack.subfolders("foo/", "foo/bar/baz.yml").should == ['bar']
+    YamlPack.subfolders("/foo", "/foo/baz.yml").should == []
+    YamlPack.subfolders("", "/foo/baz.yml").should == ['foo']
+    YamlPack.subfolders(nil, "/foo/baz.yml").should == ['foo']
+  end
+end

data/yaml_pack.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yaml_pack"
+
+Gem::Specification.new do |s|
+  s.name        = "yaml_pack"
+  s.version     = YamlPack::VERSION
+  s.authors     = ["sebastian"]
+  s.email       = ["sebastian.burkhard@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Framework for complex yaml configuration file structures.}
+  s.description = %q{
+    YamlPack is a small framework for writing large and complex configuration files in yml.
+    It supports nesting and merging merging yaml files.
+  }
+
+  s.rubyforge_project = "yaml_pack"
+
+  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,83 @@
+--- !ruby/object:Gem::Specification
+name: yaml_pack
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- sebastian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70121952134780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70121952134780
+description: ! "\n    YamlPack is a small framework for writing large and complex
+  configuration files in yml.\n    It supports nesting and merging merging yaml files.\n
+  \ "
+email:
+- sebastian.burkhard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/core_ext/hash.rb
+- lib/yaml_pack.rb
+- spec/.DS_Store
+- spec/fixtures/.DS_Store
+- spec/fixtures/yaml_pack/countries/sweden.yml
+- spec/fixtures/yaml_pack/empty.yml
+- spec/fixtures/yaml_pack/names.yml
+- spec/fixtures/yaml_pack/names_german.yml
+- spec/fixtures/yaml_pack/population.yml
+- spec/spec_helper.rb
+- spec/yaml_pack/yaml_pack_spec.rb
+- yaml_pack.gemspec
+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: 1.3.1
+requirements: []
+rubyforge_project: yaml_pack
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Framework for complex yaml configuration file structures.
+test_files:
+- spec/fixtures/.DS_Store
+- spec/fixtures/yaml_pack/countries/sweden.yml
+- spec/fixtures/yaml_pack/empty.yml
+- spec/fixtures/yaml_pack/names.yml
+- spec/fixtures/yaml_pack/names_german.yml
+- spec/fixtures/yaml_pack/population.yml
+- spec/spec_helper.rb
+- spec/yaml_pack/yaml_pack_spec.rb
+has_rdoc: