thor-scmversion 0.3.1 → 1.0.0

data/README.md

@@ -46,9 +46,27 @@ Now when you list your thor tasks you'll see 2 new ones.
     
     version
     -------
-    thor version:bump TYPE  # Bump version number (type is major, minor, patch or auto)
+    thor version:bump TYPE [PRERELEASE_TYPE]  # Bump version number (type is major, minor, patch, prerelease or auto)
+                                              # Prerelease allows an additional parameter to be passed which is used 
+                                              # as the prerelease type.
     thor version:current    # Show current SCM tagged version
 
+Usage Examples:
+  $ thor version:current
+  1.2.1
+  $ thor version:bump auto
+  1.2.2
+  $ thor version:bump major
+  2.0.0
+  $ thor version:bump prerelease
+  2.0.1-alpha.1
+  $ thor version:bump prerelease
+  2.0.1-alpha.2
+  $ thor version:bump prerelease beta
+  2.0.1-beta.1
+  $ thor version:bump minor
+  2.1.0
+
 ### Remove your VERSION file from source control
 
 Since your CI server will be managing your VERSION file, you don't
@@ -77,23 +95,24 @@ run `thor version:bump patch`. This will increment the patch, push the
 new tag, and write the VERSION file. Now the artifact you build will
 have the right version information, every time.
 
-### You manage the major and minor
+### You manage the major, minor patch and prerelease
 
-When you make significant changes, you can bump the major or minor
+When you make significant changes, you can bump the major, minor or patch
 number yourself with `thor version:bump minor`. This will create a tag
 with a .0 patch level, so the next build made by the server will be
 .1 patch level.
 
 ### Auto bumping
 
-If you include #major or #minor in the subject of commits, and run
-`thor version:bump auto` it will see if any major or minor level changes
+If you include #major, #minor or #patch in the subject of commits, and run
+`thor version:bump auto` it will see if any major, minor or patch level changes
 are included since the last tag, and use the appropriate version. This works
 especially well with a CI server, allowing you to never have to directly
-manage versions at all.
+manage versions at all. If no commits are tagged, the build number for the
+current version will be bumped instead.
 
 NOTE: auto bumping currently only works for Git repos. For Perforce repos,
-auto is the same as patch.
+auto is the same as build.
 
 
 ## Contributing

data/features/bump.feature

@@ -3,74 +3,34 @@ Feature: Bump
   I want to be able to bump the version of a project's with a simple command
   So that I don't have to do it manually
 
-  Scenario: Bumping a patch version in Git
-    Given I have a git project of version '1.0.0'
-    When I run `bundle exec thor version:bump patch` from the temp directory
-    Then the version should be '1.0.1'
-    And the origin version should be '1.0.1'
-
-   Scenario: Bumping a minor version in Git
-     Given I have a git project of version '1.0.0'
-     When I run `bundle exec thor version:bump minor` from the temp directory
-     Then the version should be '1.1.0'
-     And the origin version should be '1.1.0'
-
-   Scenario: Bumping a major version in Git
-     Given I have a git project of version '1.0.0'
-     When I run `bundle exec thor version:bump major` from the temp directory
-     Then the version should be '2.0.0'
-     And the origin version should be '2.0.0'
-
-   Scenario: Bumping a minor version in Git should reset the patch version
-     Given I have a git project of version '1.1.5'
-     When I run `bundle exec thor version:bump minor` from the temp directory
-     Then the version should be '1.2.0'
-     And the origin version should be '1.2.0'
-
-   Scenario: Bumping a major version in Git should reset the patch and minor versions
-     Given I have a git project of version '1.1.5'
-     When I run `bundle exec thor version:bump major` from the temp directory
-     Then the version should be '2.0.0'
-     And the origin version should be '2.0.0'
-
-  Scenario: Bumping a patch version in Git
+  Scenario Outline: Bumping a version
+    Given I have a <scm> project of version '<starting version>'
+    When I run `bundle exec thor version:bump <bump type>` from the temp directory
+    Then the version should be '<resulting version>'
+    And the <scm> server version should be '<resulting version>'
+
+    Examples:
+      | scm | starting version | bump type         |     resulting version |
+      | git |            1.0.0 | patch             |                 1.0.1 |
+      | git |            1.0.0 | minor             |                 1.1.0 |
+      | git |            1.0.0 | major             |                 2.0.0 |
+      | git |            1.1.5 | minor             |                 1.2.0 |
+      | git |            1.1.5 | major             |                 2.0.0 |
+      | git |            1.0.0 | prerelease        |         1.0.1-alpha.1 |
+      | git |            1.0.0 | prerelease someth |        1.0.1-someth.1 |
+      | git |    1.0.0-alpha.1 | prerelease        |         1.0.0-alpha.2 |
+      | git |    1.0.0-alpha.5 | prerelease beta   |          1.0.0-beta.1 |
+      | git |            1.0.0 | build             |         1.0.0+build.2 |
+      | git |    1.0.0-alpha.3 | build             | 1.0.0-alpha.3+build.2 |
+      | p4  |            1.0.0 | patch             |                 1.0.1 |
+      | p4  |            1.0.0 | minor             |                 1.1.0 |
+      | p4  |            1.0.0 | major             |                 2.0.0 |
+      | p4  |            1.1.5 | minor             |                 1.2.0 |
+      | p4  |            1.1.5 | major             |                 2.0.0 |
+
+  Scenario: Bumping a patch version in Git when the server has an advanced version not yet fetched
     Given I have a git project of version '1.0.0'
     And the origin version is '1.0.10'
     When I run `bundle exec thor version:bump patch` from the temp directory
     Then the version should be '1.0.11'
