rails_kvs_driver-redis_driver 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19b774e652fcdea5cf78fc12325f96fc03c7df24
-  data.tar.gz: 918da4d9464f9c98a0744d794a97f351150e31cb
+  metadata.gz: c001226ab448872b0d2b7a17f30bdfdcf00af159
+  data.tar.gz: 0d2fe48bbd9e808d190300bba6e527b5047e44d7
 SHA512:
-  metadata.gz: a5eaec9a5f0a3997e45bdf447f7b360de964abc3584755e67a11472598ac36b303067ac2e79c5da90d0e95b52c9447cc87100905d710490f92b53b2f1bce8c33
-  data.tar.gz: d9dda9ccf5209ed60e8f5188634bc67f25a2270906ca8cd48e4e0ee5cbc24226ad7b333bab81bd9146cce5a13cadaba0b6c9ae737575ce7c3666a02eb4ed0bd9
+  metadata.gz: 912b2a9462cf935c58ffa07a3780c97fc5213639b738631bfa02478830606d225b02e32367ec759d9b6055ed28246f0f458ccb386c6dddddfcd3cc21ce7cb332
+  data.tar.gz: 84f4a5967058cb0e5596bb2b630094f5dbd067274d672c769a0081661c409283c64b117dc3bc83517b81eed9fda09542183c244a0fac9c6ce0316304d1d7e60e

data/README.md

