versionomy 0.4.1 → 0.4.2

data/lib/versionomy/errors.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy exceptions
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,126 +35,126 @@
 
 
 module Versionomy
-  
-  
+
+
   # This is a namespace for errors that can be thrown by Versionomy.
-  
+
   module Errors
-    
-    
+
+
     # Base class for all Versionomy exceptions
-    
+
     class VersionomyError < ::RuntimeError
     end
-    
-    
+
+
     # This exception is raised if parsing failed.
-    
+
     class ParseError < VersionomyError
     end
-    
-    
+
+
     # This exception is raised if unparsing failed.
-    
+
     class UnparseError < VersionomyError
     end
-    
-    
+
+
     # This exception is raised if you try to set a value that is not
     # allowed by the schema.
-    
+
     class IllegalValueError < VersionomyError
     end
-    
-    
+
+
     # This exception is raised if you try to perform a comparison
     # between incompatible schemas.
-    
+
     class SchemaMismatchError < VersionomyError
     end
-    
-    
+
+
     # Base class for all Versionomy schema creation exceptions
-    
+
     class SchemaCreationError < VersionomyError
     end
-    
-    
+
+
     # This exception is raised during schema creation if you try to add
     # the same symbol twice to the same symbolic field.
-    
+
     class SymbolRedefinedError < SchemaCreationError
     end
-    
-    
+
+
     # This exception is raised during schema creation if you try to
     # create two fields covering overlapping ranges.
-    
+
     class RangeOverlapError < SchemaCreationError
     end
-    
-    
+
+
     # This exception is raised during schema creation if the range
     # specification cannot be interpreted.
-    
+
     class RangeSpecificationError < SchemaCreationError
     end
-    
-    
+
+
     # This exception is raised during schema creation if you try to
     # add a symbol to a non-symbolic schema.
-    
+
     class TypeMismatchError < SchemaCreationError
     end
-    
-    
+
+
     # This exception is raised during schema creation if you try to
     # create a circular graph.
-    
+
     class CircularDescendantError < SchemaCreationError
     end
-    
-    
+
+
     # Base class for all Versionomy format creation exceptions.
-    
+
     class FormatCreationError < VersionomyError
     end
-    
-    
+
+
     # This exception is raised if you try to register a format
     # with a name that has already been used.
-    
+
     class FormatRedefinedError < VersionomyError
     end
-    
-    
+
+
     # Raised by the Format registry if you try to retrieve a format with
     # an unrecognized name in strict mode.
-    
+
     class UnknownFormatError < VersionomyError
     end
-    
-    
+
+
     # Raised when a conversion fails.
-    
+
     class ConversionError < VersionomyError
     end
-    
-    
+
+
     # Raised when a conversion fails because no conversion implementation
     # was found.
-    
+
     class UnknownConversionError < ConversionError
     end
-    
-    
+
+
     # Raised when you try to register a conversion when one already
     # exists for its schemas.
-    
+
     class ConversionRedefinedError < VersionomyError
     end
-    
-    
+
+
   end
-  
+
 end

data/lib/versionomy/format.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy format namespace
-# 
+#
 # -----------------------------------------------------------------------------
 # 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
@@ -39,30 +39,30 @@ require 'monitor'
 
 
 module Versionomy
-  
-  
+
+
   # === Version number format.
-  # 
+  #
   # A format controls the parsing and unparsing of a version number.
   # Any time a version number is parsed from a string, a format is provided
   # to parse it. Similarly, every version number value references a format
   # that is used to unparse it back into a string.
-  # 
+  #
   # A format is always tied to a particular schema and knows how to parse
   # only that schema's version numbers.
-  # 
+  #
   # Under many circumstances, you should use the standard format, which
   # can be retrieved by calling Versionomy::Format#standard. This format
   # understands most common version numbers, including prerelease
   # (e.g. alpha, beta, release candidate, etc.) forms and patchlevels.
