asrake 0.8.0

data/lib/asrake/package_task.rb

@@ -0,0 +1,55 @@
+require 'rake/tasklib'
+require 'zip/zip'
+
+module ASRake
+class PackageTask < Rake::TaskLib
+
+	attr_accessor :output
+	attr_accessor :files
+
+	attr_reader :output_file
+	attr_reader :output_dir
+
+	def initialize(name = :package)
+
+		yield self if block_given?
+
+		fail "You must define 'output' for #{self}" if output == nil
+		fail "You must define 'files' to include for #{self}" if files == nil
+
+		#define named task first so if desc was called it will be attached to it instead of the file task
+		Rake::Task.define_task name do
+			puts "#{c output} (#{File.size(output)} bytes)"
+		end
+
+		#if the task name is a hash (ie, has dependencies defined) make sure we pull out the task name from it
+		name, _ = name.first if name.is_a? Hash
+
+		@output_dir = File.dirname(output)
+		@output_file = File.basename(output)
+
+		directory output_dir
+
+		# setup file dependencies
+		file output => output_dir
+		files.each do |to, from|
+			file output => [cf(from)]
+		end
+		
+		#add output file task as a dependency to the named task created
+		task name => output
+
+		#create the zip task
+		file output do
+			rm_r output rescue nil
+			Zip::ZipFile.open(output, Zip::ZipFile::CREATE) do |zipfile|
+				files.each do |to, from|
+					zipfile.add(cf(to), cf(from))
+				end
+			end
+		end
+
+	end
+
+end
+end

data/lib/asrake/version/component.rb

@@ -0,0 +1,90 @@
+# (The MIT License)
+# 
+# Copyright (c) 2010-2010 Stephen Touset
+# 
+# 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.
+
+class Version::Component
+	attr_accessor :digits
+	attr_accessor :letter
+	
+	#
+	# Creates a single Component of a version, consisting of digits and
+	# possibly a letter. For example, +1+, +3a+, +12+, or +0+.
+	#
+	def initialize(component)
+		parts = component.split /(?=\D)/
+		
+		self.digits = parts[0].to_i
+		self.letter = parts[1].to_s.strip
+	end
+	
+	def initialize_copy(other)
+		self.digits = other.digits
+		self.letter = other.letter.dup
+	end
+	
+	def prerelease?
+		not self.letter.empty?
+	end
+	
+	def unprerelease!
+		self.next! if self.prerelease?
+	end
+	
+	def next(pre = false)
+		self.dup.next!(pre)
+	end
+	
+	def next!(pre = false)
+		case
+			when (	  pre and	  self.prerelease?) then self.letter.next!
+			when (    pre and not self.prerelease?) then self.letter = 'a'
+			when (not pre and	  self.prerelease?) then self.letter = ''
+			when (not pre and not self.prerelease?) then self.digits = self.digits.next
+		end
+		
+		self
+	end
+	
+	def <=>(other)
+		self.to_sortable_a <=> other.to_sortable_a
+	end
+	
+	def to_sortable_a
+		[ self.digits, self.prerelease? ? 0 : 1, self.letter ]
+	end
+	
+	def to_a
+		[ self.digits, self.letter ]
+	end
+	
+	def to_i
+		self.digits
+	end
+	
+	def to_s
+		self.to_a.join
+	end
+	
+	def inspect
+		self.to_s.inspect
+	end
+end

data/lib/asrake/version/version.rb

