Class: PubGrub::VersionRange

Inherits:
Object
  • Object
show all
Defined in:
lib/pub_grub/version_range.rb

Direct Known Subclasses

Empty

Defined Under Namespace

Classes: Empty

Constant Summary collapse

EMPTY = 
Empty.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(min: nil, max: nil, include_min: false, include_max: false, name: nil) ⇒ VersionRange

Returns a new instance of VersionRange.



73
74
75
76
77
78
79
 
# File 'lib/pub_grub/version_range.rb', line 73

def initialize(min: nil, max: nil, include_min: false, include_max: false, name: nil)
  @min = min
  @max = max
  @include_min = include_min
  @include_max = include_max
  @name = name
end

Instance Attribute Details

#include_max ⇒ Object (readonly) Also known as: include_max?

Returns the value of attribute include_max.



5
6
7
 
# File 'lib/pub_grub/version_range.rb', line 5

def include_max
  @include_max
end

#include_min ⇒ Object (readonly) Also known as: include_min?

Returns the value of attribute include_min.



5
6
7
 
# File 'lib/pub_grub/version_range.rb', line 5

def include_min
  @include_min
end

#max ⇒ Object (readonly)

Returns the value of attribute max.



5
6
7
 
# File 'lib/pub_grub/version_range.rb', line 5

def max
  @max
end

#min ⇒ Object (readonly)

Returns the value of attribute min.



5
6
7
 
# File 'lib/pub_grub/version_range.rb', line 5

def min
  @min
end

Class Method Details

.any ⇒ Object 



69
70
71
 
# File 'lib/pub_grub/version_range.rb', line 69

def self.any
  new
end

.empty ⇒ Object 



65
66
67
 
# File 'lib/pub_grub/version_range.rb', line 65

def self.empty
  EMPTY
end

Instance Method Details

#==(other) ⇒ Object 



374
375
376
377
378
379
380
 
# File 'lib/pub_grub/version_range.rb', line 374

def ==(other)
  self.class == other.class &&
    min == other.min &&
    max == other.max &&
    include_min == other.include_min &&
    include_max == other.include_max
end

#allows_all?(other) ⇒ Boolean

Returns:

  • (Boolean) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/pub_grub/version_range.rb', line 310

def allows_all?(other)
  return true if other.empty?

  if other.is_a?(VersionUnion)
    return VersionUnion.new([self]).allows_all?(other)
  end

  return false if max && !other.max
  return false if min && !other.min

  if min
    case min <=> other.min
    when -1
    when 0
      return false if !include_min && other.include_min
    when 1
      return false
    end
  end

  if max
    case max <=> other.max
    when -1
      return false
    when 0
      return false if !include_max && other.include_max
    when 1
    end
  end

  true
end

#any? ⇒ Boolean

Returns:

  • (Boolean) 


343
344
345
 
# File 'lib/pub_grub/version_range.rb', line 343

def any?
  !min && !max
end

#compare_version(version) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/pub_grub/version_range.rb', line 141

def compare_version(version)
  if min
    case version <=> min
    when -1
      return -1
    when 0
      return -1 if !include_min
    when 1
    end
  end

  if max
    case version <=> max
    when -1
    when 0
      return 1 if !include_max
    when 1
      return 1
    end
  end

  0
end

#contiguous_to?(other) ⇒ Boolean

Returns:

  • (Boolean) 


302
303
304
305
306
307
308
 
# File 'lib/pub_grub/version_range.rb', line 302

def contiguous_to?(other)
  return false if other.empty?

  intersects?(other) ||
    (min == other.max && (include_min || other.include_max)) ||
    (max == other.min && (include_max || other.include_min))
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


347
348
349
 
# File 'lib/pub_grub/version_range.rb', line 347

def empty?
  false
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
88
89
90
 
# File 'lib/pub_grub/version_range.rb', line 85

def eql?(other)
  min.eql?(other.min) &&
    max.eql?(other.max) &&
    include_min.eql?(other.include_min) &&
    include_max.eql?(other.include_max)
end

#hash ⇒ Object 



81
82
83
 
# File 'lib/pub_grub/version_range.rb', line 81

def hash
  @hash ||= min.hash ^ max.hash ^ include_min.hash ^ include_max.hash
end

#include?(version) ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/pub_grub/version_range.rb', line 96

def include?(version)
  compare_version(version) == 0
end

#inspect ⇒ Object 



355
356
357
 
# File 'lib/pub_grub/version_range.rb', line 355

def inspect
  "#<#{self.class} #{to_s}>"
end

#intersect(other) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/pub_grub/version_range.rb', line 189

