rediska 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b301b8b105df4ba9c093329e391077669b638b2
-  data.tar.gz: 431df3d4c271b26c2948caaf935d899995b1d08b
+  metadata.gz: ff4d9d58f4f006fea6fbfc2f1eac33122ef9aa12
+  data.tar.gz: 8bfbf422868e1e4bb2d9bf94d6418149ce8db266
 SHA512:
-  metadata.gz: 6a59ee0d6021e31f320878d096bec22a9e1684ada257d0684f6526b8ebb29fb29e9370819afbcbb3eab41c2b3c2642db0709d83158a6a157cf98fb7374d5a127
-  data.tar.gz: 00eb3278e5015604341c4f69836db7524ab8e5d1b509ee4c99bda1e070999a01469da528b8f62e5b30e9a126430edd97f48eca5bcdfcc97115dbdb2b60503774
+  metadata.gz: a343ab5b453ace36f23d5fc451b3a99ac49db6a287c2c6cd1a8e2b82bf1cba937a19a07e0995ddfd65876da96ffdd9076524b3eb8f7e78c82e2d0cb0de31c937
+  data.tar.gz: 3e7ff21587df7a01876ec277e17c90e75cfd0723e13a154e1108e7359ed98e54a18792345a4c314e566913d450b85e520eed6e035e84add2b6dd15546e9985e9

data/README.md

@@ -73,6 +73,9 @@ end
 * BITCOUNT
 * BGSAVE
 * BGREWRITEAOF
+* BLPOP
+* BRPOP
+* BRPOPLPUSH
 * DBSIZE
 * DECR
 * DECRBY

data/lib/rediska/bitop.rb

@@ -0,0 +1,56 @@
+module Rediska
+  module Bitop
+    BIT_OPERATORS = {
+      'or'  => :|,
+      'and' => :&,
+      'xor' => :'^',
+      'not' => :~,
+    }
+
+    def bitop(operation, destkey, *keys)
+      if result = apply(operator(operation), keys)
+        set(destkey, result)
+        result.length
+      else
+        0
+      end
+    rescue ArgumentError => _
+      raise_argument_error('bitop')
+    end
+
+    private
+
+    def operator(operation)
+      BIT_OPERATORS[operation.to_s.downcase]
+    end
+
+    def apply(operator, keys)
+      case operator
+      when :~
+        raise ArgumentError if keys.count != 1
+        bitwise_not(keys.first)
+      when :&, :|, :'^'
+        raise ArgumentError if keys.empty?
+        bitwise_operation(operator, keys)
+      else
+        raise ArgumentError
+      end
+    end
+
+    def bitwise_not(key)
+      if value = get(keys.first)
+        value.bytes.map { |byte| ~ byte }.pack('c*')
+      end
+    end
+
+    def bitwise_operation(operation, keys)
+      apply_onto, *values = keys.map { |key| get(key) }.reject(&:nil?)
+      values.reduce(apply_onto) do |memo, value|
+        shorter, longer = [memo, value].sort_by(&:length).map(&:bytes).map(&:to_a)
+        longer.each_with_index.map do |byte, index|
+          byte.send(operation, shorter[index] || 0)
+        end.pack('c*')
+      end
+    end
+  end
+end

data/lib/rediska/connection.rb

@@ -4,6 +4,7 @@ require 'rediska/sort_method'
 require 'rediska/sorted_set_argument_handler'
 require 'rediska/sorted_set_store'
 require 'rediska/zset'
+require 'rediska/bitop'
 require 'rediska/driver'
 require 'rediska/command_executor'
 require 'rediska/transaction_commands'
@@ -12,6 +13,7 @@ module Rediska
   class Connection
     include Driver
     include SortMethod
+    include Bitop
     include TransactionCommands
     include CommandExecutor
 

data/lib/rediska/driver.rb

@@ -25,9 +25,6 @@ module Rediska
     end
 
     # NOT IMPLEMENTED:
-    # * blpop
-    # * brpop
-    # * brpoplpush
     # * subscribe
     # * psubscribe
     # * publish
