ratch 0.4.1 → 1.0.0

data/HISTORY

@@ -0,0 +1,6 @@
+= Change History
+
+== 2008-08-16
+
+Initial public release.
+

data/MANIFEST

@@ -0,0 +1,36 @@
+doc
+test
+test/README
+test/test_helper.rb
+test/test_task.rb
+README
+HISTORY
+METADATA
+demo
+demo/tryme1.ratch
+demo/tryme-task.ratch
+lib
+lib/ratch
+lib/ratch/runmode.rb
+lib/ratch/pathglob.rb
+lib/ratch/core_ext
+lib/ratch/core_ext/pathname.rb
+lib/ratch/core_ext/object.rb
+lib/ratch/core_ext/facets.rb
+lib/ratch/core_ext/filetest.rb
+lib/ratch/core_ext/to_list.rb
+lib/ratch/core_ext/to_console.rb
+lib/ratch/core_ext/string.rb
+lib/ratch/dsl.rb
+lib/ratch/service.rb
+lib/ratch/core_ext.rb
+lib/ratch/io.rb
+lib/ratch/index.rb
+lib/ratch/plugin.rb
+lib/ratch/task.rb
+lib/ratch/task2.rb
+lib/ratch/script.rb
+NEWS
+bin
+bin/ratch
+COPYING

data/METADATA

@@ -0,0 +1,14 @@
+project     : ratch
+version     : 1.0.0
+status      : beta
+homepage    : http://ratch.rubyforge.org
+author      : trans <transfire@gmail.com>
+requires    : facets >=2.4.3
+summary     : Ruby-based Batch Scripting
+abstract    :
+  Ratch is a Ruby-based batch scripting language.
+  It's a DSL over regular RUby to make the life
+  of the batch script writter easier.
+requires:
+  - [facets, >=2.4.3]
+

data/NEWS

@@ -0,0 +1,7 @@
+= Release Notices
+
+== 1.0.0 // 2008.08.16
+
+This is the initial public release of Ratch.
+
+

data/README

@@ -1,37 +1,87 @@
-= Ratch
+= Ratch -- Ruby-based Batch Scripts
 
-== Welcome to Ratch
+  http://ratch.rubyforge.org
+
+
+== Introduction
+
+Ratch is Ruby-based DSL for building batch scripts. It's intent
+is to ease the burdone a batch script writers, by supplementing
+the standard ruby environamet to be more condusive the needs
+of batch scripting.
+
+In addition to using Ratch to write stand-alone batch scripts,
+it makes a very powerful library for other applications that
+require batch-like functionality. In general any program that
+access the file system extensively could benifit from it's use.
 
-Ratch is a Ruby-based Batch file system. It provides a Ruby-based DSL
-for creating utility/task scripts. It is similar in function to build tools,
-like Make, Ant, Maven, Rake, et al. But unlike these it stears clear
-of monolithic design and instead more closely follows the "UNIX-way".
 
 
 == Installation
 
-  $ gem install ratch
+Standard installation procedure apply.
 
-Or download the tar.gz and install manually,
+  $ gem install ratch
 
-  $ tar -xvzf ratch-x.y.z.tar.gz
-  $ cd ratch-x.y.z
-  $ sudo task/setup
+or manually
 
-For Windows users the last line will be:
+  $ tar -xzf ratch-1.0.0.tgz
+  $ cd ratch-1.0.0
+  $ setup-rb all
 
-  $ ruby task/setup
 
 
 == Usage
 
-Basic usage simply entails writing a script that utilizes Ratch's syntax.
-See lib/ratch/toolset/ruby for examples.
+To use for your own scripts, simply add a bang line.
+
+  #!/usr/bin/env ratch
+
+On Windows, of course, you will want to associate the .ratch extension
+name to the ratch executable instead.
+
+To use Ratch as a library, simply require 'ratch', and subclass.
+
+  require 'ratch'
+
+  class MyClass < Ratch::Service
+
+
+  end
+
+Ratch also provides a delegated service which automatically supplies
+method_missing() to delegate to the given *context*. This is called
+a Ratch Plugin.
+
+  class MyClass < Ratch::Plugin
+
+  end
+
+  MyClass.new(context)
+
+For details on all the functionality Ratch provides, please refer to
+the API documentation.
+
+
+
+== Development
+
+You can use gitweb to browse the 'ratch' repository.
+
+To pull the 'ratch' repository anonymously, use:
+
+        git clone git://rubyforge.org/ratch.git
+        
+
+Developers: You can push to the 'ratch' repository using:
+
+        gitosis@rubyforge.org:ratch.git
+        
 
 
 == Copying
 
