buzzcore 0.2.5

data/lib/buzzcore/misc_utils.rb

@@ -0,0 +1,387 @@
+require 'tmpdir'
+require 'logger'
+require 'pathname'
+
+require 'buzzcore/logging'
+
+module MiscUtils
+
+	def self.logger
+		@logger || @logger = Logger.new(STDERR)
+	end
+
+	# applies the given block to key/value pairs included/excluded by the given parameters
+	# aSource must be a hash, and may contain hashes which will be recursively processed.
+	# aInclude/aExclude may be nil, an array of selected keys, or a hash containing arrays of keys for inner hashes of aSource
+	# When aInclude/aExclude are a hash, non-hash source values may be selected by passing a value of true. Hash source values 
+	# will be selected as a whole (all keys) when true is passed.
+	# input = { 'a' => 1, 'b' => {'x' => 9, 'y' => 8}, 'c' => 3 }
+	# filter_multilevel_hash(input,['a','b'],{'b'=>['y']}) {|h,k,v| h[k] = true}
+	# input now = { 'a' => true, 'b' => {'x' => true, 'y' => 8}, 'c' => 3 }
+	def self.filter_multilevel_hash(aSource,aInclude=nil,aExclude=nil,&block)
+		aSource.each do |key,value|
+			next if aInclude.is_a?(Array) and !aInclude.include?(key)		# skip if not in aInclude array
+			next if aExclude.is_a?(Array) and aExclude.include?(key)		# skip if in aExclude array
+			next if aExclude.is_a?(Hash) and aExclude[key]==true				# skip if in aExclude hash with value=true
+			next if aInclude.is_a?(Hash) and !aInclude.include?(key)		# skip if not in aInclude hash at all
+			if value.is_a?(Hash)																				# value is hash so recursively apply filter 
+				filter_multilevel_hash(
+					value,
+					aInclude.is_a?(Hash) && (f = aInclude[key]) ? f : nil,	# pass include array if provided for key
+					aExclude.is_a?(Hash) && (f = aExclude[key]) ? f : nil,	# pass exclude array if provided for key
+					&block
+				)
+			else
+				yield(aSource,key,value)
+			end
+		end
+	end
+
+	# returns output string if succesful, or integer return code if not, or nil
+	def self.execute(aCommand,aWorkingDir=nil,aTimeout=nil,aTimeoutClass=nil)
+		return nil unless !aWorkingDir || File.exists?(aWorkingDir)
+		begin
+			orig_wd = Dir.getwd
+			pipe = nil
+			result = nil
+			Dir.chdir(aWorkingDir) if aWorkingDir
+			Timeout.timeout(aTimeout,aTimeoutClass || Timeout::Error) do	# nil aTimeout will not time out
+				pipe = IO.popen(aCommand)
+				logger.debug "command PID:"+pipe.pid.to_s
+				result = pipe.read
+			end
+		ensure
+			pipe.close if pipe
+			Dir.chdir(orig_wd)
+		end
+		return result
+	end
+
+	def self.execute_string(aCmdString,aWorkingDir=nil)
+		result = nil
+		begin
+			orig_dir = Dir.pwd
+			Dir.chdir(aWorkingDir) if aWorkingDir
+			result = `#{aCmdString}`
+		ensure
+			Dir.chdir(orig_dir) if aWorkingDir
+		end 
+		return result
+	end
+
+	def self.temp_file(aExt=nil,aDir=nil)
+		aExt ||= '.tmp'
+		File.expand_path(("%08X" % rand(0x3FFFFFFF)) + aExt, aDir||Dir.tmpdir)
+	end
+	
+	def self.make_temp_file(aName=nil,aDir=nil,aContent=nil)
+		filename = aName ? File.expand_path(aName,aDir || Dir.tmpdir) : temp_file(nil,aDir)
+    FileUtils.mkdir_p(File.dirname(filename))
+		aContent ||= "content of "+filename
+		string_to_file(aContent,filename)
+    filename
+	end
+
+	def self.make_temp_dir(aPrefix='')
+		new_dir = nil
+    begin
+			new_dir = File.join(Dir.tmpdir,aPrefix+("%08X" % rand(0x3FFFFFFF)))
+		end until new_dir && !File.exists?(new_dir)
+		Dir.mkdir new_dir
+		return new_dir
+	end
+	
+	def self.mkdir?(aPath,aPermissions)
+		if File.exists?(aPath)
+			File.chmod(aPermissions, aPath)
+		else
+			Dir.mkdir(aPath, aPermissions)
+    end
+  end
+
+	def self.string_to_file(aString,aFilename)
+		File.open(aFilename,'wb') {|file| file.puts aString }
+	end
+
+	def self.string_from_file(aFilename)
+		result = nil
+		File.open(aFilename, "rb") { |f| result = f.read }
+		return result && result[0..-2]  # quick hack to stop returning false \n at end
+	end
+
+	def self.sniff_seperator(aPath)
+		result = 0.upto(aPath.length-1) do |i|
+			char = aPath[i,1]
+			break char if char=='\\' || char=='/'
+		end
+		result = File::SEPARATOR if result==0
+		return result
+	end
+
+	def self.append_slash(aPath,aSep=nil)
+		aSep = sniff_seperator(aPath) unless aSep
+		last_char = aPath[-1,1]
+		aPath += aSep unless last_char=='\\' || last_char=='/'
+		return aPath
+	end
+
+	def self.remove_slash(aPath)
+		last_char = aPath[-1,1]
+		aPath = aPath[0..-2] if last_char=='\\' || last_char=='/'
+		return aPath
+	end
+
+	# Remove base dir from given path. Result will be relative to base dir and not have a leading or trailing slash
+	#'/a/b/c','/a' = 'b/c'
+	#'/a/b/c','/' = 'a/b/c'
+	#'/','/' = ''
+	def self.path_debase(aPath,aBase)
+		aBase = MiscUtils::append_slash(aBase)
+		aPath = MiscUtils::remove_slash(aPath) unless aPath=='/'
+		aPath[0,aBase.length]==aBase ? aPath[aBase.length,aPath.length-aBase.length] : aPath
+	end
+	
+	def self.path_rebase(aPath,aOldBase,aNewBase)
+		rel_path = path_debase(aPath,aOldBase)
+		append_slash(aNewBase)+rel_path
+	end
+	
+	def self.path_combine(aBasePath,aPath)
+		return aBasePath if !aPath
+		return aPath if !aBasePath
+		return path_relative?(aPath) ? File.join(aBasePath,aPath) : aPath	
+	end
+
+	def self.path_parent(aPath)
+		MiscUtils.append_slash(File.dirname(MiscUtils.remove_slash(File.expand_path(aPath))))
+	end
+
+	def self.simple_dir_name(aPath)
+		File.basename(remove_slash(aPath))
+	end
+
+	def self.path_parts(aPath)
+		sep = sniff_seperator(aPath)
+		aPath.split(sep)
+	end
+
+	def self.file_extension(aFile,aExtended=true)
+		f = File.basename(aFile)
+		dot = aExtended ? f.index('.') : f.rindex('.')
+		return dot ? f[dot+1..-1] : f
+	end
+
+	def self.file_no_extension(aFile,aExtended=true)
+		ext = file_extension(aFile,aExtended)
+		return aFile.chomp('.'+ext)
+	end
+
+	def self.file_change_ext(aFile,aExt,aExtend=false)
+		file_no_extension(aFile,false)+(aExtend ? '.'+aExt+'.'+file_extension(aFile,false) : '.'+aExt)
+	end
+
+	def self.platform
+		RUBY_PLATFORM.scan(/-(.+)$/).flatten.first
+	end
+
+	def self.windows_path(aPath)
+		aPath.gsub('/','\\')
+	end
+
+	def self.ruby_path(aPath)
+		aPath.gsub('\\','/')
+	end
+
+	def self.is_uri?(aString)
+		/^[a-zA-Z0-9+_]+\:\/\// =~ aString ? true : false
+	end
+
+	def self.native_path(aPath)
+		is_windows? ? windows_path(aPath) : ruby_path(aPath)
+	end
+
+	def self.path_relative?(aPath)
+		return false if aPath[0,1]=='/'
+		return false if aPath =~ /^[a-zA-Z]:/
+		return true
+	end
+
+	def self.path_absolute?(aPath)
+		!path_relative(aPath)
+	end
+
+	def self.is_windows?
+		platform=='mswin32'
+	end
+
+	# takes a path and combines it with a root path (which defaults to Dir.pwd) unless it is absolute
+	# the final result is then expanded
+	def self.canonize_path(aPath,aRootPath=nil)
+		path = Pathname.new(aPath)
+		path = Pathname.new(aRootPath || Dir.pwd)+path if path.relative?
+		File.expand_path(path)
+	end
+	
+	def self.get_files(aArray,aPath,aFullPath=true,aRootPath=nil,&block)
+		#puts "get_files: aPath='#{aPath}'"
+		if aRootPath
+			abssrcpath = path_combine(aRootPath,aPath)
+		else
+			abssrcpath = aRootPath = aPath
+			aPath = nil
+		end
+		return aArray if !File.exists?(abssrcpath)
+		#abssrcpath is real path to query
+		#aRootPath is highest level path
+		#aPath is current path relative to aRootPath
+		Dir.new(abssrcpath).to_a.each do |file|
+			next if ['.','..'].include? file
+			fullpath = File.join(abssrcpath,file)
+			resultpath = aFullPath ? fullpath : path_combine(aPath,file)
+			if !block_given? || yield(resultpath)
+				if FileTest.directory?(fullpath)
+					block_given? ? get_files(aArray,path_combine(aPath,file),aFullPath,aRootPath,&block) : get_files(aArray,path_combine(aPath,file),aFullPath,aRootPath)
+				else
+					aArray << resultpath
+				end
+			end
+		end
+		return aArray
+	end
+
+	def self.recursive_file_list(aPath,aFullPath=true,&block)
+		block_given? ? get_files([],aPath,aFullPath,nil,&block) : get_files([],aPath,aFullPath)
+  end
+	
+	# returns true if aPath1 and aPath2 are the same path (doesn't query file system)
+	# both must be absolute or both relative
+	def self.path_same(aPath1,aPath2)
+		return nil unless path_relative?(aPath1) == path_relative?(aPath2)
+		remove_slash(aPath1) == remove_slash(aPath2)
+	end
+	
+	# returns true if aPath is under aPathParent
+	# both must be absolute or both relative
+	def self.path_ancestor(aPathParent,aPath)
+		return nil unless path_relative?(aPathParent) == path_relative?(aPath)
+		aPath.index(append_slash(aPathParent))==0
+	end
+
+	# returns the lowest path containing all files (assumes aFiles contains only absolute paths)
+	def self.file_list_ancestor(aFiles)
+    files = aFiles.is_a?(Hash) ? aFiles.keys : aFiles
+		result = File.dirname(files.first)
+		files.each do |fp|
+			filedir = File.dirname(fp)
+			while path_same(result,filedir)==false && path_ancestor(result,filedir)==false
+				result = path_parent(result)
+			end
+		end		
+		result
+	end
+
+	def self.path_match(aPath,aPatterns)
+		aPatterns = [aPatterns] unless aPatterns.is_a? Array
+		aPatterns.any? do |pat|
+			case pat
+				when String then aPath[0,pat.length] == pat
+				when Regexp then aPath =~ pat
+				else false
+			end
+		end
+	end
+	
+	# for capistrano deployed paths
+	# makes "/var/www/logikal.stage/releases/20090911073620/cms/config.xml" into "/var/www/logikal.stage/current/cms/config.xml"
+	def self.neaten_cap_path(aPath)
+		aPath.sub(/(\/releases\/[0-9]+\/)/,'/current/')
+	end
+
+	# takes a hash and returns a single closed tag containing the hash pairs as attributes, correctly encoded
+	def self.hash_to_xml_tag(aName,aHash)
+		atts = ''
+		aHash.each do |k,v| 
+			atts += ' ' + k.to_s + "=\"#{v.to_s.to_xs}\""
+		end
+		"<#{aName}#{atts}/>"		
+	end
+
+	def self.filelist_from_patterns(aPatterns,aBasePath)
+		return [] unless aPatterns
+		aPatterns = [aPatterns] unless aPatterns.is_a? Array
+
+		aPatterns.map do |fp|
+			fp = File.expand_path(fp,aBasePath)		# relative to rails root
+			fp = FileList[fp] if fp['*'] || fp['?']
+			fp
+		end.flatten
+	end
+
+#:host
+#:port
+#:helodomain
+#:user
+#:password
+#:from
+#:from_alias
+#:to
+#:to_alias
+#:subject
+#:message
+#:auth : 'plain', 'login', 'cram_md5'
+
+	# send an email via an SMTP server
+  def self.send_email(aArgs)
+    msg = <<END_OF_MESSAGE
+From: #{aArgs[:from_alias]} <#{aArgs[:from]}>
+To: #{aArgs[:to_alias]} <#{aArgs[:to]}>
+Subject: #{aArgs[:subject]}
+
+#{aArgs[:message]}
+END_OF_MESSAGE
+
+    Net::SMTP.start(
+			aArgs[:host],
+			aArgs[:port],
+			aArgs[:helodomain],
+			aArgs[:user],
+			aArgs[:password],
+			aArgs[:auth]
+		) do |smtp|
+      smtp.send_message msg, aArgs[:from], aArgs[:to]
+    end
+  end
+
+end
+
+# include this at the top of a class to protect it from baddies.
+# eg. 
+# + nearly all ancestor public_instance_methods will be hidden
+# + inspect will only return the class name
+# + methods will return public methods
+module SecureThisClass
+	def self.hack(aClass,aOptions={})
+		include_actions = (aOptions[:include] || aClass.public_instance_methods.clone)
+		exclude_actions = ['class','public_methods'] | (aOptions[:exclude] || [])
+		actions_to_hide = include_actions-exclude_actions
+		aClass.class_eval do
+			actions_to_hide.each { |m| protected m.to_sym }
+
+			def inspect
+				return self.class.name
+			end
+
+			def methods
+				public_methods
+			end
+		end
+	end
+end
+
+
+module ::Kernel
+	def secure_class(aOptions={})
+		SecureThisClass::hack(self,aOptions)
+	end
+end
+

