sprinkle 0.4.2 → 0.5.0.rc1

data/lib/sprinkle/installers/installer.rb

@@ -1,4 +1,8 @@
 module Sprinkle
+  # Installers are where the bulk of the work in Sprinkle happens.  Installers are
+  # the building blocks of packages.  Typically each unique type of install
+  # command has it's own installer class.
+  # 
   module Installers
     # The base class which all installers must subclass, this class makes
     # sure all installers share some general features, which are outlined
@@ -8,9 +12,16 @@ module Sprinkle
     # 
     # With all installation methods you have the ability to specify multiple
     # pre/post installation hooks. This gives you the ability to specify
-    # commands to run before and after an installation takes place. All 
-    # commands by default are sudo'd so there is no need to include "sudo"
-    # in the command itself. There are three ways to specify a pre/post hook.
+    # commands to run before and after an installation takes place. 
+    # There are three ways to specify a pre/post hook.
+    
+    # Note about sudo:
+    # When using the Capistrano actor all commands by default are run using
+    # sudo (unless your Capfile includes "set :use_sudo, false").  If you wish 
+    # to use sudo periodically with "set :user_sudo, false" or with an actor 
+    # other than Capistrano then you can just append it to your command. Some 
+    # installers (transfer) also support a :sudo option, so check each 
+    # installer for details.
     # 
     # First, a single command:
     #
@@ -45,11 +56,37 @@ module Sprinkle
 
       def initialize(package, options = {}, &block) #:nodoc:
         @package = package
-        @options = options
+        @options = options || {}
         @pre = {}; @post = {}
         self.instance_eval(&block) if block
       end
+      
+      class << self
+        def subclasses
+          @subclasses ||= []
+        end
+        
+        def api(&block)
+          Sprinkle::Package::Package.class_eval &block
+        end
+        
+        def verify_api(&block)
+          Sprinkle::Verify.class_eval &block
+        end
 
+        def inherited(base)
+          subclasses << base
+        end
+      end
+            
+      def sudo_cmd
+        "sudo " if sudo?
+      end
+      
+      def sudo?
+        options[:sudo] or package.sudo?
+      end
+            
       def pre(stage, *commands)
         @pre[stage] ||= []
         @pre[stage] += commands
@@ -61,6 +98,15 @@ module Sprinkle
         @post[stage] += commands
         @post[stage] += [yield] if block_given?
       end
+      
+      def per_host?
+        return false
+        @per_host
+      end
+      
+      # Called right before an installer is exected, can be used for logging
+      # and announcing what is about to happen
+      def announce; end
 
       def process(roles) #:nodoc:
         assert_delivery
@@ -71,12 +117,11 @@ module Sprinkle
         end
 
         unless Sprinkle::OPTIONS[:testing]
-          logger.info "--> Installing #{package.name} for roles: #{roles}"
-          @delivery.process(@package.name, install_sequence, roles)
+          logger.debug "    --> Running #{self.class.name} for roles: #{roles}"
+          @delivery.install(self, roles, :per_host => per_host?)
         end
       end
 
-      protected
         # More complicated installers that have different stages, and require pre/post commands
         # within stages can override install_sequence and take complete control of the install
         # command sequence construction (eg. source based installer).
@@ -84,6 +129,12 @@ module Sprinkle
           commands = pre_commands(:install) + [ install_commands ] + post_commands(:install)
           commands.flatten
         end
+        
+      protected
+      
+        def log(t, level=:info)
+          logger.send(level, t)
+        end
 
         # A concrete installer (subclass of this virtual class) must override this method
         # and return the commands it needs to run as either a string or an array. 

data/lib/sprinkle/installers/mac_port.rb

@@ -1,8 +1,6 @@
 module Sprinkle
   module Installers
-    # = Mac OS X Port Installer (macports)
-    #
-    # The Port installer installs macports ports.
+    # The MacPort installer installs macports ports.
     # 
     # == Example Usage
     #
@@ -13,17 +11,26 @@ module Sprinkle
     #   end
     #
     # == Notes
+    #
     # Before MacPorts packages can be installed, the PATH
     # environment variable probably has to be changed so
-    # capistrano can find the /opt/local/bin/port executable
+    # Sprinkle can find the /opt/local/bin/port executable
     #
     # You must set PATH in ~/.ssh/environment on the remote
     # system and enable 'PermitUserEnvironment yes' in /etc/sshd_config
+    #
     class MacPort < Installer
+      
+      api do
+        def mac_port(port, options={}, &block)
+          install Sprinkle::Installers::MacPort.new(self, port, options, &block)
+        end
+      end
+      
       attr_accessor :port #:nodoc:
 
