ratch 0.4.1 → 1.0.0

data/lib/ratch/dsl/build.rb

@@ -1,174 +0,0 @@
-# = TITLE:
-#
-#   Build 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 Builds
-
-    # Define a build target.
-
-    def file(name, &block)
-      name, deps, block = *parse_build_dependencies(name, &block)
-      define_file(name, *deps, &block)
-    end
-
-    # Build target(s).
-
-    def build(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_build(path)
-        if build.needed_for?(path) || force?
-          list, todo = *build_plan(build, path)
-          todo.each{|bld, pth| bld.call(pth) } #@builds[name].call }
-          build.call(path)
-        end
-      else
-        raise "build not found -- #{path}"
-      end
-    end
-
-    private
-
-      def builds; @builds ||= [] ; end
-
-      #
-      def parse_build_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
-
-      # Define a file build task.
-
-      def define_file(name, *depend, &block)
-        build = Build.new(name, *depend, &block)
-        builds << build
-      end
-
-      #
-
-      def find_build(path)
-        builds.find{ |b| b.match?(path) }
-      end
-
-      # Prepare build plan, checking for circular dependencies.
-
-      def build_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_build(npath)
-            build_plan(nbuild, npath, list, todo)
-            todo << [nbuild, npath]
-          else
-            list << npath
-          end
-        end
-
-        return list, todo
-      end
-
-  end
-
-  # This class encapsulates the build procedure for creating
-  # a file (or directory).
-
-  class Build
-
-    attr :match
-    attr :needs
-    attr :action
-
-    alias_method :name, :match
-
-    # Create a new build definition.
-
-    def initialize(match, *needs, &action)
-      @match         = match
-      @needs         = needs
-      @action        = action
-    end
-
-    # Call this build process for the given path.
-
-    def call(path)
-      if needs.empty?
-        dated = true
-      elsif File.exist?(path)
-        mtime = File.mtime(path)
-        dated = needs.find do |file|
-          !File.exist?(file) || File.mtime(file) > mtime
-        end
-      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)
-      return true if needed_paths.empty?  # TODO: if there are no prereqs then the file is always considered needed. Correct?
-      mtimes = needed_paths.collect do |f|
-        File.exist?(f) ? File.mtime(f) : Time.now
-      end
-      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
-end

data/lib/ratch/dsl/email.rb

@@ -1,108 +0,0 @@
-# = TITLE:
-#
-#   Email 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/>.
-
-begin
-  require 'facets/net/smtp_tls'
-rescue LoadError
-  require 'net/smtp'
-end
-
-module Ratch
-module Dsl
-
-  module Email
-
-    # Email function to easily send out an email.
-    #
-    # Settings:
-    #
-    #     subject      Subject of email message.
-    #     from         Message FROM address [email].
-    #     to           Email address to send announcemnt.
-    #     server       Email server to route message.
-    #     port         Email server's port.
-    #     domain       Email server's domain name.
-    #     account      Email account name if needed.
-    #     password     Password for login..
-    #     login        Login type: plain, cram_md5 or login [plain].
-    #     secure       Uses TLS security, true or false? [false]
-    #     message      Mesage to send -or-
-    #     file         File that contains message.
-
-    def email(message, settings)
-      settings ||= {}
-      settings.rekey
-
-      server    = settings[:server]
-      account   = settings[:account]  || ENV['EMAIL_ACCOUNT']
-      passwd    = settings[:password] || ENV['EMAIL_PASSWORD']
-      login     = settings[:login].to_sym
-      subject   = settings[:subject]
-      mail_to   = settings[:to]     || settings[:mail_to]
-      mail_from = settings[:from]   || settings[:mail_from]
-      secure    = settings[:secure]
-      domain    = settings[:domain] || server
-
-      port    ||= (secure ? 465 : 25)
-      account ||= mail_from
-      login   ||= :plain
-
-      #mail_to = nil if mail_to.empty?
-
-      raise ArgumentError, "missing email field -- server"  unless server
-      raise ArgumentError, "missing email field -- account" unless account
-      raise ArgumentError, "missing email field -- subject" unless subject
-      raise ArgumentError, "missing email field -- to"      unless mail_to
-      raise ArgumentError, "missing email field -- from"    unless mail_from
-
-      passwd ||= password(account)
-
-      mail_to = [mail_to].flatten.compact
-
-      msg = ""
-      msg << "From: #{mail_from}\n"
-      msg << "To: #{mail_to.join(';')}\n"
-      msg << "Subject: #{subject}\n"
-      msg << ""
-      msg << message
-
-      begin
-        Net::SMTP.enable_tls if Net::SMTP.respond_to?(:enable_tls) and secure
-        Net::SMTP.start(server, port, domain, account, passwd, login) do |s|
-          s.send_message( msg, mail_from, mail_to )
-        end
-        puts "Email sent successfully to #{mail_to.join(';')}."
-        return true
-      rescue => e
-        if trace?
-          raise e
-        else
-          abort "Email delivery failed."
-        end
-      end
-    end
-
-  end
-
-end
-end

