BuildMaster 0.5.0

data/README

@@ -0,0 +1,25 @@
+= BuildMaster - Building and releasing project and site with Ruby
+
+Homepage::  http://buildmaster.rubyforge.org
+Author::    Shane
+Copyright:: (c) 2006 BuildMaster on rubyforge
+License::   Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+BuildMaster is a project that targets project building, releasing and site building.
+
+Please post your question at http://groups.google.com/group/buildmaster/ or
+send email to buildmaster@googlegroups.com
+
+== Project Building and Releasing
+
+A ruby version of the project building and releasing script as described in
+"Pragmatic Project Automation" (http://www.pragmaticprogrammer.com/sk/auto/)
+
+== Site Building
+
+A simple template engine that can build a website by producing the content pages based on the specified source
+and decrorating the content pages with a skin.
+
+The supported content sources are <a href="http://www.w3.org/TR/xhtml11/">XHTML</a> and <a href="http://hobix.com/textile/">Textile</a>.
+
+

data/lib/buildmaster.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'buildmaster/shell_command'
+require 'buildmaster/release_control'
+require 'buildmaster/ant_client'
+require 'buildmaster/cvs_client'
+require 'buildmaster/svn_driver'
+require 'buildmaster/site'
+require 'buildmaster/xtemplate'

data/lib/buildmaster/ant_client.rb

@@ -0,0 +1,132 @@
+class Ant
+  include Shell
+  def initialize(ant_file = nil, &command_runner)
+    @ant_file = ant_file
+    @ant_home = check_directory(get_environment('ANT_HOME'))
+#ISSUE: what java wants to split up classpath varies from platform to platform 
+#and ruby, following perl, is not too hot at hinting which box it is on.
+#here I assume ":" except on win32, dos, and netware. Add extra tests here as needed.
+    #This is the only way I know how to check if on windows
+    if File.directory?('C:')
+      @class_path_delimiter = ';'
+      @path_seperator='\\'
+    else
+      @class_path_delimiter = ':'
+      @path_seperator='/'
+    end
+    @java_command = get_java_command()
+    @ant_options = get_environment_or_default('ANT_OPTS').split(' ')
+    @ant_arguments = get_environment_or_default('ANT_ARGS').split(' ')
+    @ant_options.putsh(ENV['JIKESPATH']) if ENV['JIKESPATH']
+    @classpath=ENV['CLASSPATH']
+    @command_runner = command_runner
+  end
+  
+  def get_java_command
+    java_home = get_environment_or_default('JAVA_HOME')
+    if java_home
+      command = [java_home, 'bin', 'java'].join(@path_seperator)
+    else
+      command = get_environment_or_default('JAVA_CMD', 'java')
+    end
+    return command
+  end
+  
+  def project_help
+    launch('-projecthelp')    
+  end
+  
+  def target(name)
+    launch(name)
+  end
+
+  def launch(arguments)
+    local_path = "#{@ant_home}/lib/ant-launcher.jar"
+    if (@classpath and @classpath.length() > 0)
+      local_path = "#{local_path}#{@class_path_delimiter}#{@classpath}"
+    end
+    all_arguments = Array.new()
+    all_arguments.push(@ant_options)
+    all_arguments.push('-classpath', local_path)
+    all_arguments.push("-Dant.home=#{@ant_home}")
+    all_arguments.push('org.apache.tools.ant.launch.Launcher', @ant_arguments);
+    all_arguments.push('-f', @ant_file) if @ant_file
+    all_arguments.push(arguments)
+    command_line = "#{@java_command} #{all_arguments.join(' ')}"
+    run_command(command_line)
+  end
+  
+  private :get_java_command
+
+end
+
+class RubyAnt
+  def initialize(ant_file = nil, &command_runner)
+    @ant_file = ant_file
+    @ant_home = check_directory(get_environment('ANT_HOME'))
+    @java_command = get_environment_or_default('JAVA_CMD', 'java')
+#ISSUE: what java wants to split up classpath varies from platform to platform 
+#and ruby, following perl, is not too hot at hinting which box it is on.
+#here I assume ":" except on win32, dos, and netware. Add extra tests here as needed.
+    #This is the only way I know how to check if on windows
+    if File.directory?('C:')
+      @class_path_delimiter = ';'
+    else
+      @class_path_delimiter = ':'
+    end
+    @ant_options = get_environment_or_default('ANT_OPTS').split(' ')
+    @ant_arguments = get_environment_or_default('ANT_ARGS').split(' ')
+    @ant_options.putsh(ENV['JIKESPATH']) if ENV['JIKESPATH']
+    @classpath=ENV['CLASSPATH']
+    @command_runner = command_runner
+  end
+  
+  def launch(arguments)
+    local_path = "#{@ant_home}/lib/ant-launcher.jar"
+    if (@classpath and @classpath.length() > 0)
+      local_path = "#{local_path}#{@class_path_delimiter}#{@classpath}"
+    end
+    all_arguments = Array.new()
+    all_arguments.push(@ant_options)
+    all_arguments.push('-classpath', local_path)
+    all_arguments.push("-Dant.home=#{@ant_home}")
+    all_arguments.push('org.apache.tools.ant.launch.Launcher', @ant_arguments);
+    all_arguments.push('-f', @ant_file) if @ant_file
+    all_arguments.push(arguments)
+    command_line = "#{@java_command} #{all_arguments.join(' ')}"
+    run_command(command_line)
+  end
+  
+  private
+  def run(command)
+    if (!system(command))
+      raise "error running command: #{command}"
+    end
+  end
+  
+  def run_command(full_command)
+    if (@command_runner)
+      @command_runner.call(full_command)
+    else
+      run(full_command)
+    end
+  end
+  
+  private
+  def check_directory(path)
+    raise "#{path} is not a directory" unless File.directory? path    
+    return path
+  end
+  
+  def get_environment(name)
+    value = ENV[name]
+    raise "#{name} is not set" unless value
+    return value
+  end
+  
+  def get_environment_or_default(name, default_value='')
+    value = ENV[name]
+    value = default_value if not value
+    return value
+  end
+end

data/lib/buildmaster/build_file.rb

@@ -0,0 +1,11 @@
+class BuildFile
+  def initialize(file_name)
+  end
+  
+  def increase(property_name)
+    return 1
+  end
+  
+  def save()
+  end
+end

data/lib/buildmaster/cvs_client.rb

@@ -0,0 +1,57 @@
+class CvsInfo  
+  attr_reader :root, :repository
+
+  public
+  def initialize(root, repository)
+    @root = root
+    @repository = repository
+  end
+  
+  def CvsInfo.load(folder)
+    return CvsInfo.new(read("#{folder}/Root").strip!, read("#{folder}/Repository").strip!)
+  end
+  
+  private
+  def CvsInfo.read(file)
+    File.open(file) do |file|
+      return file.gets
+    end
+  end
+  
+end
+
+class CvsClient
+  include Shell
+  def CvsClient.load(working_directory)
+    return CvsClient.new(CvsInfo.load("#{working_directory}/CVS"), working_directory)
+  end
+  
+  def initialize(cvs_info, working_directory, &command_runner)
+    @cvs_info = cvs_info
+    @working_directory = working_directory
+    @command_runner = command_runner
+  end
+  
+  def command(command)
+    run_command "cvs -d #{@cvs_info.root} #{command} #{@working_directory}"
+  end
+  
+  def checkout()
+    run_command("cvs -d #{@cvs_info.root} co -d #{@working_directory} #{@cvs_info.repository}")
+  end
+  
+  def update(option='')
+    if (option.length > 0)
+      option = ' ' + option
+    end
+    command("update#{option}")
+  end
+  
+  def tag(name)
+    command("tag #{name}")
+  end
+  
+  def commit(comment)
+    command("commit -m \"#{comment}\"")
+  end
+end

data/lib/buildmaster/file_processor.rb

@@ -0,0 +1,62 @@
+$:.unshift File.dirname(__FILE__)
+
+module BuildMaster
+
+class FileProcessor
+  def initialize(template, content_path, evaluator)
+    @template = template
+    @content_path = content_path
+    @evaluator = evaluator
+  end
+    
+  def process_textile()
+    textile_content = IO.read(@content_path)
+    match_result = TEXTILE_REGX.match(textile_content)
+    title = ''
+      if match_result != nil
+        title = match_result[2]
+        textile_content = match_result.post_match
+      end
+      html_body = RedCloth.new(textile_content).to_html
+      html_content = <<HTML
+<!DOCTYPE html
+    PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <title>#{title}</title>
+</head>
+<body>      
+    #{html_body}
+</body>
+</html>
+HTML
+    return process_html_content(html_content)      
+    end
+    
+    def process_html()
+      return process_html_content(File.open(@content_path))
+    end
+    
+    private
+    def process_html_content(source)
+      document_with_skin = @template.process(source) do |message|
+        begin
+          method = @evaluator.method(message)
+          if (method.arity == 0)
+            method.call
+          else
+            method.call(@content_path)
+          end
+        rescue NameError
+          raise TemplateException,
+            "unable to process message: #{message}: #{$!}" ,
+          caller
+      end
+    end
+    return document_with_skin
+  end
+  
+end
+
+end

data/lib/buildmaster/release_control.rb

@@ -0,0 +1,19 @@
+class Release
+  def initialize(vcs_driver, builder)
+    @vcs_driver = vcs_driver
+    @builder = builder
+  end
+  
+  def release_candidate(tag)
+    @vcs_driver.checkout
+    @vcs_driver.tag(tag)
+    @builder.build
+    @vcs_driver.commit
+  end
+  
+  def release_rebuild(tag)
+    @vcs_driver.checkout(tag)
+    @builder.invoke
+  end
+end
+

data/lib/buildmaster/run_ant.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+
+#######################################################################
+=begin
+ runant.rb
+
+    This script is a translation of the runant.pl written by Steve Loughran.
+    It runs ant with/out arguments
+    This script has been tested with ruby1.8.2-14/WinXP
+
+ created:         2005-03-08
+ author:          Shane Duan
+=end 
+
+# Debugging flag
+$debug = true
+
+# Assumptions:
+#
+# - the "java" executable/script is on the command path
+# - ANT_HOME has been set
+# - target platform uses ":" as classpath separator or a "C:" exists (windows)
+# - target platform uses "/" as directory separator.
+
+#######################################################################
+require 'Ant'
+
+if not Ant.new().launch(ARGV)
+  raise 'Ant failed'
+end
+

data/lib/buildmaster/shell_command.rb

@@ -0,0 +1,38 @@
+module Shell
+  private
+  def run(command)
+    if (!system(command))
+      raise "error running command: #{command}"
+    end
+  end
+  
+  def run_command(full_command)
+    if (@command_runner)
+      @command_runner.call(full_command)
+    else
+      run(full_command)
+    end
+  end
+
+  def check_directory(path)
+    raise "#{path} is not a directory" unless File.directory? path    
+    return path
+  end
+  
+  def get_environment(name)
+    value = ENV[name]
+    raise "#{name} is not set" unless value
+    return value
+  end
+  
+  def get_environment_or_default(name, default_value='')
+    value = ENV[name]
+    value = default_value if not value
+    return value
+  end
+
+end
+
+class SystemCommandRunner
+    
+end

data/lib/buildmaster/site.rb

@@ -0,0 +1,147 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'fileutils'
+require 'redcloth'
+require 'webrick'
+require 'source_file_handler'
+require 'file_processor'
+
+module BuildMaster
+#todo match only beginning of the file
+TEXTILE_REGX = /---(-)*\n(.*)\n(-)*---/
+
+  class SiteSpec
+    def self.get_instance
+      self.new()
+    end
+
+    attr_accessor :output_dir, :content_dir, :template, :template_file
+    
+    def validate_inputs
+      validate_dir(@content_dir, :content_dir)
+    end
+    
+    def load_template
+      if (@template)
+        return XTemplate.new(@template)
+      else
+        return XTemplate.new(File.open(@template_file))
+      end
+    end
+    
+    private
+    def validate_dir(directory, symbol)
+      if not directory
+        raise "Directory for #{symbol.id2name} not specified"
+      end
+      if not File.exists? directory
+        raise "Directory for #{symbol.id2name} -- <#{directory}#> does not exist"
+      end
+      if not File.directory? directory
+        raise "<#{directory}> should be a directory for #{symbol.id2name}"
+      end
+    end
+    
+    def validate_file(file, symbol)
+      if not file
+        raise "File for #{symbol.id2name} not specified"
+      end
+      if (not File.exists? file)
+        raise "File for #{symbol.id2name} -- <#{file}> does not exist"
+      end
+      if not File.file? file
+        raise "#<{file} should be a file for #{symbol.id2name}"
+      end
+    end
+  end
+  
+  class Site
+    def initialize(spec)
+      @spec = spec
+      @spec.validate_inputs
+      @template = @spec.load_template
+    end
+    
+    public
+    def execute(arguments)
+      action = 'build'
+      if arguments.size > 0
+        action = arguments[0]
+      end
+      method(action).call
+    end
+    
+    def build
+      @count = 0
+      ensure_directory_exists(@spec.output_dir)
+      build_directory(@spec.output_dir, @spec.content_dir, @template)
+      puts "Generated file count: #{@count}"
+    end
+    
+    def server
+      mime_types = WEBrick::HTTPUtils::DefaultMimeTypes.update(
+        {"textile" => "text/plain"}
+      )
+      server = WEBrick::HTTPServer.new(
+        :Port => 2000,
+        :Logger => WEBrick::Log.new($stdout, WEBrick::Log::INFO),
+        :MimeTypes => mime_types
+      )
+      server.mount('/', SourceFileHandler, @spec)
+      server.mount('/source', WEBrick::HTTPServlet::FileHandler, @spec.content_dir, true)
+      ['INT', 'TERM'].each { |signal|
+         trap(signal){ server.shutdown} 
+      } 
+      server.start
+    end
+    
+    private
+    def ensure_directory_exists(dir_name)
+      if (not File.exist?(dir_name))
+        ensure_directory_exists(File.join(dir_name, '..'))
+        Dir.mkdir dir_name
+      end
+    end
+    
+    def build_directory(out_dir, content_dir, template)
+      Dir.foreach(content_dir) do |item|
+        content_path = File.join(content_dir, item)
+        if (item == '.' || item == '..' || item == '.svn' || item == 'CVS')
+        elsif (File.directory? content_path)
+          build_directory(File.join(out_dir, item), content_path, template)
+        else
+          @current_file_name = content_path
+          process_file(content_path, out_dir, content_dir, item)
+          @count = @count + 1
+        end
+      end
+    end
+    
+    def process_file(content_path, out_dir, content_dir, item)
+      print ">> #{content_path}"
+      extension = File.extname(content_path)
+      isIndex = @current_file_name =~ /^index/
+      file_processor = FileProcessor.new(@template, content_path, @spec)
+      if (extension.casecmp('.textile') == 0)
+        base_name = File.basename(item, extension)
+        output_file = File.join(out_dir, base_name + '.html')
+        write(output_file, file_processor.process_textile())
+      elsif (extension.casecmp('.html') == 0)
+        output_file = File.join(out_dir, item)
+        write(output_file, file_processor.process_html())
+      else
+        output_file = File.join(out_dir, item)
+        puts " ==> #{output_file}"
+        FileUtils.cp content_path, output_file
+      end
+    end
+    
+    def write(target_file, xhtml)
+      puts " ==> #{target_file}"
+      File.open(target_file, "w") do |file|
+        xhtml.write(file, 0, false, true)
+      end
+    end
+    
+  end
+end