lite-redis 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 642392448791c4c6ad57bf6a3891dbe5328846ffdf8c9dd642a2cee7c9be55f2
-  data.tar.gz: 5669cd7aea321718b45576ba3d1ab39bf132bb66002b6c135c1cd4e22f39c490
+  metadata.gz: fecc0a6a4777336e6cc102628f7bf2327a1e4c2e15a4bc0751e90548f03df99e
+  data.tar.gz: dda8f438f3294cda99f4bf02c54d6597fd7dbdc20f6a932bcfe37576f2b5d965
 SHA512:
-  metadata.gz: 71cf4f8c52403688529fcec71ff8501370b9b65aa472dbe03483fd17901e132552161309a5f6af2b5cb26981ac471c6498686e1669725f4770b5b328b99e3c57
-  data.tar.gz: 55ce0ddfc26b79422f9f1e3bc46fed1df9b548b53253ef69ce68311d8c44be7729e2ef08df3838f05f1ade27f47095b51e32dd751e80d65b6eddcd009344182e
+  metadata.gz: 5445af5825a97e587b2bcbaeeceec785a008fc1dffefd50d5b0c1001dc5c17177737cab713b88ad966a7cca40e09e32e36fc9ca888af7ab4f591be16da020706
+  data.tar.gz: 0d33ac48c3d09f2ccf834c826eca89a961032d1e5ffa9ba8d99b111ea9e86edcb1b60e67de08490beebab83ae201143fd5e601f644c0b114aa8bf32496b580f0

data/.rubocop.yml

@@ -3,7 +3,6 @@ require:
   - rubocop-rake
   - rubocop-rspec
 AllCops:
-  TargetRubyVersion: 3.0
   NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
@@ -19,7 +18,7 @@ Layout/EmptyLinesAroundClassBody:
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
 Layout/LineLength:
-  Max: 100
+  Enabled: false
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 Lint/RaiseException:
@@ -30,6 +29,8 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/**/*'
     - '*.gemspec'
+Naming/BlockForwarding:
+  Enabled: false
 Naming/InclusiveLanguage:
   Enabled: false
 RSpec/EmptyExampleGroup:
@@ -44,3 +45,5 @@ Style/Documentation:
   Enabled: false
 Style/ExpandPathArguments:
   Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -7,62 +7,48 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.2.0] - 2022-09-26
+## [1.3.0] - 2022-11-19
+### Changed
+- Improved docs
+- Improve internal setup
+- Improved rubocop setup
 
+## [1.2.0] - 2022-09-26
 ### Removed
-
 - Removed deprecated `Redis.exists_returns_integer`
 
 ## [1.1.2] - 2021-07-22
-
 ### Changed
-
 - Improved setup
 
 ## [1.1.1] - 2021-07-21
-
 ### Changed
-
 - Improved Railtie support
 
 ## [1.1.0] - 2021-07-19
-
 ### Added
-
 - Added Ruby 3.0 support
 
 ## [1.0.5] - 2020-07-03
-
 ### Added
-
 - Added Ruby 2.7 support
 
 ## [1.0.4] - 2019-08-24
-
 ### Changed
-
 - Improved how configuration works
 
 ## [1.0.3] - 2019-08-15
-
 ### Changed
-
 - Fix broken rake task
 
 ## [1.0.2] - 2019-08-15
-
 ### Changed
-
 - Underscore initializer file name
 
 ## [1.0.1] - 2019-07-09
-
 ### Changed
-
 - Updated the client method construction
 
 ## [1.0.0] - 2019-07-08
-
 ### Added
-
 - Initial project version

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in lite-redis.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-redis (1.2.0)
+    lite-redis (1.3.0)
       redis
 
 GEM
@@ -50,7 +50,7 @@ GEM
     method_source (1.0.0)
     mini_portile2 (2.8.0)
     minitest (5.16.3)
