sprinkle 0.7.1.1 → 0.7.2

data/lib/sprinkle/core.rb

@@ -0,0 +1,16 @@
+module Sprinkle
+  # stores the global list of policies as they are defined
+  POLICIES = []
+  
+  module Core
+    # Defines a single policy. Currently the only option, which is also
+    # required, is :roles, which defines which servers a policy is
+    # used on.
+    def policy(name, options = {}, &block)
+      p = Sprinkle::Policy.new(name, options, &block)
+      POLICIES << p
+      p
+    end
+      
+  end
+end

data/lib/sprinkle/deployment.rb

@@ -1,4 +1,6 @@
 module Sprinkle
+  # = Deployments
+  #
   # Deployment blocks specify deployment specific information about a 
   # sprinkle script. An example:
   #
@@ -62,14 +64,14 @@ module Sprinkle
       end
 
       def method_missing(sym, *args, &block) #:nodoc:
-        @defaults[sym] = block
+        if Sprinkle::Package::Package.installer_methods.include?(sym)
+          @defaults[sym] = block
+        else
+          super sym, *args, &block
+        end
       end
 
-      def respond_to?(sym) #:nodoc:
-        !!@defaults[sym]
-      end
-      
-      def active_policies
+      def active_policies #:nodoc:
         if role=Sprinkle::OPTIONS[:only_role]
           role=role.to_sym
           POLICIES.select {|x| [x.roles].flatten.include?(role) }

data/lib/sprinkle/errors/pretty_failure.rb

@@ -1,5 +1,5 @@
 module Sprinkle
-  module Errors
+  module Errors #:nodoc:
     
     class PrettyFailure < StandardError #:nodoc:
       

data/lib/sprinkle/errors/template_error.rb

@@ -1,6 +1,6 @@
 module Sprinkle::Errors
   # Blatantly stole this from Chef
-  class TemplateError < RuntimeError
+  class TemplateError < RuntimeError #:nodoc:
     attr_reader :original_exception, :context
     SOURCE_CONTEXT_WINDOW = 2 unless defined? SOURCE_CONTEXT_WINDOW
 

data/lib/sprinkle/installers/brew.rb

@@ -1,7 +1,5 @@
 module Sprinkle
   module Installers
-    # = Homebrew Package Installer
-    #
     # The Homebrew package installer uses the +brew+ command to install
     # packages on OSX.
     # 

data/lib/sprinkle/installers/deb.rb

@@ -11,8 +11,12 @@ module Sprinkle
     #   end
     #
     class Deb < PackageInstaller
-      
-      auto_api
+
+      ##
+      # install deb packages from an external URL
+      # :call-seq:
+      #   deb(*package_urls)
+      auto_api :deb
 
       protected
 

data/lib/sprinkle/installers/file.rb

@@ -2,47 +2,44 @@ require 'tempfile'
 
 module Sprinkle
   module Installers
+    # = File installer
+    #
+    # This installer creates a file on the remote server.
+    #
+    # == Example Usage
+    #
+    # Installing a nginx.conf onto remote servers
+    #
+    #   package :nginx_conf do
+    #     file '/etc/nginx.conf', :content => File.read('files/nginx.conf'),
+    #       :sudo => true
+    #   end
+    #
+    # Sudo is only necessary when the user your sprinkle is running as does
+    # not have necessarily permissions to create the file on its own.
+    # Such as when the file is in /etc.
+    #
+    # Should you need to run commands before or after the file transfer (making
+    # directories or changing permissions), you can use the pre/post :install directives.
+    # 
+    # == Rendering templates
+    #
+    # Use the template render helper to render an ERB template to a remote file (you 
+    # can use variables in your templates by setting them as instance variables inside
+    # your package.  Templates have access to package methods such as opts, args, etc.
+    #
+    #   package :nginx_conf do
+    #     @nginx_port = 8080
+    #     file '/etc/nginx.conf', 
+    #       :contents => render("nginx.conf")
+    #       # ./templates/nginx.conf.erb or 
+    #       # ./templates/nginx.conf should contain the erb template
+    #   end
     class FileInstaller < Installer
-      # = File installer
-      #
-      # This installer creates a file on the remote server.
-      #
-      # == Example Usage
-      #
-      # Installing a nginx.conf onto remote servers
-      #
-      #   package :nginx_conf do
-      #     file '/etc/nginx.conf', :content => File.read('files/nginx.conf')
-      #   end
-      #
-      # If you user has access to 'sudo' and theres a file that requires
-      # priveledges to install, you can pass :sudo => true
-      #
-      #   package :nginx_conf do
-      #     file '/etc/nginx.conf', :sudo => true,
-      #       :content => File.read('files/nginx.conf')
-      #   end
-      #
-      # Should you need to run commands before or after the file transfer (making
-      # directories or changing permissions), you can use the pre/post :install directives.
-      # 
-      # == Rendering templates
-      #
-      # Use the template render helper to render an ERB template to a remote file (you 
-      # can use variables in your templates by setting them as instance variables inside
-      # your package.  Templates have access to package methods such as opts, args, etc.
-      #
-      #   package :nginx_conf do
-      #     @nginx_port = 8080
-      #     file '/etc/nginx.conf', 
-      #       :contents => render("nginx.conf")
-      #       # ./templates/nginx.conf.erb or 
-      #       # ./templates/nginx.conf should contain the erb template
-      #   end
-      attr_reader :sourcepath, :destination, :contents
+      attr_reader :sourcepath, :destination, :contents #:nodoc:
       
       api do
