bozo 0.3.3 → 0.3.4

data/lib/bozo/executor.rb

@@ -1,282 +1,289 @@
-module Bozo
-  
-  # Class defining the structure of the build and responsible for executing
-  # tasks and their dependencies.
-  class Executor
-    include Runner
-    
-    # Create a new instance.
-    #
-    # @param [Configuration] build_configuration
-    #     The build configuration.
-    # @param [Hash] global_params
-    #     The global parameters
-    def initialize(build_configuration, global_params)
-      @build_configuration = build_configuration
-      @global_params = cli_keys_to_ruby global_params
-    end
-    
-    # Executes the command using the given parameters and environment.
-    #
-    # @param [Symbol] command
-    #     The name of the command to execute.
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def execute(command, params, env)
-      with_hooks :build, params, env do
-        send command, params, env
-      end
-    end
-
-    # Runs the clean task.
-    #
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def clean(params, env)
-      with_hooks :clean, params, env do
-        log_info 'Cleaning project'
-        clear_directory 'temp'
-        clear_directory 'dist'
-      end
-    end
-    
-    # Runs the uninstall task.
-    #
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def uninstall(params, env)
-      clean params, env
-      with_hooks :uninstall, params, env do
-        log_info 'Uninstalling project'
-        clear_directory 'packages'
-        clear_directory 'build'
-      end
-    end
-
-    # Runs the dependency retrieval task.
-    #
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def dependencies(params, env)
-      clean params, env
-      retrieve_build_dependencies
-      execute_with_hooks :dependencies, params, env
-    end
-
-    # Runs the prepare task.
-    #
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def prepare(params, env)
-      dependencies params, env
-      execute_with_hooks :prepare, params, env
-    end
-
-    # Runs the compile task.
-    #
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def compile(params, env)
-      prepare params, env
-      execute_with_hooks :compile, params, env
-    end
-
-    # Runs the test task.
-    #
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def test(params, env)
-      compile params, env
-      execute_with_hooks :test, params, env
-    end
-
-    # Runs the package task.
-    #
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def package(params, env)
-      test params, env
-      execute_with_hooks :package, params, env
-    end
-
-    # Runs the publish task.
-    #
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def publish(params, env)
-      if build_server?
-        package params, env
-        execute_with_hooks :publish, params, env
-      else
-        log_warn 'You can only publish a package from build server.'
-        log_warn ''
-        log_warn 'If you really need to publish the package then provide the --build-server switch but you should only be doing that as a last resort.'
-      end
-    end
-    
-    private
-
-    # Executes the executors for the given stage logging all messages with the
-    # given action.
-    #
-    # @param [Symbol] stage
-    #     The name of the stage to execute.
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def execute_with_hooks(stage, params, env)
-      action, executors = stage_definition stage
-      with_hooks stage, params, env do
-        log_info '' # blank line for aesthetics
-        log_info action
-        log_debug 'No executors' if executors.empty?
-        executors.each do |executor|
-          log_debug "#{action} with #{executor.class}"
-          set_parameters executor, params, env
-          executor.execute
-        end
-      end
-    end
-    
-    # Gets the description and runners associated with the given stage.
-    #
-    # @params [Symbol] stage
-    #     The name of the stage.
-    def stage_definition(stage)
-      case stage
-      when :dependencies
-        return 'Resolving dependencies', @build_configuration.dependency_resolvers
-      when :compile
-        return 'Compiling', @build_configuration.compilers
-      when :test
-        return 'Running tests', @build_configuration.test_runners
-      when :package
-        return 'Packaging', @build_configuration.packagers
-      when :prepare
-        return 'Preparing', @build_configuration.preparers
-      when :publish
-        return 'Publishing', @build_configuration.publishers
-      else
-        raise "Unrecognized stage: #{stage}"
-      end
-    end
-
-    # Runs the given code block surrounding it with the hooks for the named
-    # stage.
-    #
-    # @param [Symbol] stage
-    #     The name of the stage being run.
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def with_hooks(stage, params, env)
-      call_receiving_hooks "pre_#{stage}".to_sym, params, env
-      yield
-      call_receiving_hooks "post_#{stage}".to_sym, params, env
-    end
-    
-    # Invokes the method for the hook for all hook objects that define a 
-    # method for it.
-    #
-    # @param [Symbol] stage
-    #     The name of the hook to call the methods for.
-    # @param [Hash] params
-    #     The parameters for the command.
-    # @param [Hash] env
-    #     The environment that the command is run within.
-    def call_receiving_hooks(stage, params, env)
-      @build_configuration.hooks.each do |hook|
-        if hook.respond_to? stage
-          set_parameters hook, params, env
-          hook.send stage
-        end
-      end
-    end
-    
-    # Assigns the state of the build system to the runner.
-    #
-    # @param [Runner] runner
-    #     The runner to assign the state to.
-    # @param [Hash] params
-    #     The parameters for the step.
-    # @param [Hash] env
-    #     The environment that the step is run within.
-    def set_parameters(runner, params, env)
-      runner.build_configuration = @build_configuration
-      runner.global_params = @global_params
-      runner.params = cli_keys_to_ruby params
-      runner.env = env
-    end
-
-    # Removes the named directory from the root directory.
-    #
-    # @param [String] dir
-    #     The name of the directory to remove.
-    def clear_directory(dir)
-      full_path = File.expand_path(dir)
-      log_debug "Clearing directory #{full_path}"
-      FileUtils.rm_rf full_path
-    end
-
-    # Retrieves the required build tools from the configured build tools
-    # location.
-    def retrieve_build_dependencies
-      tools_location = @build_configuration.build_tools_location
-      required_tools = @build_configuration.build_tools
-      tools_path = File.expand_path(File.join('build', 'tools'))
-
-      log_info 'Retrieving build tools'
-
-      required_tools.each do |tool|
-        tool_name = tool.to_s
-        tool_path = File.join(tools_location, tool_name)
-        tool_destination = File.join(tools_path, tool_name)
-
-        if File.exist? tool_destination
-          log_debug "#{tool_name.capitalize} already present"
-        else
-          log_debug "Retrieving #{tool_name.capitalize}"
-          FileUtils.mkdir_p tool_destination
-          FileUtils.cp_r tool_path, tools_path
-          log_debug "#{tool_name.capitalize} retrieved"
-        end
-      end
-    end
-    
-    # Converts a hash containing CLI-style keys (:'multi-word') and converts 
-    # them into Ruby-style symbols (:multi_word).
-    #
-    # @param [Hash] hash
-    #     A hash containing CLI-style keys.
-    def cli_keys_to_ruby(hash)
-      hash.keys.to_a.each do |key|
-        new_key = key.to_s.gsub('-', '_').to_sym
-        hash[new_key] = hash[key] unless hash.has_key? new_key
-      end
-
-      hash
-    end
-    
-  end
-  
+module Bozo
+  
+  # Class defining the structure of the build and responsible for executing
+  # tasks and their dependencies.
+  class Executor
+    include Runner
+    
+    # Create a new instance.
+    #
+    # @param [Configuration] build_configuration
+    #     The build configuration.
+    # @param [Hash] global_params
+    #     The global parameters
+    def initialize(build_configuration, global_params)
+      @build_configuration = build_configuration
+      @global_params = cli_keys_to_ruby global_params
+    end
+    
+    # Executes the command using the given parameters and environment.
+    #
+    # @param [Symbol] command
+    #     The name of the command to execute.
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def execute(command, params, env)
+      with_hooks :build, params, env do
+        send command, params, env
+      end
+    end
+
+    # Runs the clean task.
+    #
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def clean(params, env)
+      with_hooks :clean, params, env do
+        log_info 'Cleaning project'
+        clear_directory 'temp'
+        clear_directory 'dist'
+      end
+    end
+    
+    # Runs the uninstall task.
+    #
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def uninstall(params, env)
+      clean params, env
+      with_hooks :uninstall, params, env do
+        log_info 'Uninstalling project'
+        clear_directory 'packages'
+        clear_directory 'build'
+      end
+    end
+
+    # Runs the dependency retrieval task.
+    #
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def dependencies(params, env)
+      clean params, env
+      retrieve_build_dependencies
+      execute_with_hooks :dependencies, params, env
+    end
+
+    # Runs the prepare task.
+    #
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def prepare(params, env)
+      dependencies params, env
+      execute_with_hooks :prepare, params, env
+    end
+
+    # Runs the compile task.
+    #
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def compile(params, env)
+      prepare params, env
+      execute_with_hooks :compile, params, env
+    end
+
+    # Runs the test task.
+    #
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def test(params, env)
+      compile params, env
+      execute_with_hooks :test, params, env
+    end
+
+    # Runs the package task.
+    #
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def package(params, env)
+      test params, env
+      execute_with_hooks :package, params, env
+    end
+
+    # Runs the publish task.
+    #
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def publish(params, env)
+      if build_server?
+        package params, env
+        execute_with_hooks :publish, params, env
+      else
+        log_warn 'You can only publish a package from build server.'
+        log_warn ''
+        log_warn 'If you really need to publish the package then provide the --build-server switch but you should only be doing that as a last resort.'
+      end
+    end
+    
+    private
+
+    # Executes the executors for the given stage logging all messages with the
+    # given action.
+    #
+    # @param [Symbol] stage
+    #     The name of the stage to execute.
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def execute_with_hooks(stage, params, env)
+      action, executors = stage_definition stage
+      with_hooks stage, params, env do
+        log_info '' # blank line for aesthetics
+        log_info action
+        log_debug 'No executors' if executors.empty?
+        executors.each do |executor|
+          log_debug "#{action} with #{executor.class}"
+          set_parameters executor, params, env
+          executor.execute
+        end
+      end
+    end
+    
+    # Gets the description and runners associated with the given stage.
+    #
+    # @params [Symbol] stage
+    #     The name of the stage.
+    def stage_definition(stage)
+      case stage
+      when :dependencies
+        return 'Resolving dependencies', @build_configuration.dependency_resolvers
+      when :compile
+        return 'Compiling', @build_configuration.compilers
+      when :test
+        return 'Running tests', @build_configuration.test_runners
+      when :package
+        return 'Packaging', @build_configuration.packagers
+      when :prepare
+        return 'Preparing', @build_configuration.preparers
+      when :publish
+        return 'Publishing', @build_configuration.publishers
+      else
+        raise "Unrecognized stage: #{stage}"
+      end
+    end
+
+    # Runs the given code block surrounding it with the hooks for the named
+    # stage.
+    #
+    # @param [Symbol] stage
+    #     The name of the stage being run.
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def with_hooks(stage, params, env)
+      call_receiving_hooks "pre_#{stage}".to_sym, params, env
+
+      begin
+        yield
+      rescue
+        call_receiving_hooks "failed_#{stage}".to_sym, params, env
+        raise
+      end
+
+      call_receiving_hooks "post_#{stage}".to_sym, params, env
+    end
+    
+    # Invokes the method for the hook for all hook objects that define a 
+    # method for it.
+    #
+    # @param [Symbol] stage
+    #     The name of the hook to call the methods for.
+    # @param [Hash] params
+    #     The parameters for the command.
+    # @param [Hash] env
+    #     The environment that the command is run within.
+    def call_receiving_hooks(stage, params, env)
+      @build_configuration.hooks.each do |hook|
+        if hook.respond_to? stage
+          set_parameters hook, params, env
+          hook.send stage
+        end
+      end
+    end
+    
+    # Assigns the state of the build system to the runner.
+    #
+    # @param [Runner] runner
+    #     The runner to assign the state to.
+    # @param [Hash] params
+    #     The parameters for the step.
+    # @param [Hash] env
+    #     The environment that the step is run within.
+    def set_parameters(runner, params, env)
+      runner.build_configuration = @build_configuration
+      runner.global_params = @global_params
+      runner.params = cli_keys_to_ruby params
+      runner.env = env
+    end
+
+    # Removes the named directory from the root directory.
+    #
+    # @param [String] dir
+    #     The name of the directory to remove.
+    def clear_directory(dir)
+      full_path = File.expand_path(dir)
+      log_debug "Clearing directory #{full_path}"
+      FileUtils.rm_rf full_path
+    end
+
+    # Retrieves the required build tools from the configured build tools
+    # location.
+    def retrieve_build_dependencies
+      tools_location = @build_configuration.build_tools_location
+      required_tools = @build_configuration.build_tools
+      tools_path = File.expand_path(File.join('build', 'tools'))
+
+      log_info 'Retrieving build tools'
+
+      required_tools.each do |tool|
+        tool_name = tool.to_s
+        tool_path = File.join(tools_location, tool_name)
+        tool_destination = File.join(tools_path, tool_name)
+
+        if File.exist? tool_destination
+          log_debug "#{tool_name.capitalize} already present"
+        else
+          log_debug "Retrieving #{tool_name.capitalize}"
+          FileUtils.mkdir_p tool_destination
+          FileUtils.cp_r tool_path, tools_path
+          log_debug "#{tool_name.capitalize} retrieved"
+        end
+      end
+    end
+    
+    # Converts a hash containing CLI-style keys (:'multi-word') and converts 
+    # them into Ruby-style symbols (:multi_word).
+    #
+    # @param [Hash] hash
+    #     A hash containing CLI-style keys.
+    def cli_keys_to_ruby(hash)
+      hash.keys.to_a.each do |key|
+        new_key = key.to_s.gsub('-', '_').to_sym
+        hash[new_key] = hash[key] unless hash.has_key? new_key
+      end
+
+      hash
+    end
+    
+  end
+  
 end

