rails_kvs_driver 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65825db278e173b70e7356bebb71e1706be19cbe
-  data.tar.gz: feb19bf2dcb02b2499395c27c71bb3523bb41dce
+  metadata.gz: 9739938d3667ed90c199b022fc20750e7d721218
+  data.tar.gz: 132108582e21c4d1b96a46fca297bdebcaa99c4c
 SHA512:
-  metadata.gz: 38119d7f68efb358baa88241b1a777102390b058110d760034539a6745e4edaad041bd455ea3679d8c0baa77483a950bf867ec16993fe08f851f0444c622eb75
-  data.tar.gz: 7fc6b26b52371aa7807240ebb1f06eadc10a8739b679c7e8dc8643857a8076b9a9481385f11d2b3051e32cc193391816b25e9fa33331ffe942d6355eafabeee1
+  metadata.gz: cf393acdf5228ceab39e2a73aa50ecaebabe089e9fed92f81685e59d75e9d1fd56a279b8f2f85c5070968df5c73894f33f0bfa427508f06a781dd1fd29df2fd2
+  data.tar.gz: a0b3a886926497d72bddf2467a7afbc02502e3b56b6a0ef2a65c6f0c33674a1e5058da3a060a86242a46d65c5d180166d9331b67998ca4fcd044f8a199827f0e

data/README.md

@@ -17,6 +17,7 @@ Or install it yourself as:
     $ gem install rails_kvs_driver
 
 ## Implementation
