sprinkle 0.7.5 → 0.7.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sprinkle (0.7.4)
+    sprinkle (0.7.6)
       activesupport (>= 2.0.2)
       capistrano (>= 2.5.5)
       erubis (>= 2.7.0)

data/examples/rails/rails.rb

@@ -56,8 +56,11 @@ end
 deployment do
 
   # mechanism for deployment
-  delivery :capistrano do
-    recipes 'deploy'
+  # delivery :capistrano do
+  #   recipes 'deploy'
+  # end
+  delivery :dummy do
+    role :app, "test"
   end
 
   # source based package installer defaults

data/lib/sprinkle.rb

@@ -17,6 +17,8 @@ def require_all(*args) # :nodoc:
     Dir[File.dirname(__FILE__) + "/sprinkle/#{f}"].each { |e| require e } }
 end
 
+$LOAD_PATH << File.dirname(__FILE__)
+
 require     'sprinkle/version'
 
 require_all "extensions/*.rb"

data/lib/sprinkle/actors/capistrano.rb

@@ -100,11 +100,10 @@ module Sprinkle
         define_task(name, roles) do
           via = fetch(:run_method, :run)
           commands.each do |command|
-            if command == :TRANSFER
-              opts.reverse_merge!(:recursive => true)
-              upload inst.sourcepath, inst.destination, :via => :scp, 
-                :recursive => opts[:recursive]
-            elsif command == :RECONNECT
+            if command.is_a? Commands::Transfer
+              upload command.source, command.destination, :via => :scp, 
+                :recursive => command.recursive?
+            elsif command.is_a? Commands::Reconnect
               teardown_connections_to(sessions.keys)
             else
               # this reset the log

data/lib/sprinkle/actors/dummy.rb

@@ -4,6 +4,8 @@ require 'pp'
 module Sprinkle
   module Actors
     class Dummy < Actor #:nodoc:
+      
+      attr_accessor :per_host
 
       def initialize(&block) #:nodoc:
         # @config.set(:_sprinkle_actor, self)
@@ -23,6 +25,7 @@ module Sprinkle
       end
       
       def install(installer, roles, opts={})
+        @installer = installer
         if self.per_host=opts.delete(:per_host)
           servers_per_role(roles).each do |server|
             installer.reconfigure_for(server)
@@ -45,10 +48,16 @@ module Sprinkle
       def servers_per_role(role)
         @roles[role]
       end
+      
+      def print_command(cmd)
+        puts cmd.inspect
+      end
 
       def process(name, commands, roles, opts = {}) #:nodoc:
         # puts "PROCESS: #{name} on #{roles}"
-        pp commands
+        commands.each do |cmd|
+          print_command(cmd)
+        end
         # return false if suppress_and_return_failures
         true
       end

data/lib/sprinkle/actors/local.rb

@@ -53,11 +53,11 @@ module Sprinkle
       def process(name, commands, roles, opts = {}) #:nodoc:
         @log_recorder = Sprinkle::Utility::LogRecorder.new
         commands.each do |command|
-          if command == :RECONNECT
+          if command.is_a?(Commands::Reconnect)
             res = 0
-          elsif command == :TRANSFER
-            res = transfer(@installer.sourcepath, @installer.destination, roles,
-              :recursive => @installer.options[:recursive])
+          elsif command.is_a?(Commands::Transfer)
+            res = transfer(command.source, command.destination, roles,
+              :recursive => command.recursive?)
           else
             res = run_command command
           end

data/lib/sprinkle/actors/ssh.rb

@@ -162,11 +162,11 @@ module Sprinkle
         def execute_on_host(commands,host) #:nodoc:
           prepare_commands(commands).each do |cmd|
             case cmd
-              when :RECONNECT
+              when cmd.is_a?(Commands::Reconnect) then
                 reconnect host
-              when :TRANSFER
-                transfer_to_host(@installer.sourcepath, @installer.destination, host, 
-                  :recursive => @installer.options[:recursive])
+              when cmd.is_a?(Commands::Transfer) then
+                transfer_to_host(cmd.source, cmd.destination, host, 
+                  :recursive => cmd.recursive?)
               else  
                 run_command cmd, host
             end

data/lib/sprinkle/commands/command.rb

@@ -0,0 +1,23 @@
+module Sprinkle
+  module Commands
+    class Command
+      
+      def initialize(str, opts = {})
+        @sudo = opts[:sudo]
+        @str = str
+        # this is a dummy class for now, not intended to be used directly
+        raise
+      end
+      
+      def sudo?
+        @sudo
+      end
+      
+      def string
+        # TODO: sudo
+        @str
+      end
+      
+    end
+  end
+end

data/lib/sprinkle/commands/reconnect.rb

@@ -0,0 +1,14 @@
+module Sprinkle
+  module Commands
+    class Reconnect < Command
+      
+      def initialize()
+      end
+      
+      def inspect
+        ":RECONNECT"
+      end
+      
+    end
+  end
+end

data/lib/sprinkle/commands/transfer.rb

