coordinator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 480787ac7b5eecf9271ec542f15f5ebf17d23085
-  data.tar.gz: 9f688ebfcd97125c0292784f8ab06a121b9a4b51
+  metadata.gz: e53824a57bc5054c529d8a0566a4c26024fb9eaf
+  data.tar.gz: 7db6d332ac9d662721a5c45cb2e0ca52493cf1cf
 SHA512:
-  metadata.gz: c4ee690d00d2e78c10636c587c6f701230822c85a43118ab8c605759c4f9f2c75130f773649f2671ea1a4af2a6674d9643bc2be958c3dafbe21c5cc6acac4375
-  data.tar.gz: 7b4742110498118ffcf39ad32e72b98c55bb8957d3df4f4b67fc065abe705e73a1d00ce2e60018f18839598afc228dbe0d3359830eea5e007a9b6cb83b1a473f
+  metadata.gz: ac992d700929b4d5ae35ddabfff494280e77daacc25198e1d2a07fb9be322d7eaea7a9849ec933dfb40eb7532d98530ae47c2200d036caedc9249c241ae11a89
+  data.tar.gz: 672e70f26491333ebbabbd33a2692125dfc9af2875aca218b4b7f3b8e491bd4edf8433ef8d5826ca92a6a841986d31e97f7aa750bbb0c2a7a62e4f7da439f6f9

data/README.md

@@ -28,6 +28,13 @@ Or install it yourself as:
       Coordinator::Queue.new("medium"),
       Coordinator::Queue.new("low")
     ])
+    
+    @coordinator.add_task("high", 1)
+    @coordinator.add_task("medium", 2)
+    @coordinator.add_priority_task("high", 3)
+    
+    @coordinator.next_task(["high"]) # returns 3
+    @coordinator.next_task(["medium"]) # returns 2
 
 ## Contributing
 

data/lib/coordinator.rb

@@ -1,4 +1,5 @@
 require "coordinator/version"
+require "coordinator/error"
 require "coordinator/redis_queue"
 require "coordinator/queue"
 require "coordinator/base"

data/lib/coordinator/base.rb

@@ -22,11 +22,16 @@ module Coordinator
       false
     end
 
+    def set_capacity(skill, capacity)
+      queue = queue_for_skill(skill)
+      queue.set_capacity(capacity)
+    end
+
     private
 
     def queue_for_skill(skill)
       queue = @queues.find {|q| q.skill == skill}
-      raise "No matching queue for #{skill}" unless queue
+      raise Coordinator::Error.new("No matching queue for #{skill}") unless queue
       queue
     end
   end

data/lib/coordinator/error.rb

@@ -0,0 +1,4 @@
+module Coordinator
+  class Error < Exception
+  end
+end

data/lib/coordinator/queue.rb

@@ -1,10 +1,12 @@
 module Coordinator
   class Queue
-    attr_reader :skill
+    attr_reader :skill, :rules
 
-    def initialize(skill)
+    def initialize(skill, capacity=nil, &block)
       @skill = skill
       @store = Coordinator::RedisQueue.new(@skill)
+      @store.capacity = capacity if capacity
+      @custom_block = block if block_given?
     end
 
     def add_task(task)
@@ -16,11 +18,16 @@ module Coordinator
     end
 
     def next_task(skills)
-      can_work?(skills) ? @store.pop : nil
+      eligible?(@store.peek, skills) ? @store.pop : nil
     end
 
-    def can_work?(skills)
-      skills.include?(@skill)
+    def eligible?(task, skills)
+      return true if skills.include?(@skill)
+      @custom_block ? @custom_block.call(task, skills) : false
+    end
+
+    def set_capacity(capacity)
+      @store.capacity = capacity
     end
   end
 end

data/lib/coordinator/redis_queue.rb

@@ -3,44 +3,60 @@ require 'json'
 module Coordinator
   class RedisQueue
     def initialize(name)
-      @name = name
-      raise "redis not found, please set 'Redis.current'" unless Redis.current
+      @queue_name = "#{name}-queue"
+      @capacity_name = "#{name}-capacity"
+      raise Coordinator::Error.new("'Redis.current' not set") unless Redis.current
       @redis = Redis.current
     end
 
     def push(item)
+      raise Coordinator::Error.new("Queue is at capacity") if full?
       data = serialize(item)
-      @redis.rpush(@name, data) unless items.include?(data)
+      @redis.rpush(@queue_name, data) unless items.include?(data)
     end
 
     def left_push(item)
       data = serialize(item)
