ratch 0.3.0 → 0.4.0

data/lib/ratch/dsl/meta.rb

@@ -0,0 +1,132 @@
+# = TITLE:
+#
+#   Metadata / Configuration DSL
+#
+# = COPYING:
+#
+#   Copyright (c) 2007 Psi T Corp.
+#
+#   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
+#   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'
+require 'ratch/support/filename'  # string ?
+require 'ratch/metadata/package'
+require 'ratch/metadata/release'
+
+module Ratch
+module Dsl
+
+  module Meta
+
+    DEFAULT_FOLD = '{,meta/,meta/config/}'
+    DEFAULT_FILE = '{config,meta/config,meta/config/general}{.yaml,.yml,}'
+
+    def package
+      @package ||= Package.load
+    end
+
+    # Roll file information.
+
+    def rollrc
+      @rollrc ||= Release.load
+      #     @rollrc ||= (
+      #       file = Dir.glob('{meta/,}rollrc', File::FNM_CASEFOLD).first
+      #       data = File.read(file).split(/\n/)
+      #       data, *libpath = *data
+      #       name, version, status, date, default, *null = *data.split(/\s+/)
+      #       klass = Struct.new("ROLLRC", :file, :name, :version, :status, :date, :default, :libpath)
+      #       klass.new(file, name, version, status, date, default, libpath)
+      #     )
+    end
+
+    # Load configuration data from a file. The file will
+    # be looked for in the current script directory then
+    # from the project root.
+    #
+    # Since they are YAML files, they can optionally
+    # end with '.yaml' or '.yml'.
+
+    def configuration(file=nil)
+      @configuration ||= {}
+      @configuration[file] ||= (
+        if file = config_file(file)
+          config_read(file)
+        else
+          Hash.new{ |h,k| h[k] = {} }
+        end
+     )
+    end
+
+    # If a +path+ is given it will first be looked for in the config directory of
+    # the utility directory. If not there, then it will be looked for in the project's trunk.
+    #
+    # If +path+ is not given then config.yaml or config/general.yaml will be used.
+    #
+    # TODO: Consider more carfully where configuration should be stored.
+
+    def config_file(path=nil)
+      if path
+        find = DEFAULT_FOLD + "#{path}{.yaml,.yml,}"
+      else
+        find = DEFAULT_FILE
+      end
+      Dir.glob(find, File::FNM_CASEFOLD).find{ |f| File.file?(f) }
+    end
+
+    #
+
+    def config_read(path)
+      #find = "{#{utility_directory}/,}#{path}{.yaml,.yml,}"
+      #if file = Dir.glob(find)[0]
+      if File.file?(path)
+        YAML::load(File.open(path)) || {}  # The || {} is in case the file is empty.
+      else
+        raise LoadError, "Missing file -- #{path}"
+      end
+    end
+
+    # Create an argument vector from a set of config options.
+    # TODO Deprecate in favor of Hash extension.
+
+    def config_vector(config, args_field=nil)
+      config.command_vector(args_field)
+    end
+
+    #     # Load task configuration if any.
+    #
+    #     def config_load(*names) #, defaults=nil)
+    #
+    #       names.inject({}) do |memo, name|
+    #         name     = name.to_s
+    #         #defaults = defaults || {}
+    #
+    #         if file = config_file(name)
+    #           config = YAML.load(File.open(file))
+    #         elsif file = Dir.glob("#{utility_directory}/config{,.yaml,.yml}")[0]
+    #           config = YAML.load(File.open(file))[name.to_s]
+    #         else
+    #           config = {}
+    #         end
+    #
+    #         config.update(memo)
+    #       end
+    #       #return defaults.update(config || {})
+    #     end
+
+  end
+
+end
+end

data/lib/ratch/{batch → dsl}/options.rb

@@ -1,8 +1,8 @@
-# TITLE:
+# = TITLE:
 #
-#   GeneralOptions
+#   Options DSL
 #
-# COPYING:
+# = COPYING:
 #
 #   Copyright (c) 2007 Psi T Corp.
 #
@@ -22,10 +22,11 @@
 #   along with Ratch.  If not, see <http://www.gnu.org/licenses/>.
 
 module Ratch
+module Dsl
 
-  # General Options
+  # Options. There are derived from ARGV.
 
-  module GeneralOptions
+  module Options
 
     # Duplicate of ARGV.
 
@@ -94,3 +95,4 @@ module Ratch
   end
 
 end
+end

data/lib/ratch/dsl/setup.rb