data/lib/ratch/dsl/file.rb

@@ -1,205 +0,0 @@
-# = TITLE:
-#
-#   File 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/>.
-
-require 'fileutils'
-require 'facets/dir/multiglob'
-require 'ratch/support/filetest'
-
-
-module Ratch
-module Dsl
-
-  module Filing
-
-    # Delegate access to FileUtils.
-
-    def fileutils
-      dryrun? ? ::FileUtils::DryRun : ::FileUtils
-    end
-
-    # Add FileUtils Features
-
-    ::FileUtils.private_instance_methods(false).each do |meth|
-      next if meth =~ /^fu_/
-      module_eval %{
-        def #{meth}(*a,&b)
-          fileutils.#{meth}(*a,&b)
-        end
-      }
-    end
-
-    # Add FileTest Features
-
-    ::FileTest.private_instance_methods(false).each do |meth|
-      next if meth =~ /^fu_/
-      module_eval %{
-        def #{meth}(*a,&b)
-          FileTest.#{meth}(*a,&b)
-        end
-      }
-    end
-
-    # Bonus FileUtils features.
-
-    def cd(*a,&b)
-      puts "cd #{a}" if dryrun? or trace?
-      fileutils.chdir(*a,&b)
-    end
-
-    # Read file.
-
-    def file_read(path)
-      File.read(path)
-    end
-
-    # Write file.
-
-    def file_write(path, text)
-      if dryrun?
-        puts "write #{path}"
-      else
-        File.open(path, 'w'){ |f| f << text }
-      end
-    end
-
-    # Assert that a path exists.
-
-    def exists?(path)
-      paths = Dir.glob(path)
-      paths.not_empty?
-    end
-    alias_method :exist?, :exists? ; module_function :exist?
-    alias_method :path?,  :exists? ; module_function :path?
-
-    # Assert that a path exists.
-
-    def exists!(*paths)
-      abort "path not found #{path}" unless paths.any?{|path| exists?(path)}
-    end
-    alias_method :exist!, :exists! ; module_function :exist!
-    alias_method :path!,  :exists! ; module_function :path!
-
-    # Is a given path a regular file? If +path+ is a glob
-    # then checks to see if all matches are refular files.
-
-    def file?(path)
-      paths = Dir.glob(path)
-      paths.not_empty? && paths.all?{ |f| FileTest.file?(f) }
-    end
-
-    # Assert that a given path is a file.
-
-    def file!(*paths)
-      abort "file not found #{path}" unless paths.any?{|path| file?(path)}
-    end
-
-    # Is a given path a directory? If +path+ is a glob
-    # checks to see if all matches are directories.
-
-    def dir?(path)
-      paths = Dir.glob(path)
-      paths.not_empty? && paths.all?{ |f| FileTest.directory?(f) }
-    end
-    alias_method :directory?, :dir? ; module_function :directory?
-
-    # Assert that a given path is a directory.
-
-    def dir!(*paths)
-      paths.each do |path|
-        abort "Directory not found: '#{path}'." unless  dir?(path)
-      end
-    end
-    alias_method :directory!, :dir! ; module_function :directory!
-
-#     # Okay, I'm being a dork, but 'fold' seems like a better word
-#     # then 'dir', 'folder', or 'directory'.
-#
-#     def fold?(path)
-#       paths = Dir.glob(path)
-#       paths.not_empty? && paths.all?{ |f| FileTest.directory?(f) }
-#     end
-#
-#     # Assert that a given path is a fold (ie. a folder).
-#
-#     def fold!(*paths)
-#       abort "fold not found #{path}" unless paths.any?{|path| fold?(path)}
-#     end
-
-    # Glob files.
-
-    def glob(*args, &blk)
-      Dir.glob(*args, &blk)
-    end
-
-    def multiglob(*args, &blk)
-      Dir.multiglob(*args, &blk)
-    end
-
-    def multiglob_r(*args, &blk)
-      Dir.multiglob_r(*args, &blk)
-    end
-
-
-#     # Is a file a task?
-#
-#     def task?(path)
-#       task = File.dirname($0) + "/#{path}"
-#       task.chomp!('!')
-#       task if FileTest.file?(task) && FileTest.executable?(task)
-#     end
-
-#     # Is a file a command executable?
-#     #
-#     # TODO Probably needs to be fixed for Windows.
-#
-#     def bin?(path)
-#       is_bin = command_paths.any? do |f|
-#         FileTest.exist?(File.join(f, path))
-#       end
-#       is_bin ? File.basename(path) : false
-#     end
-#
-#     # This is a support method of #bin?
-#
-#     def command_paths
-#       @command_paths ||= ENV['PATH'].split(/[:;]/)
-#     end
-#
-#     # TODO Make more robust.
-#
-#     UNSAFE = [ '/', '/*', '/**/*' ]
-#
-#     # Is a path considered reasonably "safe"?
-#
-#     def safe?(path)
-#       case path
-#       when *UNSAFE
-#         return false
-#       end
-#       true
-#     end
-
-  end
-
-end
-end