@@ -301,6 +298,8 @@ module Rediska
     end
 
     def rpush(key, value)
+      raise_argument_error('rpush') if value.respond_to?(:each) && value.empty?
+
       data_type_check(key, Array)
       data[key] ||= []
       [value].flatten.each do |val|
@@ -310,12 +309,16 @@ module Rediska
     end
 
     def rpushx(key, value)
+      raise_argument_error('rpushx') if value.respond_to?(:each) && value.empty?
+
       data_type_check(key, Array)
       return unless data[key]
       rpush(key, value)
     end
 
     def lpush(key, value)
+      raise_argument_error('lpush') if value.respond_to?(:each) && value.empty?
+
       data_type_check(key, Array)
       data[key] ||= []
       [value].flatten.each do |val|
@@ -325,6 +328,8 @@ module Rediska
     end
 
     def lpushx(key, value)
+      raise_argument_error('lpushx') if value.respond_to?(:each) && value.empty?
+
       data_type_check(key, Array)
       return unless data[key]
       lpush(key, value)
@@ -336,6 +341,17 @@ module Rediska
       data[key].pop
     end
 
+    def brpop(keys, timeout = 0)
+      keys = Array(keys)
+      keys.each do |key|
+        if data[key] && data[key].size > 0
+          return [key, data[key].pop]
+        end
+      end
+      sleep(timeout.to_f)
+      nil
+    end
+
     def rpoplpush(key1, key2)
       data_type_check(key1, Array)
       rpop(key1).tap do |elem|
@@ -343,12 +359,30 @@ module Rediska
       end
     end
 
+    def brpoplpush(key1, key2, opts = {})
+      data_type_check(key1, Array)
+      brpop(key1).tap do |elem|
+        lpush(key2, elem) unless elem.nil?
+      end
+    end
+
     def lpop(key)
       data_type_check(key, Array)
       return unless data[key]
       data[key].shift
     end
 
+    def blpop(keys, timeout = 0)
+      keys = Array(keys)
+      keys.each do |key|
+        if data[key] && data[key].size > 0
+          return [key, data[key].shift]
+        end
+      end
+      sleep(timeout.to_f)
+      nil
+    end
+
     def smembers(key)
       data_type_check(key, ::Set)
       return [] unless data[key]

data/lib/rediska/version.rb

@@ -1,3 +1,3 @@
 module Rediska
-  VERSION = '0.2.7'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/spec/redis_spec.rb

@@ -12,6 +12,7 @@ shared_examples 'redis' do
   it_behaves_like 'transactions'
   it_behaves_like 'sorted sets'
   it_behaves_like 'upcase method names'
+  it_behaves_like 'bitop'
 
   it_behaves_like 'driver'
   it_behaves_like 'sidekiq'

data/spec/support/bitop.rb

