configurability 1.0.4 → 1.0.5

data.tar.gz.sig

@@ -1,2 +1 @@
-3�B���/�d2:��6��rqe�~z��s
-�)��A1�fQl��a⾡���,���}u�#��x�-#s���X*�M��
�Q��p?��]�GJ��Q%�}��ޢ���&%~�P��Y����"�T���\OgC���-m����~<�5Ԓw
+#�Ы�݈�1�O�0���@� #���U(��+�AvߜkU���!��,���<��~�:[@ 
��ߜ����}ߧBAϯ�¹����m-}����9��t]`d�K���t9�BY�_�����?���

data/History.md

@@ -0,0 +1,40 @@
+## 1.0.5 [2011-02-08] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+* Now handles config files with nil keys correctly.
+
+
+## 1.0.4 [2010-11-29] Michael Granger <ged@FaerieMUD.org>
+
+Packaging fix.
+
+
+## 1.0.3 [2010-11-29] Michael Granger <ged@FaerieMUD.org>
+
+Enchancements:
+
+* Propagate the installed config to objects that add Configurability after the
+  config is loaded.
+
+
+## 1.0.2 [2010-11-29] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+* Fixes for specs under 1.9.2.
+
+
+## 1.0.1 [2010-08-08] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+* Adding a Configurability::Config class for YAML config loading.
+* Add an rspec shared behavior for testing classes with Configurability
+* Converted tests to RSpec 2.
+
+
+## 1.0.0 [2010-07-12] Michael Granger <ged@FaerieMUD.org>
+
+Initial release
+

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010, Michael Granger
+Copyright (c) 2010, 2011 Michael Granger
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -1,10 +1,21 @@
 # Configurability
 
+* http://bitbucket.org/ged/configurability
+
+
+## Description
+
 Configurability is a mixin that allows you to add configurability to one or
 more objects or classes. You can assign them each a subsection of the
 configuration, and then later, when the configuration is loaded, the
 configuration is split up and sent to the objects that will use it.
 
+
+## Installation
+
+    gem install configurability
+
+
 ## Usage
 
 To add configurability to a class, just require the library and extend
@@ -214,23 +225,23 @@ or write it back to the file it was loaded from:
 	config.write
 
 
-
 ## Development
 
-You can submit bug reports, suggestions, and read more about future plans at
-the project page:
+You can submit bug reports, suggestions, clone it with Mercurial, and read
+more about future plans at [the project page][projectpage]. If you prefer Git,
+there is also a [Github mirror][gitmirror].
 
-> http://bitbucket.org/ged/configurability
+After checking out the source, run:
 
-or clone it with Mercurial from the same address. If you prefer Git, there is 
-also a mirror of the repo on Github:
+    $ rake newb
 
-> https://github.com/ged/configurability
+This task will install any missing dependencies, run the tests/specs,
+and generate the API documentation.
 
 
 ## License
 
-Copyright (c) 2010, Michael Granger
+Copyright (c) 2010, 2011  Michael Granger
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -258,3 +269,7 @@ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+
+[projectpage]:http://bitbucket.org/ged/configurability
+[gitmirror]:https://github.com/ged/configurability
+

data/Rakefile

@@ -1,362 +1,88 @@
-#!rake -*- ruby -*-
-#
-# configurability rakefile
-#
-# Based on various other Rakefiles, especially one by Ben Bleything
-#
-# Copyright (c) 2007-2010 The FaerieMUD Consortium
-#
-# Authors:
-#  * Michael Granger <ged@FaerieMUD.org>
-#
-
-BEGIN {
-	require 'rbconfig'
-	require 'pathname'
-	basedir = Pathname.new( __FILE__ ).dirname
-
-	libdir = basedir + "lib"
-	extdir = libdir + Config::CONFIG['sitearch']
-
-	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
-	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
-	$LOAD_PATH.unshift( extdir.to_s ) unless $LOAD_PATH.include?( extdir.to_s )
-}
+#!/usr/bin/env rake
 
 begin
-	require 'readline'
-	include Readline
+	require 'hoe'
 rescue LoadError
-	# Fall back to a plain prompt
-	def readline( text )
-		$stderr.print( text.chomp )
-		return $stdin.gets
-	end
-end
-
-begin
-	require 'rubygems'
-rescue LoadError
-	module Gem
-		class Specification; end
-	end
-end
-
-require 'pathname'
-require 'rbconfig'
-require 'rake'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/clean'
-# require 'rake/191_compat.rb'
-
-$dryrun = false
-
-### Config constants
-BASEDIR       = Pathname.new( __FILE__ ).dirname.relative_path_from( Pathname.getwd )
-BINDIR        = BASEDIR + 'bin'
-LIBDIR        = BASEDIR + 'lib'
-EXTDIR        = BASEDIR + 'ext'
-DOCSDIR       = BASEDIR + 'docs'
-PKGDIR        = BASEDIR + 'pkg'
-DATADIR       = BASEDIR + 'data'
-
-MANUALDIR     = DOCSDIR + 'manual'
-
-PROJECT_NAME  = 'configurability'
-PKG_NAME      = PROJECT_NAME.downcase
-PKG_SUMMARY   = 'A configurability mixin for Ruby'
-
-# Cruisecontrol stuff
-CC_BUILD_LABEL     = ENV['CC_BUILD_LABEL']
-CC_BUILD_ARTIFACTS = ENV['CC_BUILD_ARTIFACTS'] || 'artifacts'
-
-VERSION_FILE  = LIBDIR + 'configurability.rb'
-if VERSION_FILE.exist? && buildrev = ENV['CC_BUILD_LABEL']
-	PKG_VERSION = VERSION_FILE.read[ /VERSION\s*=\s*['"](\d+\.\d+\.\d+)['"]/, 1 ] + '.' + buildrev
-elsif VERSION_FILE.exist?
-	PKG_VERSION = VERSION_FILE.read[ /VERSION\s*=\s*['"](\d+\.\d+\.\d+)['"]/, 1 ]
+	abort "This Rakefile requires 'hoe' (gem install hoe)"
 end
 
-PKG_VERSION = '0.0.0' unless defined?( PKG_VERSION ) && !PKG_VERSION.nil?
 
-PKG_FILE_NAME = "#{PKG_NAME.downcase}-#{PKG_VERSION}"
-GEM_FILE_NAME = "#{PKG_FILE_NAME}.gem"
+Hoe.plugin :mercurial
+Hoe.plugin :yard
+Hoe.plugin :signing
 
-# Universal VCS constants
-DEFAULT_EDITOR  = 'vi'
-COMMIT_MSG_FILE = 'commit-msg.txt'
-FILE_INDENT     = " " * 12
-LOG_INDENT      = " " * 3
+Hoe.plugins.delete :rubyforge
 
-EXTCONF       = EXTDIR + 'extconf.rb'
 
-ARTIFACTS_DIR = Pathname.new( CC_BUILD_ARTIFACTS )
+hoespec = Hoe.spec 'configurability' do
+	self.readme_file = 'README.md'
+	self.history_file = 'History.md'
 
-TEXT_FILES    = Rake::FileList.new( %w[Rakefile ChangeLog README* LICENSE] )
-BIN_FILES     = Rake::FileList.new( "#{BINDIR}/*" )
-LIB_FILES     = Rake::FileList.new( "#{LIBDIR}/**/*.rb" )
-EXT_FILES     = Rake::FileList.new( "#{EXTDIR}/**/*.{c,h,rb}" )
-DATA_FILES    = Rake::FileList.new( "#{DATADIR}/**/*" )
+	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
-SPECDIR       = BASEDIR + 'spec'
-SPECLIBDIR    = SPECDIR + 'lib'
-SPEC_FILES    = Rake::FileList.new( "#{SPECDIR}/**/*_spec.rb", "#{SPECLIBDIR}/**/*.rb" )
+	self.extra_dev_deps.push *{
+		'rspec' => '~> 2.4',
+	}
 
-TESTDIR       = BASEDIR + 'tests'
-TEST_FILES    = Rake::FileList.new( "#{TESTDIR}/**/*.tests.rb" )
+	self.spec_extras[:licenses] = ["BSD"]
+	self.spec_extras[:post_install_message] = %{
 
-RAKE_TASKDIR  = BASEDIR + 'rake'
-RAKE_TASKLIBS = Rake::FileList.new( "#{RAKE_TASKDIR}/*.rb" )
-PKG_TASKLIBS  = Rake::FileList.new( "#{RAKE_TASKDIR}/{191_compat,helpers,packaging,rdoc,testing}.rb" )
-PKG_TASKLIBS.include( "#{RAKE_TASKDIR}/manual.rb" ) if MANUALDIR.exist?
+		New!
+		
+	}.gsub( /^\t{2}/, '' )
 
-RAKE_TASKLIBS_URL = 'http://repo.deveiate.org/rake-tasklibs'
+	self.spec_extras[:signing_key] = '/Volumes/Keys/ged-private_gem_key.pem'
 
-LOCAL_RAKEFILE = BASEDIR + 'Rakefile.local'
+	self.require_ruby_version( '>= 1.8.7' )
 
-EXTRA_PKGFILES = Rake::FileList.new
+	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
+	self.yard_opts = [ '--protected', '--verbose' ] if self.respond_to?( :yard_opts= )
 
-RELEASE_FILES = TEXT_FILES + 
-	SPEC_FILES + 
-	TEST_FILES + 
-	BIN_FILES +
-	LIB_FILES + 
-	EXT_FILES + 
-	DATA_FILES + 
-	RAKE_TASKLIBS +
-	EXTRA_PKGFILES
-
-
-RELEASE_FILES << LOCAL_RAKEFILE.to_s if LOCAL_RAKEFILE.exist?
-
-RELEASE_ANNOUNCE_ADDRESSES = [
-	"Ruby-Talk List <ruby-talk@ruby-lang.org>",
-]
-
-COVERAGE_MINIMUM = ENV['COVERAGE_MINIMUM'] ? Float( ENV['COVERAGE_MINIMUM'] ) : 85.0
-RCOV_EXCLUDES = 'spec,tests,/Library/Ruby,/var/lib,/usr/local/lib'
-RCOV_OPTS = [
-	'--exclude', RCOV_EXCLUDES,
-	'--xrefs',
-	'--save',
-	'--callsites',
-	#'--aggregate', 'coverage.data' # <- doesn't work as of 0.8.1.2.0
-  ]
-
-
-### Load some task libraries that need to be loaded early
-if !RAKE_TASKDIR.exist?
-	$stderr.puts "It seems you don't have the build task directory. Shall I fetch it "
-	ans = readline( "for you? [y]" )
-	ans = 'y' if !ans.nil? && ans.empty?
-
-	if ans =~ /^y/i
-		$stderr.puts "Okay, fetching #{RAKE_TASKLIBS_URL} into #{RAKE_TASKDIR}..."
-		system 'hg', 'clone', RAKE_TASKLIBS_URL, "./#{RAKE_TASKDIR}"
-		if ! $?.success?
-			fail "Damn. That didn't work. Giving up; maybe try manually fetching?"
-		end
-	else
-		$stderr.puts "Then I'm afraid I can't continue. Best of luck."
-		fail "Rake tasklibs not present."
-	end
-
-	RAKE_TASKLIBS.include( "#{RAKE_TASKDIR}/*.rb" )
-end
-
-require RAKE_TASKDIR + 'helpers.rb'
-include RakefileHelpers
-
-# Set the build ID if the mercurial executable is available
-if hg = which( 'hg' )
-	id = `#{hg} id -n`.chomp
-	PKG_BUILD = (id.chomp[ /^[[:xdigit:]]+/ ] || '1')
-else
-	PKG_BUILD = '0'
+	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
 end
