Rename from version_task to rake-versioning

Author: Ernie Prabhakar

History.rdoc

@@ -20,8 +20,8 @@
   * Version#prerelease? to determine if it's a prerelease version
   * Version#bump! now accepts symbolic indexes
   * Version#inspect has slightly friendlier output
-  * VersionTask now correctly bumps prerelease versions
-  * VersionTask has new version:bump:pre task
+  * RakeVersioning now correctly bumps prerelease versions
+  * RakeVersioning has new version:bump:pre task
   * now properly MIT-licensed
   * somewhat spec'd
 
@@ -44,7 +44,7 @@
 
 * enhancements
   * support for committing and tagging through git
-    * see rdoc for Rake::VersionTask
+    * see rdoc for Rake::RakeVersioning
 
 === Version 0.6.2 / 2010-02-05
 
@@ -66,15 +66,15 @@
   * readme and history files
   * extended documentation
   * support for easy version-file management through rake
-    * see rdoc for Rake::VersionTask
+    * see rdoc for Rake::RakeVersioning
   * support auto-setting VERSION constant in classes
     * see rdoc for Class::Versioned()
-  * eating own dogfood with Rake::VersionTask
+  * eating own dogfood with Rake::RakeVersioning
   * make Version#to_hash exclude keys with nil values
 
 * todo for 1.0.0
   * full suite of specs
-  * remove duplication in Class::Version() and Rake::VersionTask
+  * remove duplication in Class::Version() and Rake::RakeVersioning
   * get rid of gem task warnings
 
 === Version 0.5.0 / 2010-02-04

README.rdoc

@@ -1,35 +1,34 @@
-= Version
+= Rake Versioning
 
-* http://github.com/stouset/version
-* http://rdoc.info/gems/version/
-* http://atlruby.org/stouset/posts/138-version-task
+* https://github.com/drernie/rake-versioning
+* FROM: http://github.com/stouset/version / http://rdoc.info/gems/version/ / http://atlruby.org/stouset/posts/138-version-task
 
 == Description
 
-Version is a simple wrapper around the concept of version-numbering schemes.
+Rake Versioning is a simple wrapper around the concept of version-numbering schemes.  It is forked from the "Version" gem as that name caused numerous complications in my environment.
 
 == Features
 
-* Rake::VersionTask provides tasks for simple version bumping
-* Version smartly handles several versioning schemes, abstracting the details
+* Rake::VersioningTask provides tasks for simple version bumping
+* Rake Versioning smartly handles several versioning schemes, abstracting the details
 
 == Examples
 
 === Screencast
 
