configict 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in configict.gemspec
+gemspec
+
+group :test do
+  gem 'test-unit'
+end

data/README.md

@@ -0,0 +1,41 @@
+configict
+===========
+
+A YAML config loader with checking conflict from a example.
+
+## Features
+
+  * You can load a config .yml file and get a hash from YAML.
+  * Notify the conflict between .yml and .yml.(example|sample)
+
+## Usage
+
+    # config.yml(not committed)
+    name: "taro"
+
+    # config.yml.sample(committed)
+    name: "sample name"
+
+You can load config.yml. 
+
+    require "configict"
+    p Configict.load_yml("config.yml")
+    # => {name: "taro"}
+
+Then, other developer updates config.yml.sample.
+
+    # config.yml.sample(committed)
+    fullname: "sample fullname"
+    age: 20
+
+Configict raises a confiction error when you load it.
+
+    require "configict"
+    p Configict.load_yml("config.yml")
+    # => RuntimeError:
+    # You must specify follow keys in config file (config.yml)
+    # - fullname
+    # - age
+    # 
+    # You must not specify follow keys in config file (config.yml):
+    # + name

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/configict.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "configict/version"
+
+Gem::Specification.new do |s|
+  s.name        = "configict"
+  s.version     = Configict::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Narihiro Nakamura"]
+  s.email       = ["authornari@gmail.com"]
+  s.homepage    = "https://github.com/authorNari/configict"
+  s.summary     = %q{YAML config loader with checking conflict from example}
+  s.description = %q{YAML config loader with checking conflict from example}
+
+  s.rubyforge_project = "configict"
+
+  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"]
+end

data/lib/configict.rb

@@ -0,0 +1,47 @@
+require "erb"
+require "yaml"
+
+module Configict
+  class LoadError < StandardError; end
+  def self.load_yml(path)
+    config = YAML.load(ERB.new(File.read(path)).result)
+    example_config = example_config(path)
+    if example_config
+      diff = diff_keys(config, example_config)
+      if !diff["-"].empty? || !diff["+"].empty?
+        res = ["You must specify follow keys in config file (#{path}):"]
+        res += diff['-'].map{|d| "- #{d}"}
+        res << ""
+        res << "You must not specify follow keys in config file (#{path}):"
+        res += diff['+'].map{|d| "+ #{d}"}
+        raise LoadError, "\n" + res.join("\n")
+      end
+    end
+    return config
+  end
+
+  private
+  def self.example_config(path)
+    %w(.sample .example).each do |s|
+      sample = path + s
+      if File.exists?(sample)
+        return YAML.load(ERB.new(File.read(sample)).result)
+      end
+    end
+    return nil
+  end
+
+  def self.diff_keys(orig, other)
+    res = {'-' => [], '+' => []}
+    res['+'] = (orig.keys - other.keys).map(&:to_s)
+    res['-'] = (other.keys - orig.keys).map(&:to_s)
+    (orig.keys & other.keys).each do |k|
+      if orig[k].is_a?(Hash) && other[k].is_a?(Hash)
+        d = diff_keys(orig[k], other[k])
+        res['+'] << ([k, d['+']].join(" -> ")) if not d['+'].empty?
+        res['-'] << ([k, d['-']].join(" -> ")) if not d['-'].empty?
+      end
+    end
+    return res
+  end
+end

data/lib/configict/version.rb

@@ -0,0 +1,3 @@
+module Configict
+  VERSION = "0.0.1"
+end

data/test/fixtures/config_loader.yml

@@ -0,0 +1,8 @@
+test1: 'a'
+test2:
+  test2-1: 'a'
+  test2-2:
+    test2-2-1: 'b'
+test3:
+  - t
+  - s

data/test/fixtures/config_loader.yml.example

@@ -0,0 +1,8 @@
+test1: 'a'
+test2:
+  test2-1: 'a'
+  test2-2:
+    test2-2-1: 'b'
+test3:
+  - t
+  - s

data/test/fixtures/config_loader_has_diff.yml

@@ -0,0 +1,9 @@
+test1: 'a'
+test2:
+  test2-1: 'a'
+  test2-2:
+    test2-2-1-ex: 'b'
+  test2-3: 'c'
+test3:
+  - t
+  - s

data/test/fixtures/config_loader_has_diff.yml.sample

@@ -0,0 +1,9 @@
+test1: 'a'
+test2:
+  test2-1: 'a'
+  test2-2:
+    test2-2-1: 'b'
+test3:
+  - t
+  - s
+test4: 'aa'

data/test/run-test.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler"
+Bundler.require(:default, :test)
+
+test_file = "./test/test_*.rb"
+Dir.glob(test_file) do |file|
+  require file
+end

data/test/test_configict.rb

@@ -0,0 +1,13 @@
+class TestConfigict < Test::Unit::TestCase
+  def test_load_yml
+    Configict.load_yml(File.join(
+      File.dirname(__FILE__),
+      "fixtures/config_loader.yml"))
+
+    assert_raise(Configict::LoadError) do
+      Configict.load_yml(File.join(
+        File.dirname(__FILE__),
+        "fixtures/config_loader_has_diff.yml"))
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: configict
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Narihiro Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-03 00:00:00.000000000Z
+dependencies: []
+description: YAML config loader with checking conflict from example
+email:
+- authornari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- configict.gemspec
+- lib/configict.rb
+- lib/configict/version.rb
+- test/fixtures/config_loader.yml
+- test/fixtures/config_loader.yml.example
+- test/fixtures/config_loader_has_diff.yml
+- test/fixtures/config_loader_has_diff.yml.sample
+- test/run-test.rb
+- test/test_configict.rb
+homepage: https://github.com/authorNari/configict
+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: configict
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: YAML config loader with checking conflict from example
+test_files: []