semver2 3.1.2 → 3.3.2

data/.semver

@@ -1,5 +1,6 @@
 ---
 :major: 3
-:minor: 1
+:minor: 3
 :patch: 2
 :special: ''
+:metadata: ''

data/README.md

@@ -1,4 +1,4 @@
-SemVer2 3.1.x gem, following semver.org 2.0.0-rc.1
+SemVer2 3.3.x gem, following semver.org 2.0.0-rc.2
 ======
 
 quickstart on the command line
@@ -9,10 +9,18 @@ install it
 
 use it
 
+    % semver                    # => v2.3.4
+    Find the .semver file and print a formatted string from this.
+
     % semver init
+    Initialize the .semver file.
+
     % semver tag                # => v0.0.0
+    Print the tag for the current .semver file.
+
     % semver inc minor          # => v0.1.0
-    % semver special 'alpha.45' # => v0.1.0-alpha.45
+    % semver pre 'alpha.45'     # => v0.1.0-alpha.45
+    % semver meta 'md5.abc123'  # => v0.1.0-alpha.45+md5.abc123
     % semver format "%M.%m"     # => 0.1
     % git tag -a `semver tag`
     % say 'that was easy'
@@ -25,14 +33,29 @@ quickstart for ruby
     v.major                     # => "0"
     v.major += 1
     v.major                     # => "1"
-    v.special = 'alpha.46'
-    v.format "%M.%m.%p%s"       # => "1.1.0-alpha.46"
-    v.to_s                      # => "v1.1.0"
+    v.prerelease = 'alpha.46'
+    v.metadata = 'md5.abc123'
+    v.format "%M.%m.%p%s%d"     # => "1.1.0-alpha.46+md5.abc123"
+    v.to_s                      # => "v1.1.0-alpha.46+md5.abc123"
     v.save
 
+
 git integration
 ---------------
     % git config --global alias.semtag '!git tag -a $(semver tag) -m "tagging $(semver tag)"'
 
-[Franco Lazzarino](mailto:flazzarino@gmail.com)
-[Henrik Feldt](mailto:henrik@haf.se)
+
+existing 'SemVer' class from other gem?
+---------------------------------------
+You can now do this:
+
+    require 'xsemver'
+    v = XSemVer::SemVer.find
+    # ...
+    v.save
+
+creds
+-----
+* [Franco Lazzarino](mailto:flazzarino@gmail.com)
+* [Henrik Feldt](mailto:henrik@haf.se)
+* [James Childress](mailto:james@childr.es)

data/bin/semver

@@ -1,83 +1,11 @@
 #!/usr/bin/env ruby
 
-require 'fileutils'
-require 'semver'
-
-class CommandError < StandardError; end
+require 'runner'
 
 begin
-  command = ARGV.shift || 'tag'
-
-  case command
-  when /^init(ialize)?$/
-    file = SemVer::FILE_NAME
-
-    if File.exist? file
-      puts "#{file} already exists"
-    else
-      version = SemVer.new
-      version.save file
-    end
-
-  when /^inc(rement)?$/
-    version = SemVer.find
-    dimension = ARGV.shift or raise CommandError, "required: major | minor | patch"
-
-    case dimension
-    when 'major'
-      version.major += 1
-      version.minor = 0
-      version.patch = 0
-
-    when 'minor'
-      version.minor += 1
-      version.patch = 0
-
-    when 'patch'
-      version.patch += 1
-
-    else
-      raise CommandError, "#{dimension} is invalid: major | minor | patch"
-    end
-
-    version.special = ''
-    version.save
-
-  when /^spe(cial)?$/
-    version = SemVer.find
-    special_str = ARGV.shift or raise CommandError, "required: an arbitrary string (beta, alfa, romeo, etc)"
-    version.special = special_str
-    version.save
-
-  when 'format'
-    version = SemVer.find
-    format_str = ARGV.shift or raise CommandError, "required: format string"
-    version.format format_str
-
-  when 'tag'
-    version = SemVer.find
-    puts version.to_s
-
-  when 'help'
-    puts <<-HELP
-semver commands
----------------
-
-init[ialze]                        # initialize semantic version tracking
-inc[rement] major | minor | patch  # increment a specific version number
-spe[cial] [STRING]                 # set a special version suffix
-format                             # printf like format: %M, %m, %p, %s
-tag                                # equivalent to format 'v%M.%m.%p%s'
-help
-
-PLEASE READ http://semver.org
-    HELP
-
-  else raise CommandError, "invalid command #{command}"
-  end
-
-rescue CommandError => e
+  XSemVer::Runner.new *ARGV
+rescue XSemVer::Runner::CommandError => e
   puts e.message
   puts "#{$0} help for more info"
   exit 1
-end
+end

data/lib/pre_release.rb

