steenzout-sqnc 1.0.6 → 1.0.8

data/lib/sqnc/file/manager.rb

@@ -4,7 +4,15 @@ module Steenzout
 
     private
 
-      def self.increment_and_store name
+      # Increments the counter and stores it into a file.
+      # If the current counter is not already in memory,
+      # it will read the initial value from the sequence file.
+      # If the sequence file is empty, it will set the counter
+      # to the configured offset and increment it.
+      #
+      # @param name: the name of the sequence.
+      #
+      def self.increment_and_store(name)
 
         open(@config[:sequences][name][:location], File::RDWR|File::CREAT, 0644) do |f|
 
@@ -12,18 +20,28 @@ module Steenzout
 
             f.flock(File::LOCK_EX)
 
+            # read counter from memory or disk
             value = @sequences[name] # get value from memory
             value = f.readline().to_i if @sequences[name].nil? rescue EOFError # get value from file
+
+            # initialize counter to offset, if needed
             value ||= @config[:sequences][name][:offset] # initialize value to offset if none of the above had a value
+            # increment
             value += @config[:sequences][name][:step]
-            @sequences[name] = value
+
+            # write new counter into file
+            f.rewind if f.pos > 0
             f << value
+            f.truncate(f.pos)
+
+            @sequences[name] = value
+
             return value
 
           ensure
             f.flock(File::LOCK_UN)
             f.close
-            end
+          end
 
         end
       end

data/lib/sqnc/manager.rb

@@ -2,13 +2,13 @@ module Steenzout
 
   class SequenceManager
 
-    class << self; attr_accessor :sequences end
-    class << self; attr_accessor :implementations end
-
     @config = nil
     @sequences = {}
     @implementations = [:file]
 
+    class << self; attr_accessor :sequences end
+    class << self; attr_accessor :implementations end
+
 
     private
 
@@ -54,6 +54,21 @@ module Steenzout
 
     public
 
+      # Returns the current in-memory value for this sequence.
+      # WARNING: if the sequence hasn't been used yet, a nil value will be returned.
+      #
+      # @param name: the sequence name.
+      #
+      def self.current_value(name)
+
+        raise ArgumentError.new "The sequence #{name} doesn't exist!" if !@sequences.has_key? name
+
+        return @sequences[name]
+
+      end
+
+
+
       # Returns the list of allowed sequence management implementations.
       #
       def self.implementations
@@ -62,6 +77,17 @@ module Steenzout
 
 
 
+      # Increments and returns the given sequence by step (or offset + step if it has never been used before).
+      #
+      # @param name: the sequence name.
+      #
+      def self.increment(name)
+        raise ArgumentError.new "The sequence #{name} doesn't exist!" if !@sequences.has_key? name
+        self.increment_and_store name
+      end
+
+
+
       # Validates the configuration and loads the class with the given implementation.
       #
       def self.load
@@ -97,31 +123,6 @@ module Steenzout
 
 
 
-      # Returns the current in-memory value for this sequence.
-      # WARNING: if the sequence hasn't been used yet, a nil value will be returned.
-      #
-      # @param name: the sequence name.
-      #
-      def self.current_value name
-
-        raise ArgumentError.new "The sequence #{name} doesn't exist!" if !@sequences.has_key? name
-
-        return @sequences[name]
-
-      end
-
-
-
-      # Increments and returns the given sequence by step (or offset + step if it has never been used before).
-      #
-      # @param name: the sequence name.
-      #
-      def self.increment name
-        raise ArgumentError.new "The sequence #{name} doesn't exist!" if !@sequences.has_key? name
-        self.increment_and_store name
-      end
-
-
       # Returns a list of the current sequence names being managed.
       #
       def self.sequences

data/test/unit/sqnc/manager_test.rb

@@ -13,30 +13,23 @@ require 'lib/steenzout-sqnc'
 class TestSequenceManager < Test::Unit::TestCase
 
   def setup
+
     @config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-sqnc'
