Class: Dependabot::Hex::Requirement

Inherits:
Gem::Requirement
  • Object
show all
Defined in:
lib/dependabot/hex/requirement.rb

Constant Summary collapse

AND_SEPARATOR =
/\s+and\s+/.freeze
OR_SEPARATOR =
/\s+or\s+/.freeze
OPS =

Add the double-equality matcher to the list of allowed operations

OPS.merge("==" => ->(v, r) { v == r })
PATTERN_RAW =
"\\s*(#{quoted})?\\s*(#{Hex::Version::VERSION_PATTERN})\\s*"
PATTERN =
/\A#{PATTERN_RAW}\z/.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*requirements) ⇒ Requirement

Patches Gem::Requirement to make it accept requirement strings like “~> 4.2.5, >= 4.2.5.1” without first needing to split them.


31
32
33
34
35
36
37
# File 'lib/dependabot/hex/requirement.rb', line 31

def initialize(*requirements)
  requirements = requirements.flatten.flat_map do |req_string|
    req_string.split(",").map(&:strip)
  end

  super(requirements)
end

Class Method Details

.parse(obj) ⇒ Object

Override the parser to create Hex::Versions


40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/dependabot/hex/requirement.rb', line 40

def self.parse(obj)
  return ["=", Hex::Version.new(obj.to_s)] if obj.is_a?(Gem::Version)

  unless (matches = PATTERN.match(obj.to_s))
    msg = "Illformed requirement [#{obj.inspect}]"
    raise BadRequirementError, msg
  end

  return DefaultRequirement if matches[1] == ">=" && matches[2] == "0"

  [matches[1] || "=", Hex::Version.new(matches[2])]
end

.requirements_array(requirement_string) ⇒ Object

Returns an array of requirements. At least one requirement from the returned array must be satisfied for a version to be valid.


22
23
24
25
26
27
# File 'lib/dependabot/hex/requirement.rb', line 22

def self.requirements_array(requirement_string)
  requirement_string.strip.split(OR_SEPARATOR).map do |req_string|
    requirements = req_string.strip.split(AND_SEPARATOR)
    new(requirements)
  end
end

Instance Method Details

#satisfied_by?(version) ⇒ Boolean

Returns:

  • (Boolean)

53
54
55
56
57
# File 'lib/dependabot/hex/requirement.rb', line 53

def satisfied_by?(version)
  version = Hex::Version.new(version.to_s)

  requirements.all? { |op, rv| (OPS[op] || OPS["="]).call(version, rv) }
end