@@ -0,0 +1,250 @@
+# (The MIT License)
+# 
+# Copyright (c) 2010-2010 Stephen Touset
+# 
+# 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.
+
+require 'pathname'
+
+#
+# Encodes version-numbering logic into a convenient class.
+#
+class Version
+	include Comparable
+	autoload :Component, 'asrake/version/component'
+	#
+	# Searches through the parent directories of the calling method and looks
+	# for a VERSION or VERSION.yml file to parse out the current version. Pass
+	#
+	# Pass a filename to +path+ to override autodetection, or pass a directory
+	# name as +path+ to autodetect within a given directory
+	#
+	def self.current(path = nil)
+		# if path is nil, detect automatically; if path is a directory, detect
+		# automatically in the directory; if path is a filename, use it directly
+		path = path ? Pathname.new(path) : self.version_file(caller.first)
+		path = self.version_file(path) unless path.nil? or path.file?
+		
+		return nil unless path
+		
+		case path.extname
+			when ''		then Version.to_version(path.read.strip)
+			when '.yml'	then Version.to_version(YAML::load(path.read))
+		end
+	end
+	
+	#
+	# Attempts to detect the version file for the passed +filename+. Looks up
+	# the directory hierarchy for a file named VERSION or VERSION.yml. Returns
+	# a Pathname for the file if found, otherwise nil.
+	#
+	def self.version_file(filename)
+		Pathname(filename).dirname.expand_path.ascend do |d|
+			break d.join('VERSION')		 if d.join('VERSION').file?
+			break d.join('VERSION.yml') if d.join('VERSION.yml').file?
+		end
+	end
+
+	# 
+	# Converts a String, Hash, or Array into a Version instance
+	#
+	def self.to_version(obj)
+		if obj.kind_of? String
+			Version.new *obj.split(%r{\.})
+		elsif obj.kind_of? Hash
+			Version.new *obj.values_at(:major, :minor, :revision, :rest)
+		elsif obj.kind_of? Array
+			Version.new *obj
+		end
+	end
+	
+	#
+	# Creates a new version number, with a +major+ version number, +minor+
+	# revision number, +revision+ number, and optionally more (unnamed)
+	# version components.
+	#
+	def initialize(major, minor = 0, revision = nil, *rest)
+		self.components = [ major, minor, revision, *rest ]
+	end
+	
+	#
+	# For +major+, +minor+, and +revision+, make a helper method that gets and
+	# sets each based on accessing indexes.
+	#--
+	# TODO: make these rdoc-capable
+	#++
+	#
+	[ :major, :minor, :revision ].to_enum.each.with_index do |component, i|
+		define_method(:"#{component}")	{ self.components[i] ? self.components[i].to_s : nil }
+		define_method(:"#{component}=") {|v| self[i] = v	}
+	end
+	
+	#
+	# Set the component of the Version at +index+ to +value+. Zeroes out any
+	# trailing components.
+	#
+	# If +index+ is greater than the length of the version number, pads the
+	# version number with zeroes until +index+.
+	#
+	def []=(index, value)
+		return self.resize!(index)							 if value.nil? || value.to_s.empty?
+		return self[self.length + index] = value if index < 0
+		
+		length = self.length - index
+		zeroes = Array.new length.abs, Version::Component.new('0')
+		value	= Version::Component.new(value.to_s)
+		
+		if length >= 0
+			self.components[index, length] = zeroes
+			self.components[index]				 = value
+		else
+			self.components += zeroes
+			self.components << value
+		end
+	end
+	
+	def prerelease?
+		self.components.any? {|c| c.prerelease? }
+	end
+	
+	#
+	# Resizes the Version to +length+, removing any trailing components. Is a
+	# no-op if +length+ is greater than its current length.
+	#
+	def resize!(length)
+		self.components = self.components.take(length)
+		self
+	end
+	
+	#
+	# Bumps the version number. Pass +component+ to bump a component other than
+	# the least-significant part. Set +pre+ to true if you want to bump the
+	# component to a prerelease version. Set +trim+ to true if you want the
+	# version to be resized to only large enough to contain the component set.
+	#
+	#		"1.0.4a".bump!											 # => '1.0.4'
+	#		"1.0.4a".bump!(:pre)								 # => '1.0.4b'
+	#		"1.0.4a".bump!(:minor, false, true)	# => '1.1'
+	#		"1.0.4a".bump!(:minor, true, true)	 # => '1.1a
+	#		"1.0.4a".bump!(:minor, true, false)	# => '1.1.0a'
+	#
+	def bump!(component = -1, pre = false, trim = false)
+		case component
+			when :major		then self.bump!(0,	pre,	trim)
+			when :minor		then self.bump!(1,	pre,	trim)
+			when :revision	then self.bump!(2,	pre,	trim)
+			when :pre		then self.bump!(-1,	true,	trim)
+			else
+				# resize to match the new length, if applicable
+				self.resize!(component + 1) if (trim or component >= self.length)
+				
+				# mark all but the changed bit as non-prerelease
+				self[0...component].each(&:unprerelease!)
+				
+				# I don't even understand this part any more; god help you
+				self[component] = self[component].next	if		pre and self.prerelease? and component == self.length - 1
+				self[component] = self[component].next	unless	pre and self.prerelease? and component == -1
+				self[-1]		= self[-1].next(true)	if		pre
+				self
+		end
+	end
+
+	def bump(component = -1, pre = false, trim = false)
+		return (Version.to_version(self.to_hash)).bump!(component, pre, trim)
+	end
+		
+	#
+	# Returns the current length of the version number.
+	#
+	def length
+		self.components.length
+	end
+	
+	#
+	# Compares a Version against any +other+ object that responds to
+	# +to_version+.
+	#
+	def <=>(other)
+		self.components <=> other.to_version.components
+	end
+	
+	#
+	# Converts the version number into an array of its components.
+	#
+	def to_a
+		self.components.map {|c| c.to_s }
+	end
+	
+	#
+	# Converts the version number into a hash of its components.
+	#
+	def to_hash
+		{ :major		=> self.major,
+			:minor		=> self.minor,
+			:revision => self.revision,
+			:rest		 => self.length > 3 ? self.to_a.drop(3) : nil }.
+			delete_if {|k,v| v.nil? }
+	end
+	
+	#
+	# The canonical representation of a version number.
+	#
+	def to_s
+		self.to_a.join('.')
+	end
+	
+	#
+	# Returns +self+.
+	#
+	def to_version
+		self
+	end
+	
+	#
+	# Returns a YAML representation of the version number.
+	#
+	def to_yaml
+		YAML::dump(self.to_hash)
+	end
+	
+	#
+	# Returns a human-friendly version format.
+	#
+	def inspect
+		self.to_s.inspect
+	end
+	
+	protected
+	
+	#
+	# Retrieves the component of the Version at +index+.
+	#
+	def [](index)
+		self.components[index] || Component.new('0')
+	end
+	
+	def components
+		@components ||= []
+	end
+	
+	def components=(components)
+		components.each_with_index {|c, i| self[i] = c }
+	end
+end

