steenzout-sqnc 1.0.2

data/README.textile

@@ -0,0 +1,37 @@
+h1. Introduction
+
+This gem provides simple sequence management functionality.
+
+
+
+h1. Configuration
+
+You can only use one type of sequence manager implementation.
+
+
+h2. implement sequence on a file
+
+<pre><code>:steenzout-sqnc:
+  :implementation: :file
+  :sequences:
+    :seq1:
+      :location: '/opt/local/steenzout/sequence1'
+    :seq2:
+      :location: '/opt/local/steenzout/sequence2'
+      :step: 100
+      :offset: 100
+</code></pre>
+
+
+h2. implement sequence on a TokyoCabinet database
+
+<pre><code>:steenzout-sqnc:
+  :implementation: :tokyocabinet
+  :sequences:
+    :seq1:
+      :location: '/opt/local/steenzout/sequence1.tch'
+    :seq2:
+      :location: '/opt/local/steenzout/sequence2.tch'
+      :step: 100
+      :offset: 100
+</code></pre>

data/lib/sqnc/file/manager.rb

@@ -0,0 +1,37 @@
+module Steenzout
+
+  class SequenceManager
+
+    private
+
+      def self.increment_and_store name
+
+        open(@@config[:sequences][name][:location], File::RDWR|File::CREAT, 0644) do |f|
+
+          begin
+
+            p @@config[:implementation]
+            f.flock(File::LOCK_EX)
+
+            value = @@sequences[name] # get value from memory
+            p "from memory #{value}"
+            value = f.readline().to_i if @@sequences[name].nil? rescue EOFError # get value from file
+            p "from file #{value}"
+            value ||= @@config[:sequences][name][:offset] # initialize value to offset if none of the above had a value
+            p "value=#{value}, offset=#{@@config[:sequences][name][:offset]}"
+            value += @@config[:sequences][name][:step]
+            @@sequences[name] = value
+            p "newvalue=#{value}, increment=#{@@config[:sequences][name][:step]}"
+            f << value
+            return value
+
+          ensure
+            f.flock(File::LOCK_UN)
+            f.close
+            end
+
+        end
+      end
+    end
+
+end

data/lib/sqnc/file/manager_file.rb

@@ -0,0 +1,33 @@
+module Steenzout
+
+  class SequenceManager
+
+    @@sequences = {}
+
+    def self.load_from_tokyocabinet
+
+    end
+
+    def self.load_from_yaml
+      config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-sqnc'
+      @@sequences = config[:sequences]
+    end
+
+    def self.reload
+      config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-sqnc'
+      load_from_yaml if config[:method] == 'yaml'
+      end
+
+
+    def self.list_sequences
+      @@sequences
+    end
+
+    def self.increment_sequence name
+      @@sequences[name] = @@sequences[name] + 1
+    end
+
+    reload
+
+  end
+end

data/lib/sqnc/kyotocabinet/manager.rb

@@ -0,0 +1,18 @@
+require 'kyotocabinet'
+
+include KyotoCabinet
+
+
+
+module Steenzout
+
+  class SequenceManager
+
+    private
+
+      def self.increment_and_store name
+        raise ArgumentError "KyotoCabinet implementation is not ready!"
+      end
+
+  end
+end

data/lib/sqnc/manager.rb

@@ -0,0 +1,134 @@
+module Steenzout
+
+  class SequenceManager
+
+    class << self; attr_accessor :sequences end
+    class << self; attr_accessor :implementations end
+
+    @config = nil
+    @sequences = {}
+    @implementations = [:file]
+
+
+    private
+
+      # Validates gem configuration and initializes the class' sequences.
+      #
+      def self.load_sequences
+
+        @config[:sequences].each_key do |name|
+
+
+          # validate :location
+
+          raise ArgumentError.new \
+            "Sequence file location #{@config[:sequences][name][:location]} needs to be defined!" \
+            if !@config[:sequences][name].has_key? :location
+
+
+          # validate :offset
+
+          @config[:sequences][name][:offset] ||= 0
+          raise ArgumentError.new \
+            "Offset value #{@config[:sequences][name][:offset]} for #{name} sequence needs to be >= 0!" \
+            if @config[:sequences][name][:offset] < 0
+
+
+          # validate :step
+
+          @config[:sequences][name][:step] ||= 1
+          raise ArgumentError.new \
+            "Step value #{@config[:sequences][name][:step]} for #{name} sequence needs to be > 0!" \
+            if @config[:sequences][name][:step] <= 0
+
+
+          # initialize sequence
+
+          @sequences[name] = nil
+
+        end
+
+      end
+
+
+
+    public
+
+      # Returns the list of allowed sequence management implementations.
+      #
+      def self.implementations
+        @implementations
+      end
+
+
+
+      # Validates the configuration and loads the class with the given implementation.
+      #
+      def self.load
+
+        # retrieve configuration
+
+        @config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-sqnc'
+        @config[:sequences] ||= {}
+
+
+        # validation
+
+        if !@config.has_key? :implementation or @config[:implementation].nil?
+          error_message = "implementation property is missing from the configuration file!"
+          raise ArgumentError.new error_message
+        end
+
+        raise ArgumentError.new "there is no #{@config[:implementation]} implementation!" if
+            !@implementations.include? @config[:implementation] or
+                !File.exist? "#{File.dirname(__FILE__)}/#{@config[:implementation]}/manager.rb"
+
+
+        # load implementation
+
+        require "#{File.dirname(__FILE__)}/#{@config[:implementation]}/manager"
+
+
+        # load sequences
+
+        load_sequences
+
+      end
+
+
+
+      # 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
+        @sequences.each_key {|name|
+          yield name
+        }
+      end
+
+  end
+end

