buzzcore 0.2.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/README.rdoc

@@ -0,0 +1,46 @@
+= buzzcore
+
+* Author : http://www.buzzware.com.au
+
+== DESCRIPTION:
+
+Core library of Buzzware Solutions
+
+== FEATURES/PROBLEMS:
+
+* something
+
+== REQUIREMENTS:
+
+* tested on MacOS and Linux
+
+== INSTALL:
+
+ sudo gem sources -a http://gems.github.com
+ sudo gem install buzzware-buzzcore
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Gary McGhee, Buzzware Solutions
+
+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,63 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "buzzcore"
+    gem.summary = %Q{buzzcore is the ruby core library developed and used by Buzzware Solutions.}
+    gem.description = %Q{buzzcore is the ruby core library developed and used by Buzzware Solutions.}
+    gem.email = "contact@buzzware.com.au"
+    gem.homepage = "http://github.com/buzzware/buzzcore"
+    gem.authors = ["buzzware"]
+    #gem.rubyforge_project = "buzzware"
+    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 = "buzzcore #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.5

data/buzzcore.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{buzzcore}
+  s.version = "0.2.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["buzzware"]
+  s.date = %q{2009-10-06}
+  s.description = %q{buzzcore is the ruby core library developed and used by Buzzware Solutions.}
+  s.email = %q{contact@buzzware.com.au}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "buzzcore.gemspec",
+     "buzzcore.vpj",
+     "buzzcore.vpw",
+     "lib/buzzcore.rb",
+     "lib/buzzcore.rb",
+     "lib/buzzcore/config.rb",
+     "lib/buzzcore/database_utils.rb",
+     "lib/buzzcore/enum.rb",
+     "lib/buzzcore/extend_base_classes.rb",
+     "lib/buzzcore/html_utils.rb",
+     "lib/buzzcore/logging.rb",
+     "lib/buzzcore/misc_utils.rb",
+     "lib/buzzcore/require_paths.rb",
+     "lib/buzzcore/shell_extras.rb",
+     "lib/buzzcore/string_utils.rb",
+     "lib/buzzcore/text_doc.rb",
+     "lib/buzzcore/thread_utils.rb",
+     "lib/buzzcore/xml_utils.rb",
+     "lib/buzzcore_dev.rb",
+     "test/buzzcore_test.rb",
+     "test/config_test.rb",
+     "test/credentials_test.rb",
+     "test/shell_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/buzzware/buzzcore}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{buzzcore is the ruby core library developed and used by Buzzware Solutions.}
+  s.test_files = [
+    "test/buzzcore_test.rb",
+     "test/config_test.rb",
+     "test/credentials_test.rb",
+     "test/shell_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/buzzcore.vpj

@@ -0,0 +1,93 @@
+<!DOCTYPE Project SYSTEM "http://www.slickedit.com/dtd/vse/10.0/vpj.dtd">
+<Project
+	Version="10.0"
+	VendorName="SlickEdit"
+	WorkingDir=".">
+	<Config
+		Name="Release"
+		OutputFile=""
+		CompilerConfigName="Latest Version">
+		<Menu>
+			<Target
+				Name="Compile"
+				MenuCaption="&amp;Compile"
+				CaptureOutputWith="ProcessBuffer"
+				SaveOption="SaveCurrent"
+				RunFromDir="%rw">
+				<Exec/>
+			</Target>
+			<Target
+				Name="Build"
+				MenuCaption="&amp;Build"
+				CaptureOutputWith="ProcessBuffer"
+				SaveOption="SaveWorkspaceFiles"
+				RunFromDir="%rw">
+				<Exec/>
+			</Target>
+			<Target
+				Name="Rebuild"
+				MenuCaption="&amp;Rebuild"
+				CaptureOutputWith="ProcessBuffer"
+				SaveOption="SaveWorkspaceFiles"
+				RunFromDir="%rw">
+				<Exec/>
+			</Target>
+			<Target
+				Name="Debug"
+				MenuCaption="&amp;Debug"
+				SaveOption="SaveNone"
+				RunFromDir="%rw">
+				<Exec/>
+			</Target>
+			<Target
+				Name="Execute"
+				MenuCaption="E&amp;xecute"
+				SaveOption="SaveNone"
+				RunFromDir="%rw"
+				CaptureOutputWith="ProcessBuffer"
+				ClearProcessBuffer="1">
+				<Exec CmdLine="source actions.sh execute"/>
+			</Target>
+		</Menu>
+	</Config>
+	<CustomFolders>
+		<Folder
+			Name="Source Files"
+			Filters="*.c;*.C;*.cc;*.cpp;*.cp;*.cxx;*.c++;*.prg;*.pas;*.dpr;*.asm;*.s;*.bas;*.java;*.cs;*.sc;*.e;*.cob;*.html;*.rc;*.tcl;*.py;*.pl"/>
+		<Folder
+			Name="Header Files"
+			Filters="*.h;*.H;*.hh;*.hpp;*.hxx;*.inc;*.sh;*.cpy;*.if"/>
+		<Folder
+			Name="Resource Files"
+			Filters="*.ico;*.cur;*.dlg"/>
+		<Folder
+			Name="Bitmaps"
+			Filters="*.bmp"/>
+		<Folder
+			Name="Other Files"
+			Filters="">
+		</Folder>
+	</CustomFolders>
+	<Files AutoFolders="DirectoryView">
+		<Folder Name="lib">
+			<F
+				N="lib/*"
+				Recurse="1"
+				Refilter="0"
+				Excludes=""/>
+		</Folder>
+		<Folder Name="test">
+			<F
+				N="test/*"
+				Recurse="0"
+				Refilter="0"
+				Excludes=".svn/"/>
+		</Folder>
+		<F N="buzzcore.gemspec"/>
+		<F N="History.txt"/>
+		<F N="Manifest.txt"/>
+		<F N="PostInstall.txt"/>
+		<F N="Rakefile"/>
+		<F N="README.rdoc"/>
+	</Files>
+</Project>

data/buzzcore.vpw

@@ -0,0 +1,93 @@
+<!DOCTYPE Project SYSTEM "http://www.slickedit.com/dtd/vse/10.0/vpj.dtd">
+<Project
+	Version="10.0"
+	VendorName="SlickEdit"
+	WorkingDir=".">
+	<Config
+		Name="Release"
+		OutputFile=""
+		CompilerConfigName="Latest Version">
+		<Menu>
+			<Target
+				Name="Compile"
+				MenuCaption="&amp;Compile"
+				CaptureOutputWith="ProcessBuffer"
+				SaveOption="SaveCurrent"
+				RunFromDir="%rw">
+				<Exec/>
+			</Target>
+			<Target
+				Name="Build"
+				MenuCaption="&amp;Build"
+				CaptureOutputWith="ProcessBuffer"
+				SaveOption="SaveWorkspaceFiles"
+				RunFromDir="%rw">
+				<Exec/>
+			</Target>
+			<Target
+				Name="Rebuild"
+				MenuCaption="&amp;Rebuild"
+				CaptureOutputWith="ProcessBuffer"
+				SaveOption="SaveWorkspaceFiles"
+				RunFromDir="%rw">
+				<Exec/>
+			</Target>
+			<Target
+				Name="Debug"
+				MenuCaption="&amp;Debug"
+				SaveOption="SaveNone"
+				RunFromDir="%rw">
+				<Exec/>
+			</Target>
+			<Target
+				Name="Execute"
+				MenuCaption="E&amp;xecute"
+				SaveOption="SaveNone"
+				RunFromDir="%rw"
+				CaptureOutputWith="ProcessBuffer"
+				ClearProcessBuffer="1">
+				<Exec CmdLine="source actions.sh execute"/>
+			</Target>
+		</Menu>
+	</Config>
+	<CustomFolders>
+		<Folder
+			Name="Source Files"
+			Filters="*.c;*.C;*.cc;*.cpp;*.cp;*.cxx;*.c++;*.prg;*.pas;*.dpr;*.asm;*.s;*.bas;*.java;*.cs;*.sc;*.e;*.cob;*.html;*.rc;*.tcl;*.py;*.pl"/>
+		<Folder
+			Name="Header Files"
+			Filters="*.h;*.H;*.hh;*.hpp;*.hxx;*.inc;*.sh;*.cpy;*.if"/>
+		<Folder
+			Name="Resource Files"
+			Filters="*.ico;*.cur;*.dlg"/>
+		<Folder
+			Name="Bitmaps"
+			Filters="*.bmp"/>
+		<Folder
+			Name="Other Files"
+			Filters="">
+		</Folder>
+	</CustomFolders>
+	<Files AutoFolders="DirectoryView">
+		<Folder Name="lib">
+			<F
+				N="lib/*"
+				Recurse="1"
+				Refilter="0"
+				Excludes=""/>
+		</Folder>
+		<Folder Name="test">
+			<F
+				N="test/*"
+				Recurse="0"
+				Refilter="0"
+				Excludes=".svn/"/>
+		</Folder>
+		<F N="buzzcore.gemspec"/>
+		<F N="History.txt"/>
+		<F N="Manifest.txt"/>
+		<F N="PostInstall.txt"/>
+		<F N="Rakefile"/>
+		<F N="README.rdoc"/>
+	</Files>
+</Project>

data/lib/buzzcore/config.rb

@@ -0,0 +1,239 @@
+require 'buzzcore/xml_utils'
+require 'buzzcore/extend_base_classes'
+
+class ConfigClass < Hash
+
+	attr_reader :default_values
+
+	def initialize(aDefaultValues,aNewValues=nil,&aBlock)
+		@default_values = aDefaultValues.clone
+		reset()
+		if aNewValues
+			block_given? ? read(aNewValues,&aBlock) : read(aNewValues) 
+		end
+	end
+
+	# aBlock allows values to be filtered based on key,default and new values
+	def read(aSource,&aBlock)
+		default_values.each do |k,v|
+			done = false
+			if block_given? && ((newv = yield(k,v,aSource && aSource[k])) != nil)
+				self[k] = newv
+				done = true
+			end
+			copy_item(aSource,k) if !done && aSource && !aSource[k].nil?
+		end
+		self
+	end
+	
+	# reset values back to defaults
+	def reset
+		self.clear
+		me = self
+		@default_values.each {|n,v| me[n] = v.is_a?(Class) ? nil : v}
+	end
+
+	def set_int(aKey,aValue)
+		case aValue
+			when String then    self[aKey] = aValue.to_integer(self[aKey]);
+			when Fixnum then    self[aKey] = aValue;
+			when Float then     self[aKey] = aValue.to_i;
+		end
+	end
+
+	def set_float(aKey,aValue)
+		case aValue
+			when String then    self[aKey] = aValue.to_float(self[aKey]);
+			when Fixnum then    self[aKey] = aValue.to_f;
+			when Float then     self[aKey] = aValue;
+		end
+	end
+
+	def set_boolean(aKey,aValue)
+		case aValue
+			when TrueClass,FalseClass then   self[aKey] = aValue;
+			when String then    self[aKey] = (['1','yes','y','true','on'].include?(aValue.downcase))
+		else
+			set_boolean(aKey,aValue.to_s)
+		end
+	end
+	
+	def set_symbol(aKey,aValue)
+		case aValue
+			when String then    self[aKey] = (aValue.to_sym rescue nil);
+			when Symbol then    self[aKey] = aValue;
+		end
+	end
+
+	def copy_item(aHash,aKey)
+		d = default_values[aKey]
+		d_class = (d.is_a?(Class) ? d : d.class)
+		cname = d_class.name.to_sym
+		case cname
+			when :NilClass then ;
+			when :String then self[aKey] = aHash[aKey].to_s unless aHash[aKey].nil?
+			when :Float then set_float(aKey,aHash[aKey]);
+			when :Fixnum then set_int(aKey,aHash[aKey]);
+			when :TrueClass, :FalseClass then set_boolean(aKey,aHash[aKey]);
+			when :Symbol then self[aKey] = (aHash[aKey].to_sym rescue nil)
+			else
+				raise StandardError.new('unsupported type')
+		end
+	end
+
+	def copy_strings(aHash,*aKeys)
+		aKeys.each do |k|
+			self[k] = aHash[k].to_s unless aHash[k].nil?
+		end
+	end
+
+	def copy_ints(*aDb)
+		aHash = aDb.shift
+		aKeys = aDb
+		aKeys.each do |k|
+			set_int(k,aHash[k])
+		end
+	end
+
+	def copy_floats(aHash,*aKeys)
+		aKeys.each do |k|
+			set_float(k,aHash[k])
+		end
+	end
+
+	def copy_booleans(aHash,*aKeys)
+		aKeys.each do |k|
+			set_boolean(k,aHash[k])
+		end
+	end
+
+	def to_hash
+		{}.merge(self)
+	end
+
+end
+
+# use like this :
+#
+# in initializer or environment.rb :
+#APP_CONFIG = ConfigXmlClass.from_file(
+#	SITE_CONFIG_DEFAULTS = {
+#		:something => String,									# giving a class means the type is the given class, and the default value is nil
+#		:session_key => '_session',
+#		:upload_path=> 'cms/uploads',
+#		:thumbs_cache => File.expand_path('public/thumbs_cache',RAILS_ROOT),	# make sure this exists with correct permissions
+#		:thumbs_url => '/thumbs_cache'
+#	},
+#	File.expand_path('config/config.xml',RAILS_ROOT)
+#)
+#
+# config/logikal.config.xml :
+#
+#<?xml version="1.0" encoding="UTF-8"?>
+#<Config>
+#	<SimpleItems>
+#		<Item Name="upload_path">../shared/uploads</Item>
+#		<Item Name="something">a value</Item>
+#	</SimpleItems>
+#</Config>
+#
+# then throughout app eg. :
+# 
+# ... APP_CONFIG[:upload_path]
+#
+
+class ConfigXmlClass < ConfigClass
+	attr_accessor :xmlRoot
+	def initialize(aDefaultValues,aConfig)
+		return super(aDefaultValues,aConfig) unless aConfig.is_a?(REXML::Element)
+		@xmlRoot = aConfig.deep_clone
+		super(aDefaultValues,XmlUtils.read_simple_items(@xmlRoot,'SimpleItems').symbolize_keys)
+	end
+	
+	def self.from_file(aDefaultValues,aFile)
+		xml = XmlUtils.get_file_root(aFile)
+		return ConfigXmlClass.new(aDefaultValues,xml)
+	end
+end
+
+# credentials files look like :
+#<?xml version="1.0" encoding="UTF-8"?>
+#<Credentials>
+#	<SimpleItems namespace="global">
+#		<Item name=""></Item>
+#		<Item name=""></Item>
+#		<Item name=""></Item>
+#	</SimpleItems>
+#	<SimpleItems namespace="yore_test">
+#		<Item name=""></Item>
+#		<Item name=""></Item>
+#		<Item name=""></Item>
+#	</SimpleItems>
+#</Credentials>
+#
+# global .credentials.xml file  
+# local .credentials.xml file
+# cred = Credentials.new()	# optionally specify filename or path or hash. if nil then use Dir.pwd
+#
+# def initialize(aSource)
+#		# load global namespace from ~/.credentials.xml
+#		# load global namespace from local .credentials.xml
+#		# load given namespace from ~/.credentials.xml
+#		# load given namespace from local .credentials.xml
+#		# merge all top to bottom
+class Credentials < Hash
+
+	CRED_FILENAME = ".credentials.xml"
+
+	def find_file_upwards(aFilename,aStartPath=nil)
+		aStartPath ||= Dir.pwd
+		return nil if aFilename.nil? || aFilename.empty?
+		arrPath = aStartPath.split(File::SEPARATOR)
+		while arrPath.length > 0
+			path = File.join(arrPath.join(File::SEPARATOR),aFilename)
+			return path if File.exists?(path)
+			arrPath.pop
+		end
+		return nil
+	end
+	
+	def get_all_credentials(aXmlRoot)
+		return nil unless aXmlRoot
+		result = {}
+		REXML::XPath.each(aXmlRoot, '/Credentials/SimpleItems') do |si|
+			ns = si.attributes['Namespace']
+			values = XmlUtils.read_simple_items(si)
+			result[ns.to_sym] = values.symbolize_keys if ns && values
+		end
+		return result
+	end
+
+	#XmlUtils.read_simple_items(@xmlRoot,'/Yore/SimpleItems')
+	def get_user_credentials
+		return get_all_credentials(XmlUtils.get_file_root(File.join(HOME_PATH,CRED_FILENAME)))
+	end
+
+	def get_local_credentials(aSource=nil)
+		aSource ||= Dir.pwd
+		# assume source is a directory path, but other types could be supported later
+		return nil unless file=find_file_upwards(CRED_FILENAME,aSource)
+		return get_all_credentials(XmlUtils.get_file_root(file))
+	end
+
+	def initialize(aNamespace=nil,aSource=nil)
+		#HOME_PATH can be preset by tests eg. ::Credentials.const_set('HOME_PATH',@user_dir)
+		Credentials.const_set("HOME_PATH", ENV['HOME']) unless Credentials.const_defined? "HOME_PATH"
+		arrCredentials = []
+		user_credentials = get_user_credentials()
+		local_credentials = get_local_credentials(aSource)
+		arrCredentials << user_credentials[:global] if user_credentials
+		arrCredentials << local_credentials[:global] if local_credentials
+		arrCredentials << user_credentials[aNamespace.to_sym] if aNamespace && user_credentials
+		arrCredentials << local_credentials[aNamespace.to_sym] if aNamespace && local_credentials
+		arrCredentials.compact!
+		arrCredentials.each do |c|
+			self.merge!(c)
+		end
+	end
+end
+