yore 0.0.4 → 0.0.5

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2008-2009 Gary McGhee - Buzzware Solutions, Western Australia - gary@buzzware.com.au
+
+MIT Licence
+
+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

@@ -1,57 +1,64 @@
-require 'rubygems'
-require 'rake/rdoctask'
-require 'rake/testtask'
-%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 (later converted to shoulda)
-# 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'],
-    ['shairontoledo-popen4', '>= 0.1.2']
-  ]
-  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
-
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yore"
+    gem.summary = %Q{yore (as in "days of yore") is a user data management utility for web applications.}
+    gem.description = %Q{yore (as in "days of yore") is a user data management utility for web applications.}
+    gem.email = "contact@buzzware.com.au"
+    gem.homepage = "http://github.com/buzzware/yore"
+    gem.authors = ["buzzware"]
+    gem.rubyforge_project = "buzzware"
+    gem.add_dependency('buzzcore', '>= 0.2.5')
+    gem.add_development_dependency "thoughtbot-shoulda"
+		#gem.files.include %w(
+		#	lib/buzzcore.rb
+		#)
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yore #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/bin/yore

@@ -3,15 +3,9 @@
 require 'fileutils'
 
 require 'rubygems'
-gem 'RequirePaths'; require 'require_paths'
-require_paths '.','../../..'
-
+gem 'buzzware-buzzcore'; require 'buzzcore';
 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
