gen_sid 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e85f018eee3cb1b5826585b177b232370ff9ac0
+  data.tar.gz: 17a7ccae61acfd7fe180b73781f430e499384a15
+SHA512:
+  metadata.gz: 651db99fe7a9cb5497edb9ae74e30dc1c866827c38a1d1eccce1de30024af47b85c2422d015ebae470026eae717f74b137d0c40c976520d02dcc71546fef108f
+  data.tar.gz: 9c05dc4279c60cef6b81750649cb64886caedbd682f12d857c6d8f1cccc8628535312734898a8c48600ae25429bb90de58fa74277d8aa7ae4f293a7fb1700ac2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gen_sid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tracy Flynn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# GenSid
+
+Generate sequential alphanumeric identifiers from a template
+
+e.g. Template 'AA9' produces 'AA0', 'AA1','AA2,'AA3', 'AA4', 'AA5', 'AA6', 'AA7', 'AA8', 'AA9', 'AB0', 'AB1', ....
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gen_sid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gen_sid
+
+## Usage
+
+    require 'gen_sid'
+    seq = GenSid::SeqID.new('EF27Y')
+    # Note that the first 'next_value' call returns the initial value
+    seq.next_value # => "EF27Y"
+    seq.next_value # => "EF27Z"
+    seq.next_value # => "EF28A"
+
+
+## Contributing
+
+1. Fork it ( https://github.com/tflynn/gen_sid/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/gen_sid.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gen_sid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gen_sid"
+  spec.version       = GenSid::VERSION
+  spec.authors       = ["Tracy Flynn"]
+  spec.email         = ["tracy.flynn@verymuchme.com"]
+  spec.summary       = %q{Generate sequential identifiers}
+  spec.description   = %q{Generate sequential identifiers using alpha-numeric template}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.0.0.beta1'
+
+end

data/lib/gen_sid.rb

@@ -0,0 +1,5 @@
+require_relative "gen_sid/version"
+require_relative "gen_sid/seq_id"
+require_relative "gen_sid/counter"
+require_relative "gen_sid/counter_alpha"
+require_relative "gen_sid/counter_num"

data/lib/gen_sid/counter.rb

@@ -0,0 +1,22 @@
+module GenSid
+
+
+  class Counter
+
+    attr_reader :initial_value, :current_value
+    attr_accessor :skip_first_value
+
+    def initialize(initial_value)
+      @initial_value = initial_value
+      @previous_value = nil
+      @current_value = nil
+      @skip_first_value = false
+    end
+
+    def next_value
+      raise "Method next_value must be implemented by sub class"
+    end
+
+  end
+
+end

data/lib/gen_sid/counter_alpha.rb

@@ -0,0 +1,39 @@
+module GenSid
+
+  class CounterAlpha < GenSid::Counter
+
+    def initialize(initial_value = 'A')
+      super(initial_value)
+    end
+
+    def value
+      @current_value.nil? ? @initial_value : @current_value
+    end
+
+    def next_value
+      increment
+      if @skip_first_value
+        increment
+        @skip_first_value = false
+      end
+      next_val = @current_value
+      status = @previous_value == 'Z' ? :rollover : :normal
+      [next_val,status]
+    end
+
+    def increment
+      @previous_value = @current_value
+      if @current_value.nil?
+        @current_value = @initial_value
+      else
+        if @current_value == 'Z'
+          @current_value = 'A'
+        else
+          @current_value = (@current_value[0].ord + 1).chr
+        end
+      end
+    end
+
+  end
+
+end

data/lib/gen_sid/counter_num.rb

@@ -0,0 +1,39 @@
+module GenSid
+
+  class CounterNum < GenSid::Counter
+
+    def initialize(initial_value = 0)
+      super(initial_value)
+    end
+
+    def value
+      @current_value.nil? ? @initial_value : @current_value
+    end
+
+    def next_value
+      increment
+      if @skip_first_value
+        increment
+        @skip_first_value = false
+      end
+      next_val = @current_value
+      status = @previous_value == 9 ? :rollover : :normal
+      [next_val,status]
+    end
+
+    def increment
+      @previous_value = @current_value
+      if @current_value.nil?
+        @current_value = @initial_value
+      else
+        if @current_value == 9
+          @current_value = 0
+        else
+          @current_value += 1
+        end
+      end
+    end
+
+  end
+
+end

data/lib/gen_sid/seq_id.rb

@@ -0,0 +1,66 @@
+module GenSid
+
+  class SeqID
+
+    attr_reader :total, :pattern
+
+    def initialize(pattern = 'A1')
+      @pattern = pattern
+      @reversed_counters = parse_pattern(@pattern).reverse
+      # Set all but first counter to skip first value on increment
+      1.upto(@reversed_counters.size - 1) do |pos|
+        @reversed_counters[pos].skip_first_value = true
+      end
+    end
+
+    def next_value
+
+      # Counters are managed in reverse order - from least-significant (i.e. most rapidly varying)
+      # to most-significant (i.e. least rapidly varying)
+
+      last_processed = 0
+      all_next = ""
+
+      # Stop at first counter that yields a next value without a rollover
+      0.upto(@reversed_counters.size - 1) do |pos|
+        last_processed = pos
+        counter = @reversed_counters[pos]
+        next_value, status = counter.next_value
+        all_next << next_value.to_s
+        break if (status == :normal)
+      end
+
+      # Deal with remainder - get current values
+      (last_processed + 1).upto(@reversed_counters.size - 1) do |pos|
+        counter = @reversed_counters[pos]
+        all_next << counter.value.to_s
+      end
+
+      # Reverse the result
+      all_next.reverse
+
+    end
+
+    private # Private from here on
+
+    # Returns an array of Counters, one per pattern element in the same order - i.e. most significant first
+    def parse_pattern(pattern)
+      counters = Array.new
+      pattern.split("").each do |element|
+        if element =~ /\d/
+          counters << CounterNum.new(element.to_i)
+        elsif element =~ /[[:alpha:]]/
+          counters << CounterAlpha.new(element.upcase)
+        else
+          # Do nothing
+        end
+      end
+
+      counters
+    end
+
+
+  end
+
+
+end

data/lib/gen_sid/version.rb

@@ -0,0 +1,3 @@
+module GenSid
+  VERSION = "0.0.2"
+end

data/test/gen_sid/counter_alpha_spec.rb

@@ -0,0 +1,70 @@
+require 'rspec'
+require 'gen_sid'
+
+describe 'An alpha counter' do
+
+  it 'should initialize with an  explicit value' do
+    counter = GenSid::CounterAlpha.new
+    expect(counter.initial_value).to eq('A')
+  end
+
+  it 'should return a next value' do
+    counter = GenSid::CounterAlpha.new
+    expect(counter.next_value).to be
+  end
+
+  it "should return 'A' as the initial next value without marking it as a rollover" do
+    counter = GenSid::CounterAlpha.new
+    next_value, status = counter.next_value
+    expect(next_value).to eq('A')
+    expect(status).to eq(:normal)
+  end
+
+  it "should return 'B' as the second value" do
+    counter = GenSid::CounterAlpha.new
+    next_value, status = counter.next_value
+    expect(next_value).to eq('A')
+    expect(status).to eq(:normal)
+    next_value, status = counter.next_value
+    expect(next_value).to eq('B')
+    expect(status).to eq(:normal)
+  end
+
+
+  it "should indicate the first rollover when the first range is exceeded" do
+    counter = GenSid::CounterAlpha.new
+    next_value, status = counter.next_value # initial 'A'
+    expect(next_value).to eq('A')
+    expect(status).to eq(:normal)
+
+    # 'B' - 'Y'
+    1.upto(24) do |i|
+      counter.next_value
+    end
+
+    next_value, status = counter.next_value # 'Z'
+    expect(next_value).to eq('Z')
+    expect(status).to eq(:normal)
+
+    next_value, status = counter.next_value # 'A' with rollover
+    expect(next_value).to eq('A')
+    expect(status).to eq(:rollover)
+
+    next_value, status = counter.next_value # 'B'
+    expect(next_value).to eq('B')
+    expect(status).to eq(:normal)
+
+  end
+
+
+  it "should initialize to any supplied value and increment properly" do
+    counter = GenSid::CounterAlpha.new('Z')
+    next_value, status = counter.next_value # initial 'Z'
+    expect(next_value).to eq('Z')
+    expect(status).to eq(:normal)
+
+    next_value, status = counter.next_value # 'A' with rollover
+    expect(next_value).to eq('A')
+    expect(status).to eq(:rollover)
+  end
+end

data/test/gen_sid/counter_num_spec.rb

@@ -0,0 +1,59 @@
+require 'rspec'
+require 'gen_sid'
+
+describe 'A numeric counter' do
+
+  it 'should initialize with an  explicit value' do
+    counter = GenSid::CounterNum.new
+    expect(counter.initial_value).to eq(0)
+  end
+
+  it 'should return a next value' do
+    counter = GenSid::CounterNum.new
+    expect(counter.next_value).to be
+  end
+
+  it "should return 0 as the initial next value without marking it as a rollover" do
+    counter = GenSid::CounterNum.new
+    next_value, status = counter.next_value
+    expect(next_value).to eq(0)
+    expect(status).to eq(:normal)
+  end
+
+  it "should indicate the first rollover when the first range is exceeded" do
+    counter = GenSid::CounterNum.new
+    next_value, status = counter.next_value # initial 0
+    expect(next_value).to eq(0)
+    expect(status).to eq(:normal)
+
+    # 1 through 8
+    1.upto(8) do |i|
+      counter.next_value
+    end
+
+    next_value, status = counter.next_value # 9
+    expect(next_value).to eq(9)
+    expect(status).to eq(:normal)
+
+    next_value, status = counter.next_value # 0 with rollover
+    expect(next_value).to eq(0)
+    expect(status).to eq(:rollover)
+
+    next_value, status = counter.next_value # 1
+    expect(next_value).to eq(1)
+    expect(status).to eq(:normal)
+
+  end
+
+  it "should initialize to any supplied value and increment properly" do
+    counter = GenSid::CounterNum.new(9)
+    next_value, status = counter.next_value # initial 9
+    expect(next_value).to eq(9)
+    expect(status).to eq(:normal)
+
+    next_value, status = counter.next_value # 0 with rollover
+    expect(next_value).to eq(0)
+    expect(status).to eq(:rollover)
+  end
+
+end

data/test/gen_sid/gen_sid_spec.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'gen_sid'
+
+describe "Initialize SeqID" do
+
+  it 'should supply defaults' do
+    sid = GenSid::SeqID.new
+    expect(sid.pattern).to eq('A1')
+  end
+
+
+end

data/test/gen_sid/seq_id_spec.rb

@@ -0,0 +1,38 @@
+require 'rspec'
+require 'gen_sid'
+
+describe 'SeqID' do
+
+  it 'should handle the default case correctly' do
+    seq = GenSid::SeqID.new
+    # Default value is 'A1'
+    expect(seq.next_value).to eq('A1')
+    7.times {|i| seq.next_value}
+    expect(seq.next_value).to eq('A9')
+    expect(seq.next_value).to eq('B0')
+    8.times {|i| seq.next_value}
+    expect(seq.next_value).to eq('B9')
+    expect(seq.next_value).to eq('C0')
+  end
+
+  it "should handle a more complex case properly" do
+    seq = GenSid::SeqID.new('CC1B')
+    expect(seq.next_value).to eq('CC1B')
+    expect(seq.next_value).to eq('CC1C')
+    22.times {|i| seq.next_value}
+    expect(seq.next_value).to eq('CC1Z')
+    expect(seq.next_value).to eq('CC2A')
+  end
+
+  it "should handle starting in the middle of a complex sequence properly" do
+    seq = GenSid::SeqID.new('EF27Y')
+    expect(seq.next_value).to eq('EF27Y')
+    expect(seq.next_value).to eq('EF27Z')
+    expect(seq.next_value).to eq('EF28A')
+    seq = GenSid::SeqID.new('EF9ZZ')
+    expect(seq.next_value).to eq('EF9ZZ')
+    expect(seq.next_value).to eq('EG0AA')
+
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: gen_sid
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tracy Flynn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+description: Generate sequential identifiers using alpha-numeric template
+email:
+- tracy.flynn@verymuchme.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gen_sid.gemspec
+- lib/gen_sid.rb
+- lib/gen_sid/counter.rb
+- lib/gen_sid/counter_alpha.rb
+- lib/gen_sid/counter_num.rb
+- lib/gen_sid/seq_id.rb
+- lib/gen_sid/version.rb
+- test/gen_sid/counter_alpha_spec.rb
+- test/gen_sid/counter_num_spec.rb
+- test/gen_sid/gen_sid_spec.rb
+- test/gen_sid/seq_id_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Generate sequential identifiers
+test_files:
+- test/gen_sid/counter_alpha_spec.rb
+- test/gen_sid/counter_num_spec.rb
+- test/gen_sid/gen_sid_spec.rb
+- test/gen_sid/seq_id_spec.rb