@@ -0,0 +1,29 @@
+module Sprinkle
+  module Commands
+    class Transfer < Command
+      
+      attr_reader :source, :destination, :opts
+      
+      def initialize(source, destination, opts={})
+        @source = source
+        @destination = destination
+        @opts = opts
+      end
+      
+      def recursive?
+        !!@opts[:recursive]
+      end
+      
+      def inspect
+        ":TRANSFER, src: #{source}, dest: #{destination}, opts: #{@opts.inspect}"
+      end
+      
+      def eql?(a,b)
+        a.source == b.source &&
+        a.destionation == b.destination &&
+        a.opts == b.opts
+      end
+      
+    end
+  end
+end

data/lib/sprinkle/installers/file.rb

@@ -32,8 +32,23 @@ module Sprinkle
     #     @nginx_port = 8080
     #     file '/etc/nginx.conf',
     #       :contents => render("nginx.conf")
-    #       # ./templates/nginx.conf.erb or
-    #       # ./templates/nginx.conf should contain the erb template
+    #       # where [cwd] is the current working dir you're running sprinkle from
+    #       # [cwd]/templates/nginx.conf.erb or
+    #       # [cwd]/templates/nginx.conf should contain the erb template
+    #   end
+    #
+    # You can also tell the package where to look for templates, so that if you have
+    # a complex package hierarchy such as:
+    #
+    #   .../packages/p/postfix.rb
+    #   .../packages/p/postfix/templates/main.cf.erb
+    #
+    #   package :postfix do
+    #     template_search_path File.dirname(__FILE__)
+    #     file '/etc/postfix/main.cf', :contents => render("main.cf")
+    #     # searches for:
+    #     #   ../packages/p/main.cf[.erb]
+    #     #   ../packages/p/templates/main.cf[.erb]
     #   end
     class FileInstaller < Installer
       attr_reader :sourcepath, :destination, :contents #:nodoc:
@@ -60,7 +75,7 @@ module Sprinkle
       end
 
       def install_commands #:nodoc:
-        :TRANSFER
+        Commands::Transfer.new(sourcepath, destination)
       end
 
       # calls chown own to set the file ownership
@@ -87,12 +102,16 @@ module Sprinkle
       end
 
       def setup_source
-        @file=Tempfile.new(@package.name.to_s)
-        @file.print(@contents)
+        @file = Tempfile.new(@package.name.to_s)
+        @file.print @contents
         @file.close
         @sourcepath = @file.path
       end
 
+      def post_process
+        @file.unlink
+      end
+
     end
   end
 end

data/lib/sprinkle/installers/installer.rb

@@ -130,6 +130,10 @@ module Sprinkle
         return false
       end
 
+      # Called right after processing, can be used for local cleanup such
+      # as removing any temporary files created on the local system, etc
+      def post_process; end
+
       # Called right before an installer is exected, can be used for logging
       # and announcing what is about to happen
       def announce; end
@@ -144,6 +148,7 @@ module Sprinkle
           logger.debug "    --> Running #{self.class.name} for roles: #{roles}"
           @delivery.install(self, roles, :per_host => per_host?)
         end
+        post_process
       end
 
         # More complicated installers that have different stages, and require pre/post commands

data/lib/sprinkle/installers/pecl.rb

@@ -0,0 +1,82 @@
+module Sprinkle
+  module Installers
+    # = Pecl extension installed
+    #
+    # Installs the specified pecl extension
+    #
+    # == Example Usage
+    #
+    #   package :php_stuff do
+    #     pecl 'mongo'
+    #     verify { has_pecl 'mongo' }
+    #   end
+    #
+    # You can optionally pass a version number to both `pecl` and `has_pecl`:
+    #
+    #   package :php_stuff do
+    #     pecl 'mongo', :version => "1.4.3"
+    #     verify { has_pecl 'mongo', :version => "1.4.3" }
+    #   end
+    #
+    # Some extensions need an ini file. You can have that generated, by passing the `:ini_file` option:
+    #
+    #   package :php_stuff do
+    #     pecl 'mongo', :ini_file => true
+    #   end
+    #
+    # If you need more fine grained control of the location or contents of the ini file, use:
+    #
+    #   package :php_stuff do
+    #     pecl 'mongo', :ini_file => { :path => "/etc/php5/apache2/php.ini",
+    #                                  :content => "extension=mongo.so",
+    #                                  :sudo => true }
+    #   end
+    #
+    class Pecl < Installer
+      attr_accessor :package_name, :package_version
+
+      api do
+        def pecl(package_name, options = {}, &block)
+          install Pecl.new(self, package_name, options, &block)
+        end
+      end
+
+      verify_api do
+        def has_pecl(package_name, options = {})
+          @commands = "TERM= pecl list | grep '^#{package_name}\\\\s*" + (options[:version] ? options[:version].to_s : "") + "'"
+        end
+      end
+
+      def initialize(parent, package_name, options = {}, &block) #:nodoc:
+        super parent, &block
+        @package_name = package_name
+        @package_version = options[:version]
+        @ini_file = options[:ini_file]
+        setup_ini if @ini_file
+      end
+      
+      def setup_ini
+        @ini_file = to_ini_file_hash(@ini_file)
+        text = @ini_file[:content] || "extension=#{@package_name}.so"
+        path = @ini_file[:path] || "/etc/php5/conf.d/#{@package_name}.ini"
+        use_sudo = @ini_file[:sudo]===false ? false : true
+        post(:install) do
+          file(path, :content => text, :sudo => use_sudo)
+        end
+      end
+      
+      def to_ini_file_hash(s)
+        return {:content => s} if s.is_a? String
+        return {} if s===true
+        s
+      end
+
+      protected
+        def install_commands #:nodoc:
+          cmd = "TERM= pecl install --alldeps #{@package_name}"
+          cmd << "-#{@package_version}" if @package_version
+          cmd
+        end
+    end
+  end
+end