data/lib/buzzcore/require_paths.rb

@@ -0,0 +1,39 @@
+# This sorts out the issues of require'ing files in Ruby
+#	1) on one line, you specify all the paths you need
+# 2) Relative paths will be relative to the file you are in, absolute paths also supported
+# 3) Paths will be expanded
+# 4) Paths will only be added if they don't already exist
+# 
+module ::Kernel
+
+	# returns full path given relative to $LOAD_PATH
+	def require_which(aFilepath)
+		aFilepath += '.rb'
+		$LOAD_PATH.each do |dir|
+			full_path = File.expand_path(File.join(dir,aFilepath))
+			return full_path if File.exist? full_path
+		end
+		return nil
+	end
+
+	def require_paths(*aArgs)
+	  caller_dir = File.dirname(File.expand_path(caller.first.sub(/:[0-9]+.*/,'')))
+		aArgs.each do |aPath|
+			aPath = File.expand_path(aPath,caller_dir)
+			$LOAD_PATH << aPath unless $LOAD_PATH.include?(aPath)
+		end
+	end
+	
+	def require_paths_first(*aArgs)
+	  caller_dir = File.dirname(File.expand_path(caller.first.sub(/:[0-9]+.*/,'')))
+		paths = []
+		aArgs.each do |aPath|
+			aPath = File.expand_path(aPath,caller_dir)
+			paths << aPath
+		end
+		paths.each do |p|
+			$LOAD_PATH.insert(0,p)
+		end
+	end
+end
+

