ratch 0.2.3 → 0.3.0

data/lib/ratch/support/stage.rb

@@ -0,0 +1,292 @@
+# = TITLE:
+#
+#   Build
+#
+# = COPYING:
+#
+#   Copyright (c) 2007 Psi T Corp.
+#
+#   This file is part of the ProUtils' Box program.
+#
+#   Box is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   Box is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with Box.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'fileutils'
+require 'facets/string/lchomp'
+require 'facets/hash/rekey'
+require 'facets/hash/slice'
+
+require 'box/buildutils'
+
+module Box
+
+  # Error when attempting to overwrite prexisting package.
+  # Presently this is triggered by the existance of the stage
+  # directory, not any specific package file.
+
+  class OverwriteError < Exception
+  end
+
+  # Build packages for a given platform. It servers as the basis
+  # of all package building for Box. It does this by first staging
+  # the package, ie. hard linking it to the store location,
+  # then it generates each package format from it.
+
+  class Build
+
+    include BuildUtils
+
+    attr_reader :location
+
+    attr_reader :project
+
+    attr_reader :release
+
+    #attr_reader :build
+
+    # General options. These are parsed and then passed on to the per-format builders.
+    # TODO: Fully enforce the dryrun and force options.
+    attr_reader :options
+
+    # Whether to include all files, not just manifests.
+    #attr_reader :all
+
+    # New package builder.
+    #
+    # INPUT:
+    #   location       Project location
+    #   project        Project metadata
+    #   release        Release metadata, eg. version number.
+    #   build          Build data hash. This generally differs b/c of platform binary builds.
+    #   options        Overrides and runtime options.
+    #
+    # Options can be
+    #   types/formats  Override build specified types
+    #   store          Override build specified store
+    #   force          Force build (overwrite old build of same name)
+    #   dryrun         Dry-run mode (NOT YET FULLY ENFORCED!)
+
+    def initialize(location, project, release, build, options={})
+      @location = location
+
+      # per-build project
+      project = project.clone
+      project.update(build)
+
+      @project = project
+      @release = release
+      @options = options
+
+      assert_valid
+    end
+
+    #
+
+    def assert_valid
+      raise "missing location" unless location
+      raise "missing project"  unless project
+      raise "missing release"  unless release
+    end
+
+    #
+
+    def package
+      @package ||= (
+        package = project.instance_data
+        #package.update(build)
+        package[:release]  = release
+        package[:filelist] = project.filelist
+        #package.rekey!
+        Package.new(location, package)
+      )
+    end
+
+    # Force otherwise protected operations.
+
+    def force?  ; @options[:force]  ; end
+
+    # Dryrun mode? (NOT FULLY ENFORCED YET)
+
+    def dryrun? ; @options[:dryrun] ; end
+
+    # Which package formats to create.
+
+    def formats
+      @formats ||= (
+        [project.formats].flatten.collect{ |f| f.to_s.downcase.lchomp('.') }
+      )
+    end
+
+    # Where to store the created package(s).
+
+    def store
+      @project.store
+    end
+
+#     # Template for stage directory name. Defaults to "%s-%s" for name-version or
+#     # "%s-%s-%s for name-version-platform."
+#     #
+#     def stage_name
+#       #@stage_name ||= project.stage_name
+#     end
+
+    # Where to stage the build.
+
+    def stage_directory
+      @stage_directory ||= File.join(store, stage_name)
+    end
+
+    # Create package(s).
+
+    def generate
+      generate_extensions
+      generate_stage
+      generate_manifest
+      generate_packages
+    end
+
+    # Compile binary extensions -- shell out to compile script if given.
+    # This is used when creating binary packages.
+
+    def generate_extensions
+      compile = project.compile
+      return unless compile
+      #begin
+        sh compile
+      #rescue
+      #end
+    end
+
+    # Prepare stage.
+
+    def generate_stage
+      return stage_directory if dryrun?           # Don't link to stage if dryrun.
+
+      clear_stage
+      mkdir_p(stage_directory)                    #dir = File.expand_path(stage)
+
+      # TODO Dryrun test here or before folder creation?
+      files.each do |f|                 # Link files into staging area.
+        file = File.join(stage_directory, f)
+        if File.directory?(f)
+          mkdir_p(file)
+        else
+          unless File.exist?(file) and File.mtime(file) >= File.mtime(f)
+            ln(f, file) #safe_ln ?
+          end
+        end
+      end
+      return stage_directory
+    end
+
+    # Clear old stage, if any.
+
+    def clear_stage
+      if File.directory?(stage_directory)         # Ensure existance of staging area
+        raise(OverwriteError, stage_directory) unless force?
+        rm_r(stage_directory)
+      end
+    end
+
+    # TODO Build manifest
+
+    def generate_manifest
+    end
+
+    # Build packages.
+    # TODO Move this to Manager ?
+
+    def generate_packages
+      package_files = formats.collect do |format|
+        #format = clean_type(format)
+        say '' if format == 'gem'  # FIXME This is here b/c Gems outputs on it's own.
+        file = create_package(format)
+        unless dryrun? or (format == 'gem')
+          report_package_built(format, file) if file
+        end
+        file
+      end
+      report_packaging_complete(package_files.size)
+    end
+
+    # Create package.
+
+    def create_package(type)
+      package.format = type
+
+      builder_class = FormatBuilder.registry[type]
+      builder = builder_class.new(package, stage_directory, options)
+      file    = builder.build
+
+      transfer(file) unless dryrun?
+
+      return file
+    end
+
+    # Stage name.
+
+    def stage_name
+      name     = package.name
+p name
+      version  = package.version
+      platform = package.platform #arch
+      buildno  = package.buildno
+
+      if project.stage
+        template = project.stage
+      else
+        template = platform ? "%s-%s-%s" : "%s-%s"
+      end
+
+      if buildno  # TODO Make this better.
+        buildno = Time.now.strftime("%H*60+%M")
+        version = "#{version}.#{buildno}"
+      end
+
+      template % [ name, version, platform ]
+    end
+
+    # Files to be included in package.
+
+    def files
+      project.filelist #+ [package.manifest_file]
+    end
+
+    # Transfer package file to storage location.
+
+    def transfer(file)
+      dest = File.join(store, File.basename(file))    # move to store, unless already there
+      dest = File.expand_path(dest)
+      mv(file, store) unless file == dest
+    end
+
+    # Report that a package has been built.
+
+    def report_package_built(type, file)
+      r = ''
+      r << "\n  Successfully built #{type}"
+      r << "\n  Name: #{package.name}"
+      r << "\n  Version: #{package.version}"
+      r << "\n  File: #{File.basename(file)}"
+      say r
+    end
+
+    # Report that packaging is complete.
+
+    def report_packaging_complete(size)
+      say "\nSuccessfully built #{size} packages at #{store}/."
+    end
+
+  end
+
+end