-  # 
+  #
   # You may also create your own formats, either by implementing the
   # format contract (see Versionomy::Format::Base), or by using the
   # Versionomy::Format::Delimiter tool, which can be used to construct
   # parsers for many version number formats.
-  # 
+  #
   # === Format registry
-  # 
+  #
   # Formats may be registered with Versionomy and given a name using the
   # methods of this module. This allows version numbers to be serialized
   # with their format. When a version number is serialized, its format
@@ -70,14 +70,14 @@ module Versionomy
   # representation. When the version number is reconstructed, its format
   # is looked up by name so versionomy can determine how to parse the
   # string.
-  # 
+  #
   # Format names are strings that may include letters, numerals, dashes,
   # underscores, and periods. By convention, periods are used as namespace
   # delimiters. Format names without a namespace (that is, with no periods)
   # are considered reserved for standard versionomy formats. If you define
   # your own format, you should use a name that includes a namespace (e.g.
   # "mycompany.LibraryVersion") to reduce the chance of name collisions.
-  # 
+  #
   # You may register formats directly using the register method, or set it
   # up to be autoloaded on demand. When a format is requested, if it has
   # not been registered explicitly, Versionomy looks for a format definition
@@ -91,27 +91,27 @@ module Versionomy
   # that defines the format and registers it using the correct name. See
   # the files in the "lib/versionomy/format_definitions/" directory for
   # examples.
-  
+
   module Format
-    
+
     @mutex = ::Mutex.new
     @load_mutex = ::Monitor.new
     @directories = [::File.expand_path(::File.dirname(__FILE__)+'/format_definitions')]
     @names_to_formats = {}
     @formats_to_names = {}
-    
+
     class << self
-      
-      
+
+
       # Add a directory to the format path.
-      # 
+      #
       # The format path is an array of directory paths. These directories
       # are searched for format definitions if a format name that has not
       # been registered is requested.
-      # 
+      #
       # If high_priority_ is set to true, the directory is added to the
       # front of the lookup path; otherwise it is added to the back.
-      
+
       def add_directory(path_, high_priority_=false)
         path_ = ::File.expand_path(path_)
         @mutex.synchronize do
@@ -124,18 +124,18 @@ module Versionomy
           end
         end
       end
-      
-      
+
+
       # Get the format with the given name.
-      # 
+      #
       # If the given name has not been defined, attempts to autoload it from
       # a format definition file. See the description of the Format module
       # for details on this procedure.
-      # 
+      #
       # If the given name still cannot be resolved, and strict is set to
       # true, raises Versionomy::Errors::UnknownFormatError. If strict is
       # set to false, returns nil if the given name cannot be resolved.
-      
+
       def get(name_, strict_=false)
         name_ = _check_name(name_)
         format_ = @mutex.synchronize{ @names_to_formats[name_] }
@@ -156,25 +156,25 @@ module Versionomy
         end
         format_
       end
-      
-      
+
+
       # Determines whether a format with the given name has been registered
       # explicitly. Does not attempt to autoload the format.
-      
+
       def registered?(name_)
         name_ = _check_name(name_)
         @mutex.synchronize{ @names_to_formats.include?(name_) }
       end
-      
-      
+
+
       # Register the given format under the given name.
-      # 
+      #
       # Valid names may contain only letters, digits, underscores, dashes,
       # and periods.
-      # 
+      #
       # Raises Versionomy::Errors::FormatRedefinedError if the name has
       # already been defined.
-      
+
       def register(name_, format_, silent_=false)
         name_ = _check_name(name_)
         @mutex.synchronize do
@@ -188,15 +188,15 @@ module Versionomy
           end
         end
       end
-      
-      
+
+
       # Get the canonical name for the given format, as a string.
       # This is the first name the format was registered under.
-      # 
+      #
       # If the given format was never registered, and strict is set to true,
       # raises Versionomy::Errors::UnknownFormatError. If strict is set to
       # false, returns nil if the given format was never registered.