data/lib/asrake/version_task.rb

@@ -0,0 +1,90 @@
+require 'rake/tasklib'
+
+require 'asrake/version/version'
+
+module ASRake
+class VersionTask < Rake::TaskLib
+
+	attr_accessor :filename
+	attr_accessor :filetype
+	attr_reader :version
+
+	def initialize(name = :version, filename = "VERSION")
+		self.filename = filename
+
+		yield self if block_given?
+
+		# fail if no filename was provided
+		fail "You must define 'filename' for #{self}" if filename == nil
+
+		@path = Pathname.new(self.filename)
+		# set filetype from the filename if it hasn't been set already
+		self.filetype ||= @path.extname[1..-1]
+
+		# read in the current version
+		contents = @path.read rescue '0.0.0'
+		@version = case filetype.to_s
+			when ''		then Version.to_version(contents.chomp)
+			when 'yml'	then Version.to_version(YAML::load(contents))
+		end
+
+		# create the primary version task
+		desc "Increment version from #{@version}"
+		@version_task = Rake::Task.define_task name
+
+		# if the task name is a hash (ie, has dependencies defined) make sure we pull out the task name from it
+		name, _ = name.first if name.is_a? Hash
+
+		Rake::Task.define_task name, [:part] => filename do |t, args|
+			case (args[:part] || "").chomp.downcase
+				when 'major'
+					puts "Incremented version from #{@version} to #{save(@version.bump!(:major))}"
+				when 'minor'
+					puts "Incremented version from #{@version} to #{save(@version.bump!(:minor))}"
+				when 'revision', 'rev', 'patch'
+					puts "Incremented version from #{@version} to #{save(@version.bump!(:revision))}"
+				when ''
+					puts "Current version is #{@version}"
+				else
+					fail "Invalid version argument '#{args[:part]}', run 'rake #{@help_task}' for help."
+			end
+			@sync_task.execute()
+		end
+
+		file filename do
+			puts "Created version #{save(Version.to_version(ENV['VERSION'] || '0.0.0'))} at #{filename}"
+		end
+		
+		# create a namespace with the same name as the task to provide further options
+		namespace name do
+
+			#add to this task to perform some operation post-bump
+			@sync_task = task :sync
+			
+			desc "Display help for version task"
+			@help_task = task :help do
+				puts "Version number format is Major.Minor.Revision (aka Major.Minor.Patch)"
+				puts "To display the current version, run without arguments"
+				puts "rake #{@version_task} => #{@version}"
+				puts "To increment the version, provide the respective part as an argument."
+				puts "rake #{@version_task}[major]    => #{@version.bump(:major)}"
+				puts "rake #{@version_task}[minor]    => #{@version.bump(:minor)}"
+				puts "rake #{@version_task}[revision] => #{@version.bump(:revision)}"
+			end
+		end
+
+	end
+	
+	private 
+
+	def save(version)
+		@path.open('w') do |file|
+			file << case filetype.to_s
+				when ''		then version.to_s + "\n"
+				when 'yml'	then version.to_yaml
+			end
+		end
+		return version
+	end
+end
+end