data/lib/buzzcore/shell_extras.rb

@@ -0,0 +1,80 @@
+gem 'Platform'; require 'platform'
+gem 'shairontoledo-popen4'; require 'popen4'
+
+module POpen4
+
+	class ExecuteError < StandardError
+
+		attr_reader :result #,:stderr,:stdout,:exitcode,:pid
+
+    def initialize(aArg)
+      if aArg.is_a? Hash
+				msg = ([aArg[:stderr],aArg[:stdout],"Error #{aArg[:exitcode].to_s}"].find {|i| i && !i.empty?})
+        super(msg)
+        @result = aArg
+      else
+        super(aArg)
+      end
+    end
+		
+		def inspect
+			"#{self.class.to_s}: #{@result.inspect}"
+		end
+
+	end
+	
+	def self.pump_thread(aIn,aOut)
+		Thread.new do
+			loop { aOut.puts aIn.gets }
+		end
+	end
+
+	# Usage :
+	# result = POpen4::shell('somebinary') do |r|   # block gives opportunity to adjust result, and avoid exception raised from non-zero exit codes
+	# 	if r[:exitcode]==254		# eg. say this binary returns 254 to mean something special but not an error
+	#     r[:stdout] = 'some correct output'
+	#     r[:stderr] = ''
+	#     r[:exitcode] = 0
+	#   end
+	# end
+  #
+  # OR
+  #
+  # result = POpen4::shell('somebinary');
+  # puts result[:stdout]
+	#
+	# Giving aStdOut,aStdErr causes the command output to be connected to the given stream, and that stream to not be given in the result hash
+	def self.shell(aCommand,aWorkingDir=nil,aTimeout=nil,aStdOut=nil,aStdErr=nil)
+		raise ExecuteError.new('aWorkingDir doesnt exist') unless !aWorkingDir || File.exists?(aWorkingDir)
+		orig_wd = Dir.getwd
+		result = {:command => aCommand, :dir => (aWorkingDir || orig_wd)}
+    status = nil
+		begin
+			Dir.chdir(aWorkingDir) if aWorkingDir
+			Timeout.timeout(aTimeout,ExecuteError) do	# nil aTimeout will not time out
+				status = POpen4::popen4(aCommand) do |stdout, stderr, stdin, pid|
+					thrOut = aStdOut ? Thread.new { aStdOut.puts stdout.read } : nil
+					thrErr = aStdErr ? Thread.new { aStdErr.puts stderr.read } : nil
+					thrOut.join if thrOut
+					thrErr.join if thrErr
+
+					result[:stdout] = stdout.read unless aStdOut
+					result[:stderr] = stderr.read unless aStdErr
+					result[:pid] = pid
+				end
+			end
+		ensure
+			Dir.chdir(orig_wd)
+		end
+		result[:exitcode] = (status && status.exitstatus) || 1
+		yield(result) if block_given?
+		raise ExecuteError.new(result) if result[:exitcode] != 0
+		return result
+	end
+	
+	def self.shell_out(aCommand,aWorkingDir=nil,aTimeout=nil,&block)
+		block_given? ? POpen4::shell(aCommand,aWorkingDir,aTimeout,STDOUT,STDERR,&block) : POpen4::shell(aCommand,aWorkingDir,aTimeout,STDOUT,STDERR)
+	end
+
+end
+