+driver class that extend RailsKvsDriver::Base
 
 * [rails_kvs_driver-redis_driver](https://github.com/alfa-jpn/rails_kvs_driver-redis_driver)
 

data/lib/rails_kvs_driver/defined_base_method.rb

@@ -1,4 +1,5 @@
-require 'rails_kvs_driver/sorted_set'
+require 'rails_kvs_driver/sorted_sets/sorted_sets'
+
 module RailsKvsDriver
   module DefinedBaseMethod
     # initialize driver.
@@ -9,11 +10,28 @@ module RailsKvsDriver
       @driver_config = driver_config
     end
 
+    # get string value from kvs.
+    # @param key [String] key.
+    # @return [String] value. when doesn't exist, nil
+    # @abstract get value from kvs. when doesn't exist, nil
+    def [](key)
+      get(key)
+    end
+
+    # set string value to kvs.
+    # @param key    [String] key.
+    # @param value  [String] value.
+    # @return [Boolean] result
+    # @abstract set value to kvs.
+    def []=(key, value)
+      set(key, value)
+    end
+
     # return initialized SortedSet class.
     #
-    # @return [RailsKvsDriver::SortedSet] SortedSet
+    # @return [RailsKvsDriver::SortedSets] SortedSet
     def sorted_sets
-      RailsKvsDriver::SortedSet.new(self)
+      SortedSets::SortedSets.new(self)
     end
 
     # execute the block of code for each key having string, and value.

data/lib/rails_kvs_driver/sorted_sets/sorted_set.rb

@@ -0,0 +1,93 @@
+module RailsKvsDriver
+  module SortedSets
+    class SortedSet
+      attr_accessor :driver_instance
+      attr_accessor :key
+
+      # initialize sorted_set
+      #
+      # @param driver_instance  [RailsKvsDriver::Base] instance of driver.
+      # @param key              [String] key of sorted_set.
+      def initialize(driver_instance, key)
+        @driver_instance = driver_instance
+        @key = key
+      end
+
+      # get score of member.
+      # when the key or member doesn't exist, return 0.
+      #
+      # @param member [String] member of sorted_set.
+      # @return [Integer] score.
+      def [](member)
+        @driver_instance.get_sorted_set_score(@key, member)
+      end
+
+      # add member in sorted_set.
+      # when the key doesn't exist, it's made newly.
+      #
+      # @param member [String]  member of sorted_set.
+      # @param score  [Flaot]   default score.
+      # @return [Float] score.
+      def []=(member, score)
+        @driver_instance.add_sorted_set(@key, member, score)
+        return score
+      end
+
+      # execute the block of code for each member of sorted set.
+      #
+      # @param reverse  [Boolean] order by desc. (default=false(acs))
+      # @param limit    [Integer] limit number to acquire at a time. (default=1000)
+      # @param &block   [{|member, score, position| }] each the block of code for each member of sorted set.
+      def each(reverse=false, limit=1000)
+        count    = length
+        position = 0
+
+        while position < count
+          @driver_instance.get_sorted_set(@key, position, position + (limit-1), reverse).each do |data|
+            yield data[0], data[1], position
+            position += 1
+          end
+        end
+      end
+
+      # check having member.
+      #
+      # @return [Boolean] result
+      def has_member?(member)
+        members.include?(member)
+      end
+
+      # increment member's score of sorted set.
+      #
+      # @param member [String]  member of sorted set.
+      # @param score  [Float]   increment score
+      # @return [Float] score after increment.
+      def increment(member, score)
+        @driver_instance.increment_sorted_set(@key, member, score)
+      end
+
+      # length of sorted_set
+      #
+      # @return [Integer] length of sorted_set
+      def length
+        @driver_instance.count_sorted_set_member(@key)
+      end
+
+      # get all member.
+      # @return [Array<String>] array of member.
+      def members
+        members = Array.new
+        each{|member| members.push(member)}
+        return members
+      end
+
+      # remove member of sorted_set.
+      #
+      # @param member [String] member of sorted_set.
+      def remove(member)
+        @driver_instance.remove_sorted_set(@key, member)
+      end
+
+    end
+  end
+end

data/lib/rails_kvs_driver/sorted_sets/sorted_sets.rb

@@ -0,0 +1,73 @@
+require 'rails_kvs_driver/sorted_sets/sorted_set'
+
+module RailsKvsDriver
+  module SortedSets
+    class SortedSets
+      attr_accessor :driver_instance
+
+      # initialize sorted_sets
+      #
+      # @param driver_instance [RailsKvsDriver::Base]
+      def initialize(driver_instance)
+        @driver_instance = driver_instance
+      end
+
+      # get sorted_set.
+      #
+      # @param key    [String] sorted_set key.
+      # @return [SortedSet] sorted_set of key.
+      def [](key)
+        SortedSet.new(@driver_instance, key)
+      end
+
+      # add new sorted_set.
+      # if key exists, delete old sorted_set.
+      #
+      # @param key [String] sorted_set key.
+      # @param member_sets [Array<Array<member,score>>] array of array of member<String> and score<Float>.
+      # @return [Array<Array<member,score>>] meber_sets
+      def []=(key, member_sets)
+        delete(key) if has_key?(key)
+        sorted_set = SortedSet.new(@driver_instance,key)
+        member_sets.each {|member_set| sorted_set[member_set[0]] = member_set}
+      end
+
+      # delete sorted_set.
+      #
+      # @param key [String] key of sorted_set.
+      def delete(key)
+        @driver_instance.delete(key)
+      end
+
+      # execute the block of code for each sorted_set.
+      #
+      # @param &block   [{|key| }] each the block of code for each key of sorted set.
+      def each
+        keys.each {|key| yield key }
+      end
+
+      # check key in sorted set.
+      #
+      # @param key [String] key name.
+      # @return [Boolean] result.
+      def has_key?(key)
+        keys.include?(key)
+      end
+
+      # get all keys from kvs.
+      #
+      # @return [Array<String>] array of key names.
+      def keys
+        @driver_instance.get_sorted_set_keys
+      end
+
+      # get length of sorted_set.
+      #
+      # @return [Integer] length of keys.
+      def length
+        keys.length
+      end
+
+    end
+  end
+end

data/lib/rails_kvs_driver/version.rb

@@ -1,3 +1,3 @@
 module RailsKvsDriver
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/rails_kvs_driver.rb

@@ -38,7 +38,7 @@ module RailsKvsDriver
     # @param key [String] key.
     # @return [String] value. when doesn't exist, nil
     # @abstract get value from kvs. when doesn't exist, nil
-    def [](key)
+    def get(key)
       raise NoMethodError
     end
 
@@ -47,7 +47,7 @@ module RailsKvsDriver
     # @param value  [String] value.
     # @return [Boolean] result
     # @abstract set value to kvs.
-    def []=(key, value)
+    def set(key, value)
       raise NoMethodError
     end
 
@@ -89,7 +89,8 @@ module RailsKvsDriver
     # @note same as sorted set of redis. refer to redis.
     #
     # @param key [String]  key of sorted set.
-    # @return [Integer] members num
+    # @return [Integer] members num. when doesn't exist key, return nil
+    # @abstract count members of sorted set. when doesn't exist key, return nil
     def count_sorted_set_member(key)
       raise NoMethodError
     end
@@ -108,8 +109,8 @@ module RailsKvsDriver
     end
 
     # get all sorted_set keys.
-    # @return [Array<String>] array of key names.
-    # @abstract get all keys from kvs.(only having sorted_set)
+    # @return [Array<String>] array of key names. when doesn't exist keys, return Array of length 0.
+    # @abstract get all keys from kvs.(only having sorted_set), when doesn't exist keys, return Array of length 0.
     def get_sorted_set_keys
       raise NoMethodError
     end
@@ -119,8 +120,8 @@ module RailsKvsDriver
     #
     # @param key    [String]  key of sorted set.
     # @param member [String]  member of sorted set.
-    # @return [Float] score of member.
-    # @abstract get the score of member.
+    # @return [Float] score of member. when doesn't exist key or member, nil.
+    # @abstract get the score of member. when doesn't exist key or member, nil.
     def get_sorted_set_score(key, member)
       raise NoMethodError
     end
@@ -131,8 +132,8 @@ module RailsKvsDriver
     # @param key    [String]  key of sorted set.
     # @param member [String]  member of sorted set.
     # @param score  [Float]   increment score.
-    # @return [Float] value after increment
-    # @abstract increment score of member from sorted set.
+    # @return [Float] value after increment. when doesn't exist key or member, create.
+    # @abstract increment score of member from sorted set. when doesn't exist key or member, create.
     def increment_sorted_set(key, member, score)
       raise NoMethodError
     end
@@ -143,8 +144,8 @@ module RailsKvsDriver
     #
     # @param key    [String]  key of sorted set.
     # @param member [String]  member of sorted set.
-    # @return [Boolean] result.
-    # @abstract remove sorted set from kvs.
+    # @return [Boolean] result. when doesn't exist key or member, false.
+    # @abstract remove sorted set from kvs. when doesn't exist key or member, do nothing.
     def remove_sorted_set(key, member)
       raise NoMethodError
     end

data/spec/common_example.rb

@@ -26,17 +26,17 @@ shared_examples_for 'RailsKvsDriver example' do |driver_class, driver_config|
     end
 
     context 'override methods' do
-      it 'call []' do
+      it 'call get' do
         driver_class::session(driver_config) do |kvs|
-          kvs['example'] = 'nico-nico'
-          expect(kvs['example']).to  eq('nico-nico')
-          expect(kvs['nothing key']).to be_nil
+          kvs.set('example', 'nico-nico')
+          expect(kvs.get('example')).to  eq('nico-nico')
+          expect(kvs.get('nothing key')).to be_nil
         end
       end
 
-      it 'call []=' do
+      it 'call set' do
         driver_class::session(driver_config) do |kvs|
-          expect{ kvs['example'] = 'nico-nico' }.to change{ kvs.keys.length }.by(1)
+          expect{ kvs.set('example', 'nico-nico') }.to change{ kvs.keys.length }.by(1)
         end
       end
 
@@ -156,6 +156,19 @@ shared_examples_for 'RailsKvsDriver example' do |driver_class, driver_config|
 
 
     context 'inheritance methods' do
+      it 'call []' do
+        driver_class::session(driver_config) do |kvs|
+          kvs['example'] = 'nico-nico'
+          expect(kvs['example']).to  eq('nico-nico')
+          expect(kvs['nothing key']).to be_nil
+        end
+      end
+
+      it 'call []=' do
+        driver_class::session(driver_config) do |kvs|
+          expect{ kvs['example'] = 'nico-nico' }.to change{ kvs.keys.length }.by(1)
+        end
+      end
 
       it 'call each' do
         driver_class::session(driver_config) do |kvs|

data/spec/rails_kvs_driver/defined_base_method_spec.rb

@@ -15,7 +15,7 @@ describe RailsKvsDriver::DefinedBaseMethod do
 
   context 'call sorted_sets' do
     it 'return instance of RailsKvsDriver::SortedSet' do
-      expect(MockDriver.new(nil,nil).sorted_sets.instance_of?(RailsKvsDriver::SortedSet)).to be_true
+      expect(MockDriver.new(nil,nil).sorted_sets.instance_of?(RailsKvsDriver::SortedSets::SortedSets)).to be_true
     end
   end
 

data/spec/rails_kvs_driver/sorted_sets/sorted_set_spec.rb

@@ -0,0 +1,61 @@
+require 'rspec'
+require 'spec_helper'
+
+describe RailsKvsDriver::SortedSets::SortedSet do
+
+  before(:each) do
+    @driver = MockDriver.new(nil,nil)
+    @driver.stub({
+        add_sorted_set:          nil,
+        count_sorted_set_member: 100,
+        delete:                  true,
+        get_sorted_set:          [[:a,:b],[:c,:d]],
+        get_sorted_set_keys:     [:a,:b,:c],
+        get_sorted_set_score:    100,
+        increment_sorted_set:    10,
+        remove_sorted_set:       true
+    })
+  end
+
+  it 'call []' do
+    expect(@driver.sorted_sets[:key][:member] = 1).to eq(1)
+  end
+
+  it 'call []=' do
+    expect(@driver.sorted_sets[:key][:member]).to eq(100)
+  end
+
+  it 'call length' do
+    expect(@driver.sorted_sets[:key].length).to eq(100)
+  end
+
+  it 'call each' do
+    count = 0
+    expect{
+      @driver.sorted_sets[:key].each(false, 10) do |member, score, position|
+        expect(position).to eq(count)
+        count += 1
+      end
+    }.to change{count}.by(100)
+  end
+
+  it 'call has_member?' do
+    expect(@driver.sorted_sets[:key].has_member?(:a)).to be_true
+  end
+
+  it 'call increment' do
+    expect( @driver.sorted_sets[:key].increment(:b, 1) ).to eq(10)
+  end
+
+  it 'call length' do
+    expect(@driver.sorted_sets[:key].length).to eq(100)
+  end
+
+  it 'call members' do
+    expect(@driver.sorted_sets[:key].members.length).to eq(100)
+  end
+
+  it 'call remove' do
+    expect(@driver.sorted_sets[:key].remove(:b)).to be_true
+  end
+end

data/spec/rails_kvs_driver/{sorted_set_spec.rb → sorted_sets/sorted_sets_spec.rb}

@@ -1,7 +1,7 @@
 require 'rspec'
 require 'spec_helper'
 
-describe RailsKvsDriver::SortedSet do
+describe RailsKvsDriver::SortedSets::SortedSets do
 
   before(:each) do
     @driver = MockDriver.new(nil,nil)
@@ -18,16 +18,12 @@ describe RailsKvsDriver::SortedSet do
   end
 
   it 'call []' do
-    expect((@driver.sorted_sets['hoge'] = ['test', 1])[0]).to eq('test')
+    sorted_set = [['member', 1],['member', 2]]
+    expect(@driver.sorted_sets[:key] = sorted_set).to eq(sorted_set)
   end
 
   it 'call []=' do
-    expect((@driver.sorted_sets['hoge'])[0][0]).to eq(:a)
-    expect(@driver.sorted_sets['hoge','fuga']).to eq(100)
-  end
-
-  it 'call count' do
-    expect(@driver.sorted_sets.count(:a)).to eq(100)
+    expect((@driver.sorted_sets[:key]).instance_of?(RailsKvsDriver::SortedSets::SortedSet)).to be_true
   end
 
   it 'call delete' do
@@ -43,37 +39,16 @@ describe RailsKvsDriver::SortedSet do
     }.to change{count}.by(3)
   end
 
