bozo 0.3.3 → 0.3.4

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/bin/bozo

@@ -1,9 +1,9 @@
-#!/usr/bin/env ruby
-$:.push File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
-
-require "bundler/setup"
-require "rainbow"
-require "bozo"
-
-# Invoke the command
+#!/usr/bin/env ruby
+$:.push File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require "bundler/setup"
+require "rainbow"
+require "bozo"
+
+# Invoke the command
 exit GLI.run(ARGV)

data/lib/bozo/bozo.rb

@@ -1,7 +1,7 @@
-# The top level module for Bozo's functionality.
-module Bozo
-  
-  # The version of Bozo in use.
-  VERSION = File.read(File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../../VERSION')).strip
-
+# The top level module for Bozo's functionality.
+module Bozo
+  
+  # The version of Bozo in use.
+  VERSION = File.read(File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../../VERSION')).strip
+
 end

data/lib/bozo/bozo_configuration.rb

@@ -1,300 +1,300 @@
-module Bozo
-
-  # Class used for defining the configuration of a build.
-  class BozoConfiguration
-
-    include Bozo::ClassNameHelpers
-    
-    # Creates a new instance
-    def initialize
-      @build_tools_location = nil
-      @compilers = []
-      @dependency_resolvers = []
-      @hooks = []
-      @packagers = []
-      @preparers = []
-      @publishers = []
-      @test_runners = []
-      @version = nil
-    end
-    
-    # Loads the configuration from the specified file.
-    # 
-    # @param [String] path
-    #     The path to the configuration file.    
-    def load(path)
-      instance_eval IO.read(path), path
-    end
-
-    # The version of the project to build.
-    def version
-      @version ||= Versioning::Version.load_from_file
-    end
-
-    # The location of the base build tools.
-    #
-    # Sets and returns the location if a value is provided, otherwise returns
-    # the current value.
-    #
-    # It is expected the build tools will be in sub-directory of this location
-    # according to the name of the tool and that the runner will be able to
-    # copy the contents of the sub-directory to a local directory via the
-    # `FileUtils.cp_r` method.
-    #
-    # @param [String] location
-    #     The path to set as the build tools location.
-    def build_tools_location(location = nil)
-      @build_tools_location = location if location
-      @build_tools_location
-    end
-
-    # Returns the all the build tools required by the specified compilers,
-    # dependency resolvers, hooks, packagers, publishers and test runners.
-    def build_tools
-      build_tools = get_build_tools @compilers
-      build_tools |= get_build_tools @dependency_resolvers
-      build_tools |= get_build_tools @hooks
-      build_tools |= get_build_tools @packagers
-      build_tools |= get_build_tools @preparers
-      build_tools |= get_build_tools @publishers
-      build_tools | (get_build_tools @test_runners)
-    end
-
-    # Returns the configured dependency resolvers.
-    attr_reader :dependency_resolvers
-
-    # Adds an instance of the named preparer to the preparer collection and
-    # yields it to the configuration block when one is specified.
-    #
-    # @param [Symbol] type
-    #     The name of the preparer.
-    # @param [Proc] block
-    #     Optional block to refine the configuration of the preparer.
-    def prepare(type, &block) # :yields: preparer
-      add_instance @preparers, Bozo::Preparers, type, block
-    end
-
-    # Returns the configured preparers.
-    attr_reader :preparers
-
-    # Adds an instance of the named dependency resolver to the dependency
-    # resolver collection and yields it to the configuration block when one
-    # is specified.
-    #
-    # @param [Symbol] type
-    #     The name of the dependency resolver.
-    # @param [Proc] block
-    #     Optional block to refine the configuration of the dependency
-    #     resolver.
-    def resolve_dependencies_with(type, &block) # :yields: dependency_resolver
-      add_instance @dependency_resolvers, Bozo::DependencyResolvers, type, block
-    end
-
-    # Returns the configured compilers.
-    attr_reader :compilers
-
-    # Adds an instance of the named compiler to the compiler collection and
-    # yields it to the configuration block when one is specified.
-    #
-    # @param [Symbol] type
-    #     The name of the compiler.
-    # @param [Proc] block
-    #     Optional block to refine the configuration of the compiler.
-    def compile_with(type, &block) # :yields: compiler
-      add_instance @compilers, Bozo::Compilers, type, block
-    end
-
-    # Returns the configured test runners.
-    attr_reader :test_runners
-
-    # Adds an instance of the named test runner to the test runner collection
-    # and yields it to the configuration block when one is specified.
-    #
-    # @param [Symbol] type
-    #     The name of the test runner.
-    # @param [Proc] block
-    #     Optional block to refine the configuration of the test runner.
-    def test_with(type, &block) # :yields: test_runner
-      add_instance @test_runners, Bozo::TestRunners, type, block
-    end
-
-    # Returns the configured packagers.
-    attr_reader :packagers
-
-    # Adds an instance of the named packager to the packager collection and
-    # yields it to the configuration block when one is specified.
-    #
-    # @param [Symbol] type
-    #     The name of the packager.
-    # @param [Proc] block
-    #     Optional block to refine the configuration of the packager.
-    def package_with(type, &block) # :yields: packager
-      add_instance @packagers, Bozo::Packagers, type, block
-    end
-
-    # Returns the configured publishers.
-    attr_reader :publishers
-
-    # Adds an instance of the named publisher to the publisher collection and
-    # yields it to the configuration block when one is specified.
-    #
-    # @param [Symbol] type
-    #     The name of the publisher.
-    # @param [Proc] block
-    #     Optional block to refine the configuration of the publisher.
-    def publish_with(type, &block) # :yields: publisher
-      add_instance @publishers, Bozo::Publishers, type, block
-    end
-
-    # Returns the configured hooks.
-    attr_reader :hooks
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    #
-    # @param [Symbol] type
-    #     The name of the hook.
-    # @param [Proc] block
-    #     Optional block to refine the configuration of the hook.
-    def with_hook(type, &block) # :yields: hook
-      add_instance @hooks, Bozo::Hooks, type, block
-    end
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :pre_build :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :pre_clean :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :post_clean :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :pre_uninstall :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :post_uninstall :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :pre_dependencies :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :post_dependencies :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :pre_prepare :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :post_prepare :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :pre_compile :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :post_compile :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :pre_test :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :post_test :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :pre_package :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :post_package :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :pre_publish :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :post_publish :with_hook
-
-    # Adds an instance of the named hook to the hook collection and yields it
-    # to the configuration block when one is specified.
-    alias :post_build :with_hook
-    
-    private
-
-    # Resolves the named class within the given namespace and then created an
-    # instance of the class before adding it to the given collection and
-    # yielding it to the configuration block when one is provided.
-    #
-    # @param [Array] collection
-    #     The collection the step executor should be added to once created.
-    # @param [Module] namespace
-    #     The module the named step executor should be found in.
-    # @param [Symbol] type
-    #     The name of the step executor.
-    # @param [Proc] block
-    #     Optional block to refine the configuration of the step executor.
-    def add_instance(collection, namespace, type, block)
-      instance = namespace.const_get(to_class_name(type)).new
-      instance.extend Bozo::Runner
-      collection << instance
-      block.call instance if block
-    end
-
-    # Returns the collection of build tools required for the configuration.
-    #
-    # Sourced from the required tools of compilers, dependency resolvers,
-    # hooks, publishers and test runners.
-    #
-    # @param [Array] providers
-    #     Collection of providers that can define required tools.
-    def get_build_tools(providers)
-      providers.
-          select{|p| p.respond_to? :required_tools}.
-          map{|p| p.required_tools}.
-          flatten
-    end
-  
-  end
-
-  # Module containing all dependency resolvers.
-  module DependencyResolvers
-  end
-
-  # Module containing all compilers.
-  module Compilers
-  end
-
-  # Module containing all test runners.
-  module TestRunners
-  end
-
-  # Module containing all packagers.
-  module Packagers
-  end
-
-  # Module containing all preparers.
-  module Preparers
-  end
-
-  # Module containing all publishers.
-  module Publishers
-  end
-
-  # Module containing all hooks.
-  module Hooks
-  end
-
+module Bozo
+
+  # Class used for defining the configuration of a build.
+  class BozoConfiguration
+
+    include Bozo::ClassNameHelpers
+    
+    # Creates a new instance
+    def initialize
+      @build_tools_location = nil
+      @compilers = []
+      @dependency_resolvers = []
+      @hooks = []
+      @packagers = []
+      @preparers = []
+      @publishers = []
+      @test_runners = []
+      @version = nil
+    end
+    
+    # Loads the configuration from the specified file.
+    # 
+    # @param [String] path
+    #     The path to the configuration file.    
+    def load(path)
+      instance_eval IO.read(path), path
+    end
+
+    # The version of the project to build.
+    def version
+      @version ||= Versioning::Version.load_from_file
+    end
+
+    # The location of the base build tools.
+    #
+    # Sets and returns the location if a value is provided, otherwise returns
+    # the current value.
+    #
+    # It is expected the build tools will be in sub-directory of this location
+    # according to the name of the tool and that the runner will be able to
+    # copy the contents of the sub-directory to a local directory via the
+    # `FileUtils.cp_r` method.
+    #
+    # @param [String] location
+    #     The path to set as the build tools location.
+    def build_tools_location(location = nil)
+      @build_tools_location = location if location
+      @build_tools_location
+    end
+
+    # Returns the all the build tools required by the specified compilers,
+    # dependency resolvers, hooks, packagers, publishers and test runners.
+    def build_tools
+      build_tools = get_build_tools @compilers
+      build_tools |= get_build_tools @dependency_resolvers
+      build_tools |= get_build_tools @hooks
+      build_tools |= get_build_tools @packagers
+      build_tools |= get_build_tools @preparers
+      build_tools |= get_build_tools @publishers
+      build_tools | (get_build_tools @test_runners)
+    end
+
+    # Returns the configured dependency resolvers.
+    attr_reader :dependency_resolvers
+
+    # Adds an instance of the named preparer to the preparer collection and
+    # yields it to the configuration block when one is specified.
+    #
+    # @param [Symbol] type
+    #     The name of the preparer.
+    # @param [Proc] block
+    #     Optional block to refine the configuration of the preparer.
+    def prepare(type, &block) # :yields: preparer
+      add_instance @preparers, Bozo::Preparers, type, block
+    end
+
+    # Returns the configured preparers.
+    attr_reader :preparers
+
+    # Adds an instance of the named dependency resolver to the dependency
+    # resolver collection and yields it to the configuration block when one
+    # is specified.
+    #
+    # @param [Symbol] type
+    #     The name of the dependency resolver.
+    # @param [Proc] block
+    #     Optional block to refine the configuration of the dependency
+    #     resolver.
+    def resolve_dependencies_with(type, &block) # :yields: dependency_resolver
+      add_instance @dependency_resolvers, Bozo::DependencyResolvers, type, block
+    end
+
+    # Returns the configured compilers.
+    attr_reader :compilers
+
+    # Adds an instance of the named compiler to the compiler collection and
+    # yields it to the configuration block when one is specified.
+    #
+    # @param [Symbol] type
+    #     The name of the compiler.
+    # @param [Proc] block
+    #     Optional block to refine the configuration of the compiler.
+    def compile_with(type, &block) # :yields: compiler
+      add_instance @compilers, Bozo::Compilers, type, block
+    end
+
+    # Returns the configured test runners.
+    attr_reader :test_runners
+
+    # Adds an instance of the named test runner to the test runner collection
+    # and yields it to the configuration block when one is specified.
+    #
+    # @param [Symbol] type
+    #     The name of the test runner.
+    # @param [Proc] block
+    #     Optional block to refine the configuration of the test runner.
+    def test_with(type, &block) # :yields: test_runner
+      add_instance @test_runners, Bozo::TestRunners, type, block
+    end
+
+    # Returns the configured packagers.
+    attr_reader :packagers
+
+    # Adds an instance of the named packager to the packager collection and
+    # yields it to the configuration block when one is specified.
+    #
+    # @param [Symbol] type
+    #     The name of the packager.
+    # @param [Proc] block
+    #     Optional block to refine the configuration of the packager.
+    def package_with(type, &block) # :yields: packager
+      add_instance @packagers, Bozo::Packagers, type, block
+    end
+
+    # Returns the configured publishers.
+    attr_reader :publishers
+
+    # Adds an instance of the named publisher to the publisher collection and
+    # yields it to the configuration block when one is specified.
+    #
+    # @param [Symbol] type
+    #     The name of the publisher.
+    # @param [Proc] block
+    #     Optional block to refine the configuration of the publisher.
+    def publish_with(type, &block) # :yields: publisher
+      add_instance @publishers, Bozo::Publishers, type, block
+    end
+
+    # Returns the configured hooks.
+    attr_reader :hooks
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    #
+    # @param [Symbol] type
+    #     The name of the hook.
+    # @param [Proc] block
+    #     Optional block to refine the configuration of the hook.
+    def with_hook(type, &block) # :yields: hook
+      add_instance @hooks, Bozo::Hooks, type, block
+    end
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :pre_build :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :pre_clean :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :post_clean :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :pre_uninstall :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :post_uninstall :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :pre_dependencies :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :post_dependencies :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :pre_prepare :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :post_prepare :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :pre_compile :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :post_compile :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :pre_test :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :post_test :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :pre_package :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :post_package :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :pre_publish :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :post_publish :with_hook
+
+    # Adds an instance of the named hook to the hook collection and yields it
+    # to the configuration block when one is specified.
+    alias :post_build :with_hook
+    
+    private
+
+    # Resolves the named class within the given namespace and then created an
+    # instance of the class before adding it to the given collection and
+    # yielding it to the configuration block when one is provided.
+    #
+    # @param [Array] collection
+    #     The collection the step executor should be added to once created.
+    # @param [Module] namespace
+    #     The module the named step executor should be found in.
+    # @param [Symbol] type
+    #     The name of the step executor.
+    # @param [Proc] block
+    #     Optional block to refine the configuration of the step executor.
+    def add_instance(collection, namespace, type, block)
+      instance = namespace.const_get(to_class_name(type)).new
+      instance.extend Bozo::Runner
+      collection << instance
+      block.call instance if block
+    end
+
+    # Returns the collection of build tools required for the configuration.
+    #
+    # Sourced from the required tools of compilers, dependency resolvers,
+    # hooks, publishers and test runners.
+    #
+    # @param [Array] providers
+    #     Collection of providers that can define required tools.
+    def get_build_tools(providers)
+      providers.
+          select{|p| p.respond_to? :required_tools}.
+          map{|p| p.required_tools}.
+          flatten
+    end
+  
+  end
+
+  # Module containing all dependency resolvers.
+  module DependencyResolvers
+  end
+
+  # Module containing all compilers.
+  module Compilers
+  end
+
+  # Module containing all test runners.
+  module TestRunners
+  end
+
+  # Module containing all packagers.
+  module Packagers
+  end
+
+  # Module containing all preparers.
+  module Preparers
+  end
+
+  # Module containing all publishers.
+  module Publishers
+  end
+
+  # Module containing all hooks.
+  module Hooks
+  end
+
 end

data/lib/bozo/class_name_helpers.rb

@@ -1,17 +1,17 @@
-module Bozo
-
-  module ClassNameHelpers
-
-    # Converts a symbol into a Pascal Case class name.
-    #
-    # eg. `:single` => `"Single"`, `:two_words` => `"TwoWords"`.
-    #
-    # @param [Symbol] type
-    #     The name of a step executor.
-    def to_class_name(type)
-      type.to_s.split('_').map{|word| word.capitalize}.join
-    end
-
-  end
-
+module Bozo
+
+  module ClassNameHelpers
+
+    # Converts a symbol into a Pascal Case class name.
+    #
+    # eg. `:single` => `"Single"`, `:two_words` => `"TwoWords"`.
+    #
+    # @param [Symbol] type
+    #     The name of a step executor.
+    def to_class_name(type)
+      type.to_s.split('_').map{|word| word.capitalize}.join
+    end
+
+  end
+
 end