def intersect(other)
  return other if other.empty?
  return other.intersect(self) if other.is_a?(VersionUnion)

  min_range =
    if !min
      other
    elsif !other.min
      self
    else
      case min <=> other.min
      when 0
        include_min ? other : self
      when -1
        other
      when 1
        self
      end
    end

  max_range =
    if !max
      other
    elsif !other.max
      self
    else
      case max <=> other.max
      when 0
        include_max ? other : self
      when -1
        self
      when 1
        other
      end
    end

  if !min_range.equal?(max_range) && min_range.min && max_range.max
    case min_range.min <=> max_range.max
    when -1
    when 0
      if !min_range.include_min || !max_range.include_max
        return EMPTY
      end
    when 1
      return EMPTY
    end
  end

  VersionRange.new(
    min: min_range.min,
    include_min: min_range.include_min,
    max: max_range.max,
    include_max: max_range.include_max
  )
end

#intersects?(other) ⇒ Boolean Also known as: allows_any?

Returns:

  • (Boolean) 


182
183
184
185
186
 
# File 'lib/pub_grub/version_range.rb', line 182

def intersects?(other)
  return false if other.empty?
  return other.intersects?(self) if other.is_a?(VersionUnion)
  !strictly_lower?(other) && !strictly_higher?(other)
end

#invert ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/pub_grub/version_range.rb', line 359

def invert
  return self.class.empty if any?

  low = VersionRange.new(max: min, include_max: !include_min)
  high = VersionRange.new(min: max, include_min: !include_max)

  if !min
    high
  elsif !max
    low
  else
    low.union(high)
  end
end

#partition_versions(versions) ⇒ Object

Partitions passed versions into [lower, within, higher]

versions must be sorted



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
 
# File 'lib/pub_grub/version_range.rb', line 103

def partition_versions(versions)
  min_index =
    if !min || versions.empty?
      0
    elsif include_min?
      (0..versions.size).bsearch { |i| versions[i].nil? || versions[i] >= min }
    else
      (0..versions.size).bsearch { |i| versions[i].nil? || versions[i] > min }
    end

  lower = versions.slice(0, min_index)
  versions = versions.slice(min_index, versions.size)

  max_index =
    if !max || versions.empty?
      versions.size
    elsif include_max?
      (0..versions.size).bsearch { |i| versions[i].nil? || versions[i] > max }
    else
      (0..versions.size).bsearch { |i| versions[i].nil? || versions[i] >= max }
    end

  [
    lower,
    versions.slice(0, max_index),
    versions.slice(max_index, versions.size)
  ]
end

#ranges ⇒ Object 



92
93
94
 
# File 'lib/pub_grub/version_range.rb', line 92

def ranges
  [self]
end

#select_versions(versions) ⇒ Object

Returns verisons which are included by this range.

versions must be sorted



135
136
137
138
139
 
# File 'lib/pub_grub/version_range.rb', line 135

def select_versions(versions)
  return versions if any?

  partition_versions(versions)[1]
end

#span(other) ⇒ Object

The span covered by two ranges

If self and other are contiguous, this builds a union of the two ranges. (if they aren’t you are probably calling the wrong method)



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/pub_grub/version_range.rb', line 249

def span(other)
  return self if other.empty?

  min_range =
    if !min
      self
    elsif !other.min
      other
    else
      case min <=> other.min
      when 0
        include_min ? self : other
      when -1
        self
      when 1
        other
      end
    end

  max_range =
    if !max
      self
    elsif !other.max
      other
    else
      case max <=> other.max
      when 0
        include_max ? self : other
      when -1
        other
      when 1
        self
      end
    end

  VersionRange.new(
    min: min_range.min,
    include_min: min_range.include_min,
    max: max_range.max,
    include_max: max_range.include_max
  )
end

#strictly_higher?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

def strictly_higher?(other)
  other.strictly_lower?(self)
end

#strictly_lower?(other) ⇒ Boolean

Returns:

  • (Boolean) 


165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/pub_grub/version_range.rb', line 165

def strictly_lower?(other)
  return false if !max || !other.min

  case max <=> other.min
  when 0
    !include_max || !other.include_min
  when -1
    true
  when 1
    false
  end
end

#to_s ⇒ Object 



351
352
353
 
# File 'lib/pub_grub/version_range.rb', line 351

def to_s
  @name ||= constraints.join(", ")
end

#union(other) ⇒ Object 



292
293
294
295
296
297
298
299
300
 
# File 'lib/pub_grub/version_range.rb', line 292

def union(other)
  return other.union(self) if other.is_a?(VersionUnion)

  if contiguous_to?(other)
    span(other)
  else
    VersionUnion.union([self, other])
  end
end