data/lib/sqnc/manager_file.rb

@@ -0,0 +1,33 @@
+module Steenzout
+
+  class SequenceManager
+
+    @@sequences = {}
+
+    def self.load_from_tokyocabinet
+
+    end
+
+    def self.load_from_yaml
+      config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-sqnc'
+      @@sequences = config[:sequences]
+    end
+
+    def self.reload
+      config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-sqnc'
+      load_from_yaml if config[:method] == 'yaml'
+      end
+
+
+    def self.list_sequences
+      @@sequences
+    end
+
+    def self.increment_sequence name
+      @@sequences[name] = @@sequences[name] + 1
+    end
+
+    reload
+
+  end
+end

data/lib/sqnc/tokyocabinet/manager.rb

@@ -0,0 +1,18 @@
+require 'tokyocabinet'
+
+include TokyoCabinet
+
+
+
+module Steenzout
+
+  class SequenceManager
+
+    private
+
+      def self.increment_and_store name
+        raise ArgumentError "TokyoCabinet implementation is not ready!"
+      end
+
+  end
+end

data/lib/steenzout-sqnc.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'steenzout-cfg'
+
+module Steenzout
+
+  autoload :SequenceManager, "#{File.dirname(__FILE__)}/sqnc/manager"
+
+end
+
+Steenzout::SequenceManager.load

data/test/unit/sqnc/manager_test.rb

@@ -0,0 +1,72 @@
+require 'test/unit'
+require 'rubygems'
+require 'steenzout-cfg'
+
+# loading development environment configuration settings
+Steenzout::ConfigurationManager.load 'config/development.yaml'
+
+# load gem
+require 'lib/steenzout-sqnc'
+
+
+
+class TestSequenceManager < Test::Unit::TestCase
+
+  def setup
+    @config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-sqnc'
+  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
+
+
+
+  def test_increment
+
+    # run tests for all implementations
+    Steenzout::SequenceManager.implementations {|implementation|
+
+      # override configuration
+      @config[:implementation] = implementation
+
+      # load new sequence manager implementation
+      Steenzout::SequenceManager.load
+
+      # run tests
+      __do_increment_tests
+    }
+
+  end
+
+
+
+  def test_sequences
+
+    sequence_names = []
+    Steenzout::SequenceManager.sequences {|name| sequence_names << name}
+    assert_equal([:seq1, :seq2], sequence_names)
+
+  end
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: steenzout-sqnc
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 2
+  version: 1.0.2
+platform: ruby
+authors: 
+- steenzout
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-17 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: steenzout-cfg
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id001
+description: |
+  This gem provides simple sequence management functionality.
+
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- lib/sqnc/file/manager.rb
+- lib/sqnc/file/manager_file.rb
+- lib/sqnc/kyotocabinet/manager.rb
+- lib/sqnc/kyotocabinet/manager_kyotocabinet.rb
+- lib/sqnc/manager.rb
+- lib/sqnc/manager_file.rb
+- lib/sqnc/manager_kyotocabinet.rb
+- lib/sqnc/manager_tokyocabinet.rb
+- lib/sqnc/tokyocabinet/manager.rb
+- lib/sqnc/tokyocabinet/manager_tokyocabinet.rb
+- lib/steenzout-sqnc.rb
+- README.textile
+- test/unit/sqnc/manager_test.rb
+has_rdoc: true
+homepage: https://github.com/steenzout/steenzout-cfg
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Steenzout sequence management gem.
+test_files: 
+- test/unit/sqnc/manager_test.rb