barrage 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3642f34f25aae142789e33a2cf4c1d5a01648212
-  data.tar.gz: 3e71ac939f14b17c6c9d1d1407efda603392ea77
+SHA256:
+  metadata.gz: 1f1e0b5da1bcf39c6afcd692da7a90d3784bd791a83d2553c62b23c522de5e71
+  data.tar.gz: 97c3f16796ab212ad5421d758fdf2773f040befde8170cf5682fa1607b84c84f
 SHA512:
-  metadata.gz: 6b6f8a47d16b21d6160a79b007e45622564953fc680a5f98d4acc9ca437af42fbb42d2f8c545409968c6b72b26002b9cc210646cea2068c1ff797dff3d4c1d1f
-  data.tar.gz: 5f182c40631fe62015e9365eda727011a24943da8e1280a6bf7dc19aac1bcd959f3c5e2e79232a76d2874cd06f6714c734304abdf926ee083bcc085266f99689
+  metadata.gz: 8c0189dfdd3286230938d122dee87d56d7d41fdf2526115ba87f34c1bbe3ed276e37efe485e8cb8f18dad253bc0b9452f0997db08e5400c5ad690a42da267fe8
+  data.tar.gz: 2dff301124982ccec6670d36b53e1e2c48e9108c37eb80a559f85e6a371eccf89a682fcd5ff22485d23fbde51e9529914491f10cc5cf05b20244ecdb042c8e7f

data/.travis.yml

@@ -1,3 +1,10 @@
 language: ruby
 rvm:
-  - 2.1.1
+  - 2.0.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+bundler_args: --jobs=2
+services:
+  - redis-server
+script: bundle exec rake spec

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 0.1.1
+
+  * Fix redis client disconnect
+
+## 0.1.0
+
+  * Fix RedisWorkerId's worker_id handling
+  * Release old worker_id only if it is before ttl
+  * Add required_options to generators
+
+## 0.0.4
+
+  * [redis_worker_id generator] Release current worker_id before reaching real ttl
+
 ## 0.0.3
 
   * Fix critical bug on redis_worker_id generator

data/Gemfile

@@ -2,3 +2,17 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in barrage.gemspec
 gemspec
+
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.2.2")
+  gem "activesupport", "< 5.0.0"
+end
+
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.2.3")
+  gem "listen", "< 3.1.0"
+end
+
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.2.5")
+  gem "ruby_dep", "< 1.4.0"
+end
+
+gem "redis", ">= 4.0.0"

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec,
+  cmd: "bundle exec rspec",
+  all_after_pass: true,
+  all_on_start: true do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,5 +1,11 @@
 # Barrage
 
