sprinkle 0.4.2 → 0.5.0.rc1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+pkg
+.DS_Store
+.idea
+.*.swp
+coverage/*
+rdoc
+.ruby-version

data/Gemfile

@@ -0,0 +1,5 @@
+# to make travis CI happy
+#source :rubygems
+source "https://rubygems.org" 
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    sprinkle (0.5)
+      activesupport (>= 2.0.2)
+      capistrano (>= 2.5.5)
+      highline (>= 1.4.0)
+      open4 (>= 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    capistrano (2.14.2)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    diff-lcs (1.1.3)
+    highline (1.6.16)
+    i18n (0.6.1)
+    json (1.7.5)
+    multi_json (1.7.2)
+    net-scp (1.1.0)
+      net-ssh (>= 2.6.5)
+    net-sftp (2.1.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.6)
+    net-ssh-gateway (1.2.0)
+      net-ssh (>= 2.6.5)
+    open4 (1.1.0)
+    rake (10.0.4)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (>= 0.8.7)
+  rdoc (>= 3.12)
+  rspec (>= 2.5)
+  sprinkle!

data/README.markdown

@@ -1,12 +1,16 @@
 # SPRINKLE
 
-* <http://redartisan.com/2008/5/27/sprinkle-intro>
-* <http://github.com/crafterm/sprinkle>
-* <http://github.com/benschwarz/passenger-stack>
-* <http://github.com/trevorturk/sprinkle-packages>
-* <http://www.vimeo.com/2888665>
-* <http://redartisan.lighthouseapp.com/projects/25275-sprinkle/tickets>
-* <http://maxim.github.com/sprinkle-cheatsheet>
+  * <http://redartisan.com/2008/5/27/sprinkle-intro>
+  * <http://github.com/crafterm/sprinkle>
+  * <http://github.com/benschwarz/passenger-stack>
+  * <http://github.com/trevorturk/sprinkle-packages>
+  * <http://www.vimeo.com/2888665>
+  * <http://maxim.github.com/sprinkle-cheatsheet>
+  * <http://github.com/mingalar/sprinkle-packages>
+  * <http://github.com/stuartellis/spritz>
+  * <http://engineering.gomiso.com/2011/08/26/forget-chef-or-puppet-automate-with-sprinkle/>
+
+  [![Build Status](https://travis-ci.org/crafterm/sprinkle.png?branch=master)](https://travis-ci.org/crafterm/sprinkle)
 
 ## DESCRIPTION:
 
@@ -20,20 +24,22 @@ define as concisely as possible a language for installing software).
 
 An example package description follows:
 
-    package :ruby do
-      description 'Ruby Virtual Machine'
-      version '1.8.6'
-      source "ftp://ftp.ruby-lang.org/pub/ruby/1.8/ruby-#{version}-p111.tar.gz"
-      requires :ruby_dependencies
-
-      verify do
-        has_file '/usr/bin/ruby'
-      end
-    end
-
-This defines a package called 'ruby', that uses the source based installer to build Ruby 1.8.6 from source,
-installing the package 'ruby_dependencies' beforehand. Additionally, the package verifies it was installed
-correctly by verifying the file '/usr/bin/ruby' exists after installation. If this verification fails, the
+``` ruby
+package :ruby do
+  description 'Ruby Virtual Machine'
+  version '1.8.6'
+  source "ftp://ftp.ruby-lang.org/pub/ruby/1.8/ruby-#{version}-p111.tar.gz"
+  requires :ruby_dependencies
+
+  verify do
+    has_file '/usr/bin/ruby'
+  end
+end
+```
+
+This defines a package called `'ruby'`, that uses the source based installer to build Ruby 1.8.6 from source,
+installing the package `'ruby_dependencies'` beforehand. Additionally, the package verifies it was installed
+correctly by verifying the file `'/usr/bin/ruby'` exists after installation. If this verification fails, the
 sprinkle script will gracefully stop.
 
 Reasonable defaults are set by sprinkle, such as the install prefix, download area, etc, but can be customized
@@ -53,14 +59,16 @@ Packages can be grouped into polices to define several packages that should be i
 
 An example policy:
 
-    policy :rails, :roles => :app do
-      requires :rails, :version => '2.1.0'
-      requires :appserver
-      requires :database
-      requires :webserver
-    end
+``` ruby
+policy :rails, :roles => :app do
+  requires :rails, :version => '2.1.0'
+  requires :appserver
+  requires :database
+  requires :webserver
+end
+```
 
-This defines a policy called Rails, that applies to machines of role :app. The policy includes the packages
+This defines a policy called Rails, that applies to machines of role `:app`. The policy includes the packages
 rails (version 2.1.0), appserver, database and webserver.
 
 appserver, database and webserver can be virtual packages, where the user will be prompted for selection if
@@ -74,143 +82,147 @@ desired. Sprinkle can also be configured to simply issue installation commands t
 An full example Sprinkle deployment script for deploying Rails (via gems), MySQL (via APT), Apache (via source)
 and Git (via source with dependencies from APT):
 
-    # Sprinkle Rails deployment script
-    #
-    # This is an example Sprinkle script, configured to install Rails from gems, Apache, Ruby and Git from source,
-    # and mysql and Git dependencies from apt on an Ubuntu system. Installation is configured to run via
-    # Capistrano (and an accompanying deploy.rb recipe script). Source based packages are downloaded and built into
-    # /usr/local on the remote system.
-    #
-    # A sprinkle script is separated into 3 different sections. Packages, policies and deployment.
-    #
-    # Packages
-    #
-    #  Defines the world of packages as we know it. Each package has a name and
-    #  set of metadata including its installer type (eg. apt, source, gem, etc). Packages can have
-    #  relationships to each other via dependencies
-    #
-    # Policies
-    #
-    #  Names a group of packages (optionally with versions) that apply to a particular set of roles.
-    #
-    # Deployment
-    #
-    #  Defines script wide settings such as a delivery mechanism for executing commands on the target
-    #  system (eg. capistrano), and installer defaults (eg. build locations, etc).
-
-    # Packages
-
-    package :ruby do
-      description 'Ruby Virtual Machine'
-      version '1.8.6'
-      source "ftp://ftp.ruby-lang.org/pub/ruby/1.8/ruby-#{version}-p111.tar.gz"
-      requires :ruby_dependencies
-    end
-
-    package :ruby_dependencies do
-      description 'Ruby Virtual Machine Build Dependencies'
-      apt %w( bison zlib1g-dev libssl-dev libreadline5-dev libncurses5-dev file )
-    end
-
-    package :mysql, :provides => :database do
-      description 'MySQL Database'
-      apt %w( mysql-server mysql-client )
-    end
-
-    package :apache, :provides => :webserver do
-      description 'Apache 2 HTTP Server'
-      version '2.2.9'
-      source "http://apache.wildit.net.au/httpd/httpd-#{version}.tar.bz2" do
-        enable %w( mods-shared=all proxy proxy-balancer proxy-http rewrite cache headers ssl deflate so )
-        prefix "/opt/local/apache2-#{version}"
-        post :install, 'install -m 755 support/apachectl /etc/init.d/apache2', 'update-rc.d -f apache2 defaults'
-      end
-      requires :apache_dependencies
-    end
-
-    package :apache_dependencies do
-      description 'Apache 2 HTTP Server Build Dependencies'
-      apt %w( openssl libtool mawk zlib1g-dev libssl-dev )
-    end
-
-    package :rubygems do
-      description 'Ruby Gems Package Management System'
-      version '1.2.0'
-      source "http://rubyforge.org/frs/download.php/38646/rubygems-#{version}.tgz" do
-        custom_install 'ruby setup.rb'
-      end
-      requires :ruby
-    end
-
-    package :rails do
-      description 'Ruby on Rails'
-      gem 'rails'
-      version '2.1.0'
-    end
-
-    package :mongrel do
-      description 'Mongrel Application Server'
-      gem 'mongrel'
-      version '1.1.5'
-    end
-
-    package :mongrel_cluster, :provides => :appserver do
-      description 'Cluster Management for Mongrel'
-      gem 'mongrel_cluster' # :source => 'http://gems.github.com/' for alternate gem server
-      version '1.0.5'
-      requires :mongrel
-    end
-
-    package :git, :provides => :scm do
-      description 'Git Distributed Version Control'
-      version '1.5.6.3'
-      source "http://kernel.org/pub/software/scm/git/git-#{version}.tar.gz"
-      requires :git_dependencies
-    end
-
-    package :git_dependencies do
-      description 'Git Build Dependencies'
-      apt 'git', :dependencies_only => true
-    end
-
-    # Policies
-
-    # Associates the rails policy to the application servers. Contains rails, and surrounding
-    # packages. Note, appserver, database and webserver are all virtual packages defined above. If
-    # there's only one implementation of a virtual package, it's selected automatically, otherwise
-    # the user is requested to select which one to use.
-
-    policy :rails, :roles => :app do
-      requires :rails, :version => '2.1.0'
-      requires :appserver
-      requires :database
-      requires :webserver
-      requires :scm
-    end
-
-    # Deployment
-
-    # Configures sprinkle to use capistrano for delivery of commands to the remote machines (via
-    # the named 'deploy' recipe). Also configures 'source' installer defaults to put package gear
-    # in /usr/local
-
-    deployment do
-
-      # mechanism for deployment
-      delivery :capistrano do
-        recipes 'deploy'
-      end
-
-      # source based package installer defaults
-      source do
-        prefix   '/usr/local'           # where all source packages will be configured to install
-        archives '/usr/local/sources'   # where all source packages will be downloaded to
-        builds   '/usr/local/build'     # where all source packages will be built
-      end
-
-    end
-
-Please see the examples directory for more complete examples of Sprinkle deployment scripts, and also the Passenger Stack github page and video by Ben Schwarz (<http://github.com/benschwarz/passenger-stack> and <http://www.vimeo.com/2888665> respectively).
+``` ruby
+# Sprinkle Rails deployment script
+#
+# This is an example Sprinkle script, configured to install Rails from gems, Apache, Ruby and Git from source,
+# and mysql and Git dependencies from apt on an Ubuntu system. Installation is configured to run via
+# Capistrano (and an accompanying deploy.rb recipe script). Source based packages are downloaded and built into
+# /usr/local on the remote system.
+#
+# A sprinkle script is separated into 3 different sections. Packages, policies and deployment.
+#
+# Packages
+#
+#  Defines the world of packages as we know it. Each package has a name and
+#  set of metadata including its installer type (eg. apt, source, gem, etc). Packages can have
+#  relationships to each other via dependencies
+#
+# Policies
+#
+#  Names a group of packages (optionally with versions) that apply to a particular set of roles.
+#
+# Deployment
+#
+#  Defines script wide settings such as a delivery mechanism for executing commands on the target
+#  system (eg. capistrano), and installer defaults (eg. build locations, etc).
+
+# Packages
+
+package :ruby do
+  description 'Ruby Virtual Machine'
+  version '1.8.6'
+  source "ftp://ftp.ruby-lang.org/pub/ruby/1.8/ruby-#{version}-p111.tar.gz"
+  requires :ruby_dependencies
+end
+
+package :ruby_dependencies do
+  description 'Ruby Virtual Machine Build Dependencies'
+  apt %w( bison zlib1g-dev libssl-dev libreadline5-dev libncurses5-dev file )
+end
+
+package :mysql, :provides => :database do
+  description 'MySQL Database'
+  apt %w( mysql-server mysql-client )
+end
+
+package :apache, :provides => :webserver do
+  description 'Apache 2 HTTP Server'
+  version '2.2.9'
+  source "http://apache.wildit.net.au/httpd/httpd-#{version}.tar.bz2" do
+    enable %w( mods-shared=all proxy proxy-balancer proxy-http rewrite cache headers ssl deflate so )
+    prefix "/opt/local/apache2-#{version}"
+    post :install, 'install -m 755 support/apachectl /etc/init.d/apache2', 'update-rc.d -f apache2 defaults'
+  end
+  requires :apache_dependencies
+end
+
+package :apache_dependencies do
+  description 'Apache 2 HTTP Server Build Dependencies'
+  apt %w( openssl libtool mawk zlib1g-dev libssl-dev )
+end
+
+package :rubygems do
+  description 'Ruby Gems Package Management System'
+  version '1.2.0'
+  source "http://rubyforge.org/frs/download.php/38646/rubygems-#{version}.tgz" do
+    custom_install 'ruby setup.rb'
+  end
+  requires :ruby
+end
+
+package :rails do
+  description 'Ruby on Rails'
+  gem 'rails'
+  version '2.1.0'
+end
+
+package :mongrel do
+  description 'Mongrel Application Server'
+  gem 'mongrel'
+  version '1.1.5'
+end
+
+package :mongrel_cluster, :provides => :appserver do
+  description 'Cluster Management for Mongrel'
+  gem 'mongrel_cluster' # :source => 'http://gems.github.com/' for alternate gem server
+  version '1.0.5'
+  requires :mongrel
+end
+
+package :git, :provides => :scm do
+  description 'Git Distributed Version Control'
+  version '1.5.6.3'
+  source "http://kernel.org/pub/software/scm/git/git-#{version}.tar.gz"
+  requires :git_dependencies
+end
+
+package :git_dependencies do
+  description 'Git Build Dependencies'
+  apt 'git', :dependencies_only => true
+end
+
+# Policies
+
+# Associates the rails policy to the application servers. Contains rails, and surrounding
+# packages. Note, appserver, database and webserver are all virtual packages defined above. If
+# there's only one implementation of a virtual package, it's selected automatically, otherwise
+# the user is requested to select which one to use.
+
+policy :rails, :roles => :app do
+  requires :rails, :version => '2.1.0'
+  requires :appserver
+  requires :database
+  requires :webserver
+  requires :scm
+end
+
+# Deployment
+
+# Configures sprinkle to use capistrano for delivery of commands to the remote machines (via
+# the named 'deploy' recipe). Also configures 'source' installer defaults to put package gear
+# in /usr/local
+
+deployment do
+
+  # mechanism for deployment
+  delivery :capistrano do
+    recipes 'deploy'
+  end
+
+  # source based package installer defaults
+  source do
+    prefix   '/usr/local'           # where all source packages will be configured to install
+    archives '/usr/local/sources'   # where all source packages will be downloaded to
+    builds   '/usr/local/build'     # where all source packages will be built
+  end
+
+end
+```
+
+Please see the examples directory for more complete examples of Sprinkle deployment scripts, and 
+also the [Passenger Stack github page](http://github.com/benschwarz/passenger-stack) and video by 
+(Ben Schwarz)[http://www.vimeo.com/2888665].
 
 Sprinkle is a work in progress and I'm excited to hear if anyone finds it useful - please feel free to
 comment, ask any questions, or send in any ideas, patches, bugs. All most welcome.
@@ -221,7 +233,7 @@ Marcus Crafter <crafterm@redartisan.com>
 
 (The MIT License)
 
-Copyright (c) 2008-2009 Marcus Crafter <crafterm@redartisan.com>
+Copyright (c) 2008-2013 Marcus Crafter <crafterm@redartisan.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,35 +1,13 @@
 require 'rubygems'
 require 'rake'
 require 'rspec/core/rake_task'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "sprinkle"
-    gem.summary = "Ruby DSL based software provisioning tool"
-    gem.description = "Ruby DSL based software provisioning tool"
-    gem.email = "crafterm@redartisan.com"
-    gem.rubyforge_project = 'sprinkle'
-    gem.homepage = "http://github.com/crafterm/sprinkle"
-    gem.authors = ["Marcus Crafter"]
-    gem.add_development_dependency("rspec", ">= 2.5")
-    gem.add_dependency('activesupport', '>= 2.0.2')
-    gem.add_dependency('highline', '>= 1.4.0')
-    gem.add_dependency('capistrano', '>= 2.5.5')
-
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require 'rdoc/task'
+require './lib/sprinkle/version'
 
 task "inst" => [:clobber, :build] do
   puts `gem install pkg/sprinkle-*.gem`
 end
 
-task :spec => :check_dependencies
-
 desc 'Default: run specs.'
 task :default => :spec
 
@@ -46,10 +24,8 @@ RSpec::Core::RakeTask.new(:coverage) do |t|
   t.rcov_opts = ['--exclude', 'spec']
 end
 
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+RDoc::Task.new do |rdoc|
+  version = Sprinkle::Version
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "sprinkle #{version}"