bozo-scripts 0.1.11 → 0.2.0

data/lib/bozo/erubis_templating_coordinator.rb

@@ -1,128 +1,128 @@
-require 'erubis'
-
-module Bozo
-  
-  # Class for creating files based upon configuration files and ERB-style
-  # templates.
-  # 
-  # == Overview
-  # 
-  # This class is primarily intended for generating config files with shared
-  # values but it is capable of generating whatever files you want.
-  # 
-  # == 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 hook will raise an error and halt the build.
-  class ErubisTemplatingCoordinator
-
-    # Create a new instance.
-    #
-    # @param [Configuration] configuration
-    #     The configuration to use with templates. If not specified a new
-    #     object is created.
-    def initialize(configuration = Bozo::Configuration.new)
-      @templates = []
-      @configuration = configuration
-    end
-
-    # Adds a required configuration file to the underlying configuration
-    # object.
-    # 
-    # @param [String] path
-    #     The path of the configuration file to load.
-    def required_config_file(path)
-      raise RuntimeError.new "Required config file #{path} could not be found" unless File.exist? path
-      config_file path
-    end
-    
-    # Adds a configuration file to the underlying configuration object if a
-    # file exists at the given path.
-    # 
-    # @param [String] path
-    #     The path of the configuration file to load.
-    def config_file(path)
-      @configuration.load path if File.exist? path
-    end
-
-    # Adds a template file to use when generating files.
-    # 
-    # @param [String] path
-    #     The path of the template file.
-    def template_file(path)
-      @templates << path
-    end
-
-    # Adds a selection of template files to use when generating files.
-    # 
-    # @param [String] glob
-    #     A glob from that matches template files.
-    def template_files(glob)
-      @templates = @templates + Dir[glob]
-    end
-
-    # Generate all the files matching the underlying configuration.
-    #
-    # @param [Proc] block
-    #     A block that will be called with the template path and target file
-    #     path when provided.
-    def generate_files(&block)
-      @templates.each {|template| generate_file template, block}
-    end
-
-    private
-
-    # Generate the file relating to the template file using the given
-    # configuration.
-    # 
-    # @param [String] template_path
-    #     The path of the template file that should be filled using the
-    #     configuration.
-    # @param [Proc] block
-    #     A block that will be called with the template path and target file
-    #     path when provided.
-    def generate_file(template_path, block)
-      target_path = template_path.sub /\.[^\.]+$/, ''
-
-      block.call(template_path, target_path) unless block.nil?
-
-      template_content = IO.read template_path
-      template = Erubis::Eruby.new template_content
-
-      content = @configuration.apply {|binding| template.result(binding)}
-
-      File.open(target_path, 'w+') {|f| f.write(content)}
-    end
-
-  end
-
+require 'erubis'
+
+module Bozo
+  
+  # Class for creating files based upon configuration files and ERB-style
+  # templates.
+  # 
+  # == Overview
+  # 
+  # This class is primarily intended for generating config files with shared
+  # values but it is capable of generating whatever files you want.
+  # 
+  # == 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 hook will raise an error and halt the build.
+  class ErubisTemplatingCoordinator
+
+    # Create a new instance.
+    #
+    # @param [Configuration] configuration
+    #     The configuration to use with templates. If not specified a new
+    #     object is created.
+    def initialize(configuration = Bozo::Configuration.new)
+      @templates = []
+      @configuration = configuration
+    end
+
+    # Adds a required configuration file to the underlying configuration
+    # object.
+    # 
+    # @param [String] path
+    #     The path of the configuration file to load.
+    def required_config_file(path)
+      raise RuntimeError.new "Required config file #{path} could not be found" unless File.exist? path
+      config_file path
+    end
+    
+    # Adds a configuration file to the underlying configuration object if a
+    # file exists at the given path.
+    # 
+    # @param [String] path
+    #     The path of the configuration file to load.
+    def config_file(path)
+      @configuration.load path if File.exist? path
+    end
+
+    # Adds a template file to use when generating files.
+    # 
+    # @param [String] path
+    #     The path of the template file.
+    def template_file(path)
+      @templates << path
+    end
+
+    # Adds a selection of template files to use when generating files.
+    # 
+    # @param [String] glob
+    #     A glob from that matches template files.
+    def template_files(glob)
+      @templates = @templates + Dir[glob]
+    end
+
+    # Generate all the files matching the underlying configuration.
+    #
+    # @param [Proc] block
+    #     A block that will be called with the template path and target file
+    #     path when provided.
+    def generate_files(&block)
+      @templates.each {|template| generate_file template, block}
+    end
+
+    private
+
+    # Generate the file relating to the template file using the given
+    # configuration.
+    # 
+    # @param [String] template_path
+    #     The path of the template file that should be filled using the
+    #     configuration.
+    # @param [Proc] block
+    #     A block that will be called with the template path and target file
+    #     path when provided.
+    def generate_file(template_path, block)
+      target_path = template_path.sub /\.[^\.]+$/, ''
+
+      block.call(template_path, target_path) unless block.nil?
+
+      template_content = IO.read template_path
+      template = Erubis::Eruby.new template_content
+
+      content = @configuration.apply {|binding| template.result(binding)}
+
+      File.open(target_path, 'w+') {|f| f.write(content)}
+    end
+
+  end
+
 end