@@ -0,0 +1,267 @@
+require 'spec_helper'
+
+shared_examples_for 'a bitwise operation' do |operator|
+  it 'raises an argument error when not passed any source keys' do
+    expect {
+      subject.bitop(operator, 'destkey')
+    }.to raise_error(Redis::CommandError)
+  end
+
+  it 'should not create destination key if nothing found' do
+    expect(subject.bitop(operator, 'dest1', 'nothing_here1')).to eq(0)
+    expect(subject.exists('dest1')).to be_falsy
+  end
+
+  it 'should accept operator as a case-insensitive symbol' do
+    subject.set('key1', 'foobar')
+    subject.bitop(operator.to_s.downcase.to_sym, 'dest1', 'key1')
+    subject.bitop(operator.to_s.upcase.to_sym, 'dest2', 'key1')
+
+    expect(subject.get('dest1')).to eq('foobar')
+    expect(subject.get('dest2')).to eq('foobar')
+  end
+
+  it 'should accept operator as a case-insensitive string' do
+    subject.set('key1', 'foobar')
+    subject.bitop(operator.to_s.downcase, 'dest1', 'key1')
+    subject.bitop(operator.to_s.upcase, 'dest2', 'key1')
+
+    expect(subject.get('dest1')).to eq('foobar')
+    expect(subject.get('dest2')).to eq('foobar')
+  end
+
+  it 'should copy original string for single key' do
+    subject.set('key1', 'foobar')
+    subject.bitop(operator, 'dest1', 'key1')
+
+    expect(subject.get('dest1')).to eq('foobar')
+  end
+
+  it 'should copy original string for single key' do
+    subject.set('key1', 'foobar')
+    subject.bitop(operator, 'dest1', 'key1')
+
+    expect(subject.get('dest1')).to eq('foobar')
+  end
+
+  it 'should return length of the string stored in the destination key' do
+    subject.set('key1', 'foobar')
+    subject.set('key2', 'baz')
+
+    expect(subject.bitop(operator, 'dest1', 'key1')).to eq(6)
+    expect(subject.bitop(operator, 'dest2', 'key2')).to eq(3)
+  end
+
+  it 'should overwrite previous value with new one' do
+    subject.set('key1', 'foobar')
+    subject.set('key2', 'baz')
+    subject.bitop(operator, 'dest1', 'key1')
+    subject.bitop(operator, 'dest1', 'key2')
+
+    expect(subject.get('dest1')).to eq('baz')
+  end
+end
+
+shared_examples 'bitop' do
+  it 'raises an argument error when passed unsupported operation' do
+    expect {
+      subject.bitop('meh', 'dest1', 'key1')
+    }.to raise_error(Redis::CommandError)
+  end
+
+  describe 'or' do
+    it_should_behave_like 'a bitwise operation', 'or'
+
+    it 'should apply bitwise or operation' do
+      subject.setbit('key1', 0, 0)
+      subject.setbit('key1', 1, 1)
+      subject.setbit('key1', 2, 1)
+      subject.setbit('key1', 3, 0)
+
+      subject.setbit('key2', 0, 1)
+      subject.setbit('key2', 1, 1)
+      subject.setbit('key2', 2, 0)
+      subject.setbit('key2', 3, 0)
+
+      expect(subject.bitop('or', 'dest1', 'key1', 'key2')).to eq(1)
+      expect(subject.bitcount('dest1')).to eq(3)
+      expect(subject.getbit('dest1', 0)).to eq(1)
+      expect(subject.getbit('dest1', 1)).to eq(1)
+      expect(subject.getbit('dest1', 2)).to eq(1)
+      expect(subject.getbit('dest1', 3)).to eq(0)
+    end
+
+    it 'should apply bitwise or operation with empty values' do
+      subject.setbit('key1', 1, 1)
+
+      expect(subject.bitop('or', 'dest1', 'key1', 'nothing_here1', 'nothing_here2')).to eq(1)
+      expect(subject.bitcount('dest1')).to eq(1)
+      expect(subject.getbit('dest1', 0)).to eq(0)
+      expect(subject.getbit('dest1', 1)).to eq(1)
+      expect(subject.getbit('dest1', 2)).to eq(0)
+    end
+
+    it 'should apply bitwise or operation with multiple keys' do
+      subject.setbit('key1', 1, 1)
+      subject.setbit('key1', 3, 1)
+
+      subject.setbit('key2', 5, 1)
+      subject.setbit('key2', 10, 1)
+
+      subject.setbit('key3', 13, 1)
+      subject.setbit('key3', 15, 1)
+
+      expect(subject.bitop('or', 'dest1', 'key1', 'key2', 'key3')).to eq(2)
+      expect(subject.bitcount('dest1')).to eq(6)
+      expect(subject.getbit('dest1', 1)).to eq(1)
+      expect(subject.getbit('dest1', 3)).to eq(1)
+      expect(subject.getbit('dest1', 5)).to eq(1)
+      expect(subject.getbit('dest1', 10)).to eq(1)
+      expect(subject.getbit('dest1', 13)).to eq(1)
+      expect(subject.getbit('dest1', 15)).to eq(1)
+      expect(subject.getbit('dest1', 2)).to eq(0)
+      expect(subject.getbit('dest1', 12)).to eq(0)
+    end
+  end
+
+  describe 'and' do
+    it_should_behave_like 'a bitwise operation', 'and'
+
+    it 'should apply bitwise and operation' do
+      subject.setbit('key1', 0, 1)
+      subject.setbit('key1', 1, 1)
+      subject.setbit('key1', 2, 0)
+
+      subject.setbit('key2', 0, 0)
+      subject.setbit('key2', 1, 1)
+      subject.setbit('key2', 2, 1)
+
+      expect(subject.bitop('and', 'dest1', 'key1', 'key2')).to eq(1)
+      expect(subject.bitcount('dest1')).to eq(1)
+      expect(subject.getbit('dest1', 0)).to eq(0)
+      expect(subject.getbit('dest1', 1)).to eq(1)
+      expect(subject.getbit('dest1', 2)).to eq(0)
+    end
+
+    it 'should apply bitwise and operation with empty values' do
+      subject.setbit('key1', 1, 1)
+
+      expect(subject.bitop('and', 'dest1', 'key1', 'nothing_here')).to eq(1)
+      expect(subject.bitcount('dest1')).to eq(1)
+      expect(subject.getbit('dest1', 0)).to eq(0)
+      expect(subject.getbit('dest1', 1)).to eq(1)
+      expect(subject.getbit('dest1', 2)).to eq(0)
+    end
+
+    it 'should apply bitwise and operation with multiple keys' do
+      subject.setbit('key1', 1, 1)
+      subject.setbit('key1', 2, 1)
+      subject.setbit('key1', 3, 1)
+      subject.setbit('key1', 4, 1)
+
+      subject.setbit('key2', 2, 1)
+      subject.setbit('key2', 3, 1)
+      subject.setbit('key2', 4, 1)
+      subject.setbit('key2', 5, 1)
+
+      subject.setbit('key3', 2, 1)
+      subject.setbit('key3', 4, 1)
+      subject.setbit('key3', 5, 1)
+      subject.setbit('key3', 6, 1)
+
+      expect(subject.bitop('and', 'dest1', 'key1', 'key2', 'key3')).to eq(1)
+      expect(subject.bitcount('dest1')).to eq(2)
+      expect(subject.getbit('dest1', 1)).to eq(0)
+      expect(subject.getbit('dest1', 2)).to eq(1)
+      expect(subject.getbit('dest1', 3)).to eq(0)
+      expect(subject.getbit('dest1', 4)).to eq(1)
+      expect(subject.getbit('dest1', 5)).to eq(0)
+      expect(subject.getbit('dest1', 6)).to eq(0)
+    end
+  end
+
+  describe 'xor' do
+    it_should_behave_like 'a bitwise operation', 'xor'
+
+    it 'should apply bitwise xor operation' do
+      subject.setbit('key1', 0, 0)
+      subject.setbit('key1', 1, 1)
+      subject.setbit('key1', 2, 0)
+      subject.setbit('key1', 3, 0)
+
+      subject.setbit('key2', 0, 1)
+      subject.setbit('key2', 1, 1)
+      subject.setbit('key2', 2, 1)
+      subject.setbit('key2', 3, 0)
+
+      expect(subject.bitop('xor', 'dest1', 'key1', 'key2')).to eq(1)
+      expect(subject.bitcount('dest1')).to eq(2)
+      expect(subject.getbit('dest1', 0)).to eq(1)
+      expect(subject.getbit('dest1', 1)).to eq(0)
+      expect(subject.getbit('dest1', 2)).to eq(1)
+      expect(subject.getbit('dest1', 3)).to eq(0)
+    end
+
+    it 'should apply bitwise xor operation with empty values' do
+      subject.setbit('key1', 1, 1)
+
+      expect(subject.bitop('xor', 'dest1', 'key1', 'nothing_here1', 'nothing_here2')).to eq(1)
+      expect(subject.bitcount('dest1')).to eq(1)
+      expect(subject.getbit('dest1', 0)).to eq(0)
+      expect(subject.getbit('dest1', 1)).to eq(1)
+      expect(subject.getbit('dest1', 2)).to eq(0)
+    end
+
+    it 'should apply bitwise xor operation with multiple keys' do
+      subject.setbit('key1', 1, 1)
+      subject.setbit('key1', 3, 1)
+      subject.setbit('key1', 5, 1)
+      subject.setbit('key1', 6, 1)
+
+      subject.setbit('key2', 2, 1)
+      subject.setbit('key2', 3, 1)
+      subject.setbit('key2', 4, 1)
+      subject.setbit('key2', 6, 1)
+
+      expect(subject.bitop('xor', 'dest1', 'key1', 'key2')).to eq(1)
+      expect(subject.bitcount('dest1')).to eq(4)
+      expect(subject.getbit('dest1', 1)).to eq(1)
+      expect(subject.getbit('dest1', 2)).to eq(1)
+      expect(subject.getbit('dest1', 3)).to eq(0)
+      expect(subject.getbit('dest1', 4)).to eq(1)
+      expect(subject.getbit('dest1', 5)).to eq(1)
+      expect(subject.getbit('dest1', 6)).to eq(0)
+    end
+  end
+
+  describe 'not' do
+    it 'raises an argument error when not passed any keys' do
+      expect {
+        subject.bitop('not', 'destkey')
+      }.to raise_error(Redis::CommandError)
+    end
+
+    it 'raises an argument error when not passed too many keys' do
+      expect {
+        subject.bitop('not', 'destkey', 'key1', 'key2')
+      }.to raise_error(Redis::CommandError)
+    end
+
+    it 'should apply bitwise negation operation' do
+      subject.setbit('key1', 1, 1)
+      subject.setbit('key1', 3, 1)
+      subject.setbit('key1', 5, 1)
+
+      expect(subject.bitop('not', 'dest1', 'key1')).to eq(1)
+      expect(subject.bitcount('dest1')).to eq(5)
+      expect(subject.getbit('dest1', 0)).to eq(1)
+      expect(subject.getbit('dest1', 1)).to eq(0)
+      expect(subject.getbit('dest1', 2)).to eq(1)
+      expect(subject.getbit('dest1', 3)).to eq(0)
+      expect(subject.getbit('dest1', 4)).to eq(1)
+      expect(subject.getbit('dest1', 5)).to eq(0)
+      expect(subject.getbit('dest1', 6)).to eq(1)
+      expect(subject.getbit('dest1', 7)).to eq(1)
+    end
+  end
+end

data/spec/support/lists.rb

@@ -200,4 +200,24 @@ shared_examples 'lists' do
     expect(subject.lrange('key1', 0, -1)).to eq(['one', 'two'])
     expect(subject.lrange('key2', 0, -1)).to be_empty
   end
+
+  it 'should not allow pushing empty list of objects' do
+    expect {
+      subject.lpush('key1', [])
+    }.to raise_error(Redis::CommandError, /lpush[^x]/)
+
+    expect {
+      subject.lpush('key1', 1)
+      subject.lpushx('key1', [])
+    }.to raise_error(Redis::CommandError, /lpushx/)
+
+    expect {
+      subject.rpush('key1', [])
+    }.to raise_error(Redis::CommandError, /rpush[^x]/)
+
+    expect {
+      subject.rpush('key1', 1)
+      subject.rpushx('key1', [])
+    }.to raise_error(Redis::CommandError, /rpushx/)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rediska
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2015-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -97,6 +97,7 @@ files:
 - README.md
 - Rakefile
 - lib/rediska.rb
+- lib/rediska/bitop.rb
 - lib/rediska/command_executor.rb
 - lib/rediska/configuration.rb
 - lib/rediska/connection.rb
@@ -114,6 +115,7 @@ files:
 - rediska.gemspec
 - spec/redis_spec.rb
 - spec/spec_helper.rb
+- spec/support/bitop.rb
 - spec/support/compatibility.rb
 - spec/support/connection.rb
 - spec/support/driver.rb
@@ -155,6 +157,7 @@ summary: A light-weighted redis driver for testing, development, and minimal env
 test_files:
 - spec/redis_spec.rb
 - spec/spec_helper.rb
+- spec/support/bitop.rb
 - spec/support/compatibility.rb
 - spec/support/connection.rb
 - spec/support/driver.rb