butler 1.8.0

data/lib/event/at.rb

@@ -0,0 +1,64 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'event'
+
+
+
+class Event
+	class At < Event
+		class <<self
+			public :new
+		end
+
+		attr_reader :index
+	
+		# A string representation. Just nice for printing.
+		def inspect
+			string = if off? then
+				"Off"
+			elsif finished? then
+				"Finished"
+			elsif left = seconds_left then
+				"Due: %s (%.2fs)" %  [@next.strftime("%H:%M:%S"), left]
+			else
+				"Error"
+			end
+
+			datetimes = (@previous ? @datetimes.select { |dt| dt > @previous } : @datetimes)
+			"#<%s %s, %s done, due at %s%s>" %  [
+				self.class,
+				string,
+				@times ? "#{@count}/#{@times}" : @count,
+				datetimes.first(5).join(', '),
+				datetimes.length > 5 ? "..." : ""
+			]
+		end
+	
+		def initialize(*datetimes, &block)
+			super(datetimes.last.kind_of?(Hash) ? datetimes.pop : {}, &block)
+			@datetimes  = datetimes.sort
+			#@start     = @datetimes.first
+			#@stop      = @datetimes.last
+			@index      = nil
+			@next				= calculate_first(@start)
+		end
+		
+		protected	
+		def calculate_first(with_start)
+			found			= @datetimes.find { |compare| compare >= with_start }
+			@index    = found && @datetimes.index(found)
+			return found
+		end
+
+		def calculate_next(withLast)
+			@index += 1
+			@datetimes[@index]
+		end
+	end
+end

data/lib/event/every.rb

@@ -0,0 +1,56 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'event'
+
+
+
+class Event
+	class Every < Event
+		class <<self
+			public :new
+		end
+
+		attr_reader :interval
+
+		# A string representation. Just nice for printing.
+		def inspect
+			string = if off? then
+				"Off"
+			elsif finished? then
+				"Finished"
+			elsif left = seconds_left then
+				"Due: %s (%.2fs)" %  [@next.strftime("%H:%M:%S"), left]
+			else
+				"Error"
+			end
+
+			"#<%s %s, %s done, scheduled every %.1fs>" %  [
+				self.class,
+				string,
+				@times ? "#{@count}/#{@times}" : @count,
+				@interval
+			]
+		end
+
+		protected
+		def initialize(seconds, options={}, &block)
+			super(options, &block)
+			@interval = seconds
+			@next     = calculate_first(@start)
+		end
+
+		def calculate_first(with_start)
+			with_start+@interval
+		end
+
+		def calculate_next(with_last)
+			with_last+@interval
+		end
+	end
+end

data/lib/event/timed.rb

@@ -0,0 +1,112 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'event'
+
+
+
+class Event
+	class Timed < Event
+		class <<self
+			public :new
+		end
+
+		attr_reader :original
+
+		# A string representation. Just nice for printing.
+		def inspect
+			string = if off? then
+				"Off"
+			elsif finished? then
+				"Finished"
+			elsif left = seconds_left then
+				"Due: %s (%.2fs)" %  [@next.strftime("%H:%M:%S"), left]
+			else
+				"Error"
+			end
+
+			"#<%s %s, %s done, timed for %s, %s, %s>" %  [
+				self.class,
+				string,
+				@times ? "#{@count}/#{@times}" : @count,
+				*@original
+			]
+		end
+
+		def initialize(hours=[0], minutes=[0], seconds=[0], options={}, &block)
+			super(options, &block)
+			@original	= [hours.inspect, minutes.inspect, seconds.inspect]
+			@indices  = [0,0,0]
+			@hours    = extract_time_range(hours, 23, HOUR_DIVISORS).sort
+			@minutes  = extract_time_range(minutes, 59, MINUTE_DIVISORS).sort
+			@seconds  = extract_time_range(seconds, 59, SECOND_DIVISORS).sort
+			@next     = calculate_first(@start)
+		end
+		
+		def hours
+			@hours.dup
+		end
+
+		def minutes
+			@minutes.dup
+		end
+
+		def seconds
+			@seconds.dup
+		end
+		
+		protected
+		def calculate_first(with_start)
+			start_sec  = with_start.sec
+			start_min  = with_start.min
+			start_hour = with_start.hour
+
+			sec        = @seconds.find { |s| s > start_sec } || @seconds.first
+	
+			# if second is smaller than start time's second, it can't be in the same minute
+			min = if (sec <= start_sec) then
+				@minutes.find { |m| m > start_min } || @minutes.first
+			else
+				@minutes.find { |m| m >= start_min } || @minutes.first
+			end
+	
+			# if minute is smaller than start time's minute, it can't be in the same hour
+			hour = if (min < start_min) then
+				@hours.find { |h| h > start_hour } || @hours.first
+			else
+				@hours.find { |h| h >= start_hour } || @hours.first
+			end
+			
+			@indices = [@hours.index(hour), @minutes.index(min), @seconds.index(sec)]
+			first    = Time.mktime(with_start.year, with_start.month, with_start.day, hour, min, sec)
+			first   += 86400 if first < with_start # happens if hour was nil (e.g. it's 23.00 and next timer is 01.00)
+	
+			first
+		end
+
+		def calculate_next(with_last)
+			overflow = 0
+			2.downto(0) { |i|
+				@indices[i] += 1
+				@indices[i], overflow = *@indices[i].divmod(@seconds.length)
+			}
+			hour    = @hours[@indices[0]]
+			minute  = @minutes[@indices[1]]
+			second  = @seconds[@indices[2]]
+	
+			Time.mktime(
+				with_last.year,
+				with_last.month,
+				with_last.day,
+				hour,
+				minute,
+				second
+			)+overflow*86400
+		end
+	end
+end

