ratch 0.3.0 → 0.4.0

data/lib/ratch/{batch/task.rb → dsl/zip.rb}

@@ -1,12 +1,12 @@
-# TITLE:
+# = TITLE:
 #
-#   Task
+#   Zip DSL
 #
-# COPYING:
+# = COPYING:
 #
 #   Copyright (c) 2007 Psi T Corp.
 #
-#   This file is part of the ProUtils' Ratch program.
+#   This file is part of the Ratch program.
 #
 #   Ratch is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -21,23 +21,39 @@
 #   You should have received a copy of the GNU General Public License
 #   along with Ratch.  If not, see <http://www.gnu.org/licenses/>.
 
+require 'facets/ziputils'
+
 module Ratch
+module Dsl
+
+  module Zip
+
+    #
+
+    def zip(folder, file=nil, options={})
+      ziputils.zip(folder, file, options)
+    end
 
-  # Task is a very simple store for the defined
-  # actions and it's prerequisites.
+    #
 
-  class Task
-    attr_reader :name, :needs, :action
+    def tar_bzip(folder, file=nil, options={})
+      ziputils.tar_bzip(folder, file, options)
+    end
+
+    #
 
-    def initialize(name, *needs, &action)
-      @name          = name.to_s
-      @needs         = needs
-      @action        = action
+    def tar_gzip(folder, file=nil, options={})
+      ziputils.tar_gzip(folder, file, options)
     end
+    alias_method :tgz, :tar_gzip
+
+    # Delegate access to ZipUtils.
 
-    def call
-      @action.call if @action
+    def ziputils
+      dryrun? ? ::ZipUtils::DryRun : ::ZipUtils
     end
+
   end
 
 end
+end

data/lib/ratch/dsl.rb

@@ -0,0 +1,52 @@
+# = TITLE:
+#
+#   Main DSL Loader
+#
+# = COPYING:
+#
+#   Copyright (c) 2007 Psi T Corp.
+#
+#   This file is part of the ProUtils' Ratch program.
+#
+#   Ratch 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.
+#
+#   Ratch 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 Ratch.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'yaml'      # make it generally available
+require 'rbconfig'  # replace with facets/system?
+
+require 'ratch/dsl/options'
+require 'ratch/dsl/batch'
+require 'ratch/dsl/build'
+require 'ratch/dsl/task'
+require 'ratch/dsl/console'
+require 'ratch/dsl/file'
+require 'ratch/dsl/argv'
+require 'ratch/dsl/meta'
+
+# Load ratch dsl functionality into toplevel.
+# This loads into the toplevel's metaclass b/c we don't want
+# all these utilies to invade every object [do we?]
+
+class << self
+  include Ratch::Dsl::Options
+  include Ratch::Dsl::Batch
+  include Ratch::Dsl::Builds
+  include Ratch::Dsl::Tasks
+  include Ratch::Dsl::Filing
+  include Ratch::Dsl::Console
+  include Ratch::Dsl::Argv
+  include Ratch::Dsl::Meta
+end
+
+# run main task
+END { run_main }

data/lib/ratch/extra/email.rb

@@ -0,0 +1,5 @@
+require 'ratch/dsl/email'
+
+class << self
+  include Ratch::Dsl::Email
+end

data/lib/ratch/extra/stage.rb

@@ -0,0 +1,5 @@
+require 'ratch/dsl/stage'
+
+class << self
+  include Ratch::Dsl::Stage
+end

data/lib/ratch/extra/zip.rb

@@ -0,0 +1,5 @@
+require 'ratch/dsl/zip'
+
+class << self
+  include Ratch::Dsl::Zip
+end

data/lib/ratch/manifest.rb