data/lib/buzzcore/string_utils.rb

@@ -0,0 +1,66 @@
+module StringUtils
+	def self.crop(aString,aLength,aEllipsis=true,aConvertNil=true)
+		return aConvertNil ? ' '*aLength : nil if !aString
+
+    increase = aLength-aString.length
+    return aString+' '*increase if increase>=0
+		return aEllipsis ? aString[0,aLength-3]+'...' : aString[0,aLength]
+  end
+
+	# aTemplate is a string containing tokens like ${SOME_TOKEN}
+	# aValues is a hash of token names eg. 'SOME_TOKEN' and their values to substitute
+	def self.render_template(aTemplate,aValues)
+		# get positions of tokens
+		result = aTemplate.gsub(/\$\{(.*?)\}/) do |s| 
+			key = s[2..-2]
+			rep = (aValues[key] || s)
+			#puts "replacing #{s} with #{rep}"
+			rep
+    end
+		#puts "rendered :\n#{result}"
+		return result
+	end
+	
+	def self.clean_number(aString)
+		aString.gsub(/[^0-9.-]/,'')
+	end
+
+	# supply a block with 2 parameters, and it will get called for each char as an integer
+	def self.each_unicode_char(aString)
+		len = 1
+		index = 0
+		char = 0
+		aString.each_byte do |b|
+			if index==0
+				len = 1
+				len = 2 if b & 0b11000000 != 0
+				len = 3 if b & 0b11100000 != 0
+				len = 4 if b & 0b11110000 != 0
+				char = 0
+			end
+		
+			char |= b << index*8
+		
+			yield(char,len) if index==len-1 # last byte; char is complete
+		
+			index += 1
+			index = 0 if index >= len
+		end
+	end
+
+	# given ('abcdefg','c.*?e') returns ['ab','cde','fg'] so you can manipulate the head, match and tail seperately, and potentially rejoin
+	def self.split3(aString,aPattern,aOccurence=0)
+		matches = aString.scan_md(aPattern)
+		match = matches[aOccurence]
+		parts = [match.pre_match,match.to_s,match.post_match]
+
+		if !block_given?	# return head,match,tail
+			parts
+		else						# return string
+			parts[1] = yield *parts
+			parts.join
+		end
+	end
+
+end
+

