serialnumber 0.0.11 → 0.0.12

data/Rakefile

@@ -43,8 +43,8 @@ spec = Gem::Specification.new do |s|
   s.authors     = ["David Krentzlin"]
   s.email       = ["david.krentzlin@lisp-unleashed.de"]
   s.homepage    = ""
-  s.summary     = %q{Implementation of a rfc1982 serial}
-  s.description = %q{Serialarithmetic as described in rfc1982}
+  s.summary     = %q{Implementation of rfc1982}
+  s.description = %q{Arithmetic on serialnumbers as described in rfc1982}
 
   s.rubyforge_project = ""
 

data/VERSION

@@ -1 +1 @@
-0.0.11
+0.0.12

data/lib/serialnumber/rfc1982.rb

@@ -24,19 +24,18 @@ module Serial
 
   class OutOfBound < RuntimeError; end
   class Invalid < RuntimeError; end
-  
-  # For some serial-numbers a comparision is
-  # simply not defined. In this case an Exception of this
-  # kind will be raised
-  class ComparisonImpossible < RuntimeError; end
 
   # This class implements a serialnumber with it's operations as
   # described in rfc1982. This may for example be used to manage
-  # serials as present in SOA-Records
+  # the serial part of SOA-Records.
+  #
+  # It defines only two basic operation; addition and comparison.
+  # Note that due to wrap-arounds you might encounter interesting 
+  # results if you increment the serialnumber.
+  # As serialnumber may wrap the following expression may not always
+  # hold:
+  # sn > sn2  =>  (sn + 1) > sn2
   #
-  # It defines only one basic operation, that is adding a fixnum.
-  # It is does also define an order.
-  # 
   # == Examples
   #  sn  = Serial::RFC1982.new(100)
   #  sn2 = sn + 12
@@ -47,18 +46,16 @@ module Serial
     attr_reader :serial_bits,:value
     
     # Creates a serialnumber object from the fixnum given
-    # * the serial_bits define the domain of integers that can be
-    # represented with the fixnum.
     def initialize(number,serial_bits = 32)
-      raise OutOfBound,"The number of serial_bits must be >= 2" unless serial_bits >= 2
+      raise OutOfBound,"The number of serial_bits must be >= 1" unless serial_bits >= 1
+      ensure_valid_serial!(number,serial_bits)
       @serial_bits = serial_bits
-      ensure_valid!(number)
-      @value = number
+      @value       = number
     end
     
     # Add a fixnum value to the serialnumber.
-    # Note that the resulting value may be smaller than
-    # the initial value due to a wrap-around on the serial-bits boundary
+    # Not that this may actually wrap if it exceeds the serialnumber's
+    # boundary given by serial_bits
     def +(number)
       if summand_out_of_bound?(number)
         raise OutOfBound,"The summand #{number} is out of bound"
@@ -78,15 +75,14 @@ module Serial
     protected
     def <=>(other)
       unless other.respond_to?(:value)
-        raise Invalid,"Expected #{other} to respond_to :value"
+        raise Invalid,"Expected #{other} to respond to #value"
       end
       return 0  if equal?(value,other.value)
       return -1 if less?(value,other.value)
       return 1  if greater?(value,other.value)
-      raise ComparisonImpossible, "The comparison is undefined"
     end
         
-    def ensure_valid!(number)
+    def ensure_valid_serial!(number,serial_bits)
       raise Invalid,"Serial must be a fixnum" unless %w(Fixnum Bignum).include?(number.class.name)
       raise OutOfBound,"Negative numbers are not allowd" if number < 0
       if bits_needed_for(number) > serial_bits

data/serialnumber.gemspec

@@ -2,19 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{serialnumber}
-  s.version = "0.0.11"
+  s.version = "0.0.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Krentzlin"]
-  s.date = %q{2011-07-14}
-  s.description = %q{Serialarithmetic as described in rfc1982}
+  s.date = %q{2011-07-15}
+  s.description = %q{Arithmetic on serialnumbers as described in rfc1982}
   s.email = ["david.krentzlin@lisp-unleashed.de"]
   s.files = [".hgignore", ".hgtags", "Gemfile", "Gemfile.lock", "README", "Rakefile", "VERSION", "autotest/discover.rb", "lib/serialnumber.rb", "lib/serialnumber/rfc1982.rb", "serialnumber.gemspec", "spec/serial_spec.rb", "spec/spec_helper.rb"]
   s.homepage = %q{}
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{}
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Implementation of a rfc1982 serial}
+  s.summary = %q{Implementation of rfc1982}
   s.test_files = ["spec/serial_spec.rb", "spec/spec_helper.rb"]
 
   if s.respond_to? :specification_version then

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: serialnumber
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: false
   segments: 
   - 0
   - 0
-  - 11
-  version: 0.0.11
+  - 12
+  version: 0.0.12
 platform: ruby
 authors: 
 - David Krentzlin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-14 00:00:00 +02:00
+date: 2011-07-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,7 +88,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id005
-description: Serialarithmetic as described in rfc1982
+description: Arithmetic on serialnumbers as described in rfc1982
 email: 
 - david.krentzlin@lisp-unleashed.de
 executables: []
@@ -144,7 +144,7 @@ rubyforge_project: ""
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Implementation of a rfc1982 serial
+summary: Implementation of rfc1982
 test_files: 
 - spec/serial_spec.rb
 - spec/spec_helper.rb