@@ -0,0 +1,540 @@
+# = TITLE:
+#
+#   Manifest
+#
+# = SYNOPSIS:
+#
+#   Generate manifest/digest list. Usefule for including in package distributions.
+#
+# = COPYING:
+#
+#   Copyright (c) 2007 Psi T Corp.
+#
+#   This file is part of the ProUtils' Ratch program.
+#
+#   Ratch 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.
+#
+#   Ratch 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 Ratch.  If not, see <http://www.gnu.org/licenses/>.
+#
+# = TODO:
+#   - Integrate file signing and general manifest better (?)
+#   - Digester is in sign.rb too. Dry-up?
+#   - Is it problematic to add a digest to the manifest?
+#   - This needs some TLC. Eg. diff is shelling out, but it would
+#     be better if internalized.
+#   - Could just use some over all belt tightening.
+
+require 'fileutils'
+require 'getoptlong'
+require 'shellwords'
+
+require 'facets/dir/multiglob'    # for Dir.multiglob_r
+require 'facets/file/read'       # for File.read_list
+
+module Ratch
+
+  # Manifest file overwrite error.
+  #
+  class OverwriteError < Exception
+  end
+
+  # No Manifest File Error.
+  #
+  class NoManifestError < LoadError
+  end
+
+  # Manifest stores a list of package files, and optionally checksums.
+  #
+  # The class can be used to create and compare package manifests.
+
+  class Manifest
+
+    DEFAULT_EXCLUDE = %w{ InstalledFiles .config *~ CVS _darcs .svn .git }
+    DEFAULT_FILE    = '{,meta/}manifest{,.txt,.list}'
+
+    # Possible file name (was for Fileable?).
+    def self.filename
+      DEFAULT_FILE
+    end
+
+    def self.open(file=nil, options={})
+      unless file
+        file = Dir.glob(filename, File::FNM_CASEFOLD).first
+        raise LoadError, "Manifest file is required." unless file
+      end
+      options.update(:file => file)
+      self.new(options)
+    end
+
+    # File used to store digest/manifest.
+
+    attr_accessor :file
+
+    # Encryption type
+
+    attr_accessor :digest
+
+    # Do not exclude standard exclusions.
+
+    attr_accessor :all
+    alias_method :all?, :all
+
+    # What files to exclude from digest.
+
+    attr_accessor :exclude
+    alias_method :ignore, :exclude
+
+    # Directory to use.
+
+    attr_accessor :directory
+
+    # Layout of digest -- csf or sfv. Default is csf.
+
+    attr_accessor :format
+
+    # Files and checksums listed in file.
+
+    attr_reader :list
+
+    # New Digest object.
+
+    def initialize(options={})
+      @exclude = []
+
+      change_options(options)
+
+      if @file
+        read(@file)
+      #else
+        #if file = Dir.glob(self.class.filename)[0]
+        #  @file = file
+        #else
+      #    @file = DEFAULT_FILE
+        #end
+      end
+    end
+
+    # Set options.
+
+    def change_options(opts)
+      opts.each do |k,v|
+        k = k.to_s.downcase
+        send("#{k}=",v||send(k))
+      end
+      #@file       = options[:file]    || @file
+      #@digest     = options[:digest]  || @digest
+      #@all        = options[:all]     || @all
+      #@exclude    = options[:exclude] || options[:ignore] || @exclude
+      #@exclude    = [@exclude].flatten.compact
+    end
+
+    #
+
+    def file?
+      @read_from_file
+    end
+
+    # Create a digest/manifest file. This saves the list of files
+    # and optionally their checksum.
+
+    #def create(options=nil)
+    #  change_options(options) if options
+    #  #@file ||= DEFAULT_FILE
+    #  raise OverwriteError if FileTest.file?(file)
+    #  save #(false)
+    #end
+
+    # Update file.
+
+    def update(options=nil)
+      change_options(options) if options
+      raise NoManifestError unless file and FileTest.file?(file)
+      save
+    end
+
+    # Save as file.
+
+    def save(options=nil)
+      change_options(options) if options
+      File.open(file, 'w') do |file|
+        file << topline_string
+        output(file)
+      end
+      return file
+    end
+
+    # Diff file against actual files.
+
+    def diff
+      raise NoManifestError unless file and FileTest.file?(file)
+      manifest = create_temporary_manifest
+      begin
+        result = `diff -du #{file} #{manifest.file}`
+      ensure
+        FileUtils.rm(manifest.file)
+      end
+      # pass = result.empty?
+      return result
+    end
+
+    # Files listed in manifest, but not found.
+
+    def whatsold
+      #raise ManifestMissing unless file
+      filelist - files
+    end
+
+    # Files found, but not listed in manifest.
+
+    def whatsnew
+      #raise ManifestMissing unless file
+      files - (filelist + [filename])
+    end
+
+    # Clean non-manifest files.
+
+    def clean
+      cfiles, cdirs = clean_files.partition{ |f| !File.directory?(f) }
+      FileUtils.rm(cfiles)
+      FileUtils.rmdir(cdirs)
+    end
+
+    #
+
+    def clean_files
+      keep = Dir.glob('*').select{|f| File.directory?(f)}
+      keep << filename # keep manifest
+      Dir.glob('**/*') - (files + keep)
+    end
+
+    #     # Clobber non-manifest files.
+    #     #
+    #     def clobber
+    #       clobber_files.each{ |f| rm_r(f) if File.exist?(f) }
+    #     end
+    #
+    #     #--
+    #     # TODO Should clobber work off the manifest file itself?
+    #     #++
+    #     def clobber_files
+    #       keep = filelist # + [info.manifest]
+    #       Dir.glob('**/*') - keep
+    #     end
+
+    # File's name.
+
+    def filename
+      File.basename(file)
+    end
+
+    # File's location.
+
+    def location
+      #if directory
+      #  directory
+      #if file
+      #  File.dirname(file)
+      #else
+        @location = @directory || Dir.pwd
+      #end
+    end
+
+    # List of files as given in the file.
+
+    def filelist
+      list.keys.sort
+    end
+
+    # Generate manifest.
+
+    def generate(out=$stdout)
+      out << topline_string
+      output(out)
+    end
+
+    #
+
+    def output(out=$stdout)
+      Dir.chdir(location) do
+        rec_output('*', out)
+      end
+    end
+
+    # Generate listing on the fly.
+
+    def rec_output(match, out=$stdout)
+      out.flush
+      #match = (location == dir ? '*' : File.join(dir,'*'))
+      files = Dir.glob(match) - exclusions
+      files.sort!
+      files.each do |file|
+        sum = checksum(file,digest)
+        sum = sum + ' ' if sum
+        out << "#{sum}#{file}\n"
+        if File.directory?(file)
+          rec_output(File.join(file,'*'), out)
+        end
+      end
+      #return out
+    end
+    private :rec_output
+
+
+    # List files in package.
+
+    def files #(update=false)
+      #remove = (update ? (exclude + topline.exclude) : exclude)
+      #remove = exclude
+      #remove += DEFAULT_EXCLUDE unless all?
+      #remove += [filename, filename.chomp('~')]
+
+      files = []
+      Dir.chdir(location) do
+        files += Dir.multiglob_r('**/*')
+        files -= Dir.multiglob_r(exclusions)
+      end
+      return files
+    end
+
+    # Compute exclusions.
+
+    def exclusions
+      @_exclusions ||= (
+        e = exclude
+        e += DEFAULT_EXCLUDE unless all?
+        e += [filename, filename.chomp('~')] if file
+        e
+      )
+    end
+
+    # List of files in package, but omit folders.
+
+    def files_without_folders
+      files.select{ |f| !File.directory?(f) }
+    end
+
+    # Produce textual listing less the manifest file.
+
+    def listing
+      str = ''
+      output(str)
+      str
+
+#       #crypt = (update ? (digest || topline.digest) : digest)
+#       crypt = digest
+#
+#       list = files #(update) #- [filename, filename.chomp('~')]
+#       list.sort!
+#       list.collect!{ |file| [checksum(file,crypt), file] }
+#       list.collect!{ |file| file.compact.join(' ') }
+#       list.join("\n") + "\n"
+    end
+
+    # File content.
+
+    def to_s #(update=false)
+      topline_string + listing #(update) + listing(update)
+    end
+
+  private
+
+    # Create temporary manifest (for comparison).
+
+    def create_temporary_manifest
+      temp_manifest = Manifest.new
+      temp_manifest.save(
+        :file    => file+"~",
+        :digest  => digest,
+        :exclude => exclude,
+        :all     => all
+      )
+      #File.open(tempfile, 'w+') do |f|
+      #  f << to_s(true)
+      #end
+      return temp_manifest
+    end
+
+    # Produce hexdigest/cheksum for a file.
+    # Default digest type is sha1.
+
+    def checksum(file, digest=nil)
+      return nil unless digest
+      if FileTest.directory?(file)
+        @null_string ||= digester(digest).hexdigest("")
+      else
+        digester(digest).hexdigest(File.read(file))
+      end
+    end
+
+    # Return a digest class for given +type+.
+    # Supported digests are:
+    #
+    # * md5
+    # * sha1
+    # * sha128  (same as sha1)
+    # * sha256
+    # * sha512
+    #
+    # Default digest type is sha256.
+
+    def digester(type=nil)
+      require 'openssl'
+      case type.to_s.downcase
+      when 'md5'
+        require 'digest/md5'
+        ::Digest::MD5
+      when 'sha128', 'sha1'
+        require 'digest/sha1'  #need?
+        OpenSSL::Digest::SHA1
+      when 'sha256'
+        require 'digest/sha1'  #need?
+        OpenSSL::Digest::SHA256
+      when 'sha512'
+        require 'digest/sha1'  #need?
+        OpenSSL::Digest::SHA512
+      else
+        raise "unsupported digest #{type}"
+      end
+    end
+
+    # Read manifest file.
+
+    def read(file)
+      @file = file
+      #@location = File.dirname(File.expand_path(file))
+
+      l = {}
+      flist = File.read_list(file)
+      flist.each do |line|
+        left, right = line.split(/\s+/)
+        if right
+          checksum = left
+          filename = right
+          l[filename] = checksum
+        else
+          filename = left
+          l[filename] = nil
+        end
+      end
+
+      a, d, x = *topline_parse
+
+      @list    = l
+      @all     = a
+      @digest  = d
+      @exclude = x
+
+      @read_from_file = file
+    end
+
+    # Get topline of Manifest file, parse and cache.
+    #def topline
+    #  @topline ||= topline_parse
+    #end
+
+    #TOPLINE_ARITY = {:x=>1, :exclude=>1, :g=>1, :digest=>1}
+
+    #
+    def topline_parse
+      if line = read_topline
+        argv = Shellwords.shellwords(line)
+        ARGV.replace(argv)
+        opts = GetoptLong.new(
+            [ '-g', '--digest' ,             GetoptLong::REQUIRED_ARGUMENT ],
+            [ '-x', '--exclude', '--ignore', GetoptLong::REQUIRED_ARGUMENT ],
+            [ '-a', '--all'    ,             GetoptLong::NO_ARGUMENT ]
+        )
+        a, d, x = false, nil, []
+        opts.each do |opt, arg|
+          case opt
+          when '-g': d = arg.downcase
+          when '-a': a = true
+          when '-x': x << arg
+          end
+        end
+        return a, d, x
+      end
+    end
+
+    #
+    def read_topline
+      r = nil
+      #if file = locate(filename)
+        File.open(file) do |f|
+          s = f.readline
+          if s =~ /^#\s*(.*?)\n/
+            r = $1
+          end
+        end
+        return r
+      #end
+    end
+
+    # Create topline of MANIFEST file.
+    #
+    def topline_string(update=false)
+      if update
+        a = all #|| topline.all
+        d = digest #|| topline.digest
+        x = exclude #+ topline.exclude
+      else
+        a, d, x = all, digest, exclude
+      end
+      top = []
+      top << "-a" if a
+      top << "-g #{d.to_s.downcase}" if d
+      x.each do |e|
+        top << "-x #{e}"
+      end
+      return "# #{top.join(' ')}\n"
+    end
+
+  end
+
+end
+
+
+
+=begin
+    #
+    def manifest_file
+      apply_naming_policy(@file || DEFAULT_FILE, 'txt')
+    end
+
+  private
+
+    # Apply naming policy.
+    #
+    def apply_naming_policy(name, ext)
+      return name unless policy
+      policies = naming_policy.split(' ')
+      policies.each do |polic|
+        case polic
+        when 'downcase'
+          name = name.downcase
+        when 'upcase'
+          name = name.upcase
+        when 'capitalize'
+          name = name.capitalize
+        when 'extension'
+          name = name + ".#{ext}"
+        when 'plain'
+          name = name.chomp(File.extname(name))
+        else
+          name
+        end
+      end
+      return name
+    end
+=end
+
+#end # module Ratchets

data/lib/ratch/{project → metadata}/information.rb

@@ -21,6 +21,7 @@
 #   You should have received a copy of the GNU General Public License
 #   along with Ratch.  If not, see <http://www.gnu.org/licenses/>.
 
+require 'yaml'
 require 'facets/hash/rekey'