data/lib/installer.rb

@@ -0,0 +1,75 @@
+require 'rbconfig'
+
+class Installer
+	def initialize(app_name)
+		@app_name = app_name
+	end
+
+	def os_class
+		@os_class ||= case Config::CONFIG["target_os"]
+			when /^darwin/: :osx
+			when /^win/:    :windows
+			else :nix
+		end
+	end
+	
+	def user_data_suggestions
+		{
+			:osx     => ["#{ENV['HOME']}/Library/Application Support/#{@app_name}", "#{ENV['HOME']}/.#{@app_name}"],
+			:windows => ["#{ENV['HOME']}/.#{@app_name}"],
+			:nix     => ["#{ENV['HOME']}/.#{@app_name}"],
+		}[os_class]
+	end
+
+	def user_config_suggestions
+		{
+			:osx     => ["#{ENV['HOME']}/Library/Preferences/#{@app_name}", "#{ENV['HOME']}/.#{@app_name}/etc"],
+			:windows => ["#{ENV['HOME']}/.#{@app_name}/etc"],
+			:nix     => ["#{ENV['HOME']}/.#{@app_name}/etc"],
+		}[os_class]
+	end
+
+	def user_documents_suggestions
+		{
+			:osx     => ["#{ENV['HOME']}/Documents"],
+			:windows => [
+				"#{ENV['HOME']}/My Documents",
+				"#{ENV['HOME']}/#{ENV['USER']}'s Documents",
+				"#{ENV['HOME']}/#{ENV['USER'].downcase}'s documents"
+				].select { |path| File.directory?(path) },
+			:nix     => ["#{ENV['HOME']}/"],
+		}[os_class]
+	end
+	
+	def user_pid_suggestions
+		{
+			:osx     => ["#{ENV['HOME']}/Library/Application Support/#{@app_name}/run", "#{ENV['HOME']}/.#{@app_name}/run"],
+			:windows => ["#{ENV['HOME']}/.#{@app_name}/run"],
+			:nix     => ["#{ENV['HOME']}/.#{@app_name}/run"],
+		}[os_class]
+	end
+
+	def shared_data_suggestions
+		{
+			:osx     => ["/Library/Application Support/#{@app_name}", "#{Config::CONFIG['datadir']}/#{@app_name}"],
+			:windows => ["#{Config::CONFIG['datadir']}/#{@app_name}"],
+			:nix     => ["#{Config::CONFIG['datadir']}/#{@app_name}"],
+		}[os_class]
+	end
+	
+	def cli_binary_suggestions
+		{
+			:osx     => [Config::CONFIG['bindir']],
+			:windows => [Config::CONFIG['bindir']],
+			:nix     => [Config::CONFIG['bindir'], "#{ENV['HOME']}/bin"],
+		}[os_class]
+	end
+
+	def gui_binary_suggestions
+		{
+			:osx     => ["/Applications", ENV['HOME']+"/Applications"],
+			:windows => [Config::CONFIG['bindir']],
+			:nix     => [Config::CONFIG['bindir'], "#{ENV['HOME']}/bin"],
+		}[os_class]
+	end
+end

data/lib/iterator.rb

@@ -0,0 +1,34 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+class Iterator
+	include Enumerable
+
+	class Iteration
+		def initialize(&block)
+			@block = block
+		end
+		def yield(*args)
+			@block.call(*args)
+		end
+	end
+
+	def initialize(&iterator)
+		@iterator = iterator
+	end
+	
+	def each(&block)
+		@iterator.call(Iteration.new(&block))
+	end
+end
+
+if __FILE__ == $0 then
+	#Iterator.new { |iter| File.open(path) { |fh| while buf = fh.read(8192); iter.yield(buf); end } }
+	x = Iterator.new { |iter| [1,2,3].each { |e| iter.yield(e) } }
+	p x.map { |e| e*2 }
+end

data/lib/log.rb

