version 0.5.0 → 0.6.0

data/History.rdoc

@@ -0,0 +1,27 @@
+=== Version 0.6.0 / 2010-02-04
+
+* bug fixes
+  * when autozeroing version components, use strings, not integers
+
+* enhancements
+  * readme and history files
+  * extended documentation
+  * support for easy version-file management through rake
+    * see rdoc for Rake::VersionTask
+  * support auto-setting VERSION constant in classes
+    * see rdoc for Class::Versioned()
+  * eating own dogfood with Rake::VersionTask
+  * 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
+  * get rid of gem task warnings
+
+=== Version 0.5.0 / 2010-02-04
+
+* initial release
+
+* todo for 1.0.0
+  * full suite of specs
+  * version-bumping rake tasks

data/README.rdoc

@@ -0,0 +1,72 @@
+= Version
+
+* http://github.com/stouset/version
+* http://rdoc.info/projects/stouset/version
+* http://getcaliper.com/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fstouset%2Fversion.git
+
+== Description
+
+Version is a simple wrapper around the concept of version-numbering schemes.
+
+== Features
+
+* Rake::VersionTask provides tasks for simple version bumping
+* Version smartly handles several versioning schemes, abstracting the details
+
+== Examples
+
+
+=== Rake Tasks
+
+Version comes with a Rake::VersionTask that lets you manage version numbering
+automatically. Place the following in a Rakefile:
+
+  require 'rake/version_task'
+  Rake::VersionTask.new
+  
+You're all set up.
+
+  $ rake version:create VERSION=0.1.0 # => 0.1.0
+  $ rake version                      # => 0.1.0
+  $ rake version:bump                 # => 0.1.1
+  $ rake version:bump:minor           # => 0.2.0
+  $ rake version:bump:revision        # => 0.2.1
+  $ rake version:bump:major           # => 1.0.0
+  $ cat VERSION                       # => 1.0.0
+  
+Version also supports a .yml VERSION file. See the VersionTask rdoc for
+details.
+
+=== Library Versioning
+
+Version lets you automatically keep an in-class VERSION constant in sync with
+the contents of the version file on disk.
+
+  require 'version'
+  
+  class Foo
+    Version()
+  end
+  
+  Foo::VERSION # => 1.0.0
+  
+The Class::Version method takes a filename parameter if you use a different
+location for the VERSION file. See the Class::Version rdoc for details.
+
+=== Manipulation in Code
+
+All the above functionality is performed behind-the-scenes by the Version
+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.
+
+  v = "1.2.0".to_version
+  v.to_s           # => 1.2.0
+  v.bump!          # => 1.2.1
+  v.bump!(1)       # => 1.3.0
+  v.bump!(1, true) # => 1.3
+  v.major = 2      # => 2.0
+  v.to_a           # => ['2', '0']
+  
+== Install
+
+  [sudo] gem install version

data/Rakefile

@@ -1,6 +1,7 @@
 $: << 'lib'
 
 require 'version'
+require 'rake/version_task'
 
 require 'rubygems'
 require 'rake/gempackagetask'
@@ -12,7 +13,7 @@ spec = Gem::Specification.new do |s|
   s.author  = 'Stephen Touset'
   s.email   = 'stephen@touset.org'
   s.summary = 'simple version-number encapsulation'
-  s.version = '0.5.0'
+  s.version = Version::VERSION
   s.files   = FileList['[A-Z]*', 'lib/**/*.rb', 'spec/**/*']
   
   s.add_development_dependency 'rspec'
@@ -23,9 +24,7 @@ Rake::GemPackageTask.new(spec) do |gem|
 end
 
 Rake::RDocTask.new do |doc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  doc.title    = 'emcien-engine #{version}'
+  doc.title    = "emcien-engine #{Version::VERSION}"
   doc.rdoc_dir = 'doc'
   doc.rdoc_files.include('README*')
   doc.rdoc_files.include('lib/**/*.rb')
@@ -35,4 +34,6 @@ Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
+Rake::VersionTask.new
+
 task :default => :spec

data/TODO.rdoc

@@ -0,0 +1,4 @@
+* fully spec all functionality
+* remove file parsing duplication between Class::Version() and
+  Rake::VersionTask
+* get rid of gem task warnings

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/lib/ext/class.rb

