renoir 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c38bafe64d4e6e17eb9e8ac7bfda4518a16831f
-  data.tar.gz: 934d5766ccfa78fe3d7113f937ced20a2d9e1ae5
+  metadata.gz: fcf83e530a5859d415a1bbe367fcb3505f5ec96e
+  data.tar.gz: c06b4040a3d4639547d5ee7d9570b8009dd2babd
 SHA512:
-  metadata.gz: 29202c8ae95394db795908d472645f1134c04a50ead0833c6fd7c7348e3b251b4f9a9f2f12d0e91f621c041cd379430fdd0cb81e920f77467a103f629a6b73a5
-  data.tar.gz: 2521e02fd50177c9e2a380eb5025122177964d1d708ed4b2693873d417ec96771c27653a77271a326f4bae11b8aa9e956252dae49cce8c8c7ee0f113de89f07a
+  metadata.gz: 4cf573b2c5af35650da61f303f77e6b95d6aa42c29c547d4c5122123cbe4c1aad38c7f730d2e598b7e2c5130cc885b5033fddda5e77363cdf938ad2d943b3db1
+  data.tar.gz: a85045df90e31e5bab6e5685b231ae7d5e726b69ab788f08aa1c034308024064b49f32b4b0dfa4840f0175e8f52c3de35439dbe579bacbe25fb0bc731faf393d

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown -M redcarpet --no-private

data/lib/renoir.rb

@@ -2,9 +2,11 @@ require "renoir/version"
 require "renoir/client"
 
 module Renoir
+  # Base class of Renoir errors.
   class BaseError < RuntimeError
   end
 
+  # Error related to redirection.
   class RedirectionError < BaseError
   end
 end

data/lib/renoir/client.rb

@@ -19,6 +19,20 @@ module Renoir
       connection_adapter: :redis,
     }.freeze
 
+    # @option options [Array<String, Array<String, Fixnum>, Hash{String => Fixnum}>] :cluster_nodes
+    #   Array of hostnames and ports of cluster nodes. At least one node must be specified.
+    #   An element could be one of: `String` (`"127.0.0.1:6379"`), `Array` (`["127.0.0.1", 6379]`) or
+    #   `Hash` (`{ host: "127.0.0.1", port: 6379 }`).
+    #   Defaults to `[["127.0.0.1", 6379]]`.
+    # @option options [Fixnum] :max_redirection Max number of MOVED/ASK redirections. Defaults to `10`.
+    # @option options [Fixnum] :max_connection_error
+    #   Max number of reconnections for connection errors. Defaults to `5`.
+    # @option options [Float] :connect_retry_random_factor A factor of reconnection interval. Defaults to `0.1`.
+    # @option options [Float] :connect_retry_interval
+    #   A base interval (seconds) of reconnection. Defaults to `0.001`, i.e., 1 ms.
+    # @option options [String, Symbol] :connection_adapter
+    #   Adapter name of a connection used by client. Defaults to `:redis`.
+    # @option options [Logger] :logger A logger. Defaults to `nil`.
     def initialize(options)
       @connections = {}
       @cluster_info = ClusterInfo.new
@@ -50,10 +64,22 @@ module Renoir
       @refresh_slots_mutex = Mutex.new
     end
 
+    # Call EVAL command.
+    #
+    # @param [Array] args arguments of EVAL passed to a connection backend
+    # @yield [Object] a connection backend may yield
+    # @raise [Renoir::RedirectionError] when too many redirections
+    # @return the value returned by a connection backend
     def eval(*args, &block)
       call(:eval, *args, &block)
     end
 
+    # Pipeline commands and call them with MULTI/EXEC.
+    #
+    # @yield [Renoir::Pipeline] A command pipeliner which has almost compatible interfaces with {Renoir::Client}.
+    # @return the value returned by a connection backend
+    # @raise [Renoir::RedirectionError] when too many redirections
+    # @note Return value of {Renoir::Pipeline} methods is useless since "future variable" is not yet supported.
     def multi(&block)
       commands = pipeline_commands(&block)
       slot = get_slot_from_commands(commands)
@@ -62,6 +88,12 @@ module Renoir
       call_with_redirection(slot, [[:multi]] + commands + [[:exec]])
     end
 
+    # Pipeline commands and call them.
+    #
+    # @yield [Renoir::Pipeline] A command pipeliner which has almost compatible interfaces with {Renoir::Client}.
+    # @return the value returned by a connection backend
+    # @raise [Renoir::RedirectionError] when too many redirections
+    # @note Return value of {Renoir::Pipeline} methods is useless since "future variable" is not yet supported.
     def pipelined(&block)
       commands = pipeline_commands(&block)
       slot = get_slot_from_commands(commands)
@@ -70,6 +102,12 @@ module Renoir
       call_with_redirection(slot, commands)
     end
 
+    # Call a Redis command.
+    #
+    # @param [Array] command a Redis command passed to a connection backend
+    # @yield [Object] a connection backend may yield
+    # @return the value returned by a connection backend
+    # @raise [Renoir::RedirectionError] when too many redirections
     def call(*command, &block)
       slot = get_slot_from_commands([command])
 