-Copyright (c) 2007 T. Sawyer (Psi T. Corp)
+Copyright (c) 2007, 2008 Tiger Ops & Thomas Sawyer
 
-Ratch is distributed under the terms of the GPLv3.
+Ratch is licensed under the terms of the MIT license.
 

data/bin/ratch

@@ -1,83 +1,10 @@
-#! /usr/bin/env ruby
+#!/usr/bin/env ruby
 
-# TODO Create a more robust parser.
+$0 = ARGV.shift
 
-if ARGV[0] == '-s'
-  require 'ratch/manager'
-  manager = Ratch::Manager.new
+require 'ratch/script'
 
-  set  = ARGV[1]
-  path = ARGV[2]
+script = Ratch::Script.new
 
-  if set
-    if setdirectory = manager.toolset?(set)
-      if path
-        if batchfile = manager.tool?(set, path)
-          require 'ratch/dsl'
-          self.batch_directory = setdirectory
-          load($0 = batchfile)
-        else
-          puts "no #{set} tool -- #{path}"
-        end
-      else
-        puts manager.tools(set).join("\n")
-      end
-    else
-      puts "no toolset -- #{set}"
-    end
-  else
-    puts manager.toolsets.join("\n")
-  end
+script.instance_eval(File.read($0))
 
-elsif ARGV.empty?
-
-  # TODO read stdin for ratch script
-
-else
-  require 'ratch/dsl'
-  load($0 = ARGV.shift)
-end
-
-
-# module Ratch
-#
-#   class RatchCommand
-#
-#     # Quick start.
-#
-#     def self.start(file)
-#       new.run(file)
-#     end
-#
-#     # Run task.
-#
-#     def run(file)
-#       if file
-#         BatchFile.new(file).call
-#       else
-#         help
-#       end
-#     end
-#
-#     # Dispaly help.
-#
-#     def help
-#       help = <<-END
-#        USAGE:
-#
-#          ratch [options] <taskfile>
-#
-#        OPTIONS:
-#
-#          --dryrun --nohram
-#
-#          --trace
-#
-#          --debug
-#       END
-#       puts help.gsub(/^\s+/, '')
-#     end
-#
-#   end
-#
-# end

data/demo/tryme-task.ratch

@@ -0,0 +1,12 @@
+#!/usr/bin/env ratch
+
+task :hello do
+  puts "Hello"
+end
+
+task :world => [:hello] do
+  puts "World"
+end
+
+run :world
+

data/demo/tryme1.ratch

@@ -0,0 +1,6 @@
+#!/usr/bin/env ratch
+
+puts "Hello World"
+
+p commandline
+

data/lib/ratch/core_ext.rb

@@ -0,0 +1,6 @@
+__DIR__ = File.dirname(__FILE__)
+
+Dir[File.join(__DIR__, 'core_ext', '*.rb')].each do |file|
+  require file
+end
+

data/lib/ratch/core_ext/facets.rb

@@ -0,0 +1 @@
+require 'facets'

data/lib/ratch/core_ext/filetest.rb

@@ -0,0 +1,52 @@
+module FileTest
+
+  module_function
+
+  # Return a cached list of the PATH environment variable.
+  # This is a support method used by #bin?
+
+  def command_paths
+    @command_paths ||= ENV['PATH'].split(/[:;]/)
+  end
+
+  # Is a file a command executable?
+  #
+  # TODO: Make more robust. Probably needs to be fixed for Windows.
+
+  def bin?(fname)
+    is_bin = command_paths.any? do |f|
+      FileTest.exist?(File.join(f, fname))
+    end
+    #is_bin ? File.basename(fname) : false
+    is_bin ? fname : false
+  end
+
+  # Is a path considered reasonably "safe"?
+  #
+  # TODO: Make more robust.
+
+  def safe?(path)
+    case path
+    when *[ '/', '/*', '/**/*' ]
+      return false
+    end
+    true
+  end
+
+  # Does a path need updating, based on given +sources+?
+  # This compares mtimes of give paths. Returns false
+  # if the path needs to be updated.
+
+  def out_of_date?(path, *sources)
+    return true unless File.exist?(path)
+
+    sources = sources.collect{ |source| Dir.glob(source) }.flatten
+    mtimes  = sources.collect{ |file| File.mtime(file) }
+
+    return true if mtimes.empty?  # TODO: This the way to go here?
+
+    File.mtime(path) < mtimes.max
+  end
+
+end
+