@@ -36,6 +36,8 @@ driver_config = {
 ### connect and exec basic (set/get/delete)
 session method enables connection pool.
 ``` ruby
+You can use Enumerable.
+
 RailsKvsDriver::RedisDriver::Driver::session(driver_config) do |redis|
   
   # set key to redis.
@@ -66,17 +68,70 @@ RailsKvsDriver::RedisDriver::Driver::session(driver_config) do |redis|
 end
 ```
 
+### list
+``` ruby
+lists include Enumerable.
+
+RailsKvsDriver::RedisDriver::Driver::session(driver_config) do |redis|
+
+  # set value to list.
+  redis.lists['anime'][0]   = 'nyarukosan'
+  redis.lists['anime'][1]   = 'kinnmoza'
+  redis.lists['anime'][2]   = 'outbreakcompany'
+
+  # or can use this.
+  redis.lists['fruit'] = [:apple, :orange]
+
+
+  # get value of list.
+  puts redis.lists['anime'][0] # => 'nyarukosan'
+
+
+  # execute the block of code for each keys.
+  redis.lists.each do {|key| puts key }  # => anime fruit
+
+  # execute the block of code for each member of list.
+  redis.lists['anime'].each do |index, value|
+    puts "#{index}: #{value}." # => '0: nyarukosan.'
+                               # => '1: kinnmoza.'
+                               # => '2: outbreakcompany.'
+  end
+
+  # get all keys
+  redis.lists.keys? # => ['anime', 'fruit']
+
+  # length of sorted set.
+  redis.lists.length # => 2
+
+  # length member of sorted set.
+  redis.lists['anime'].length # => 3
+
+
+  # delete key
+  redis.lists.delete('fruit')
+
+  # remove member of list.
+  redis.lists['anime'].delete('kinnmoza')
+
+  # or can use this.
+  redis.lists['anime'].delete_at(1)
+
+end
+```
+
 ### sorted set
 ``` ruby
+sorted_sets include Enumerable.
+
 RailsKvsDriver::RedisDriver::Driver::session(driver_config) do |redis|
   
   # set member to redis.
   redis.sorted_sets['anime']['nyarukosan']   = 10
-  redis.sorted_sets['anime']['nonnonbiyori'] = 10
-  redis.sorted_sets['anime']['kiniromosaic'] = 10
+  redis.sorted_sets['anime']['nonnonbiyori'] =  5
+  redis.sorted_sets['anime']['kiniromosaic'] =  1
 
   # or can use this.
-  redis.sorted_set['fruit'] = [['apple', 1], [orange, 2]]
+  redis.sorted_set['fruit'] = [['apple', 1], ['orange', 2]]
 
 
   # get score of member.

data/lib/rails_kvs_driver/redis_driver.rb

@@ -47,6 +47,136 @@ module RailsKvsDriver::RedisDriver
       keys_with_type('string')
     end
 
+
+    #--------------------
+    # list (same as list of redis. refer to redis.)
+    #--------------------
+
+    # count value of the list.
+    # when the key doesn't exist, return 0.
+    #
+    # @param key [String] key of the list.
+    # @return [Integer] number.
+    # @abstract count value of the list.
+    def count_list_value(key)
+      @kvs_instance.llen(safe_key(key))
+    end
+
+    # delete value from list.
+    #
+    # @param key    [String] key of the list.
+    # @param value  [String] delete value.
+    # @abstract delete value from list.
+    def delete_list_value(key, value)
+      @kvs_instance.lrem(safe_key(key), 0, value)
+    end
+
+    # delete at index from list.
+    #
+    # @param key    [String] key of the list.
+    # @param index  [Integer] index of the list.
+    # @abstract delete at index from list.
+    def delete_list_value_at(key, index)
+      back_list = get_list_values(key, index+1)
+
+      if index > 0
+        @kvs_instance.ltrim(safe_key(key), 0, index-1)
+      else
+        delete(key)
+      end
+
+      back_list.each {|value| push_list_last(key, value) }
+    end
+
+    # get all keys of existed list.
+    #
+    # @return [Array<String>] keys.
+    # @abstract get all keys of existed list.
+    def get_list_keys
+      keys_with_type('list')
+    end
+
+    # get value from index of the list.
+    # when the key doesn't exist, return nil.
+    #
+    # @param key    [String] key of the list.
+    # @param index  [Integer] index of the list.
+    # @return [String] value.
+    # @abstract get value from index of the list.
+    def get_list_value(key, index)
+      @kvs_instance.lindex(safe_key(key), index)
+    end
+
+    # get values from index of the list.
+    # @example get_list_value(:key) => get all.
+    # @example get_list_value(:key, 5, 10) => 5~10 return total 6 values.
+    #
+    # @param key    [String]  key of the list.
+    # @param start  [Integer] start index of the list.
+    # @param stop   [Integer] end index of the list.
+    # @return [Array<String>] value.
+    # @abstract get values from index of the list.
+    def get_list_values(key, start = 0, stop = -1)
+      @kvs_instance.lrange(safe_key(key), start, stop)
+    end
+
+    # push value to first of the list.
+    # when the key doesn't exist, it's made newly list.
+    #
+    # @param key    [String] key of list.
+    # @param value  [String] push value.
+    # @return [Integer] length of list after push.
+    # @abstract push value to first of the list.
+    def push_list_first(key, value)
+      @kvs_instance.lpush(safe_key(key), value)
+    end
+
+    # push value to last of the list.
+    # when the key doesn't exist, it's made newly list.
+    #
+    # @param key    [String] key of list.
+    # @param value  [String] push value.
+    # @return [Integer] length of list after push.
+    # @abstract push value to last of the list.
+    def push_list_last(key, value)
+      @kvs_instance.rpush(safe_key(key), value)
+    end
+
+    # pop value from first of the list.
+    # when the key doesn't exist or is empty. return nil.
+    #
+    # @param key [String] key of the list.
+    # @return [String] value of the key.
+    # @abstract pop value from first of the list.
+    def pop_list_first(key)
+      @kvs_instance.lpop(safe_key(key))
+    end
+
+    # pop value from first of the list.
+    # when the key doesn't exist or is empty. return nil.
+    #
+    # @param key [String] key of the list.
+    # @return [String] value of the key.
+    # @abstract pop value from last of the list.
+    def pop_list_last(key)
+      @kvs_instance.rpop(safe_key(key))
+    end
+
+    # set value to index of the list.
+    #
+    # @param key    [String] key of the list.
+    # @param index  [Integer] index of the list.
+    # @param value  [String] set value.
+    def set_list_value(key, index, value)
+      @kvs_instance.lset(safe_key(key), index, value)
+    end
+
+
+
+    #--------------------
+    # sorted set (same as sorted set of redis. refer to redis.)
+    #--------------------
+
     # add sorted set to kvs.
     # when the key doesn't exist, it's made newly.
     # @note same as sorted set of redis. refer to redis.
@@ -76,7 +206,7 @@ module RailsKvsDriver::RedisDriver
     # @param stop     [Integer] stop index
     # @param reverse  [Boolean] order by desc
     # @return [Array<String, Float>>] array of the member and score. when doesn't exist, nil.
-    def get_sorted_set(key, start=0, stop=-1, reverse=false)
+    def get_sorted_set(key, start = 0, stop = -1, reverse=false)
       if reverse
         result = @kvs_instance.zrevrange(safe_key(key), start, stop, with_scores: true)
       else

data/lib/rails_kvs_driver/redis_driver/version.rb

@@ -1,5 +1,5 @@
 module RailsKvsDriver
   module RedisDriver
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/rails_kvs_driver-redis_driver.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
 
   spec.add_dependency "redis"
-  spec.add_dependency "rails_kvs_driver", "0.2.1"
+  spec.add_dependency "rails_kvs_driver", "0.3.1"
 end

data/spec/common_example.rb

@@ -40,23 +40,6 @@ shared_examples_for 'RailsKvsDriver example' do |driver_class, driver_config|
         end
       end
 
-      it 'call add_sorted_set' do
-        driver_class::session(driver_config) do |kvs|
-          expect{
-            kvs.add_sorted_set('example', 'element', 1)
-          }.to change{ kvs.get_sorted_set_keys.length }.by(1)
-        end
-      end
-
-      it 'call count_sorted_set_member' do
-        driver_class::session(driver_config) do |kvs|
-          kvs.add_sorted_set('example', 'element1', 5)
-          kvs.add_sorted_set('example', 'element2', 5)
-          kvs.add_sorted_set('example', 'element3', 5)
-          expect(kvs.count_sorted_set_member('example')).to eq(3)
-        end
-      end
-
       it 'call delete' do
         driver_class::session(driver_config) do |kvs|
           kvs['example']  = 'nico-nico'
@@ -78,6 +61,148 @@ shared_examples_for 'RailsKvsDriver example' do |driver_class, driver_config|
         end
       end
 
+      it 'call has_key?' do
+        driver_class::session(driver_config) do |kvs|
+          kvs['example'] = 'nico-nico'
+
+          expect(kvs.has_key?('example')).to be_true
+          expect(kvs.has_key?('nothing key')).to be_false
+        end
+      end
+
+      it 'call keys' do
+        driver_class::session(driver_config) do |kvs|
+          kvs['example0'] = 'nico-nico'
+          kvs['example1'] = 'nico-nico'
+          kvs.add_sorted_set('example_ss', 'element5', 5)
+
+          expect(kvs.keys.length).to eq(2)
+        end
+      end
+
+
+      #--------------------
+      # list (same as list of redis. refer to redis.)
+      #--------------------
+
+      it 'call count_list_value' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.push_list_last('anime', 'nyaruko')
+          kvs.push_list_last('anime', 'kinmoza')
+
+          expect(kvs.count_list_value('anime')).to eq(2)
+        end
+      end
+
+      it 'call delete_list_value' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.push_list_last('anime', 'nyaruko')
+          kvs.push_list_last('anime', 'kinmoza')
+          kvs.push_list_last('anime', 'hoge')
+
+          expect{
+            kvs.delete_list_value('anime', 'hoge')
+          }.to change{ kvs.count_list_value('anime') }.by(-1)
+          expect(kvs.get_list_values('anime').include?('hoge')).to be_false
+        end
+      end
+
+      it 'call delete_list_value_at 0' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.push_list_last('anime', 'hoge')
+          kvs.push_list_last('anime', 'nyaruko')
+          kvs.push_list_last('anime', 'kinmoza')
+
+          expect{
+            kvs.delete_list_value_at('anime', 0)
+          }.to change{ kvs.count_list_value('anime') }.by(-1)
+          expect(kvs.get_list_values('anime').include?('hoge')).to be_false
+        end
+      end
+
+      it 'call get_list_keys' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.push_list_last('anime', 'nyaruko')
+          kvs.push_list_last('anime', 'kinmoza')
+
+          expect(kvs.get_list_keys.length).to eq(1)
+        end
+      end
+
+      it 'call get_list_value' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.push_list_last('anime', 'nyaruko')
+          kvs.push_list_last('anime', 'kinmoza')
+
+          expect(kvs.get_list_value('anime', 0)).to eq('nyaruko')
+        end
+      end
+
+      it 'call get_list_values' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.push_list_last('anime', 'nyaruko')
+          kvs.push_list_last('anime', 'kinmoza')
+
+          expect(kvs.get_list_values('anime').length).to eq(2)
+        end
+      end
+
+      it 'call push_list_*' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.push_list_last('anime', 'nyaruko')
+          kvs.push_list_last('anime', 'kinmoza')
+          kvs.push_list_first('anime', 'inuhasa')
+
+          expect(kvs.get_list_value('anime', 2)).to eq('kinmoza')
+          expect(kvs.get_list_value('anime', 0)).to eq('inuhasa')
+        end
+      end
+
+      it 'call pop_list_*' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.push_list_last('anime', 'nyaruko')
+          kvs.push_list_last('anime', 'kinmoza')
+          kvs.push_list_first('anime', 'inuhasa')
+
+          expect{
+            expect(kvs.pop_list_first('anime')).to eq('inuhasa')
+            expect(kvs.pop_list_last('anime')).to eq('kinmoza')
+          }.to change{ kvs.count_list_value('anime') }.by(-2)
+        end
+      end
+
+      it 'call pop_list_*' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.push_list_last('anime', 'nyaruko')
+          kvs.push_list_last('anime', 'kinmoza')
+
+          kvs.set_list_value('anime', 1, 'inuhasa')
+
+          expect(kvs.get_list_value('anime', 1)).to eq('inuhasa')
+        end
+      end
+
+      #--------------------
+      # sorted set (same as sorted set of redis. refer to redis.)
+      #--------------------
+
+      it 'call add_sorted_set' do
+        driver_class::session(driver_config) do |kvs|
+          expect{
+            kvs.add_sorted_set('example', 'element', 1)
+          }.to change{ kvs.get_sorted_set_keys.length }.by(1)
+        end
+      end
+
+      it 'call count_sorted_set_member' do
+        driver_class::session(driver_config) do |kvs|
+          kvs.add_sorted_set('example', 'element1', 5)
+          kvs.add_sorted_set('example', 'element2', 5)
+          kvs.add_sorted_set('example', 'element3', 5)
+          expect(kvs.count_sorted_set_member('example')).to eq(3)
+        end
+      end
+
       it 'call get_sorted_set' do
         driver_class::session(driver_config) do |kvs|
           kvs.add_sorted_set('example', 'element1', 1)
@@ -121,25 +246,6 @@ shared_examples_for 'RailsKvsDriver example' do |driver_class, driver_config|
         end
       end
 
-      it 'call has_key?' do
-        driver_class::session(driver_config) do |kvs|
-          kvs['example'] = 'nico-nico'
-
-          expect(kvs.has_key?('example')).to be_true
-          expect(kvs.has_key?('nothing key')).to be_false
-        end
-      end
-
-      it 'call keys' do
-        driver_class::session(driver_config) do |kvs|
-          kvs['example0'] = 'nico-nico'
-          kvs['example1'] = 'nico-nico'
-          kvs.add_sorted_set('example_ss', 'element5', 5)
-
-          expect(kvs.keys.length).to eq(2)
-        end
-      end
-
       it 'call remove_sorted_set' do
         driver_class::session(driver_config) do |kvs|
           kvs.add_sorted_set('example', 'element', 1)
@@ -190,6 +296,128 @@ shared_examples_for 'RailsKvsDriver example' do |driver_class, driver_config|
         end
       end
 
+      context 'lists' do
+        before(:each) do
+          driver_class::session(driver_config) do |kvs|
+            kvs.push_list_last('anime', 'nyaruko')
+            kvs.push_list_last('anime', 'haganai')
+          end
+        end
+
+        it 'call[]' do
+          driver_class::session(driver_config) do |kvs|
+            expect(kvs.lists['anime'].instance_of?(RailsKvsDriver::Lists::List)).to be_true
+          end
+        end
+
+        it 'call []=' do
+          driver_class::session(driver_config) do |kvs|
+
+            expect{
+              kvs.lists['fruit'] = [:apple, :orange]
+            }.to change{
+              kvs.lists.length
+            }.by(1)
+
+            expect(kvs.lists['fruit'].length).to eq(2)
+          end
+        end
+
+        it 'call delete' do
+          driver_class::session(driver_config) do |kvs|
+            expect{kvs.lists.delete('anime')}.to change{kvs.lists.length}.by(-1)
+          end
+        end
+
+        it 'call each' do
+          driver_class::session(driver_config) do |kvs|
+            kvs.lists.each do |key|
+              expect(key).to eq('anime')
+            end
+          end
+        end
+
+        it 'call keys' do
+          driver_class::session(driver_config) do |kvs|
+            expect(kvs.lists.keys.length).to eq(1)
+          end
+        end
+
+        it 'call length' do
+          driver_class::session(driver_config) do |kvs|
+            expect(kvs.lists.length).to eq(1)
+          end
+        end
+
+        context 'lists' do
+          it 'call[]' do
+            driver_class::session(driver_config) do |kvs|
+              expect(kvs.lists['anime'][0]).to eq('nyaruko')
+            end
+          end
+
+          it 'call []=' do
+            driver_class::session(driver_config) do |kvs|
+              kvs.lists['anime'][1] = 'inuhasa'
+              expect(kvs.lists['anime'][1]).to eq('inuhasa')
+            end
+          end
+
+          it 'call delete' do
+            driver_class::session(driver_config) do |kvs|
+              expect{
+                kvs.lists['anime'].delete('nyaruko')
+              }.to change{ kvs.lists['anime'].length }.by(-1)
+              expect(kvs.lists['anime'][0]).to eq('haganai')
+            end
+          end
+
+          it 'call delete_at' do
+            driver_class::session(driver_config) do |kvs|
+              expect{
+                kvs.lists['anime'].delete_at(1)
+              }.to change{ kvs.lists['anime'].length }.by(-1)
+              expect(kvs.lists['anime'][0]).to eq('nyaruko')
+            end
+          end
+
+          it 'call each' do
+            driver_class::session(driver_config) do |kvs|
+              kvs.lists['anime'].each do |index, value|
+                expect(kvs.lists['anime'][index]).to eq(value)
+              end
+            end
+          end
+
+          it 'call each' do
+            driver_class::session(driver_config) do |kvs|
+              kvs.lists['anime'].each do |index, value|
+                expect(kvs.lists['anime'][index]).to eq(value)
+              end
+            end
+          end
+
+          it 'call include?' do
+            driver_class::session(driver_config) do |kvs|
+              expect(kvs.lists['anime'].include?('nyaruko')).to      be_true
+              expect(kvs.lists['anime'].include?('konnanonaiyo')).to be_false
+            end
+          end
+
+          it 'call push pop' do
+            driver_class::session(driver_config) do |kvs|
+              kvs.lists['anime'].push_first('rozen')
+              kvs.lists['anime'].push_last('maiden')
+
+              expect(kvs.lists['anime'].pop_first).to eq('rozen')
+              expect(kvs.lists['anime'].pop_last).to  eq('maiden')
+            end
+          end
+        end
+
+      end
+
+
       context 'sorted_sets' do
         before(:each) do
           driver_class::session(driver_config) do |kvs|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_kvs_driver-redis_driver
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - alfa-jpn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.1
 description: rails_kvs_driver is available to use namespace and connection pool and
   ruby-like methods of kvs.
 email: