ratch 0.2.2 → 0.2.3

data/lib/ratch/buildable.rb

@@ -1,3 +1,26 @@
+# TITLE:
+#
+#   Buildable
+#
+# 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
 
   # = Buildable mixin
@@ -6,24 +29,24 @@ module Ratch
 
     # Reference task manager.
     def build_manager
-      @build_manager ||= BuildManager.new
+      @build_manager ||= BuildManager.new(self)
     end
 
     # Define a build target.
     def file(name, &block)
       name, deps, block = *parse_build_dependencies(name, &block)
-      @build_manager.define_file(name, *deps, &block)
+      build_manager.define_file(name, *deps, &block)
     end
 
     # Build a file.
     def build(file)
-      @build_manager.call(file)
+      build_manager.call(file)
     end
 
     private
 
       #
-      def parse_build_dependencies
+      def parse_build_dependencies(name_deps, &block)
         if Hash===name_deps
           name = name_deps.keys[0]
           deps = name_deps.values[0]
@@ -31,7 +54,7 @@ module Ratch
           name = name_deps
           deps = []
         end
-        [name, *deps, &block]
+        [name, deps, block]
       end
   end
 
@@ -40,33 +63,55 @@ module Ratch
   class BuildManager
     attr :builds
 
-    def initialize
-      @builds = {}
+    def initialize(runspace)
+      @runspace = runspace
+      @builds = []
     end
 
+    def force? ; @runspace.force? ; end
+
+    # Define a file build task.
     def define_file(name, *depend, &block)
       build = Build.new(name, *depend, &block)
-      builds[build.name] = task
+      builds << build
     end
 
-    #
-    def call(file)
-      plan.each{ |name| @@tasks[name].action_call }
-      #action_call
+    # Call build.
+    def call(path)
+      # TODO How to handle more than one matching means of building?
+      #warn "More than one build definition matches #{path} using #{means.first}" if means.size > 1
+      if build = find(path)
+        if build.needed_for?(path) || force?
+          list, todo = *plan(build, path)
+          todo.each{|bld, pth| bld.call(pth) } #@builds[name].call }
+          build.call(path)
+        end
+      else
+        raise
+      end
     end
 
-    # TODO Check for circular dependencies.
-    def plan(list=[])
-      if list.include?(name)
-        raise "Circular dependency #{name}."
-      end
-      @preqs.each do |need|
-        need = need.to_s
-        next if list.include?(need)
-        @@tasks[need].plan(list)
+    def find(path)
+      builds.find{ |b| b.match?(path) }
+    end
+
+    # Prepare plan, checking for circular dependencies.
+    def plan(build, path, list=[], todo=[])
+      #if list.include?(build)
+      #  raise "Circular build dependency #{build.name}."
+      #end
+
+      build.needed_paths.each do |npath|
+        next if list.include?(npath)
+        if nbuild = find(npath)
+          plan(nbuild, npath, list, todo)
+          todo << [nbuild, npath]
+        else
+          list << npath
+        end
       end
-      list << name
-      return list
+
+      return list, todo
     end
 
   end
@@ -75,33 +120,63 @@ module Ratch
   #
   class Build
 
-    attr :name
-    attr :preqs
+    attr :match
+    attr :needs
     attr :action
 
-    #
-    def initialize(name, *preqs, &action)
-      @name          = name.to_s
-      @preqs         = preqs
+    alias_method :name, :match
+
+    # Create a new build definition.
+
+    def initialize(match, *needs, &action)
+      @match         = match
+      @needs         = needs
       @action        = action
     end
 
-    #
-    def call
-      files = Dir.glob(@name)
-      files.each do |name|
-        if File.exist?(name)
-          mtime = File.mtime(name)
-          needs = @preqs.find do |file| 
-            !File.exist?(file) || File.mtime(file) > mtime
-          end
-        else
-          needs = true
+    # Call this build process for the given path.
+
+    def call(path)
+      if File.exist?(path)
+        mtime = File.mtime(path)
+        dated = needs.find do |file|
+          !File.exist?(file) || File.mtime(file) > mtime
         end
-        @action.call(@name) if needs
+      else
+        dated = true
+      end
+      action.call(path) if dated
+    end
+
+    # Does a file match this build definition?
+
+    def match?(path)
+      case match
+      when String
+        File.fnmatch(match, path)
+      when Regexp
+        match =~ path
+      else
+        false        # ???
       end
     end
 
