dbg-rb 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2db3ba3ac88033948685e877c1b9245f77c4f0c3b3b061d786305ea1a2059113
-  data.tar.gz: 0412b7c4b793aabe451c622fbf293938a5e9dce9ad4ae06d4cda8604d4798df9
+  metadata.gz: fd12005e78ffa686afda779eabb3adf25011f8c2c53a8aeba8b34115f6fc481a
+  data.tar.gz: 4854bb2a74440292fb681b949dcbb44af0c25fb8fba074de45df923827c6f9dc
 SHA512:
-  metadata.gz: 5b655b3c9c88e2e973cf860f1bf8228e27075b115d6ce37e4a0903ae0a062194c15915dcb3cd851b4234dcfa119d669b57af25f563ed4f14c852b5361f67d03b
-  data.tar.gz: d71e5a0b42c1999ab7e981ba467fa7bd19851f26c8e3f5dcd22576db306f756b95edbe04562918b372e9a1e7bfcb96e6449fc08f79dbf5db969844b6240cb994
+  metadata.gz: 2cf2c64ce51787a3613c57a37c090166e22d26b23cf832e00ac1a087469f8eb77beb18a60f85665cd1b50222161a860b7de89383a8ac349667f833f0968922a0
+  data.tar.gz: 6be32da1ee94b9c02ad0be8156daceda13a775482d8f51a30150652b6e2b41d70cc4cb88169e00da3a519efd75fb25c342713b7a43376cd210d907beaaec310e

data/.github/workflows/ci.yml

@@ -27,4 +27,4 @@ jobs:
           bundle install
       - name: Run tests
         run: |
-          bundle exec rspec spec
+          bundle exec rake test

data/README.md

@@ -1,4 +1,4 @@
-# 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 [![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)
  
@@ -16,10 +16,9 @@ too many times already.
 
 ## Installation
 
