configulator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0be977b2ac66bdc4eff6e156fc0b79d4f58a6f39
+  data.tar.gz: 666cb63c44ab7c9f7361ad415b68e751fe0fef83
+SHA512:
+  metadata.gz: 633253c21f194e83c9e3163ac120ca75cce1ef39689693c0404e4ae64253631bb96fa29d8e60bf820b8a93b739ba86c97e522dd224a999b3f2e8a54aede2d194
+  data.tar.gz: 5b79fc953a1535c89bab8c616c5d968e5035c3dc8df97765eafb83cd3ef8081ff56ca367521d2c94cf0329862295ebc87452ae82f7d7c53e670fb7d1653c98a6

data/.gitignore

@@ -0,0 +1,20 @@
+.ruby-gemset
+.ruby-version
+docs
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Muller
+
+MIT License
+
+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,74 @@
+# Configulator : Generate Config Files
+ 
+Configurator allows you to maintain a single file with configuration values that can be used to generate other config files based on templates.
+
+For instance, if you need to generate all of the config files for a Hadoop cluster and the files vary in type (xml, json, yaml, etc) but all rely on the same few configuration values, you can use configulator to generate those files.
+
+Configulator is a tool that takes a single master input config file and some number of template files as input and then outputs the template files with the correct configuration values substituted. Additionally, there is a way of specifying default values, and then configulator will override on the necessary ones per environment.
+
+See [this blog post](http://findingscience.com/linux/sysadmin/ruby/2010/10/27/config-template-class.html) for the background on why this can be useful.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'configulator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install configulator
+
+## Usage
+
+Configulator can accept a master config file either in json or yaml.  Here's an example config file:
+
+    mysql_host: 127.0.0.1
+    mysql_port: 5678
+    db_host: <%= mysql_host %>
+    db_port: <%= mysql_port %>
+    current_time: <%= Time.now %>
+
+It specifies a mysql host and port, as well as a general db host and port that will simply use the values for mysql.  Then, given an example config file that's nasty and written in XML:
+
+    <xml><config><host><%= db_host %></host></config></xml>
+
+We can now convert the above file into one with db_host filled in either using code or the configulator command.  Here's what the code looks like (assuming our master config is master.yml and our xml is xmlisbad.xml.tmpl):
+
+    require 'configulator'
+    converted = Configulator.from_yaml_file('master.yml').convert_file('xmlisbad.xml')
+    File.write 'xmlisbad.xml', converted
+
+You can also access specific variables in the ruby code:
+
+    puts converted.db_host # => 127.0.0.1
+
+Using the configulator command instead looks like this:
+
+    configulator master.yml xmlisbad.xml.tmpl > xmlisbad.xml
+
+## Environments
+
+You have the option of setting default values in your master config file and then separate environment sections beneath that.  For instance, here's a yaml config file with default values for some keys:
+
+    default:
+        debug: INFO
+        db_host: <%= mysql_host %>
+        db_port: <%= mysql_port %>
+    production:
+        mysql_host: 1.2.3.4
+        mysql_port: 5678
+    development:
+        mysql_host: 127.0.0.1
+        mysql_port: 5678
+
+We can spit out the production values like this (just passing in an extra argument to from_yaml_file):
+
+    require 'configulator'
+    converted = Configulator.from_yaml_file('master.yml', 'production').convert_file('xmlisbad.xml')
+    File.write 'xmlisbad.xml', converted
+
+When db_host is used in the xml file, configulator will look for it first in the production section and then in the default (where it is found, then repeats process for mysql_host).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require 'rdoc/task'
+require 'rake/testtask'
+
+task :default => [:test]
+
+RDoc::Task.new("doc") { |rdoc|
+  rdoc.title = "Configulator - Generate config files"
+  rdoc.rdoc_dir = 'docs'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+desc "Run all unit tests"
+Rake::TestTask.new("test") { |t|
+  t.libs << "lib"
+  t.test_files = FileList['test/*.rb']
+}

data/bin/configulator

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'configulator'
+rescue LoadError
+  require 'rubygems'
+  require 'configulator'
+end
+
+if ARGV.length < 2
+  puts "Usage: configulator <master config file> <template file> [<environment>]"
+  exit 1
+end
+
+if ARGV[0].end_with? '.yml' or ARGV[0].end_with? '.yaml'
+  conf = Configulator.from_yaml_file(ARGV[0], ARGV[2])
+else
+  conf = Configulator.from_json_file(ARGV[0], ARGV[2])
+end
+
+puts conf.convert_file ARGV[1]

data/configulator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'configulator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "configulator"
+  spec.version       = Configulator::VERSION
+  spec.authors       = ["Brian Muller"]
+  spec.email         = ["bamuller@gmail.com"]
+  spec.summary       = %q{Generate config files from a template}
+  spec.description   = %q{Configurator allows you to maintain a single file with configuration values that can be used to generate other config files based on templates.}
+  spec.homepage      = "https://github.com/bmuller/configulator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rdoc"
+end

data/lib/configulator.rb

@@ -0,0 +1,20 @@
+require "configulator/version"
+require "configulator/config_template"
+
+module Configulator
+  def self.from_json(conf, environment = nil)
+    JSONConfigTemplate.new conf, environment
+  end
+
+  def self.from_json_file(fname, environment = nil)
+    from_json File.read(fname), environment
+  end
+
+  def self.from_yaml(fname, environment = nil)
+    YAMLConfigTemplate.new fname, environment
+  end
+
+  def self.from_yaml_file(fname, environment = nil)
+    from_yaml File.read(fname), environment
+  end
+end

data/lib/configulator/config_template.rb

@@ -0,0 +1,63 @@
+require 'yaml'
+require 'json'
+require 'erb'
+ 
+module Configulator
+  class ConfStruct < Struct
+    def get_binding
+      binding
+    end
+  end
+
+  class ConfigTemplate
+    def initialize(conf, environment = nil)
+      if environment.nil?
+        @binding = make_binding conf
+      else
+        raise "No such environment: #{environment}" unless conf.has_key? environment
+        env = conf[environment]
+        env = conf['default'].merge(env) if conf.has_key? 'default'
+        env['environment_name'] = environment
+        @binding = make_binding env
+      end
+    end
+
+    def convert_file(infile)
+      ERB.new(File.read(infile)).result(@binding)
+    end
+    
+    def get(name)
+      eval name.to_s, @binding
+    end
+    
+    def method_missing(name, *args, &block)
+      get name
+    end
+    
+    private
+    def make_binding(env)
+      klass = ConfStruct.new *env.keys.map(&:intern)
+      k = klass.new *env.values
+      # support up to 5 levels of embedding
+      5.times do
+        values = env.values.map do |v|
+          v.is_a?(String) ? ERB.new(v).result(k.get_binding) : v
+        end
+        k = klass.new *values
+      end
+      k.get_binding
+    end
+  end
+
+  class JSONConfigTemplate < ConfigTemplate
+    def initialize(config, environment = nil)
+      super JSON.parse(config), environment
+    end    
+  end
+
+  class YAMLConfigTemplate < ConfigTemplate
+    def initialize(config, environment = nil)
+      super YAML.load(config), environment
+    end
+  end
+end

data/lib/configulator/version.rb

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

data/test/configulator_test.rb

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'configulator'
+require 'test/unit'
+
+class ConfigulatorTest < Test::Unit::TestCase
+  def test_json_load_without_env
+    input = {
+      "one" => "something",
+      "two" => "<%= one %> one",
+      "three" => "<%= two %> two"
+    }
+    c = Configulator.from_json(JSON.dump(input))
+    assert_equal c.one, "something"
+    assert_equal c.two, "something one"
+    assert_equal c.three, "something one two"
+  end
+
+  def test_json_load_with_env
+    input = {
+      "default" => {
+        "one" => "something",
+        "two" => "<%= one %> one",
+        "three" => "<%= two %> two"        
+      },
+      "test" => {
+        "three" => "<%= one %> as three",
+        "newone" => 3
+      }
+    }
+    c = Configulator.from_json(JSON.dump(input), "test")
+    assert_equal c.one, "something"
+    assert_equal c.two, "something one"
+    assert_equal c.three, "something as three"
+    assert_equal c.newone, 3
+
+    assert_raise RuntimeError do
+      Configulator.from_json(JSON.dump(input), "testfake")
+    end
+  end
+
+  def test_yaml_load_without_env
+    input = {
+      "one" => "something",
+      "two" => "<%= one %> one",
+      "three" => "<%= two %> two"
+    }
+    c = Configulator.from_yaml(YAML.dump(input))
+    assert_equal c.one, "something"
+    assert_equal c.two, "something one"
+    assert_equal c.three, "something one two"
+  end
+
+  def test_yaml_load_with_env
+    input = {
+      "default" => {
+        "one" => "something",
+        "two" => "<%= one %> one",
+        "three" => "<%= two %> two"        
+      },
+      "test" => {
+        "three" => "<%= one %> as three",
+        "newone" => 3
+      }
+    }
+    c = Configulator.from_yaml(YAML.dump(input), "test")
+    assert_equal c.one, "something"
+    assert_equal c.two, "something one"
+    assert_equal c.three, "something as three"
+    assert_equal c.newone, 3
+
+    assert_raise RuntimeError do
+      Configulator.from_yaml(YAML.dump(input), "testfake")
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: configulator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Muller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Configurator allows you to maintain a single file with configuration
+  values that can be used to generate other config files based on templates.
+email:
+- bamuller@gmail.com
+executables:
+- configulator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/configulator
+- configulator.gemspec
+- lib/configulator.rb
+- lib/configulator/config_template.rb
+- lib/configulator/version.rb
+- test/configulator_test.rb
+homepage: https://github.com/bmuller/configulator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generate config files from a template
+test_files:
+- test/configulator_test.rb