dbg-rb 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d82a9c04865692653212313f996cf4fb9a6830527bbe4ed5558d66399b35aeb
-  data.tar.gz: 6ad01658fc39a212899f8d77855a4511b752c1b3da424a783f122b9223f22408
+  metadata.gz: 05a2b90f0904d6bfdbcb0a03099b305364cecdb9cd49a833e1d55338b9fb6c80
+  data.tar.gz: db531071fce82b46b52b12bc4b97e1b563acc38621fb83d191ef58bcdaa4b5b2
 SHA512:
-  metadata.gz: 246eb6ddd67d12911245d1423cfec870dd72dfc5b8e513aee1c2d4b47d2d9d19398a046f6847f0d8359716c772cbe11aaaf9c71e0d5ff4934152605710d4c7e5
-  data.tar.gz: 312ae9d10b0c13979a18337ab645eec926a385f65307d2850a061852bf6de52ef3892fad546c32ab82c4f3cfd41a9e85e71c16b46ff144ef1dbaec6d1f5c8be0
+  metadata.gz: 12f8fd0a098e18b73d66fda695ecc87d99d9b73661a130c92866dfbf143380d71f2645ec8a7cc7e773f7bd4fa8d383af25625c853133fafd7d2d787e614c4342
+  data.tar.gz: 774daf99ccc4c44cf23e9c2c8188bbf0bf1fc760cbc1e37f5e8128cf14ffc17512e59bfdc65efedb83b1a28e85f3f2330bcf094db5c7c1cf91a77bc4bbe26378

data/README.md

@@ -34,6 +34,7 @@ dbg(User.last.id)
 
 It appends a caller file, line info and source expression to the debug output.
 
+
 Hash values are pretty printed:
 
 ```ruby
@@ -85,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
@@ -159,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
@@ -135,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.2"
+  VERSION = "0.4.0"
 end

data/spec/inline_spec.rb

@@ -124,4 +124,99 @@ describe DbgRb 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

@@ -124,4 +124,99 @@ describe DbgRb 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.2
+  version: 0.4.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-21 00:00:00.000000000 Z
+date: 2025-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -99,6 +99,7 @@ files:
 - 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