-SNAPSHOT_PKG_NAME = "#{PKG_FILE_NAME}.#{PKG_BUILD}"
-SNAPSHOT_GEM_NAME = "#{SNAPSHOT_PKG_NAME}.gem"
-
-# Documentation constants
-API_DOCSDIR = DOCSDIR + 'api'
-README_FILE = TEXT_FILES.find {|path| path =~ /^README/ } || 'README'
-RDOC_OPTIONS = [
-	'--tab-width=4',
-	'--show-hash',
-	'--include', BASEDIR.to_s,
-	"--main=#{README_FILE}",
-	"--title=#{PKG_NAME}",
-  ]
-YARD_OPTIONS = [
-	'--use-cache',
-	'--protected',
-	'-r', README_FILE,
-	'--exclude', 'extconf\\.rb',
-	'--files', 'ChangeLog,LICENSE',
-	'--output-dir', API_DOCSDIR.to_s,
-	'--title', "#{PKG_NAME} #{PKG_VERSION}",
-  ]
-
-# Release constants
-SMTP_HOST = "mail.faeriemud.org"
-SMTP_PORT = 465 # SMTP + SSL
-
-# Project constants
-PROJECT_HOST = 'deveiate.org'
-PROJECT_PUBDIR = '/usr/local/www/public/code'
-PROJECT_DOCDIR = "#{PROJECT_PUBDIR}/#{PKG_NAME}"
-PROJECT_SCPPUBURL = "#{PROJECT_HOST}:#{PROJECT_PUBDIR}"
-PROJECT_SCPDOCURL = "#{PROJECT_HOST}:#{PROJECT_DOCDIR}"
-
-GEM_PUBHOST = 'rubygems.org'
 
