Class: Version Private

Inherits:
Object show all
Includes:
Comparable
Defined in:
version.rb,
version/parser.rb

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Direct Known Subclasses

MacOSVersion

Defined Under Namespace

Classes: AlphaToken, BetaToken, CompositeToken, NumericToken, Parser, PatchToken, PostToken, PreToken, RCToken, RegexParser, StemParser, StringToken, Token, UrlParser

Constant Summary collapse

NULL_TOKEN =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

Represents the absence of a token.

T.let(NullToken.new.freeze, NullToken)

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(val, detected_from_url: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • val (String, Version)
  • detected_from_url (Boolean) (defaults to: false)

Raises:

  • (ArgumentError) 


497
498
499
500
501
502
503
 
# File 'version.rb', line 497

def initialize(val, detected_from_url: false)
  version = val.to_str
  raise ArgumentError, "Version must not be empty" if version.blank?

  @version = T.let(version, String)
  @detected_from_url = detected_from_url
end

Class Method Details

.detect(url, **specs) ⇒ Version

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



344
345
346
 
# File 'version.rb', line 344

def self.detect(url, **specs)
  parse(specs.fetch(:tag, url), detected_from_url: true)
end

.formula_optionally_versioned_regex(name, full: true) ⇒ Regexp

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (Regexp) 


11
12
13
 
# File 'version.rb', line 11

def self.formula_optionally_versioned_regex(name, full: true)
  /#{"^" if full}#{Regexp.escape(name)}(@\d[\d.]*)?#{"$" if full}/
end

.parse(spec, detected_from_url: false) ⇒ Version

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • spec (String, Pathname)
  • detected_from_url (Boolean) (defaults to: false)

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'version.rb', line 349

def self.parse(spec, detected_from_url: false)
  # This type of full-URL decoding is not technically correct but we only need a rough decode for version parsing.
  spec = URI.decode_www_form_component(spec.to_s) if detected_from_url

  spec = Pathname(spec)

  VERSION_PARSERS.each do |parser|
    version = parser.parse(spec)
    return new(version, detected_from_url:) if version.present?
  end

  NULL
end

Instance Method Details

#commit ⇒ String?

Return the commit for a HEAD version.

Returns:



525
526
527
 
# File 'version.rb', line 525

def commit
  version&.match(HEAD_VERSION_REGEX)&.[](:commit)
end

#compare(comparator, other) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (Boolean) 


547
548
549
550
551
552
553
554
555
556
557
 
# File 'version.rb', line 547

def compare(comparator, other)
  case comparator
  when ">=" then self >= other
  when ">" then self > other
  when "<" then self < other
  when "<=" then self <= other
  when "==" then self == other
  when "!=" then self != other
  else raise ArgumentError, "Unknown comparator: #{comparator}"
  end
end

#detected_from_url? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


506
507
508
 
# File 'version.rb', line 506

def detected_from_url?
  @detected_from_url
end

#freeze ⇒ T.self_type

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (T.self_type) 


753
754
755
756
 
# File 'version.rb', line 753

def freeze
  tokens # Determine and store tokens before freezing
  super
end

#head? ⇒ Boolean

Check if this is a HEAD version.

Returns:

  • (Boolean) 


517
518
519
 
# File 'version.rb', line 517

def head?
  version&.match?(HEAD_VERSION_REGEX) || false
end

#major ⇒ Token?

The major version.

Returns:



652
653
654
655
656
 
# File 'version.rb', line 652

def major
  return NULL_TOKEN if null?

  tokens.first
end

#major_minor ⇒ T.self_type

The major and minor version.

Returns:

  • (T.self_type) 


682
683
684
685
686
687
 
# File 'version.rb', line 682

def major_minor
  return self if null?

  major_minor = T.must(tokens[0..1])
  major_minor.empty? ? NULL : self.class.new(major_minor.join("."))
end

#major_minor_patch ⇒ T.self_type

The major, minor and patch version.

Returns:

  • (T.self_type) 


693
694
695
696
697
698
 
# File 'version.rb', line 693

def major_minor_patch
  return self if null?

  major_minor_patch = T.must(tokens[0..2])
  major_minor_patch.empty? ? NULL : self.class.new(major_minor_patch.join("."))
end

#minor ⇒ Token?

The minor version.

Returns:



662
663
664
665
666
 
# File 'version.rb', line 662

def minor
  return NULL_TOKEN if null?

  tokens.second
end

#null? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


542
543
544
 
# File 'version.rb', line 542

def null?
  version.nil?
end

#patch ⇒ Token?

The patch version.

Returns:



672
673
674
675
676
 
# File 'version.rb', line 672

def patch
  return NULL_TOKEN if null?

  tokens.third
end

#respond_to?(method, include_all = false) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • method (Symbol, String)
  • include_all (Boolean) (defaults to: false)

Returns:

  • (Boolean) 


739
740
741
742
743
 
# File 'version.rb', line 739

def respond_to?(method, include_all = false)
  return !null? if ["to_str", :to_str].include?(method)

  super
end

#to_f ⇒ Float

Convert the version to a floating-point number.

Returns:

  • (Float) 


709
710
711
712
713
 
# File 'version.rb', line 709

def to_f
  return Float::NAN if null?

  version.to_f
end

#to_i ⇒ Integer

Convert the version to an integer.

Returns:

  • (Integer) 


719
720
721
 
# File 'version.rb', line 719

def to_i
  version.to_i
end

#to_json(*options) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • options (T.untyped)

Returns:



736
 
# File 'version.rb', line 736

def to_json(*options) = version.to_json(*options)

#to_str ⇒ String

Returns:

Raises:

  • (NoMethodError) 


725
726
727
728
729
 
# File 'version.rb', line 725

def to_str
  raise NoMethodError, "undefined method `to_str` for #{self.class}:NULL" if null?

  T.must(version).to_str
end

#update_commit(commit) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Update the commit for a HEAD version.

Parameters:

Raises:

  • (ArgumentError) 


531
532
533
534
535
536
537
538
539
 
# File 'version.rb', line 531

def update_commit(commit)
  raise ArgumentError, "Cannot update commit for non-HEAD version." unless head?

  @version = if commit
    "HEAD-#{commit}"
  else
    "HEAD"
  end
end