rejson-rb 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd7a76d54e046c3ba8880b0aaeb7d3df2849b95aad7d5097c321b46d3d82844a
-  data.tar.gz: 371f4e666bb970f311e24cc9b571ba75a76d16d67fd3fe7c5470c85a512538af
+  metadata.gz: 11987003b0b1b4bef4b31354a6c9bbd962351efdfe258ce098b1fa0f64f3ce8f
+  data.tar.gz: ff94bae68b52dc5ed825072739024b70db8c5c8d1958beece3f22f979eb9398c
 SHA512:
-  metadata.gz: 36a5c940c8efe4c9da419fb23abfdaa5b472bbbc2b87ede905fb74a371d29ab7591c150b43c801cecea8a5b26d78d220594f2dcc28e6fbe3abc82dbcf3aa6ae1
-  data.tar.gz: 3fafa39182f902bcaf469738666da400ba87258c03dbeec3a4426fc4e47687c337a4d06dacd1377cb0bd2a35e77bb5e66366ddbd1700b380346278fc4c794d6f
+  metadata.gz: 0c5355cf126b61fd104f99ef1c2f4950626b33198ee0c13663b4296c95dc34061fce068f09656b6e2d5d6963e277666cbed2d4eb044ad125c12d684fa54595da
+  data.tar.gz: 62bfe041a7faa6c50394c634757803f4fffdfb028c580760f355cdadd41f5d34585a260bac2529881d584f2bebdab836e437fbfa33d15aa67716eceb0652b1b8

data/.rubocop.yml

@@ -0,0 +1,58 @@
+AllCops:
+  Exclude:
+    - bin/**/*
+    - coverage/**/*
+  DisplayCopNames: true
+  TargetRubyVersion: 2.6
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/GuardClause:
+  Enabled: false
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 9
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*
+
+Lint/RaiseException:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true

data/.travis.yml

@@ -1,22 +1,25 @@
 ---
 language: ruby
+
+services: docker
 cache: bundler
 rvm:
   - 2.5.5
   - 2.6.3
-before_install: gem install bundler -v 2.0.0
+  - ruby-head
+
+before_install:
+  - gem install bundler -v 2.0.0
+  - docker pull redislabs/rejson:edge
+  - docker run -d -p 6379:6379 redislabs/rejson:edge
 
 install:
-  # Get Redis
-  - git clone --depth=1 https://github.com/antirez/redis.git && cd redis && make && cd ..
-  # Get ReJSON
-  - git clone --depth=1 https://github.com/RedisLabsModules/ReJSON.git && cd ReJSON && make && cd ..
   # Install dependency gems
   - bundle install
 
 before_script:
-  - ./redis/src/redis-server --loadmodule ReJSON/src/rejson.so &
   - bundle install
 
 script:
-  - bundle exec rspec
+  - bundle exec rake rubocop
+  - bundle exec rspec

data/Gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rejson-rb.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 12.0"

data/README.md

@@ -18,15 +18,57 @@ Or install it yourself as:
 
     $ gem install rejson-rb
 
+## Usage
+
+Make sure you have loaded rejson module in `redis.conf`
+```ruby
+require 'rejson'
+
+rcl = Redis.new # Get a redis client
+
+# Get/Set/Delete keys
+obj = {
+        'foo': 42,
+        'arr': [nil, true, 3.14],
+        'truth': {
+          'coord': "out there"
+        }
+      }
+
+rcl.json_set("root", Rejson::Path.root_path, obj)
+# => "OK" 
+
+rcl.json_set("root", Rejson::Path.new(".foo"), 56)
+# => "OK" 
+
+rcl.json_get "root", Rejson::Path.root_path
+# => {"foo"=>56, "arr"=>[nil, true, 3.14], "truth"=>{"coord"=>"out there"}}
+
+rcl.json_del "root", ".truth.coord"
+# => 1
+
+# Use similar to redis-rb client
+rj = rcl.pipelined do
+  rcl.set "foo", "bar"
+  rcl.json_set "test", ".", "{:foo => 'bar', :baz => 'qux'}"
+end
+# => ["OK", "OK"] 
+```
+
+Path to JSON can be passed as `Rejson::Path.new("<path>")` or `Rejson::Path.root_path`. `<path>` syntax can be as mentioned [here](https://oss.redislabs.com/redisjson/path).
+
+### Refer project WIKI for more detailed documentation.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/vachhanihpavan/rejson-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/vachhanihpavan/rejson-rb/blob/master/CODE_OF_CONDUCT.md).
 
 For complete documentation about ReJSON's commands, refer to ReJSON's website.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Rejson::Rb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vachhanihpavan/rejson-rb/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rejson project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vachhanihpavan/rejson-rb/blob/master/CODE_OF_CONDUCT.md).#