-      def initialize(parent, port, &block) #:nodoc:
-        super parent, &block
+      def initialize(parent, port, options = {}, &block) #:nodoc:
+        super parent, options, &block
         @port = port
       end
 

data/lib/sprinkle/installers/npm.rb

@@ -0,0 +1,42 @@
+module Sprinkle
+  	module Installers
+      # = Npm package Installed
+      #
+      # Installs an npm module
+      # 
+      # == Example Usage
+      #
+      #   package :magic_beans do
+      #     npm 'grunt'
+      #   end
+      #
+      #   verify { has_npm 'grunt' }
+  		class Npm < Installer
+        
+  			attr_accessor :package_name
+        
+        api do
+          def npm(package, &block)
+            install Sprinkle::Installers::Npm.new(self, package, &block)
+          end
+        end
+        
+        verify_api do
+          def has_npm(package)
+            @commands << "npm --global list | grep \"#{package}@\""
+          end
+        end
+
+  			def initialize(parent, package_name, &block) #:nodoc:
+  				super parent, &block
+  				@package_name = package_name
+  			end
+
+  			protected
+  				def install_commands #:nodoc:
+  					"npm install --global #{@package_name}"
+  				end
+
+  	end
+	end
+end

data/lib/sprinkle/installers/openbsd_pkg.rb

@@ -1,8 +1,6 @@
 module Sprinkle
   module Installers
-    # = OpenBSD Package Installer
-    #
-    # The Pkg package installer installs OpenBSD packages.
+    # The OpenBSD package installer installs OpenBSD packages.
     # 
     # == Example Usage
     #
@@ -27,14 +25,9 @@ module Sprinkle
     # 
     # For help on PKG_PATH see section 15.2.2 of the OpenBSD FAQ 
     # (http://www.openbsd.org/faq/faq15.html)
-    class OpenbsdPkg < Installer
-      attr_accessor :packages #:nodoc:
-
-      def initialize(parent, packages, &block) #:nodoc:
-        super parent, &block
-        packages = [packages] unless packages.is_a? Array
-        @packages = packages
-      end
+    class OpenbsdPkg < PackageInstaller
+      
+      auto_api
 
       protected
 

data/lib/sprinkle/installers/opensolaris_pkg.rb

@@ -1,8 +1,6 @@
 module Sprinkle
   module Installers
-    # = OpenSolaris Package Installer
-    #
-    # The Pkg package installer installs OpenSolaris packages.
+    # The OpenSolaris package installer installs OpenSolaris packages.
     # 
     # == Example Usage
     #
@@ -21,16 +19,12 @@ module Sprinkle
     # == Note
     # If you are using capistrano as the deployment method
     # you will need to add the following lines to your deploy.rb
-    # set :sudo, 'pfexec'
-    # set :sudo_prompt, ''
-    class OpensolarisPkg < Installer
-      attr_accessor :packages #:nodoc:
-
-      def initialize(parent, packages, &block) #:nodoc:
-        super parent, &block
-        packages = [packages] unless packages.is_a? Array
-        @packages = packages
-      end
+    #
+    #   set :sudo, 'pfexec'
+    #   set :sudo_prompt, ''
+    class OpensolarisPkg < PackageInstaller
+      
+      auto_api
 
       protected
 

data/lib/sprinkle/installers/package_installer.rb

@@ -0,0 +1,33 @@
+module Sprinkle
+  module Installers
+    # This is a abstract class installer that most all the package installers
+    # inherit from (deb, *BSD pkg, rpm, etc)
+    class PackageInstaller < Installer
+      
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, *packages, &block) #:nodoc:
+        options = packages.extract_options!
+        super parent, options, &block
+        @packages = [*packages].flatten
+      end
+      
+      def self.auto_api
+        method_name = self.to_s.underscore.split("/").last
+        class_name = self.to_s
+        api do
+          method="def #{method_name}(*names, &block)
+            install #{class_name}.new(self, *names, &block)
+          end"
+          eval(method)
+        end
+      end
+      
+      # called by subclasses of PackageInstaller
+      def install_package(*names, &block) #:nodoc:
+        install Sprinkle::Installers::class.new(self, *names, &block)
+      end
+
+    end
+  end
+end

data/lib/sprinkle/installers/pacman.rb

@@ -1,21 +1,13 @@
 module Sprinkle
   module Installers
-    class Pacman < Installer
-      attr_accessor :packages
-
-      def initialize(parent, *packages, &block)
-        super parent, options, &block
-
-        packages = [packages] unless packages.is_a?(Array)
-        packages.flatten!
-
-
-        @packages = packages
-      end
+    # The pacman installer installs Pacman packages
+    class Pacman < PackageInstaller
+      
+      auto_api
 
       protected
 
