redis-json 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c4992d626b03ba86229fb96d18713a5ae0154e566c60a4740444c9dfa42a8e7
-  data.tar.gz: 005bbd5b6e66ddf75e83a585251099d07ad8a3cb9b00b15b0f6ba12973c6e475
+  metadata.gz: f62b79d920fff44b30233d3d9723fe413dfd316f9cb94fd7f0cde4602a6f9e30
+  data.tar.gz: a5e6c5603730c4f863ef60b066776f7a9820bc9f460b1fdcdda5f0eefaa39195
 SHA512:
-  metadata.gz: 54a918c7cf3a6e85025f1f2fa168c17dcfac7b0e2bc931c08f4288614b7836773eb6c02f14493333fd757f3c2910029889cdc063a6629b6404c0e245f6ca18da
-  data.tar.gz: 71deaea8c939d271c9d30453886af0fe314ae3c91dd1068a0f60f898a463877a6398eba38d1bff1b128d05f3245d1967e22d40e3e8d710c6e27f293a40e63aef
+  metadata.gz: 4e02f20f232fe10431536b216d1dc8c560163be952b9900e605f0a14bcf22a2d2e39aee4bb577e1d459b5f679d32ead3a28a1d863afc5f5119111e82f80b1981
+  data.tar.gz: e203b86be101dfef7ec5b57dba5b34b981b794167742f0f8c1440f898f66ce39042d31112f97c34f79a6fde3124f4c5e84af8b6a7f3e6ec6d61c344dc1d694d7

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.0.1 2023-06-06
+
+### New features
+
+- Added type signatures for json client methods.
+
+### Bug fixes
+
+- Added missing parsing to return value of `arrpop`.
+
 ## 1.0.0 2023-06-05
 
 First release. Refer to [README.md](README.md) for the full documentation.

data/README.md

@@ -34,7 +34,7 @@ hash = {
   string: 'example',
   empty_object: {}
 }
-redis.json.set 'key', hash # => OK
+redis.json.set 'key', hash, path: '$' # => OK
 ```
 
 Input values will be converted to JSON strings using `JSON.generate`, and returned JSON strings will be parsed to Ruby objects using `JSON.parse`. You can use, respectively, `generate_options` and `parse_options` to specify options that will be passed on to the `JSON` methods:

data/lib/redis/json/client.rb

@@ -52,18 +52,27 @@ class Redis
         end
       end
 
-      def arrpop key, index=NOT_PROVIDED, path: NOT_PROVIDED
+      def arrpop key, index=NOT_PROVIDED, path: NOT_PROVIDED, parse_options: {}
         if !index.eql?(NOT_PROVIDED) && path.eql?(NOT_PROVIDED)
           raise ArgumentError,
                 'You cannot specify an index unless you also specify a path'
         end
 
         if path.eql? NOT_PROVIDED
-          call __callee__, key
+          call(__callee__, key)
+            .then do |response|
+              parse response, **parse_options if response
+            end
         elsif index.eql? NOT_PROVIDED
-          call __callee__, key, path
+          call(__callee__, key, path)
+            .map do |response|
+              parse response, **parse_options if response
+            end
         else
-          call __callee__, key, path, index
+          call(__callee__, key, path, index)
+            .map do |response|
+              parse response, **parse_options if response
+            end
         end
       end
 

data/lib/redis/json/version.rb

@@ -1,5 +1,5 @@
 class Redis
   module JSON
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.freeze
   end
 end

data/sig/lib/redis/json/client.rbs

@@ -0,0 +1,57 @@
+class Redis
+  module JSON
+    class Client
+      def call: (Symbol command, *String args) -> untyped
+
+      def arrappend: (String key, Hash[untyped, untyped] value, *Hash[untyped, untyped] values, ?path: String, ?generate_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def arrindex: (String key, Hash[untyped, untyped] value, ?Integer start, ?Integer stop, path: String, ?generate_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def arrinsert: (String key, untyped index, Hash[untyped, untyped] value, *Hash[untyped, untyped] values, path: String, ?generate_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def arrlen: (String key, ?path: String) -> untyped
+
+      def arrpop: (String key, ?Integer index, ?path: String) -> untyped
+
+      def arrtrim: (String key, Integer start, Integer stop, path: String) -> untyped
+
+      def clear: (String key, ?path: String) -> untyped
+
+      def debug_memory: (String key, ?path: String) -> untyped
+
+      def del: (String key, ?path: String) -> untyped
+
+      def forget: (String key, ?path: String) -> untyped
+
+      def get: (String key, *String paths, ?indent: String, ?newline: String, ?space: String, ?parse_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def merge: (String key, Hash[untyped, untyped] value, path: String, ?generate_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def mget: (String key, *String keys, path: String, ?parse_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def mset: (String key, untyped path, Hash[untyped, untyped] value, *untyped rest, ?generate_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def numincrby: (String key, Hash[untyped, untyped] value, path: String, ?parse_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def nummultby: (String key, Hash[untyped, untyped] value, path: String, ?parse_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def numpowby: (String key, Hash[untyped, untyped] value, path: String, ?parse_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def objkeys: (String key, ?path: String) -> untyped
+
+      def objlen: (String key, ?path: String) -> untyped
+
+      def resp: (String key, ?path: String) -> untyped
+
+      def set: (String key, Hash[untyped, untyped] value, path: String, ?nx: bool, ?xx: bool, ?generate_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def strappend: (String key, Hash[untyped, untyped] value, ?path: String, ?generate_options: ::Hash[Symbol, untyped]) -> untyped
+
+      def strlen: (String key, ?path: String) -> untyped
+
+      def toggle: (String key, path: String) -> untyped
+
+      def type: (String key, ?path: String) -> untyped
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-json
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Moku S.r.l.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -42,6 +42,7 @@ files:
 - lib/redis/json/client.rb
 - lib/redis/json/commands_patch.rb
 - lib/redis/json/version.rb
+- sig/lib/redis/json/client.rbs
 homepage: https://github.com/moku-io/redis-json
 licenses:
 - MIT