data/lib/buzzcore/text_doc.rb

@@ -0,0 +1,70 @@
+# represents a mono-spaced text document with a given width and expandable height.
+class TextDoc
+
+  attr_reader :width, :height, :lines
+
+  def logger
+    RAILS_DEFAULT_LOGGER
+  end
+
+  def initialize(aWidth=80,aHeight=66)
+    @width = aWidth
+    @height = aHeight
+  
+    @lines = Array.new(@height)
+    line_str = ' '*@width
+    @lines.collect!{|line| line_str.clone }
+  end
+
+  def replace_string(aString,aCol,aSubString)
+    return aString if aSubString==nil || aSubString==''
+
+    aSubString = aSubString.to_s
+    start_col = aCol < 0 ? 0 : aCol
+    end_col = aCol+aSubString.length-1
+    end_col = @width-1 if end_col >= @width
+    source_len = end_col-start_col+1
+    return aString if source_len <= 0 || end_col < 0 || start_col >= @width
+    aString += ' '*((end_col+1) - aString.length) if aString.length < end_col+1
+    aString[start_col,source_len] = aSubString[start_col-aCol,end_col-start_col+1]
+    return aString
+  end
+
+  def replace(aCol,aLine,aString)
+    return if (aLine < 0) || (aLine>=@lines.length)
+    replace_string(@lines[aLine],aCol,aString)
+  end
+
+  def replace_block(aCol,aLine,aLines)
+    aLines = aLines.split(/\n/) if aLines.is_a?(String)
+    aLines = aLines.lines if aLines.is_a?(TextDoc)
+  
+    aLines.each_index do |iSource|
+      replace(aCol,aLine+iSource,aLines[iSource])
+    end
+  end
+
+  def add_block(aLines,aCol=0)
+    aLines = aLines.split(/\n/) if aLines.is_a?(String)
+    aLines = aLines.lines if aLines.is_a?(TextDoc)
+    aLines.each_index do |iSource|
+      @lines << ' '*@width
+      replace(aCol,@lines.length-1,aLines[iSource])
+    end
+  end
+
+  def add_line(aLine=nil,aCol=0)
+    @lines << ' '*@width and return if !aLine
+    @lines << ' '*@width
+    replace(aCol,@lines.length-1,aLine)
+  end
+
+  def centre_bar(aChar = '-', indent = 6)
+    (' '*indent) + aChar*(@width-(indent*2)) + (' '*indent)
+  end
+
+  def to_s
+    return @lines.join("\n")
+  end
+end
+