Module: SemanticRange

Defined in:
lib/semantic_range.rb,
lib/semantic_range/range.rb,
lib/semantic_range/version.rb,
lib/semantic_range/comparator.rb,
lib/semantic_range/pre_release.rb

Defined Under Namespace

Classes: Comparator, InvalidComparator, InvalidIncrement, InvalidRange, InvalidVersion, PreRelease, Range, Version

Constant Summary collapse

BUILDIDENTIFIER = 
/[0-9A-Za-z-]+/
BUILD = 
/(?:\+(#{BUILDIDENTIFIER.source}(?:\.#{BUILDIDENTIFIER.source})*))/
NUMERICIDENTIFIER = 
/0|[1-9]\d*/
NUMERICIDENTIFIERLOOSE = 
/[0-9]+/
NONNUMERICIDENTIFIER = 
/\d*[a-zA-Z-][a-zA-Z0-9-]*/
XRANGEIDENTIFIERLOOSE = 
/#{NUMERICIDENTIFIERLOOSE.source}|x|X|\*/
PRERELEASEIDENTIFIERLOOSE = 
/(?:#{NUMERICIDENTIFIERLOOSE.source}|#{NONNUMERICIDENTIFIER.source})/
PRERELEASELOOSE = 
/(?:-?(#{PRERELEASEIDENTIFIERLOOSE.source}(?:\.#{PRERELEASEIDENTIFIERLOOSE.source})*))/
XRANGEPLAINLOOSE = 
/[v=\s]*(#{XRANGEIDENTIFIERLOOSE.source})(?:\.(#{XRANGEIDENTIFIERLOOSE.source})(?:\.(#{XRANGEIDENTIFIERLOOSE.source})(?:#{PRERELEASELOOSE.source})?#{BUILD.source}?)?)?/
HYPHENRANGELOOSE = 
/^\s*(#{XRANGEPLAINLOOSE.source})\s+-\s+(#{XRANGEPLAINLOOSE.source})\s*$/
PRERELEASEIDENTIFIER = 
/(?:#{NUMERICIDENTIFIER.source}|#{NONNUMERICIDENTIFIER.source})/
PRERELEASE = 
/(?:-(#{PRERELEASEIDENTIFIER.source}(?:\.#{PRERELEASEIDENTIFIER.source})*))/
XRANGEIDENTIFIER = 
/#{NUMERICIDENTIFIER.source}|x|X|\*/
XRANGEPLAIN = 
/[v=\s]*(#{XRANGEIDENTIFIER.source})(?:\.(#{XRANGEIDENTIFIER.source})(?:\.(#{XRANGEIDENTIFIER.source})(?:#{PRERELEASE.source})?#{BUILD.source}?)?)?/
HYPHENRANGE = 
/^\s*(#{XRANGEPLAIN.source})\s+-\s+(#{XRANGEPLAIN.source})\s*$/
MAINVERSIONLOOSE = 
/(#{NUMERICIDENTIFIERLOOSE.source})\.(#{NUMERICIDENTIFIERLOOSE.source})\.(#{NUMERICIDENTIFIERLOOSE.source})/
LOOSEPLAIN = 
/[v=\s]*#{MAINVERSIONLOOSE.source}#{PRERELEASELOOSE.source}?#{BUILD.source}?/
GTLT = 
/((?:<|>)?=?)/
COMPARATORTRIM = 
/(\s*)#{GTLT.source}\s*(#{LOOSEPLAIN.source}|#{XRANGEPLAIN.source})/
LONETILDE = 
/(?:~>?)/
TILDETRIM = 
/(\s*)#{LONETILDE.source}\s+/
LONECARET = 
/(?:\^)/
CARETTRIM = 
/(\s*)#{LONECARET.source}\s+/
STAR = 
/(<|>)?=?\s*\*/
CARET = 
/^#{LONECARET.source}#{XRANGEPLAIN.source}$/
CARETLOOSE = 
/^#{LONECARET.source}#{XRANGEPLAINLOOSE.source}$/
MAINVERSION = 
/(#{NUMERICIDENTIFIER.source})\.(#{NUMERICIDENTIFIER.source})\.(#{NUMERICIDENTIFIER.source})/
FULLPLAIN = 
/v?#{MAINVERSION.source}#{PRERELEASE.source}?#{BUILD.source}?/
FULL = 
/^#{FULLPLAIN.source}$/
LOOSE = 
/^#{LOOSEPLAIN.source}$/
TILDE = 
/^#{LONETILDE.source}#{XRANGEPLAIN.source}$/
TILDELOOSE = 
/^#{LONETILDE.source}#{XRANGEPLAINLOOSE.source}$/
XRANGE = 
/^#{GTLT.source}\s*#{XRANGEPLAIN.source}$/
XRANGELOOSE = 
/^#{GTLT.source}\s*#{XRANGEPLAINLOOSE.source}$/
COMPARATOR = 
/^#{GTLT.source}\s*(#{FULLPLAIN.source})$|^$/
COMPARATORLOOSE = 
/^#{GTLT.source}\s*(#{LOOSEPLAIN.source})$|^$/
ANY = 
{}
MAX_LENGTH = 
256
VERSION = 
"2.2.1"

Class Method Summary collapse

Class Method Details

.clean(version, loose = false) ⇒ Object 



223
224
225
226
 
# File 'lib/semantic_range.rb', line 223

def self.clean(version, loose = false)
  s = parse(version.strip.gsub(/^[=v]+/, ''), loose)
  return s ? s.version : nil
end

.cmp(a, op, b, loose = false) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/semantic_range.rb', line 61

def self.cmp(a, op, b, loose = false)
  case op
  when '==='
    a = a.version if !a.is_a?(String)
    b = b.version if !b.is_a?(String)
    a == b
  when '!=='
    a = a.version if !a.is_a?(String)
    b = b.version if !b.is_a?(String)
    a != b
  when '', '=', '=='
    eq?(a, b, loose)
  when '!='
    neq?(a, b, loose)
  when '>'
    gt?(a, b, loose)
  when '>='
    gte?(a, b, loose)
  when '<'
    lt?(a, b, loose)
  when '<='
    lte?(a, b, loose)
  else
    raise 'Invalid operator: ' + op
  end
end

.compare(a, b, loose = false) ⇒ Object 



174
175
176
 
# File 'lib/semantic_range.rb', line 174

def self.compare(a, b, loose = false)
  Version.new(a, loose).compare(b)
end

.compare_loose(a, b) ⇒ Object 



178
179
180
 
# File 'lib/semantic_range.rb', line 178

def self.compare_loose(a, b)
  compare(a, b, true)
end

.diff(a, b) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/semantic_range.rb', line 254

def self.diff(a, b)
  a = Version.new(a, false) unless a.kind_of?(Version)
  b = Version.new(b, false) unless b.kind_of?(Version)
  pre_diff = a.prerelease.to_s != b.prerelease.to_s
  pre = pre_diff ? 'pre' : ''
  return "#{pre}major" if a.major != b.major
  return "#{pre}minor" if a.minor != b.minor
  return "#{pre}patch" if a.patch != b.patch
  return "prerelease"  if pre_diff
end

.eq?(a, b, loose = false) ⇒ Boolean Also known as: eq

Returns:

  • (Boolean) 


202
203
204
 
# File 'lib/semantic_range.rb', line 202

def self.eq?(a, b, loose = false)
  compare(a, b, loose) == 0
end

.gt?(a, b, loose = false) ⇒ Boolean Also known as: gt

Returns:

  • (Boolean) 


198
199
200
 
# File 'lib/semantic_range.rb', line 198

def self.gt?(a, b, loose = false)
  compare(a, b, loose) > 0
end

.gte?(a, b, loose = false) ⇒ Boolean Also known as: gte

Returns:

  • (Boolean) 


210
211
212
 
# File 'lib/semantic_range.rb', line 210

def self.gte?(a, b, loose = false)
  compare(a, b, loose) >= 0
end

.gtr?(version, range, loose = false, platform = nil) ⇒ Boolean Also known as: gtr

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/semantic_range.rb', line 57

def self.gtr?(version, range, loose = false, platform = nil)
  outside?(version, range, '>', loose, platform)
end

.increment!(version, release, loose, identifier) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/semantic_range.rb', line 243

def self.increment!(version, release, loose, identifier)
  if loose.is_a? String
    identifier = loose
    loose = false
  end

  Version.new(version, loose).increment!(release, identifier).version
rescue InvalidIncrement, InvalidVersion
  nil
end

.lt?(a, b, loose = false) ⇒ Boolean Also known as: lt

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/semantic_range.rb', line 194

def self.lt?(a, b, loose = false)
  compare(a, b, loose) < 0
end

.lte?(a, b, loose = false) ⇒ Boolean Also known as: lte

Returns:

  • (Boolean) 


214
215
216
 
# File 'lib/semantic_range.rb', line 214

def self.lte?(a, b, loose = false)
  compare(a, b, loose) <= 0
end

.ltr?(version, range, loose = false, platform = nil) ⇒ Boolean Also known as: ltr

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/semantic_range.rb', line 53

def self.ltr?(version, range, loose = false, platform = nil)
  outside?(version, range, '<', loose, platform)
end

.max_satisfying(versions, range, loose = false, platform = nil) ⇒ Object 



156
157
158
159
160
161
162
 
# File 'lib/semantic_range.rb', line 156

def self.max_satisfying(versions, range, loose = false, platform = nil)
  versions.select { |version|
    satisfies?(version, range, loose, platform)
  }.sort { |a, b|
    rcompare(a, b, loose)
  }[0] || nil
end

.neq?(a, b, loose = false) ⇒ Boolean Also known as: neq

Returns:

  • (Boolean) 


206
207
208
 
# File 'lib/semantic_range.rb', line 206

def self.neq?(a, b, loose = false)
  compare(a, b, loose) != 0
end

.outside?(version, range, hilo, loose = false, platform = nil) ⇒ Boolean Also known as: outside

Returns:

  • (Boolean) 


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/semantic_range.rb', line 88

def self.outside?(version, range, hilo, loose = false, platform = nil)
  version = Version.new(version, loose)
  range = Range.new(range, loose, platform)

  return false if satisfies?(version, range, loose, platform)

  case hilo
  when '>'
    comp = '>'
    ecomp = '>='
  when '<'
    comp = '<'
    ecomp = '<='
  end

  range.set.each do |comparators|
    high = nil
    low = nil

    comparators.each do |comparator|
      if comparator.semver == ANY
        comparator = Comparator.new('>=0.0.0', loose)
      end

      high = high || comparator
      low = low || comparator

      case hilo
      when '>'
        if gt?(comparator.semver, high.semver, loose)
          high = comparator
        elsif lt?(comparator.semver, low.semver, loose)
          low = comparator
        end
      when '<'
        if lt?(comparator.semver, high.semver, loose)
          high = comparator
        elsif gt?(comparator.semver, low.semver, loose)
          low = comparator
        end
      end
    end

    return false if (high.operator == comp || high.operator == ecomp)

    case hilo
    when '>'
      if (low.operator.empty? || low.operator == comp) && lte?(version, low.semver, loose)
        return false;
      elsif (low.operator == ecomp && lt?(version, low.semver, loose))
        return false;
      end
    when '<'
      if (low.operator.empty? || low.operator == comp) && gte?(version, low.semver, loose)
        return false;
      elsif low.operator == ecomp && gt?(version, low.semver, loose)
        return false;
      end
    end
  end
  true
end

.parse(version, loose = false) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/semantic_range.rb', line 228

def self.parse(version, loose = false)
  return version if version.is_a?(Version)

  return nil unless version.is_a?(String)

  stripped_version = version.strip

  return nil if stripped_version.length > MAX_LENGTH

  rxp = loose ? LOOSE : FULL
  return nil if !rxp.match(stripped_version)

  Version.new(stripped_version, loose)
end

.rcompare(a, b, loose = false) ⇒ Object 



182
183
184
 
# File 'lib/semantic_range.rb', line 182

def self.rcompare(a, b, loose = false)
  compare(b, a, true)
end

.rsort(list, loose = false) ⇒ Object 



190
191
192
 
# File 'lib/semantic_range.rb', line 190

def self.rsort(list, loose = false)
  # TODO
end

.satisfies?(version, range, loose = false, platform = nil) ⇒ Boolean Also known as: satisfies

Returns:

  • (Boolean) 


151
152
153
154
 
# File 'lib/semantic_range.rb', line 151

def self.satisfies?(version, range, loose = false, platform = nil)
  return false if !valid_range(range, loose, platform)
  Range.new(range, loose, platform).test(version)
end

.sort(list, loose = false) ⇒ Object 



186
187
188
 
# File 'lib/semantic_range.rb', line 186

def self.sort(list, loose = false)
  # TODO
end

.to_comparators(range, loose = false, platform = nil) ⇒ Object 



265
266
267
268
269
 
# File 'lib/semantic_range.rb', line 265

def self.to_comparators(range, loose = false, platform = nil)
  Range.new(range, loose, platform).set.map do |comp|
    comp.map(&:to_s)
  end
end

.valid(version, loose = false) ⇒ Object 



218
219
220
221
 
# File 'lib/semantic_range.rb', line 218

def self.valid(version, loose = false)
  v = parse(version, loose)
  return v ? v.version : nil
end

.valid_range(range, loose = false, platform = nil) ⇒ Object 



164
165
166
167
168
169
170
171
172
 
# File 'lib/semantic_range.rb', line 164

def self.valid_range(range, loose = false, platform = nil)
  begin
    r = Range.new(range, loose, platform).range
    r = '*' if r.nil? || r.empty?
    r
  rescue
    nil
  end
end