@@ -0,0 +1,68 @@
+module XSemVer
+  
+  # Represents the pre-release portion of a SemVer string.
+  class PreRelease
+    
+    ONLY_DIGITS = /\A\d+\z/
+    
+    attr_reader :ids
+    
+    include Comparable
+    
+    
+    
+    
+    def initialize(prerelease_string)
+      @ids = prerelease_string.split(".")
+    end
+    
+    def to_s
+      ids.join "."
+    end
+    
+    def empty?
+      ids.empty?
+    end    
+    
+    
+    
+    
+    # The SemVer 2.0.0-rc2 spec uses this example for determining pre-release precedence:
+    #   1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0.
+    # Pre-release precedence is calculated using the following rules, which are listed above their corresponding code.
+    def <=>(other)
+      
+      # A SemVer with no prerelease data is 'greater' than a SemVer with any prerelease data.
+      # If both prereleases are empty, they are equal.
+      return  1 if  empty? && !other.empty?
+      return -1 if !empty? &&  other.empty?
+      return  0 if  empty? &&  other.empty?
+      
+      [ids.size, other.ids.size].max.times do |n|
+        id = ids[n]
+        oid = other.ids[n]
+        
+        # A pre-release with fewer ids is less than a pre-release with more ids. (1.0.0-alpha < 1.0.0-alpha.1)
+        return 1 if oid.nil?
+        return -1 if id.nil?
+        
+        # If a pre-release id consists of only numbers, it is compared numerically.
+        if id =~ ONLY_DIGITS && oid =~ ONLY_DIGITS
+          id = id.to_i
+          oid = oid.to_i
+        end
+        
+        # If a pre-release id contains one or more letters, it is compared alphabetically.
+        comparison = (id <=> oid)
+        return comparison unless comparison == 0
+      end
+      
+      0
+    end
+    
+    
+    
+    
+  end
+  
+end

data/lib/runner.rb

@@ -0,0 +1,127 @@
+require 'semver'
+
+module XSemVer
+  
+  # Contains the logic for performing SemVer operations from the command line.
+  class Runner
+    
+    class CommandError < StandardError
+    end
+    
+    
+    # Run a semver command. Raise a CommandError if the command does not exist.
+    # Expects an array of commands, such as ARGV.
+    def initialize(*args)
+      @args = args
+      command = @args.shift || :tag
+      method = "run_#{command}"
+      raise CommandError, "invalid command #{command}" unless self.class.method_defined?(method)
+      send method
+    end
+    
+    
+    # Return the text to be displayed when the 'help' command is run.
+    def self.help_text
+      <<-HELP
+semver commands
+---------------
+
+init[ialze]                        # initialize semantic version tracking
+inc[rement] major | minor | patch  # increment a specific version number
+pre[release] [STRING]              # set a pre-release version suffix
+spe[cial] [STRING]                 # set a pre-release version suffix (deprecated)
+meta[data] [STRING]                # set a metadata version suffix
+format                             # printf like format: %M, %m, %p, %s
+tag                                # equivalent to format 'v%M.%m.%p%s'
+help
+
+PLEASE READ http://semver.org
+      HELP
+    end
+    
+    
+    # Create a new .semver file if the file does not exist.
+    def run_initialize
+      file = SemVer.file_name
+      if File.exist? file
+        puts "#{file} already exists"
+      else
+        version = SemVer.new
+        version.save file
+      end
+    end
+    alias :run_init :run_initialize
+    
+    
+    # Increment the major, minor, or patch of the .semver file.
+    def run_increment
+      version = SemVer.find
+      dimension = @args.shift or raise CommandError, "required: major | minor | patch"
+      case dimension
+      when 'major'
+        version.major += 1
+        version.minor =  0
+        version.patch =  0
+      when 'minor'
+        version.minor += 1
+        version.patch =  0
+      when 'patch'
+        version.patch += 1
+      else
+        raise CommandError, "#{dimension} is invalid: major | minor | patch"
+      end
+      version.special = ''
+      version.metadata = ''
+      version.save
+    end
+    alias :run_inc :run_increment
+    
+    
+    # Set the pre-release of the .semver file.
+    def run_special
+      version = SemVer.find
+      special_str = @args.shift or raise CommandError, "required: an arbitrary string (beta, alfa, romeo, etc)"
+      version.special = special_str
+      version.save
+    end
+    alias :run_spe        :run_special
+    alias :run_pre        :run_special
+    alias :run_prerelease :run_special
+    
+    
+    # Set the metadata of the .semver file.
+    def run_metadata
+      version = SemVer.find
+      special_str = @args.shift or raise CommandError, "required: an arbitrary string (beta, alfa, romeo, etc)"
+      version.metadata = special_str
+      version.save
+    end
+    alias :run_meta :run_metadata
+    
+        
+    # Output the semver as specified by a format string.
+    # See: SemVer#format
+    def run_format
+      version = SemVer.find
+      format_str = @args.shift or raise CommandError, "required: format string"
+      puts version.format(format_str)
+    end
+    
+    
+    # Output the semver with the default formatting.
+    # See: SemVer#to_s
+    def run_tag
+      version = SemVer.find
+      puts version.to_s
+    end
+    
+    
+    # Output instructions for using the semvar command.
+    def run_help
+      puts self.class.help_text
+    end
+    
+    
+  end
+  
+end

