versionomy 0.4.1 → 0.4.2

data/lib/versionomy/format_definitions/standard.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy standard format implementation
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2008-2009 Daniel Azuma
-# 
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,27 +35,27 @@
 
 
 module Versionomy
-  
+
   module Format
-    
-    
+
+
     # Get the standard format.
     # This is identical to calling <tt>get('standard')</tt>.
-    # 
+    #
     # The standard format is designed to handle most commonly-used version
     # number forms, and allow parsing and comparison between them.
-    # 
+    #
     # The standard schema is the heart of this format, providing a
     # common structure for most version numbers.
-    # 
+    #
     # It begins with four numeric fields:
     # "<tt>major.minor.tiny.tiny2</tt>".
-    # 
+    #
     # The next field, <tt>:release_type</tt>, defines the remaining
     # structure. The release type can be one of these symbolic values:
     # <tt>:development</tt>, <tt>:alpha</tt>, <tt>:beta</tt>,
     # <tt>:preview</tt>, <tt>:release_candidate</tt>, <tt>:release</tt>.
-    # 
+    #
     # Depending on that value, additional fields become available. For
     # example, the <tt>:alpha</tt> value enables the fields
     # <tt>:alpha_version</tt> and <tt>:alpha_minor</tt>, which represent
@@ -65,11 +65,11 @@ module Versionomy
     # <tt>:beta_version</tt> and <tt>:beta_minor</tt>. A release_type
     # of <tt>:release</tt> enables <tt>:patchlevel</tt> and
     # <tt>:patchlevel_minor</tt>, to support versions like "1.8.7p72".
-    # 
+    #
     # The format itself is a delimiter-based format that understands a
     # wide variety of string representations of this version schema.
     # Examples of supported syntax include:
-    # 
+    #
     #  2.0
     #  2.0.42.10
     #  2.0b2
@@ -79,11 +79,11 @@ module Versionomy
     #  2.0 Alpha 1
     #  2.0a5.3
     #  2.1.42.10-4.3
-    # 
+    #
     # Because the standard format is based on Versionomy::Format::Delimiter,
     # a number of parameters are available for parsing and unparsing. See
     # the documentation for the delimiter class for more information.
-    # 
+    #
     # Two of the fields have styles that can be set when unparsing.
     # The <tt>:release_type</tt> field can be unparsed as either
     # <tt>:long</tt> style (e.g. "1.0alpha2") or <tt>:short</tt> style
@@ -91,57 +91,57 @@ module Versionomy
     # <tt>:number</tt> style (e.g. "2.1-1") or <tt>:letter</tt> style
     # (e.g. "2.1a"). Most fields can have their delimiter specified during
     # unparsing as well.
-    # 
+    #
     # For the exact annotated definition of the standard schema and format,
     # see the source code for Versionomy::Format::Standard#create.
-    
+
     def self.standard
       get('standard')
     end
-    
-    
+
+
     # This is a namespace for the implementation of the Standard schema
     # and format.
-    
+
     module Standard
-      
-      
+
+
       # Extra methods added to version values that use the standard schema.
-      
+
       module ExtraMethods
-        
-        
+
+
         # Returns true if the version is a prerelease version
-        
+
         def prerelease?
           self.release_type != :final
         end
-        
-        
+
+
         # Returns the release for this version.
         # For example, converts "1.2.0a1" to "1.2.0".
         # Non-prerelease versions return themselves.
-        
+
         def release
           self.change(:release_type => :final)
         end
-        
-        
+
+
       end
-      
-      
+
+
       # 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.
-      
+
       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".
@@ -150,46 +150,46 @@ module Versionomy
             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.
@@ -197,21 +197,21 @@ module Versionomy
                           :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.
@@ -219,14 +219,14 @@ module Versionomy
                           :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
@@ -237,22 +237,22 @@ module Versionomy
               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_ = 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
@@ -267,7 +267,7 @@ module Versionomy
           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
@@ -293,7 +293,7 @@ module Versionomy
             # 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')
@@ -318,7 +318,7 @@ module Versionomy
               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.
@@ -363,7 +363,7 @@ module Versionomy
           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.
@@ -378,21 +378,21 @@ module Versionomy
           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
-      
-      
+
+
     end
-    
-    
+
+
     register('standard', Format::Standard.create, true)
-    
-    
+
+
   end
-  
+
 end

data/lib/versionomy/interface.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy convenience interface
-# 
+#
 # -----------------------------------------------------------------------------
 # Copyright 2008-2009 Daniel Azuma
-# 
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,61 +35,61 @@
 
 
 # == Versionomy
