serialnumber 0.0.9 → 0.0.10

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/lib/serialnumber.rb

@@ -1,4 +1,5 @@
-# Author: David Krentzlin <david.krentzlin@lisp-unleashed.de>
+# Author:: David Krentzlin <david.krentzlin@lisp-unleashed.de>
+# Copyright:: Copyright (c) 2011 David Krentzlin
 #
 # Permission is hereby granted, free of charge, to any person obtaining a
 # copy of this software and associated documentation files (the "Software"),

data/lib/serialnumber/rfc1982.rb

@@ -1,4 +1,5 @@
-# Author: David Krentzlin <david.krentzlin@lisp-unleashed.de>
+# Author:: David Krentzlin <david.krentzlin@lisp-unleashed.de>
+# Copyright:: Copyright (c) 2011 David Krentzlin
 #
 # Permission is hereby granted, free of charge, to any person obtaining a
 # copy of this software and associated documentation files (the "Software"),
@@ -19,15 +20,35 @@
 # OTHER DEALINGS IN THE SOFTWARE.
 
 
-
 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
+  #
+  # 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
+  #  sn2 > sn
+  #
   class RFC1982
     include Comparable
     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
       @serial_bits = serial_bits
@@ -35,14 +56,9 @@ module Serial
       @value = number
     end
     
-    def ensure_valid!(number)
-      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
-        raise OutOfBound,"Given number #{number} can not be represented with #{serial_bits} serial_bits"
-      end
-    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
     def +(number)
       if summand_out_of_bound?(number)
         raise OutOfBound,"The summand #{number} is out of bound"
@@ -51,6 +67,15 @@ module Serial
       Serial::RFC1982.new(sum,serial_bits)
     end
     
+    def to_s
+      value.to_s
+    end
+    
+    def to_i
+      value.to_i
+    end
+    
+    protected
     def <=>(other)
       unless other.respond_to?(:value)
         raise Invalid,"Expected #{other} to respond_to :value"
@@ -58,9 +83,17 @@ module Serial
       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)
+      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
+        raise OutOfBound,"Given number #{number} can not be represented with #{serial_bits} serial_bits"
+      end
     end
     
-    protected
     def boundary
       @boundary ||= (2 ** (serial_bits - 1))
     end

data/serialnumber.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{serialnumber}
-  s.version = "0.0.9"
+  s.version = "0.0.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Krentzlin"]
-  s.date = %q{2011-07-13}
+  s.date = %q{2011-07-14}
   s.description = %q{Serialarithmetic 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"]

data/spec/serial_spec.rb

@@ -1,4 +1,5 @@
-# Author: David Krentzlin <david.krentzlin@lisp-unleashed.de>
+# Author:: David Krentzlin <david.krentzlin@lisp-unleashed.de>
+# Copyright:: Copyright (c) 2011 David Krentzlin
 #
 # Permission is hereby granted, free of charge, to any person obtaining a
 # copy of this software and associated documentation files (the "Software"),
@@ -19,7 +20,7 @@
 # OTHER DEALINGS IN THE SOFTWARE.
 
 
-require 'serial/rfc1982'
+require 'serialnumber/rfc1982'
 
 describe Serial::RFC1982 do
   
@@ -90,5 +91,15 @@ describe Serial::RFC1982 do
         s101.should > s100
       end
     end
+    
+    it "allows the value to be retrieved as a string" do
+      Serial::RFC1982.new(100).to_s.should eq("100")
+    end
+    
+    it "allows the value to be retrieved as a integer" do
+      Serial::RFC1982.new(100).to_i.should eq(100)
+    end
+    
+    
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: serialnumber
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - David Krentzlin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-13 00:00:00 +02:00
+date: 2011-07-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency