yore 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-25
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,22 @@
+bin/yore
+History.txt
+lib/ihl_ruby/enum.rb
+lib/ihl_ruby/extend_base_classes.rb
+lib/ihl_ruby/misc_utils.rb
+lib/ihl_ruby/string_utils.rb
+lib/ihl_ruby/xml_utils.rb
+lib/yore.orig.rb
+lib/yore/yore_core.rb
+Manifest.txt
+PostInstall.txt
+Rakefile
+README.rdoc
+script/console
+script/destroy
+script/generate
+spec/rewind_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/test_job_a.xml
+spec/yore_spec.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on yore, see http://yore.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= yore
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/yore.orig'
+
+# built following http://newgem.rubyforge.org/
+# using RSpec option
+# and had to add processor_ids from dr nic :
+# http://groups.google.com/group/new-gem-generator/browse_thread/thread/648f70da782e607a/928ea0fe8319d886?lnk=raot
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('yore', Yore::VERSION) do |p|
+  p.developer('Gary McGhee', 'contact@buzz@ware@com@au')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = 'buzzware' #p.name # TODO this is default value
+  p.extra_deps         = [
+    ['RequirePaths','>= 1.0.1'],
+    ['cmdparse', '>= 2.0.2'],
+    ['s3sync', '>= 1.2.5']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]
+# this was generated by netbeans
+# Rake::RDocTask.new do |rdoc|
+#   files =['README', 'LICENSE', 'lib/**/*.rb']
+#   rdoc.rdoc_files.add(files)
+#   rdoc.main = "README" # page to start on
+#   rdoc.title = "yore Docs"
+#   rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+#   rdoc.options << '--line-numbers'
+# end
+# 
+# Rake::TestTask.new do |t|
+#   t.test_files = FileList['test/**/*.rb']
+# end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+end
+

data/bin/yore

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+require 'rubygems'
+gem 'RequirePaths'; require 'require_paths'
+require_paths '.','../../..','/Users/gary/repos/Buzzware/projects_2009/yore/lib'
+
+gem 'cmdparse'; require 'cmdparse'
+
+require 'ihl_ruby/misc_utils'
+require 'ihl_ruby/xml_utils'
+require 'ihl_ruby/extend_base_classes'
+
+require 'yore/yore_core'
+
+CMD_OPTIONS = {}  # options given on command line
+
+# this contains a block that actually creates the controller, yore
+def command(aParser,aController,aAction,aShortDescription=nil,aOptionParser=nil,aOther={})
+  c = CmdParse::Command.new( aAction.to_s, false )
+	c.short_desc = aShortDescription
+	c.description = aOther[:description] if aOther[:description]
+	c.options = aOptionParser if aOptionParser
+  c.set_execution_block do |args|
+    job = args.first
+    xmlRoot = XmlUtils.get_file_root(job)
+    aController.configure(xmlRoot,CMD_OPTIONS,{:basepath => File.dirname(File.expand_path(job))})
+    aController.send(aAction,args)
+  end
+  aParser.add_command(c)
+end
+
+cmd = CmdParse::CommandParser.new( true )
+cmd.program_name = "yore"
+cmd.program_version = [0, 0, 1]
+# Options are given after a command and before arguments on the command line
+# so global options are given first, before the first command
+# ie ruby yore.rb --global_option command --command_option argument1 argument2 argumentn
+cmd.options = CmdParse::OptionParserWrapper.new do |opt|
+  opt.separator "Global options:"
+  opt.on("--verbose", "Be verbose when outputting info") do |t|
+    CMD_OPTIONS[:verbose] = t
+  end
+end
+cmd.add_command( CmdParse::HelpCommand.new )
+cmd.add_command( CmdParse::VersionCommand.new )
+
+yore = YoreCore::Yore.new      # main program object
+
+# these options must be given after backup and before arguments
+option_parser = CmdParse::OptionParserWrapper.new do |opt|
+  opt.on( '--all', 'Delete all IP addresses' ) do
+    CMD_OPTIONS[:deleteAll] = true
+  end
+end
+
+command(cmd,yore,:backup,"Backup filelist to S3",option_parser)
+
+command(cmd,yore,:test_email,"Test email sending\n")
+
+command(cmd,yore,:db_dump,"Dump database by name in job\n")
+
+cmd.parse
+

data/lib/ihl_ruby/enum.rb