-      def install_commands
+      def install_commands #:nodoc:
         "pacman -Sy #{@packages.join(' ')} --no-confirm --needed"  
       end
     end

data/lib/sprinkle/installers/pear.rb

@@ -0,0 +1,40 @@
+module Sprinkle
+  	module Installers
+      # = Pear package installed
+      #
+      # Installs the specified pear package
+      # 
+      # == Example Usage
+      #
+      #   package :php_stuff do
+      #     pear 'PHP_Compat'
+      #     verify { has_pear 'PHP_Compat' }
+      #   end
+  		class Pear < Installer
+  			attr_accessor :package_name
+        
+        api do
+          def pear(package, &block)
+            install Sprinkle::Installers::Pear.new(self, package, &block)
+          end
+        end
+        
+        verify_api do
+          def has_pear(package)
+            @commands << "pear list | grep \"#{package}\" | grep \"stable\""
+          end
+        end
+
+  			def initialize(parent, package_name, &block) #:nodoc:
+  				super parent, &block
+  				@package_name = package_name
+  			end
+
+  			protected
+  				def install_commands #:nodoc:
+  					"pear install --alldeps #{@package_name}"
+  				end
+
+  		end
+	end
+end

data/lib/sprinkle/installers/push_text.rb

@@ -2,9 +2,7 @@ module Sprinkle
   module Installers
     # Beware, strange "installer" coming your way.
     #
-    # = Text configuration installer
-    #
-    # This installer pushes simple configuration into a file.
+    # This push text installer pushes simple configuration into a file.
     # 
     # == Example Usage
     #
@@ -22,14 +20,29 @@ module Sprinkle
     #   end
     #
     # A special verify step exists for this very installer
-    # its known as file_contains, it will test that a file indeed
+    # its known as +file_contains+, it will test that a file indeed
     # contains a substring that you send it.
     #
+    #   package :magic_beans do
+    #     push_text 'magic_beans', '/etc/apache2/apache2.conf'
+    #     verify do
+    #       file_contains '/etc/apache2/apache2.conf', 'magic_beans'
+    #     end
+    #   end
+    #
     class PushText < Installer
       attr_accessor :text, :path #:nodoc:
+      
+      api do
+        def push_text(text, path, options = {}, &block)
+          install Sprinkle::Installers::PushText.new(self, text, path, options, &block)
+        end
+      end
 
       def initialize(parent, text, path, options={}, &block) #:nodoc:
         super parent, options, &block
+        # by default we would not want to push the same thing over and over
+        options.reverse_merge!(:idempotent => true)
         @text = text
         @path = path
       end
@@ -37,7 +50,7 @@ module Sprinkle
       protected
 
         def install_commands #:nodoc:
-          "#{"#{'sudo ' if option?(:sudo)}grep \"^#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}$\" #{@path} ||" if option?(:idempotent) }/bin/echo -e '#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}' |#{'sudo ' if option?(:sudo)}tee -a #{@path}"
+          "#{"#{sudo_cmd}grep \"^#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}$\" #{@path} || " if option?(:idempotent) }/bin/echo -e '#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}' |#{sudo_cmd}tee -a #{@path}"
         end
 
     end

data/lib/sprinkle/installers/rake.rb

@@ -1,7 +1,5 @@
 module Sprinkle
   module Installers
-    # = Rake Installer
-    #
     # This installer runs a rake command.
     # 
     # == Example Usage
@@ -20,6 +18,13 @@ module Sprinkle
     #   end
      
     class Rake < Installer
+      
+      api do
+        def rake(name, options = {}, &block)
+          install Sprinkle::Installers::Rake.new(self, name, options, &block)
+        end    
+      end
+      
       def initialize(parent, commands, options = {}, &block) #:nodoc:
         super parent, options, &block
         @commands = commands

data/lib/sprinkle/installers/reconnect.rb

@@ -0,0 +1,29 @@
+module Sprinkle
+  module Installers
+    # Disconnects and reconnects the remote SSH session, you might want to do this 
+    # after pushing a file that would affect the local shell environment
+    #
+    # == Example Usage
+    #
+    #   package :download_with_proxy do
+    #     push_text proxy_config, "/etc/environment", :sudo => true
+    #     reconnect
+    #     source "http://someurlthatneedstheproxy.com/installer.tar.gz"
+    #   end
+    class Reconnect < Installer
+      
+      api do
+        def reconnect(options={}, &block)
+          install Sprinkle::Installers::Reconnect.new(self, options, &block)
+        end
+      end
+
+      # :RECONNECT is a symbol that the actors understand to mean to drop
+      # and reestablish any SSH conncetions they have open
+      def install_commands #:nodoc:
+        :RECONNECT
+      end
+
+    end
+  end
+end