bozo-scripts 0.1.11 → 0.2.0

data/lib/bozo/packagers/rubygems.rb

@@ -1,24 +1,24 @@
-module Bozo::Packagers
-
-  # Specifies gem packager.
-  #
-  # Builds any '*.gemspec' file in the root directory
-  class Rubygems
-
-    def execute
-      dist_dir = File.expand_path(File.join('dist', 'gem'))
-      FileUtils.mkdir_p dist_dir
-
-      Dir['*.gemspec'].each { |spec| build_gem spec }
-      Dir['*.gem'].each { |file| FileUtils.mv file, File.join(dist_dir, file) }
-    end
-
-    private
-
-    def build_gem(spec)
-      execute_command :rubygems, ['gem', 'build', spec]
-    end
-
-  end
-
+module Bozo::Packagers
+
+  # Specifies gem packager.
+  #
+  # Builds any '*.gemspec' file in the root directory
+  class Rubygems
+
+    def execute
+      dist_dir = File.expand_path(File.join('dist', 'gem'))
+      FileUtils.mkdir_p dist_dir
+
+      Dir['*.gemspec'].each { |spec| build_gem spec }
+      Dir['*.gem'].each { |file| FileUtils.mv file, File.join(dist_dir, file) }
+    end
+
+    private
+
+    def build_gem(spec)
+      execute_command :rubygems, ['gem', 'build', spec]
+    end
+
+  end
+
 end

data/lib/bozo/preparers/common_assembly_info.rb

@@ -1,34 +1,34 @@
-module Bozo::Preparers
-
-  class CommonAssemblyInfo
-
-    def company_name(name)
-      @company_name = name
-    end
-
-    def execute
-      log_info 'Generating common assembly info'
-
-      git_hash = env['GIT_HASH_FULL']
-      computer_name = env['COMPUTERNAME']
-      trademark = computer_name ? "#{computer_name} #{git_hash}" : git_hash
-      path = File.expand_path(File.join('build', 'CommonAssemblyInfo.cs'))
-
-      log_debug "Version: #{version}"
-      log_debug "Commit hash: #{git_hash}"
-      log_debug "Computer name: #{computer_name}" if computer_name
-      log_debug "Path: #{path}"
-
-      File.open(path, 'w+') do |f|
-        f << "using System.Reflection;\n"
-        f << "\n"
-        f << "[assembly: AssemblyCompany(\"#{@company_name}\")]\n"
-        f << "[assembly: AssemblyVersion(\"#{version}\")]\n"
-        f << "[assembly: AssemblyFileVersion(\"#{version}\")]\n"
-        f << "[assembly: AssemblyTrademark(\"#{trademark}\")]"
-      end
-    end
-
-  end
-
-end
+module Bozo::Preparers
+
+  class CommonAssemblyInfo
+
+    def company_name(name)
+      @company_name = name
+    end
+
+    def execute
+      log_info 'Generating common assembly info'
+
+      git_hash = env['GIT_HASH_FULL']
+      computer_name = env['COMPUTERNAME']
+      trademark = computer_name ? "#{computer_name} #{git_hash}" : git_hash
+      path = File.expand_path(File.join('build', 'CommonAssemblyInfo.cs'))
+
+      log_debug "Version: #{version}"
+      log_debug "Commit hash: #{git_hash}"
+      log_debug "Computer name: #{computer_name}" if computer_name
+      log_debug "Path: #{path}"
+
+      File.open(path, 'w+') do |f|
+        f << "using System.Reflection;\n"
+        f << "\n"
+        f << "[assembly: AssemblyCompany(\"#{@company_name}\")]\n"
+        f << "[assembly: AssemblyVersion(\"#{version}\")]\n"
+        f << "[assembly: AssemblyFileVersion(\"#{version}\")]\n"
+        f << "[assembly: AssemblyTrademark(\"#{trademark}\")]"
+      end
+    end
+
+  end
+
+end

data/lib/bozo/preparers/file_templating.rb