-  it 'call each_member' do
-    count = 0
-    expect{
-      @driver.sorted_sets.each_member('test',false, 10) do |member, score, position|
-        expect(position).to eq(count)
-        count += 1
-      end
-    }.to change{count}.by(100)
-  end
-
-  it 'call increment_member' do
-    expect( @driver.sorted_sets.increment(:a, :b, 1) ).to eq(10)
-  end
-
-  it 'call keys' do
-    expect(@driver.sorted_sets.keys.length).to eq(3)
-  end
-
   it 'call has_key?' do
     expect(@driver.sorted_sets.has_key?(:a)).to be_true
   end
 
-  it 'call has_member?' do
-    expect(@driver.sorted_sets.has_member?(:a,:b)).to be_true
+  it 'call keys' do
+    expect(@driver.sorted_sets.keys.length).to eq(3)
   end
 
   it 'call length' do
     expect(@driver.sorted_sets.length).to eq(3)
   end
 
-  it 'call remove' do
-    expect(@driver.sorted_sets.remove(:a, :b)).to be_true
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_kvs_driver
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - alfa-jpn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,14 +96,16 @@ files:
 - lib/rails_kvs_driver.rb
 - lib/rails_kvs_driver/defined_base_method.rb
 - lib/rails_kvs_driver/session.rb