+    # Is this build needed to update/create path?
+
+    def needed_for?(path)
+      return true unless File.exist?(path)
+      mtimes = needed_paths.collect{|f| File.mtime(f)}
+      mtimes.max > File.mtime(path)
+    end
+
+    # Glob expanded needs.
+
+    def needed_paths
+      #exact = needs.select{|n| File.fnmatch?(n,n)} +
+      exact = needs.select{|n| n !~ /[\[*?]/ }
+      globs = needs.collect{|n| Dir.glob(n)}.flatten
+      (exact + globs).uniq
+    end
+
   end
 end
-

data/lib/ratch/configutils.rb

@@ -1,11 +1,38 @@
+# TITLE:
+#
+#   ConfigUtils
+#
+# 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 ConfigUtils
 
-    DEFAULT_CONFIG_FILE = 'config'
+    #DEFAULT_CONFIG_FILE = '{config, config/general}'
 
+    # 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 ||= {}
@@ -18,32 +45,35 @@ module Ratch
      )
     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.
 
     def config_file(path=nil)
-      path ||= DEFAULT_CONFIG_FILE
-      find = "{#{utility_directory}/,}#{path}{.yaml,.yml,}"
-      file = Dir.glob(find)[0]
+      if path
+        find = "{#{utility_directory}/config/,}#{path}{.yaml,.yml,}"
+      else
+        #path = DEFAULT_CONFIG_FILE
+        find = "{#{utility_directory}/config,#{utility_directory}/config/general}{.yaml,.yml,}"
+      end
+      file = Dir.glob(find).find{ |f| File.file?(f) }
       return file
     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 config_read(path)
-      find = "{#{utility_directory}/,}#{path}{.yaml,.yml,}"
-      if file = Dir.glob(find)[0]
-        YAML::load(File.open(file)) || {}  # The || {} is in case the file is empty.
+      #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
 
-    # TODO Better name? Better definition? (Won't handle task subdirs well).
+    # TODO Better name? Better definition? (Won't handle task subdirs!).
 
     def utility_directory
       File.dirname($0)

data/lib/ratch/consoleutils.rb

@@ -1,3 +1,26 @@
+# TITLE:
+#
+#   ConsoleUtils
+#
+# 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 ConsoleUtils
@@ -39,42 +62,74 @@ end
 
 class Array
 
+  # Not empty?
+
+  def not_empty?
+    !empty?
+  end
+
   # Convert an array into command line parameters.
   # The array is accepted in the format of Ruby
   # method arguments --ie. [arg1, arg2, ..., hash]
 
-  def to_params
+  def to_console
     flags = (Hash===last ? pop : {})
-    flags = flags.collect do |f,v|
+    flags = flags.to_console
+    flags + ' ' + join(" ")
+  end
+  alias_method :to_params, :to_console
+
+#   def to_console
+#     flags = (Hash===last ? pop : {})
+#     flags = flags.collect do |f,v|
+#       m = f.to_s.size == 1 ? '-' : '--'
+#       case v
+#       when Array
+#         v.collect{ |e| "#{m}#{f} '#{e}'" }.join(' ')
+#       when true
+#         "#{m}#{f}"
+#       when false, nil
+#         ''
+#       else
+#         "#{m}#{f} '#{v}'"
+#       end
+#     end
+#     return (flags + self).join(" ")
+#   end
+
+end
+
+
+class Hash
+
+  # Convert an array into command line parameters.
+  # The array is accepted in the format of Ruby
+  # method arguments --ie. [arg1, arg2, ..., hash]
+
+  def to_console
+    flags = collect do |f,v|
       m = f.to_s.size == 1 ? '-' : '--'
       case v
       when Array
-        v.collect{ |e| "#{m}#{f} '#{e}'" }.join(' ')
+        v.collect{ |e| "#{m}#{f}='#{e}'" }.join(' ')
       when true
         "#{m}#{f}"
       when false, nil
         ''
       else
-        "#{m}#{f} '#{v}'"
+        "#{m}#{f}='#{v}'"
       end
     end
-    return (flags + self).join(" ")
-  end
-
-  # Not empty?
-
-  def not_empty?
-    !empty?
+    flags.join(" ")
   end
 
-end
-
-
-class Hash
-
-  # Setup a console arguments vector from a set of config options.
-
-  def command_vector(args_field=nil)
+  # Turn a hash into arguments.
+  #
+  #   h = { :list => [1,2], :base => "HI" }
+  #   h.argumentize #=> [ [], { :list => [1,2], :base => "HI" } ]
+  #   h.argumentize(:list) #=> [ [1,2], { :base => "HI" } ]
+  #
+  def argumentize(args_field=nil)
     config = dup
     if args_field
       args = [config.delete(args_field)].flatten.compact
@@ -85,4 +140,6 @@ class Hash
     return args
   end
 
+  alias_method :command_vector, :argumentize
+
 end

data/lib/ratch/emailutils.rb

@@ -1,3 +1,27 @@
+
+# TITLE:
+#
+#   EmailUtils
+#
+# 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/>.
+
 begin
   require 'facets/net/smtp_tls'
 rescue LoadError