itrigga-generator 0.1.2 → 0.1.3

data/README.rdoc

@@ -1,6 +1,53 @@
 = itrigga-generator
 
-Description goes here.
+A flexible template rendering gem. We use this to dynamically generate monit scripts, logrotate scripts, cron scripts etc.
+At the moment only erb templates are supported.
+
+== How to use with config file
+There are 2 ways to make the generator work - with or without a config file.
+A config file is simply a hash of options serialized into YAML. An example (test.yml) is:
++
+---
+processes_to_start: [:worker]
+processes:
+  worker:
+    name: worker_1
+    identifier: 1
++
+In this example there is a worker process whose template should be rendered. If this was a monit script then in the TEMPLATE_DIR there must be a matching template
+named worker.monit.config
+
+This can be invoked by:
++rake itrigga:generator TEMPLATE_DIR=/tmp/test/templates OUTPUT_DIR=/tmp/test/output CONFIG_FILE=/tmp/test/test.yml+
+This will look for the template in /tmp/test/templates and put the rendered template into /tmp/test/output
+
+If a config file is given then is must define a processes hash. Each key needs to match the name of the template.
+Only the templates listed in the processes_to_start list will be rendered.
+
+For this example the worker.monit.config file looks like this:
++
+check process <%= name %> with pidfile <%= File.join("/var/run","worker_#{identifer}.pid") %>
+	start program = "/etc/init.d/itrigga start worker <%= identifer %>"
+	stop program = "/etc/init.d/itrigga stop worker <%= identifer %>"
+	group workers
++
+
+The keys defined in the config file for each process are made available to the template as top level variables (in this case identifer and name)
+Also any variables given to the rake task are also made available - so there will be variables named template_dir, output_dir and config_file.
+
+== How to use with no config file
+You can also set the CONFIG_FILE=false in the rake task. This will then just make the variables in the rake task available to the template.
+
+eg
+rake itrigga:generator PATTERN=logrotate TEMPLATE_DIR=/tmp/test/templates OUTPUT_DIR=/tmp/test/output CONFIG_FILE=false
+
+== What if I have different templates in the TEMPLATE_DIR?
+Use the PATTERN=xxxx variable (which can be any regex minus the start and end /). This will then filter the templates in the TEMPLATE_DIR.
+
+== What if I have a template I don't want rendered?
+Change the template name to: worker.monit.config.inactive
+
+
 
 == Contributing to itrigga-generator
  
@@ -14,6 +61,5 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2011 Anson. See LICENSE.txt for
+Copyright (c) 2011 iTrigga Media. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/itrigga-generator.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{itrigga-generator}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anson Kelly"]
+  s.date = %q{2011-10-05}
+  s.description = %q{Generates config files from templates using information from a config yaml file}
+  s.email = %q{ansonkelly@itrigga.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "itrigga-generator.gemspec",
+    "lib/itrigga-generator.rb",
+    "lib/itrigga-generator/constants.rb",
+    "lib/itrigga-generator/generator.rb",
+    "lib/tasks/generator.rake",
+    "test/helper.rb",
+    "test/test_itrigga-generator.rb"
+  ]
+  s.homepage = %q{http://gems.itrigga.com/itrigga-generator}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib", "lib", "lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Generates config files from templates}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: itrigga-generator
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Anson Kelly
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-04 00:00:00 +01:00
+date: 2011-10-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -109,6 +109,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- itrigga-generator.gemspec
 - lib/itrigga-generator.rb
 - lib/itrigga-generator/constants.rb
 - lib/itrigga-generator/generator.rb