+
+    # default sequence manager
+    @config[:implementation] = :file
+
+    # add value to a sequence file
+    File.open(@config[:sequences][:seq3][:location], 'w') {|f| f.write('111')}
+
   end
 
   def teardown
+
     @config[:sequences].each_key {|name|
       sequence_file = @config[:sequences][name][:location]
       File.delete sequence_file if File.exist? sequence_file
     }
-  end
-
-
-
-  def __do_increment_tests
-
-    assert_equal 1, Steenzout::SequenceManager::increment(:seq1), @config[:implementation]
-    assert_equal 2, Steenzout::SequenceManager::increment(:seq1), @config[:implementation]
-
-    # invalid sequence name
-    assert_raises ArgumentError do
-      Steenzout::SequenceManager::increment 'seq1'
-    end
-    assert_raises ArgumentError do
-      Steenzout::SequenceManager::increment 'unknown'
-    end
 
   end
 
@@ -45,7 +38,7 @@ class TestSequenceManager < Test::Unit::TestCase
   def test_increment
 
     # run tests for all implementations
-    Steenzout::SequenceManager.implementations {|implementation|
+    Steenzout::SequenceManager.implementations.each {|implementation|
 
       # override configuration
       @config[:implementation] = implementation
@@ -54,18 +47,75 @@ class TestSequenceManager < Test::Unit::TestCase
       Steenzout::SequenceManager.load
 
       # run tests
-      __do_increment_tests
+      # no step and no offset defined
+      sequence_file1 = @config[:sequences][:seq1][:location]
+
+      assert_equal 1, Steenzout::SequenceManager::increment(:seq1), @config[:implementation]
+      assert_equal 1, File.read(sequence_file1).to_i
+
+      assert_equal 2, Steenzout::SequenceManager::increment(:seq1), @config[:implementation]
+      assert_equal 2, File.read(sequence_file1).to_i
+
+
+      # step=100 and offset=100
+      sequence_file2 = @config[:sequences][:seq2][:location]
+
+      assert_equal 200, Steenzout::SequenceManager::increment(:seq2), @config[:implementation]
+      assert_equal 200, File.read(sequence_file2).to_i
+
+      assert_equal 300, Steenzout::SequenceManager::increment(:seq2), @config[:implementation]
+      assert_equal 300, File.read(sequence_file2).to_i
     }
 
   end
 
 
 
+  def test_increment_with_file_containing_initial_value
+
+    # override configuration
+    @config[:implementation] = :file
+
+    # load new sequence manager implementation
+    Steenzout::SequenceManager.load
+
+    # run tests
+    sequence_file3 = @config[:sequences][:seq3][:location]
+
+    assert_equal 112, Steenzout::SequenceManager::increment(:seq3), @config[:implementation]
+    assert_equal 112, File.read(sequence_file3).to_i
+
+    assert_equal 113, Steenzout::SequenceManager::increment(:seq3), @config[:implementation]
+    assert_equal 113, File.read(sequence_file3).to_i
+
+  end
+
+
+
+  def test_increment_with_invalid_sequence_names
+
+    # invalid sequence name
+    assert_raises ArgumentError do
+      Steenzout::SequenceManager::increment 'seq1'
+    end
+    assert_raises ArgumentError do
+      Steenzout::SequenceManager::increment 'unknown'
+    end
+
+  end
+
+
+
   def test_sequences
 
-    sequence_names = []
-    Steenzout::SequenceManager.sequences {|name| sequence_names << name}
-    assert_equal([:seq1, :seq2], sequence_names)
+    result = []
+    Steenzout::SequenceManager.sequences {|name| result << name.to_s}
+    result.sort!
+
+    expected = ['seq1', 'seq2', 'seq3']
+    expected.sort!
+    
+    assert_equal expected, result
 
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: steenzout-sqnc
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 7
   prerelease: 
   segments: 
   - 1
   - 0
-  - 6
-  version: 1.0.6
+  - 8
+  version: 1.0.8
 platform: ruby
 authors: 
 - steenzout