Merge branch 'main' into rubocop

* main:
  Update Readme on local development and debugging
  Set up ruby/debug in place of byebug for dev and test

Author: lewispb

.gitignore

@@ -1,3 +1,2 @@
 *.gem
-.byebug_history
 .rubocop-*

Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake"
-gem "byebug"
+gem "debug", ">= 1.0.0"
 gem "rubocop"
 gem "rubocop-minitest"
 gem "rubocop-packaging"

Gemfile.lock

@@ -70,15 +70,20 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     builder (3.2.4)
-    byebug (11.1.3)
     concurrent-ruby (1.1.8)
     connection_pool (2.4.1)
     crass (1.0.6)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
     erubi (1.10.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.7.1)
+      reline (>= 0.3.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
     loofah (2.9.0)
@@ -140,6 +145,8 @@ GEM
     redis-client (0.14.1)
       connection_pool
     regexp_parser (2.8.1)
+    reline (0.3.6)
+      io-console (~> 0.5)
     rexml (3.2.5)
     rubocop (1.54.1)
       json (~> 2.3)
@@ -190,7 +197,7 @@ PLATFORMS
   x86_64-darwin
 
 DEPENDENCIES
-  byebug
+  debug (>= 1.0.0)
   kredis!
   rails (>= 6.0.0)
   rake

README.md

@@ -259,6 +259,29 @@ config.kredis.connector = ->(config) { SomeRedisProxy.new(config) }
 
 By default Kredis will use `Redis.new(config)`.
 
+## Development
+
+A development console is available by running `bin/console`.
+
+From there, you can experiment with Kredis. e.g.
+
+```rb
+>> str = Kredis.string "mystring"
+  Kredis  (0.1ms)  Connected to shared
+=>
+#<Kredis::Types::Scalar:0x0000000134c7d938
+...
+>> str.value = "hello, world"
+  Kredis Proxy (2.4ms)  SET mystring ["hello, world"]
+=> "hello, world"
+>> str.value
+```
+
+Run tests with `bin/test`.
+
+[`debug`](https://github.com/ruby/debug) can be used in the development console and in the test suite by inserting a
+breakpoint, e.g. `debugger`.
+
 ## License
 
 Kredis is released under the [MIT License](https://opensource.org/licenses/MIT).

bin/console

@@ -5,9 +5,13 @@ require "bundler/inline"
 
 gemfile do
   source "https://rubygems.org"
+
+  gem "debug", ">= 1.0.0"
+
   gem "kredis", path: "../"
 end
 
+require "debug"
 
 Kredis.configurator = Class.new { def config_for(name) { db: "2" } end }.new
 ActiveSupport::LogSubscriber.logger = ActiveSupport::Logger.new(STDOUT)

test/test_helper.rb

@@ -2,7 +2,7 @@
 require "active_support/test_case"
 require "active_support/testing/autorun"
 require "minitest/mock"
-require "byebug"
+require "debug"
 
 require "kredis"