-- lib/rails_kvs_driver/sorted_set.rb
+- lib/rails_kvs_driver/sorted_sets/sorted_set.rb
+- lib/rails_kvs_driver/sorted_sets/sorted_sets.rb
 - lib/rails_kvs_driver/validation_driver_config.rb
 - lib/rails_kvs_driver/version.rb
 - rails_kvs_driver.gemspec
 - spec/common_example.rb
 - spec/rails_kvs_driver/defined_base_method_spec.rb
 - spec/rails_kvs_driver/session_spec.rb
-- spec/rails_kvs_driver/sorted_set_spec.rb
+- spec/rails_kvs_driver/sorted_sets/sorted_set_spec.rb
+- spec/rails_kvs_driver/sorted_sets/sorted_sets_spec.rb
 - spec/rails_kvs_driver/validate_driver_config_spec.rb
 - spec/rails_kvs_driver_spec.rb
 - spec/spec_helper.rb
@@ -136,7 +138,8 @@ test_files:
 - spec/common_example.rb
 - spec/rails_kvs_driver/defined_base_method_spec.rb
 - spec/rails_kvs_driver/session_spec.rb
-- spec/rails_kvs_driver/sorted_set_spec.rb
+- spec/rails_kvs_driver/sorted_sets/sorted_set_spec.rb
+- spec/rails_kvs_driver/sorted_sets/sorted_sets_spec.rb
 - spec/rails_kvs_driver/validate_driver_config_spec.rb
 - spec/rails_kvs_driver_spec.rb
 - spec/spec_helper.rb