data/lib/ratch/core_ext/object.rb

@@ -0,0 +1,8 @@
+class Object
+
+  def to_yamlfrag
+    to_yaml.sub("---",'').rstrip
+  end
+
+end
+

data/lib/ratch/core_ext/pathname.rb

@@ -0,0 +1,38 @@
+require 'facets/pathname'
+
+class Pathname
+
+  # Like directory? but return self if true, otherwise nil.
+  def dir?
+    directory? ? self : nil
+  end
+
+# Already in Facets
+#
+#    def glob(*opts)
+#      flags = 0
+#      opts.each do |opt|
+#        case opt when Symbol, String
+#          flags += File.const_get("FNM_#{opt}".upcase)
+#        else
+#          flags += opt
+#        end
+#      end
+#      self.class.glob(self.to_s, flags).collect{ |path| self.class.new(path) }
+#    end
+#
+#    #
+#    def first(*opts)
+#      flags = 0
+#      opts.each do |opt|
+#        case opt when Symbol, String
+#          flags += File.const_get("FNM_#{opt}".upcase)
+#        else
+#          flags += opt
+#        end
+#      end
+#      file = self.class.glob(self.to_s, flags).first
+#      file ? self.class.new(file) : nil
+#    end
+
+end

data/lib/ratch/core_ext/string.rb

@@ -0,0 +1,44 @@
+class String
+
+  # okay this is a bit much --we should subclass string.
+  # but it will do for now and we will work this out
+  # when CLIO is up and running.
+  attr_accessor :color
+
+  # Find actual filename (casefolding) and returns it.
+  # Returns nil if no file is found.
+
+  def to_actual_filename
+    Dir.glob(self, File::FNM_CASEFOLD).first
+  end
+
+  # Find actual filename (casefolding) and replace string with it.
+  # If file not found, string remains the same and method returns nil.
+
+  def to_actual_filename!
+    filename = to_actual_filename
+    replace(filename) if filename
+  end
+
+  #
+  def unfold_paragraphs
+    blank = false
+    text  = ''
+    split(/\n/).each do |line|
+      if /\S/ !~ line
+        text << "\n\n"
+        blank = true
+      else
+        if /^(\s+|[*])/ =~ line 
+          text << (line.rstrip + "\n")
+        else
+          text << (line.rstrip + " ")
+        end
+        blank = false
+      end
+    end
+    return text
+  end
+
+end
+

data/lib/ratch/{dsl/console.rb → core_ext/to_console.rb}

@@ -1,81 +1,6 @@
-# = TITLE:
 #
-#   Console
-#
-# = 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 Console
-
-    # Convenient method to get simple console reply.
-
-    def ask(question, answers=nil)
-      print "#{question}"
-      print " [#{answers}] " if answers
-      until inp = $stdin.gets ; sleep 1 ; end
-      inp
-    end
-
-    # Ask for a password. (FIXME: only for unix so far)
-
-    def password(prompt=nil)
-      msg ||= "Enter Password: "
-      inp = ''
-
-      print "#{prompt} "
-
-      begin
-        system "stty -echo"
-        #inp = gets.chomp
-        until inp = $stdin.gets
-          sleep 1
-        end
-      ensure
-        system "stty echo"
-      end
-
-      return inp.chomp
-    end
-
-    # Internal status report.
-    # Only output if dryrun or trace mode.
-
-    def status(message)
-      puts message if dryrun? or trace?
-    end
-
-  end
-
-end
-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]
@@ -85,6 +10,7 @@ class Array
     flags = flags.to_console
     flags + ' ' + join(" ")
   end
+
   alias_method :to_params, :to_console
 
 #   def to_console
@@ -107,7 +33,6 @@ class Array
 
 end
 
-
 class Hash
 
   # Convert an array into command line parameters.
@@ -151,3 +76,4 @@ class Hash
   alias_method :command_vector, :argumentize
 
 end
+