@@ -23,10 +17,11 @@ def command(aParser,aController,aAction,aShortDescription=nil,aOptionParser=nil,
 	c.description = aOther[:description] if aOther[:description]
 	c.options = aOptionParser if aOptionParser
   c.set_execution_block do |args|
-		if job = CMD_OPTIONS[:config]
-			aController.configure(job,CMD_OPTIONS)
-		end
-		aController.do_action(aAction,args,CMD_OPTIONS)
+		CMD_OPTIONS[:config] = args.first if aAction == :backup
+		CMD_OPTIONS[:config] = 'yore.config.xml' if !CMD_OPTIONS[:config] && File.exists?('yore.config.xml')
+		aController.configure(CMD_OPTIONS[:config],CMD_OPTIONS) unless CMD_OPTIONS.empty?
+
+		aController.do_action(aAction,args)
   end
   aParser.add_command(c)
 end

data/lib/yore/yore_core.rb

@@ -1,20 +1,9 @@
 require 'rubygems'
-gem 'RequirePaths'; require 'require_paths'
-require_paths '.','..'
-
+gem 'buzzware-buzzcore'; require 'buzzcore';
 
 require 'fileutils'
 require 'net/smtp'
 
-require 'ihl_ruby/misc_utils'
-require 'ihl_ruby/logging'
-require 'ihl_ruby/string_utils'
-require 'ihl_ruby/xml_utils'
-require 'ihl_ruby/extend_base_classes'
-require 'ihl_ruby/shell_extras'
-require 'ihl_ruby/config'
-require 'ihl_ruby/database_utils'
-
 THIS_FILE = File.expand_path(__FILE__)
 THIS_DIR = File.dirname(THIS_FILE)
 
@@ -156,11 +145,20 @@ module YoreCore
 			return xdoc.root
 		end
 		
-		def get_rails_db_details(aRailsPath,aRailsEnv)
+		def get_rails_db_details(aRailsPath,aRailsEnv,aFile=nil)
 			return nil unless aRailsPath && aRailsEnv && aRailsEnv!=''
-			return nil unless dbyml = (YAML::load(File.open(File.expand_path('config/database.yml',aRailsPath))) rescue nil)	
+			yml_file = MiscUtils.path_combine(aRailsPath,aFile || 'config/database.yml')
+			return nil unless dbyml = (YAML::load(File.open(yml_file)) rescue nil)	
 			return dbyml[aRailsEnv] && dbyml[aRailsEnv].symbolize_keys
 		end
+		
+		def self.find_upwards(aStartPath,aPath)
+			curr_path = File.expand_path(aStartPath)
+			while curr_path && !(test_path_exists = File.exists?(test_path = File.join(curr_path,aPath))) do
+				curr_path = MiscUtils.path_parent(curr_path)
+			end
+			curr_path && test_path_exists ? test_path : nil
+		end
 
 		def expand_app_option(kind=nil)
 			kind = config[:kind] unless kind && !kind.empty?
@@ -173,7 +171,23 @@ module YoreCore
 					if xmlSources
 						strSource = <<-EOS
 							<Source Type="File">
-								<IncludePath>public/assets/products</IncludePath>
+								<IncludePath BasePath="public/assets">products</IncludePath>
+							</Source>
+						EOS
+						XmlUtils.add_xml_from_string(strSource,xmlSources)
+					end
+					expand_app_option('rails')	# do again
+				# 
+				# if capistrano deployed, uploads are assumed to be in shared/uploads
+				#
+				when 'browsercms'
+					# add file source
+					xmlSources = XmlUtils.single_node(config.xmlRoot,'/Yore/Sources')
+					if xmlSources
+						uploadParent = File.join(config[:basepath],'tmp') unless config[:basepath]['/releases/'] && uploadParent = Yore.find_upwards(config[:basepath],'shared')
+						strSource = <<-EOS
+							<Source Type="File">
+								<IncludePath BasePath="#{uploadParent}">uploads</IncludePath>
 							</Source>
 						EOS
 						XmlUtils.add_xml_from_string(strSource,xmlSources)
@@ -185,12 +199,12 @@ module YoreCore
 					#if (dbyml = YAML::load(File.open(File.expand_path('config/database.yml',config[:basepath]))) rescue nil)
 					#	if env = (config[:RAILS_ENV] && config[:RAILS_ENV]!='' && config[:RAILS_ENV])
 					#		if (db_details = dbyml[env]) &&
-					db_details = get_rails_db_details(config[:basepath],config[:RAILS_ENV])
 					xmlSources = XmlUtils.single_node(config.xmlRoot,'/Yore/Sources')
-					if db_details && xmlSources
+					if xmlSources
+						#<Database Name="#{db_details[:database]}" Host="#{db_details[:host]}" User="#{db_details[:username]}" Password="#{db_details[:password]}">
 						strSource = <<-EOS
 							<Source Type="MySql" >
-								<Database Name="#{db_details[:database]}" Host="#{db_details[:host]}" User="#{db_details[:username]}" Password="#{db_details[:password]}">
+								<Database Yml="config/database.yml">
 									<ArchiveFile>rails_app.sql</ArchiveFile>
 								</Database>
 							</Source>
@@ -240,10 +254,10 @@ module YoreCore
       @keepers << KeepMonthly.new(config[:keep_monthly])
     end
 		
-		def do_action(aAction,aArgs,aCmdOptions)
+		def do_action(aAction,aArgs)
 			logger.info "Executing command: #{aAction} ...\n"
 			begin
-				send(aAction,aArgs,aCmdOptions)
+				send(aAction,aArgs)
 			rescue Exception => e
 				logger.info {e.backtrace.join("\n")}				
 				logger.warn "#{e.class.to_s}: during #{aAction.to_s}(#{(aArgs && aArgs.inspect).to_s}): #{e.message.to_s}"
@@ -416,15 +430,25 @@ module YoreCore
       )
     end
 
-    def self.database_from_xml(aDatabaseNode)
-      return {
-        :host => aDatabaseNode.attributes['Host'],
-        :username => aDatabaseNode.attributes['User'],
-        :password => aDatabaseNode.attributes['Password'],
-        :database => aDatabaseNode.attributes['Name'],
+    def database_from_xml(aDatabaseNode)
+			result = {
         :file => XmlUtils::peek_node_value(aDatabaseNode, "ToFile"),
         :archive_file => XmlUtils::peek_node_value(aDatabaseNode, "ArchiveFile")
-      }
+			}
+			if config[:RAILS_ENV] && (yml=aDatabaseNode.attributes['Yml'] || !aDatabaseNode.attributes['Name'])		# has yml or doesn't have database name
+				raise StandardError.new("RAILS_ENV must be given to read #{yml}") if !config[:RAILS_ENV] || config[:RAILS_ENV].empty?
+				db_details = get_rails_db_details(config[:basepath],config[:RAILS_ENV],yml)
+				raise StandardError.new('insufficient or missing database configuration') if !db_details
+				result.merge!(db_details)
+			else
+				result.merge!({
+					:host => aDatabaseNode.attributes['Host'],
+					:username => aDatabaseNode.attributes['User'],
+					:password => aDatabaseNode.attributes['Password'],
+					:database => aDatabaseNode.attributes['Name'],
+				})
+			end
+			result
     end
 		
 		
@@ -438,10 +462,11 @@ module YoreCore
 						when 'File' then
 							# BasePath tag provides base path for IncludePaths to be relative to. Also indicates root folder for archive 
 							bp = MiscUtils.path_combine(config[:basepath],XmlUtils::peek_node_value(xmlSource, "@BasePath"))
-							filelist << '-C'+bp
 							REXML::XPath.each(xmlSource, 'IncludePath') do |xmlPath|
-								files = MiscUtils::recursive_file_list(MiscUtils::path_combine(bp,xmlPath.text))
-								files.map!{|f| MiscUtils.path_debase(f,bp)}
+								bp2 = MiscUtils.path_combine(bp,XmlUtils::peek_node_value(xmlPath,"@BasePath"))
+								filelist << '-C'+bp2
+								files = MiscUtils::recursive_file_list(MiscUtils::path_combine(bp2,xmlPath.text))
+								files.map!{|f| MiscUtils.path_debase(f,bp2)}
 								filelist += files
 								sourceFound = true
 							end
@@ -452,10 +477,10 @@ module YoreCore
 							#	</Database>
 							#</Source>
 							REXML::XPath.each(xmlSource, 'Database') do |xmlDb|
-								args = Yore::database_from_xml(xmlDb)
+								args = database_from_xml(xmlDb)
 								file = args.delete(:file)							#legacy, absolute path
 								arc_file = args.delete(:archive_file)	#path in archive
-								unless args[:host] && args[:username] && args[:password] && args[:database] && (file||arc_file)
+								unless args[:username] && args[:password] && args[:database] && (file||arc_file)
 									raise StandardError.new("Invalid or missing parameter")
 								end
 								if arc_file
@@ -506,17 +531,12 @@ module YoreCore
 		#		ACTIONS
 		#
 
-		def save(aArgs,aCmdOptions=nil)
+		def save(aArgs)
 			fnArchive = aArgs.is_a?(Array) ? aArgs.first : aArgs	#only supported argument
-			configure(nil,aCmdOptions)
 			save_internal(fnArchive)
 		end
 
-    def backup(aArgs,aCmdOptions=nil)	# was aJobFiles
-			unless aCmdOptions && aCmdOptions[:config]	# assume already configured if config option specified, but back supports first arg being config file
-				job = aArgs.first
-				configure(job,aCmdOptions || {})
-			end			
+    def backup(aArgs)	# was aJobFiles
       temp_file = File.expand_path('backup.tar',temp_path)
 			save_internal(temp_file)
       backup_file = File.expand_path(encode_file_name(),temp_path)
@@ -527,7 +547,6 @@ module YoreCore
 				
 		def load(aArgs,aCmdOptions=nil)
 			fnArchive = aArgs.is_a?(Array) ? aArgs.first : aArgs	#only supported argument
-			configure(nil,aCmdOptions)
 
 			FileUtils.mkdir_p(archive_path = File.join(temp_path,'archive'))
 			uncompress(fnArchive,archive_path)
@@ -538,18 +557,26 @@ module YoreCore
 						#<Source Type="File">
 						#	<IncludePath>public/assets/products</IncludePath>
 						#</Source>
