Module: Tap::Support::Versions

Included in:
Root, Root
Defined in:
lib/tap/support/versions.rb

Overview

Version provides methods for adding, removing, and incrementing versions at the end of filepaths. Versions are all formatted like: ‘filepath-version.extension’.

Instance Method Summary collapse

Instance Method Details

#compare_versions(a, b) ⇒ Object

A <=> comparison for versions. compare_versions can take strings, integers, or even arrays representing the parts of a version.

compare_versions("1.0.0", "0.9.9")          # => 1
compare_versions(1.1, 1.1)                  # => 0
compare_versions([0,9], [0,9,1])            # => -1



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/tap/support/versions.rb', line 70

def compare_versions(a,b)
  a, b = [a,b].collect {|item| to_integer_array(item) }
  
  # equalize the lengths of the integer arrays
  d = b.length - a.length
  case 
  when d < 0 then b.concat Array.new(-d, 0)
  when d > 0 then a.concat Array.new(d, 0)
  end 

  a <=> b
end

#deversion(path) ⇒ Object

Splits the version from the input path, then returns the path and version.

If no version is specified, then the returned version will be nil.

deversion("path/to/file-1.0.txt")           # => ["path/to/file.txt", "1.0"]
deversion("path/to/file.txt")               # => ["path/to/file.txt", nil]



58
59
60
61
62
 
# File 'lib/tap/support/versions.rb', line 58

def deversion(path)
  extname = File.extname(path)
  extname = '' if extname =~ /^\.\d+$/
  path =~ /^(.*)-(\d(\.?\d)*)#{extname}$/ ? [$1 + extname, $2] : [path, nil]
end

#increment(path, increment) ⇒ Object

Increments the version of the filepath by the specified increment.

increment("path/to/file-1.0.txt", "0.0.1")  # => "path/to/file-1.0.1.txt"
increment("path/to/file.txt", 1.0)          # => "path/to/file-1.0.txt"



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/tap/support/versions.rb', line 31

def increment(path, increment)
  path, version = deversion(path)
  
  # split the version and increment into integer arrays of equal length
  increment, version = [increment, version].collect do |vstr| 
    begin
      vstr.to_s.split(/\./).collect {|v| v.to_i}
    rescue
      raise "Bad version or increment: #{vstr}"
    end
  end
  version.concat Array.new(increment.length - version.length, 0) if increment.length > version.length

  # add the increment to version
  0.upto(version.length-1) do |i|
    version[i] += (increment[i] || 0)
  end

  self.version(path, version.join("."))
end

#version(path, version) ⇒ Object

Adds a version to the filepath. Versioned filepaths follow the format: ‘path-version.extension’. If no version is specified, then the filepath is returned.

version("path/to/file.txt", 1.0)            # => "path/to/file-1.0.txt"



16
17
18
19
20
21
22
23
24
 
# File 'lib/tap/support/versions.rb', line 16

def version(path, version)
  version = version.to_s.strip
  if version.empty? 
    path
  else
    extname = File.extname(path)
    path.chomp(extname) + '-' + version + extname
  end
end