data/lib/xsemver.rb

@@ -1,12 +1,17 @@
 require 'yaml'
 require 'semver/semvermissingerror'
+require 'pre_release'
 
 module XSemVer
 # sometimes a library that you are using has already put the class
 # 'SemVer' in global scope. Too Bad®. Use this symbol instead.
   class SemVer
     FILE_NAME = '.semver'
-    TAG_FORMAT = 'v%M.%m.%p%s'
+    TAG_FORMAT = 'v%M.%m.%p%s%d'
+    
+    def SemVer.file_name
+      FILE_NAME
+    end
 
     def SemVer.find dir=nil
       v = SemVer.new
@@ -18,13 +23,13 @@ module XSemVer
     def SemVer.find_file dir=nil
       dir ||= Dir.pwd
       raise "#{dir} is not a directory" unless File.directory? dir
-      path = File.join dir, FILE_NAME
+      path = File.join dir, file_name
 
       Dir.chdir dir do
         while !File.exists? path do
           raise SemVerMissingError, "#{dir} is not semantic versioned", caller if File.dirname(path).match(/(\w:\/|\/)$/i)
           path = File.join File.dirname(path), ".."
-          path = File.expand_path File.join(path, FILE_NAME)
+          path = File.expand_path File.join(path, file_name)
           puts "semver: looking at #{path}"
         end
         return path
@@ -32,9 +37,9 @@ module XSemVer
 
     end
 
-    attr_accessor :major, :minor, :patch, :special
+    attr_accessor :major, :minor, :patch, :special, :metadata
 
-    def initialize major=0, minor=0, patch=0, special=''
+    def initialize major=0, minor=0, patch=0, special='', metadata=''
       major.kind_of? Integer or raise "invalid major: #{major}"
       minor.kind_of? Integer or raise "invalid minor: #{minor}"
       patch.kind_of? Integer or raise "invalid patch: #{patch}"
@@ -43,7 +48,11 @@ module XSemVer
         special =~ /[A-Za-z][0-9A-Za-z\.]+/ or raise "invalid special: #{special}"
       end
 
-      @major, @minor, @patch, @special = major, minor, patch, special
+      unless metadata.empty?
+        metadata =~ /\A[A-Za-z0-9][0-9A-Za-z\.-]*\z/ or raise "invalid metadata: #{metadata}"
+      end
+
+      @major, @minor, @patch, @special, @metadata = major, minor, patch, special, metadata
     end
 
     def load file
@@ -52,7 +61,8 @@ module XSemVer
       @major = hash[:major] or raise "invalid semver file: #{file}"
       @minor = hash[:minor] or raise "invalid semver file: #{file}"
       @patch = hash[:patch] or raise "invalid semver file: #{file}"
-      @special = hash[:special]  or raise "invalid semver file: #{file}"
+      @special = hash[:special] or raise "invalid semver file: #{file}"
+      @metadata = hash[:metadata] || ""
     end
 
     def save file=nil
@@ -62,7 +72,8 @@ module XSemVer
         :major => @major,
         :minor => @minor,
         :patch => @patch,
-        :special => @special
+        :special => @special,
+        :metadata => @metadata
       }
 
       yaml = YAML.dump hash
@@ -73,11 +84,8 @@ module XSemVer
       fmt = fmt.gsub '%M', @major.to_s
       fmt = fmt.gsub '%m', @minor.to_s
       fmt = fmt.gsub '%p', @patch.to_s
-      if @special.nil? or @special.length == 0 then
-        fmt = fmt.gsub '%s', ''
-      else
-        fmt = fmt.gsub '%s', "-" + @special.to_s
-      end
+      fmt = fmt.gsub('%s', prerelease? ? "-#{@special}" : '')
+      fmt = fmt.gsub('%d', metadata? ? "+#{@metadata}" : '')
       fmt
     end
 
@@ -85,20 +93,13 @@ module XSemVer
       format TAG_FORMAT
     end
 
+    # Compare version numbers according to SemVer 2.0.0-rc2
     def <=> other