-        def file(destination, options = {}, &block)
+        def file(destination, options = {}, &block) #:nodoc:
           # options.merge!(:binding => binding())
           install FileInstaller.new(self, destination, options, &block)
         end
@@ -61,15 +58,17 @@ module Sprinkle
         mode options[:mode] if options[:mode]
       end
       
-      def install_commands
+      def install_commands #:nodoc:
         :TRANSFER
       end
             
+      # calls chown own to set the file ownership
       def owner(owner)
         @owner = owner
         post :install, "#{sudo_cmd}chown #{owner} #{@destination}"
       end
       
+      # calls chmod to set the files permissions
       def mode(mode)
         @mode = mode
         post :install, "#{sudo_cmd}chmod #{mode} #{@destination}"

data/lib/sprinkle/installers/freebsd_pkg.rb

@@ -18,6 +18,10 @@ module Sprinkle
     #
     class FreebsdPkg < PackageInstaller
       
+      ##
+      # installs the FreeBSD packages passed
+      # :method: freebsd_pkg
+      # :call-seq: freebsd_pkg(*packages)
       auto_api
 
       protected

data/lib/sprinkle/installers/group.rb

@@ -1,18 +1,17 @@
 module Sprinkle
   module Installers
+    # The user installer helps add groups.  You may pass flags as an option.
+    # 
+    # == Example Usage
+    #
+    #   package :users do
+    #     add_group 'webguys', :flags => "--shell /usr/bin/zsh"
+    #
+    #     verify do
+    #       has_group 'webguys'
+    #     end
+    #   end
     class Group < Installer
-      # The user installer helps add groups.  You may pass flags as an option.
-      # 
-      # == Example Usage
-      #
-      #   package :users do
-      #     add_group 'webguys', :flags => "--shell /usr/bin/zsh"
-      #
-      #     verify do
-      #       has_group 'webguys'
-      #     end
-      #   end
-      
       api do
         def add_group(group, options={},  &block)
           install Group.new(self, group, options, &block)

data/lib/sprinkle/installers/install_package.rb

@@ -1,6 +1,6 @@
 module Sprinkle
   module Installers
-    class InstallPackage < Installer
+    class InstallPackage < Installer #:nodoc:
       cattr_accessor :installer
       attr_accessor :packages #:nodoc:
 
@@ -62,18 +62,18 @@ end
 module Sprinkle
   module Package
     class Package
-      def install_package(*names, &block)
+      def install_package(*names, &block) #:nodoc:
         ActiveSupport::Deprecation.warn("install_package will be removed from sprinkle 0.8, please use yum or smart installers instead.")
         @installers << Sprinkle::Installers::InstallPackage.new(self, names, &block)
       end
 
-      def uninstall_package(*names, &block)
+      def uninstall_package(*names, &block) #:nodoc:
         ActiveSupport::Deprecation.warn("uninstall_package will be removed from sprinkle 0.8, please use yum or smart installers instead.")
         @installers << Sprinkle::Installers::UninstallPackage.new(self, names, &block)
       end
 
-      alias_method :install_packages, :install_package
-      alias_method :uninstall_packages, :uninstall_package
+      alias_method :install_packages, :install_package #:nodoc:
+      alias_method :uninstall_packages, :uninstall_package #:nodoc:
     end
   end
 end

data/lib/sprinkle/installers/openbsd_pkg.rb

@@ -26,7 +26,11 @@ 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 < PackageInstaller
-      
+
+      ##
+      # installs the OpenBSD packages passed
+      # :method: openbsd_pkg
+      # :call-seq: openbsd_pkg(*packages)
       auto_api
 
       protected

data/lib/sprinkle/installers/opensolaris_pkg.rb

@@ -13,7 +13,7 @@ module Sprinkle
     # You may also specify multiple packages as an array:
     #
     #   package :magic_beans do
-    #     opensolaris_pkg %w(magic_beans magic_sauce)
+    #     opensolaris_pkg 'magic_beans', 'magic_sauce'
     #   end
     #
     # == Note
@@ -24,6 +24,10 @@ module Sprinkle
     #   set :sudo_prompt, ''
     class OpensolarisPkg < PackageInstaller
       
+      ##
+      # installs the OpenSolaris packages passed
+      # :method: opensolaris_pkg
+      # :call-seq: opensolaris_pkg(*packages)
       auto_api
 
       protected

data/lib/sprinkle/installers/package_installer.rb