-    And the origin version should be '1.0.11'
-
-   @p4 @wip
-   Scenario: Bumping a patch version in Perforce
-     Given I have a Perforce project of version '1.0.0'
-     When I run `bundle exec thor version:bump patch` from the Perforce project directory
-     Then the version should be '1.0.1' in the Perforce project directory
-     And the p4 server version should be '1.0.1'
-  
-   @p4
-   Scenario: Bumping a minor version in Perforce
-     Given I have a Perforce project of version '1.0.0'
-     When I run `bundle exec thor version:bump minor` from the Perforce project directory
-     Then the version should be '1.1.0' in the Perforce project directory
-     And the p4 server version should be '1.1.0'
-  
-   @p4
-   Scenario: Bumping a major version in Perforce
-     Given I have a Perforce project of version '1.0.0'
-     When I run `bundle exec thor version:bump major` from the Perforce project directory
-     Then the version should be '2.0.0' in the Perforce project directory
-     And the p4 server version should be '2.0.0'
-  
-   @p4
-   Scenario: Bumping a minor version in Perforce should reset the patch version
-     Given I have a Perforce project of version '1.1.5'
-     When I run `bundle exec thor version:bump minor` from the Perforce project directory
-     Then the version should be '1.2.0' in the Perforce project directory
-     And the p4 server version should be '1.2.0'
-
-   @p4
-   Scenario: Bumping a major version in Perforce should reset the patch and minor versions
-     Given I have a Perforce project of version '1.1.5'
-     When I run `bundle exec thor version:bump major` from the Perforce project directory
-     Then the version should be '2.0.0' in the Perforce project directory
-     And the p4 server version should be '2.0.0'
+    And the git server version should be '1.0.11'

data/features/bump_tags.feature

@@ -3,71 +3,34 @@ Feature: Guessing the level of a bump
   I want a command that figures out a major, minor or patch bump based on commit logs
   So that I can control semver changes while still using a CI server
 