@@ -0,0 +1,124 @@
+# = TITLE:
+#
+#   Setup DSL
+#
+# = SYNOPSIS:
+#
+#   Mixen used to setup a package, eg. a manual install.
+#
+# = 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/>.
+
+#
+module Ratch
+module Dsl
+
+  # = Setup DSL
+  #
+  # Setup utilities provides a convenient way to install
+  # a ruby project via setup.rb.
+
+  module Setup
+
+    # Installation to a prefix destination using setup.rb.
+    # Some package types need this.
+
+    def prefix_install(prefix)
+      mkdir_p(prefix)
+
+      unless setup_rb
+        raise "Setup.rb is missing. Forced to abort."
+      end
+      # mock install
+      cmd = ''
+      cmd << 'ruby setup.rb '
+      cmd << '-q ' unless project.verbose?
+      cmd << 'config --installdirs=std ; '
+      cmd << 'ruby setup.rb '
+      cmd << '-q ' unless project.verbose?
+      cmd << "install --prefix=#{prefix}"
+      sh cmd
+    end
+
+    # If setup.rb is not found add a copy to the project.
+    # FIXME
+
+    def setup_rb
+      unless File.exist?('setup.rb')
+        f = File.join(libdir,'vendor','setup.rb')
+        if File.exist?(f)
+          cp(f,'.')
+        else
+          raise "setup.rb is not avaialble"
+        end
+      end
+      true
+    end
+
+    #     # Setup and install. This builds and installs a project
+    #     # using setup.rb or install.rb. If neither exist setup.rb
+    #     # will be created for the purpose.
+    #     #
+    #     #     options    Command line options to add to shell command.
+    #     #     script     Install script, default is install.rb or setup.rb
+    #     #--
+    #     #     source     Location of source. (Defaults to current directory)
+    #     #++
+    #
+    #     def setup(keys={})
+    #
+    #       options = keys['options']
+    #       script  = keys['script']
+    #       #source = keys.source || Dir.pwd
+    #
+    #       options = [options].flatten.compact
+    #
+    #       if script
+    #         exe = script + ' '
+    #         exe << options.join(' ')
+    #       elsif File.exist?('install.rb')
+    #         exe = 'ruby install.rb '
+    #         exe << options.join(' ')
+    #       elsif File.exist?('setup.rb') or setup_rb
+    #         exe = 'ruby setup.rb '
+    #         exe << '-q ' unless verbose?
+    #         exe << options.join(' ')
+    #         exe << ' all'
+    #       else
+    #         puts "Script setup.rb or install.rb is missing."
+    #         return nil
+    #       end
+    #
+    #       # SHELLS OUT!
+    #
+    #       #Dir.chdir(source) do
+    #         #begin
+    #           success = sh(exe)
+    #           puts "Installation complete!" if success
+    #         #rescue Errno::EACCES
+    #         #  puts "Permission denied"
+    #         #  exit -1
+    #         #end
+    #       #end
+    #     end
+
+  end
+
+end
+end

data/lib/ratch/{support/signiture.rb → dsl/sign.rb}

@@ -1,8 +1,8 @@
-# TITLE:
+# = TITLE:
 #
-#   Sign
+#   Sign DSL
 #
-# COPYING:
+# = COPYING:
 #
 #   Copyright (c) 2007 Psi T Corp.
 #
@@ -21,7 +21,7 @@
 #   You should have received a copy of the GNU General Public License
 #   along with Box.  If not, see <http://www.gnu.org/licenses/>.
 #
-# TODO:
+# = TODO:
 #   - Do signitures belong under data/{name}/?
 #     Heck do all these metadata files belong there?
 #     OTOH using remote require, how would one access these?
@@ -30,22 +30,13 @@
 #require 'autorake/tasks/manifest'
 
 #
-module Box
+module Ratch
+module Dsl
 
   # Create signitures for libraries.
-  #
-  class Sign #< Tool
+  # FIXME
 
-    # Define signiture tasks.
-
-    def task_sign
-
-      desc "Generate file signitures"
-      task :sign do
-        project.sign
-      end
-
-    end
+  module Sign
 
     # Default set of files to sign.
     DEFAULT_SIGN_FILES = ['lib/**/*', 'ext/**/*']
@@ -249,4 +240,4 @@ module Box
   end
 
 end
-
+end

data/lib/ratch/dsl/stage.rb