data/lib/bozo/logging.rb

@@ -1,40 +1,40 @@
-module Bozo
-
-  # Module that provides functionality for logging.
-  module Logging
-
-    # Records a `debug` log message.
-    #
-    # @param [String] msg
-    #   The message to log.
-    def log_debug(msg)
-      puts "  #{msg.bright.color(:black)}"
-    end
-
-    # Records a `fatal` log message.
-    #
-    # @param [String] msg
-    #   The message to log.
-    def log_fatal(msg)
-      puts msg.color(:red).bright
-    end
-
-    # Records an `info` log message.
-    #
-    # @param [String] msg
-    #   The message to log.
-    def log_info(msg)
-      puts msg.color(:cyan).bright
-    end
-
-    # Records a `warn` log message.
-    #
-    # @param [String] msg
-    #   The message to log.
-    def log_warn(msg)
-      puts msg.color(:yellow).bright
-    end
-
-  end
-
-end
+module Bozo
+
+  # Module that provides functionality for logging.
+  module Logging
+
+    # Records a `debug` log message.
+    #
+    # @param [String] msg
+    #   The message to log.
+    def log_debug(msg)
+      puts "  #{msg.bright.color(:black)}"
+    end
+
+    # Records a `fatal` log message.
+    #
+    # @param [String] msg
+    #   The message to log.
+    def log_fatal(msg)
+      puts msg.color(:red).bright
+    end
+
+    # Records an `info` log message.
+    #
+    # @param [String] msg
+    #   The message to log.
+    def log_info(msg)
+      puts msg.color(:cyan).bright
+    end
+
+    # Records a `warn` log message.
+    #
+    # @param [String] msg
+    #   The message to log.
+    def log_warn(msg)
+      puts msg.color(:yellow).bright
+    end
+
+  end
+
+end