-  Background:
-    Given I have a git project of version '1.2.3'
-
-  Scenario: changeset with no tags
-    Given a commit message "This is an untagged commit"
-    And a commit message "this is another commit"
-    And a commit message "this is another change to the project"
-    When I run `bundle exec thor version:bump auto` from the temp directory
-    Then the version should be '1.2.4'
-    And the origin version should be '1.2.4'
-
-  Scenario: changeset with a [major] tag
-    Given a commit message "This is an untagged commit"
-    And a commit message "this is another commit"
-    And a commit message "this is a big change to the project [major]"
-    When I run `bundle exec thor version:bump auto` from the temp directory
-    Then the version should be '2.0.0'
-    And the origin version should be '2.0.0'
-
-  Scenario: changeset with a [minor] tag
-    Given a commit message "This is an untagged commit"
-    And a commit message "this is another commit"
-    And a commit message "this is a smallish change to the project [minor]"
-    When I run `bundle exec thor version:bump auto` from the temp directory
-    Then the version should be '1.3.0'
-    And the origin version should be '1.3.0'
-
-  Scenario: changeset with a [major] and [minor] tag
-    Given a commit message "This is an untagged commit"
-    And a commit message "this is another commit"
-    And a commit message "this is a big change to the project [major]"
-    And a commit message "this is a smallish change to the project [minor]"
-    When I run `bundle exec thor version:bump auto` from the temp directory
-    Then the version should be '2.0.0'
-    And the origin version should be '2.0.0'
-
-  Scenario: changeset with a #major tag
-    Given a commit message "This is an untagged commit"
-    And a commit message "this is another commit"
-    And a commit message "this is a big change to the project #major"
-    When I run `bundle exec thor version:bump auto` from the temp directory
-    Then the version should be '2.0.0'
-    And the origin version should be '2.0.0'
-
-  Scenario: changeset with a #minor tag
-    Given a commit message "This is an untagged commit"
-    And a commit message "this is another commit"
-    And a commit message "this is a smallish change to the project #minor"
-    When I run `bundle exec thor version:bump auto` from the temp directory
-    Then the version should be '1.3.0'
-    And the origin version should be '1.3.0'
-
-  Scenario: changeset with a #major and #minor tag
-    Given a commit message "This is an untagged commit"
-    And a commit message "this is another commit"
-    And a commit message "this is a big change to the project #major"
-    And a commit message "this is a smallish change to the project #minor"
-    When I run `bundle exec thor version:bump auto` from the temp directory
-    Then the version should be '2.0.0'
-    And the origin version should be '2.0.0'
-
-  Scenario: changeset with a [MAJOR] tag
-    Given a commit message "This is an untagged commit"
-    And a commit message "this is another commit"
-    And a commit message "this is a big change to the project [MAJOR]"
-    When I run `bundle exec thor version:bump auto` from the temp directory
-    Then the version should be '2.0.0'
-    And the origin version should be '2.0.0'
+  Scenario Outline: changeset tags
+    Given I have a git project of version '<starting version>'
+    And a commit message "<message 1>"
+    And a commit message "<message 2>"
+    And a commit message "<message 3>"
+    When I run `bundle exec thor version:bump auto` from the temp directory
+    Then the version should be '<resulting version>'
+    And the <scm> server version should be '<resulting version>'
+
+  Examples:
+    | starting version | scm | message 1 | message 2          | message 3               | resulting version |
+    |            1.2.3 | git | untagged  | another commit     | another change          | 1.2.3+build.2     |
+    |            1.2.3 | git | untagged  | another commit     | big change [major]      | 2.0.0             |
+    |            1.2.3 | git | untagged  | another commit     | big change [MAJOR]      | 2.0.0             |
+    |            1.2.3 | git | untagged  | another commit     | smallish change [minor] | 1.3.0             |
+    |            1.2.3 | git | untagged  | big change [major] | smallish change [minor] | 2.0.0             |
+    |            1.2.3 | git | untagged  | another commit     | pre [prerelease]        | 1.2.4-alpha.1     |
+    |            1.2.3 | git | untagged  | another commit     | pre [prerelease beta]   | 1.2.4-beta.1      |
+    |     1.2.3-beta.1 | git | untagged  | another commit     | pre [prerelease beta]   | 1.2.3-beta.2      |
+    |     1.2.3-beta.1 | git | untagged  | another commit     | pre [prerelease someth] | 1.2.3-someth.1    |
+    |     1.2.3-beta.1 | git | untagged  | another commit     | pre [prerelease]        | 1.2.3-beta.2      |
+    |            1.2.3 | git | untagged  | another commit     | build [patch]           | 1.2.4             |
+    |            1.2.3 | git | untagged  | another commit     | big change #major       | 2.0.0             |
+    |            1.2.3 | git | untagged  | another commit     | smallish change #minor  | 1.3.0             |
+    |            1.2.3 | git | untagged  | big change #major  | smallish change #minor  | 2.0.0             |
+    |            1.2.3 | git | untagged  | another commit     | pre #prerelease         | 1.2.4-alpha.1     |
+    |            1.2.3 | git | untagged  | another commit     | pre #prerelease-beta    | 1.2.4-beta.1      |
+    |     1.2.3-beta.1 | git | untagged  | another commit     | pre #prerelease-beta    | 1.2.3-beta.2      |
+    |     1.2.3-beta.1 | git | untagged  | another commit     | pre #prerelease-someth  | 1.2.3-someth.1    |
+    |     1.2.3-beta.1 | git | untagged  | another commit     | pre #prerelease         | 1.2.3-beta.2      |
+    |            1.2.3 | git | untagged  | another commit     | build #patch            | 1.2.4             |

data/features/step_definitions/bump_steps.rb

@@ -34,13 +34,13 @@ Then /^the version should be '(.*)'$/ do |version|
   }
 end
 
-Then /^the version should be '(.+)' in the Perforce project directory$/ do |version|
+Then /^the version should be '(.+)' in the p4 project directory$/ do |version|
   Dir.chdir(perforce_project_dir) {
     ThorSCMVersion.versioner.from_path.to_s.should == version
   }
 end
 
-Then /^the origin version should be '(.*)'$/ do |version|
+Then /^the git server version should be '(.*)'$/ do |version|
   Dir.chdir(origin_dir) {
     ThorSCMVersion.versioner.from_path.to_s.should == version
   }
@@ -59,13 +59,13 @@ When /^I run `(.*)` from the temp directory$/ do |run|
   }
 end
 
-When /^I run `(.*)` from the Perforce project directory$/ do |run|
+When /^I run `(.*)` from the p4 project directory$/ do |run|
   Dir.chdir(perforce_project_dir) {
     `#{run}`
   }
 end
 