data/lib/sprinkle/installers/reconnect.rb

@@ -21,7 +21,7 @@ module Sprinkle
       # :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
+        Commands::Reconnect.new()
       end
 
     end

data/lib/sprinkle/installers/source.rb

@@ -103,7 +103,7 @@ module Sprinkle
 
       multi_attributes :enable, :disable, :with, :without, :option,
         :custom_install
-      attributes :configure_command, :build_command, :install_command, :custom_archive
+      attributes :configure_command, :build_command, :install_command, :custom_archive, :custom_dir
 
       def install_sequence #:nodoc:
         prepare + download + extract + configure + build + install

data/lib/sprinkle/installers/transfer.rb

@@ -1,3 +1,5 @@
+require 'tempfile'
+
 module Sprinkle
   module Installers
     # = File transfer installer
@@ -25,17 +27,34 @@ module Sprinkle
     # via this method. If you wish to disable recursive transfers, you can pass
     # :recursive => false, although it will not be obeyed when using the Vlad actor.
     #
+    # As an alternative to :recursive, you can use the :tarball option. When this is
+    # supplied, the source file(s) are first packed in a tar.gz archive, then
+    # transferred to a temp dir and finally unpacked at the destination. This is usually
+    # much faster when transferring many small files (Such as a typical rails application)
+    # You can optionally supply :exclude, which is an array of glob-patterns to not
+    # include in the tarball
+    #
+    #   package :webapp do
+    #     transfer 'app/', '/var/www/' do
+    #       tarball :exclude => %w(.git log/*)
+    #     end
+    #   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
     # and they will be run.
-    # 
+    #
     # == Rendering templates
     #
     # Rendering templates with transfer has been depreciated.  Please see the file
     # installer if you want to use templates.
     class Transfer < Installer
       attr_accessor :source, :destination, :sourcepath #:nodoc:
-      
+
+      # Include deprecated code
+      # Mainly, this makes it easier to see where to cut, when next major version comes along
+      DEPRECATED = true #:nodoc:
+
       api do
         def transfer(source, destination, options = {}, &block)
           options.reverse_merge!(:binding => binding())
@@ -43,92 +62,136 @@ module Sprinkle
         end
       end
 
-      def initialize(parent, source, destination, options={}, &block) #:nodoc:
-        @source = source
-        @destination = destination
-        @orig_destination = destination
-        super parent, options, &block
-        @binding = options[:binding]
-        if sudo? # perform the transfer in two steps if we're using sudo
-          final = @destination
-          @destination = "/tmp/sprinkle_#{File.basename(@destination)}"
-          # make sure we push the move ahead of any other post install tasks
-          # a user may have requested
-          post(:install).unshift ["#{sudo_cmd}mv #{@destination} #{final}"]
-        end
+      def initialize(parent, source, destination, options = {}, &block) #:nodoc:
+        options.reverse_merge! :recursive => true
+        
+        @source = source # Original source
+        @sourcepath = source # What the actor will transfer (may be the same as @source)
+        @final_destination = destination # Final destination
+        @destination = destination # Where the actor will place the file (May be same as @final_destination)
+        
         owner(options[:owner]) if options[:owner]
         mode(options[:mode]) if options[:mode]
+        tarball(options[:tarball]) if options[:tarball]
+        
+        super parent, options, &block
+        
+        if DEPRECATED
+          @binding = options[:binding]
+          options[:render] = true if source_is_template?
+          options[:recursive] = false if options[:render]
+          setup_rendering if options[:render]
+        end
+        setup_tarball if tarball?
+        setup_sudo if sudo?
+      end
 
-        options[:render]=true if source_is_template?
-        options[:recursive]=false if options[:render]
+      def tarball(options = {})
+        @tarball = true
+        @exclude = options===true ? [] : options[:exclude]
       end
-      
+
       def owner(owner)
         @owner = owner
-        post :install, "#{sudo_cmd}chown #{owner} #{@orig_destination}"
+        post(:install, "#{sudo_cmd}chown -R #{@owner} #{@final_destination}")
       end
-      
+
       def mode(mode)
         @mode = mode
-        post :install, "#{sudo_cmd}chmod #{mode} #{@orig_destination}"
+        post(:install, "#{sudo_cmd}chmod -R #{@mode} #{@final_destination}")
       end
 
-      def install_commands
-        :TRANSFER
+      def tarball?
+        @tarball
       end
 
