dbg-rb 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc71d393c746d79980c413057430f8f9e473d2746a343dc64ec3289dc6ea278e
-  data.tar.gz: 6de928faad269dfa03dedc2e0f0606444cd3df2f8ce1f8660dbbdcf580b4a6ca
+  metadata.gz: 05a2b90f0904d6bfdbcb0a03099b305364cecdb9cd49a833e1d55338b9fb6c80
+  data.tar.gz: db531071fce82b46b52b12bc4b97e1b563acc38621fb83d191ef58bcdaa4b5b2
 SHA512:
-  metadata.gz: a6c4ccb43238e5c47639339588589cdc4b175acf9cfb5ed62e332f03d9a738824891ce980f2ec8d3582ba66b7f9cc63fdb2b15868e2108f79b7dc3456810fa28
-  data.tar.gz: 6098cf547b0efce0ef4f0751e3ae4d067b0e19864315de0de515f644da367d86b520370778eb016d9b0722a6e312e948692b6006fd2d2cfafa6bfc80c08e65cc
+  metadata.gz: 12f8fd0a098e18b73d66fda695ecc87d99d9b73661a130c92866dfbf143380d71f2645ec8a7cc7e773f7bd4fa8d383af25625c853133fafd7d2d787e614c4342
+  data.tar.gz: 774daf99ccc4c44cf23e9c2c8188bbf0bf1fc760cbc1e37f5e8128cf14ffc17512e59bfdc65efedb83b1a28e85f3f2330bcf094db5c7c1cf91a77bc4bbe26378

data/README.md

@@ -1,6 +1,6 @@
 # dbg [![Gem Version](https://badge.fury.io/rb/dbg-rb.svg)](https://badge.fury.io/rb/dbg-rb) [![GH Actions](https://github.com/pawurb/dbg-rb/actions/workflows/ci.yml/badge.svg)](https://github.com/pawurb/dbg-rb/actions)
 
