File: version.rb

package info (click to toggle)
ruby-semantic-puppet 0.1.4-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 268 kB
  • ctags: 126
  • sloc: ruby: 2,102; makefile: 9
file content (195 lines) | stat: -rw-r--r-- 6,064 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
require 'semantic_puppet'

module SemanticPuppet

  # @note SemanticPuppet::Version subclasses Numeric so that it has sane Range
  #       semantics in Ruby 1.9+.
  class Version < Numeric
    include Comparable

    class ValidationFailure < ArgumentError; end

    class << self
      # Parse a Semantic Version string.
      #
      # @param ver [String] the version string to parse
      # @return [Version] a comparable {Version} object
      def parse(ver)
        match, major, minor, patch, prerelease, build = *ver.match(/\A#{REGEX_FULL}\Z/)

        if match.nil?
          raise _("Unable to parse '%{version}' as a semantic version identifier") % {version: ver}
        end

        prerelease = parse_prerelease(prerelease) if prerelease
        # Build metadata is not yet supported in semantic_puppet, but we hope to.
        # The following code prevents build metadata for now.
        #build = parse_build_metadata(build) if build
        if !build.nil?
          raise _("'%{version}' MUST NOT include build identifiers") % {version: ver}
        end

        self.new(major.to_i, minor.to_i, patch.to_i, prerelease, build)
      end

      # Validate a Semantic Version string.
      #
      # @param ver [String] the version string to validate
      # @return [bool] whether or not the string represents a valid Semantic Version
      def valid?(ver)
        !!(ver =~ /\A#{REGEX_FULL}\Z/)
      end

      private
      def parse_prerelease(prerelease)
        subject = 'Prerelease identifiers'
        prerelease = prerelease.split('.', -1)

        if prerelease.empty? or prerelease.any? { |x| x.empty? }
          raise _("%{subject} MUST NOT be empty") % {subject: subject}
        elsif prerelease.any? { |x| x =~ /[^0-9a-zA-Z-]/ }
          raise _("%{subject} MUST use only ASCII alphanumerics and hyphens") % {subject: subject}
        elsif prerelease.any? { |x| x =~ /^0\d+$/ }
          raise _("%{subject} MUST NOT contain leading zeroes") % {subject: subject}
        end

        return prerelease.map { |x| x =~ /^\d+$/ ? x.to_i : x }
      end

      def parse_build_metadata(build)
        subject = 'Build identifiers'
        build = build.split('.', -1)

        if build.empty? or build.any? { |x| x.empty? }
          raise _("%{subject} MUST NOT be empty") % {subject: subject}
        elsif build.any? { |x| x =~ /[^0-9a-zA-Z-]/ }
          raise _("%{subject} MUST use only ASCII alphanumerics and hyphens") % {subject: subject}
        end

        return build
      end

      def raise(msg)
        super ValidationFailure, msg, caller.drop_while { |x| x !~ /\bparse\b/ }
      end
    end

    attr_reader :major, :minor, :patch

    def initialize(major, minor, patch, prerelease = nil, build = nil)
      @major      = major
      @minor      = minor
      @patch      = patch
      @prerelease = prerelease
      @build      = build
    end

    def next(part)
      case part
      when :major
        self.class.new(@major.next, 0, 0)
      when :minor
        self.class.new(@major, @minor.next, 0)
      when :patch
        self.class.new(@major, @minor, @patch.next)
      end
    end

    def prerelease
      @prerelease && @prerelease.join('.')
    end

    # @return [Boolean] true if this is a stable release
    def stable?
      @prerelease.nil?
    end

    def build
      @build && @build.join('.')
    end

    def <=>(other)
      return self.major <=> other.major unless self.major == other.major
      return self.minor <=> other.minor unless self.minor == other.minor
      return self.patch <=> other.patch unless self.patch == other.patch
      return compare_prerelease(other)
    end

    def eql?(other)
      other.is_a?(Version) &&
        @major.eql?(other.major) &&
        @minor.eql?(other.minor) &&
        @patch.eql?(other.patch) &&
        @prerelease.eql?(other.instance_variable_get(:@prerelease)) &&
        @build.eql?(other.instance_variable_get(:@build))
    end
    alias == eql?

    def to_s
      "#{major}.#{minor}.#{patch}" +
      (@prerelease.nil? || prerelease.empty? ? '' : "-" + prerelease) +
      (@build.nil?      || build.empty?      ? '' : "+" + build     )
    end

    def hash
      self.to_s.hash
    end

    private
    # This is a hack; tildes sort later than any valid identifier. The
    # advantage is that we don't need to handle stable vs. prerelease
    # comparisons separately.
    @@STABLE_RELEASE = [ '~' ].freeze

    def compare_prerelease(other)
      all_mine  = @prerelease                               || @@STABLE_RELEASE
      all_yours = other.instance_variable_get(:@prerelease) || @@STABLE_RELEASE

      # Precedence is determined by comparing each dot separated identifier from
      # left to right...
      size = [ all_mine.size, all_yours.size ].max
      Array.new(size).zip(all_mine, all_yours) do |_, mine, yours|

        # ...until a difference is found.
        next if mine == yours

        # Numbers are compared numerically, strings are compared ASCIIbetically.
        if mine.class == yours.class
          return mine <=> yours

        # A larger set of pre-release fields has a higher precedence.
        elsif mine.nil?
          return -1
        elsif yours.nil?
          return 1

        # Numeric identifiers always have lower precedence than non-numeric.
        elsif mine.is_a? Numeric
          return -1
        elsif yours.is_a? Numeric
          return 1
        end
      end

      return 0
    end

    def first_prerelease
      self.class.new(@major, @minor, @patch, [])
    end

    public

    # Version string matching regexes
    REGEX_NUMERIC = "(0|[1-9]\\d*)[.](0|[1-9]\\d*)[.](0|[1-9]\\d*)" # Major . Minor . Patch
    REGEX_PRE     = "(?:[-](.*?))?"            # Prerelease
    REGEX_BUILD   = "(?:[+](.*?))?"            # Build
    REGEX_FULL    = REGEX_NUMERIC + REGEX_PRE + REGEX_BUILD

    # The lowest precedence Version possible
    MIN = self.new(0, 0, 0, []).freeze

    # The highest precedence Version possible
    MAX = self.new((1.0/0.0), 0, 0).freeze
  end
end