-Given /^I have a Perforce project of version '(.*)'$/ do |version|
+Given /^I have a p4 project of version '(.*)'$/ do |version|
   ENV['P4PORT']    = 'p4server.example.com:1666'
   ENV['P4USER']    = 'tester'
   ENV['P4PASSWD']  = 'tester'

data/lib/thor-scmversion.rb

@@ -1,18 +1,20 @@
 require 'pathname'
 require 'tmpdir'
 require 'thor'
+require 'thor-scmversion/prerelease'
 require 'thor-scmversion/scm_version'
 require 'thor-scmversion/git_version'
 require 'thor-scmversion/p4_version'
 require 'thor-scmversion/shell_utils'
+require 'thor-scmversion/errors'
 
 module ThorSCMVersion
   class Tasks < Thor
     namespace "version"
 
-    desc "bump TYPE", "Bump version number (type is major, minor, patch or auto)"
-    def bump(type)
-      current_version.bump! type
+    desc "bump TYPE [PRERELEASE_TYPE]", "Bump version number (type is major, minor, patch, prerelease or auto)"
+    def bump(type, prerelease_type = nil)
+      current_version.bump! type, prerelease_type
       begin
         say "Creating and pushing tags", :yellow
         current_version.tag

data/lib/thor-scmversion/errors.rb

@@ -0,0 +1,26 @@
+module ThorSCMVersion
+  # @author Josiah Kiehl <josiah@skirmisher.net>
+  # adapted from code written by Jamie Winsor <jamie@vialstudios.com>
+  class SCMVersionError < StandardError
+    class << self
+      # @param [Integer] code
+      def status_code(code)
+        define_method(:status_code) { code }
+        define_singleton_method(:status_code) { code }
+      end
+    end
+
+    alias_method :message, :to_s
+  end
+
+  class InternalError < SCMVersionError; status_code(99); end
+
+  class TagFormatError < SCMVersionError
+    status_code(100)
+    def initialize(tag); @tag = tag; end
+    def to_s; "#{@tag.inspect} is formatted incorrectly."; end
+  end
+  class InvalidPrereleaseFormatError < TagFormatError
+    def to_s; super + " Format must be: #{Prerelease::FORMAT.inspect}."; end
+  end
+end

data/lib/thor-scmversion/git_version.rb

@@ -7,7 +7,7 @@ module ThorSCMVersion
         Dir.chdir(path) do
           tags = Open3.popen3("git tag") { |stdin, stdout, stderr| stdout.read }.split(/\n/)
           version_tags = tags.select { |tag| tag.match(ScmVersion::VERSION_FORMAT) }
-          version_tags.collect { |tag| new(*tag.split('.')) }.sort.reverse
+          version_tags.collect { |tag| from_tag(tag) }.sort.reverse
         end
       end
 
@@ -21,6 +21,7 @@ module ThorSCMVersion
       ShellUtils.sh "git push --tags || true"
     end
 
+    # Check the commit messages to see what type of bump is required
     def auto_bump
       last_tag = self.class.from_path.to_s
       logs = ShellUtils.sh "git log --abbrev-commit --format=oneline #{last_tag}.."
@@ -28,10 +29,15 @@ module ThorSCMVersion
                 :major
               elsif logs =~ /\[minor\]|\#minor/i
                 :minor
