Class: PubGrub::VersionConstraint

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(package, range: nil) ⇒ VersionConstraint

Returns a new instance of VersionConstraint.

Parameters:



9
10
11
12
 
# File 'lib/pub_grub/version_constraint.rb', line 9

def initialize(package, range: nil)
  @package = package
  @range = range
end

Instance Attribute Details

#package ⇒ Object (readonly)

Returns the value of attribute package.



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

def package
  @package
end

#range ⇒ Object (readonly)

Returns the value of attribute range.



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

def range
  @range
end

Class Method Details

.any(package) ⇒ Object 



29
30
31
 
# File 'lib/pub_grub/version_constraint.rb', line 29

def any(package)
  new(package, range: VersionRange.any)
end

.empty(package) ⇒ Object 



33
34
35
 
# File 'lib/pub_grub/version_constraint.rb', line 33

def empty(package)
  new(package, range: VersionRange.empty)
end

.exact(package, version) ⇒ Object 



24
25
26
27
 
# File 'lib/pub_grub/version_constraint.rb', line 24

def exact(package, version)
  range = VersionRange.new(min: version, max: version, include_min: true, include_max: true)
  new(package, range: range)
end

Instance Method Details

#allows_all?(other) ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/pub_grub/version_constraint.rb', line 63

def allows_all?(other)
  range.allows_all?(other.range)
end

#allows_any?(other) ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/pub_grub/version_constraint.rb', line 67

def allows_any?(other)
  range.intersects?(other.range)
end

#any? ⇒ Boolean

Does this match every version of the package

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/pub_grub/version_constraint.rb', line 116

def any?
  range.any?
end

#constraint_string ⇒ Object 



103
104
105
106
107
108
109
 
# File 'lib/pub_grub/version_constraint.rb', line 103

def constraint_string
  if any?
    ">= 0"
  else
    range.to_s
  end
end

#difference(other) ⇒ Object 



59
60
61
 
# File 'lib/pub_grub/version_constraint.rb', line 59

def difference(other)
  intersect(other.invert)
end

#disjoint?(other) ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/pub_grub/version_constraint.rb', line 79

def disjoint?(other)
  !overlap?(other)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/pub_grub/version_constraint.rb', line 111

def empty?
  range.empty?
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
21
 
# File 'lib/pub_grub/version_constraint.rb', line 18

def eql?(other)
  package.eql?(other.package) &&
    range.eql?(other.range)
end

#hash ⇒ Object 



14
15
16
 
# File 'lib/pub_grub/version_constraint.rb', line 14

def hash
  package.hash ^ range.hash
end

#inspect ⇒ Object 



120
121
122
 
# File 'lib/pub_grub/version_constraint.rb', line 120

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

#intersect(other) ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/pub_grub/version_constraint.rb', line 38

def intersect(other)
  unless package == other.package
    raise ArgumentError, "Can only intersect between VersionConstraint of the same package"
  end

  self.class.new(package, range: range.intersect(other.range))
end

#invert ⇒ Object 



54
55
56
57
 
# File 'lib/pub_grub/version_constraint.rb', line 54

def invert
  new_range = range.invert
  self.class.new(package, range: new_range)
end

#overlap?(other) ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/pub_grub/version_constraint.rb', line 75

def overlap?(other)
  other.allows_any?(self)
end

#relation(other) ⇒ Object 



83
84
85
86
87
88
89
90
91
 
# File 'lib/pub_grub/version_constraint.rb', line 83

def relation(other)
  if subset?(other)
    :subset
  elsif overlap?(other)
    :overlap
  else
    :disjoint
  end
end

#subset?(other) ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/pub_grub/version_constraint.rb', line 71

def subset?(other)
  other.allows_all?(self)
end

#to_s(allow_every: false) ⇒ Object 



93
94
95
96
97
98
99
100
101
 
# File 'lib/pub_grub/version_constraint.rb', line 93

def to_s(allow_every: false)
  if package == Package.root
    "root"
  elsif allow_every && any?
    "every version of #{package}"
  else
    "#{package} #{constraint_string}"
  end
end

#union(other) ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/pub_grub/version_constraint.rb', line 46

def union(other)
  unless package == other.package
    raise ArgumentError, "Can only intersect between VersionConstraint of the same package"
  end

  self.class.new(package, range: range.union(other.range))
end