oxblood 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27d328641bcf1ed89164aeb5288e6f9280ca6127
-  data.tar.gz: fbf311595af5e1bb6fc0a582f7d1a799168399f0
+  metadata.gz: 914d269f92807d5e874e813be77ad7a325fa6b86
+  data.tar.gz: e8ec8e0a92d5ccc93a48271b0b44545cdc38a365
 SHA512:
-  metadata.gz: 9876df90dcd7a807fe2bbcf9b7ef9a8068a08dd80943d7c0fd8808883ab99986d954d078215c7794a52dfeeb707b97f56e4b1f8976ee3ede87e5d5bf7b064e84
-  data.tar.gz: 82efd7dd0895e1275afdecdb6c47a46d95bf8b3550bbcb45e2f18a313c575a04097ad0f17f4ed284f88002ab1c2124310ce227290f22095d076d8e594218c657
+  metadata.gz: 6a5584d343e12974e664c75b094662c72b0cc63c6c660c1c6f305d8a8d2cd7de2fe6c7361acf648fa1db7da158e532967be0fee053454e9a6ad785eaa63ecc52
+  data.tar.gz: 2d7ca78e83a921687b56de218a0b57a1bac2a262a66fb8c33c1fb630b623691e610e53ecd01063342e363927d02fb4e77d5d084f675faf7746ba49263ee09424

data/.travis.yml

@@ -3,8 +3,8 @@ sudo: false
 language: ruby
 
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.2.6
+  - 2.3.3
   - 2.4.0
   - jruby-9.0.5.0
   - jruby-9.1.5.0

data/CHANGELOG.md

