oxblood 0.1.0.dev10 → 0.1.0.dev11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa40f0d5b2f3279151d1689abb30900a658e4b42
-  data.tar.gz: 1dab3c062674dc0cacae8ed38bd54b01965fc962
+  metadata.gz: 8748b287262e6e3f061b9c4359472527f8c32937
+  data.tar.gz: a42f3aeea15b7220730a5fdd37bda6f73955b231
 SHA512:
-  metadata.gz: cca554b76261801ee8805aef706002efcfbed3412cf93105f74885b329e80b3d2632b1e53b586199bf610c0f584f856d744fd8eede3b6ccc58ac83b25c355b8d
-  data.tar.gz: 26168ad1e57c524f137374865648680f4d684f0ea4ade6a71664cf9d7ee70507cfcfc5c9ab946e42bb91fd189ce7fd89218fbb2141453404d211a98a0785924b
+  metadata.gz: b39975b37b8b7c4ec046b42a4edef9a24e080c63fee98f3ac1455123409c60f4dccd4234200d05a7297847c7dd2d2c85b20266023e7b6502ef45eec69eeca648
+  data.tar.gz: 17fa53c914114183a3460edf8b64e127b5d379aab83ebc8bf97a9cbd35eb5062d9acc18010a6efba44e21e9331a216381357be57dc0f631a9cf473c9c403c6c2

data/.travis.yml

@@ -5,8 +5,10 @@ language: ruby
 rvm:
   - 2.2.5
   - 2.3.1
+  - 2.4.0
   - jruby-9.0.5.0
   - jruby-9.1.5.0