@@ -1,152 +1,152 @@
-module Bozo::Preparers
-
-  # Preparer for creating files based upon configuration files and ERB-style
-  # templates before any compilation occurs.
-  #
-  # == Overview
-  #
-  # This preparer is primarily intended for generating config files with shared
-  # values but it is capable of generating whatever files you want. Each
-  # instance of the preparer is isolated from the anothers so you could specify
-  # multiple preparers to work with different configurations and templates if
-  # you wished.
-  #
-  # By default the preparer will load <tt>default.rb</tt> followed by
-  # <tt>[environment].rb</tt> followed by <tt>[machine_name].rb</tt> from the
-  # configured config_path if the file exists. It will then load any files
-  # explicitly required through the config_file method.
-  #
-  # == Hook configuration
-  #
-  #   prepare :file_templating do |t|
-  #     t.config_path 'somewhere' # defaults to 'config' if not specified
-  #     t.config_file 'my/specific/file.rb' # must be a specific file
-  #     t.template_files 'src/**/*.config.template' # can use glob format
-  #   end
-  #
-  # Source files are expected to have an additional extension compared to the
-  # target file. For example, a source file of
-  # <tt>src/csharp/Project/Project.config.template</tt> will generate the file
-  # <tt>src/csharp/Project/Project.config</tt>.
-  #
-  # == Configuration files
-  #
-  # Configuration files specify a hash of hashes in a more readable format.
-  # For example:
-  #
-  #   group :example do
-  #     set :one, 'foo'
-  #     set :two, 'bar'
-  #   end
-  #
-  # Internally creates a hash like:
-  #
-  #   {:example => {:one => 'foo', :two => 'bar'}}
-  #
-  # A configuration file can overwrite the values specified by a preceding one
-  # without error. Groups can be opened and closed as desired and nesting
-  # groups is possible.
-  #
-  # == Template files
-  #
-  # To use a value within an ERB template you specify the hash hierarchy as if
-  # they were method names rather than having to use the full hash syntax.
-  #
-  # Therefore, this is valid:
-  #
-  #   Foo is <%= example.one %>
-  #
-  # Whilst this is *not* valid:
-  #
-  #   Foo is <%= self[:example][:one] %>
-  #
-  # If a template uses a value that is not specified within the configuration
-  # then the preparer will raise an error and halt the build.
-  class FileTemplating
-
-    # Creates a new instance.
-    def initialize
-      @config_path = 'config'
-      @template_globs = []
-      @config_files = []
-    end
-
-    # Sets the path of the directory within which the preparer should look for
-    # the default configuration files.
-    #
-    # @param [String] path
-    #     The path to the directory containing the default configuration files.
-    def config_path(path)
-      @config_path = path
-    end
-
-    # Adds a specific file to load configuration from.
-    #
-    # @param [String] path
-    #     The path to a configuration file.
-    def config_file(path)
-      @config_files << path
-    end
-
-    # Adds a set of templates files from which to generate files.
-    #
-    # @param [String] glob
-    #     A glob that points to a set of files that should pass through the
-    #     templating engine.
-    def template_files(glob)
-      @template_globs << glob
-    end
-
-    # Generate all the files matching the configuration.
-    def execute
-      log_info '' # formatting
-      log_info 'Generating files'
-
-      get_coordinator.generate_files do |template, target|
-        log_debug "Generating #{target} from #{template}"
-      end
-    end
-
-    private
-
-    # Creates a new templating coordinator based upon the current
-    # configuration.
-    def get_coordinator
-      coordinator = Bozo::ErubisTemplatingCoordinator.new
-
-      add_config coordinator
-      add_templates coordinator
-
-      coordinator
-    end
-
-    # Adds the configuration to the templating coordinator.
-    def add_config(coordinator)
-      add_default_config_files coordinator
-      @config_files.each {|f| coordinator.required_config_file f}
-    end
-
-    # Adds the default configuration from the configuration directory to the
-    # templating coordinator.
-    #
-    # @param [ErubisTemplatingCoordinator] coordinator
-    #     The template coordinator to add the configuration to.
-    def add_default_config_files(coordinator)
-      default_files = ['default.rb', "#{environment}.rb"]
-      default_files << "#{env['MACHINENAME']}.rb" if env['MACHINENAME']
-
-      default_files.each do |file|
-        coordinator.config_file File.join(@config_path, file)
-      end
-    end
-
-    # Adds the templates to the templating coordinator.
-    def add_templates(coordinator)
-      @template_globs.each do |glob|
-        coordinator.template_files glob
-      end
-    end
-
-  end
-
-end
+module Bozo::Preparers
+
+  # Preparer for creating files based upon configuration files and ERB-style
+  # templates before any compilation occurs.
+  #
+  # == Overview
+  #
+  # This preparer is primarily intended for generating config files with shared
+  # values but it is capable of generating whatever files you want. Each
+  # instance of the preparer is isolated from the anothers so you could specify
+  # multiple preparers to work with different configurations and templates if
+  # you wished.
+  #
+  # By default the preparer will load <tt>default.rb</tt> followed by
+  # <tt>[environment].rb</tt> followed by <tt>[machine_name].rb</tt> from the
+  # configured config_path if the file exists. It will then load any files
+  # explicitly required through the config_file method.
+  #
+  # == Hook configuration
+  #
+  #   prepare :file_templating do |t|
+  #     t.config_path 'somewhere' # defaults to 'config' if not specified
+  #     t.config_file 'my/specific/file.rb' # must be a specific file
+  #     t.template_files 'src/**/*.config.template' # can use glob format
+  #   end
+  #
+  # Source files are expected to have an additional extension compared to the
+  # target file. For example, a source file of
+  # <tt>src/csharp/Project/Project.config.template</tt> will generate the file
+  # <tt>src/csharp/Project/Project.config</tt>.
+  #
+  # == Configuration files
+  #
+  # Configuration files specify a hash of hashes in a more readable format.
+  # For example:
+  #
+  #   group :example do
+  #     set :one, 'foo'
+  #     set :two, 'bar'
+  #   end
+  #
+  # Internally creates a hash like:
+  #
+  #   {:example => {:one => 'foo', :two => 'bar'}}
+  #
+  # A configuration file can overwrite the values specified by a preceding one
+  # without error. Groups can be opened and closed as desired and nesting
+  # groups is possible.
+  #
+  # == Template files
+  #
+  # To use a value within an ERB template you specify the hash hierarchy as if
+  # they were method names rather than having to use the full hash syntax.
+  #
+  # Therefore, this is valid:
+  #
+  #   Foo is <%= example.one %>
+  #
+  # Whilst this is *not* valid:
+  #
+  #   Foo is <%= self[:example][:one] %>
+  #
+  # If a template uses a value that is not specified within the configuration
+  # then the preparer will raise an error and halt the build.
+  class FileTemplating
+
+    # Creates a new instance.
+    def initialize
+      @config_path = 'config'
+      @template_globs = []
+      @config_files = []
+    end
+
+    # Sets the path of the directory within which the preparer should look for
+    # the default configuration files.
+    #
+    # @param [String] path
+    #     The path to the directory containing the default configuration files.
+    def config_path(path)
+      @config_path = path
+    end
+
+    # Adds a specific file to load configuration from.
+    #
+    # @param [String] path
+    #     The path to a configuration file.
+    def config_file(path)
+      @config_files << path
+    end
+
+    # Adds a set of templates files from which to generate files.
+    #
+    # @param [String] glob
+    #     A glob that points to a set of files that should pass through the
+    #     templating engine.
+    def template_files(glob)
+      @template_globs << glob
+    end
+
+    # Generate all the files matching the configuration.
+    def execute
+      log_info '' # formatting
+      log_info 'Generating files'
+
+      get_coordinator.generate_files do |template, target|
+        log_debug "Generating #{target} from #{template}"
+      end
+    end
+
+    private
+
+    # Creates a new templating coordinator based upon the current
+    # configuration.
+    def get_coordinator
+      coordinator = Bozo::ErubisTemplatingCoordinator.new
+
+      add_config coordinator
+      add_templates coordinator
+
+      coordinator
+    end
+
+    # Adds the configuration to the templating coordinator.
+    def add_config(coordinator)
+      add_default_config_files coordinator
+      @config_files.each {|f| coordinator.required_config_file f}
+    end
+
+    # Adds the default configuration from the configuration directory to the
+    # templating coordinator.
+    #
+    # @param [ErubisTemplatingCoordinator] coordinator
+    #     The template coordinator to add the configuration to.
+    def add_default_config_files(coordinator)
+      default_files = ['default.rb', "#{environment}.rb"]
+      default_files << "#{env['MACHINENAME']}.rb" if env['MACHINENAME']
+
+      default_files.each do |file|
+        coordinator.config_file File.join(@config_path, file)
+      end
+    end
+
+    # Adds the templates to the templating coordinator.
+    def add_templates(coordinator)
+      @template_globs.each do |glob|
+        coordinator.template_files glob
+      end
+    end
+
+  end
+
+end