+						#
+						# arcparent = parent_folder(IncludePath.text)
+						# arcfolder = File.basename(IncludePath.text)
+						# destination = MiscUtils.path_combine(basepath,IncludePath.text)
+						bpSource = MiscUtils.path_combine(config[:basepath],XmlUtils::peek_node_value(xmlSource, "@BasePath"))
 						REXML::XPath.each(xmlSource,'IncludePath') do |xmlIncludePath|
+							bpInclude = MiscUtils.path_combine(bpSource,XmlUtils::peek_node_value(xmlIncludePath, "@BasePath"))
+
 							pathArchive = xmlIncludePath.text()
 							pathUncompressed = File.join(archive_path,pathArchive)
 							pathTmp = File.join(rails_tmp_path,pathArchive)
-							pathDest = File.join(config[:basepath],pathArchive)
-							# move basepath/relativepath to tmp/yore/090807-010203/relativepath
+							pathDest = File.join(bpInclude,pathArchive)
+
+							# move basepath/relativepath to tmp/yore/090807-010203/relativepath (out of the way)
 							Yore::move_folder(pathDest,pathTmp) if File.exists?(pathDest)
 							# get <IncludeFiles> and copy to basepath/relativepath
 							Yore::copy_folder(pathUncompressed,pathDest) if File.exists?(pathUncompressed)
 						end
 					when 'MySql' then
-						db_details = Yore::database_from_xml(XmlUtils.single_node(xmlSource,'Database'))
+						db_details = database_from_xml(XmlUtils.single_node(xmlSource,'Database'))
 						DatabaseUtils.load_database(db_details,File.join(archive_path,db_details[:archive_file]))
 				end
 			end						

data/notes.txt

@@ -0,0 +1,27 @@
+
+debug,info,warning,error
+
+* log warning and above to STDERR
+* report used with all detail levels, all sent to log ?
+* log warning and above sent to report
+
+Perhaps :
+* one logger. 
+* Report includes info+
+* STDERR includes warning+
+
+Write log splitter that looks like a logger, and is created with an array of other loggers.
+All log actions are replicated on the array of loggers
+
+loggers :
+ConsoleLogger: (debug-info to STDOUT,warning+ to STDERR) (no timestamp)
+ReportLogger: (info+ to report file) standard logger class (minimised timestamp)
+SystemLogger: all levels to /var/log (rolling file) SysLogLogger ? (standard timestamp)
+
+
+* only 2 files
+* 
+
+*** Use this for parsing PHP configs
+http://github.com/mattfawcett/ruby-reads-php/tree/master
+

data/test/S3_test.rb

@@ -1,8 +1,5 @@
 require 'rubygems'
-gem 'RequirePaths'; require 'require_paths'
-require_paths '../../..','../lib' 
-require 'ihl_ruby/misc_utils'
-require 'ihl_ruby/shell_extras'
+gem 'buzzware-buzzcore'; require 'buzzcore';
 require 'yore/yore_core'
 require 'test/unit'
 gem 'Shoulda'; require 'shoulda'
@@ -93,7 +90,7 @@ class S3Test < Test::Unit::TestCase
 			_xmlRoot = XmlUtils.get_xml_root(job_content)
 			cmd_options = {:config => job_file}
 			@yore_upload = YoreCore::Yore::launch(_xmlRoot,cmd_options,{:basepath => File.dirname(File.expand_path(job_file))})
-			@yore_upload.backup([job_file],cmd_options)
+			@yore_upload.backup([job_file])
 		rescue ::StandardError => e
 			flunk e.inspect
 		end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'yore'
+
+class Test::Unit::TestCase
+end

data/test/test_job_b.xml

@@ -12,7 +12,7 @@
 		<Item Name="log_level">INFO</Item>
 		<Item Name="email_report">false</Item>
 
-		<Item Name="mail_host">mail.authsmtp.com</Item>
+		<Item Name="mail_host">mail.com</Item>
 		<Item Name="mail_port">25</Item>
 		<Item Name="mail_helodomain">blah.com</Item>
 		<Item Name="mail_user">erewrwer</Item>