vmlib 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59fe12924831b9a814d93ead77137e7ec9ef03ce
+  data.tar.gz: 89c6f9f26768d373ef1fb8381653e3e92c3b6dc2
+SHA512:
+  metadata.gz: a09e8f0656391ed990283f1cc884a203ea9d4b48ef69adc2fc300e902b4a4e5b6a19d3e23a54476b1fcde7e9cb692d814f8a6cb246892c061c24cf10dc3ffc90
+  data.tar.gz: 2e1f5938fd9cae969f29a62be0b7e36492059318549dcff805e66c9e0ce8c2101b28fa9b1983ab6540229fde0d6616fecebe3a6e6c138d292f45d5dd8edcd06d

data/Gemfile

@@ -0,0 +1,5 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec
+# gem "rails"

data/README.md

@@ -0,0 +1,80 @@
+Version Manager Library
+=======================
+
+The Version manager library (VMLib) is a generic library to handle
+semantic versioning as specified at <http://semver.org>. In addition to
+complying with semantic versioning v2.0.0-rc.1, it adds additional API
+calls to bump the major, minor and patch versions as well as handle
+distinct types of releases (development, alpha, beta, release candidate,
+final as well as a custom type)
+
+# Public API
+
+VMLib has the following public CLI interface
+
+`init <name>` - Initializes the version tracker
+> This creates a new version tracker library for the project named
+> <name>. It initializes the version number to 0.1.0 and the release
+> type to `:development` and the release number to 0. If the project
+> has already been intialized, then raises VMLibInitError.
+
+`bump major` - Bumps the major version
+> This will increment the major version by 1, while simultaneously
+> setting the minor version and patchlevel to 0.
+
+`bump minor` - Bumps the minor version
+> This will increment the minor version by 1 and reset the patch level
+> to 0.
+
+`bump patch` - Bumps the patch level
+> This will increment the patch level by 1.
+
+`bump type` - Bumps the prerelease type to the next higher release type
+> This will bump the prerelease type up to the next higher release type,
+> i.e., `development` -> `alpha` -> `beta` -> `release candidate` ->
+> `final`. The corresponding release number is also set to 1. If the
+> release type is already `final` or `custom`, it will raise
+> `VMLib::Errors::BumpError`.
+
+`bump pre`, `bump prerelease`
+> This will bump the release number by 1 if the prerelease type is
+> `development`, `alpha`, `beta` or `release candidate`. If the
+> release type is `:final` it will raise VMLib::Errors::BumpError.
+> If the release type is `custom`, it will take the last field of
+> `relcustom` and if numeric, it will bump it, otherwise, it will
+> raise VMLib::Errors::BumpError.
+
+`set pre`, `set prerelease`
+> This will set the prerelease information as specified by the user.
+
+`set build`
+> This will set the build information as specified by the user.
+
+`format`
+> This takes in an optional format string for printing the version
+> information. If the format string is not specified, it will revert to
+> the default, however, if the format string is `tag`, then it will
+> print the tag format.
+
+`update`
+> This command will search for all source files beginning with the
+> string `version` and will update them to match with the primary
+> version number set by the bump routine. It will also generate a Git
+> commit for the changed files.
+
+`tag`
+> This command will generate a Git tag with the version specified by the
+> version number file.
+
+# Release Types
+
+VMLib supports the following release types, in order
+
+* development
+* alpha
+* beta
+* release candidate
+* final
+* custom
+
+

data/Rakefile

@@ -0,0 +1,24 @@
+# VMLib Rakefile
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "bundler/gem_tasks"
+require "vmlib/version"
+
+# Unit tests task
+desc "Run unit test task for vmlib-#{VMLib::VERSION}"
+task :test do
+  $:.unshift(::File.expand_path('lib', ::File.dirname(__FILE__)))
+  if ::ENV['TEST_CASE']
+    test_files = ::Dir.glob("test/#{::ENV['TEST_CASE']}.rb")
+  else
+    test_files = ::Dir.glob("test/**/test_*.rb")
+  end
+  $VERBOSE = true
+
+  test_files.each do |path|
+    load path
+    puts "Loaded testcase #{path}"
+  end
+end
+

data/Version

@@ -0,0 +1 @@
+vmlib 1.0.0

data/bin/vmlib