-For a quick introduction, watch the
-screencast[http://blip.tv/file/get/Tkadom-ATLRUGSteveTousetPresentingVersion277.mov]
+For a quick introduction to the original gem, watch the
+screencast[http://blip.tv/file/get/Tkadom-ATLRUGSteveTousetPresentingRake Versioning277.mov]
 of my presentation[http://atlruby.org/stouset/posts/138-version-task] at the
 {Atlanta Ruby Users' Group}[http://atlruby.org/].
 
 === Rake Tasks
 
-Version comes with a Rake::VersionTask that lets you manage version numbering
+Rake Versioning comes with a Rake::Rake VersioningTask that lets you manage version numbering
 automatically. Place the following in a Rakefile:
 
-  require 'rake/version_task'
-  Rake::VersionTask.new
-  
+  require 'rake/rake_versioning'
+  Rake::Rake VersioningTask.new
+
 You're all set up.
 
   $ rake version:create VERSION=0.1.0 # => 0.1.0
@@ -58,51 +57,51 @@ Now `rake -T version` will tell you what all you can do.
   $ rake version:bump:minor           # => 1.1.0
   $ cat VERSION                       # => 1.1.0
 
-The VersionTask can automatically manage git tagging for
+The Rake VersioningTask can automatically manage git tagging for
 you, too.
 
-  Rake::VersionTask.new do |task|
+  Rake::Rake VersioningTask.new do |task|
     task.with_git_tag = true
   end
 
-And if you want the VersionTask to automatically emit updated gemspecs on
+And if you want the Rake VersioningTask to automatically emit updated gemspecs on
 version-bumps, use the +with_gemspec+ flag.
 
   spec = Gem::Specification.new do |s|
     ...
   end
-  
-  Rake::VersionTask.new do |task|
+
+  Rake::Rake VersioningTask.new do |task|
     task.with_gemspec = spec
   end
-  
-Version also supports a .yml VERSION file. See the VersionTask rdoc for
+
+Rake Versioning also supports a .yml VERSION file. See the Rake VersioningTask rdoc for
 details.
 
-=== Library Versioning
+=== Library Rake Versioninging
 
-Version lets you automatically keep an in-class VERSION constant in sync with
-the contents of the version file on disk. Version also provides a class-level
+Rake Versioning lets you automatically keep an in-class VERSION constant in sync with
+the contents of the version file on disk. Rake Versioning also provides a class-level
 +current+ method which lets you get the current version without setting a
 class-level constant.
 
   require 'version'
-  
-  Version.current # => 1.0.1
-  
+
+  Rake Versioning.current # => 1.0.1
+
   class Foo
     is_versioned
   end
-  
+
   Foo::VERSION # => 1.0.1
-  
-The Version.current and Class::is_versioned methods both take a filename
+
+The Rake Versioning.current and Class::is_versioned methods both take a filename
 parameter if you use a different location for the VERSION file. See the
-Version.current rdoc for details.
+Rake Versioning.current rdoc for details.
 
 === Manipulation in Code
 
-All the above functionality is performed behind-the-scenes by the Version
+All the above functionality is performed behind-the-scenes by the Rake Versioning
 library. It's simple to use, but I'll be surprised if there's much point
 beyond doing the legwork for the Rake task and class versioning.
 
@@ -113,7 +112,7 @@ beyond doing the legwork for the Rake task and class versioning.
   v.bump!(:minor, false, true) # => 2.1
   v.major = 3                  # => 3.0
   v.to_a                       # => ['3', '0']
-  
+
 == Install
 
   [sudo] gem install version

Rakefile

@@ -1,15 +1,15 @@
 $: << 'lib'
 
-require 'rake/version_task'
+require 'rake/rake_versioning'
 
 require 'rubygems'
 require 'rubygems/package_task'
 require 'rdoc/task'
 require 'spec/rake/spectask'
 
 spec = Gem::Specification.new do |s|
-  s.name    = 'version'
-  s.version = VersionTask::Version.current or '0.0.0'
+  s.name    = 'rake-versioning'
+  s.version = RakeVersioning::Version.current or '0.0.0'
   s.summary = 'simple version-number encapsulation'
 
   s.author  = 'Stephen Touset'
@@ -29,7 +29,7 @@ Gem::PackageTask.new(spec) do |gem|
 end
 
 Rake::RDocTask.new do |doc|
-  doc.title    = "version #{VersionTask::Version.current}"
+  doc.title    = "version #{RakeVersioning::Version.current}"
   doc.rdoc_dir = 'doc'
   doc.main     = 'README.rdoc'
   doc.rdoc_files.include('*.rdoc')
@@ -40,7 +40,7 @@ Spec::Rake::SpecTask.new(:spec) do |task|
   task.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-Rake::VersionTask.new do |v|
+Rake::RakeVersioning.new do |v|
   v.with_git_tag = true
   v.with_gemspec = spec
 end

TODO.rdoc

@@ -1,4 +1,4 @@
 * remove file parsing duplication between Version.current and
-  Rake::VersionTask
+  Rake::RakeVersioning
 * get rid of gem task warnings
 * improved pre-bumping (version:bump:major:pre?)

VERSION

@@ -1,18 +1,18 @@
-require 'version_task/ext/array'
-require 'version_task/ext/module'
-require 'version_task/ext/hash'
-require 'version_task/ext/string'
+require 'rake_versioning/ext/array'
+require 'rake_versioning/ext/module'
+require 'rake_versioning/ext/hash'
+require 'rake_versioning/ext/string'
 
 require 'pathname'
 
 #
 # Encodes version-numbering logic into a convenient class.
 #
-module VersionTask
+module RakeVersioning
   class Version
     include Comparable
 
-    autoload :Component, 'version_task/component'
+    autoload :Component, 'rake_versioning/component'
 
     #
     # Searches through the parent directories of the calling method and looks
@@ -80,8 +80,8 @@ def []=(index, value)
       return self[self.length + index] = value if index < 0
 
       length = self.length - index
-      zeroes = Array.new length.abs, VersionTask::Version::Component.new('0')
-      value  = VersionTask::Version::Component.new(value.to_s)
+      zeroes = Array.new length.abs, RakeVersioning::Version::Component.new('0')
+      value  = RakeVersioning::Version::Component.new(value.to_s)
 
       if length >= 0
         self.components[index, length] = zeroes

lib/version_task.rb renamed to lib/rake-versioning.rb

@@ -1,6 +1,6 @@
-require 'version_task'
+require 'rake_versioning'
 
-class VersionTask::Version::Component
+class RakeVersioning::Version::Component
   attr_accessor :digits
   attr_accessor :letter
 

lib/version_task/component.rb renamed to lib/rake-versioning/component.rb

@@ -1,10 +1,10 @@
-require 'version_task'
+require 'rake_versioning'
 
 class Array
   #
   # Converts the Array into a version number.
   #
   def to_version
-    VersionTask::Version.new *self
+    RakeVersioning::Version.new *self
   end
 end

lib/version_task/ext/array.rb renamed to lib/rake-versioning/ext/array.rb

@@ -0,0 +1,10 @@
+require 'rake_versioning'
+
+class Hash
+  #
+  # Converts the Hash into a version number.
+  #
+  def to_version
+    RakeVersioning::Version.new *self.values_at(:major, :minor, :revision, :rest)
+  end
+end

lib/rake-versioning/ext/hash.rb

@@ -0,0 +1,11 @@
+require 'rake_versioning'
+
+class Module
+  #
+  # Automagically sets a VERSION constant in the current module according to
+  # the results of RakeVersioning::Version.current.
+  #
+  def is_versioned
+    const_set :VERSION, RakeVersioning::Version.current(File.dirname(caller.first))
+  end
+end