version 0.8.0 → 0.9.0

data/History.rdoc

@@ -1,4 +1,21 @@
-=== Version 0.8.0 / (unreleased)
+=== Version 0.9.0 / 2010-02-15
+
+* bug fixes
+  * fixed project name in some areas
+  * ensure correct sorting of 1.9 <=> 1.10 (closes #3)
+  * ensure correct sorting of prerelease versions
+  * Version.current returns nil if no VERSION found (closes #4)
+
+* enhancements
+  * 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
+  * now properly MIT-licensed
+  * somewhat spec'd
+
+=== Version 0.8.0 / 2010-02-05
 
 * bug fixes
   * fixed README documentation to properly reflect is_versioned
@@ -6,7 +23,7 @@
     collisions with other gems
 
 * enhancements
-  * Added Version.current method (closes #2)
+  * added Version.current method (closes #2)
 
 === Version 0.7.1 / 2010-02-05
 
@@ -56,4 +73,4 @@
 
 * todo for 1.0.0
   * full suite of specs
-  * version-bumping rake tasks
+  * version-bumping rake tasks

data/License.txt

@@ -0,0 +1,23 @@
+(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.
+

data/README.rdoc

@@ -3,6 +3,7 @@
 * 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
+* http://atlruby.org/stouset/posts/138-version-task
 
 == Description
 
@@ -15,6 +16,12 @@ Version is a simple wrapper around the concept of version-numbering schemes.
 
 == Examples
 
+=== Screencast
+
+For a quick introduction, watch the
+screencast[http://blip.tv/file/get/Tkadom-ATLRUGSteveTousetPresentingVersion277.mov]
+of my presentation[http://atlruby.org/stouset/posts/138-version-task] at the
+{Atlanta Ruby Users' Group}[http://atlruby.org/].
 
 === Rake Tasks
 
@@ -31,6 +38,8 @@ You're all set up.
   $ rake version:bump                 # => 0.1.1
   $ rake version:bump:minor           # => 0.2.0
   $ rake version:bump:revision        # => 0.2.1
+  $ rake version:bump:pre             # => 0.2.1a
+  $ rake version:bump                 # => 0.2.2
   $ rake version:bump:major           # => 1.0.0
   $ rake version:bump:minor           # => 1.0.1
   $ cat VERSION                       # => 1.0.1
@@ -55,8 +64,9 @@ class-level constant.
   
   Foo::VERSION # => 1.0.1
   
-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.
+The Version.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.
 
 === Manipulation in Code
 
@@ -65,12 +75,12 @@ 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']
+  v.to_s                # => 1.2.0
+  v.bump!               # => 1.2.1
+  v.bump!(:major)       # => 1.3.0
+  v.bump!(:minor, true) # => 1.3
+  v.major = 2           # => 2.0
+  v.to_a                # => ['2', '0']
   
 == Install
 

data/Rakefile

@@ -1,6 +1,5 @@
 $: << 'lib'
 
-require 'version'
 require 'rake/version_task'
 
 require 'rubygems'
@@ -13,7 +12,7 @@ spec = Gem::Specification.new do |s|
   s.author  = 'Stephen Touset'
   s.email   = 'stephen@touset.org'
   s.summary = 'simple version-number encapsulation'
-  s.version = Version::VERSION
+  s.version = Version.current
   s.files   = FileList['[A-Z]*', 'lib/**/*.rb', 'spec/**/*']
   
   s.add_development_dependency 'rspec'
@@ -24,9 +23,10 @@ Rake::GemPackageTask.new(spec) do |gem|
 end
 
 Rake::RDocTask.new do |doc|
-  doc.title    = "emcien-engine #{Version::VERSION}"
+  doc.title    = "version #{Version.current}"
   doc.rdoc_dir = 'doc'
-  doc.rdoc_files.include('README*')
+  doc.main     = 'README.rdoc'
+  doc.rdoc_files.include('*.rdoc')
   doc.rdoc_files.include('lib/**/*.rb')
 end
 

data/TODO.rdoc

@@ -1,5 +1,4 @@
-* fully spec all functionality
-* remove file parsing duplication between Class::Version() and
+* remove file parsing duplication between Version.current and
   Rake::VersionTask
 * get rid of gem task warnings
-* support prerelease versions like Gem::Version
+* improved pre-bumping (version:bump:major:pre?)

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/lib/rake/version_task.rb

@@ -66,13 +66,16 @@ class Rake::VersionTask < Rake::TaskLib
       
       namespace :bump do
         desc 'Bump the major version number'
-        task(:major => filename) { puts write(read.bump!(0)) }
+        task(:major => filename) { puts write(read.bump!(:major)) }
         
         desc 'Bump the minor version number'
-        task(:minor => filename) { puts write(read.bump!(1)) }
+        task(:minor => filename) { puts write(read.bump!(:minor)) }
         
         desc 'Bump the revision number'
-        task(:revision => filename) { puts write(read.bump!(2)) }
+        task(:revision => filename) { puts write(read.bump!(:revision)) }
+        
+        desc 'Bump to a prerelease version'
+        task(:pre => filename) { puts write(read.bump!(:pre)) }
       end
     end
   end

data/lib/version.rb

@@ -11,6 +11,8 @@ require 'pathname'
 class Version
   include Comparable
   
+  autoload :Component, '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
@@ -22,9 +24,9 @@ class Version
     # 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.file?
-            
-    raise 'no VERSION or VERSION.yml found' unless path
+    path = self.version_file(path) unless path.nil? or path.file?
+    
+    return nil unless path
     
     case path.extname
       when ''      then path.read.strip.to_version
@@ -39,8 +41,8 @@ class Version
   #
   def self.version_file(filename)
     Pathname(filename).dirname.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?
+      break d.join('VERSION')     if d.join('VERSION').file?
+      break d.join('VERSION.yml') if d.join('VERSION.yml').file?
     end
   end
   
@@ -50,13 +52,7 @@ class Version
   # version components.
   #
   def initialize(major, minor = 0, revision = nil, *rest)
-    self.components = []
-    
-    self.major     = major
-    self.minor     = minor
-    self.revision  = revision
-    
-    rest.each.with_index {|v, i| self[3 + i] = v }
+    self.components = [ major, minor, revision, *rest ]
   end
   
   #
@@ -67,15 +63,15 @@ class Version
   #++
   #
   [ :major, :minor, :revision ].each.with_index do |component, i|
-    define_method(:"#{component}")  {    self[i]          }
-    define_method(:"#{component}=") {|v| self[i] = v.to_s }
+    define_method(:"#{component}")  {    self[i]     }
+    define_method(:"#{component}=") {|v| self[i] = v }
   end
   
   #
   # Retrieves the component of the Version at +index+.
   #
   def [](index)
-    self.components[index]
+    self.components[index] ? self.components[index].to_s : nil
   end
   
   #
@@ -84,33 +80,34 @@ class Version
   #
   # If +index+ is greater than the length of the version number, pads the
   # version number with zeroes until +index+.
-  #--
-  # TODO: rewrite sanely
-  #++
+  #
   def []=(index, value)
-    self.resize!(index) and return if value.nil? || value.empty?
+    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 index < self.length
-      length = self.length - index
-      zeroes = Array.new(length, '0')
-      
+    if length >= 0
       self.components[index, length] = zeroes
       self.components[index]         = value
     else
-      length = index - self.length
-      zeroes = Array.new(length, '0')
-      
       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[0, length]
+    self.components = self.components.take(length)
     self
   end
   
@@ -119,12 +116,21 @@ class Version
   # least-significant part. Set +trim+ to true if you want the version to be
   # resized to only large enough to contain the index.
   #
-  #    "1.0.4a".bump!          # => "1.0.4b"
-  #    "1.0.4b".bump!(1, true) # => "1.2"
+  #    "1.0.4a".bump!               # => '1.0.5'
+  #    "1.0.4a".bump!(:pre)         # => '1.0.5b'
+  #    "1.0.4a".bump!(:minor, true) # => '1.2'
   #
   def bump!(index = self.length - 1, trim = false)
-    self.resize!(index + 1) if trim
-    self[index] = (self[index] || -1).succ
+    case index
+      when :major    then self.bump!(0, trim)
+      when :minor    then self.bump!(1, trim)
+      when :revision then self.bump!(2, trim)
+      when :pre      then self[-1] = self.components[-1].next(true)
+      else
+        self.resize!(index + 1) if (trim or index >= self.length)
+        self[index] = self.components[index].next
+    end
+    
     self
   end
   
@@ -140,14 +146,14 @@ class Version
   # +to_version+.
   #
   def <=>(other)
-    self.to_a <=> other.to_version.to_a
+    self.components <=> other.to_version.components
   end
   
   #
   # Converts the version number into an array of its components.
   #
   def to_a
-    self.components
+    self.components.map {|c| c.to_s }
   end
   
   #
@@ -157,7 +163,7 @@ 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.to_a.drop(3) : nil }.
       delete_if {|k,v| v.nil? }
   end
   
@@ -165,7 +171,7 @@ class Version
   # The canonical representation of a version number.
   #
   def to_s
-    self.components.join('.')
+    self.to_a.join('.')
   end
   
   #
@@ -183,13 +189,21 @@ class Version
   end
   
   #
-  # Aliased from +to_s+.
+  # Returns a human-friendly version format.
   #
-  alias inspect to_s
+  def inspect
+    self.to_s.inspect
+  end
   
   protected
   
-  attr_accessor :components
+  def components
+    @components ||= []
+  end
+  
+  def components=(components)
+    components.each_with_index {|c, i| self[i] = c }
+  end
 end
 
 class Version

data/lib/version/component.rb

@@ -0,0 +1,65 @@
+require 'version'
+
+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 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/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 $:.unshift File.dirname(__FILE__)
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
-require 'emcien-engine'
+require 'version'
 require 'spec'
 require 'spec/autorun'
 

data/spec/version_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+module ImplicitVersion
+  def method_missing(name, *args, &block)
+    super unless args.empty?
+    super unless block.nil?
+    super unless name.to_s =~ /^v[\d\w_]+$/
+    
+    name.to_s.gsub(/^v/, '').gsub(/_/, '.').to_version
+  end
+end
+
+describe Version do
+  include ImplicitVersion
+  
+  subject { "1.6.3a".to_version }
+  
+  its(:major)       { should == '1'  }
+  its(:minor)       { should == '6'  }
+  its(:revision)    { should == '3a' }
+  its(:prerelease?) { should be_true }
+  
+  it 'should allow indexed access to components' do
+    subject[0].should == '1'
+    subject[1].should == '6'
+    subject[2].should == '3a'
+  end
+  
+  it 'should return nil for unset components' do
+    subject[3].should == nil
+    subject[4].should == nil
+  end
+  
+  it 'should major-bump to 2.0.0' do
+    subject.bump!(:major).should == v2_0_0
+  end
+  
+  it 'should minor-bump to 1.7.0' do
+    subject.bump!(:minor).should == v1_7_0
+  end
+  
+  it 'should revision-bump to 1.6.3' do
+    subject.bump!(:revision).should == v1_6_3
+  end
+  
+  it 'should prerelease-bump to 1.6.3b' do
+    subject.bump!(:pre).should == v1_6_3b
+  end
+end
+
+describe Version do
+  include ImplicitVersion
+  
+  it 'should preserve equality' do
+    v0_0.should       == v0_0
+    v0_1_1.should     == v0_1_1
+    v0_4_alpha.should == v0_4_alpha
+    v1_0_2.should     == v1_0_2
+    v1_0_2b.should    == v1_0_2b
+    v1_01.should      == v1_01
+    v1_10.should      == v1_10
+    v2_0.should       == v2_0
+    va.should         == vb
+  end
+  
+  it 'should order correctly' do
+    v0_0.should     < v0_0_0_0_0_1
+    v0_0_0_1.should < v1
+    v0_1a.should    < v0_1
+    v0_01.should    < v0_10
+    v0_9.should     < v0_10
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: version
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Stephen Touset
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 -05:00
+date: 2010-02-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,11 +32,13 @@ extra_rdoc_files: []
 
 files: 
 - History.rdoc
+- License.txt
 - Rakefile
 - README.rdoc
 - TODO.rdoc
 - VERSION
 - lib/rake/version_task.rb
+- lib/version/component.rb
 - lib/version/ext/array.rb
 - lib/version/ext/class.rb
 - lib/version/ext/hash.rb
@@ -44,6 +46,7 @@ files:
 - lib/version.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/version_spec.rb
 has_rdoc: true
 homepage: 
 licenses: []