@@ -77,15 +115,21 @@ module Renoir
       call_with_redirection(slot, [command], &block)[0]
     end
 
+    # Close all holding connections.
     def close
       while entry = @connections.shift
         entry[1].close
       end
     end
 
+    # Enumerate connections of cluster nodes.
+    #
+    # @yield [Object] an connection instance of connection backend
+    # @return [Enumerable]
     def each_node
       return enum_for(:each_node) unless block_given?
 
+      refresh_slots
       @cluster_info.nodes.each do |node|
         fetch_connection(node).with_raw_connection do |conn|
           yield conn
@@ -93,6 +137,7 @@ module Renoir
       end
     end
 
+    # Delegated to {#call}.
     def method_missing(command, *args, &block)
       call(command, *args, &block)
     end

data/lib/renoir/cluster_info.rb

@@ -1,4 +1,5 @@
 module Renoir
+  # Store cluster information.
   class ClusterInfo
     class << self
       def node_name(host, port)

data/lib/renoir/connection_adapters.rb

@@ -1,6 +1,8 @@
 require "renoir/connection_adapters/reply"
 
 module Renoir
+  # Adapter of backend Redis connection. {Renoir::Client} communicates with a
+  # backend connection through a corresponding adapter.
   module ConnectionAdapters
     autoload :Redis, "renoir/connection_adapters/redis"
   end

data/lib/renoir/connection_adapters/base.rb

@@ -1,20 +1,34 @@
 module Renoir
   module ConnectionAdapters
+    # Abstract class.
     class Base
       class << self
+        # Return keys in a `command`.
+        #
+        # @param [Array] command a command argument
+        # @return [Array<String>] keys
         def get_keys_from_command(command)
           fail "a connection adapter must override #get_keys_from_command"
         end
       end
 
+      # Call pipelined commands.
+      #
+      # @param [Array<Array>] commands list of commands.
+      # @param [Boolean] asking Call ASKING command at first if `true`
+      # @yield [Object] a connection backend may yield
       def call(commands, asking=false, &block)
         fail "a connection adapter must override #call"
       end
 
+      # Close a backend connection.
       def close
         fail "a connection adapter must override #close"
       end
 
+      # Return a backend connection.
+      #
+      # @return [Object] a backend connection instance
       def with_raw_connection
         fail "a connection adapter must override #with_raw_connection"
       end

data/lib/renoir/connection_adapters/redis.rb

@@ -3,6 +3,7 @@ require "renoir/connection_adapters/base"
 
 module Renoir
   module ConnectionAdapters
+    # Connection adapter for {https://rubygems.org/gems/redis}.
     class Redis < Base
       class << self
         def get_keys_from_command(command)

data/lib/renoir/connection_adapters/reply.rb

@@ -1,5 +1,6 @@
 module Renoir
   module ConnectionAdapters
+    # Reply for {Renoir::Client}.
     module Reply
       class Base
         attr_reader :cause

data/lib/renoir/crc16.rb

@@ -1,18 +1,18 @@
-# This is the CRC16 algorithm used by Redis Cluster to hash keys.
-# Implementation according to CCITT standards.
-#
-# This is actually the XMODEM CRC 16 algorithm, using the
-# following parameters:
-#
-# Name                       : "XMODEM", also known as "ZMODEM", "CRC-16/ACORN"
-# Width                      : 16 bit
-# Poly                       : 1021 (That is actually x^16 + x^12 + x^5 + 1)
-# Initialization             : 0000
-# Reflect Input byte         : False
-# Reflect Output CRC         : False
-# Xor constant to output CRC : 0000
-# Output for "123456789"     : 31C3
 module Renoir
+  # This is the CRC16 algorithm used by Redis Cluster to hash keys.
+  # Implementation according to CCITT standards.
+  #
+  # This is actually the XMODEM CRC 16 algorithm, using the
+  # following parameters:
+  #
+  # - Name                       : "XMODEM", also known as "ZMODEM", "CRC-16/ACORN"
+  # - Width                      : 16 bit
+  # - Poly                       : 1021 (That is actually x^16 + x^12 + x^5 + 1)
+  # - Initialization             : 0000
+  # - Reflect Input byte         : False
+  # - Reflect Output CRC         : False
+  # - Xor constant to output CRC : 0000
+  # - Output for "123456789"     : 31C3
   module CRC16
     def self.crc16(bytes)
       crc = 0

data/lib/renoir/pipeline.rb

@@ -6,14 +6,19 @@ module Renoir
       @commands = []
     end
 
+    # Delegated to {#call}.
     def eval(*args)
       call(:eval, *args)
     end
 
+    # Store a command for pipelining.
+    #
+    # @param [Array] a Redis command passed to a connection backend
     def call(*command)
       @commands << command
     end
 
+    # Delegated to {#call}.
     def method_missing(command, *args, &block)
       call(command, *args, &block)
     end

data/lib/renoir/version.rb

@@ -1,3 +1,3 @@
 module Renoir
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renoir
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Hiroshi Saito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt