Class: Version

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Includes:
Comparable
Defined in:
Library/Homebrew/version.rb,
Library/Homebrew/version/null.rb,
Library/Homebrew/version/parser.rb

Overview

typed: true frozen_string_literal: true

Direct Known Subclasses

HeadVersion, OS::Mac::Version

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. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Represents the absence of a token.

NullToken.new.freeze
NULL =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Represents the absence of a version.

NullVersion.instance.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(val, detected_from_url: false) ⇒ Version

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Version.

Raises:

  • (TypeError)

504
505
506
507
508
509
# File 'Library/Homebrew/version.rb', line 504

def initialize(val, detected_from_url: false)
  raise TypeError, "Version value must be a string; got a #{val.class} (#{val})" unless val.respond_to?(:to_str)

  @version = val.to_str
  @detected_from_url = detected_from_url
end

Class Method Details

.create(val) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:

  • (TypeError)

351
352
353
354
355
356
357
358
359
# File 'Library/Homebrew/version.rb', line 351

def self.create(val)
  raise TypeError, "Version value must be a string; got a #{val.class} (#{val})" unless val.respond_to?(:to_str)

  if val.to_str.start_with?("HEAD")
    HeadVersion.new(val)
  else
    Version.new(val)
  end
end

.detect(url, **specs) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


346
347
348
# File 'Library/Homebrew/version.rb', line 346

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

.formula_optionally_versioned_regex(name, full: true) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


17
18
19
# File 'Library/Homebrew/version.rb', line 17

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) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


362
363
364
365
# File 'Library/Homebrew/version.rb', line 362

def self.parse(spec, detected_from_url: false)
  version = _parse(spec, detected_from_url: detected_from_url)
  version.nil? ? NULL : new(version, detected_from_url: detected_from_url)
end

Instance Method Details

#<=>(other) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'Library/Homebrew/version.rb', line 527

def <=>(other)
  # Needed to retain API compatibility with older string comparisons
  # for compiler versions, etc.
  other = Version.new(other) if other.is_a? String
  # Used by the *_build_version comparisons, which formerly returned Fixnum
  other = Version.new(other.to_s) if other.is_a? Integer
  return 1 if other.nil?
  return 1 if other.respond_to?(:null?) && other.null?

  other = Version.new(other.to_s) if other.is_a? Token
  return unless other.is_a?(Version)
  return 0 if version == other.version
  return 1 if head? && !other.head?
  return -1 if !head? && other.head?
  return 0 if head? && other.head?

  ltokens = tokens
  rtokens = other.tokens
  max = max(ltokens.length, rtokens.length)
  l = r = 0

  while l < max
    a = ltokens[l] || NULL_TOKEN
    b = rtokens[r] || NULL_TOKEN

    if a == b
      l += 1
      r += 1
      next
    elsif a.numeric? && !b.numeric?
      return 1 if a > NULL_TOKEN

      l += 1
    elsif !a.numeric? && b.numeric?
      return -1 if b > NULL_TOKEN

      r += 1
    else
      return a <=> b
    end
  end

  0
end

#detected_from_url?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

512
513
514
# File 'Library/Homebrew/version.rb', line 512

def detected_from_url?
  @detected_from_url
end

#empty?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

604
605
606
# File 'Library/Homebrew/version.rb', line 604

def empty?
  version.empty?
end

#hashObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


609
610
611
# File 'Library/Homebrew/version.rb', line 609

def hash
  version.hash
end

#head?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

517
518
519
# File 'Library/Homebrew/version.rb', line 517

def head?
  false
end

#majorObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


575
576
577
# File 'Library/Homebrew/version.rb', line 575

def major
  tokens.first
end

#major_minorObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


593
594
595
# File 'Library/Homebrew/version.rb', line 593

def major_minor
  self.class.new([major, minor].compact.join("."))
end

#major_minor_patchObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


599
600
601
# File 'Library/Homebrew/version.rb', line 599

def major_minor_patch
  self.class.new([major, minor, patch].compact.join("."))
end

#minorObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


581
582
583
# File 'Library/Homebrew/version.rb', line 581

def minor
  tokens.second
end

#null?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

522
523
524
# File 'Library/Homebrew/version.rb', line 522

def null?
  false
end

#patchObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


587
588
589
# File 'Library/Homebrew/version.rb', line 587

def patch
  tokens.third
end

#to_fObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


614
615
616
# File 'Library/Homebrew/version.rb', line 614

def to_f
  version.to_f
end

#to_iObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


619
620
621
# File 'Library/Homebrew/version.rb', line 619

def to_i
  version.to_i
end

#to_sObject Also known as: to_str

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


624
625
626
# File 'Library/Homebrew/version.rb', line 624

def to_s
  version.dup
end