-      def render_template(template, context, prefix)
-        require 'tempfile'
-
-        output = @package.template(template, context)
-
-        final_tempfile = Tempfile.new(prefix.to_s)
-        final_tempfile.print(output)
-        final_tempfile.close
-        final_tempfile
-      end
-
-      def render_template_file(path, context, prefix)
-        template = source_is_template? ? path : File.read(path)
-        tempfile = render_template(template, context, @package.name)
-        tempfile
-      end
-      
-      def source_is_template?
-        @source.split("\n").size>1
+      def install_commands
+        Commands::Transfer.new(sourcepath, destination,
+          :recursive => options[:recursive])
       end
 
-      def process(roles) #:nodoc:
-        logger.debug "transfer: #{@source} -> #{@destination} for roles: #{roles}\n"
+      if DEPRECATED
+        def render_template(template, context, prefix)
+          output = @package.template(template, context)
+          final_tempfile = Tempfile.new(prefix.to_s)
+          final_tempfile.print(output)
+          final_tempfile.close
+          final_tempfile
+        end
 
-        return if Sprinkle::OPTIONS[:testing]
+        def render_template_file(path, context, prefix)
+          template = source_is_template? ? path : File.read(path)
+          tempfile = render_template(template, context, @package.name)
+          tempfile
+        end
 
-        if options[:render]
+        def source_is_template?
+          @source.split("\n").size > 1
+        end
+        
+        def setup_rendering
           ActiveSupport::Deprecation.warn("transfer :render is depreciated, please use the `file` installer now.")
           ActiveSupport::Deprecation.warn("transfer :render will be removed from Sprinkle v0.8")
-          if options[:locals]
-            context = {}
-            options[:locals].each_pair do |k,v|
-              if v.respond_to?(:call)
-                context[k] = v.call
-              else
-                context[k] = v
+          if @options[:render]
+            raise "Incompatible combination of options :render and :tarball" if tarball?
+            if @options[:locals]
+              context = {}
+              @options[:locals].each_pair do |k,v|
+                if v.respond_to?(:call)
+                  context[k] = v.call
+                else
+                  context[k] = v
+                end
               end
+            else
+              context = @binding
             end
-          else
-            context = @binding
+
+            @tempfile = render_template_file(@source, context, @package.name).path
+            @sourcepath = @tempfile
+            @options[:recursive] = false
           end
+        end
+      end
+        
+      def setup_tarball
+        # tar files locally and scp to a temp location
+        # then untar after transfer
+        tar_options = @exclude.map {|glob| "--exclude \"#{glob}\" " }.join('')
+        @tempfile = make_tmpname
+        local_command = "cd '#{@source}' ; #{local_tar_bin} -zcf '#{@tempfile}' #{tar_options}."
+        logger.debug "    --> Compressing #{@source} locally"
+        raise "Unable to tar #{@source}" unless system(local_command)
+        @sourcepath = @tempfile
+        @destination = "/tmp/#{File.basename(@tempfile)}"
+        post(:install).unshift [
+          "#{sudo_cmd}tar -zxf '#{@destination}' -C '#{@final_destination}'",
+          "#{sudo_cmd}rm '#{@destination}'"
+        ]
+      end
+      
+      def setup_sudo
+        @destination = "/tmp/sprinkle_#{File.basename(@destination)}"
+        # make sure we push the move ahead of any other post install tasks
+        # a user may have requested
+        post(:install).unshift "#{sudo_cmd}mv #{@destination} #{@final_destination}"
+      end
 
-          tempfile = render_template_file(@source, context, @package.name)
-          @sourcepath = tempfile.path
-          @options[:recursive] = false
-        else
-          @sourcepath = @source
+      protected
+        def local_tar_bin
+          @local_tar_bin ||= (`uname` =~ /Darwin/ ? "COPYFILE_DISABLE=true /usr/bin/gnutar" : "tar")
+        end
+
+        def post_process
+          return unless @tempfile
+          logger.debug "    --> Deleting local temp file"
+          File.delete @tempfile
+        end
+
+        def make_tmpname
+          Dir::Tmpname.make_tmpname(['/tmp/sprinkle-', '.tar.gz'], nil)
         end
 
-        logger.debug "    --> Transferring #{sourcepath} to #{@orig_destination} for roles: #{roles}"
-        @delivery.install(self, roles, :recursive => @options[:recursive])
-      end
     end
   end
 end

data/lib/sprinkle/package.rb

@@ -317,7 +317,7 @@ module Sprinkle
         tree = []
         packages.each do |dep, config|
           package = PACKAGES.find_all(dep, config)
-          raise "Package definition not found for key: #{dep}" if package.empty? and opts[:required]
+          raise MissingPackageError.new(dep) if package.empty? and opts[:required]
           next if package.empty? # skip missing recommended packages as they're allowed to not exist
           package = Chooser.select_package(dep, package) #if package.size>1
           package = package.instance(config)

data/lib/sprinkle/package/rendering.rb

@@ -1,7 +1,9 @@
+require 'pp'
 require 'erubis'
 require 'digest/md5'
 
 module Sprinkle::Package
+  # For help on rendering, see the Sprinkle::Installers::FileInstaller.
   module Rendering
     extend ActiveSupport::Concern
 
@@ -9,19 +11,21 @@ module Sprinkle::Package
       self.send :include, Helpers
     end
 