-      
+
       def canonical_name_for(format_, strict_=false)
         name_ = @mutex.synchronize{ @formats_to_names[format_.object_id] }
         if name_.nil? && strict_
@@ -204,10 +204,10 @@ module Versionomy
         end
         name_
       end
-      
-      
+
+
       private
-      
+
       def _check_name(name_)  # :nodoc:
         name_ = name_.to_s
         unless name_ =~ /\A[\w.-]+\z/
@@ -215,17 +215,17 @@ module Versionomy
         end
         name_
       end
-      
-      
+
+
     end
-    
+
   end
-  
-  
+
+
   # Versionomy::Formats is an alias for Versionomy::Format, for backward
   # compatibility with version 0.1.0 code. It is deprecated; use
   # Versionomy::Format instead.
   Formats = Format
-  
-  
+
+
 end

data/lib/versionomy/format/base.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Versionomy format base class
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,74 +35,74 @@
 
 
 module Versionomy
-  
-  
+
+
   module Format
-    
-    
+
+
     # The base format.
-    # 
+    #
     # This format doesn't actually do anything useful. It causes all strings
     # to parse to the schema's default value, and unparses all values to the
     # empty string. Instead, the purpose here is to define the API for a
     # format.
-    # 
+    #
     # All formats must define the methods +schema+, +parse+, and +unparse+.
     # It is also recommended that formats define the <tt>===</tt> method,
     # though this is not strictly required. Finally, formats may optionally
     # implement <tt>uparse_for_serialize</tt>.
-    # 
+    #
     # Formats need not extend this base class, as long as they duck-type
     # these methods.
-    
+
     class Base
-      
-      
+
+
       # Create an instance of this base format, with the given schema.
-      
+
       def initialize(schema_)
         @_schema = schema_
       end
-      
-      
+
+
       def inspect   # :nodoc:
         "#<#{self.class}:0x#{object_id.to_s(16)} schema=#{@_schema.inspect}>"
       end
-      
+
       def to_s   # :nodoc:
         inspect
       end
-      
-      
+
+
       # Returns the schema understood by this format.
-      
+
       def schema
         @_schema
       end
-      
-      
+
+
       # Parse the given string and return a value.
-      # 
+      #
       # The optional parameter hash can be used to pass parameters to the
       # parser to affect its behavior. The exact parameters supported are
       # defined by the format.
-      
+
       def parse(string_, params_=nil)
         Value.new([], self)
       end
-      
-      
+
+
       # Unparse the given value and return a string.
-      # 
+      #
       # The optional parameter hash can be used to pass parameters to the
       # unparser to affect its behavior. The exact parameters supported
       # are defined by the format.
-      
+
       def unparse(value_, params_=nil)
         ''
       end
-      
-      
+
+
       # An optional method that does unparsing especially for serialization.
       # Implement this if normal unparsing is "lossy" and doesn't guarantee
       # reconstruction of the version number. This method should attempt to
@@ -110,7 +110,7 @@ module Versionomy
       # reconstructed from the unparsed string. Serialization routines will
       # first attempt to call this method to unparse for serialization. If
       # this method is not present, the normal unparse method will be used.
-      # 
+      #
       # Return either the unparsed string, or an array consisting of the
       # unparsed string and a hash of parse params to pass to the parser
       # when the string is to be reconstructed. You may also either return
@@ -118,17 +118,17 @@ module Versionomy
       # cannot be done satisfactorily for serialization. In this case,
       # serialization will be done using the raw value data rather than an
       # unparsed string.
-      # 
+      #
       # This default implementation just turns around and calls unparse.
       # Thus it is equivalent to the method not being present at all.
-      
+
       def unparse_for_serialization(value_)
         unparse(value_)
       end
-      
-      
+
+
       # Determine whether the given value uses this format.
-      
+
       def ===(obj_)
         if obj_.kind_of?(Value)
           obj_.format == self
@@ -136,11 +136,11 @@ module Versionomy
           obj_ == self
         end
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end