Module: Versionomy::Format::Standard

Defined in:
lib/versionomy/format_definitions/standard.rb

Overview

This is a namespace for the implementation of the Standard schema and format.

Defined Under Namespace

Modules: ExtraMethods

Class Method Summary collapse

Class Method Details

.createObject

Create the standard format. This method is called internally when Versionomy loads the standard format, and you should not need to call it again. It is documented so that you can inspect its source code from RDoc, since the source contains useful examples of how to use the schema and format definition DSLs.



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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# File 'lib/versionomy/format_definitions/standard.rb', line 140

def self.create

  # The following is the definition of the standard schema
  schema_ = Schema.create do

    # The major field has the default value of 1. Most other fields
    # have a default value of 0. Thus, the default version number
    # overall is "1.0".
    # We first create the core version fields "major.minor.tiny.tiny2".
    field(:major, :default_value => 1) do
      field(:minor) do
        field(:tiny) do
          field(:tiny2) do

            # The next field is a symbolic field that specifies the
            # release type: e.g. beta, release candidate, release, etc.
            field(:release_type, :type => :symbol) do

              # Development releases are typically expressed like
              # "1.0d3" and are intended for unstable development
              # progress. Bumping the release type will change it to
              # alpha.
              symbol(:development, :bump => :alpha)

              # Alpha releases are typically expressed like "1.0a2" and
              # are intended for internal testing.
              # Bumping the release type advances to beta.
              symbol(:alpha, :bump => :beta)

              # Beta releases are typically expressed like "1.0b2" and
              # are intended for external or public testing.
              # Bumping the release type advances to release candidate.
              symbol(:beta, :bump => :release_candidate)

              # Release candidate releases are typically expressed like
              # "1.0rc2" and are intended for final public testing
              # prior to release.
              # Bumping the release type advances to final release.
              symbol(:release_candidate, :bump => :final)

              # Preview releases represent an alternative release type
              # progression, and are typically used for public testing
              # similar to beta or release candidate.
              # Bumping the release type advances to final release.
              symbol(:preview, :bump => :final)

              # This type represents a final release. This is the
              # default value for the release_type field if no value is
              # explicitly provided.
              # Bumping the release type has no effect.
              symbol(:final, :bump => :final)
              default_value(:final)

              # If the release type is development, these fields are
              # made available to indicate which development release
              # is being represented.
              field(:development_version, :only => :development,
                    :default_value => 1) do
                field(:development_minor)
              end

              # If the release type is alpha, these fields are made
              # available to indicate which alpha release is being
              # represented.
              field(:alpha_version, :only => :alpha, :default_value => 1) do
                field(:alpha_minor)
              end

              # If the release type is beta, these fields are made
              # available to indicate which beta release is being
              # represented.
              field(:beta_version, :only => :beta, :default_value => 1) do
                field(:beta_minor)
              end

              # If the release type is release candidate, these fields
              # are made available to indicate which release candidate
              # is being represented.
              field(:release_candidate_version, :only => :release_candidate,
                    :default_value => 1) do
                field(:release_candidate_minor)
              end

              # If the release type is preview, these fields are made
              # available to indicate which preview release is being
              # represented.
              field(:preview_version, :only => :preview, :default_value => 1) do
                field(:preview_minor)
              end

              # If the release type is final, these fields are made
              # available to indicate an optional patchlevel.
              field(:patchlevel, :only => :final) do
                field(:patchlevel_minor)
              end
            end
          end
        end
      end
    end

    # Add the methods in this module to each value
    add_module(Format::Standard::ExtraMethods)
  end

  # The following is the definition of the standard format. It
  # understands the standard schema defined above.
  Format::Delimiter.new(schema_) do

    # All version number strings must start with the major version.
    # Unlike other fields, it is not preceded by the usual "dot"
    # delimiter, but it can be preceded by a "v" indicator.
    field(:major) do
      recognize_number(:delimiter_regexp => '(v\s?)?', :default_delimiter => '')
    end

    # The remainder of the core version number are represented as
    # integers delimited by periods by default. Each is also dependent
    # on the presence of the previous field, so :requires_previous_field
    # retains its default value of true. Finally, they can be optional
    # in an unparsed string if they are set to the default value of 0.
    field(:minor) do
      recognize_number(:default_value_optional => true)
    end
    field(:tiny) do
      recognize_number(:default_value_optional => true)
    end
    field(:tiny2) do
      recognize_number(:default_value_optional => true)
    end

    # The release type field is the most complex field because of the
    # variety of syntaxes we support. The basic strategy is to map
    # a few specific sets of characters as signaling particular release
    # types. For example, the "a" in "1.0a5" signals an alpha release.
    # If no such release type marker is found, it defaults to the final
    # release type.
    # We set up two styles, a short style and a long style. Short style
    # syntax looks like "1.0a5". Long syntax looks more like
    # "1.0 Alpha 5". The parsed value retains knowledge of which style
    # it came from so it can be reconstructed when the value is unparsed.
    # Note that we turn requires_previous_field off because the release
    # type syntax markers don't require any particular set of the core
    # version number fields to be present. "1.0a5" and "1.0.0.0a5" are
    # both valid version numbers.
    field(:release_type, :requires_previous_field => false,
          :default_style => :short) do
      # Some markers require a prerelease version (e.g. the 5 in
      # "1.0a5") while others don't (e.g. "1.9.2dev"). This is because
      # the syntax "1.0a" looks like a patchlevel syntax. So some of
      # the following recognizers set requires_next_field while others
      # do not.
      # Also note that we omit the value <tt>:final</tt>. This is
      # because that value is signaled by the absence of any syntax in
      # the version string, including the absence of any delimiters.
      # So we just allow it to fall through to the default.

      recognize_regexp_map(:style => :long, :default_delimiter => '',
                           :delimiter_regexp => '-|_|\.|\s?') do
        map(:development, 'dev')
        map(:alpha, 'alpha')
        map(:beta, 'beta')
        map(:preview, 'preview')
      end
      recognize_regexp_map(:style => :short, :default_delimiter => '',
                           :delimiter_regexp => '-|_|\.|\s?') do
        map(:release_candidate, 'rc')
        map(:preview, 'pre')
      end
      recognize_regexp_map(:style => :long, :default_delimiter => '',
                           :delimiter_regexp => '-|_|\.|\s?') do
        map(:release_candidate, 'rc')
      end
      recognize_regexp_map(:style => :short, :default_delimiter => '',
                           :delimiter_regexp => '-|_|\.|\s?',
                           :requires_next_field => true) do
        map(:development, 'd')
        map(:alpha, 'a')
        map(:beta, 'b')
      end
    end

    # The main prerelease version may sometimes be optional, so we
    # mark it as optional here. If it is required, that will be
    # signalled by requires_next_field on the release_type field.
    # Minor prerelease versions are always optional.
    # Note that we override the default_value (normally 1) and set
    # it to 0 if a main prerelease version is not present. This is
    # so schema-oriented operations like bumping will set the value
    # to 1, while parsing a string will yield 0 when the field is
    # missing (e.g. we want "1.9.2dev" to mean "1.9.2dev0".)
    field(:development_version, :default_value => 0) do
      recognize_number(:delimiter_regexp => '-|_|\.|\s?', :default_delimiter => '',
                       :default_value_optional => true)
    end
    field(:development_minor) do
      recognize_number(:default_value_optional => true)
    end
    field(:alpha_version, :default_value => 0) do
      recognize_number(:delimiter_regexp => '-|_|\.|\s?', :default_delimiter => '',
                       :default_value_optional => true)
    end
    field(:alpha_minor) do
      recognize_number(:default_value_optional => true)
    end
    field(:beta_version, :default_value => 0) do
      recognize_number(:delimiter_regexp => '-|_|\.|\s?', :default_delimiter => '',
                       :default_value_optional => true)
    end
    field(:beta_minor) do
      recognize_number(:default_value_optional => true)
    end
    field(:release_candidate_version, :default_value => 0) do
      recognize_number(:delimiter_regexp => '-|_|\.|\s?', :default_delimiter => '',
                       :default_value_optional => true)
    end
    field(:release_candidate_minor) do
      recognize_number(:default_value_optional => true)
    end
    field(:preview_version, :default_value => 0) do
      recognize_number(:delimiter_regexp => '-|_|\.|\s?', :default_delimiter => '',
                       :default_value_optional => true)
    end
    field(:preview_minor) do
      recognize_number(:default_value_optional => true)
    end

    # The patchlevel field does not require the previous field (which is
    # release_type). Here we also set up two styles: a numeric style and
    # a letter style. So "1.0a" and "1.0-1" are equivalent.
    field(:patchlevel, :requires_previous_field => false,
          :default_value_optional => true, :default_style => :number) do
      recognize_number(:style => :number, :default_delimiter => '-',
                       :delimiter_regexp => '(-|_|\.|\s?)(p|u)|-|_')
      recognize_letter(:style => :letter, :default_delimiter => '',
                       :delimiter_regexp => '-|_|\.|\s?',
                       :expected_follower_regexp => '\z')
    end
    field(:patchlevel_minor) do
      recognize_number(:default_value_optional => true)
    end

    # By default, we require that at least the major and minor fields
    # appear in an unparsed version string.
    default_unparse_params(:required_fields => [:minor, :development_version, :alpha_version,
      :beta_version, :release_candidate_version, :preview_version])
  end
end