@@ -1,2 +1,15 @@
+## 0.2.0 (2017-01-18)
+  * [#13](https://github.com/etehtsea/oxblood/issues/13):
+    Added support for ZRANGEBYLEX/ZREMRANGEBYLEX/ZREVRANGEBYLEX - [@etehtsea](https://github.com/etehtsea)
+  * [#14](https://github.com/etehtsea/oxblood/issues/14):
+    Added support for ZINTERSTORE/ZUNIONSTORE - [@etehtsea](https://github.com/etehtsea)
+  * [#12](https://github.com/etehtsea/oxblood/issues/12):
+    Added support for ZADD options - [@etehtsea](https://github.com/etehtsea)
+  * [#3](https://github.com/etehtsea/oxblood/issues/3),
+    [#8](https://github.com/etehtsea/oxblood/issues/8),
+    [#10](https://github.com/etehtsea/oxblood/issues/10),
+    [#15](https://github.com/etehtsea/oxblood/issues/15):
+    Implemented SCAN, HSCAN, SSCAN, ZSCAN commands - [@etehtsea](https://github.com/etehtsea)
+
 ## 0.1.0 (2017-01-18)
   * Initial public release - [@etehtsea](https://github.com/etehtsea)

data/README.md

@@ -18,15 +18,15 @@ A straightforward Redis Ruby client.
   - Cluster (0/20)
   - [Connection](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Connection)
   - Geo (0/6)
-  - [Hashes](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Hashes) (14/15) (See [#3])
+  - [Hashes](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Hashes)
   - [HyperLogLog](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/HyperLogLog)
-  - [Keys](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Keys) (18/22) (See [#4], [#6], [#7], [#8])
+  - [Keys](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Keys) (19/22) (See [#4], [#6], [#7])
   - [Lists](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Lists)
   - Pub/Sub (0/6)
   - Scripting (0/7)
   - [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])
+  - [Sets](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/Sets)
+  - [Sorted Sets](http://www.rubydoc.info/github/etehtsea/oxblood/master/Oxblood/Commands/SortedSets)
   - [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)
@@ -48,15 +48,8 @@ Bug reports and pull requests are welcome on [GitHub](https://github.com/etehtse
 ## 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,3 +1,5 @@
+require 'oxblood/commands/scan'
+
 module Oxblood
   module Commands
     module Hashes
@@ -166,6 +168,25 @@ module Oxblood
       def hvals(key)
         run(:HVALS, key)
       end
+
+      # Incrementally iterate hash fields and associated values
+      # @see https://redis.io/commands/hscan
+      #
+      # @param [Integer] cursor
+      # @param [Hash] opts
+      #
+      # @option opts [Integer] :count Amount of work that should be done at
+      #   every call in order to retrieve elements from the collection.
+      # @option opts [String] :match
+      #
+      # @return [Array] two elements array, where the first element is String
+      #   representing an unsigned 64 bit number (the cursor), and the second
+      #   element is an Array of elements.
+      def hscan(key, cursor, opts = {})
+        args = [:HSCAN, key, cursor]
+        Scan.merge_opts!(args, opts)
+        run(*args)
+      end
     end
   end
 end

data/lib/oxblood/commands/hyper_log_log.rb

@@ -20,7 +20,7 @@ module Oxblood
       # @param [String, Array<String>] keys
       #
       # @return [Integer] the approximated number of unique elements observed
-      #   via {pfadd}.
+      #   via {#pfadd}.
       def pfcount(*keys)
         run(*keys.unshift(:PFCOUNT))
       end

data/lib/oxblood/commands/keys.rb

@@ -1,3 +1,5 @@
+require 'oxblood/commands/scan'
+
 module Oxblood
   module Commands
     module Keys
@@ -208,6 +210,25 @@ module Oxblood
       def type(key)
         run(:TYPE, key)
       end
+
+      # Incrementally iterate the keys space
+      # @see https://redis.io/commands/scan
+      #
+      # @param [Integer] cursor
+      # @param [Hash] opts
+      #
+      # @option opts [Integer] :count Amount of work that should be done at
+      #   every call in order to retrieve elements from the collection.
+      # @option opts [String] :match
+      #
+      # @return [Array] two elements array, where the first element is String
+      #   representing an unsigned 64 bit number (the cursor), and the second
+      #   element is an Array of elements.
+      def scan(cursor, opts = {})
+        args = [:SCAN, cursor]
+        Scan.merge_opts!(args, opts)
+        run(*args)
+      end
     end
   end
 end

data/lib/oxblood/commands/scan.rb

@@ -0,0 +1,17 @@
+module Oxblood
+  module Commands
+    # @api private
+    module Scan
+      # @note Mutates args argument!
+      def self.merge_opts!(args, opts)
+        if v = opts[:count]
+          args.push(:COUNT, v)
+        end
+
+        if v = opts[:match]
+          args.push(:MATCH, v)
+        end
+      end
+    end
+  end
+end

data/lib/oxblood/commands/sets.rb

@@ -1,3 +1,5 @@
+require 'oxblood/commands/scan'
+
 module Oxblood
   module Commands
     module Sets
@@ -167,6 +169,25 @@ module Oxblood
       def sunionstore(destination, *keys)
         run(*keys.unshift(:SUNIONSTORE, destination))
       end
+
+      # Incrementally iterate Set elements
+      # @see https://redis.io/commands/sscan
+      #
+      # @param [Integer] cursor
+      # @param [Hash] opts
+      #
+      # @option opts [Integer] :count Amount of work that should be done at
+      #   every call in order to retrieve elements from the collection.
+      # @option opts [String] :match
+      #
+      # @return [Array] two elements array, where the first element is String
+      #   representing an unsigned 64 bit number (the cursor), and the second
+      #   element is an Array of elements.
+      def sscan(key, cursor, opts = {})
+        args = [:SSCAN, key, cursor]
+        Scan.merge_opts!(args, opts)
+        run(*args)
+      end
     end
   end
 end

data/lib/oxblood/commands/sorted_sets.rb

@@ -1,3 +1,5 @@
+require 'oxblood/commands/scan'
+
 module Oxblood
   module Commands
     module SortedSets
@@ -10,10 +12,25 @@ module Oxblood
       #
       # @param [String] key under which store set
       # @param [[Float, String], Array<[Float, String]>] args scores and members
+      # @param [Hash] opts
+      #
+      # @option opts [Boolean] :xx Only update elements that already exist.
+      #   Never add elements.
+      # @option opts [Boolean] :nx Don't update already existing elements.
+      #   Always add new elements.
+      # @option opts [Boolean] :ch Modify the return value from the number of
+      #   new elements added, to the total number of elements changed.
+      # @option opts [Boolean] :incr When this option is specified ZADD acts
+      #   like ZINCRBY. Only one score-element pair can be specified in this mode.
       #
       # @return [Integer] The number of elements added to the sorted sets, not
       #   including elements already existing for which the score was updated
-      def zadd(key, *args)
+      def zadd(key, *args, **opts)
+        args.unshift(:XX) if opts[:xx]
+        args.unshift(:NX) if opts[:nx]
+        args.unshift(:CH) if opts[:ch]
+        args.unshift(:INCR) if opts[:incr]
+
         run(*args.unshift(:ZADD, key))
       end
 
@@ -53,6 +70,51 @@ module Oxblood
         run(:ZINCRBY, key, increment, member)
       end
 
+      # Return a range of members in a sorted set, by lexicographical range.
+      # @see https://redis.io/commands/zrangebylex
+      #
+      # @param [String] key
+      # @param [String] min
+      # @param [String] max
+      # @param [Hash] opts
+      #
+      # @option opts [Array<Integer, Integer>] :limit Get a range of the matching
+      #   elements (similar to SELECT LIMIT offset, count in SQL)
+      #
+      # @return [Array<String>] list of elements in the specified score range.
+      def zrangebylex(key, min, max, opts = {})
+        common_rangebylex(:ZRANGEBYLEX, key, min, max, opts)
+      end
+
+      # Remove all members in a sorted set between the given lexicographical range.
+      # @see https://redis.io/commands/zremrangebylex
+      #
+      # @param [String] key
+      # @param [String] min
+      # @param [String] max
+      #
+      # @return [Integer] the number of elements removed.
+      def zremrangebylex(key, min, max)
+        run(:ZREMRANGEBYLEX, key, min, max)
+      end
+
+      # Return a range of members in a sorted set, by lexicographical range, ordered
+      # from higher to lower strings.
+      # @see https://redis.io/commands/zrevrangebylex
+      #
+      # @param [String] key
+      # @param [String] min
+      # @param [String] max
+      # @param [Hash] opts
+      #
+      # @option opts [Array<Integer, Integer>] :limit Get a range of the matching
+      #   elements (similar to SELECT LIMIT offset, count in SQL)
+      #
+      # @return [Array<String>] list of elements in the specified score range.
+      def zrevrangebylex(key, min, max, opts = {})
+        common_rangebylex(:ZREVRANGEBYLEX, key, min, max, opts)
+      end
+
       # Count the number of members in a sorted set between a given
       # lexicographical range
       # @see http://redis.io/commands/zlexcount
@@ -256,6 +318,64 @@ module Oxblood
         run(:ZSCORE, key, member)
       end
 
+      # Incrementally iterate sorted sets elements and associated scores
+      # @see https://redis.io/commands/zscan
+      #
+      # @param [Integer] cursor
+      # @param [Hash] opts
+      #
+      # @option opts [Integer] :count Amount of work that should be done at
+      #   every call in order to retrieve elements from the collection.
+      # @option opts [String] :match
+      #
+      # @return [Array] two elements array, where the first element is String
+      #   representing an unsigned 64 bit number (the cursor), and the second
+      #   element is an Array of elements.
+      def zscan(key, cursor, opts = {})
+        args = [:ZSCAN, key, cursor]
+        Scan.merge_opts!(args, opts)
+        run(*args)
+      end
+
+      # Add multiple sorted sets and store the resulting sorted set in a new key
+      # @see https://redis.io/commands/zunionstore
+      #
+      # @param [String] destination key
+      # @param [Integer] numkeys number of sorted sets
+      # @param [String, Array<String>] keys
+      # @param [Hash] opts
+      #
+      # @option opts [Array<Float>] :weights multiplication factor for each
+      #   input sorted set.
+      # @option opts [Symbol] :aggregate how the results of the union
+      #   are aggregated.
+      #
+      # @return [Integer] the number of elements in the resulting sorted set
+      #   at destination.
+      def zunionstore(destination, numkeys, *keys, **opts)
+        common_store(:ZUNIONSTORE, destination, numkeys, keys, opts)
+      end
+
+      # Intersect multiple sorted sets and store the resulting sorted set in
+      #   a new key.
+      # @see https://redis.io/commands/zinterstore
+      #
+      # @param [String] destination key
+      # @param [Integer] numkeys number of sorted sets
+      # @param [String, Array<String>] keys
+      # @param [Hash] opts
+      #
+      # @option opts [Array<Float>] :weights multiplication factor for each
+      #   input sorted set.
+      # @option opts [Symbol] :aggregate how the results of the union
+      #   are aggregated.
+      #
+      # @return [Integer] the number of elements in the resulting sorted set
+      #   at destination.
+      def zinterstore(destination, numkeys, *keys, **opts)
+        common_store(:ZINTERSTORE, destination, numkeys, keys, opts)
+      end
+
       private
 
       def common_rangebyscore(command_name, key, min, max, opts)
@@ -271,6 +391,27 @@ module Oxblood
         args << :WITHSCORES if opts[:withscores]
         run(*args)
       end
+
+      def common_store(command_name, destination, numkeys, *keys, **opts)
+        args = keys.unshift(command_name, destination, numkeys)
+
+        if v = opts[:weights]
+          args.push(:WEIGHTS).concat(v)
+        end
+
+        if v = opts[:aggregate]
+          args.push(:AGGREGATE, v)
+        end
+
+        run(*args)
+      end
+
+      def common_rangebylex(command_name, key, min, max, opts)
+        args = [command_name, key, min, max]
+        args.push(:LIMIT).concat(opts[:limit]) if opts[:limit].is_a?(Array)
+
+        run(*args)
+      end
     end
   end
 end

data/lib/oxblood/version.rb

@@ -1,3 +1,3 @@
 module Oxblood
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxblood
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Konstantin Shabanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -122,6 +122,7 @@ files:
 - lib/oxblood/commands/hyper_log_log.rb
 - lib/oxblood/commands/keys.rb
 - lib/oxblood/commands/lists.rb
+- lib/oxblood/commands/scan.rb
 - lib/oxblood/commands/server.rb
 - lib/oxblood/commands/sets.rb
 - lib/oxblood/commands/sorted_sets.rb