+[![Gem Version](https://badge.fury.io/rb/barrage.svg)](http://badge.fury.io/rb/barrage)
+[![Dependency Status](https://gemnasium.com/drecom/barrage.svg)](https://gemnasium.com/drecom/barrage)
+[![Coverage Status](https://img.shields.io/coveralls/drecom/barrage.svg)](https://coveralls.io/r/drecom/barrage)
+[![Build Status](https://travis-ci.org/drecom/barrage.svg)](https://travis-ci.org/drecom/barrage)
+[![Code Climate](https://codeclimate.com/github/drecom/barrage.png)](https://codeclimate.com/github/drecom/barrage)
+
 Distributed ID generator(like twitter/snowflake)
 
 ## Installation
@@ -34,13 +40,15 @@ barrage = Barrage.new(
   ]
 )
 barrage.next
-# => Generated ID
+# => Generated 64bit ID
 ```
 
 ### Generators
 
 #### msec
 #### redis_worker_id
+requirement: redis 2.6+
+
 #### sequence
 
 ### Creating your own generator
@@ -48,13 +56,14 @@ barrage.next
 ```ruby
 module Barrage::Generators
   class YourOwnGenerator < Base
+    self.required_options += %w(your_option_value)
     def generate
-	  # generated code
-	end
+      # generated code
+    end
 
     def your_option_value
-	  options["your_option_value"]
-	end
+      options["your_option_value"]
+    end
   end
 end
 

data/barrage.gemspec

@@ -22,8 +22,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "3.0.0.beta2"
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "redis"
+  spec.add_development_dependency "fakeredis"
+  spec.add_development_dependency "delorean"
+  spec.add_development_dependency "coveralls"
 end

data/lib/barrage/generators/base.rb

@@ -1,9 +1,18 @@
+require 'barrage/generators'
+require 'active_support/core_ext/class/attribute'
+
 class Barrage
   module Generators
     class Base
       attr_reader :options
+      class_attribute :required_options, :available_options
+      self.required_options = %w(length)
+      self.available_options = []
 
       def initialize(options = {})
+        if (missing = missing_required_options(options)) && !missing.empty?
+          raise ArgumentError, "Missing Required options: #{missing.join(', ')}"
+        end
         @options = options
       end
 
@@ -18,6 +27,12 @@ class Barrage
       def current
         raise NotImplemented, "Please Override"
       end
+
+      private
+
+      def missing_required_options(given_options)
+        required_options.reject { |k| given_options.has_key?(k) }
+      end
     end
   end
 end

data/lib/barrage/generators/msec.rb

@@ -3,6 +3,8 @@ require 'barrage/generators/base'
 class Barrage
   module Generators
     class Msec < Base
+      self.required_options += %w(start_at)
+
       def generate
         ((Time.now.to_f * 1000).round - start_at) & (2 ** length - 1)
       end

data/lib/barrage/generators/redis_worker_id.rb

@@ -5,10 +5,12 @@ class Barrage
   module Generators
     class RedisWorkerId < Base
       RACE_CONDITION_TTL = 30
+      self.required_options += %w(ttl)
 
       def initialize(options = {})
         @worker_id = nil
         @worker_ttl = 0
+        @real_ttl   = 0
         super
         @data = []
         @finalizer_proc = Finalizer.new(@data)
@@ -19,21 +21,23 @@ class Barrage
         now = Time.now.to_i
         if @worker_ttl - now <= 0
           @data[1] = @worker_id = renew_worker_id
-          # check redis when passed half of real ttl
+          # check redis after half of real ttl
           @worker_ttl = now + ttl / 2
+          @real_ttl   = now + ttl
+          @data[2] = @real_ttl
         end
         @worker_id
       end
       alias_method :current, :generate
 
-      def redis
-        @redis ||= @data[0] = Redis.new(options["redis"] || {})
-      end
-
       def ttl
         options["ttl"]
       end
 
+      def redis
+        @redis ||= @data[0] = Redis.new(options["redis"] || {})
+      end
+
       class Finalizer
         def initialize(data)
           @pid = $$
@@ -42,11 +46,11 @@ class Barrage
 
         def call(*args)
           return if @pid != $$
-          redis, worker_id = *@data
+          redis, worker_id, real_ttl = *@data
 
           if redis.is_a?(Redis) and redis.connected?
-            redis.del("barrage:worker:#{worker_id}")
-            redis.client.disconnect
+            redis.del("barrage:worker:#{worker_id}") if real_ttl > Time.now.to_i
+            redis._client.disconnect
           end
         end
       end
@@ -54,33 +58,47 @@ class Barrage
       private
 
       def renew_worker_id
+        if @real_ttl - Time.now.to_i - RACE_CONDITION_TTL <= 0
+          @worker_id = nil
+        end
         new_worker_id = redis.evalsha(
           script_sha,
           argv: [2 ** length, rand(2 ** length), @worker_id, ttl, RACE_CONDITION_TTL]
-        ).to_i
-        new_worker_id
+        )
+        new_worker_id or raise StandardError, "Renew redis worker id failed"
+        return new_worker_id.to_i
       end
 
       def script_sha
         @script_sha ||=
           redis.script(:load, <<-EOF.gsub(/^ {12}/, ''))
-            local max_value = ARGV[1]
+            local max_value = tonumber(ARGV[1])
             local new_worker_id = ARGV[2]
             local old_worker_id = ARGV[3]
-            local ttl = ARGV[4]
-            local race_condition_ttl = ARGV[5]
+            local ttl = tonumber(ARGV[4])
+            local race_condition_ttl = tonumber(ARGV[5])
+            local loop_cnt = 0
+
+            local worker_id = nil
+            local candidate_worker_id = tonumber(new_worker_id)
 
             if type(old_worker_id) == "string" and string.len(old_worker_id) > 0 and redis.call('EXISTS', "barrage:worker:" .. old_worker_id) == 1 then
               redis.call("EXPIRE", "barrage:worker:" .. old_worker_id, ttl + race_condition_ttl)
-              new_worker_id = old_worker_id
+              worker_id = old_worker_id
             else
-              while redis.call("SETNX", "barrage:worker:" .. new_worker_id, 1) == 0
+              while redis.call("SETNX", "barrage:worker:" .. candidate_worker_id, 1) == 0 and loop_cnt < max_value
               do
-                new_worker_id = (new_worker_id + 1) % max_value
+                candidate_worker_id = (candidate_worker_id + 1) % max_value
+                loop_cnt = loop_cnt + 1
+              end
+              if loop_cnt >= max_value then
+                return nil
+              else
+                worker_id = candidate_worker_id
               end
-              redis.call("EXPIRE", "barrage:worker:" .. new_worker_id, ttl + race_condition_ttl)
+              redis.call("EXPIRE", "barrage:worker:" .. worker_id, ttl + race_condition_ttl)
             end
-            return new_worker_id
+            return worker_id
           EOF
       end
     end

data/lib/barrage/version.rb

@@ -1,3 +1,3 @@
 class Barrage
-  VERSION = "0.0.3"
+  VERSION = "0.1.1"
 end

data/lib/barrage.rb

@@ -50,3 +50,5 @@ class Barrage
     @generators.inject(0) {|sum, g| sum += g.length }
   end
 end
+
+require "barrage/generators"

data/spec/barrage/generators/msec_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'barrage/generators/msec'
+
+describe Barrage::Generators::Msec do
+  context "When initialized" do
+    subject { described_class.new(options) }
+
+    context "with empty hash" do
+      let(:options) { {} }
+
+      it { expect { subject }.to raise_error(ArgumentError) }
+    end
+
+    context "with required options" do
+      let(:options) { {"length" => 16, "start_at" => (Time.now.to_f * 1000).round } }
+
+      it { is_expected.to be_instance_of(Barrage::Generators::Msec) }
+      its(:length) { is_expected.to eq(options["length"]) }
+      its(:start_at) { is_expected.to eq(options["start_at"]) }
+    end
+  end
+
+  describe "#generate" do
+    subject { described_class.new(options).generate }
+    let(:length) { 39 }
+    let(:start_at) { (Time.parse("2014-01-01 00:00:00").to_f*1000).round }
+    let(:options) { {"length" => length, "start_at" => start_at} }
+
+    it { is_expected.to be_instance_of(Fixnum) }
+    it { is_expected.to be < 2 ** length }
+
+    context "generate two numbers between 10 millisecond " do
+      subject { described_class.new(options) }
+
+      it "numbers difference that generated in interval 10 millisecond should exactly 10" do
+        t = Time.parse("2014-01-01 00:00:00")
+        first = time_travel_to(t) { subject.generate }
+        second = time_travel_to(Time.at(t.to_i, 10000)) { subject.generate }
+        expect(second - first).to eq(10)
+      end
+    end
+  end
+end

data/spec/barrage/generators/redis_worker_id_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'barrage/generators/redis_worker_id'
+
+describe Barrage::Generators::RedisWorkerId do
+  context "When initialized" do
+    subject { described_class.new(options) }
+
+    context "with empty hash" do
+      let(:options) { {} }
+
+      it { expect { subject }.to raise_error(ArgumentError) }
+    end
+
+    context "with required options" do
+      let(:options) { {"length" => 16, "ttl" => 300} }
+
+      it { is_expected.to be_instance_of(Barrage::Generators::RedisWorkerId) }
+      its(:length) { is_expected.to eq(options["length"]) }
+      its(:ttl) { is_expected.to eq(options["ttl"]) }
+    end
+  end
+
+  describe "#generate" do
+    subject { described_class.new(options).generate }
+    let(:length) { 8 }
+    let(:ttl) { 300 }
+    let(:options) { {"length" => length, "ttl" => ttl} }
+
+    it { is_expected.to be_instance_of(Fixnum) }
+    it { is_expected.to be < 2 ** length }
+
+    context "on many instances" do
+      subject { 64.times.map { described_class.new(options) } }
+      let(:length) { 8 }
+
+      it "should generate unique numbers" do
+        numbers = subject.map(&:generate)
+        expect(numbers.size).to eq(numbers.uniq.size)
+      end
+
+      it "generates numbers should less than length" do
+        expect(subject.all? { |s| s.generate < (2 ** length) }).to be true
+      end
+    end
+  end
+
+  describe "#Finalizer" do
+    subject { described_class::Finalizer.new(data).call(*args) }
+
+    before do
+      redis._client.connect
+    end
+    let(:now) { Time.now.to_i }
+    let(:ttl) { 300 }
+    let(:redis) { Redis.new }
+    let(:worker_ttl) { now + ttl / 2 }
+    let(:real_ttl) { now + ttl }
+    let(:data) { [redis, worker_ttl, real_ttl] }
+    let(:args) { {} }
+
+    it "redis client disconnect" do
+      subject
+      expect(redis.connected?).to eq false
+    end
+  end
+end

data/spec/barrage/generators/sequence_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'barrage/generators/sequence'
+
+describe Barrage::Generators::Sequence do
+  context "When initialized" do
+    subject { described_class.new(options) }
+
+    context "with empty hash" do
+      let(:options) { {} }
+
+      it { expect { subject }.to raise_error(ArgumentError) }
+    end
+
+    context "with required options" do
+      let(:options) { {"length" => 16 } }
+
+      it { is_expected.to be_instance_of(Barrage::Generators::Sequence) }
+      its(:length) { is_expected.to eq(options["length"]) }
+    end
+  end
+
+  describe "#generate" do
+    subject { described_class.new(options).generate }
+    let(:length) { 9 }
+    let(:options) { {"length" => length } }
+
+    it { is_expected.to be_instance_of(Fixnum) }
+    it { is_expected.to be < 2 ** length }
+
+    context "When sequence is 0" do
+      before do
+        subject.instance_variable_set(:@sequence, 0)
+      end
+      subject { described_class.new(options) }
+
+      it "should generates '1'" do
+        expect(subject.generate).to eq(1)
+      end
+
+      it "if generate twice in a row, generated numbers should be in succession" do
+        first = subject.generate
+        second = subject.generate
+        expect(first.succ).to eq(second)
+      end
+    end
+
+    context "When sequence is max" do
+      before do
+        subject.instance_variable_set(:@sequence, (2 ** length) - 1)
+      end
+      subject { described_class.new(options) }
+
+      it "should generates zero" do
+        expect(subject.generate).to be_zero
+      end
+    end
+  end
+end

data/spec/barrage_spec.rb

@@ -4,4 +4,45 @@ describe Barrage do
   it 'has a version number' do
     expect(Barrage::VERSION).not_to be nil
   end
+
+  context "when initialized" do
+    subject { Barrage.new(options) }
+
+    context "with empty generators" do
+      let(:options) { {"generators" => []} }
+      its(:generators) { is_expected.to be_empty }
+    end
+
+    context "with generators" do
+      let(:options) {
+        {
+          "generators" => [
+            {"name" => "msec", "length" => 39, "start_at" => 1396278000000},
+            {"name" => "redis_worker_id", "length" => 16, "ttl" => 300},
+            {"name" => "sequence", "length" => 9}
+          ]
+        }
+      }
+      it { expect(subject.generators.size).to eq(options["generators"].size) }
+      its(:generators) {
+        is_expected.to contain_exactly(
+          be_kind_of(Barrage::Generators::Msec),
+          be_kind_of(Barrage::Generators::RedisWorkerId),
+          be_kind_of(Barrage::Generators::Sequence)
+        )
+      }
+
+      describe "#generate" do
+        let(:barrage) { described_class.new(options) }
+        subject { barrage.generate }
+        it { is_expected.to be_kind_of(Integer) }
+        it { is_expected.to be < 2 ** barrage.length }
+      end
+
+      describe "#length" do
+        subject { described_class.new(options).length }
+        it { is_expected.to eq(options["generators"].map { |h| h["length"]}.inject(:+)) }
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,15 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bundler/setup'
+require 'rspec/its'
+require 'delorean'
+
+require 'coveralls'
+Coveralls.wear!
+
 require 'barrage'
 
 RSpec.configure do |config|
+  include Delorean
   config.filter_run focus: true
-  config.run_all_when_everything_filtered
+  config.run_all_when_everything_filtered = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barrage
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - gussan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2022-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,16 +56,30 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: delorean
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Distributed id generator
 email:
 - egussan@gmail.com
@@ -120,6 +176,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -133,13 +190,16 @@ files:
 - lib/barrage/generators/sequence.rb
 - lib/barrage/generators/timestamp.rb
 - lib/barrage/version.rb
+- spec/barrage/generators/msec_spec.rb
+- spec/barrage/generators/redis_worker_id_spec.rb
+- spec/barrage/generators/sequence_spec.rb
 - spec/barrage_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/drecom/barrage
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,11 +214,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Distributed id generator
 test_files:
+- spec/barrage/generators/msec_spec.rb
+- spec/barrage/generators/redis_worker_id_spec.rb
+- spec/barrage/generators/sequence_spec.rb
 - spec/barrage_spec.rb
 - spec/spec_helper.rb