+    # render src as ERB
     def template(src, context=binding)
       eruby = Erubis::Eruby.new(src)
       eruby.result(context)
     rescue Object => e
       raise Sprinkle::Errors::TemplateError.new(e, src, context)
     end
-    
+
+    # read in filename and render it as ERB
     def render(filename, context=binding)
       contents=File.read(expand_filename(filename))
       template(contents, context)
     end
-    
-    # Helper methods can be called from inside your package and 
+
+    # Helper methods can be called from inside your package and
     # verification code
     module Helpers
       # return the md5 of a string (as a hex string)
@@ -30,14 +34,49 @@ module Sprinkle::Package
       end
     end
     
-    private 
-    
+    # sets the path a package should use to search for templates
+    def template_search_path(path)
+      @template_search_path = path
+    end
+
+    private
+
+    def search_paths(n) #:nodoc:
+      # if we are given an absolute path, return just that path
+      return [File.dirname(n)] if n.starts_with? "/"
+      
+      pwd = Dir.pwd
+      package_dir = @template_search_path
+
+      p = []
+      # if ./ is used assume the path is relative to the package
+      if package_dir
+        p << File.expand_path(File.join(package_dir,"templates"))
+        p << File.expand_path(package_dir)
+      else
+        # otherwise search template folders relate to cwd
+        p << File.expand_path(File.join(pwd,"templates"))
+        p << File.expand_path(pwd)
+      end
+
+      p.uniq
+    end
+
     def expand_filename(n) #:nodoc:
-      return n.to_s if n.to_s.starts_with? "/"
-      ["./templates/#{n}","./templates/#{n}.erb"].each do |f|
+      name = File.basename(n)
+      paths = search_paths(n).map do |p|
+        [File.join(p,name), File.join(p,"#{name}.erb")]
+      end.flatten
+
+      paths.each do |f|
         return f if File.exist?(f)
       end
-      raise "template file not found"
+
+      puts "RESOLVED SEARCH PATHS"
+      pp paths
+
+      raise "template not found: #{n}"
+
     end
 
   end

data/lib/sprinkle/policy.rb

@@ -12,6 +12,16 @@ module Sprinkle
     end
   end
 
+  class MissingPackageError < StandardError #:nodoc:
+    def initialize(name)
+      @name = name
+    end
+
+    def to_s
+      "Package definition not found for key: #{@name}"
+    end
+  end
+
   # = Policies
   #
   # Policies define a set of packages which are required for a certain
@@ -93,7 +103,7 @@ module Sprinkle
 
         opts = args.clone.extract_options!
         package = Sprinkle::Package::PACKAGES.find_all(p, opts)
-        raise "Package definition not found for key: #{p}" unless package
+        raise MissingPackageError.new(p) unless package.any?
         package = Sprinkle::Package::Chooser.select_package(p, package) if package.is_a? Array # handle virtual package selection
         # get an instance of the package and pass our config options
         package = package.instance(*args)

data/lib/sprinkle/version.rb

@@ -1,3 +1,3 @@
 module Sprinkle
-  Version = "0.7.5"
+  Version = "0.7.6"
 end

data/spec/sprinkle/extensions/rendering_spec.rb

@@ -7,6 +7,33 @@ describe Sprinkle::Package::Rendering, 'rendering' do
     @package = package :something do
     end
   end
+  
+  describe "path expansion" do
+    
+    it "should know / is root" do
+      dirs = @package.send :search_paths, "/test/file"
+      dirs.should eq ["/test"]
+    end
+    
+    it "./ is local to where we tell it to be" do
+      Dir.stub(:pwd).and_return("/path/is/")
+      @package.template_search_path "/my/super/package/"
+      dirs = @package.send :search_paths, "./test/file"
+      dirs.should include("/my/super/package")
+      dirs.should include("/my/super/package/templates")
+      dirs.should_not include("/path/is")
+      dirs.should_not include("/path/is/templates")
+    end    
+    
+    it "should search pwd when amgiguous" do
+      Dir.stub(:pwd).and_return("/path/is/")
+      dirs = @package.send :search_paths, "test/file"
+      dirs.should include("/path/is")
+      dirs.should include("/path/is/templates")
+      dirs.size.should eq 2
+    end
+    
+  end
 
   it "should be able to calculate md5s" do
     @package.md5("test").should == "098f6bcd4621d373cade4e832627b4f6"

data/spec/sprinkle/installers/file_spec.rb

@@ -7,7 +7,6 @@ describe Sprinkle::Installers::FileInstaller do
     @package = double(Sprinkle::Package, :name => 'package', :sudo? => false)
     @empty = Proc.new { }
     @delivery = double(Sprinkle::Deployment, :install => true)
-    @source = 'source'
     @destination = 'destination'
     @contents = "hi"
     @installer = create_file_installer(@destination, :contents => @contents)
@@ -17,6 +16,12 @@ describe Sprinkle::Installers::FileInstaller do
       source do; prefix '/usr/bin'; end
     end
   end
+  
+  def simplify(seq)
+    seq.map do |cmd|
+      cmd.is_a?(Sprinkle::Commands::Transfer) ? :TRANSFER : cmd
+    end
+  end
 
   def create_file_installer(dest, options={}, &block)
     i = Sprinkle::Installers::FileInstaller.new(@package, dest, options, &block)