-# Gem dependencies: gemname => version
-DEPENDENCIES = {
-}
+ENV['VERSION'] ||= hoespec.spec.version.to_s
 
-# Developer Gem dependencies: gemname => version
-DEVELOPMENT_DEPENDENCIES = {
-	'rake'          => '~> 0.8.7',
-	'rcodetools'    => '~> 0.7.0.0',
-	'rcov'          => '~> 0.8.1.2.0',
-	'yard'          => '~> 0.6.1',
-	'RedCloth'      => '~> 4.2.3',
-	'rspec'         => '~> 2.0.1',
-	'ruby-termios'  => '~> 0.9.6',
-	'text-format'   => '~> 1.0.0',
-	'tmail'         => '~> 1.2.3.1',
-}
+# Ensure the specs pass before checking in
+task 'hg:precheckin' => :spec
 
-# Non-gem requirements: packagename => version
-REQUIREMENTS = {
-}
-
-# RubyGem specification
-GEMSPEC   = Gem::Specification.new do |gem|
-	gem.name              = PKG_NAME.downcase
-	gem.version           = PKG_VERSION
-
-	gem.summary           = PKG_SUMMARY
-	gem.description       = [
-		"Configurability is a mixin that allows you to add ",
-		"configurability to one or more classes, assign them ",
-		"each a section of the configuration, and then when ",
-		"the configuration is loaded, the class is given the ",
-		"section it requested.",
-  	  ].join( "\n" )
-
-	gem.authors           = ["Michael Granger"]
-	gem.email             = ["ged@FaerieMUD.org"]
-	gem.homepage          = 'http://bitbucket.org/ged/configurability'
-	gem.licenses          = ["BSD"]
-
-	gem.has_rdoc          = true
-	gem.rdoc_options      = RDOC_OPTIONS
-	gem.extra_rdoc_files  = TEXT_FILES - [ 'Rakefile' ]
-
-	gem.bindir            = BINDIR.relative_path_from(BASEDIR).to_s
-	gem.executables       = BIN_FILES.select {|pn| File.executable?(pn) }.
-	                            collect {|pn| File.basename(pn) }
-	gem.require_paths << EXTDIR.relative_path_from( BASEDIR ).to_s if EXTDIR.exist?
-
-	if EXTCONF.exist?
-		gem.extensions << EXTCONF.relative_path_from( BASEDIR ).to_s
-	end
-
-	gem.files             = RELEASE_FILES
-	gem.test_files        = SPEC_FILES
-
-	# signing key and certificate chain
-	gem.signing_key       = '/Volumes/Keys/ged-private_gem_key.pem'
-	gem.cert_chain        = [File.expand_path('~/.gem/ged-public_gem_cert.pem')]
-
-
-	gem.required_ruby_version = '>= 1.8.7'
-
-	DEPENDENCIES.each do |name, version|
-		version = '>= 0' if version.length.zero?
-		gem.add_runtime_dependency( name, version )
-	end
-
-	REQUIREMENTS.each do |name, version|
-		gem.requirements << [ name, version ].compact.join(' ')
-	end
-end
-
-$trace = Rake.application.options.trace ? true : false
-$dryrun = Rake.application.options.dryrun ? true : false
-$include_dev_dependencies = false
-
-# Load any remaining task libraries
-RAKE_TASKLIBS.each do |tasklib|
-	next if tasklib.to_s =~ %r{/helpers\.rb$}
-	begin
-		trace "  loading tasklib %s" % [ tasklib ]
-		import tasklib
-	rescue ScriptError => err
-		fail "Task library '%s' failed to load: %s: %s" %
-			[ tasklib, err.class.name, err.message ]
-		trace "Backtrace: \n  " + err.backtrace.join( "\n  " )
-	rescue => err
-		log "Task library '%s' failed to load: %s: %s. Some tasks may not be available." %
-			[ tasklib, err.class.name, err.message ]
-		trace "Backtrace: \n  " + err.backtrace.join( "\n  " )
+begin
+	include Hoe::MercurialHelpers
+
+	### Task: prerelease
+	desc "Append the package build number to package versions"
+	task :pre do
+		rev = get_numeric_rev()
+		trace "Current rev is: %p" % [ rev ]
+		hoespec.spec.version.version << "pre#{rev}"
+		Rake::Task[:gem].clear
+
+		Gem::PackageTask.new( hoespec.spec ) do |pkg|
+			pkg.need_zip = true
+			pkg.need_tar = true
+		end
 	end
