bucketer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91aeba943436f2464a9eb1733c5bac7846113bdc
-  data.tar.gz: facd6e076c68d5e4ba8d8f44c5170f6df875ed33
+  metadata.gz: 977bcdc41c9616bd1eb50f0c6ef7b38d477d2acb
+  data.tar.gz: 7fc0498334f0eb657dfba2a3d6bd8129d6cea23e
 SHA512:
-  metadata.gz: 0da5f86a6b232041663ad6c6b358b5b0f5e98b868b7138fc4132b916b4049eae1e570a673398e54454b6409c71178ec388423eaa38c2a287048d3f9b26a0daa2
-  data.tar.gz: e0561a07c9694e9a3f0add769323f7021e10473c8035e505710d47edb567f22e34e38872db0f34100b8eeb80740c56582511a0d10feb39fa2e6eccf5d617a83d
+  metadata.gz: 3f10938119224521bfdc699037e64cda70193bf7f323d0a196524f62b28f46831cdbb335b81d180a709be5ea204eaf11bb71e2e23781deb8cfcf5eb18e4aa257
+  data.tar.gz: d326b7ff4de0a29d66d0a2821780c3a8da3ebcce3764f158b374cdbc8b07fa48112b7f806b3feb6114a93c3ef10e00bedc40b7f8a8ea1642c1e6bc8a65c1d696

data/README.md

@@ -1,6 +1,6 @@
 # Bucketer
 