@@ -0,0 +1,50 @@
+module Kernel
+  # simple (sequential) enumerated values
+  # usage :
+  # 
+  # module Constants
+  #   module Gradient
+  #     enum :B, :A, :C
+  #   end
+  # end
+  #
+  # then :
+  #
+  # puts Constants::Gradient::B -> 0
+  # puts Constants::Gradient::C -> 2
+  # puts Constants::Gradient::MINVALUE -> 0
+  # puts Constants::Gradient::MAXVALUE -> 2
+  # puts Constants::Gradient::NAMES -> [:B, :A, :C]
+  # puts Constants::Gradient[0] -> :B
+  # puts Constants::Gradient[1] -> :A
+  # puts Constants::Gradient[2] -> :C
+  
+  def enum(*syms)
+    syms.each_index { |i| 
+      const_set(syms[i], i) 
+    }
+    const_set(:NAMES, syms || []) 
+    const_set(:MINVALUE, syms==nil ? nil : 0) 
+    const_set(:MAXVALUE, syms==nil ? nil : syms.length-1) 
+    const_set(:VALUECOUNT, syms==nil ? nil : syms.length) 
+    const_set(:ALL, syms==nil ? [] : (0..syms.length-1).to_a) 
+    const_set(:HUMAN_NAMES, syms.map{|n| n.to_s.humanize} || []) 
+
+    # this returns the enum name given the value
+    def self.[]( idx )
+      (idx.is_a? Integer) ? const_get(:NAMES)[idx] : nil
+    end
+
+    def self.valid?(idx)
+      (idx.is_a? Integer) && (idx >= 0) && (idx <= const_get(:MAXVALUE))
+    end
+
+    def self.parse(name,default=nil)
+      return default if name.nil? || name.empty?
+			return default if not name = name.to_sym
+      result = const_get(:NAMES).index(name)
+      return result==nil ? default : result
+    end
+  end
+end
+

data/lib/ihl_ruby/extend_base_classes.rb

@@ -0,0 +1,313 @@
+String.class_eval do    
+  def pad_left(value)
+    increase = value-self.length
+    return self if increase==0
+    if increase > 0
+      return self + ' '*increase
+    else
+      return self[0,value]
+    end
+  end   
+
+  def pad_right(value)
+    increase = value-self.length
+    return self if increase==0
+    if increase > 0
+      return ' '*increase + self
+    else
+      return self[0,value]
+    end
+  end
+
+  # Like chomp! but operates on the leading characters instead.
+  # The aString parameter would not normally be used.
+  def bite!(aValue=$/,aString=self)
+    if aString[0,aValue.length] == aValue
+      aString[0,aValue.length] = ''
+      return aString
+    else
+      return aString
+    end
+  end
+
+  def bite(aValue=$/)
+    bite!(aValue,self.clone)
+  end  
+
+	def begins_with?(aString)
+		self[0,aString.length]==aString
+	end
+
+	def ends_with?(aString)
+		self[-aString.length,aString.length]==aString
+	end
+
+# for future methods
+#   def centre_bar(aChar = '-', indent = 6)
+#     (' '*indent) + aChar*(@width-(indent*2)) + (' '*indent)
+#   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 to_integer(aDefault=nil)
+		t = self.strip
+		return aDefault if t.empty? || !t.index(/^-{0,1}[0-9]+$/)
+		return t.to_i
+	end
+
+	def is_i?
+		self.to_integer(false) and true
+	end
+
+	def to_float(aDefault=nil)
+		t = self.strip
+		return aDefault if !t =~ /(\+|-)?([0-9]+\.?[0-9]*|\.[0-9]+)([eE](\+|-)?[0-9]+)?/
+		return t.to_f
+	end
+
+	def is_f?
+		self.to_float(false) and true
+	end
+  
+end  
+
+
+Time.class_eval do
+
+  if !respond_to?(:change)  # no activesupport loaded
+    def change(options)
+      ::Time.send(
+        self.utc? ? :utc : :local,
+        options[:year]  || self.year,
+        options[:month] || self.month,
+        options[:day]   || self.day,
+        options[:hour]  || self.hour,
+        options[:min]   || (options[:hour] ? 0 : self.min),
+        options[:sec]   || ((options[:hour] || options[:min]) ? 0 : self.sec),
+        options[:usec]  || ((options[:hour] || options[:min] || options[:sec]) ? 0 : self.usec)
+      )
+    end
+
+    def seconds_since_midnight
+      self.to_i - self.change(:hour => 0).to_i + (self.usec/1.0e+6)
+    end
+
+    def beginning_of_day
+      (self - self.seconds_since_midnight).change(:usec => 0)
+    end
+
+    alias :midnight :beginning_of_day
+    alias :at_midnight :beginning_of_day
+    alias :at_beginning_of_day :beginning_of_day
+
+  end
+
+	# offset of local machine from UTC, in seconds eg +9.hours
+	def self.local_offset
+		local(2000).utc_offset	
+	end
+
+  def date
+    self.at_beginning_of_day
+  end
+
+	# index number of this day, from Time.at(0) + utc_offset
+	def day_number
+		(self.to_i+self.utc_offset) / 86400
+	end
+
+	# index number of this utc day
+	def day_number_utc
+		self.to_i / 86400
+	end
+
+	# the last microsecond of the day
+	def day_end
+		self.at_beginning_of_day + 86399.999999
+	end
+
+	def date_numeric
+		self.strftime('%Y%m%d')
+	end
+	
+	# create a new Time from eg. "20081231"
+	def self.from_date_numeric(aString)
+		local(aString[0,4].to_i,aString[4,2].to_i,aString[6,2].to_i)
+	end
+
+	def time_numeric
+		self.strftime('%H%M%S')
+	end
+
+	def datetime_numeric
+		self.strftime('%Y%m%d-%H%M%S')
+	end
+
+	def to_sql
+		self.strftime('%Y-%m-%d %H:%M:%S')
+	end
+
+	def to_w3c
+		utc.strftime("%Y-%m-%dT%H:%M:%S+00:00") 
+	end
+end
+
+module HashUtils
+  def filter_include!(aKeys,aHash=nil)
+    aHash ||= self
+
+		if aKeys.is_a? Regexp
+      return aHash.delete_if {|k,v| not k =~ aKeys }
+		else
+			aKeys = [aKeys] unless aKeys.is_a? Array
+      return aHash.clear if aKeys.empty?
+      return aHash.delete_if {|key, value| !((aKeys.include?(key)) || (key.is_a?(Symbol) and aKeys.include?(key.to_s)) || (key.is_a?(String) and aKeys.include?(key.to_sym)))}
+      return aHash	# last resort
+		end
+  end
+
+  def filter_include(aKeys,aHash=nil)
+    aHash ||= self
+    filter_include!(aKeys,aHash.clone)
+  end
+
+  def filter_exclude!(aKeys,aHash=nil)
+    aHash ||= self
+
+		if aKeys.is_a? Regexp
+      return aHash.delete_if {|k,v| k =~ aKeys }
+		else
+			aKeys = [aKeys] unless aKeys.is_a? Array
+      return aHash if aKeys.empty?
+      return aHash.delete_if {|key, value| ((aKeys.include?(key)) || (key.is_a?(Symbol) and aKeys.include?(key.to_s)) || (key.is_a?(String) and aKeys.include?(key.to_sym)))}
+		end
+  end
+
+  def filter_exclude(aKeys,aHash=nil)
+    aHash ||= self
+    filter_exclude!(aKeys,aHash.clone)
+  end
+
+	def has_values_for?(aKeys,aHash=nil)
+    aHash ||= self
+		# check all keys exist in aHash and their values are not nil
+		aKeys.all? { |k,v| aHash[k] }
+	end
+
+	# give a block to execute without the given key in this hash
+	# It will be replaced after the block (guaranteed by ensure)
+	# eg. 
+	# hash.without_key(:blah) do |aHash|
+	#		puts aHash.inspect
+	# end
+	def without_key(aKey)
+		temp = nil
+		h = self
+		begin
+			if h.include?(aKey)
+				temp = [aKey,h.delete(aKey)]
+			end
+			result = yield(h)
+		ensure
+			h[temp[0]] = temp[1] if temp
+		end
+		return result
+	end
+
+end
+
+Hash.class_eval do
+  include HashUtils
+end
+
+if defined? HashWithIndifferentAccess
+	HashWithIndifferentAccess.class_eval do
+		include HashUtils
+	end
+end
+
+module ArrayUtils
+  def filter_include!(aValues,aArray=nil)
+    aArray ||= self
+    if aValues.is_a? Array
+      return aArray if aValues.empty?
+      return aArray.delete_if {|v| not aValues.include? v }
+    elsif aValues.is_a? Regexp
+      return aArray.delete_if {|v| not v =~ aValues }
+    else
+      return filter_include!([aValues],aArray)
+    end
+  end
+
+  def filter_include(aValues,aArray=nil)
+    aArray ||= self
+    filter_include!(aValues,aArray.clone)
+  end
+
+  def filter_exclude!(aValues,aArray=nil)
+    aArray ||= self
+    if aValues.is_a? Array
+      return aArray if aValues.empty?
+      return aArray.delete_if {|v| aValues.include? v }
+    elsif aValues.is_a? Regexp
+      return aArray.delete_if {|v| v =~ aValues }
+    else
+      return filter_exclude!([aValues],aArray)
+    end
+  end
+
+  def filter_exclude(aValues,aArray=nil)
+    aArray ||= self
+    filter_exclude!(aValues,aArray.clone)
+  end
+end
+
+Array.class_eval do
+  include ArrayUtils
+
+	# fixes a memory leak in shift in Ruby 1.8 - should be fixed in 1.9
+	# see http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/216055
+	def shift()
+		delete_at(0)
+	end
+
+end
+
+Kernel.class_eval do
+	def is_windows?
+		RUBY_PLATFORM =~ /(win|w)32$/ ? true : false
+	end
+end
+
+if defined? ActiveRecord
+	ActiveRecord::Base.class_eval do
+	
+		def self.find_any_id(aId)
+			with_exclusive_scope { find(:first, {:conditions => {:id => aId}}) }
+		end
+	
+		def self.find_any_all(aOptions={})
+			with_exclusive_scope { find(:all, aOptions) }
+		end
+	
+		def self.find_ids(aIds)
+			find(:all, {:conditions=> ["id in (?)",aIds.join(',')]})
+		end
+	
+		def self.find_any_ids(aIds)
+			with_exclusive_scope { find(:all, {:conditions=> ["id in (?)",aIds.join(',')]}) }
+		end
+	
+	end
+end