+  - jruby-9.1.7.0
 
 services:
   - redis-server

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -4,9 +4,8 @@
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/etehtsea/oxblood/master/frames)
 [![Build Status](https://travis-ci.org/etehtsea/oxblood.svg?branch=master)](https://travis-ci.org/etehtsea/oxblood)
 [![Code Climate](https://codeclimate.com/github/etehtsea/oxblood/badges/gpa.svg)](https://codeclimate.com/github/etehtsea/oxblood)
-[![Test Coverage](https://codeclimate.com/github/etehtsea/oxblood/badges/coverage.svg)](https://codeclimate.com/github/etehtsea/oxblood/coverage)
 
-An experimental Redis Ruby client.
+A straightforward Redis Ruby client.
 
 ## Compatibility
 
@@ -17,19 +16,19 @@ An experimental Redis Ruby client.
 
 - Commands:
   - Cluster (0/20)
-  - Connection
+  - [Connection](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Connection)
   - Geo (0/6)
-  - Hashes (14/15) (See [#3](https://github.com/etehtsea/oxblood/issues/3))
+  - [Hashes](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Hashes) (14/15) (See [#3])
   - HyperLogLog (0/3)
-  - Keys (18/22) (See [#4], [#6], [#7], [#8])
-  - Lists
+  - [Keys](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Keys) (18/22) (See [#4], [#6], [#7], [#8])
+  - [Lists](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Lists)
   - Pub/Sub (0/6)
   - Scripting (0/7)
-  - Server (2/31)
-  - Sets (14/15) (See [#10](https://github.com/etehtsea/oxblood/issues/10))
-  - Sorted Sets (15/21) (See [#12], [#13], [#14], [#15])
-  - Strings (23/24) (See [#16](https://github.com/etehtsea/oxblood/issues/16))
-  - Transaction (3/5) (See [#19])
+  - [Server](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Server) (2/31)
+  - [Sets](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Sets) (14/15) (See [#10])
+  - [Sorted Sets](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/SortedSets) (15/21) (See [#12], [#13], [#14], [#15])
+  - [Strings](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Strings) (23/24) (See [#16])
+  - [Transactions](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Transactions)
 - [Pipeling](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Pipeline)
 - [Connection pooling](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Pool)
 - [Connection resiliency](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/RSocket)
@@ -41,23 +40,23 @@ As a starting point please look at [Oxblood::Pool](http://www.rubydoc.info/githu
 Documentation and usage examples are available on [Rubydoc](http://rubydoc.info/github/etehtsea/oxblood/master/frames).
 
 ## Continuous Integration
-You can check CI status at [Travis CI](https://travis-ci.org/etehtsea/oxblood.svg?branch=master).
+You can check CI status at [Travis CI](https://travis-ci.org/etehtsea/oxblood).
 
 ## Contributing
-
 Bug reports and pull requests are welcome on [GitHub](https://github.com/etehtsea/oxblood).
 
-
 ## License
-
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+[#3]: https://github.com/etehtsea/oxblood/issues/3
 [#4]: https://github.com/etehtsea/oxblood/issues/4
 [#6]: https://github.com/etehtsea/oxblood/issues/6
 [#7]: https://github.com/etehtsea/oxblood/issues/7
 [#8]: https://github.com/etehtsea/oxblood/issues/8
+[#10]: https://github.com/etehtsea/oxblood/issues/10
 [#12]: https://github.com/etehtsea/oxblood/issues/12
 [#13]: https://github.com/etehtsea/oxblood/issues/13
 [#14]: https://github.com/etehtsea/oxblood/issues/14
 [#15]: https://github.com/etehtsea/oxblood/issues/15
+[#16]: https://github.com/etehtsea/oxblood/issues/16
 [#19]: https://github.com/etehtsea/oxblood/issues/19

data/lib/oxblood/commands/hashes.rb

@@ -1,9 +1,6 @@
 module Oxblood
   module Commands
     module Hashes
-      QUEUED = 'QUEUED'.freeze
-      private_constant :QUEUED
-
       # Removes the specified fields from the hash stored at key
       # @see http://redis.io/commands/hdel
       #
@@ -21,9 +18,9 @@ module Oxblood
       # @param [String] key under which hash is stored
       # @param [String] field to check for existence
       #
-      # @return [Boolean] do hash contains field or not
+      # @return [Integer] 1 if the hash contains field and 0 otherwise
       def hexists(key, field)
-        1 == run(:HEXISTS, key, field)
+        run(:HEXISTS, key, field)
       end
 
       # Get the value of a hash field
@@ -43,10 +40,10 @@ module Oxblood
       #
       # @param [String] key under which hash is stored
       #
-      # @return [Hash] of fields and their values
+      # @return [Array] list of fields and their values stored in the hash,
+      #   or an empty list when key does not exist.
       def hgetall(key)
-        response = run(:HGETALL, key)
-        response == 'QUEUED' ? response : Hash[*response]
+        run(:HGETALL, key)
       end
 
       # Increment the integer value of a hash field by the given number

data/lib/oxblood/commands/transactions.rb

@@ -1,13 +1,36 @@
 module Oxblood
   module Commands
+    # @see https://redis.io/topics/transactions
     module Transactions
       # Mark the start of a transaction block
       # @see http://redis.io/commands/multi
       #
+      # @example {#exec} will be executed automatically at the end of a block.
+      #   session.multi do
+      #     session.ping
+      #     session.ping
+      #   end
+      #   # => ['PONG', 'PONG']
+      #
+      # @example Blockless variant.
+      #   session.multi
+      #   session.incr(:counter0)
+      #   session.incr(:counter1)
+      #   session.exec
+      #
       # @return [String] 'OK'
       # @return [RError] if multi called inside transaction
       def multi
-        run(:MULTI)
+        response = run(:MULTI).tap do |resp|
+          connection.transaction_mode = true if resp == 'OK'
+        end
+
+        if block_given?
+          yield
+          exec
+        else
+          response
+        end
       end
 
       # Execute all commands issued after MULTI
@@ -17,7 +40,7 @@ module Oxblood
       #   in the atomic transaction
       # @return [nil] when WATCH was used and execution was aborted
       def exec
-        run(:EXEC)
+        run(:EXEC).tap { connection.transaction_mode = false }
       end
 
       # Discard all commands issued after MULTI
@@ -26,7 +49,30 @@ module Oxblood
       # @return [String] 'OK'
       # @return [RError] if called without transaction started
       def discard
-        run(:DISCARD)
+        run(:DISCARD).tap { connection.transaction_mode = false }
+      end
+
+      # Watch the given keys to determine execution of the MULTI/EXEC block
+      # @see https://redis.io/commands/watch
+      #
+      # @example
+      #   session.set(:cnt, 0)
+      #   session.watch(:cnt)
+      #   value = session.get(:cnt).to_i
+      #   value += 1
+      #   session.multi { session.set(:cnt, value) }
+      #   # => `['OK']` or `nil` if `cnt` was modified while was watched
+      # @return [String] 'OK'
+      def watch(*keys)
+        run(:WATCH, keys)
+      end
+
+      # Forget about all watched keys
+      # @see https://redis.io/commands/unwatch
+      #
+      # @return [String] 'OK'
+      def unwatch
+        run(:UNWATCH)
       end
     end
   end

data/lib/oxblood/connection.rb

@@ -1,4 +1,5 @@
 require 'oxblood/protocol'
+require 'oxblood/pipeline'
 require 'oxblood/rsocket'
 require 'oxblood/session'
 
@@ -9,6 +10,11 @@ module Oxblood
     #   @return [RSocket] resilient socket
     attr_reader :socket
 
+    # @!attribute [rw] transaction_mode
+    #   @return [Boolean] transaction status
+    # @api private
+    attr_accessor :transaction_mode
+
     # Initialize connection to Redis server
     #
     # @param [Hash] opts Connection options
@@ -23,6 +29,7 @@ module Oxblood
     #
     # @option opts [String] :path UNIX socket path
     def initialize(opts = {})
+      @in_transaction = false
       @socket = RSocket.new(opts)
 
       session = Session.new(self)
@@ -56,10 +63,12 @@ module Oxblood
       Protocol.parse(@socket)
     end
 
-    # Read several responses from server
-    # (see #read_response)
-    def read_responses(n)
-      Array.new(n) { read_response }
+    # Connection transaction status.
+    # @api private
+    #
+    # @return [Boolean, nil] transaction status
+    def in_transaction?
+      transaction_mode
     end
   end
 end

data/lib/oxblood/pipeline.rb

@@ -14,7 +14,7 @@ module Oxblood
   #   pipeline.echo('!')
   #   pipeline.sync # => ["ping", "PONG", "!"]
   class Pipeline
-    include Oxblood::Commands
+    include Commands
 
     attr_reader :connection
 
@@ -26,12 +26,9 @@ module Oxblood
     # Sends all commands at once and reads responses
     # @return [Array] of responses
     def sync
-      serialized_commands = @commands.map do |c|
-        Oxblood::Protocol.build_command(*c)
-      end
-
-      @connection.socket.write(serialized_commands.join)
-      @connection.read_responses(@commands.size)
+      serialized_commands = @commands.map { |c| Protocol.build_command(*c) }
+      connection.socket.write(serialized_commands.join)
+      Array.new(@commands.size) { connection.read_response }
     ensure
       @commands.clear
     end

data/lib/oxblood/pool.rb

@@ -39,29 +39,10 @@ module Oxblood
     #   end # => 'world'
     def with
       conn = @pool.checkout
-      yield Session.new(conn)
-    ensure
-      @pool.checkin if conn
-    end
-
-    # Run commands on a connection from pool. Connection is wrapped to
-    # the {Pipeline}. {Pipeline#sync} operation will be executed automatically
-    # at the end of a block.
-    # @yield [pipeline] provide {Pipeline} to a block
-    # @yieldreturn [Array] responses from all executed operations
-    #
-    # @example
-    #  pool = Oxblood::Pool.new(size: 8)
-    #  pool.pipelined do |pipeline|
-    #    pipeline.set('hello', 'world')
-    #    pipeline.get('hello')
-    #  end # => ['OK', 'world']
-    def pipelined
-      conn = @pool.checkout
-      pipeline = Pipeline.new(conn)
-      yield pipeline
-      pipeline.sync
+      session = Session.new(conn)
+      yield(session)
     ensure
+      session.discard if conn.in_transaction?
       @pool.checkin if conn
     end
   end

data/lib/oxblood/session.rb

@@ -13,7 +13,7 @@ module Oxblood
   #   session = Oxblood::Session.new(conn)
   #   session.ping # => 'PONG'
   class Session
-    include Oxblood::Commands
+    include Commands
 
     attr_reader :connection
 
@@ -21,6 +21,26 @@ module Oxblood
       @connection = connection
     end
 
+    # Send queries using pipelining.
+    # Sync operation will be executed automatically at the end of a block.
+    #
+    # @see https://redis.io/topics/pipelining
+    #
+    # @yield [pipeline] provide {Pipeline} to a block
+    # @yieldreturn [Array] responses from all executed operations
+    #
+    # @example
+    #  session = Oxblood::Session.new(Oxblood::Connection.new)
+    #  session.pipelined do |pipeline|
+    #    pipeline.set('hello', 'world')
+    #    pipeline.get('hello')
+    #  end # => ['OK', 'world']
+    def pipelined
+      pipeline = Pipeline.new(connection)
+      yield pipeline
+      pipeline.sync
+    end
+
     private
 
     def run(*command)

data/lib/oxblood/version.rb

@@ -1,3 +1,3 @@
 module Oxblood
-  VERSION = '0.1.0.dev10'
+  VERSION = '0.1.0.dev11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxblood
 version: !ruby/object:Gem::Version
-  version: 0.1.0.dev10
+  version: 0.1.0.dev11
 platform: ruby
 authors:
 - Konstantin Shabanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Ruby Redis client