data/lib/bozo/publishers/file_copy.rb

@@ -1,83 +1,83 @@
-require 'fileutils'
-
-module Bozo::Publishers
-
-  # Publisher that copies files from one location to another.
-  class FileCopy
-
-    # Creates a new instance.
-    def initialize
-      @directories = []
-    end
-
-    # Adds a source directory of files copy.
-    #
-    # Must be relative to the project root. All files within the directory and
-    # its subdirectories will be copied to the destination directory,
-    # maintaining the file structure.
-    #
-    # @params [Array] args
-    #     Path to a directory relative to the project root.
-    def directory(*args)
-      @directories << args
-    end
-
-    # Set the destination directory of the file copy.
-    #
-    # Must be an absolute path.
-    #
-    # @params [String] destination
-    #     The absolution path the source files should be copied to.
-    def destination(destination)
-      @destination = destination
-    end
-
-    def execute
-      if @directories.empty? or @destination.nil?
-        raise Bozo::ConfigurationError.new 'You must specify at least one source file or directory AND a destination directory'
-      end
-
-      ensure_no_clashing_files
-
-      copy_pairs do |source, target|
-        FileUtils.mkdir_p File.dirname(target)
-        log_debug "Publishing \"#{File.basename(source)}\" to \"#{target}\""
-        FileUtils.cp source, target
-      end
-    end
-
-    private
-
-    # Checks the destination does not contain files that will be overwritten by
-    # the source files.
-    def ensure_no_clashing_files
-      existing_files = []
-
-      copy_pairs do |source, target|
-        existing_files << target if File.exist? target
-      end
-
-      raise Bozo::ConfigurationError.new "Target files already exist - #{existing_files}" unless existing_files.empty?
-    end
-
-    # Returns the source-destination file pairs specified by the source
-    # directories and destination directory.
-    def copy_pairs # :yields: source_path, destination_path
-      destination = File.join @destination
-
-      @directories.each do |dir|
-        relative_source_dir = File.join(dir)
-        source_dir = File.expand_path relative_source_dir
-        source_dir_path = Pathname.new source_dir
-
-        Dir[File.join(source_dir, '**', '*')].each do |source_file|
-          rel_path = Pathname.new(source_file).relative_path_from(source_dir_path).to_s
-          target_file = File.join(destination, rel_path)
-          yield source_file, target_file
-        end
-      end
-    end
-
-  end
-
+require 'fileutils'
+
+module Bozo::Publishers
+
+  # Publisher that copies files from one location to another.
+  class FileCopy
+
+    # Creates a new instance.
+    def initialize
+      @directories = []
+    end
+
+    # Adds a source directory of files copy.
+    #
+    # Must be relative to the project root. All files within the directory and
+    # its subdirectories will be copied to the destination directory,
+    # maintaining the file structure.
+    #
+    # @params [Array] args
+    #     Path to a directory relative to the project root.
+    def directory(*args)
+      @directories << args
+    end
+
+    # Set the destination directory of the file copy.
+    #
+    # Must be an absolute path.
+    #
+    # @params [String] destination
+    #     The absolution path the source files should be copied to.
+    def destination(destination)
+      @destination = destination
+    end
+
+    def execute
+      if @directories.empty? or @destination.nil?
+        raise Bozo::ConfigurationError.new 'You must specify at least one source file or directory AND a destination directory'
+      end
+
+      ensure_no_clashing_files
+
+      copy_pairs do |source, target|
+        FileUtils.mkdir_p File.dirname(target)
+        log_debug "Publishing \"#{File.basename(source)}\" to \"#{target}\""
+        FileUtils.cp source, target
+      end
+    end
+
+    private
+
+    # Checks the destination does not contain files that will be overwritten by
+    # the source files.
+    def ensure_no_clashing_files
+      existing_files = []
+
+      copy_pairs do |source, target|
+        existing_files << target if File.exist? target
+      end
+
+      raise Bozo::ConfigurationError.new "Target files already exist - #{existing_files}" unless existing_files.empty?
+    end
+
+    # Returns the source-destination file pairs specified by the source
+    # directories and destination directory.
+    def copy_pairs # :yields: source_path, destination_path
+      destination = File.join @destination
+
+      @directories.each do |dir|
+        relative_source_dir = File.join(dir)
+        source_dir = File.expand_path relative_source_dir
+        source_dir_path = Pathname.new source_dir
+
+        Dir[File.join(source_dir, '**', '*')].each do |source_file|
+          rel_path = Pathname.new(source_file).relative_path_from(source_dir_path).to_s
+          target_file = File.join(destination, rel_path)
+          yield source_file, target_file
+        end
+      end
+    end
+
+  end
+
 end