data/lib/bozo/hooks/fxcop.rb

@@ -1,152 +1,152 @@
-module Bozo::Hooks
-
-  # Specifies a hook for running FxCop.
-  #
-  # The default configuration runs against the compiled assemblies produced via
-  # msbuild.
-  #
-  # Alternatively a specific .fxcop project file can be specified in the 
-  # configuration.
-  class FxCop
-
-    def self.default_path
-      if ENV['ProgramFiles(x86)'].nil?
-        program_files_path = ENV['ProgramFiles']
-      else
-        program_files_path = ENV['ProgramFiles(x86)']
-      end
-
-      File.join(program_files_path, 'Microsoft Fxcop 10.0', 'fxcopcmd.exe') unless program_files_path.nil?
-    end
-
-    def initialize
-      @@defaults = {
-        :types => [],
-        :framework_versions => [:net35, :net40],
-        :project => nil,
-        :path => FxCop.default_path
-      }
-
-      @config = {}
-    end
-
-    # Adds a type to analyze
-    def type(type)
-      @config[:types] ||= []
-      @config[:types] << type
-    end
-
-    # Specifies an fxcop project file
-    def project(project)
-      @config[:project] = project
-    end
-
-    # Specifies the fxcop path
-    def path(path = nil)
-      @config[:path] = path unless path.nil?
-      
-      @config[:path]
-    end
-
-    # Runs the post_compile hook
-    def post_compile
-      config = config_with_defaults
-
-      raise no_executable_path_specified if path.nil?
-      raise no_executable_exists unless File.exists?(path)
-
-      if config[:project].nil?
-        execute_projects config
-      else
-        execute_fxcop_project config
-      end
-    end
-
-    private
-
-    def config_with_defaults
-      @@defaults.merge @config
-    end
-
-    # The path to output the fxcop results to
-    def output_path
-      out_path = File.expand_path File.join('temp', 'fxcop')
-      FileUtils.mkdir_p out_path
-      out_path
-    end
-
-    # Executes fxcop against the msbuild built assemblies
-    #
-    # @param [Hash] config
-    #     The fxcop configuration
-    def execute_projects(config)
-      log_debug "Executing projects with '#{path}'" if config[:framework_versions].any?
-
-      config[:framework_versions].each do |framework_version|
-        args = []
-        args << '"' + path + '"'
-        args << "/out:#{output_path}\\#{Time.now.to_i}-#{framework_version}-FxCop-report.xml"
-        args << "/types:" + config[:types].join(',') unless config[:types].empty?
-
-        project_dirs.each do |project|
-          projects = project_files(project, framework_version)
-
-          projects.each do |project_file|
-            project_path = File.expand_path(project_file).gsub(/\//, '\\')
-            args << "/file:\"#{project_path}\""
-          end
-        end
-
-        execute_command :fx_cop, args
-      end
-    end
-
-    # Executes a .fxcop file
-    #
-    # @param [Hash] config
-    #     The fxcop configuration
-    def execute_fxcop_project(config)
-      log_debug "Executing fxcop project '#{config[:project]}' with '#{path}'"
-
-      args = []
-      args << '"' + path + '"'
-      args << "/out:\"#{output_path}\\#{File.basename(config[:project], '.*')}-FxCop-report.xml\""
-      args << "/project:\"#{config[:project]}\""
-      args << "/types:" + config[:types].join(',') unless config[:types].empty?
-
-      execute_command :fx_cop, args
-    end
-
-    # Create a new error specifying that the executable path
-    # has not been specified.
-    def no_executable_path_specified
-      ConfigurationError.new "No path specified for fxcop"
-    end
-
-    # Create a new error specifying that the fxcop executable
-    # does not exist at the path.
-    def no_executable_exists
-      ConfigurationError.new "FxCop executable does not exist at #{path}"
-    end
-
-    # List of compiled assemblies and executables
-
-    # @param [String] project_path
-    #     The path of the project
-    # @param [Symbol] framework_version
-    #     The framework_version to find assemblies for
-    def project_files(project_path, framework_version)
-      project_name = File.basename(project_path)
-      file_matcher = File.expand_path File.join(project_path, framework_version.to_s, "#{project_name}.{dll,exe}")
-      Dir[file_matcher]
-    end
-
-    # List of all the msbuild built projects
-    def project_dirs
-      project_file_matcher = File.expand_path File.join('temp', 'msbuild', '*')
-      Dir[project_file_matcher]
-    end
-
-  end
-
+module Bozo::Hooks
+
+  # Specifies a hook for running FxCop.
+  #
+  # The default configuration runs against the compiled assemblies produced via
+  # msbuild.
+  #
+  # Alternatively a specific .fxcop project file can be specified in the 
+  # configuration.
+  class FxCop
+
+    def self.default_path
+      if ENV['ProgramFiles(x86)'].nil?
+        program_files_path = ENV['ProgramFiles']
+      else
+        program_files_path = ENV['ProgramFiles(x86)']
+      end
+
+      File.join(program_files_path, 'Microsoft Fxcop 10.0', 'fxcopcmd.exe') unless program_files_path.nil?
+    end
+
+    def initialize
+      @@defaults = {
+        :types => [],
+        :framework_versions => [:net35, :net40],
+        :project => nil,
+        :path => FxCop.default_path
+      }
+
+      @config = {}
+    end
+
+    # Adds a type to analyze
+    def type(type)
+      @config[:types] ||= []
+      @config[:types] << type
+    end
+
+    # Specifies an fxcop project file
+    def project(project)
+      @config[:project] = project
+    end
+
+    # Specifies the fxcop path
+    def path(path = nil)
+      @config[:path] = path unless path.nil?
+      
+      @config[:path]
+    end
+
+    # Runs the post_compile hook
+    def post_compile
+      config = config_with_defaults
+
+      raise no_executable_path_specified if path.nil?
+      raise no_executable_exists unless File.exists?(path)
+
+      if config[:project].nil?
+        execute_projects config
+      else
+        execute_fxcop_project config
+      end
+    end
+
+    private
+
+    def config_with_defaults
+      @@defaults.merge @config
+    end
+
+    # The path to output the fxcop results to
+    def output_path
+      out_path = File.expand_path File.join('temp', 'fxcop')
+      FileUtils.mkdir_p out_path
+      out_path
+    end
+
+    # Executes fxcop against the msbuild built assemblies
+    #
+    # @param [Hash] config
+    #     The fxcop configuration
+    def execute_projects(config)
+      log_debug "Executing projects with '#{path}'" if config[:framework_versions].any?
+
+      config[:framework_versions].each do |framework_version|
+        args = []
+        args << '"' + path + '"'
+        args << "/out:#{output_path}\\#{Time.now.to_i}-#{framework_version}-FxCop-report.xml"
+        args << "/types:" + config[:types].join(',') unless config[:types].empty?
+
+        project_dirs.each do |project|
+          projects = project_files(project, framework_version)
+
+          projects.each do |project_file|
+            project_path = File.expand_path(project_file).gsub(/\//, '\\')
+            args << "/file:\"#{project_path}\""
+          end
+        end
+
+        execute_command :fx_cop, args
+      end
+    end
+
+    # Executes a .fxcop file
+    #
+    # @param [Hash] config
+    #     The fxcop configuration
+    def execute_fxcop_project(config)
+      log_debug "Executing fxcop project '#{config[:project]}' with '#{path}'"
+
+      args = []
+      args << '"' + path + '"'
+      args << "/out:\"#{output_path}\\#{File.basename(config[:project], '.*')}-FxCop-report.xml\""
+      args << "/project:\"#{config[:project]}\""
+      args << "/types:" + config[:types].join(',') unless config[:types].empty?
+
+      execute_command :fx_cop, args
+    end
+
+    # Create a new error specifying that the executable path
+    # has not been specified.
+    def no_executable_path_specified
+      ConfigurationError.new "No path specified for fxcop"
+    end
+
+    # Create a new error specifying that the fxcop executable
+    # does not exist at the path.
+    def no_executable_exists
+      ConfigurationError.new "FxCop executable does not exist at #{path}"
+    end
+
+    # List of compiled assemblies and executables
+
+    # @param [String] project_path
+    #     The path of the project
+    # @param [Symbol] framework_version
+    #     The framework_version to find assemblies for
+    def project_files(project_path, framework_version)
+      project_name = File.basename(project_path)
+      file_matcher = File.expand_path File.join(project_path, framework_version.to_s, "#{project_name}.{dll,exe}")
+      Dir[file_matcher]
+    end
+
+    # List of all the msbuild built projects
+    def project_dirs
+      project_file_matcher = File.expand_path File.join('temp', 'msbuild', '*')
+      Dir[project_file_matcher]
+    end
+
+  end
+
 end