-This is a generic tool for putting arbitrary objects into buckets and setting callbacks to be called when any bucket exceeds a specific threshold size. The interface is intentially written using blocks/callbacks as it is suited for use in EventMachine code.
+This is a generic EventMachine library for putting arbitrary objects into buckets and setting callbacks to be called when any bucket exceeds a specific threshold size. Although the `Bucketer::InMemory` is synchronous (it's just using a ruby hash) the interface is still what would be expected for an asynchronous API for consistency with other Bucketers to be implemented in future.
 
 Currently an in memory bucketer is supported, however it is intended that a redis backed bucketer will be added later and it will be using em-hiredis gem for redis interaction and it will actually be asynchronous.
 
@@ -21,17 +21,27 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-bucketer = Bucketer::InMemory.new(:bucket_threshold_size => 5)
-
-bucketer.on_bucket_full do |bucket_id|
-  p "yay bucket #{bucket_id} filled up!"
+require 'bucketer'
+EM.run do
+  bucketer = Bucketer::InMemory.new(:bucket_threshold_size => 5)
+
+  bucketer.on_bucket_full do |bucket_id|
+    p "yay bucket #{bucket_id} filled up!"
+
+    bucketer.get_and_empty_bucket(bucket_id) do |items|
+      EM.stop
+      items.each do |item|
+        p "got back #{item}"
+      end
+    end
+  end
+
+  bucketer.add_item("1", "1", {:foo => :bar}) {EM.stop}
+  bucketer.add_item("1", "2", {:foo => :bar}) {}
+  bucketer.add_item("1", "3", {:foo => :bar}) {}
+  bucketer.add_item("1", "4", {:bar => :foo}) {}
+  bucketer.add_item("1", "5", {:bar => :foo}) {}
 end
-
-bucketer.add_item("1", "1", {:foo => :bar})
-bucketer.add_item("1", "2", {:foo => :bar})
-bucketer.add_item("1", "3", {:foo => :bar})
-bucketer.add_item("1", "4", {:bar => :foo})
-bucketer.add_item("1", "5", {:bar => :foo})
 ```
 
 ## Contributing

data/bucketer.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency     "eventmachine"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/lib/bucketer/in_memory.rb

@@ -1,3 +1,5 @@
+require 'eventmachine'
+
 module Bucketer
   # This is a purpose built class for storing arbitrary
   # objects in buckets then calling callbacks when any
@@ -37,8 +39,11 @@ module Bucketer
     # @param item [Object] the item to be
     # placed in the bucket
     def add_item(bucket_id, item_id, item, &blk)
-      add_bucket_to_db(bucket_id, item_id, item, &blk)
-      check_bucket_full(bucket_id)
+      EM::Completion.new.tap do |c|
+        c.callback(&blk) if block_given?
+        add_bucket_to_db(bucket_id, item_id, item) { c.succeed }
+        check_bucket_full(bucket_id)
+      end
     end
 
     # Used to set a callback hook for when a bucket
@@ -61,8 +66,11 @@ module Bucketer
     # @yield [Array] the items you put
     # into the bucket
     def get_bucket(bucket_id, &blk)
-      get_bucket_from_db(bucket_id) do |bucket|
-        blk.call bucket.values
+      EM::Completion.new.tap do |c|
+        c.callback(&blk) if block_given?
+        get_bucket_from_db(bucket_id) do |bucket|
+          c.succeed bucket.values
+        end
       end
     end
 
@@ -73,9 +81,12 @@ module Bucketer
     # @yield [Array] the items you put
     # into the bucket
     def get_and_empty_bucket(bucket_id, &blk)
-      get_bucket(bucket_id) do |contents|
-        empty_bucket(bucket_id) do
-          blk.call contents
+      EM::Completion.new.tap do |c|
+        c.callback(&blk) if block_given?
+        get_bucket(bucket_id) do |contents|
+          empty_bucket(bucket_id) do
+            c.succeed contents
+          end
         end
       end
     end
@@ -85,8 +96,11 @@ module Bucketer
     # @param bucket_id [String] the bucket id
     # of the bucket you want to empty
     def empty_bucket(bucket_id, &blk)
-      empty_bucket_in_db(bucket_id) do
-        blk.call if block_given?
+      EM::Completion.new.tap do |c|
+        c.callback(&blk) if block_given?
+        empty_bucket_in_db(bucket_id) do
+          c.succeed
+        end
       end
     end
 

data/lib/bucketer/version.rb

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

data/spec/bucketer_spec.rb

@@ -1,93 +1,80 @@
 require 'spec_helper'
 require 'bucketer'
 
-describe Bucketer do
-  let(:bucketer) { Bucketer::InMemory.new(:bucket_threshold_size => 5) }
-
+shared_examples "a bucketer" do
   describe '#add_item' do
     it 'adds a item to the bucket' do
-      ran_add = false
-      ran_get = false
-      bucketer.add_item("1", "2", {:foo => :bar}) do
-        ran_add = true
-      end
-
-      bucketer.get_bucket("1") do |bucket|
-        expect(bucket).to eq([{:foo => :bar}])
-        ran_get = true
+      EM.run do
+        EM.add_timer(1) { fail "didn't reach EM.stop" }
+        bucketer.add_item("1", "2", {:foo => :bar}) do
+          bucketer.get_bucket("1") do |bucket|
+            expect(bucket).to eq([{:foo => :bar}])
+            EM.stop
+          end
+        end
       end
-
-      expect(ran_add).to eq(true)
-      expect(ran_get).to eq(true)
     end
 
     it 'overwrites an existing item with the same id' do
-      ran_get = false
-      bucketer.add_item("1", "2", {:foo => :bar})
-      bucketer.add_item("1", "2", {:bar => :foo})
-
-      bucketer.get_bucket("1") do |bucket|
-        expect(bucket).to eq([{:bar => :foo}])
-        ran_get = true
+      EM.run do
+        EM.add_timer(1) { fail "didn't reach EM.stop" }
+        bucketer.add_item("1", "2", {:foo => :bar}) do
+          bucketer.add_item("1", "2", {:bar => :foo}) do
+
+            bucketer.get_bucket("1") do |bucket|
+              expect(bucket).to eq([{:bar => :foo}])
+              EM.stop
+            end
+          end
+        end
       end
-
-      expect(ran_get).to eq(true)
     end
 
     it 'calls on_bucket_full when a bucket fills up' do
-      ran = false
-      bucketer.on_bucket_full do |bucket_id|
-        expect(bucket_id).to eq("1")
-        ran = true
+      EM.run do
+        EM.add_timer(1) { fail "didn't reach EM.stop" }
+        bucketer.on_bucket_full do |bucket_id|
+          expect(bucket_id).to eq("1")
+          EM.stop
+        end
+
+        add_n_items(bucketer, "1", 5) {}
       end
-
-      bucketer.add_item("1", "1", {:foo => :bar})
-      bucketer.add_item("1", "2", {:foo => :bar})
-      bucketer.add_item("1", "3", {:foo => :bar})
-      bucketer.add_item("1", "4", {:bar => :foo})
-      bucketer.add_item("1", "5", {:bar => :foo})
-
-      expect(ran).to eq(true)
     end
   end
 
   describe '#empty_bucket' do
     it 'emptys a bucket' do
-      ran = false
-      bucketer.add_item("1", "1", {:foo => :bar})
-      bucketer.add_item("1", "2", {:foo => :bar})
-      bucketer.add_item("1", "3", {:foo => :bar})
-
-      bucketer.empty_bucket("1")
-
-      bucketer.get_bucket("1") do |bucket|
-        expect(bucket).to eq([])
-        ran = true
+      EM.run do
+        EM.add_timer(1) { fail "didn't reach EM.stop" }
+        add_n_items(bucketer, "1", 3) do
+          bucketer.empty_bucket("1") do
+            bucketer.get_bucket("1") do |bucket|
+              expect(bucket).to eq([])
+              EM.stop
+            end
+          end
+        end
       end
-      expect(ran).to eq(true)
     end
   end
 
   describe '#get_and_empty_bucket' do
     it 'gets the bucket then emptys the bucket' do
-      ran_get_and_empty = false
-      ran_get = false
-      bucketer.add_item("1", "1", {:foo => :bar})
-      bucketer.add_item("1", "2", {:bar => :foo})
-      bucketer.add_item("1", "3", {:boo => :far})
-
-      bucketer.get_and_empty_bucket("1") do |bucket|
-        expect(bucket).to eq([{:foo => :bar}, {:bar => :foo}, {:boo => :far}])
-        ran_get_and_empty = true
+      EM.run do
+        EM.add_timer(1) { fail "didn't reach EM.stop" }
+        add_n_items(bucketer, "1", 3) do
+
+          bucketer.get_and_empty_bucket("1") do |bucket|
+            expect(bucket).to eq([{:id => 0}, {:id => 1}, {:id => 2}])
+
+            bucketer.get_bucket("1") do |empty_bucket|
+              expect(empty_bucket).to eq([])
+              EM.stop
+            end
+          end
+        end
       end
-
-      bucketer.get_bucket("1") do |bucket|
-        expect(bucket).to eq([])
-        ran_get = true
-      end
-
-      expect(ran_get_and_empty).to eq(true)
-      expect(ran_get).to eq(true)
     end
   end
 end

data/spec/in_memory_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'bucketer'
+
+describe Bucketer::InMemory do
+  it_behaves_like "a bucketer" do
+    let(:bucketer) { Bucketer::InMemory.new(:bucket_threshold_size => 5) }
+  end
+end

data/spec/spec_helper.rb

@@ -2,7 +2,9 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
 require 'rspec'
 require 'pry'
+require 'spec_methods'
 
 RSpec.configure do |config|
   config.order = :rand
+  config.include(SpecMethods)
 end

data/spec/spec_methods.rb

@@ -0,0 +1,10 @@
+module SpecMethods
+  def add_n_items(bucketer, bucket, n, &blk)
+    worker = proc do |i, iter|
+      bucketer.add_item(bucket, i.to_s, {:id => i}) do
+        iter.next
+      end
+    end
+    EM::Iterator.new(0...n).each(worker, blk)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bucketer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Richard Heycock
@@ -11,6 +11,20 @@ bindir: bin
 cert_chain: []
 date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +98,9 @@ files:
 - lib/bucketer/in_memory.rb
 - lib/bucketer/version.rb
 - spec/bucketer_spec.rb
+- spec/in_memory_spec.rb
 - spec/spec_helper.rb
+- spec/spec_methods.rb
 homepage: https://github.com/dgvz/bucketer
 licenses:
 - GPL
@@ -112,4 +128,6 @@ summary: A generic class for storing arbitrary objects in buckets with callbacks
   threshold reached
 test_files:
 - spec/bucketer_spec.rb
+- spec/in_memory_spec.rb
 - spec/spec_helper.rb
+- spec/spec_methods.rb