-      maj = major.to_i <=> other.major.to_i
-      return maj unless maj == 0
-
-      min = minor.to_i <=> other.minor.to_i
-      return min unless min == 0
-
-      pat = patch.to_i <=> other.patch.to_i
-      return pat unless pat == 0
-
-      spe = special <=> other.special
-      return spec unless spe == 0
-
-      0
+      [:major, :minor, :patch].each do |method|
+        comparison = (send(method) <=> other.send(method))
+        return comparison unless comparison == 0
+      end
+      PreRelease.new(prerelease) <=> PreRelease.new(other.prerelease)
     end
 
     include Comparable
@@ -109,35 +110,63 @@ module XSemVer
       regex_str = Regexp.escape format
 
       # Convert all the format characters to named capture groups
-      regex_str = regex_str.gsub('%M', '(?<major>\d+)').
+      regex_str = regex_str.
+        gsub('%M', '(?<major>\d+)').
         gsub('%m', '(?<minor>\d+)').
         gsub('%p', '(?<patch>\d+)').
-        gsub('%s', '(?:-(?<special>[A-Za-z][0-9A-Za-z\.]+))?')
+        gsub('%s', '(?:-(?<special>[A-Za-z][0-9A-Za-z\.]+))?').
+        gsub('%d', '(?:\x2B(?<metadata>[0-9A-Za-z][0-9A-Za-z\.]*))?')
 
       regex = Regexp.new(regex_str)
       match = regex.match version_string
 
       if match
-          major = minor = patch = nil
-          special = ''
-
-          # Extract out the version parts
-          major = match[:major].to_i if match.names.include? 'major'
-          minor = match[:minor].to_i if match.names.include? 'minor'
-          patch = match[:patch].to_i if match.names.include? 'patch'
-          special = match[:special] || '' if match.names.include? 'special'
-
-          # Failed parse if major, minor, or patch wasn't found
-          # and allow_missing is false
-          return nil if !allow_missing and [major, minor, patch].any? {|x| x.nil? }
-
-          # Otherwise, allow them to default to zero
-          major ||= 0
-          minor ||= 0
-          patch ||= 0
-
-          SemVer.new major, minor, patch, special
+        major = minor = patch = nil
+        special = metadata = ''
+
+        # Extract out the version parts
+        major = match[:major].to_i if match.names.include? 'major'
+        minor = match[:minor].to_i if match.names.include? 'minor'
+        patch = match[:patch].to_i if match.names.include? 'patch'
+        special = match[:special] || '' if match.names.include? 'special'
+        metadata = match[:metadata] || '' if match.names.include? 'metadata'
+
+        # Failed parse if major, minor, or patch wasn't found
+        # and allow_missing is false
+        return nil if !allow_missing and [major, minor, patch].any? {|x| x.nil? }
+
+        # Otherwise, allow them to default to zero
+        major ||= 0
+        minor ||= 0
+        patch ||= 0
+
+        SemVer.new major, minor, patch, special, metadata
       end
     end
+    
+    # SemVer specification 2.0.0-rc2 states that anything after the '-' character is prerelease data.
+    # To be consistent with the specification verbage, #prerelease returns the same value as #special.
+    # TODO: Deprecate #special in favor of #prerelease?
+    def prerelease
+      special
+    end
+    
+    # SemVer specification 2.0.0-rc2 states that anything after the '-' character is prerelease data.
+    # To be consistent with the specification verbage, #prerelease= sets the same value as #special.
+    # TODO: Deprecate #special= in favor of #prerelease=?
+    def prerelease=(pre)
+      self.special = pre
+    end
+    
+    # Return true if the SemVer has a non-empty #prerelease value. Otherwise, false.
+    def prerelease?
+      !special.nil? && special.length > 0
+    end
+    
+    # Return true if the SemVer has a non-empty #metadata value. Otherwise, false.
+    def metadata?
+      !metadata.nil? && metadata.length > 0
+    end    
+    
   end
 end

data/semver2.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Semantic Versioning"
   spec.description = "maintain versions as per http://semver.org"
   spec.email = "henrik@haf.se"
-  spec.authors = ["Francesco Lazzarino", "Henrik Feldt"]
+  spec.authors = ["Francesco Lazzarino", "Henrik Feldt", "James Childress"]
   spec.homepage = 'https://github.com/haf/semver'
   spec.executables << 'semver'
   spec.files = [".semver", "semver2.gemspec", "README.md"] + Dir["lib/**/*.rb"] + Dir['bin/*']

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: semver2
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.3.2
   prerelease: 
 platform: ruby
 authors:
 - Francesco Lazzarino
 - Henrik Feldt
+- James Childress
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +39,8 @@ files:
 - .semver
 - semver2.gemspec
 - README.md
+- lib/pre_release.rb
+- lib/runner.rb
 - lib/semver/semvermissingerror.rb
 - lib/semver.rb
 - lib/xsemver.rb