-end
-
-# Load any project-specific rules defined in 'Rakefile.local' if it exists
-import LOCAL_RAKEFILE if LOCAL_RAKEFILE.exist?
-
-
-#####################################################################
-###	T A S K S 	
-#####################################################################
-
-### Default task
-task :default  => [:clean, :local, :spec, :apidocs, :package]
 
-### Task the local Rakefile can append to -- no-op by default
-task :local
-
-### Task: clean
-CLEAN.include 'coverage', '**/*.orig', '**/*.rej'
-CLOBBER.include 'artifacts', 'coverage.info', 'ChangeLog', PKGDIR
-
-### Task: changelog
-file 'ChangeLog' do |task|
-	log "Updating #{task.name}"
-
-	changelog = make_changelog()
-	File.open( task.name, 'w' ) do |fh|
-		fh.print( changelog )
+	### Make the ChangeLog update if the repo has changed since it was last built
+	file '.hg/branch'
+	file 'ChangeLog' => '.hg/branch' do |task|
+		$stderr.puts "Updating the changelog..."
+		content = make_changelog()
+		File.open( task.name, 'w', 0644 ) do |fh|
+			fh.print( content )
+		end
 	end
-end
-
 
-### Task: cruise (Cruisecontrol task)
-desc "Cruisecontrol build"
-task :cruise => [:clean, 'spec:quiet', :package] do |task|
-	raise "Artifacts dir not set." if ARTIFACTS_DIR.to_s.empty?
-	artifact_dir = ARTIFACTS_DIR.cleanpath + (CC_BUILD_LABEL || Time.now.strftime('%Y%m%d-%T'))
-	artifact_dir.mkpath
+	# Rebuild the ChangeLog immediately before release
+	task :prerelease => 'ChangeLog'
 
-	coverage = BASEDIR + 'coverage'
-	if coverage.exist? && coverage.directory?
-		$stderr.puts "Copying coverage stats..."
-		FileUtils.cp_r( 'coverage', artifact_dir )
+rescue NameError => err
+	task :no_hg_helpers do
+		fail "Couldn't define the :pre task: %s: %s" % [ err.class.name, err.message ]
 	end
 
-	$stderr.puts "Copying packages..."
-	FileUtils.cp_r( FileList['pkg/*'].to_a, artifact_dir )
-end
-
+	task :pre => :no_hg_helpers
+	task 'ChangeLog' => :no_hg_helpers
 
-desc "Update the build system to the latest version"
-task :update_build do
-	log "Updating the build system"
-	run 'hg', '-R', RAKE_TASKDIR, 'pull', '-u'
-	log "Updating the Rakefile"
-	sh 'rake', '-f', RAKE_TASKDIR + 'Metarakefile'
 end