@@ -0,0 +1,147 @@
+# = TITLE:
+#
+#   Stage DSL
+#
+# = 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/>.
+
+module Ratch
+module Dsl
+
+  # Stage package by hard linking included files to a stage directory.
+
+  module Stage
+
+    # Stage package.
+    #
+    #   stage       Stage directory.
+    #   filelist    Files to link to stage.
+
+    def stage(stage, filelist)
+      stage_link(stage, filelist)
+      stage_manifest(stage)
+      return stage
+    end
+
+    # Prepare stage directory.
+
+    def stage_link(stage_directory, files)
+      return stage_directory if dryrun?           # Don't link to stage if dryrun.
+
+      stage_clear(stage_directory)
+      mkdir_p(stage_directory)                    #dir = File.expand_path(stage)
+
+      #files = package.filelist  #+ [package.manifest_file]
+
+      # 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 stage_clear(stage_directory)
+      if File.directory?(stage_directory)         # Ensure existance of staging area
+        #raise(OverwriteError, stage_directory) unless force?
+        rm_r(stage_directory)
+      end
+    end
+
+    # Create manifest for stage directory.
+    # TODO Do this programatically rather then via shell.
+
+    def stage_manifest(stage_directory)
+      #cd(stage_directory) do
+      #  sh 'manifest up'
+      #end
+    end
+
+  end
+
+end
+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
+#
+#     # Transfer package file to storage dir.
+#
+#     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

data/lib/ratch/dsl/task.rb

@@ -0,0 +1,139 @@
+# = TITLE:
+#
+#   Task DSL
+#
+# = 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/>.
+
+module Ratch
+module Dsl
+
+  module Tasks
+
+    # Define main task.
+
+    def main(name, &block)
+      name, deps, block = *parse_task_dependencies(name, &block)
+      define_main(name, *deps, &block)
+    end
+
+    # Define a task.
+
+    def task(name, &block)
+      name, deps, block = *parse_task_dependencies(name, &block)
+      define_task(name, *deps, &block)
+    end
+
+    # Run a task.
+
+    def run(name, arguments=nil)
+      task_plan(name).each{ |name| tasks[name].call }
+    end
+
+    private
+
+      def tasks ; @tasks ||= {} ; end
+
+      def main_task ; @main ; end
+
+      #
+
+      def parse_task_dependencies(name_deps, &block)
+        if Hash===name_deps
+          name = name_deps.keys[0]
+          deps = name_deps.values[0]
+        else
+          name = name_deps
+          deps = []
+        end
+        [name, deps, block]
+      end
+
+      def define_main(name=nil, *depend, &block)
+        @main = define_task(name, *depend, &block)
+        #@main = Task.new(name, *depend, &block)
+        #tasks[@main.name] = @main
+      end
+
+      def define_task(name, *depend, &block)
+        task = Task.new(name, *depend, &block)
+        tasks[task.name] = task
+      end
+
+      # Call main task.
+      #--
+      # TODO If @main is nil try task by same name a file (?)
+      #      If so, be careful of infinite loop via method_missing.
+      #++
+
+      def run_main
+        return unless main_task
+        run(main_task.name)
+      end
+
+      # Prepare plan, checking for circular dependencies.
+
+      def task_plan(name, list=[])
+        if list.include?(name)
+          raise "Circular dependency #{name}."
+        end
+        if task = tasks[name]
+          task.needs.each do |need|
+            need = need.to_s
+            next if list.include?(need)
+            #@tasks[need].task_plan(need, list)
+            task_plan(need, list)
+          end
+          list << task.name
+        else
+          # TODO THIS TIES TASKS INTO BATCH, BETTER WAY?
+          if name != main_task && fname = batch?(name)
+            task = Task.new(name) do
+              batch(fname)
+            end
+            tasks[name] = task
+            list << task.name
+          else
+            abort "no task -- #{name}"
+          end
+        end
+        return list
+      end
+
+  end
+
+  # Task is a very simple store for defined actions
+  # and their prerequisites.
+
+  class Task
+    attr_reader :name, :needs, :action
+
+    def initialize(name, *needs, &action)
+      @name          = name.to_s
+      @needs         = needs
+      @action        = action
+    end
+
+    def call
+      @action.call if @action
+    end
+  end
+
+end
+end

data/lib/ratch/{uploadutils.rb → dsl/upload.rb}

@@ -1,8 +1,8 @@
-# TITLE:
+# = TITLE:
 #
-#   UploadUtils
+#   Upload DSL
 #
-# COPYING:
+# = COPYING:
 #
 #   Copyright (c) 2007 Psi T Corp.
 #
@@ -21,7 +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/>.
 #
-# TODO:
+# = TODO:
 #
 #   - Incorporate password into scp and ftp ?
 #   - rsync needs --delete option
@@ -33,6 +33,7 @@ require 'tmpdir'
 require 'facets/openobject'
 
 module Ratch
+module Dsl
 
   # Upload files to host. These means of uploading are current
   # supported: ftp, sftp, scp and rsync.
@@ -66,7 +67,7 @@ module Ratch
   # The internal template used for the outbound destination
   # is 'username@host:root/'.
 
-  module UploadUtils
+  module Upload
 
     module_function
 
@@ -309,6 +310,7 @@ module Ratch
   end
 
 end
+end
 
 
 =begin