@@ -25,14 +30,41 @@ describe Sprinkle::Installers::FileInstaller do
   end
 
   describe 'when created' do
+    before do
+      @source = "/tmp/file"
+      Tempfile.any_instance.stub(:path).and_return(@source)
+      @installer = create_file_installer(@destination, :contents => @contents)
+      @transfer = @installer.install_sequence.detect {|x| x.is_a? Sprinkle::Commands::Transfer }
+    end
+    
     it 'should accept a source and destination to install' do
       @installer.contents.should eq @contents
       @installer.destination.should eq @destination
     end
+    
+    it 'should create a transfer command' do
+      @transfer.source.should eq @source
+      @transfer.destination.should eq @destination
+    end
+    
+    it 'should not be using recursive' do
+      @transfer.recursive?.should eq false
+    end
   end
 
   describe 'during installation' do
 
+    context "post process hooks" do
+
+      it "should remove its temporary file" do
+        @tmp = double(:print => true, :close => true, :path => "/file")
+        Tempfile.stub(:new).and_return(@tmp)
+        @installer = create_file_installer(@destination, :contents => @contents)
+        @tmp.should_receive(:unlink)
+      end
+
+    end
+
     context "setting mode and owner" do
       before do
         @installer = create_file_installer @destination, :content => @contents do
@@ -59,7 +91,7 @@ describe Sprinkle::Installers::FileInstaller do
           mode "744"
           owner "root"
         end
-        @installer_commands = @installer.install_sequence
+        @installer_commands = simplify @installer.install_sequence
       end
 
       it "should run commands in correct order" do
@@ -78,7 +110,7 @@ describe Sprinkle::Installers::FileInstaller do
           :mode => "744", :owner => "root" do
           @options[:sudo]= true
         end
-        @installer_commands = @installer.install_sequence
+        @installer_commands = simplify @installer.install_sequence
       end
 
       it "should run commands in correct order" do
@@ -99,7 +131,7 @@ describe Sprinkle::Installers::FileInstaller do
           pre :install, 'op1'
           post :install, 'op2'
         end
-        @installer_commands = @installer.install_sequence
+        @installer_commands = simplify @installer.install_sequence
         @delivery = @installer.delivery
       end
 
@@ -116,7 +148,7 @@ describe Sprinkle::Installers::FileInstaller do
           pre :install, 'op1'
           post :install, 'op2'
         end
-        @installer_commands = @installer.install_sequence
+        @installer_commands = simplify @installer.install_sequence
         @delivery = @installer.delivery
       end
 
@@ -132,7 +164,7 @@ describe Sprinkle::Installers::FileInstaller do
           pre :install, 'op1', 'op1-1'
           post :install, 'op2', 'op2-1'
         end
-        @installer_commands = @installer.install_sequence
+        @installer_commands = simplify @installer.install_sequence
         @delivery = @installer.delivery
       end
 

data/spec/sprinkle/installers/pecl_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path("../../spec_helper", File.dirname(__FILE__))
+
+describe Sprinkle::Installers::Pecl do
+  before do
+    # @package = double(Sprinkle::Package, :name => 'spec', :class => double(Sprinkle::Package, :installer_methods => []))
+    @package = Package.new("test") {}
+  end
+
+  describe 'providing just package name' do
+    before do
+      @installer = Sprinkle::Installers::Pecl.new(@package, 'spec')
+    end
+
+    describe 'during installation' do
+      it 'should invoke the pecl installer' do
+        @install_commands = @installer.send :install_commands
+        @install_commands.should == "TERM= pecl install --alldeps spec"
+      end
+    end
+  end
+
+  describe 'providing explicit version' do
+    before do
+      @installer = Sprinkle::Installers::Pecl.new(@package, 'spec', :version => '1.1.1')
+    end
+
+    describe 'during installation' do
+      it 'should invoke the pecl installer' do
+        @install_commands = @installer.send :install_commands
+        @install_commands.should == "TERM= pecl install --alldeps spec-1.1.1"
+      end
+    end
+  end
+
+  describe 'providing ini_file option' do
+    describe 'during installation' do
+      it 'should transfer file with default arguments in post install' do
+        @installer = Sprinkle::Installers::Pecl.new(@package, 'spec', :ini_file => true) do
+          self.stub(:file) do |path,options|
+            path.should == "/etc/php5/conf.d/spec.ini"
+            options[:content].should == "extension=spec.so"
+            options[:sudo].should == true
+            "post install file transfer"
+          end
+        end
+        @install_sequence = @installer.install_sequence
+        @install_sequence.should include("TERM= pecl install --alldeps spec")
+        @install_sequence.should include("post install file transfer")
+      end
+
+      it 'should use custom path and content if provided' do
+        @installer = Sprinkle::Installers::Pecl.new(@package, 'spec', :ini_file => {:path => "/custom/path", :content => "hello"}) do
+          self.stub(:file) do |path,options|
+            path.should == "/custom/path"
+            options[:content].should == "hello"
+          end
+        end
+      end
+
+      it 'should use custom content if string passed' do
+        @installer = Sprinkle::Installers::Pecl.new(@package, 'spec', :ini_file => "hello") do
+          self.stub(:file) do |path,options|
+            options[:content].should == "hello"
+          end
+        end
+      end
+
+      it 'should NOT use sudo if explicitly denied' do
+        @installer = Sprinkle::Installers::Pecl.new(@package, 'spec', :ini_file => {:sudo => false}) do
+          self.stub(:file) do |path,options|
+            options[:sudo].should == false
+          end
+        end
+      end
+    end
+  end
+
+end