-# 
+#
 # The Versionomy module contains some convenience methods for creating and
 # parsing version numbers.
 
 module Versionomy
-  
+
   @default_format = nil
-  
-  
+
+
   class << self
-    
-    
+
+
     # Gets the current default format. Usually this is the "standard"
     # format returned by Versionomy::Format.standard.
-    
+
     def default_format
       @default_format ||= Format.standard
     end
-    
-    
+
+
     # Sets the default format used by other methods of this convenience
     # interface. Usually, this is set to the "standard" format returned by
     # Versionomy::Format.standard and should not be changed.
-    # 
+    #
     # The format can be specified as a format object or the name of a format
     # registered with Versionomy::Format. If the format is set to nil, the
     # default_format will be reset to the "standard" format.
-    # 
+    #
     # Raises Versionomy::Errors::UnknownFormatError if a name is given that
     # is not registered.
-    
+
     def default_format=(format_)
       if format_.kind_of?(::String) || format_.kind_of?(::Symbol)
         format_ = Format.get(format_, true)
       end
       @default_format = format_
     end
-    
-    
+
+
     # Create a new version number given a hash or array of values, and an
     # optional format.
-    # 
+    #
     # The values should either be a hash of field names and values, or an
     # array of values that will be interpreted in field order.
-    # 
+    #
     # The format can be specified as a format object or the name of a format
     # registered with Versionomy::Format. If the format is omitted or set
     # to nil, the default_format will be used.
-    # 
+    #
     # You can also optionally provide default parameters to be used when
     # unparsing this value or any derived from it.
-    # 
+    #
     # Raises Versionomy::Errors::UnknownFormatError if a name is given that
     # is not registered.
-    
+
     def create(values_=nil, format_=nil, unparse_params_=nil)
       if format_.kind_of?(::Hash) && unparse_params_.nil?
         unparse_params_ = format_
@@ -101,23 +101,23 @@ module Versionomy
       format_ ||= default_format
       Value.new(values_ || [], format_, unparse_params_)
     end
-    
-    
+
+
     # Create a new version number given a string to parse, and an optional
     # format.
-    # 
+    #
     # The format can be specified as a format object or the name of a format
     # registered with Versionomy::Format. If the format is omitted or set
     # to nil, the default_format will be used.
-    # 
+    #
     # The parameter hash, if present, will be passed as parsing parameters
     # to the format.
-    # 
+    #
     # Raises Versionomy::Errors::UnknownFormatError if a name is given that
     # is not registered.
-    # 
+    #
     # May raise Versionomy::Errors::ParseError if parsing failed.
-    
+
     def parse(str_, format_=nil, parse_params_=nil)
       if format_.kind_of?(::Hash) && parse_params_.nil?
         parse_params_ = format_
@@ -129,11 +129,11 @@ module Versionomy
       format_ ||= default_format
       format_.parse(str_, parse_params_)
     end
-    
-    
+
+
     # Convenience method for creating a version number using the Semantic
     # Versioning format (see http://semver.org/).
-    # 
+    #
     # You may pass a string to parse, or a hash with the following keys, all
     # of which are optional:
     # <tt>:major</tt>::
@@ -144,9 +144,9 @@ module Versionomy
     #   Patch version number
     # <tt>:prerelease_suffix</tt>::
     #   A prerelease suffix (e.g. "b2")
-    # 
+    #
     # May raise Versionomy::Errors::ParseError if parsing failed.
-    
+
     def semver(input_)
       if input_.kind_of?(::Hash)
         create(input_, :semver)
@@ -154,15 +154,15 @@ module Versionomy
         parse(input_.to_s, :semver)
       end
     end
-    
-    
+
+
     # Get the version of the given module as a Versionomy::Value.
     # Tries a number of common approaches to embedding version numbers into
     # modules, such as string or array constants, submodules containing
     # constants, or module method calls.
     # Returns the version number, or nil if it wasn't found or couldn't
     # be interpreted.
-    
+
     def version_of(mod_)
       version_ = nil
       [:VERSION, :VERSION_STRING, :GemVersion].each do |sym_|
@@ -197,11 +197,11 @@ module Versionomy
       end
       version_
     end
-    
-    
+
+
     # Get the ruby version as a Versionomy::Value, using the builtin
     # constants RUBY_VERSION and RUBY_PATCHLEVEL.
-    
+
     def ruby_version
       @ruby_version ||= begin
         version_ = parse(::RUBY_VERSION, :standard)
@@ -212,8 +212,8 @@ module Versionomy
         version_
       end
     end
-    
-    
+
+
   end
-  
+
 end