@@ -0,0 +1,156 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+
+require 'vmlib'
+
+module VMLib
+
+  # Raised when there is an issue on the command line
+  class CommandError < Errors::VMLibError; end
+  
+  ###########################################################################
+  # Command line interface to VMLib gem
+  ###########################################################################
+  begin
+    command = ARGV.shift || 'format'
+  
+    case command
+
+    #########################################################################
+    # Initializes a new version file in the current folder
+    #########################################################################
+    when /^init(?:ialize)?$/ # init | initialize
+      name = ARGV.shift or
+        raise CommandError, "required: <name>"
+
+      vfile = File.new
+      vfile.create(name)
+    
+    #########################################################################
+    # Bumps the specified version field by 1
+    # If type is specified, then bumps the type to the next higher type, i.e.
+    # development -> alpha -> beta -> release candidate -> final
+    #########################################################################
+    when 'bump' # bump
+      dimension = ARGV.shift or
+        raise CommandError, "required: major | minor | patch | pre | type"
+
+      vfile = File.new
+      version = vfile.read
+
+      case dimension
+      when 'major'
+        version.bump_major
+      when 'minor'
+        version.bump_minor
+      when 'patch'
+        version.bump_patch
+      when 'pre'
+        version.bump_prerelease
+      when 'type'
+        version.bump_release_type
+      else
+        raise CommandError, "invalid dimension #{dimension}"
+      end
+
+      puts "Bumped version to #{version.tag}"
+      vfile.write version
+    
+    #########################################################################
+    # Sets either the prerelease or the build string
+    #########################################################################
+    when 'set'  # set pre | prerelease | build
+      type = ARGV.shift or
+        raise CommandError, "required: pre[release] | build"
+
+      case type
+      when /^pre(?:release)?$/ # pre | prerelease
+        pre = ARGV.shift or
+          raise CommandError, "required: <prerelease string>"
+
+        vfile = File.new
+        version = vfile.read
+        version.prerelease = pre
+        puts "Set prerelease version to #{version.tag}"
+        vfile.write version
+
+      when 'build' # build
+        build = ARGV.shift or
+          raise CommandError, "required: <build string>"
+
+        vfile = File.new
+        version = vfile.read
+        version.build = build
+        puts "Set build version to #{version.tag}"
+        vfile.write version
+      
+      else
+        raise CommandError, "unrecognized set type #{type}"
+      end
+
+    #########################################################################
+    # Updates all the source files with the bumped version
+    # Also writes the changes to the git repository
+    #########################################################################
+    when 'update' # update
+      sfile = Source.new
+      sfile.update
+      version = File.new.read.tag
+
+      puts "Committing changed files in #{version}"
+      system("git commit -am 'Bumped version to #{version}'")
+      
+
+    #########################################################################
+    # Display the version as a format
+    # Accepts an optional format string or 'tag'. If neither is specified
+    # then it will print using the default format string %n%M.%m.%p%r%b
+    #########################################################################
+    when 'format'
+      fstr = ARGV.shift
+      version = File.new.read
+
+      if fstr.nil?
+        puts version.to_s
+      elsif fstr == 'tag'
+        puts version.tag
+      else
+        puts version.format fstr
+      end
+    
+    #########################################################################
+    # Generates a tag version and creates a new Git tag
+    # For now, it simply prints out the tag string
+    #########################################################################
+    when 'tag'
+      version = File.new.read
+      puts "Tagging version #{version.tag}"
+   
+      system "git tag -a -m '#{version.to_s}' #{version.tag}"
+      
+    else
+      raise CommandError, "invalid command #{command}"
+    end
+
+  ###########################################################################
+  # Handler for errors on the command line
+  ###########################################################################
+  rescue CommandError => e
+    puts "#{$0}: #{e.message}"
+    puts "Type #{$0} help for more info"
+    exit 1
+
+  ###########################################################################
+  # Handler for errors from the VMLib source
+  ###########################################################################
+  rescue Errors::VMLibError => e
+    puts "#{$0}: #{e.message}"
+    exit 1
+  end
+
+  ###########################################################################
+  # No handler for other errors
+  ###########################################################################
+
+
+end

data/lib/vmlib/base.rb