-![Dbg base](https://github.com/pawurb/dbg-rb/raw/main/dbg_base.png)
+![Dbg base](https://github.com/pawurb/dbg-rb/raw/main/dbg_base2.png)
  
 Because I wrote: 
 
@@ -28,29 +28,19 @@ Gem adds a global `dbg` method that you can use for puts debugging:
 require "dbg-rb"
 
 dbg(User.last.id)
-# [web/user_sessions_controller.rb:37] 1972
+# [web/user_sessions_controller.rb:37] User.last.id = 1972
 
 ```
 
-It appends a caller file and line info to the debug output.
+It appends a caller file, line info and source expression to the debug output.
 
-You can use symbols to output local variable names together with their values:
-
-```ruby
-a = 1
-b = 2 
-
-dbg(:a, :b)
-# [models/user.rb:22] a = 1
-# [models/user.rb:22] b = 2
-```
 
 Hash values are pretty printed:
 
 ```ruby
-user = User.last.as_json
-dbg(:user)
-# [web/users_controller.rb:10 user = {
+
+dbg(User.last.as_json)
+# [web/users_controller.rb:10] User.last.as_json = {
 #   "id": 160111,
 #   "team_id": 1,
 #   "pseudonym": "Anonymous-CBWE",
@@ -80,11 +70,10 @@ DbgRb.color_code = nil
 ```
 
 ```ruby
-user = User.last.as_json.slice("id", "slack_id")
-dbg("User last", :user)
+dbg(User.last(2).map(&:as_json))
 ```
 
-![Dbg color](https://github.com/pawurb/dbg-rb/raw/main/dbg_base.png)
+![Dbg color](https://github.com/pawurb/dbg-rb/raw/main/dbg_base2.png)
 
 If it does not stand out enough, you can enable `dbg` highlighting:
 
@@ -97,6 +86,31 @@ DbgRb.highlight!("🎉💔💣🕺🚀🧨🙈🤯🥳🌈🦄")
 
 ![Dbg emoji](https://github.com/pawurb/dbg-rb/raw/main/dbg_emoji.png)
 
+## Logs integration
+
+![Lbg logs](https://github.com/pawurb/dbg-rb/raw/main/lbg_logs.png)
+
+Use `lbg` to send debug output through a logger instead of `stdio`:
+
+```ruby
+require "dbg-rb"
+
+lbg(User.last.id)
+# Sends to Rails.logger.debug: [web/user_sessions_controller.rb:37] User.last.id = 1972
+```
+
+The `lbg` method:
+- Uses `Rails.logger` by default when Rails is available
+- Falls back to regular `dbg` behavior if no logger is configured
+- Uses `:debug` log level by default
+
+You can configure a custom logger and log level:
+
+```ruby
+DbgRb.logger = MyLogger.new
+DbgRb.log_level = :info
+```
+
 ## Status
 
 Contributions & ideas very welcome!

data/inline/dbg_rb.rb

@@ -35,13 +35,27 @@ module DbgRb
     Impl.highlight!(wrapper)
   end
 
+  def self.logger=(val)
+    Impl.logger = val
+  end
+
+  def self.log_level=(val)
+    Impl.log_level = val
+  end
+
   def self.dbg(*msgs)
     Impl.new.dbg(*msgs)
   end
 
+  def self.lbg(*msgs)
+    Impl.new.lbg(*msgs)
+  end
+
   class Impl
     @@color_code = nil
     @@highlight = false
+    @@logger = defined?(Rails) ? Rails.logger : nil
+    @@log_level = :debug
 
     def self.color_code=(val)
       @@color_code = val
@@ -51,8 +65,16 @@ module DbgRb
       @@highlight = wrapper
     end
 
-    def dbg(value)
-      loc = caller_locations.first(3).last
+    def self.logger=(val)
+      @@logger = val
+    end
+
+    def self.log_level=(val)
+      @@log_level = val
+    end
+
+    def dbg_base(value)
+      loc = caller_locations.first(4).last
       source_file = if (path = loc.absolute_path)
           path.split("/").last(2).join("/")
         else
@@ -60,7 +82,7 @@ module DbgRb
         end
 
       file = if (path = loc.absolute_path)
-          path.split(":").first
+          path
         else
           nil
         end
@@ -71,7 +93,11 @@ module DbgRb
         File.open(file) do |f|
           f.each_line.with_index do |line, i|
             if i == loc.lineno - 1
-              splitby, remove_parantheses = if line.include?("dbg(")
+              splitby, remove_parantheses = if line.include?("lbg(")
+                  ["lbg(", true]
+                elsif line.include?("lbg ")
+                  ["lbg ", false]
+                elsif line.include?("dbg(")
                   ["dbg(", true]
                 else
                   ["dbg ", false]
@@ -104,8 +130,20 @@ module DbgRb
       if @@color_code != nil
         output = colorize(output, @@color_code)
       end
+      
+      output
+    end
 
-      puts output
+    def dbg(value)
+      puts dbg_base(value)
+    end
+
+    def lbg(value)
+      if @@logger.nil?
+        puts dbg_base(value)
+      else
+        @@logger.send(@@log_level, dbg_base(value))
+      end
     end
 
     private
@@ -126,7 +164,7 @@ module DbgRb
         dbg_inspect(val, quote_str: true)
       end.then do |value|
         if value.is_a?(String)
-          value.gsub("\"nil\"", "nil")
+          value.gsub("\"nil\"", "nil").gsub("\\", "")
         else
           value
         end
@@ -139,8 +177,15 @@ module DbgRb
       end
 
       case obj
-      when Numeric, String
+      when Numeric
         obj
+      when String
+        # Handle binary strings by showing their hex representation
+        if obj.encoding == Encoding::ASCII_8BIT
+          obj.bytes.map { |b| "\\x#{b.to_s(16).rjust(2, '0')}" }.join
+        else
+          obj
+        end
       else
         obj.inspect
       end
@@ -152,4 +197,8 @@ def dbg(value)
   DbgRb.dbg(value)
 end
 
+def lbg(value)
+  DbgRb.lbg(value)
+end
+
 DbgRb.color_code = 33 # yellow

data/lib/dbg-rb.rb

@@ -11,13 +11,27 @@ module DbgRb
     Impl.highlight!(wrapper)
   end
 
+  def self.logger=(val)
+    Impl.logger = val
+  end
+
+  def self.log_level=(val)
+    Impl.log_level = val
+  end
+
   def self.dbg(*msgs)
     Impl.new.dbg(*msgs)
   end
 
+  def self.lbg(*msgs)
+    Impl.new.lbg(*msgs)
+  end
+
   class Impl
     @@color_code = nil
     @@highlight = false
+    @@logger = defined?(Rails) ? Rails.logger : nil
+    @@log_level = :debug
 
     def self.color_code=(val)
       @@color_code = val
@@ -27,8 +41,16 @@ module DbgRb
       @@highlight = wrapper
     end
 
-    def dbg(value)
-      loc = caller_locations.first(3).last
+    def self.logger=(val)
+      @@logger = val
+    end
+
+    def self.log_level=(val)
+      @@log_level = val
+    end
+
+    def dbg_base(value)
+      loc = caller_locations.first(4).last
       source_file = if (path = loc.absolute_path)
           path.split("/").last(2).join("/")
         else
@@ -36,7 +58,7 @@ module DbgRb
         end
 
       file = if (path = loc.absolute_path)
-          path.split(":").first
+          path
         else
           nil
         end
@@ -47,7 +69,11 @@ module DbgRb
         File.open(file) do |f|
           f.each_line.with_index do |line, i|
             if i == loc.lineno - 1
-              splitby, remove_parantheses = if line.include?("dbg(")
+              splitby, remove_parantheses = if line.include?("lbg(")
+                  ["lbg(", true]
+                elsif line.include?("lbg ")
+                  ["lbg ", false]
+                elsif line.include?("dbg(")
                   ["dbg(", true]
                 else
                   ["dbg ", false]
@@ -80,8 +106,20 @@ module DbgRb
       if @@color_code != nil
         output = colorize(output, @@color_code)
       end
+      
+      output
+    end
 
-      puts output
+    def dbg(value)
+      puts dbg_base(value)
+    end
+
+    def lbg(value)
+      if @@logger.nil?
+        puts dbg_base(value)
+      else
+        @@logger.send(@@log_level, dbg_base(value))
+      end
     end
 
     private
@@ -102,7 +140,7 @@ module DbgRb
         dbg_inspect(val, quote_str: true)
       end.then do |value|
         if value.is_a?(String)
-          value.gsub("\"nil\"", "nil")
+          value.gsub("\"nil\"", "nil").gsub("\\", "")
         else
           value
         end
@@ -115,8 +153,15 @@ module DbgRb
       end
 
       case obj
-      when Numeric, String
+      when Numeric
         obj
+      when String
+        # Handle binary strings by showing their hex representation
+        if obj.encoding == Encoding::ASCII_8BIT
+          obj.bytes.map { |b| "\\x#{b.to_s(16).rjust(2, '0')}" }.join
+        else
+          obj
+        end
       else
         obj.inspect
       end
@@ -128,4 +173,8 @@ def dbg(value)
   DbgRb.dbg(value)
 end
 
+def lbg(value)
+  DbgRb.lbg(value)
+end
+
 DbgRb.color_code = 33 # yellow

data/lib/dbg_rb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DbgRb
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/inline_spec.rb

@@ -116,4 +116,107 @@ describe DbgRb do
       dbg [1, 2, 3].reduce(0) { |i, agg| agg + i }
     end.to output("[spec/inline_spec.rb:116] [1, 2, 3].reduce(0) { |i, agg| agg + i } = 6\n").to_stdout
   end
+
+  it "binary input" do
+    random_bytes = Random.new.bytes(8)
+
+    expect do
+      dbg(random_bytes)
+    end.not_to raise_error
+  end
+
+  describe "lbg" do
+    let(:mock_logger) do
+      Class.new do
+        attr_reader :logged_messages, :logged_levels
+
+        def initialize
+          @logged_messages = []
+          @logged_levels = []
+        end
+
+        def debug(message)
+          @logged_levels << :debug
+          @logged_messages << message
+        end
+
+        def info(message)
+          @logged_levels << :info
+          @logged_messages << message
+        end
+
+        def warn(message)
+          @logged_levels << :warn
+          @logged_messages << message
+        end
+
+        def error(message)
+          @logged_levels << :error
+          @logged_messages << message
+        end
+      end.new
+    end
+
+    before do
+      DbgRb.logger = nil
+      DbgRb.log_level = :debug
+    end
+
+    it "falls back to dbg when no logger is configured" do
+      expect do
+        lbg("test")
+      end.to output("[spec/inline_spec.rb:167] \"test\"\n").to_stdout
+    end
+
+    it "uses logger when configured" do
+      DbgRb.logger = mock_logger
+
+      lbg("test message")
+
+      expect(mock_logger.logged_messages).to eq(["[spec/inline_spec.rb:174] \"test message\""])
+      expect(mock_logger.logged_levels).to eq([:debug])
+    end
+
+    it "uses custom log level" do
+      DbgRb.logger = mock_logger
+      DbgRb.log_level = :info
+
+      lbg("test message")
+
+      expect(mock_logger.logged_messages).to eq(["[spec/inline_spec.rb:184] \"test message\""])
+      expect(mock_logger.logged_levels).to eq([:info])
+    end
+
+    it "logs variables with logger" do
+      DbgRb.logger = mock_logger
+      test_var = 42
+
+      lbg(test_var)
+
+      expect(mock_logger.logged_messages).to eq(["[spec/inline_spec.rb:194] test_var = 42"])
+      expect(mock_logger.logged_levels).to eq([:debug])
+    end
+
+    it "logs complex objects with logger" do
+      DbgRb.logger = mock_logger
+      test_hash = { a: 1, b: "test" }
+
+      lbg(test_hash)
+
+      expected_message = "[spec/inline_spec.rb:204] test_hash = {\n  \"a\": 1,\n  \"b\": \"test\"\n}"
+      expect(mock_logger.logged_messages).to eq([expected_message])
+      expect(mock_logger.logged_levels).to eq([:debug])
+    end
+
+    it "respects color and highlight settings with logger" do
+      DbgRb.logger = mock_logger
+      DbgRb.color_code = 31
+      DbgRb.highlight!("!!!")
+
+      lbg("styled")
+
+      expected_message = "\e[31m!!!\n[spec/inline_spec.rb:216] \"styled\"\n!!!\e[0m"
+      expect(mock_logger.logged_messages).to eq([expected_message])
+    end
+  end
 end

data/spec/main_spec.rb

@@ -116,4 +116,107 @@ describe DbgRb do
       dbg [1, 2, 3].reduce(0) { |i, agg| agg + i }
     end.to output("[spec/main_spec.rb:116] [1, 2, 3].reduce(0) { |i, agg| agg + i } = 6\n").to_stdout
   end
+
+  it "binary input" do
+    random_bytes = Random.new.bytes(8)
+
+    expect do
+      dbg(random_bytes)
+    end.not_to raise_error
+  end
+
+  describe "lbg" do
+    let(:mock_logger) do
+      Class.new do
+        attr_reader :logged_messages, :logged_levels
+
+        def initialize
+          @logged_messages = []
+          @logged_levels = []
+        end
+
+        def debug(message)
+          @logged_levels << :debug
+          @logged_messages << message
+        end
+
+        def info(message)
+          @logged_levels << :info
+          @logged_messages << message
+        end
+
+        def warn(message)
+          @logged_levels << :warn
+          @logged_messages << message
+        end
+
+        def error(message)
+          @logged_levels << :error
+          @logged_messages << message
+        end
+      end.new
+    end
+
+    before do
+      DbgRb.logger = nil
+      DbgRb.log_level = :debug
+    end
+
+    it "falls back to dbg when no logger is configured" do
+      expect do
+        lbg("test")
+      end.to output("[spec/main_spec.rb:167] \"test\"\n").to_stdout
+    end
+
+    it "uses logger when configured" do
+      DbgRb.logger = mock_logger
+
+      lbg("test message")
+
+      expect(mock_logger.logged_messages).to eq(["[spec/main_spec.rb:174] \"test message\""])
+      expect(mock_logger.logged_levels).to eq([:debug])
+    end
+
+    it "uses custom log level" do
+      DbgRb.logger = mock_logger
+      DbgRb.log_level = :info
+
+      lbg("test message")
+
+      expect(mock_logger.logged_messages).to eq(["[spec/main_spec.rb:184] \"test message\""])
+      expect(mock_logger.logged_levels).to eq([:info])
+    end
+
+    it "logs variables with logger" do
+      DbgRb.logger = mock_logger
+      test_var = 42
+
+      lbg(test_var)
+
+      expect(mock_logger.logged_messages).to eq(["[spec/main_spec.rb:194] test_var = 42"])
+      expect(mock_logger.logged_levels).to eq([:debug])
+    end
+
+    it "logs complex objects with logger" do
+      DbgRb.logger = mock_logger
+      test_hash = { a: 1, b: "test" }
+
+      lbg(test_hash)
+
+      expected_message = "[spec/main_spec.rb:204] test_hash = {\n  \"a\": 1,\n  \"b\": \"test\"\n}"
+      expect(mock_logger.logged_messages).to eq([expected_message])
+      expect(mock_logger.logged_levels).to eq([:debug])
+    end
+
+    it "respects color and highlight settings with logger" do
+      DbgRb.logger = mock_logger
+      DbgRb.color_code = 31
+      DbgRb.highlight!("!!!")
+
+      lbg("styled")
+
+      expected_message = "\e[31m!!!\n[spec/main_spec.rb:216] \"styled\"\n!!!\e[0m"
+      expect(mock_logger.logged_messages).to eq([expected_message])
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbg-rb
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-20 00:00:00.000000000 Z
+date: 2025-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -95,10 +95,11 @@ files:
 - README.md
 - Rakefile
 - dbg-rb.gemspec
-- dbg_base.png
+- dbg_base2.png
 - dbg_emoji.png
 - inline/dbg_rb.rb
 - inline/sync.rb
+- lbg_logs.png
 - lib/dbg-rb.rb
 - lib/dbg_rb/version.rb
 - spec/inline_spec.rb