data/lib/rails_kvs_driver/sorted_set.rb

@@ -1,124 +0,0 @@
-module RailsKvsDriver
-  class SortedSet
-    attr_accessor :driver_instance
-
-    # initialize sorted_set
-    #
-    # @param driver_instance [RailsKvsDriver::Base]
-    def initialize(driver_instance)
-      @driver_instance = driver_instance
-    end
-
-    # get sorted_set
-    # when the key doesn't exist, it's made newly.
-    #
-    # @param key    [String] sorted_set key.
-    # @param member [String] member of sorted_set.(default=nil)
-    # @return [Array<Array> or Integer] member_set[member, score]. when set member, return score of member.
-    def [](key, member=nil)
-      if member.nil?
-        @driver_instance.get_sorted_set(key)
-      else
-        @driver_instance.get_sorted_set_score(key, member)
-      end
-    end
-
-    # add sorted_set
-    # when the key doesn't exist, it's made newly.
-    #
-    # @param key [String] sorted_set key
-    # @param member_set [Array<member,score>] array of member<String> and score<Float>
-    # @return [Array] member_set
-    def []=(key, member_set)
-      @driver_instance.add_sorted_set(key, member_set[0], member_set[1])
-      return member_set
-    end
-
-    # count member of sorted_set
-    #
-    # @param key [String] sorted_set key
-    def count(key)
-      @driver_instance.count_sorted_set_member(key)
-    end
-
-    # delete key
-    #
-    # @param key [String] sorted_set key
-    def delete(key)
-      @driver_instance.delete(key)
-    end
-
-    # execute the block of code for each sorted_set.
-    # @param &block   [{|key| }] each the block of code for each key of sorted set.
-    def each
-      keys.each {|key| yield key }
-    end
-
-    # execute the block of code for each member of sorted set.
-    #
-    # @param key      [String]  key of sorted set.
-    # @param reverse  [Boolean] order by desc.
-    # @param limit    [Integer] limit number to acquire at a time.
-    # @param &block   [{|member, score, position| }] each the block of code for each member of sorted set.
-    def each_member(key, reverse=false, limit=1000)
-      member_count    = count(key)
-      member_position = 0
-
-      while member_position < member_count
-        @driver_instance.get_sorted_set(key, member_position, member_position + (limit-1), reverse).each do |data|
-          yield data[0], data[1], member_position
-          member_position += 1
-        end
-      end
-    end
-
-    # check key in sorted set.
-    #
-    # @param key [String] key name.
-    # @return [Boolean] result.
-    def has_key?(key)
-      !(self[key].nil?)
-    end
-
-    # check member in sorted set.
-    #
-    # @param key    [String] key name.
-    # @param member [String] member name.
-    # @return [Boolean] result.
-    def has_member?(key, member)
-      !(self[key, member].nil?)
-    end
-
-    # increment member's score of sorted set.
-    #
-    # @param key    [String]  key of sorted set.
-    # @param member [String]  member of sorted set.
-    # @param score  [Float]   increment score
-    # @return [Float] score after increment.
-    def increment(key, member, score)
-      @driver_instance.increment_sorted_set(key, member, score)
-    end
-
-    # get all keys from kvs.
-    # @return [Array<String>] array of key names.
-    # @abstract get all keys from kvs.(only having string value)
-    def keys
-      @driver_instance.get_sorted_set_keys
-    end
-
-    # get length of sorted_set.
-    #
-    # @return [Integer] length of keys.
-    def length
-      keys.length
-    end
-
-    # remove member of sorted_set
-    #
-    # @param key    [String] sorted_set key
-    # @param member [String] member of sorted_se
-    def remove(key, member)
-      @driver_instance.remove_sorted_set(key, member)
-    end
-  end
-end