@@ -0,0 +1,214 @@
+###############################################################################
+# VMLib base
+###############################################################################
+# Copyright (C) 2013 Nirenjan Krishnan
+# All rights reserved.
+###############################################################################
+
+;
+
+module VMLib
+
+  # This is the primary version number class for the version manager library
+  class Version
+
+    # Reset the version number to 0.0.0-0
+    def reset
+      @name = ''
+      @major = 0
+      @minor = 0
+      @patch = 0
+      @reltype = :rel_type_dev
+      @devnum = 0
+      @alphanum = 0
+      @betanum = 0
+      @rcnum = 0
+      @relcustom = []
+      @buildtype = :bld_type_final
+      @buildcustom = []
+
+      true
+    end
+
+    # Create a new version instance and set it to the specified parameters
+    def initialize(name = '', major = 0, minor = 0, patch = 0, prerelease = '0', build = '')
+      reset
+      set_name name
+      set_major major
+      set_minor minor
+      set_patch patch
+      set_prerelease prerelease
+      set_build build
+    end
+    
+    # Inspect the version object
+    def inspect
+      str = "#<#{self.class}:"
+      str += "0x%016x" % (self.object_id * 2)
+      str += " @name='#{@name}'"
+      str += " @major=#{@major}"
+      str += " @minor=#{@minor}"
+      str += " @patch=#{@patch}"
+
+      case @reltype
+      when :rel_type_dev
+        str += " @devnum=#{@devnum}"
+      when :rel_type_alpha
+        str += " @alphanum=#{@alphanum}"
+      when :rel_type_beta
+        str += " @betanum=#{@betanum}"
+      when :rel_type_rc
+        str += " @rcnum=#{@rcnum}"
+      when :rel_type_custom
+        str += " @prerelease=#{@relcustom.inspect}"
+      end
+
+      case @buildtype
+      when :bld_type_custom
+        str += " @build=#{@buildcustom.inspect}"
+      end
+
+      str += ">"
+
+      str
+    end
+
+    ###########################################################################
+    # Accessor functions for name
+    ###########################################################################
+
+    # The program or project name
+    attr_accessor :name
+
+    # Set the program or project name
+    undef name=
+    def name= (name) #:nodoc:
+      set_name name
+    end
+
+    def set_name (name) #:nodoc:
+      name.kind_of? String or
+        raise Errors::AssignError, "invalid name #{name.inspect}"
+
+      @name = name
+    end
+    private :set_name
+
+    ###########################################################################
+    # Accessor functions for major
+    ###########################################################################
+
+    # The major version number
+    attr_accessor :major
+
+    # Set the major version number
+    undef major=
+    def major=(major) #:nodoc:
+      set_major major
+    end
+
+    def set_major (major) #:nodoc:
+      major.kind_of? Integer or
+        raise Errors::AssignError, "invalid major version #{major.inspect}"
+
+      @major = major
+    end
+    private :set_major
+
+    ###########################################################################
+    # Accessor functions for minor
+    ###########################################################################
+
+    # The minor version number
+    attr_accessor :minor
+
+    # Set the minor version number
+    undef minor=
+    def minor=(minor) #:nodoc:
+      set_minor minor
+    end
+
+    def set_minor (minor) #:nodoc:
+      minor.kind_of? Integer or
+        raise Errors::AssignError, "invalid minor version #{minor.inspect}"
+
+      @minor = minor
+    end
+    private :set_minor
+
+    ###########################################################################
+    # Accessor functions for patch
+    ###########################################################################
+
+    # The patch version number
+    attr_accessor :patch
+
+    # Set the patch version number
+    undef patch=
+    def patch=(patch) #:nodoc:
+      set_patch patch
+    end
+
+    def set_patch (patch) #:nodoc:
+      patch.kind_of? Integer or
+        raise Errors::AssignError, "invalid patch version #{patch.inspect}"
+
+      @patch = patch
+    end
+    private :set_patch
+
+    ###########################################################################
+    # Accessor functions for prerelease
+    ###########################################################################
+
+    # Get the prerelease information
+    def prerelease #:attr:
+      format '%r'
+    end
+
+    # Set the prerelease information
+    def prerelease=(prerelease)
+      set_prerelease prerelease
+    end
+
+    def set_prerelease (prerelease) #:nodoc:
+      prerelease.kind_of? String or
+        raise Errors::ParseError, "invalid prerelease #{prerelease.inspect}"
+
+      m = parse_release(prerelease)
+      prerelease = prerelease.sub(SPECIAL_REGEX, '') if m
+      warn "ignoring additional data #{prerelease.inspect}" unless prerelease.empty?
+
+      true
+    end
+    private :set_prerelease
+
+    ###########################################################################
+    # Accessor functions for build
+    ###########################################################################
+
+    # Get the build information
+    def build
+      format '%b'
+    end
+
+    # Set the build information
+    def build=(build)
+      set_build build
+    end
+
+    def set_build (build) #:nodoc:
+      build.kind_of? String or
+        raise Errors::ParseError, "invalid build #{build.inspect}"
+
+      m = parse_build(build)
+      build = build.sub(SPECIAL_REGEX, '') if m
+      warn "ignoring additional data #{build.inspect}" unless build.empty?
+
+      true
+    end
+
+  end
+
+
+end

data/lib/vmlib/bump.rb