@@ -0,0 +1,28 @@
+require 'pathname'
+
+class Class
+  #
+  # Automagically sets a VERSION constant in the current class, populated by
+  # the Version in +filename+. Attempts to guess the filename if none given.
+  # Can read both .yml files and plain text.
+  #
+  def Version(filename = nil)
+    # attempt to guess the filename if none given
+    if filename.nil?
+      filename = Pathname.new('.').expand_path.ascend do |d|
+        break d.join('VERSION')     if d.join('VERSION').exist?
+        break d.join('VERSION.yml') if d.join('VERSION.yml').exist?
+      end
+    end
+    
+    raise 'no VERSION or VERSION.yml found' unless filename
+    
+    path     = Pathname.new(filename)
+    contents = path.read
+    
+    const_set :VERSION, case path.extname
+      when ''      then contents.strip.to_version
+      when '.yml'  then YAML::load(contents).to_version
+    end
+  end
+end

data/lib/rake/version_task.rb

@@ -1,2 +1,98 @@
-require 'rake'
+require 'rake/tasklib'
+require 'pathname'
 
+class Rake::VersionTask < Rake::TaskLib
+  attr_accessor :filename
+  attr_writer   :filetype
+  
+  #
+  # Creates a new VersionTask with the given +filename+. Attempts to
+  # autodetect the +filetype+.
+  #
+  def initialize(filename = 'VERSION')
+    self.filename = filename
+    
+    yield(self) if block_given?
+    
+    self.define
+  end
+  
+  #
+  # The +filetype+ of the file to be generated. Is determined automatically
+  # if not set.
+  #
+  def filetype
+    @filetype || self.path.extname[1..-1]
+  end
+  
+  protected
+  
+  #
+  # The path for the +filename+.
+  #
+  def path
+    Pathname.new(self.filename)
+  end
+  
+  #
+  # Defines the rake tasks.
+  #
+  def define
+    fail 'Filename required' if self.filename.nil?
+    
+    file filename
+    
+    desc 'Print the current version number'
+    task(:version => filename) { puts read }
+    
+    namespace :version do
+      desc 'Creates a version file with an optional VERSION parameter'
+      task(:create ) do
+        version = (ENV['VERSION'] || '0.0.0').to_version
+        puts write(version)
+      end
+      
+      desc 'Bump the least-significant version number'
+      task(:bump => filename) { puts write(read.bump!) }
+      
+      namespace :bump do
+        desc 'Bump the major version number'
+        task(:major => filename) { puts write(read.bump!(0)) }
+        
+        desc 'Bump the minor version number'
+        task(:minor => filename) { puts write(read.bump!(1)) }
+        
+        desc 'Bump the revision number'
+        task(:revision => filename) { puts write(read.bump!(2)) }
+      end
+    end
+  end
+  
+  private
+  
+  #
+  # Returns the Version contained in the file at +filename+.
+  #
+  def read
+    contents = path.read
+    
+    case filetype.to_s
+      when ''    then contents.chomp.to_version
+      when 'yml' then YAML::load(contents).to_version
+    end
+  end
+  
+  #
+  # Writes out +version+ to the file at +filename+ with the correct format.
+  #
+  def write(version)
+    path.open('w') do |io|
+      io << case filetype.to_s
+        when ''    then version.to_s + "\n"
+        when 'yml' then version.to_yaml
+      end
+    end
+    
+    version
+  end
+end

data/lib/version.rb

@@ -1,4 +1,5 @@
 require 'ext/array'
+require 'ext/class'
 require 'ext/hash'
 require 'ext/string'
 
@@ -56,13 +57,13 @@ class Version
     
     if index < self.length
       length = self.length - index
-      zeroes = Array.new(length, 0)
+      zeroes = Array.new(length, '0')
       
       self.components[index, length] = zeroes
       self.components[index]         = value
     else
       length = index - self.length
-      zeroes = Array.new(length, 0)
+      zeroes = Array.new(length, '0')
       
       self.components += zeroes
       self.components << value
@@ -121,7 +122,8 @@ class Version
     { :major    => self.major,
       :minor    => self.minor,
       :revision => self.revision,
-      :rest     => self.length > 3 ? self.components.drop(3) : nil }
+      :rest     => self.length > 3 ? self.components.drop(3) : nil }.
+      delete_if {|k,v| v.nil? }
   end
   
   #
@@ -138,6 +140,13 @@ class Version
     self
   end
   
+  #
+  # Returns a YAML representation of the version number.
+  #
+  def to_yaml
+    YAML::dump(self.to_hash)
+  end
+  
   #
   # Aliased from +to_s+.
   #
@@ -147,3 +156,7 @@ class Version
   
   attr_accessor :components
 end
+
+class Version
+  Version()
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: version
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Stephen Touset
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-04 00:00:00 -05:00
+date: 2010-02-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,8 +31,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- History.rdoc
 - Rakefile
+- README.rdoc
+- TODO.rdoc
+- VERSION
 - lib/ext/array.rb
+- lib/ext/class.rb
 - lib/ext/hash.rb
 - lib/ext/string.rb
 - lib/rake/version_task.rb