-`Gemfile`
-```ruby
-gem "dbg-rb"
-```
+`bundle add dbg-rb`
+
+Alternatively, you can use an inline version of `dbg-rb` without adding it to the Gemfile. Check out [this post](https://pawelurbanek.com/rails-puts-debug#inline-setup) for info on how to do it.
 
 ## Usage
 
@@ -98,14 +97,6 @@ DbgRb.highlight!("🎉💔💣🕺🚀🧨🙈🤯🥳🌈🦄")
 
 ![Dbg emoji](https://github.com/pawurb/dbg-rb/raw/main/dbg_emoji.png)
 
-You can also use `DbgRb.dbg!(*msgs)` directly or wrap it to rename the helper method:
-
-```ruby
-def dd(*msgs)
-  DbgRb.dbg!(*msgs)
-end
-```
-
 ## Status
 
 Contributions & ideas very welcome!

data/Rakefile

@@ -7,5 +7,6 @@ desc "Run tests"
 task :default => :test
 
 task :test do
-  system("bundle exec rspec spec")
+  system("bundle exec rspec spec/gem_spec.rb")
+  system("bundle exec rspec spec/inline_spec.rb")
 end

data/dbg-rb.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n").reject { |f| f.match?(/\.db$/) }
   s.require_paths = ["lib"]
   s.license = "MIT"
-  s.add_dependency "binding_of_caller"
   s.add_dependency "json"
   s.add_development_dependency "ostruct"
   s.add_development_dependency "rake"

data/inline/dbg_rb.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+# Source https://github.com/pawurb/dbg-rb
+# The MIT License (MIT)
+
+# Copyright © Paweł Urbanek 2024
+
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require "json"
+
+module DbgRb
+  def self.color_code=(val)
+    Impl.color_code = val
+  end
+
+  def self.highlight!(wrapper = "!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
+    Impl.highlight!(wrapper)
+  end
+
+  def self.dbg(*msgs)
+    Impl.new.dbg(*msgs)
+  end
+
+  class Impl
+    @@color_code = nil
+    @@highlight = false
+
+    def self.color_code=(val)
+      @@color_code = val
+    end
+
+    def self.highlight!(wrapper)
+      @@highlight = wrapper
+    end
+
+    def dbg(value)
+      loc = caller_locations.first(3).last
+      source_file = if (path = loc.absolute_path)
+          path.split("/").last(2).join("/")
+        else
+          loc.label
+        end
+
+      file = loc.absolute_path.split(":").first
+
+      input = nil
+
+      File.open(file) do |f|
+        f.each_line.with_index do |line, i|
+          if i == loc.lineno - 1
+            input = line.split("dbg").last.chomp.strip
+            input = input.gsub(/[()]/, "").strip
+          end
+        end
+      end
+
+      if input.nil?
+        raise "It should never happen!"
+      end
+
+      line = loc.lineno
+      src = "[#{source_file}:#{line}]"
+      value = format_val(value)
+
+      val = if input.to_s == value.to_s
+          "#{value}"
+        else
+          "#{input} = #{value}"
+        end
+      output = "#{src} #{val}"
+
+      if @@highlight
+        output = "#{@@highlight}\n#{output}\n#{@@highlight}"
+      end
+
+      if @@color_code != nil
+        output = colorize(output, @@color_code)
+      end
+
+      puts output
+    end
+
+    private
+
+    def colorize(str, color_code)
+      "\e[#{color_code}m#{str}\e[0m"
+    end
+
+    def format_val(val)
+      if val.is_a?(Hash)
+        res = val.map { |k, v| [k, dbg_inspect(v, quote_str: false)] }.to_h
+        JSON.pretty_generate(res)
+      elsif val.is_a?(Array)
+        JSON.pretty_generate(val.map do |v|
+          dbg_inspect(v, quote_str: false)
+        end)
+      else
+        dbg_inspect(val, quote_str: true)
+      end.then do |value|
+        if value.is_a?(String)
+          value.gsub("\"nil\"", "nil")
+        else
+          value
+        end
+      end
+    end
+
+    def dbg_inspect(obj, quote_str:)
+      if quote_str && obj.is_a?(String)
+        return obj.inspect
+      end
+
+      case obj
+      when Numeric, String
+        obj
+      else
+        obj.inspect
+      end
+    end
+  end
+end
+
+def dbg(value)
+  DbgRb.dbg(value)
+end
+
+DbgRb.color_code = 33 # yellow

data/lib/dbg-rb.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "binding_of_caller"
 require "json"
 
 module DbgRb
@@ -12,8 +11,8 @@ module DbgRb
     Impl.highlight!(wrapper)
   end
 
-  def self.dbg!(*msgs)
-    Impl.new.dbg!(*msgs)
+  def self.dbg(*msgs)
+    Impl.new.dbg(*msgs)
   end
 
   class Impl
@@ -28,54 +27,51 @@ module DbgRb
       @@highlight = wrapper
     end
 
-    def dbg!(*msgs)
+    def dbg(value)
       loc = caller_locations.first(3).last
-      file = if (path = loc.absolute_path)
+      source_file = if (path = loc.absolute_path)
           path.split("/").last(2).join("/")
         else
           loc.label
         end
 
-      line = loc.lineno
-      src = "[#{file}:#{line}]"
-
-      msgs.each_with_index do |obj, i|
-        first = i == 0
-        last = i == (msgs.size - 1)
-
-        val = if obj.is_a?(Symbol)
-            begin
-              val = binding.of_caller(4).local_variable_get(obj)
-              val = format_val(val)
-
-              "#{obj} = #{val}"
-            rescue NameError
-              obj.inspect
-            end
-          else
-            format_val(obj)
-          end
+      file = loc.absolute_path.split(":").first
 
-        output = "#{src} #{val}"
-
-        if @@highlight
-          if first
-            output = "#{@@highlight}\n#{output}"
-          end
+      input = nil
 
-          if last
-            output = "#{output}\n#{@@highlight}"
+      File.open(file) do |f|
+        f.each_line.with_index do |line, i|
+          if i == loc.lineno - 1
+            input = line.split("dbg").last.chomp.strip
+            input = input.gsub(/[()]/, "").strip
           end
         end
+      end
+
+      if input.nil?
+        raise "It should never happen!"
+      end
 
-        if @@color_code != nil
-          output = colorize(output, @@color_code)
+      line = loc.lineno
+      src = "[#{source_file}:#{line}]"
+      value = format_val(value)
+
+      val = if input.to_s == value.to_s
+          "#{value}"
+        else
+          "#{input} = #{value}"
         end
+      output = "#{src} #{val}"
+
+      if @@highlight
+        output = "#{@@highlight}\n#{output}\n#{@@highlight}"
+      end
 
-        puts output
+      if @@color_code != nil
+        output = colorize(output, @@color_code)
       end
 
-      nil
+      puts output
     end
 
     private
@@ -94,6 +90,12 @@ module DbgRb
         end)
       else
         dbg_inspect(val, quote_str: true)
+      end.then do |value|
+        if value.is_a?(String)
+          value.gsub("\"nil\"", "nil")
+        else
+          value
+        end
       end
     end
 
@@ -112,10 +114,8 @@ module DbgRb
   end
 end
 
-def dbg!(*msgs)
-  DbgRb.dbg!(*msgs)
+def dbg(value)
+  DbgRb.dbg(value)
 end
 
 DbgRb.color_code = 33 # yellow
-
-alias dbg dbg!

data/lib/dbg_rb/version.rb

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

data/spec/gem_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "dbg-rb"
+require "ostruct"
+
+describe DbgRb do
+  before do
+    DbgRb.color_code = nil
+  end
+
+  it "constant values" do
+    expect do
+      dbg("123")
+    end.to output("[spec/gem_spec.rb:14] \"123\"\n").to_stdout
+
+    expect do
+      dbg(123)
+    end.to output("[spec/gem_spec.rb:18] 123\n").to_stdout
+
+    expect do
+      dbg(nil)
+    end.to output("[spec/gem_spec.rb:22] nil\n").to_stdout
+
+    expect do
+      dbg "123"
+    end.to output("[spec/gem_spec.rb:26] \"123\"\n").to_stdout
+
+    expect do
+      dbg 123
+    end.to output("[spec/gem_spec.rb:30] 123\n").to_stdout
+
+    expect do
+      dbg nil
+    end.to output("[spec/gem_spec.rb:34] nil\n").to_stdout
+  end
+
+  it "variables" do
+    a = 123
+
+    expect do
+      dbg(a)
+    end.to output("[spec/gem_spec.rb:42] a = 123\n").to_stdout
+
+    b = "123"
+
+    expect do
+      dbg(b)
+    end.to output("[spec/gem_spec.rb:48] b = \"123\"\n").to_stdout
+
+    c = nil
+
+    expect do
+      dbg(c)
+    end.to output("[spec/gem_spec.rb:54] c = nil\n").to_stdout
+  end
+
+  it "complex objects" do
+    s = OpenStruct.new(a: 1, b: 2)
+
+    expect do
+      dbg(s)
+    end.to output("[spec/gem_spec.rb:62] s = #<OpenStruct a=1, b=2>\n").to_stdout
+  end
+
+  it "hashes" do
+    h = { a: 1, b: "2" }
+    expect do
+      dbg(h)
+    end.to output("[spec/gem_spec.rb:69] h = {\n  \"a\": 1,\n  \"b\": \"2\"\n}\n").to_stdout
+  end
+
+  it "arrays" do
+    a = [1, "str"]
+    expect do
+      dbg(a)
+    end.to output("[spec/gem_spec.rb:76] a = [\n  1,\n  \"str\"\n]\n").to_stdout
+  end
+
+  it "hash formatting" do
+    h = { a: 1, b: "2", c: nil }
+    expect do
+      dbg(h)
+    end.to output("[spec/gem_spec.rb:83] h = {\n  \"a\": 1,\n  \"b\": \"2\",\n  \"c\": nil\n}\n").to_stdout
+  end
+
+  it "highlight" do
+    DbgRb.highlight!
+    expect do
+      dbg("123")
+    end.to output("!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/gem_spec.rb:90] \"123\"\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n").to_stdout
+  end
+
+  it "color_code" do
+    DbgRb.color_code = 31
+    expect do
+      dbg(123)
+    end.to output("\e[31m!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/gem_spec.rb:97] 123\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\e[0m\n").to_stdout
+  end
+
+  it "highlight and color_code" do
+    DbgRb.highlight!
+    DbgRb.color_code = 31
+    expect do
+      dbg(123)
+    end.to output("\e[31m!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/gem_spec.rb:105] 123\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\e[0m\n").to_stdout
+  end
+end

data/spec/inline_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "dbg-rb"
+require "ostruct"
+
+describe DbgRb do
+  before do
+    DbgRb.color_code = nil
+  end
+
+  it "constant values" do
+    expect do
+      dbg("123")
+    end.to output("[spec/inline_spec.rb:14] \"123\"\n").to_stdout
+
+    expect do
+      dbg(123)
+    end.to output("[spec/inline_spec.rb:18] 123\n").to_stdout
+
+    expect do
+      dbg(nil)
+    end.to output("[spec/inline_spec.rb:22] nil\n").to_stdout
+
+    expect do
+      dbg "123"
+    end.to output("[spec/inline_spec.rb:26] \"123\"\n").to_stdout
+
+    expect do
+      dbg 123
+    end.to output("[spec/inline_spec.rb:30] 123\n").to_stdout
+
+    expect do
+      dbg nil
+    end.to output("[spec/inline_spec.rb:34] nil\n").to_stdout
+  end
+
+  it "variables" do
+    a = 123
+
+    expect do
+      dbg(a)
+    end.to output("[spec/inline_spec.rb:42] a = 123\n").to_stdout
+
+    b = "123"
+
+    expect do
+      dbg(b)
+    end.to output("[spec/inline_spec.rb:48] b = \"123\"\n").to_stdout
+
+    c = nil
+
+    expect do
+      dbg(c)
+    end.to output("[spec/inline_spec.rb:54] c = nil\n").to_stdout
+  end
+
+  it "complex objects" do
+    s = OpenStruct.new(a: 1, b: 2)
+
+    expect do
+      dbg(s)
+    end.to output("[spec/inline_spec.rb:62] s = #<OpenStruct a=1, b=2>\n").to_stdout
+  end
+
+  it "hashes" do
+    h = { a: 1, b: "2" }
+    expect do
+      dbg(h)
+    end.to output("[spec/inline_spec.rb:69] h = {\n  \"a\": 1,\n  \"b\": \"2\"\n}\n").to_stdout
+  end
+
+  it "arrays" do
+    a = [1, "str"]
+    expect do
+      dbg(a)
+    end.to output("[spec/inline_spec.rb:76] a = [\n  1,\n  \"str\"\n]\n").to_stdout
+  end
+
+  it "hash formatting" do
+    h = { a: 1, b: "2", c: nil }
+    expect do
+      dbg(h)
+    end.to output("[spec/inline_spec.rb:83] h = {\n  \"a\": 1,\n  \"b\": \"2\",\n  \"c\": nil\n}\n").to_stdout
+  end
+
+  it "highlight" do
+    DbgRb.highlight!
+    expect do
+      dbg("123")
+    end.to output("!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/inline_spec.rb:90] \"123\"\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n").to_stdout
+  end
+
+  it "color_code" do
+    DbgRb.color_code = 31
+    expect do
+      dbg(123)
+    end.to output("\e[31m!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/inline_spec.rb:97] 123\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\e[0m\n").to_stdout
+  end
+
+  it "highlight and color_code" do
+    DbgRb.highlight!
+    DbgRb.color_code = 31
+    expect do
+      dbg(123)
+    end.to output("\e[31m!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/inline_spec.rb:105] 123\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\e[0m\n").to_stdout
+  end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dbg-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-05 00:00:00.000000000 Z
+date: 2025-05-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: binding_of_caller
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -111,9 +97,11 @@ files:
 - dbg-rb.gemspec
 - dbg_base.png
 - dbg_emoji.png
+- inline/dbg_rb.rb
 - lib/dbg-rb.rb
 - lib/dbg_rb/version.rb
-- spec/smoke_spec.rb
+- spec/gem_spec.rb
+- spec/inline_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/pawurb/dbg-rb
 licenses:

data/spec/smoke_spec.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-require "dbg-rb"
-require "ostruct"
-
-describe DbgRb do
-  before do
-    DbgRb.color_code = nil
-  end
-
-  it "variable values" do
-    expect { dbg("123") }.to output("[spec/smoke_spec.rb:13] \"123\"\n").to_stdout
-  end
-
-  it "binded variables" do
-    b = 123
-    expect { dbg(:b) }.to output("[spec/smoke_spec.rb:18] b = 123\n").to_stdout
-  end
-
-  it "missing binded variables" do
-    b = 123
-    expect { dbg(:c) }.to output("[spec/smoke_spec.rb:23] :c\n").to_stdout
-  end
-
-  it "complex objects" do
-    s = OpenStruct.new(a: 1, b: 2)
-    expect { dbg!(s) }.to output("[spec/smoke_spec.rb:28] #<OpenStruct a=1, b=2>\n").to_stdout
-  end
-
-  it "binded complex objects" do
-    s = OpenStruct.new(a: 1, b: 2)
-    expect { dbg!(:s) }.to output("[spec/smoke_spec.rb:33] s = #<OpenStruct a=1, b=2>\n").to_stdout
-  end
-
-  it "multiple msg" do
-    s = OpenStruct.new(a: 1, b: 2)
-    expect { dbg!(:s, "other msg") }.to output("[spec/smoke_spec.rb:38] s = #<OpenStruct a=1, b=2>\n[spec/smoke_spec.rb:38] \"other msg\"\n").to_stdout
-  end
-
-  it "nil" do
-    expect { dbg!(nil) }.to output("[spec/smoke_spec.rb:42] nil\n").to_stdout
-  end
-
-  it "highlight" do
-    DbgRb.highlight!
-    expect { dbg!("123") }.to output("!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/smoke_spec.rb:47] \"123\"\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n").to_stdout
-  end
-
-  it "color_code" do
-    DbgRb.color_code = 31
-    expect { dbg!(123) }.to output("\e[31m!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/smoke_spec.rb:52] 123\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\e[0m\n").to_stdout
-  end
-
-  it "alias" do
-    DbgRb.highlight!(false)
-    DbgRb.color_code = nil
-
-    expect {
-      dbg(123)
-    }.to output("[spec/smoke_spec.rb:60] 123\n").to_stdout
-  end
-
-  it "binded nil variables" do
-    b = nil
-    expect { dbg(:b) }.to output("[spec/smoke_spec.rb:66] b = nil\n").to_stdout
-  end
-
-  it "hashes" do
-    h = { a: 1, b: "2" }
-    expect { dbg!(h) }.to output("[spec/smoke_spec.rb:71] {\n  \"a\": 1,\n  \"b\": \"2\"\n}\n").to_stdout
-  end
-
-  it "arrays" do
-    a = [1, "str"]
-    expect { dbg!(a) }.to output("[spec/smoke_spec.rb:76] [\n  1,\n  \"str\"\n]\n").to_stdout
-  end
-end