data/spec/sprinkle/installers/source_spec.rb

@@ -201,6 +201,18 @@ describe Sprinkle::Installers::Source do
         @installer.send(:install_commands).first.should =~ /super-foo/
       end
 
+    end
+    describe 'with a custom dir definition' do
+      before do
+        @installer.options[:custom_dir] = 'super-foo'
+      end
+
+      it 'should install the source from the custom archive' do
+        @installer.send(:configure_commands).first.should =~ /super-foo/
+        @installer.send(:build_commands).first.should =~ /super-foo/
+        @installer.send(:install_commands).first.should =~ /super-foo/
+      end
+
     end
 
     describe 'with default configure, build, and install commands' do

data/spec/sprinkle/installers/transfer_spec.rb

@@ -7,7 +7,7 @@ describe Sprinkle::Installers::Transfer do
   before do
     @package = double(Sprinkle::Package, :name => 'package', :sudo? => false)
     @empty = Proc.new { }
-    @delivery = double(Sprinkle::Deployment, :install => true)
+    @delivery = double(Sprinkle::Deployment, :install => true, :sudo_command => "sudo", :sudo? => false)
     @source = 'source'
     @destination = 'destination'
     @installer = create_transfer(@source, @destination)
@@ -18,6 +18,12 @@ describe Sprinkle::Installers::Transfer do
     end
   end
 
+  def simplify(seq)
+    seq.map do |cmd|
+      cmd.is_a?(Sprinkle::Commands::Transfer) ? :TRANSFER : cmd
+    end
+  end
+
   def create_transfer(source, dest, options={}, &block)
     i = Sprinkle::Installers::Transfer.new(@package, source, dest, options, &block)
     i.delivery = @delivery
@@ -29,27 +35,39 @@ describe Sprinkle::Installers::Transfer do
       @installer.source.should eq @source
       @installer.destination.should eq @destination
     end
+
+    it 'should create a transfer command with destination and source' do
+      transfer = @installer.install_sequence.detect {|x| x.is_a? Sprinkle::Commands::Transfer }
+      transfer.source.should eq @source
+      transfer.destination.should eq @destination
+    end
+
+    it 'should default to recursive true' do
+      transfer = @installer.install_sequence.detect {|x| x.is_a? Sprinkle::Commands::Transfer }
+      transfer.recursive?.should eq true
+    end
   end
 
   describe 'during installation' do
 
     context "setting mode and owner" do
-      before do 
+      before do
         @installer = create_transfer @source, @destination do
           mode "744"
           owner "root"
         end
+        @installer.process @roles
         @installer_commands = @installer.install_sequence
       end
-      
+
       it "should include command to set owner" do
-        @installer_commands.should include("chmod 744 #{@destination}")
+        @installer_commands.should include("chmod -R 744 #{@destination}")
       end
-      
+
       it "should include command to set mode" do
-        @installer_commands.should include("chown root #{@destination}")
+        @installer_commands.should include("chown -R root #{@destination}")
       end
-      
+
     end
 
     context 'single pre/post commands' do
@@ -58,12 +76,12 @@ describe Sprinkle::Installers::Transfer do
           pre :install, 'op1'
           post :install, 'op2'
         end
-        @installer_commands = @installer.install_sequence
+        @installer_commands = simplify @installer.install_sequence
         @delivery = @installer.delivery
       end
 
       it "should call the pre and post install commands around the file transfer" do
-        @installer_commands.should eq ["op1",:TRANSFER, "op2"]
+        @installer_commands.should eq ["op1", :TRANSFER, "op2"]
       end
 
       # it "should call transfer with recursive defaulted to nil" do
@@ -72,21 +90,21 @@ describe Sprinkle::Installers::Transfer do
       # end
 
     end
-    
+
     context 'pre/post with sudo' do
       before do
-        @installer = create_transfer @source, @destination do
-          @options[:sudo]= true
+        @delivery = double(Sprinkle::Deployment, :install => true, :sudo_command => "sudo")
+        @installer = create_transfer @source, @destination, :sudo => true do
           pre :install, 'op1'
           post :install, 'op2'
         end
-        @installer_commands = @installer.install_sequence
+        @installer.process @roles
+        @installer_commands = simplify @installer.install_sequence
         @delivery = @installer.delivery
       end
 
       it "should call the pre and post install commands around the file transfer" do
-        @installer_commands.should eq ["op1",:TRANSFER, 
-          "sudo mv /tmp/sprinkle_destination destination", "op2"]
+        @installer_commands.should eq ["op1", :TRANSFER, "sudo mv /tmp/sprinkle_destination destination", "op2"]
       end
     end
 
@@ -96,7 +114,7 @@ describe Sprinkle::Installers::Transfer do
           pre :install, 'op1', 'op1-1'
           post :install, 'op2', 'op2-1'
         end