-              else
+              elsif logs =~ /\[prerelease\s?(#{Prerelease::TYPE_FORMAT})?\]|\#prerelease\-?(#{Prerelease::TYPE_FORMAT})?/
+                prerelease_type = $1 || $2
+                :prerelease
+              elsif logs =~ /\[patch\]|\#patch/i
                 :patch
+              else
+                :build
               end
-      bump!(guess)
+      bump!(guess, prerelease_type)
     end
   end
 end

data/lib/thor-scmversion/p4_version.rb

@@ -81,10 +81,10 @@ module ThorSCMVersion
       end
     end
 
-    def initialize(major=0, minor=0, patch=0)
+    def initialize(major = 0, minor = 0, patch = 0, prerelease = nil, build = 1)
       self.p4_depot_path = self.class.depot_path('.')
       self.p4_module_name = self.class.module_name('.')
-      super(major, minor, patch)
+      super
     end
     
     attr_accessor :version_file_path

data/lib/thor-scmversion/prerelease.rb

@@ -0,0 +1,80 @@
+module ThorSCMVersion
+  class Prerelease
+    TYPE_FORMAT = /[A-Za-z0-9]+/
+    FORMAT = /(#{TYPE_FORMAT})\.(\d+)/.freeze
+    DEFAULT_TYPE = 'alpha'
+
+    class << self
+      # Reads the prerelease segment of the version. While semver
+      # provides a more general format, the format with
+      # thor-scmversion is more strictly defined:
+      # 
+      # Examples:
+      #   str = 'alpha.1'
+      #   str = 'beta.10'
+      #   str = 'rc.2'
+      #
+      # @param [String] str String in the format /[A-Za-z]+\.\d+/
+      # @return [Prerelease]
+      def from_string(str)
+        return nil if str.nil?
+        matchdata = str.match(FORMAT)
+        type, version = matchdata.captures unless matchdata.nil?
+        raise InvalidPrereleaseFormatError.new(str) if (matchdata.nil? ||
+                                                        matchdata.captures.size != 2)
+        new(type, version)
+      end
+    end
+
+    attr_reader :version
+    attr_reader :type
+
+    # initialize
+    #
+    # @param [String] type Type of prerelease
+    # @param [responds_to? :to_i] version Version of the given type of prerelease
+    #
+    # Examples:
+    #   'beta', 1 #=> x.x.x-beta.1
+    def initialize(type = DEFAULT_TYPE, version = 1)
+      @version = version.to_i
+      @type = type.nil? || type.empty? ? DEFAULT_TYPE : type
+    end
+
+    def to_s
+      "#{@type}.#{@version}"
+    end
+
+    def <=>(other)
+      raise ArgumentError unless kind_of? other.class
+      if self.type == other.type
+        self.version <=> other.version
+      else
+        self.type <=> other.type
+      end
+    end
+
+    def >(other)
+      raise ArgumentError unless kind_of? other.class
+      return (self <=> other) == 1
+    end
+
+    def <(other)
+      raise ArgumentError unless kind_of? other.class
+      return (self <=> other) == -1
+    end
+
+    def ==(other)
+      other &&
+        kind_of?(other.class) &&
+        self.version == other.version &&
+        self.type == other.type
+    end
+
+    # Delegate methods to @version so this object acts like an Integer
+    def method_missing(method, *args, &blk)
+      @version = self.version.send(method, *args, &blk)
+      self
+    end
+  end
+end

data/lib/thor-scmversion/scm_version.rb

@@ -1,6 +1,9 @@
 module ThorSCMVersion
 
   class << self
+    # Figures out whether the repository is managed by git. If not, use p4.
+    #
+    # @return [#kind_of? ScmVersion]
     def versioner
       if(File.directory?(".git"))
         return GitVersion
@@ -10,17 +13,43 @@ module ThorSCMVersion
     end
   end
 
+  # author Josiah Kiehl <josiah@skirmisher.net>
   class ScmVersion
     include Comparable
     
-    VERSION_FORMAT = /^(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)$/
+    # Tags not matching this format will not show up in the tags list
+    #
+    # Examples:
+    #   1.2.3 #=> valid
+    #   1.2.3.4 #=> invalid
+    #   1.2.3-alpha.1 #=> valid
+    #   1.2.3-alpha #=> invalid
+    VERSION_FORMAT = /^(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)-?(?<prerelease>#{Prerelease::FORMAT})?(\+build\.)?(?<build>\d+)?$/
+
+    # Default file to write the current version to
     VERSION_FILENAME = 'VERSION'
     class << self
+      # Retrieve all versions from the repository contained at path
+      #
+      # @param [String] path Path to the repository
+      # @return [Array<ScmVersion>]
       def from_path(path = '.')
         retrieve_tags
         all_from_path(path).first || new(0,0,1)
       end
 
+      # Create an ScmVersion object from a tag
+      #
+      # @param [String] tag
+      # @return [ScmVersion]
+      def from_tag(tag)
+        matchdata = tag.match VERSION_FORMAT
+        new(matchdata[:major], matchdata[:minor], matchdata[:patch], Prerelease.from_string(matchdata[:prerelease]), matchdata[:build])
+      end
+
+      # In distributed SCMs, tags must be fetched from the server to
+      # ensure that the latest tags are being used to calculate the
+      # next version.
       def retrieve_tags
         # noop
       end
@@ -28,33 +57,80 @@ module ThorSCMVersion
     attr_accessor :major
     attr_accessor :minor
     attr_accessor :patch
-    
-    def initialize(major=0, minor=0, patch=0)
+    attr_accessor :prerelease
+    attr_accessor :build
+
+    def initialize(major = 0, minor = 0, patch = 0, prerelease = nil, build = 1)
       @major = major.to_i
       @minor = minor.to_i
       @patch = patch.to_i
+      @prerelease = prerelease
+      @build = build.nil? ? 1 : build.to_i
     end
-    
-    def bump!(type)
+
+    # Bumps the version in place
+    # 
+    # @param [Symbol] type Type of bump to be performed
+    # @param [String] prerelease_type Type of prerelease to bump to when doing a :prerelease bump
+    # @return [ScmVersion]
+    def bump!(type, prerelease_type = nil)
       case type.to_sym
       when :auto
         self.auto_bump
       when :major
-        self.major += 1
-        self.minor = 0
-        self.patch = 0
+        self.major += 1        
       when :minor
         self.minor += 1
-        self.patch = 0
       when :patch
         self.patch += 1
+      when :prerelease
+        if self.prerelease
+          if prerelease_type.nil? || prerelease_type == self.prerelease.type
+            self.prerelease += 1
+          else
+            self.prerelease = Prerelease.new(prerelease_type)
+          end
+        else
+          self.patch += 1
+          self.prerelease = Prerelease.new(prerelease_type)
+        end
+      when :build
+        self.build += 1
       else
         raise "Invalid release type: #{type}. Valid types are: major, minor, patch, or auto"
       end
       raise "Version: #{self.to_s} is less than or equal to the existing version." if self <= self.class.from_path
+      reset_for type unless type == :auto
       self
     end
 
+    # Reset levels lower than the type being reset for
+    #
+    # @param [Symbol] type Type under which all segments are to be reset
+    def reset_for(type)
+      matched = false
+      [[:major, Proc.new {
+          self.minor = 0
+        }],
+       [:minor, Proc.new {
+          self.patch = 0 
+        }],
+       [:patch, Proc.new {
+          self.prerelease = nil
+        }],
+       [:prerelease, Proc.new { 
+          self.build = 1
+        }]].each do |matcher, reset_proc|
+        next unless matched or type.to_sym == matcher
+        matched = true
+        reset_proc.call
+      end
+      self
+    end
+
+    # Write the version to the passed in file paths
+    #
+    # @param [Array<String>] files List of files to write
     def write_version(files = [ScmVersion::VERSION_FILENAME])
       files.each do |ver_file|
         File.open(ver_file, 'w+') do |f| 
@@ -64,24 +140,31 @@ module ThorSCMVersion
       self
     end
 
+    # Create the tag in the SCM corresponding to the version contained in self. 
+    # Abstract method. Must be implemented by subclasses.
     def tag
       raise NotImplementedError
     end
 
-    def auto_bump
+    # Perform a bump by reading recent commit messages in the SCM
+    # Abstract method. Must be implemented by subclasses.
+    def auto_bump(prerelease_type = nil)
       raise NotImplementedError
     end
-    
+
     def to_s
-      "#{major}.#{minor}.#{patch}"
+      s = "#{major}.#{minor}.#{patch}"
+      s << "-#{prerelease}" unless prerelease.nil?
+      s << "+build.#{build}" unless build < 2
+      s
     end
     alias_method :version, :to_s
-    
+
     def <=>(other)
       return unless other.is_a?(self.class)
       return 0 if self.version == other.version
       
-      [:major, :minor, :patch].each do |segment|
+      [:major, :minor, :patch, :prerelease, :build].each do |segment|
         next      if self.send(segment) == other.send(segment)
         return  1 if self.send(segment) > other.send(segment)
         return -1 if self.send(segment) < other.send(segment)

data/spec/lib/thor-scmversion/prerelease_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module ThorSCMVersion
+  describe Prerelease do
+    subject { Prerelease.new }
+    describe "::new" do
+      it { subject.to_s.should == 'alpha.1' }
+      it "should default to alpha if provided a nil or empty type" do
+        described_class.new('').type.should == 'alpha'
+      end
+    end
+    describe "::FORMAT" do
+      %w[alpha.1 beta.124].each do |example|
+        it "should match #{example}" do
+          example.match(described_class::FORMAT).should_not be_nil
+        end
+      end
+    end
+    describe "#to_s" do
+      it { subject.to_s.should == "alpha.1" }
+    end
+    describe "#method_missing" do
+      it { (subject + 1).class.should == Prerelease }
+      it { (subject + 1).version.should == 2 }
+      it { pending("Figure out why this doesn't work. Works in irb."); (subject += 1).version.should == 2 } #TODO jk 
+    end
+    describe "#<=>" do
+      [[['alpha', 5], ['beta', 1], false],
+       [['alpha', 5], ['alpha', 2], true],
+       [['alpha', 5], ['zzz', 1], false]].each do |params|
+        it "#{params[0].inspect} should #{params[2] ? '' : 'not'} be greater than #{params[1].inspect}" do
+          (described_class.new(*params[0]) > described_class.new(*params[1])).should == params[2]
+        end
+        it "#{params[0].inspect} should #{params[2] ? '' : 'not'} be less than #{params[1].inspect}" do
+          
+          (described_class.new(*params[0]) < described_class.new(*params[1])).should == !params[2]
+        end
+      end
+    end
+    describe "::from_string" do
+      it 'should parse the segment of the semver containing the prerelease information' do
+        p = described_class.from_string('alpha.1')
+        p.type.should == 'alpha'
+        p.version.should == 1
+      end
+      it 'should return nil if the str passed in is nil' do
+        described_class.from_string(nil).should be_nil
+      end
+      %w[1 1.alpha alpha alpha.alpha .1].each do |str|
+        it "should raise an error if an invalid format (#{str}) is provided" do
+          -> { Prerelease.from_string(str) }.should raise_error(InvalidPrereleaseFormatError)
+        end
+      end
+    end
+  end
+end

data/spec/lib/thor-scmversion/scm_version_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+module ThorSCMVersion
+  shared_examples 'scmversion' do
+    it 'should take major minor and patch segments on initialization' do
+      described_class.new('1', '2', '3').to_s.should == '1.2.3'
+    end
+    it 'should optionally take a prerelease' do
+      described_class.new('1', '2', '3', Prerelease.new('alpha', 1)).to_s.should == '1.2.3-alpha.1'
+    end
+    describe 'should take a build number' do
+      it do
+        described_class.new('1', '2', '3', nil, '2').to_s.should == '1.2.3+build.2'
+      end
+      it 'and a prerelease' do
+        described_class.new('1', '2', '3', Prerelease.new('beta', 3), '2').to_s.should == '1.2.3-beta.3+build.2'
+      end
+    end
+    describe '#bump!' do
+      subject { described_class.new('1', '2', '3', Prerelease.new('beta', 3), '2') }
+      describe 'should bump' do
+        it 'major' do
+          subject.bump!(:major).to_s.should == '2.0.0'
+        end
+        it 'minor' do
+          subject.bump!(:minor).to_s.should == '1.3.0'
+        end
+        it 'patch' do
+          subject.bump!(:patch).to_s.should == '1.2.4'
+        end
+        describe 'prerelease' do
+          describe 'with explicit type' do
+            it do
+              subject.bump!(:prerelease, 'someth').to_s.should == '1.2.3-someth.1'
+            end
+            it 'with no prerelease on previous version' do
+              subject.prerelease = nil
+              subject.bump!(:prerelease, 'someth').to_s.should == '1.2.4-someth.1'
+            end
+          end
+          describe 'with default type' do
+            it do
+              subject.bump!(:prerelease).to_s.should == '1.2.3-beta.4'
+            end
+            it 'with no prerelease on previous version' do
+              subject.prerelease = nil
+              subject.bump!(:prerelease).to_s.should == '1.2.4-alpha.1'
+            end
+          end
+        end
+        it 'build' do
+          subject.bump!(:build).to_s.should == '1.2.3-beta.3+build.3'
+        end
+      end
+    end
+    describe '#from_tag should create a version object from a tag' do
+      it do
+        v = described_class.from_tag('1.2.3')
+        v.major.should == 1
+        v.minor.should == 2
+        v.patch.should == 3
+        v.prerelease.should == nil
+      end
+      it 'with a prerelease' do
+        v = described_class.from_tag('1.2.3-alpha.1')
+        v.major.should == 1
+        v.minor.should == 2
+        v.patch.should == 3
+        v.prerelease.should == Prerelease.new('alpha', 1)
+      end
+    end
+    describe "#reset_for" do
+      subject { described_class.new('1', '2', '3', Prerelease.new, '4') }
+      [[:major, '1.0.0'],
+       [:minor, '1.2.0'],
+       [:patch, '1.2.3'],
+       [:prerelease, '1.2.3-alpha.1'],
+       [:build, '1.2.3-alpha.1+build.4']].each do |type, result|
+        it "should reset for #{type}" do
+          subject.reset_for(type).to_s.should == result
+        end
+      end
+    end
+  end
+  describe ScmVersion do
+    describe "::VERSION_FORMAT should " do
+      %w[1.2.3 1.2.3-alpha.1 1.2.3+build.2 1.2.45-alpha.3+build.52 1.0.0-alpha.3+build.2].each do |example|
+        it "match #{example}" do
+          example.match(described_class::VERSION_FORMAT).should_not be_nil
+        end
+      end
+    end
+  end
+
+  describe GitVersion do
+    it_behaves_like 'scmversion'
+  end
+    
+  describe Perforce do
+    it 'should set environment variables' do
+      described_class.stub(:set) { <<-here }
+P4CHARSET=utf8\nP4CLIENT=kallan_mac (config)
+P4CONFIG=p4config (config '/Users/kallan/src/kallan_mac/p4config')
+P4PORT=perflax01:1666 (config)
+P4USER=kallan
+here
+
+      described_class.parse_and_set_p4_set
+      
+      ENV["P4CHARSET"].should == "utf8"
+      ENV["P4CONFIG"].should == "p4config"
+      ENV["P4PORT"].should == "perflax01:1666"
+      ENV["P4USER"].should == "kallan"
+    end
+  end
+
+  describe P4Version do
+    it_behaves_like 'scmversion'
+
+    it 'should parse labels correctly' do
+      described_class.parse_label("Label testing-1.0.0 2012/10/01 'Created by kallan. '", "testing").should eq(["1","0","0"])
+      described_class.parse_label("Label testing-1.0.1 2012/10/01 'Created by kallan. '", "testing").should eq(["1","0","1"])
+      described_class.parse_label("Label testing-2.0.5 2012/10/01 'Created by kallan. '", "testing").should eq(["2","0","5"])
+      described_class.parse_label("Label testing-4.2.2 2012/10/01 'Created by kallan. '", "testing").should eq(["4","2","2"])
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thor-scmversion
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-08 00:00:00.000000000Z
+date: 2012-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70281121566680 !ruby/object:Gem::Requirement
+  requirement: &70341045418340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70281121566680
+  version_requirements: *70341045418340
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70281121904800 !ruby/object:Gem::Requirement
+  requirement: &70341045417740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70281121904800
+  version_requirements: *70341045417740
 - !ruby/object:Gem::Dependency
   name: geminabox
-  requirement: &70281122109820 !ruby/object:Gem::Requirement
+  requirement: &70341045417140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70281122109820
+  version_requirements: *70341045417140
 - !ruby/object:Gem::Dependency
   name: spork
-  requirement: &70281122489560 !ruby/object:Gem::Requirement
+  requirement: &70341045416600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70281122489560
+  version_requirements: *70341045416600
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70281125870580 !ruby/object:Gem::Requirement
+  requirement: &70341045416120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70281125870580
+  version_requirements: *70341045416120
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70281126177140 !ruby/object:Gem::Requirement
+  requirement: &70341045415700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70281126177140
+  version_requirements: *70341045415700
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70281126843440 !ruby/object:Gem::Requirement
+  requirement: &70341045415280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70281126843440
+  version_requirements: *70341045415280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70281126962300 !ruby/object:Gem::Requirement
+  requirement: &70341045414860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,7 +100,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70281126962300
+  version_requirements: *70341045414860
 description: Thor tasks to manage a VERSION file based on SCM tags
 email:
 - ivey@gweezlebur.com
@@ -124,13 +124,16 @@ files:
 - features/step_definitions/bump_steps.rb
 - features/support/env.rb
 - lib/thor-scmversion.rb
+- lib/thor-scmversion/errors.rb
 - lib/thor-scmversion/git_version.rb
 - lib/thor-scmversion/p4_version.rb
+- lib/thor-scmversion/prerelease.rb
 - lib/thor-scmversion/scm_version.rb
 - lib/thor-scmversion/shell_utils.rb
 - lib/thor-scmversion/version.rb
 - lib/thor/scmversion.rb
-- spec/lib/scm_version_spec.rb
+- spec/lib/thor-scmversion/prerelease_spec.rb
+- spec/lib/thor-scmversion/scm_version_spec.rb
 - spec/spec_helper.rb
 - thor-scmversion.gemspec
 homepage: ''
@@ -153,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A small set of Thor tasks you can include in your build scripts to manage
@@ -165,6 +168,7 @@ test_files:
 - features/fixtures/Thorfile
 - features/step_definitions/bump_steps.rb
 - features/support/env.rb
-- spec/lib/scm_version_spec.rb
+- spec/lib/thor-scmversion/prerelease_spec.rb
+- spec/lib/thor-scmversion/scm_version_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/lib/scm_version_spec.rb

@@ -1,36 +0,0 @@
-require 'spec_helper'
-
-module ThorSCMVersion
-  describe GitVersion do
-    it 'should take major minor and patch segments on initialization' do
-      -> { described_class.new('1', '2', '3') }.should_not raise_error
-    end
-  end
-    
-  describe Perforce do
-    it 'should set good' do
-      described_class.stub(:set) { <<-here }
-P4CHARSET=utf8\nP4CLIENT=kallan_mac (config)
-P4CONFIG=p4config (config '/Users/kallan/src/kallan_mac/p4config')
-P4PORT=perflax01:1666 (config)
-P4USER=kallan
-here
-
-      described_class.parse_and_set_p4_set
-      
-      ENV["P4CHARSET"].should == "utf8"
-      ENV["P4CONFIG"].should == "p4config"
-      ENV["P4PORT"].should == "perflax01:1666"
-      ENV["P4USER"].should == "kallan"
-    end
-  end
-
-  describe P4Version do
-    it 'should parse labels correctly' do
-      described_class.parse_label("Label testing-1.0.0 2012/10/01 'Created by kallan. '", "testing").should eq(["1","0","0"])
-      described_class.parse_label("Label testing-1.0.1 2012/10/01 'Created by kallan. '", "testing").should eq(["1","0","1"])
-      described_class.parse_label("Label testing-2.0.5 2012/10/01 'Created by kallan. '", "testing").should eq(["2","0","5"])
-      described_class.parse_label("Label testing-4.2.2 2012/10/01 'Created by kallan. '", "testing").should eq(["4","2","2"])
-    end
-  end
-end