-      @redis.lpush(@name, data) unless items.include?(data)
+      @redis.lpush(@queue_name, data) unless items.include?(data)
     end
 
     def pop
-      data = @redis.lpop(@name)
+      data = @redis.lpop(@queue_name)
       parse(data)
     end
 
     def remove(item)
       data = serialize(item)
-      @redis.lrem(@name, 1, data)
+      @redis.lrem(@queue_name, 1, data)
     end
 
     def peek
-      data = @redis.lrange(@name, 0, 0).first
+      data = @redis.lrange(@queue_name, 0, 0).first
       parse(data)
     end
 
     def length
-      @redis.llen(@name)
+      @redis.llen(@queue_name)
+    end
+
+    def capacity
+      data = @redis.get(@capacity_name)
+      parse(data)
+    end
+
+    def capacity=(capacity)
+      @redis.set(@capacity_name, capacity)
     end
 
     private
 
+    def full?
+      return false unless capacity
+      length >= capacity
+    end
+
     def items
-      @redis.lrange(@name, 0, length)
+      @redis.lrange(@queue_name, 0, length)
     end
 
     def serialize(item)

data/lib/coordinator/version.rb

@@ -1,3 +1,3 @@
 module Coordinator
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_helper.rb

@@ -1,8 +1,7 @@
 require 'minitest/autorun'
 require 'minitest/reporters'
-require "fakeredis"
+require 'fakeredis'
 
-Redis.current = Redis.new
 Minitest::Reporters.use!(Minitest::Reporters::DefaultReporter.new(color: true))
 
 ENV['RACK_ENV'] = 'test'

data/test/unit/base_test.rb

@@ -19,5 +19,12 @@ describe 'Coordinator::Base' do
       assert_equal 2, @coordinator.next_task(["medium"])
       assert_equal false, @coordinator.next_task(["medium"])
     end
+
+    it 'raises exception when no queue exists' do
+      err = -> {
+        @coordinator.add_task("forgotten", 1)
+      }.must_raise Coordinator::Error
+      err.message.must_match /No matching queue for forgotten/
+    end
   end
 end

data/test/unit/queue_test.rb

@@ -24,13 +24,26 @@ describe "Coordinator::Queue" do
     end
   end
 
-  describe "can_work?" do
+  describe "eligible?" do
     it "returns true when skill present" do
-      assert @queue.can_work?(["high"])
+      assert @queue.eligible?(nil, ["high"])
     end
 
     it "returns false when skill not present" do
-      refute @queue.can_work?(["general", "rogers"])
+      refute @queue.eligible?(nil, ["low", "normal"])
+    end
+
+    it "can override default behaviour" do
+      queue = Coordinator::Queue.new("normal") do |task, skills|
+        return true if skills.include?("low")
+        return true if task == 4
+        task == 3 && skills.include?("special")
+      end
+      refute queue.eligible?(2, ["special"])
+      assert queue.eligible?(nil, ["normal"]), "default behaviour"
+      assert queue.eligible?(2, ["low"]), "override through skill"
+      assert queue.eligible?(4, []), "override through task"
+      assert queue.eligible?(3, ["special"]), "override through both"
     end
   end
 end

data/test/unit/redis_queue_test.rb

@@ -18,6 +18,15 @@ describe 'Coordinator::RedisQueue' do
       @queue.push("a")
       assert_equal 1, @queue.length
     end
+
+    it 'adds the same item only once' do
+      @queue.capacity = 1
+      @queue.push("a")
+      err = -> {
+        @queue.push("b")
+      }.must_raise Coordinator::Error
+      err.message.must_match /Queue is at capacity/
+    end
   end
 
   describe '.left_push' do
@@ -70,6 +79,14 @@ describe 'Coordinator::RedisQueue' do
     end
   end
 
+  describe '.capacity' do
+    it 'gets the top item and does not remove' do
+      assert_equal nil, @queue.capacity
+      @queue.capacity = 2
+      assert_equal 2, @queue.capacity
+    end
+  end
+
   it 'allows for objects' do
     [1000, "taco", {"a" => 1}, [1,2,3]].each do |o|
       @queue.push(o)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coordinator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tyler Mercier
@@ -97,6 +97,7 @@ files:
 - coordinator.gemspec
 - lib/coordinator.rb
 - lib/coordinator/base.rb
+- lib/coordinator/error.rb
 - lib/coordinator/queue.rb
 - lib/coordinator/redis_queue.rb
 - lib/coordinator/version.rb