data/Rakefile

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
 
 begin
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
 
   RSpec::Core::RakeTask.new(:spec)
 
-  task :default => :spec
+  task default: :spec
 rescue LoadError
   # no rspec available
 end

data/bin/console

@@ -2,7 +2,8 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "rejson/rb"
+require "rejson/path"
+require "rejson/client"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/rejson/client.rb

@@ -5,6 +5,7 @@ require "json"
 
 # Extends Redis class to add JSON functions
 class Redis
+  # rubocop:disable Metrics/AbcSize
   def json_set(key, path, data, options = {})
     pieces = [key, str_path(path), json_encode(data)]
     options[:nx] ||= false if options.dig(:nx)
@@ -12,7 +13,7 @@ class Redis
     options[:xx] ||= false if options.dig(:xx)
 
     if options[:nx] && options[:xx]
-      raise Exception, "nx and xx are mutually exclusive: use one, the other or neither - but not both"
+      raise ArgumentError, "nx and xx are mutually exclusive: use one, the other or neither - but not both"
     elsif options[:nx]
       pieces.append("NX")
     elsif options[:xx]
@@ -21,6 +22,7 @@ class Redis
 
     call_client(:set, pieces)
   end
+  # rubocop:enable Metrics/AbcSize
 
   def json_get(key, *args)
     pieces = [key]
@@ -43,26 +45,21 @@ class Redis
   def json_mget(key, *args)
     pieces = [key]
 
-    if args.empty?
-      raise ArgumentError "Invalid arguments"
-    else
-      pieces.append(args)
-    end
+    raise ArgumentError, "Invalid arguments: Missing path" if args.empty?
 
+    pieces.append(args)
     json_bulk_decode call_client(:mget, pieces)
   end
 
-  def json_del(key, *args)
-    pieces = [key]
-    pieces.append(str_path(args))
+  def json_del(key, path = Rejson::Path.root_path)
+    pieces = [key, str_path(path)]
     call_client(:del, pieces).to_i
   end
 
   alias json_forget json_del
 
-  def json_type(key, *args)
-    pieces = [key]
-    pieces.append(str_path(args))
+  def json_type(key, path = Rejson::Path.root_path)
+    pieces = [key, str_path(path)]
     call_client(:type, pieces).to_s
   end
 
@@ -137,11 +134,11 @@ class Redis
 
   private
 
-  def str_path(p)
-    if p.instance_of?(Rejson::Path)
-      p.str_path
+  def str_path(path)
+    if path.instance_of?(Rejson::Path)
+      path.str_path
     else
-      p
+      path
     end
   end
 
@@ -167,6 +164,6 @@ class Redis
 
   def call_client(cmd, pieces)
     pieces.prepend("JSON.#{cmd.upcase}").join(" ")
-    client.call pieces
+    @client.call pieces
   end
 end

data/lib/rejson/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rejson
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/rejson-rb.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["vachhanihpavan@gmail.com"]
 
   spec.summary       = "Redis JSON Ruby Client"
-  spec.description   = "rejson-rb is a package that allows storing, updating and querying objects as JSON documents in Redis database that is intended with RedisJSON module."
+  spec.description   = "rejson-rb is a package that allows storing, updating and querying objects as JSON documents
+                        in Redis database that is intended with RedisJSON module."
   spec.homepage      = "https://github.com/vachhanihpavan/rejson-rb"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -27,9 +28,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "redis",        "~> 3.0"
-  spec.add_runtime_dependency "json",         "~> 2.0"
-  spec.add_development_dependency "bundler",  "~> 2.0"
-  spec.add_development_dependency "rspec",    "~> 3.0"
-  spec.add_development_dependency "simplecov","~> 0.17"
+  spec.add_runtime_dependency "json",          "~> 2.0"
+  spec.add_runtime_dependency "redis",         "~> 4.2.1"
+
+  spec.add_development_dependency "bundler",   "~> 2.0"
+  spec.add_development_dependency "rspec",     "~> 3.0"
+  spec.add_development_dependency "rubocop",   "=0.86.0"
+  spec.add_development_dependency "simplecov", "~> 0.17"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rejson-rb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Pavan Vachhani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 4.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 4.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.86.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +94,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
-description: rejson-rb is a package that allows storing, updating and querying objects
-  as JSON documents in Redis database that is intended with RedisJSON module.
+description: |-
+  rejson-rb is a package that allows storing, updating and querying objects as JSON documents
+                          in Redis database that is intended with RedisJSON module.
 email:
 - vachhanihpavan@gmail.com
 executables: []
@@ -89,6 +104,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -124,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Redis JSON Ruby Client