base.rb in omnibus-3.1.0

- old
+ new

@@ -1,8 +1,7 @@
 #
-# Copyright:: Copyright (c) 2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2014 Chef Software, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
@@ -15,11 +14,11 @@
 # limitations under the License.
 #
 
 require 'fileutils'
 require 'forwardable'
-require 'omnibus/util'
+require 'erb'
 
 module Omnibus
   class Packager::Base
     include Util
 
@@ -30,10 +29,18 @@
 
     # !@method name
     #   @return (see Project#name)
     def_delegator :@project, :name
 
+    # !@method friendly_name
+    #   @return (see Project#friendly_name)
+    def_delegator :@project, :friendly_name
+
+    # !@method maintainer
+    #   @return (see Project#maintainer)
+    def_delegator :@project, :maintainer
+
     # !@method version
     #   @return (see Project#build_version)
     def_delegator :@project, :build_version, :version
 
     # !@method iteration
@@ -81,11 +88,11 @@
     # The commands/steps to build the package.
     def self.build(&block)
       if block_given?
         @build = block
       else
-        @build || fail(AbstractMethod.new("#{self.class.name}.build"))
+        @build || raise(AbstractMethod.new("#{self.class.name}.build"))
       end
     end
 
     # The commands/steps to cleanup any temporary files/directories.
     def self.clean(&block)
@@ -144,48 +151,78 @@
     # @param [String] pah
     def remove_file(path)
       FileUtils.rm_f(path)
     end
 
+    # Copy the +source+ directory to the +destination+.
+    #
+    # @param [String] source
+    # @param [String] destination
+    def copy_directory(source, destination)
+      FileUtils.cp_r(Dir["#{source}/*"], destination)
+    end
+
     # Execute the command using shellout!
     #
     # @param [String] command
-    def execute(command)
-      shellout!(command,  timeout: 3600, cwd: staging_dir)
+    def execute(command, options = {})
+      options.merge! timeout: 3600, cwd: staging_dir
+      shellout!(command,  options)
     end
 
+    # Render an erb template at +source_path+ to +destination_path+ if
+    # given. Otherwise template is rendered next to +source_path+
+    # by removing the 'erb' extension of the template
     #
+    # @param [String] source_path
+    # @param [String] destination_path
+    def render_template(source_path, destination_path = nil)
+      return unless source_path.end_with?('.erb')
+
+      destination_path = source_path.chomp('.erb') if destination_path.nil?
+
+      File.open(source_path) do |file|
+        erb = ERB.new(file.read)
+        File.open(destination_path, 'w') do |out|
+          out.write(erb.result(binding))
+        end
+
+        remove_file(source_path)
+      end
+    end
+
+    #
     # Validations
     # ------------------------------
 
     # Validate the presence of a file.
     #
     # @param [String] path
     def assert_presence!(path)
-      fail MissingAsset.new(path) unless File.exist?(path)
+      raise MissingAsset.new(path) unless File.exist?(path)
     end
 
     # Execute this packager by running the following phases in order:
     #
     #   - setup
     #   - validate
     #   - build
     #   - clean
     #
     def run!
-      instance_eval(&self.class.validate) if self.class.validate
       instance_eval(&self.class.setup)    if self.class.setup
+      instance_eval(&self.class.validate) if self.class.validate
       instance_eval(&self.class.build)    if self.class.build
       instance_eval(&self.class.clean)    if self.class.clean
     end
 
     # The ending name of this package on disk. +Omnibus::Project+ uses this to
     # generate metadata about the package after it is built.
     #
     # @return [String]
     def package_name
-      fail AbstractMethod.new("#{self.class.name}#package_name")
+      raise AbstractMethod.new("#{self.class.name}#package_name")
     end
 
     private
 
     # The path to the directory where we can throw staged files.
@@ -193,23 +230,39 @@
     # @return [String]
     def staging_dir
       File.expand_path("#{project.package_tmp}/#{underscore_name}")
     end
 
-    # The path to a local resource on disk.
+    # The path to the directory where the packager resources are
+    # copied into from source.
     #
+    # @return [String]
+    def staging_resources_path
+      File.expand_path("#{staging_dir}/Resources")
+    end
+
+    # The path to a resource in staging directory.
+    #
     # @param [String]
     #   the name or path of the resource
     # @return [String]
     def resource(path)
-      File.expand_path("#{resources_path}/#{path}")
+      File.expand_path(File.join(staging_resources_path, path))
     end
 
-    # The path to all the resources on the local file system.
+    # The path to all the resources on the packager source.
+    # Uses `resources_path` if specified in the project otherwise
+    # uses the project root set in global config.
     #
     # @return [String]
     def resources_path
-      File.expand_path("#{project.files_path}/#{underscore_name}/Resources")
+      base_path = if project.resources_path
+                    project.resources_path
+                  else
+                    files_path
+                  end
+
+      File.expand_path(File.join(base_path, underscore_name, 'Resources'))
     end
 
     # The underscored equivalent of this class. This is mostly used by file
     # paths.
     #