sprinkle-tool/sprinkle

View on GitHub
lib/sprinkle/installers/replace_text.rb

Summary

Maintainability
A
1 hr
Test Coverage
module Sprinkle
  module Installers
    # = Replace text installer
    #
    # This installer replaces a text with another one in a file.
    # 
    # == Example Usage
    #
    # Change ssh port in /etc/ssh/sshd_config
    #
    #   package :magic_beans do
    #     replace_text 'Port 22', 'Port 2500', '/etc/ssh/sshd_config'
    #   end
    #
    # If you user has access to 'sudo' and theres a file that requires
    # privileges, you can pass :sudo => true 
    #
    #   package :magic_beans do
    #     replace_text 'Port 22', 'Port 2500', '/etc/ssh/sshd_config', :sudo => true
    #   end
    #
    # A special verify step exists for this very installer
    # its known as file_contains, it will test that a file indeed
    # contains a substring that you send it.
    #
    class ReplaceText < Installer
      attr_accessor :regex, :text, :path #:nodoc:
      
      api do
        def replace_text(regex, text, path, options={}, &block)
          install ReplaceText.new(self, regex, text, path, options, &block)
        end
      end

      def initialize(parent, regex, text, path, options={}, &block) #:nodoc:
        super parent, options, &block
        @regex = regex
        @text = text
        @path = path
      end
      
      def announce
        log "--> Replace '#{@regex}' with '#{@text}' in file #{@path}"
      end

      protected
      
        def escape_sed_arg(s)
          escape_shell_arg(s).gsub("/", "\\\\/").gsub('&', '\\\&')
        end
      
        def install_commands #:nodoc:
          "#{sudo_cmd}sed -i 's/#{escape_sed_arg(@regex)}/#{escape_sed_arg(@text)}/g' #{@path}"
        end

    end
  end
end