data/lib/ratch/toolset/ruby/pack/gem

@@ -0,0 +1,85 @@
+#!/usr/bin/env ratch
+
+# generate gem package
+
+begin
+  require 'rubygems/specification'
+  Gem::manage_gems
+rescue LoadError
+  raise LoadError, "RubyGems is not installed?"
+end
+
+require 'ratch/project/package'
+
+#
+
+main 'pack/gem' do
+  # load config (TODO)
+  #source  = Dir.pwd
+  store   = 'pkg'
+  package = Ratch::Package.load
+  #status "Creating RubyGem(s)"
+  file = nil
+  #cd(source) do
+    #status "vi #{metadata.name}.gemspec"
+    builder = ::Gem::Builder.new(gemspec(package))
+    #status "gem build #{package.name}"
+    unless dryrun?
+      file = builder.build
+      file = File.expand_path(file)
+    end
+  #end
+  transfer(file, store)
+end
+
+# Create Gem::Specification.
+
+def gemspec(package)
+  distribute = package.filelist
+  #distribute = Dir.multiglob_with_default( '**/*', distribute )
+
+  ::Gem::Specification.new do |spec|
+    spec.name              = package.name
+    spec.version           = package.version
+    spec.summary           = package.brief
+    spec.description       = package.description
+    spec.author            = package.author
+    spec.email             = package.email
+    spec.rubyforge_project = package.development if /rubyforge.org/ =~ package.development
+    spec.homepage          = package.homepage
+
+    # Platform: ruby, mswin32, i586-linux, powerpc-darwin, current
+    spec.platform = 'ruby'  # TODO current support!
+
+    spec.require_paths = [package.gem_path].flatten.reverse
+
+    #if package.platform != 'ruby'
+    #  spec.require_paths.concat(spec.require_paths.collect{ |d| File.join(d, platform) })
+    #end
+
+    spec.bindir = "bin"
+    spec.executables  = package.executables
+    spec.requirements = package.requirements
+    spec.has_rdoc     = package.document
+
+    if package.dependencies
+      package.dependencies.each do |d,v|
+        spec.add_dependency(*[d,v].compact)
+      end
+    end
+
+    spec.extensions = package.compile
+
+    spec.files = distribute
+
+    spec.test_files = distribute.select{ |f| f =~ /^test\// }  # TODO make test_files configurable
+  end
+end
+
+# Transfer package file to storage location.
+
+def transfer(file, store)
+  dest = File.join(store, File.basename(file))    # move to store, unless already there
+  dest = File.expand_path(dest)
+  mv(file, store) unless file == dest
+end

data/lib/ratch/toolset/ruby/pack/tgz

@@ -0,0 +1,85 @@
+#!/usr/bin/env ratch
+
+# generate gem package
+
+begin
+  require 'rubygems/specification'
+  Gem::manage_gems
+rescue LoadError
+  raise LoadError, "RubyGems is not installed?"
+end
+
+require 'ratch/project/package'
+
+#
+
+main 'pack/gem' do
+  # load config (TODO)
+  #source  = Dir.pwd
+  store   = 'pkg'
+  package = Ratch::Package.load
+  #status "Creating RubyGem(s)"
+  file = nil
+  #cd(source) do
+    #status "vi #{metadata.name}.gemspec"
+    builder = ::Gem::Builder.new(gemspec(package))
+    #status "gem build #{package.name}"
+    unless dryrun?
+      file = builder.build
+      file = File.expand_path(file)
+    end
+  #end
+  transfer(file, store)
+end
+
+# Create Gem::Specification.
+
+def gemspec(package)
+  distribute = package.filelist
+  #distribute = Dir.multiglob_with_default( '**/*', distribute )
+
+  ::Gem::Specification.new do |spec|
+    spec.name              = package.name
+    spec.version           = package.version
+    spec.summary           = package.brief
+    spec.description       = package.description
+    spec.author            = package.author
+    spec.email             = package.email
+    spec.rubyforge_project = package.development if /rubyforge.org/ =~ package.development
+    spec.homepage          = package.homepage
+
+    # Platform: ruby, mswin32, i586-linux, powerpc-darwin, current
+    spec.platform = 'ruby'  # TODO current support!
+
+    spec.require_paths = [package.gem_path].flatten.reverse
+
+    #if package.platform != 'ruby'
+    #  spec.require_paths.concat(spec.require_paths.collect{ |d| File.join(d, platform) })
+    #end
+
+    spec.bindir = "bin"
+    spec.executables  = package.executables
+    spec.requirements = package.requirements
+    spec.has_rdoc     = package.document
+
+    if package.dependencies
+      package.dependencies.each do |d,v|
+        spec.add_dependency(*[d,v].compact)
+      end
+    end
+
+    spec.extensions = package.compile
+
+    spec.files = distribute
+
+    spec.test_files = distribute.select{ |f| f =~ /^test\// }  # TODO make test_files configurable
+  end
+end
+
+# Transfer package file to storage location.
+
+def transfer(file, store)
+  dest = File.join(store, File.basename(file))    # move to store, unless already there
+  dest = File.expand_path(dest)
+  mv(file, store) unless file == dest
+end