@@ -0,0 +1,93 @@
+###############################################################################
+# VMLib bump routines
+###############################################################################
+# Copyright (C) 2013 Nirenjan Krishnan
+# All rights reserved.
+###############################################################################
+
+;
+
+module VMLib
+
+  class Version
+
+    # Bump the major release by 1 and reset the minor and patch
+    # releases to 0.
+    def bump_major
+      @major = @major + 1
+      @minor = 0
+      @patch = 0
+
+      true
+    end
+
+    # Bump the minor release by 1 and reset the patch release to 0
+    def bump_minor
+      @minor = @minor + 1
+      @patch = 0
+
+      true
+    end
+
+    # Bump the patch release by 1
+    def bump_patch
+      @patch = @patch + 1
+
+      true
+    end
+
+    # Bump the prerelease version by 1
+    def bump_prerelease
+      case @reltype
+      when :rel_type_dev
+        @devnum += 1
+      when :rel_type_alpha
+        @alphanum += 1
+      when :rel_type_beta
+        @betanum += 1
+      when :rel_type_rc
+        @rcnum += 1
+      when :rel_type_final
+        raise Errors::BumpError, "cannot bump prerelease for a final version"
+      when :rel_type_custom
+        lastfield = @relcustom.pop
+        if lastfield.kind_of? Integer
+          @relcustom.push (lastfield + 1)
+        else
+          @relcustom.push lastfield
+          raise Errors::BumpError, "cannot bump a non-numeric prerelease field"
+        end
+      end
+    end
+
+    # Bump the prerelease type
+    def bump_release_type
+      case @reltype
+      when :rel_type_dev # development -> alpha
+        @reltype = :rel_type_alpha
+        @alphanum = 1
+
+      when :rel_type_alpha # alpha -> beta
+        @reltype = :rel_type_beta
+        @betanum = 1
+
+      when :rel_type_beta # beta -> rc
+        @reltype = :rel_type_rc
+        @rcnum = 1
+
+      when :rel_type_rc # rc -> final
+        @reltype = :rel_type_final
+
+      when :rel_type_final # ERROR!
+        raise Errors::BumpError, "cannot bump from final version"
+
+      when :rel_type_custom # ERROR!
+        raise Errors::BumpError, "cannot bump from custom prerelease"
+
+      end
+    end
+
+  end
+
+
+end

data/lib/vmlib/compare.rb

@@ -0,0 +1,107 @@
+###############################################################################
+# VMLib comparision routines
+###############################################################################
+# Copyright (C) 2013 Nirenjan Krishnan
+# All rights reserved.
+###############################################################################
+
+;
+
+module VMLib
+
+  class Version
+
+    # Compare two arrays element by element.
+    # If one element is numeric and the other a string, then the string
+    # takes precedence over the number.
+    def compare_arrays(array1, array2)
+      raise Errors::ParameterError unless array1.is_a? Array
+      raise Errors::ParameterError unless array2.is_a? Array
+
+      # Run for the shorter of the two arrays
+      if array1.length < array2.length
+        len = array1.length
+        possibly_gt = :array2
+      else
+        len = array2.length
+        possibly_gt = :array1
+      end
+
+      cmp = 0
+
+      # Check for an empty array, if so, resort to using the Array <=>
+      if len == 0
+        return array1 <=> array2
+      end
+
+      for i in (0...len)
+        elm1 = array1[i]
+        elm2 = array2[i]
+        
+        cls1 = elm1.class
+        cls2 = elm2.class
+
+        if cls1 == cls2
+          cmp = (elm1 <=> elm2)
+        else
+          if cls1 == String # cls2 = Fixnum
+            # String > Fixnum
+            cmp = 1
+          else # cls1 = Fixnum, cls2 = String
+            # Fixnum < String
+            cmp = -1
+          end
+        end
+
+        break unless cmp == 0
+      end
+
+      return cmp unless cmp == 0
+
+      # Resort to comparing the remaining elements using Array <=>
+      cmp = (array1[len...array1.length] <=> array2[len...array2.length])
+      return cmp
+    end
+    private :compare_arrays
+
+    # Compare two version structures
+    def <=> (other)
+      # Check major version
+      cmp = (@major <=> other.major)
+      return cmp unless cmp == 0
+
+      # Check minor version
+      cmp = (@minor <=> other.minor)
+      return cmp unless cmp == 0
+
+      # Check patch version
+      cmp = (@patch <=> other.patch)
+      return cmp unless cmp == 0
+
+      # Check prerelease arrays
+      myown_pre = self.prerelease.split('.')
+      convert_to_integer(myown_pre)
+      other_pre = other.prerelease.split('.')
+      convert_to_integer(other_pre)
+      cmp = compare_arrays(myown_pre, other_pre)
+      
+      # Make sure that the prerelease is compared correctly
+      cmp = 1 if cmp == -1 and myown_pre.length == 0
+      cmp = -1 if cmp == 1 and other_pre.length == 0
+      return cmp unless cmp == 0
+
+      # Check build arrays
+      myown_bld = self.build.split('.')
+      convert_to_integer(myown_bld)
+      other_bld = other.build.split('.')
+      convert_to_integer(other_bld)
+      cmp = compare_arrays(myown_bld, other_bld)
+      return cmp unless cmp == 0
+
+      return 0
+    end
+
+  end
+
+
+end