@@ -0,0 +1,68 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+# == Synopsis
+#   Logfile = Log::File.new("foo.log")
+#   $stderr = Log::Forward(Logfile, :warn) # capture everything that prints to $stderr and treat it as :warn level message
+#   $stdout = Log::Forward(Logfile, :info)
+#   $stderr.puts "foo" # same as Log::File#log("foo", :warn)
+#   $stdout.puts "bar" # same as Log::File#log("bar", :info)
+#   begin
+#     raise "baz"
+#   rescue => exception
+#     $stdout.puts(exception) # same as Log::File#log(exception)
+#   end
+#
+# == Notes
+# require 'log/kernel' to get convenience methods in Kernel
+# it isn't required via 'log' alone to avoid accidental method name clashes.
+# notice that log/kernel will override Kernel#warn
+#
+module Log
+	GroupSeparator   = "\x1d"
+	RecordSeparator  = "\x1e"
+	UnitSeparator    = "\x1f"
+	RecordTerminator = "\n"
+
+	# escape binary data, the data will contain no \n, \r or \t's after escaping, but
+	# still contain binary characters, but all of them preceeded by \e
+	def self.escape(data)
+		data.
+			gsub(/\e/, "\e\e").
+			gsub(/\n/, "\en").
+			gsub(/\r/, "\er").
+			gsub(/\t/, "\et").
+			gsub(/[\x00-\x1a\x1c-\x1f]/, "\e\\0")
+	end
+	
+	# unescapes data escaped by Log.escape
+	def self.unescape(data)
+		data.
+			gsub(/\en/, "\n").
+			gsub(/\er/, "\r").
+			gsub(/\et/, "\t").
+			gsub(/\e(.)/, '\1')
+	end
+end
+
+require 'log/comfort'
+require 'log/converter'
+require 'log/entry'
+require 'log/forward'
+require 'log/fakeio'
+require 'log/file'
+require 'log/nolog'
+
+
+if __FILE__ == $0 then
+lf = StringIO.new
+log = Log::File.new(lf)
+$stderr = Log::Forward.new(log, :warn)
+warn "foo"
+Log::Entry.deserialize(lf.string.split("\n").first)
+end

data/lib/log/comfort.rb

@@ -0,0 +1,85 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+require 'log/entry'
+
+
+
+# == Description
+# log/entry.rb provides some convenience methods in Log.
+#
+# == Synopsis
+# log("Some info")
+# log("Danger!", :warn)
+# warn("Danger!")
+# debug("mecode was here")
+#
+module Log
+	module Comfort
+		# where data is logged to
+		attr_accessor :log_device
+
+		# See Log::Message.new
+		# Module::log(*args) is simply: $stderr.puts(Log::Message.new(*args))
+		def log(text, severity=:info, *args)
+			(@log_device || $stderr).puts(Log::Entry.new(text.to_str, severity, *args))
+		end
+	
+		# See Log::Entry.new to see what arguments are valid.
+		# Module::debug(text, *args) is the same as:
+		#   $stderr.puts(Log::Message.new(text, :debug, *args))
+		def debug(text, *args)
+			(@log_device || $stderr).puts(Log::Entry.new(text.to_str, :debug, *args))
+		end
+	
+		# See Log::Entry.new to see what arguments are valid.
+		# Module::info(text, *args) is the same as:
+		#   $stderr.puts(Log::Message.new(text, :info, *args))
+		def info(text, *args)
+			(@log_device || $stderr).puts(Log::Entry.new(text.to_str, :info, *args))
+		end
+	
+		# See Log::Entry.new to see what arguments are valid.
+		# Module::warn(text, *args) is the same as:
+		#   $stderr.puts(Log::Message.new(text, :warn, *args))
+		def warn(text, *args)
+			(@log_device || $stderr).puts(Log::Entry.new(text.to_str, :warn, *args))
+		end
+	
+		# See Log::Entry.new to see what arguments are valid.
+		# Module::error(text, *args) is the same as:
+		#   $stderr.puts(Log::Message.new(text, :error, *args))
+		def error(text, *args)
+			(@log_device || $stderr).puts(Log::Entry.new(text.to_str, :error, *args))
+		end
+	
+		# See Log::Entry.new to see what arguments are valid.
+		# Module::fail(text, *args) is the same as:
+		#   $stderr.puts(Log::Message.new(text, :fail, *args))
+		def fail(text, *args)
+			(@log_device || $stderr).puts(Log::Entry.new(text.to_str, :fail, *args))
+		end
+
+		# 
+		def exception(e)
+			log = @log_device || $stderr
+			if log.respond_to?(:exception) then
+				log.exception(e)
+			else
+				log.puts("#{Time.now.strftime('%FT%T')} [exception]: #{e} (#{e.class})")
+				if $VERBOSE then
+					prefix = "--> "
+					log.puts(*e.backtrace.map { |l| prefix+l })
+				end
+			end
+		end
+	end
+
+	# enable Log.log etc.
+	extend Comfort
+end