@@ -4,7 +4,8 @@ module Sprinkle
     # inherit from (deb, *BSD pkg, rpm, etc)
     class PackageInstaller < Installer
       
-      attr_accessor :packages #:nodoc:
+      # holds the list of packages to be installed
+      attr_accessor :packages 
 
       def initialize(parent, *packages, &block) #:nodoc:
         options = packages.extract_options!
@@ -12,8 +13,11 @@ module Sprinkle
         @packages = [*packages].flatten
       end
       
-      def self.auto_api
-        method_name = self.to_s.underscore.split("/").last
+      # automatically sets up the api for package installation based on the class name
+      #
+      # Apt becomes the method `apt`, etc
+      def self.auto_api(*args)
+        method_name = args.first || self.to_s.underscore.split("/").last
         class_name = self.to_s
         api do
           method="def #{method_name}(*names, &block)

data/lib/sprinkle/installers/pacman.rb

@@ -3,6 +3,10 @@ module Sprinkle
     # The pacman installer installs Pacman packages
     class Pacman < PackageInstaller
       
+      ##
+      # installs the Pacman packages passed
+      # :method: pacman
+      # :call-seq: pacman(*packages)
       auto_api
 
       protected

data/lib/sprinkle/installers/push_text.rb

@@ -47,7 +47,7 @@ module Sprinkle
         @path = path
       end
 
-      def announce
+      def announce #:nodoc:
         log "--> Append '#{@text}' to file #{@path}"
       end
 

data/lib/sprinkle/installers/rake.rb

@@ -1,6 +1,6 @@
 module Sprinkle
   module Installers
-    # This installer runs a rake command.
+    # This installer runs a rake task.
     # 
     # == Example Usage
     #
@@ -9,13 +9,13 @@ module Sprinkle
     # the :rakefile option.
     #
     #   package :spec do
-    #     rake 'spec', :rakefile => "/var/setup/Rakefile"
+    #     rake 'spec', :file => "/var/setup/Rakefile"
     #   end
     class Rake < Installer
       
       api do
-        def rake(name, options = {}, &block)
-          install Rake.new(self, name, options, &block)
+        def rake(task, options = {}, &block)
+          install Rake.new(self, task, options, &block)
         end    
       end
       
@@ -27,8 +27,16 @@ module Sprinkle
       protected
 
         def install_commands #:nodoc:
-          file = @options[:rakefile] ? "-f #{@options[:rakefile]} " : ""
-          "rake #{file}#{@commands}"
+          "#{executable} #{taskfile}#{@commands}"
+        end
+        
+        def executable #:nodoc:
+          "rake"
+        end
+        
+        def taskfile #:nodoc:
+          file = @options[:rakefile] || @options[:file] 
+          file ? "-f #{file} " : ""
         end
 
     end

data/lib/sprinkle/installers/rpm.rb

@@ -20,6 +20,11 @@ module Sprinkle
     #   end
     class Rpm < PackageInstaller
 
+      ##
+      # install RPM packages
+      # :method: rpm
+      # :call-seq:
+      #   rpm(*packages)
       auto_api
       
       verify_api do

data/lib/sprinkle/installers/runner.rb

@@ -23,8 +23,9 @@ module Sprinkle
           install Runner.new(self, cmds, options, &block)
         end
         
-        def noop(&block)
-          install Runner.new(self, "echo noop", &block)
+        # runs 'echo noop' on the remote host
+        def noop
+          install Runner.new(self, "echo noop")
         end
       end
       

data/lib/sprinkle/installers/thor.rb

@@ -2,7 +2,7 @@ module Sprinkle
   module Installers
     # = Thor Installer
     #
-    # This installer runs a thor command.
+    # This installer runs a thor task.
     # 
     # == Example Usage
     #
@@ -15,29 +15,28 @@ module Sprinkle
     # 
     # Specify a Thorfile with the :thorfile option.
     #
-    #   package :spec, :thorfile => "/var/setup/Thorfile" do
-    #     thor 'spec'
+    #   package :spec do
+    #     thor 'spec', :file => "/var/setup/Thorfile"
     #   end
      
-    class Thor < Installer
+    class Thor < Rake
       
       api do
-        def thor(name, options = {}, &block)
-          install Thor.new(self, name, options, &block)
+        def thor(task, options = {}, &block)
+          install Thor.new(self, task, options, &block)
         end  
       end
       
-      def initialize(parent, commands, options = {}, &block) #:nodoc:
-        super parent, options, &block
-        @commands = commands
-      end
-
       protected
 
-        def install_commands #:nodoc:
-          file = @options[:thorfile] ? "-f #{@options[:thorfile]} " : ""
-          "thor #{file}#{@commands}"
-        end
+      def executable #:nodoc:
+        "thor"
+      end
+      
+      def taskfile #:nodoc:
+        file = @options[:thorfile] || @options[:file] 
+        file ? "-f #{file} " : ""
+      end
 
     end
   end