-    nokogiri (1.13.8)
+    nokogiri (1.13.9)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.22.1)
@@ -75,47 +75,47 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     redis (4.8.0)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-rails (5.1.2)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
-      railties (>= 5.2)
-      rspec-core (~> 3.10)
-      rspec-expectations (~> 3.10)
-      rspec-mocks (~> 3.10)
-      rspec-support (~> 3.10)
-    rspec-support (3.11.1)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-rails (6.0.1)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.11)
+      rspec-expectations (~> 3.11)
+      rspec-mocks (~> 3.11)
+      rspec-support (~> 3.11)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.15.0)
+    rubocop-performance (1.15.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.13.2)
+    rubocop-rspec (2.15.0)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby_parser (3.19.1)
@@ -125,7 +125,7 @@ GEM
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
-    zeitwerk (2.6.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby
@@ -146,4 +146,4 @@ DEPENDENCIES
   rubocop-rspec
 
 BUNDLED WITH
-   2.3.22
+   2.3.26

data/README.md

@@ -5,8 +5,6 @@
 
 Lite::Redis is a library for accessing Redis with an ActiveRecord like ORM interface.
 
-**NOTE:** If you are coming from `ActiveRedisDB`, please read the [port](#port) section.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,12 +27,11 @@ Or install it yourself as:
 * [Pooling](#pooling)
 * [Commands](#commands)
 * [Callers](#callers)
-* [Port](#port)
 
 ## Configurations
 
-`rails g lite:redis:install` will generate the following file:
-`../config/initalizers/lite_redis.rb`
+`rails g lite:redis:install` will generate the following file in your application root:
+`config/initalizers/lite_redis.rb`
 
 ```ruby
 Lite::Redis.configure do |config|
@@ -69,25 +66,21 @@ end
 
 ## Callers
 
-There are two ways to access Redis commands, single class and multiple instance access.
-Multiple instance access reuses a Redis connection for better performance.
+Redis commands could be via a class or instance call.
+Instance access reuses a Redis connection for better performance.
 
+#### Instance
 ```ruby
-# Single class access
-Lite::Redis::String.create(:example, '123')
-Lite::Redis::String.find(:example)
-
-# - or -
-
-# Multiple instance access
 string = Lite::Redis::String.new
 string.create(:example, '123')
 string.find(:example)
 ```
 
-## Port
-
-`Lite::Redis` is a near compatible port of [ActiveRedisDB](https://github.com/drexed/active_redis_db).
+#### Class
+```ruby
+Lite::Redis::String.create(:example, '123')
+Lite::Redis::String.find(:example)
+```
 
 ## Development
 
@@ -97,7 +90,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lite-redis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/drexed/lite-redis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -105,4 +98,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Lite::Redis project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lite-redis/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Lite::Redis project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/drexed/lite-redis/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'lite/redis'
+require "bundler/setup"
+require "lite/redis"
 
 # 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.
@@ -11,5 +11,5 @@ require 'lite/redis'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/docs/CONNECTION.md

@@ -1,14 +1,18 @@
 # Connection
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/connection_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/connection.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/connection_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 connection = Lite::Redis::Connection.new
-connection.authenticate('pass')     #=> 'OK'
+connection.connected? #=> true
+```
 
-Lite::Redis::Connection.connected?  #=> true
+#### Class
+```ruby
+Lite::Redis::Connection.connected? #=> true
 ```

data/docs/GEO.md

@@ -1,14 +1,18 @@
 # Geo
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/geo_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/geo.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/geo_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 geo = Lite::Redis::Geo.new
-geo.create('Sicily', 13.361389, 38.115556)      #=> 1
+geo.position('Sicily', 'Catania') #=> [['15.08726745843887329', '37.50266842333162032']]
+```
 
-Lite::Redis::Geo.position('Sicily', 'Catania')  #=> [['15.08726745843887329', '37.50266842333162032']]
+#### Class
+```ruby
+Lite::Redis::Geo.position('Sicily', 'Catania') #=> [['15.08726745843887329', '37.50266842333162032']]
 ```

data/docs/HASH.md

@@ -1,14 +1,18 @@
 # Hash
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/hash_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/hash.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/hash_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 hash = Lite::Redis::Hash.new
-hash.create(:example, :name, 1)
+hash.find(:example, :name) #=> 1
+```
 
-Lite::Redis::Hash.find(:example, :name)  #=> 1
+#### Class
+```ruby
+Lite::Redis::Hash.find(:example, :name) #=> 1
 ```

data/docs/HYPER_LOG_LOG.md

@@ -1,14 +1,18 @@
 # HyperLogLog
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/hyper_log_log_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/hyper_log_log.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/hyper_log_log_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 hyper_log_log = Lite::Redis::HyperLogLog.new
-hyper_log_log.create(:foo, 's1')     #=> true
+hyper_log_log.count(:foo) #=> 1
+```
 
+#### Class
+```ruby
 Lite::Redis::HyperLogLog.count(:foo) #=> 1
 ```

data/docs/KEY.md

@@ -1,14 +1,18 @@
 # Key
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/key_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/key.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/key_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 key = Lite::Redis::Key.new
-key.create(:example, 'hello')      #=> 'OK'
+key.exists?(:example) #=> true
+```
 
+#### Class
+```ruby
 Lite::Redis::Key.exists?(:example) #=> true
 ```

data/docs/LIST.md

@@ -1,14 +1,18 @@
 # List
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/list_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/list.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/list_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 list = Lite::Redis::List.new
-list.create(:example, 'one')      #=> 'OK'
+list.first(:example) #=> 'one'
+```
 
+#### Class
+```ruby
 Lite::Redis::List.first(:example) #=> 'one'
 ```

data/docs/PUB_SUB.md

@@ -1,11 +1,12 @@
 # PubSub
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/pub_sub_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/pub_sub.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/pub_sub_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 pub_sub = Lite::Redis::PubSub.new
 pub_sub.subscribe('foo') do |on|
@@ -26,6 +27,9 @@ pub_sub.subscribe('foo') do |on|
     @t2 = total
   end
 end
+```
 
+#### Class
+```ruby
 Lite::Redis::PubSub.subscribed? #=> true
 ```

data/docs/SCRIPT.md

@@ -1,14 +1,18 @@
 # Script
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/script_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/script.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/script_spec.rb) file to see more example usages.
 
+# Instance
 ```ruby
 script = Lite::Redis::Script.new
-script.script(:load, script)             #=> 'OK'
+script.eval('return #KEYS') #=> 0
+```
 
+#### Class
+```ruby
 Lite::Redis::Script.eval('return #KEYS') #=> 0
 ```

data/docs/SET.md

@@ -1,14 +1,18 @@
 # Set
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/set_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/set.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/set_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 set = Lite::Redis::Set.new
-set.create(:example, '1')       #=> 'OK'
+set.find(:example) #=> ['1']
+```
 
+#### Class
+```ruby
 Lite::Redis::Set.find(:example) #=> ['1']
 ```

data/docs/SORTED_SET.md

@@ -1,14 +1,18 @@
 # Sorted Set
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/sorted_set_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/sorted_set.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/sorted_set_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 sorted_set = Lite::Redis::SortedSet.new
-sorted_set.create(:example, 1, 1, 2, 'two', 3, '3') #=> 'OK'
+sorted_set.find(:example, 2)  #=> 'two'
+```
 
-Lite::Redis::SortedSet.find(:example, 2)            #=> 'two'
+#### Class
+```ruby
+Lite::Redis::SortedSet.find(:example, 2) #=> 'two'
 ```

data/docs/STRING.md

@@ -1,14 +1,18 @@
 # String
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/string_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/string.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/string_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 string = Lite::Redis::String.new
-string.create(:example1, '123')     #=> 'OK'
+string.create(:example1, '123') #=> 'OK'
+```
 
+#### Class
+```ruby
 Lite::Redis::String.find(:example1) #=> '123'
 ```

data/docs/TRANSACTION.md

@@ -1,14 +1,18 @@
 # Transaction
 
-#### Usage
+## Usage
 
-Please read the corresponding [helper](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/helpers/transaction_helper.rb) file to see all available methods.
+Please read the corresponding [class](https://github.com/drexed/lite-redis/blob/master/lib/lite/redis/transaction.rb) file to see all available methods.
 
 Please read the corresponding [spec](https://github.com/drexed/lite-redis/blob/master/spec/lite/redis/transaction_spec.rb) file to see more example usages.
 
+#### Instance
 ```ruby
 transaction = Lite::Redis::Transaction.new
-transaction.multi { |m| m.set('foo', 's1') } #=> 'OK'
+transaction.discard #=> 'OK'
+```
 
-Lite::Redis::Transaction.discard             #=> 'OK'
+#### Class
+```ruby
+Lite::Redis::Transaction.discard #=> 'OK'
 ```

data/lib/generators/lite/redis/install_generator.rb

@@ -4,10 +4,10 @@ module Lite
   module Redis
     class InstallGenerator < Rails::Generators::Base
 
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("../templates", __FILE__)
 
       def copy_initializer_file
-        copy_file('install.rb', 'config/initializers/lite_redis.rb')
+        copy_file("install.rb", "config/initializers/lite_redis.rb")
       end
 
     end