-        @installer_commands = @installer.install_sequence
+        @installer_commands = simplify @installer.install_sequence
         @delivery = @installer.delivery
       end
 
@@ -114,19 +132,19 @@ describe Sprinkle::Installers::Transfer do
   describe "if the :render flag is true" do
     before do
       allow(::ActiveSupport::Deprecation).to receive(:warn)
-      @installer = create_transfer @source, @destination, :render => true
-      @delivery = @installer.delivery
-      @delivery.stub(:render_template_file)
       @tempfile = Tempfile.new("foo")
+      Sprinkle::Installers::Transfer.any_instance.
+        should_receive(:render_template_file).
+        with(@source, anything, @package.name).
+        and_return(@tempfile)
+      @installer = create_transfer @source, @destination, :render => true
     end
 
     it "should render the source file as a template to a tempfile" do
-      @installer.should_receive(:render_template_file).with(@source, anything, @package.name).and_return(@tempfile)
       @delivery.stub(:transfer)
     end
 
     it "should call transfer with recursive set to false" do
-      @installer.should_receive(:render_template_file).with(@source, anything, @package.name).and_return(@tempfile)
       @installer.options[:recursive].should eq false
     end
 
@@ -140,13 +158,45 @@ describe Sprinkle::Installers::Transfer do
       @installer = create_transfer @source, @destination, :recursive => false
     end
 
-    it "should call transfer with recursive set to false" do
-      @installer.delivery
-      @installer.options[:recursive].should eq false
+    it "should created transfer command with recursive set to false" do
+      transfer = @installer.install_sequence.detect {|x| x.is_a? Sprinkle::Commands::Transfer }
+      transfer.recursive?.should eq false
     end
+  end
 
-    after do
+  describe "if the :tarball option is set" do
+    it "should tar locally, then transfer and extract, finally deleting local tempfile" do
+      @installer = create_transfer @source, @destination, :tarball => true do
+        self.stub(:local_tar_bin) { "tar" }
+        self.stub(:make_tmpname) { "/tmp/foo.tar.gz" }
+        self.should_receive(:system) do |command|
+          command.should == "cd 'source' ; tar -zcf '/tmp/foo.tar.gz' ."
+          true
+        end
+        File.should_receive(:delete) do |path|
+          path.should == "/tmp/foo.tar.gz"
+        end
+      end
       @installer.process @roles
+      install_sequence = @installer.install_sequence
+      install_sequence.should include("tar -zxf '/tmp/foo.tar.gz' -C 'destination'")
+      install_sequence.should include("rm '/tmp/foo.tar.gz'")
+    end
+
+    describe "and the :exclude option is provided" do
+      it "should pass --exclude option to local tar command" do
+        @installer = create_transfer @source, @destination, :tarball => {:exclude => %w(.git log/*)} do
+          self.stub(:local_tar_bin) { "tar" }
+          self.stub(:make_tmpname) { "/tmp/foo.tar.gz" }
+          self.should_receive(:system) do |command|
+            command.should == "cd 'source' ; tar -zcf '/tmp/foo.tar.gz' --exclude \".git\" --exclude \"log/*\" ."
+            true
+          end
+        end
+      end
     end
+
   end
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprinkle
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -189,6 +189,9 @@ files:
 - lib/sprinkle/actors/ssh.rb
 - lib/sprinkle/actors/ssh/connection_cache.rb
 - lib/sprinkle/actors/vlad.rb
+- lib/sprinkle/commands/command.rb
+- lib/sprinkle/commands/reconnect.rb
+- lib/sprinkle/commands/transfer.rb
 - lib/sprinkle/core.rb
 - lib/sprinkle/deployment.rb
 - lib/sprinkle/errors/pretty_failure.rb
@@ -220,6 +223,7 @@ files:
 - lib/sprinkle/installers/package_installer.rb
 - lib/sprinkle/installers/pacman.rb
 - lib/sprinkle/installers/pear.rb
+- lib/sprinkle/installers/pecl.rb
 - lib/sprinkle/installers/push_text.rb
 - lib/sprinkle/installers/rake.rb
 - lib/sprinkle/installers/reconnect.rb
@@ -276,6 +280,7 @@ files:
 - spec/sprinkle/installers/openbsd_pkg_spec.rb
 - spec/sprinkle/installers/opensolaris_pkg_spec.rb
 - spec/sprinkle/installers/pear_spec.rb
+- spec/sprinkle/installers/pecl_spec.rb
 - spec/sprinkle/installers/push_text_spec.rb
 - spec/sprinkle/installers/rake_spec.rb
 - spec/sprinkle/installers/replace_text_spec.rb
@@ -348,6 +353,7 @@ test_files:
 - spec/sprinkle/installers/openbsd_pkg_spec.rb
 - spec/sprinkle/installers/opensolaris_pkg_spec.rb
 - spec/sprinkle/installers/pear_spec.rb
+- spec/sprinkle/installers/pecl_spec.rb
 - spec/sprinkle/installers/push_text_spec.rb
 - spec/sprinkle/installers/rake_spec.rb
 - spec/sprinkle/installers/replace_text_spec.rb