conman 0.1.0 → 0.1.1

data/README.md

@@ -3,20 +3,31 @@ conman - Server Configuration Management
 
 __This is still under active development and is subject to change__
 
+Conman is a simple server configuration management library.  The core concepts are around:
+
+* _Ingredients_ - reusable, sharable components that achieve specific tasks
+* _Recipes_ - your public or private recipes that make use of the Ingredients
+
+Ingredients should ensure that they are idempotent.  Public Recipes may include setting up a LAMP system for example.
+
 Installation
 ------------
 
 gem install conman
 
-Recipes
--------
+Ingredient Repository
+---------------------
 
-Our recipe library can be found at: [github.com/moocode/recipes](http://github.com/moocode/recipes)
+Our ingredient library can be found at: [github.com/moocode/ingredients](http://github.com/moocode/ingredients)
 
-Creating your first Recipe
---------------------------
+Creating your first Ingredient
+------------------------------
 
-    class FileRecipe < Recipe
+An ingredient is a simple Ruby Class whose name ends with Ingredient and (optionally) subclasses Ingredient.
+The Ingredient superclass just provides some helper methods if you wish to use them.  Because they are just Ruby classes
+they can be tested using any test framework you like.  See our ingredients repository for some examples.
+
+    class FileIngredient < Ingredient
       def create(options={})
     	`touch #{options[:path]}` unless exists? :path => options[:path]
       end
@@ -26,22 +37,49 @@ Creating your first Recipe
 	  end
 	end
 
-Your first server definition
-----------------------------
+Your first Recipe
+-----------------
 
-	class MyServer < Recipe
-		file :create :path => '/tmp/foo.txt'
+	class MyRecipe < Recipe
+		file :create, :path => '/tmp/foo.txt'
 	end
 
-Why another chef/puppet/...?
-----------------------------
+Running your Recipe
+-------------------
+
+conman ships with a binary for running your recipes.  It takes a path to a folder of ingredients and a recipe file:
+
+	conman -i /path/to/ingredients /path/to/recipes/my_recipe.rb
+
+Alternatively you can run them from a script (handy for testing)
 
-* More ruby-like
-* Simple to understand
-* Designed for smaller scale systems
+	Conman.init :ingredients => '/path/to/ingredients/'
+	Conman.run '/path/to/recipes/my_recipe.rb'
+
+Testing
+-------
+
+Here's an example of a TestUnit test for an ingredient:
+
+	require 'test/unit'
+	require 'rubygems'
+	require 'mocha'
+	require 'conman'
+
+	class FileIngredientTest < Test::Unit::TestCase
+	  def setup
+	    @@conman ||= Conman.init(:ingredients => '/path/to/ingredients/file.rb')
+	    @file = FileIngredient.new
+	  end
+
+	  def test_create
+	    FileIngredient.any_instance.expects(:create).returns('touch /tmp/moo.txt')
+	    @file.create :path => '/tmp/moo.txt'
+	  end
+    end
 
-On a live server
-----------------
+Preparing a live server
+-----------------------
 
 First you need to install all the pre-requisites (ruby, rubygems, conman, git-core)
 

data/lib/conman/ingredient.rb

@@ -0,0 +1,35 @@
+class Ingredient
+
+  def self.method_missing(m, *args, &block)
+    Recipe.execute_recipe(m, args)
+  end
+  
+  def method_missing(m, *args, &block)
+    Recipe.execute_recipe(m, args)
+  end
+  
+  def self.execute_recipe(class_name, args={})
+    clazz_name = (class_name.to_s.split('_').map {|w| w.capitalize}.join) + 'Ingredient'
+    clazz = Kernel.const_get(clazz_name)
+    method = args.shift
+    #puts "Calling #{clazz.name}##{method} with #{args.first.inspect}"
+    recipe = clazz.new
+    if args.empty?
+      recipe.send method
+    else
+      recipe.send method, args.first
+    end
+  end
+  
+  def option?(options, targets)
+    targets = [targets] unless targets.is_a? Array
+    targets.each do |target|
+      return false unless options[target] and !options[target].nil? and !options[target].to_s.strip.empty?
+    end
+  end
+  
+  def option!(options, targets)
+    raise ArgumentError, "Missing required parameter from #{options.inspect}, required = #{targets.inspect}" unless option?(options, targets)
+  end
+  
+end

data/lib/conman/recipe.rb

@@ -1,35 +1,2 @@
-class Recipe
-
-  def self.method_missing(m, *args, &block)
-    Recipe.execute_recipe(m, args)
-  end
-  
-  def method_missing(m, *args, &block)
-    Recipe.execute_recipe(m, args)
-  end
-  
-  def self.execute_recipe(class_name, args={})
-    clazz_name = (class_name.to_s.split('_').map {|w| w.capitalize}.join) + 'Recipe'
-    clazz = Kernel.const_get(clazz_name)
-    method = args.shift
-    #puts "Calling #{clazz.name}##{method} with #{args.first.inspect}"
-    recipe = clazz.new
-    if args.empty?
-      recipe.send method
-    else
-      recipe.send method, args.first
-    end
-  end
-  
-  def option?(options, targets)
-    targets = [targets] unless targets.is_a? Array
-    targets.each do |target|
-      return false unless options[target] and !options[target].nil? and !options[target].to_s.strip.empty?
-    end
-  end
-  
-  def option!(options, targets)
-    raise ArgumentError, "Missing required parameter from #{options.inspect}, required = #{targets.inspect}" unless option?(options, targets)
-  end
-  
+class Recipe < Ingredient
 end

data/lib/conman.rb

@@ -1,24 +1,25 @@
+require 'conman/ingredient'
 require 'conman/recipe'
 
 class Conman
   def self.init(options)
-    recipe_folder = options[:recipes]
+    ingredients_folder = options[:ingredients]
     
-    puts "initializing with recipes folder: #{recipe_folder}"
+    puts "initializing with ingredients folder: #{ingredients_folder}"
     
-    abort "You must specify a recipe" if recipe_folder.nil? or recipe_folder.empty?
+    abort "You must specify an ingredient" if ingredients_folder.nil? or ingredients_folder.empty?
     
-    recipes = []
+    ingredients = []
     
-    Dir.glob(recipe_folder + '*').each do |f|
-      recipes << "#{File.join f, File.basename(f)}.rb" if File.directory? f
-      recipes << f unless File.directory? f
+    Dir.glob(ingredients_folder + '*').each do |f|
+      ingredients << "#{File.join f, File.basename(f)}.rb" if File.directory? f
+      ingredients << f unless File.directory? f
     end
     
     #puts "Loading recipes: #{recipes.inspect}"
-    puts "Loading #{recipes.size} recipe(s)"
+    puts "Loading #{ingredients.size} ingredient(s)"
     
-    recipes.each {|recipe| load recipe}
+    ingredients.each {|ingredient| load ingredient}
   end
   
   def self.run(options)

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: conman
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Richard Taylor
@@ -31,10 +25,10 @@ files:
 - LICENSE
 - README.md
 - lib/conman.rb
+- lib/conman/ingredient.rb
 - lib/conman/recipe.rb
-- bin/conman
 has_rdoc: true
-homepage: http://github.com/moomerman/conman
+homepage: http://github.com/moocode/conman
 licenses: []
 
 post_install_message: 
@@ -44,27 +38,21 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
+  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
+  version: 
 requirements: []
 
 rubyforge_project: conman
-rubygems_version: 1.3.7
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: conman is a server configuration management library