dbg-rb 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b59e26796df37f516bbf9e49abf36ef3e6381251efb147a8cfebc2dc3b25e859
-  data.tar.gz: fb966c5473b1a5799fbb7c6d74823aa62821e054f8af7dfa4f6e05f39efe30fa
+  metadata.gz: 2db3ba3ac88033948685e877c1b9245f77c4f0c3b3b061d786305ea1a2059113
+  data.tar.gz: 0412b7c4b793aabe451c622fbf293938a5e9dce9ad4ae06d4cda8604d4798df9
 SHA512:
-  metadata.gz: d282afefaa8acb843fea7bd553ba3d31e323f58693ea14c96e8f14cc3c5fbf190f520d30b19521ac28636c8f02387f24dd8e15850c996a3d5a4dd7ba5ce69592
-  data.tar.gz: 815a02500042f53cb9d8e170efd5efef323d68a994258c7b3df59de62c371958b48019ba2a83c6a73b491a8b22b1669cf70058228fdc63ac382934bc41704349
+  metadata.gz: 5b655b3c9c88e2e973cf860f1bf8228e27075b115d6ce37e4a0903ae0a062194c15915dcb3cd851b4234dcfa119d669b57af25f563ed4f14c852b5361f67d03b
+  data.tar.gz: d71e5a0b42c1999ab7e981ba467fa7bd19851f26c8e3f5dcd22576db306f756b95edbe04562918b372e9a1e7bfcb96e6449fc08f79dbf5db969844b6240cb994

data/.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['3.3', '3.2', '3.1', '3.0', '2.7', '2.6']
+        ruby-version: ['3.4', '3.3', '3.2', '3.1', '3.0', '2.7', '2.6']
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby ${{ matrix.ruby-version }}

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_base3.png)
+![Dbg base](https://github.com/pawurb/dbg-rb/raw/main/dbg_base.png)
  
 Because I wrote: 
 
@@ -77,7 +77,7 @@ DbgRb.color_code = 33
 It's yellow by default. You can disable colors by running:
 
 ```ruby
-DbgRb.color_code= nil
+DbgRb.color_code = nil
 ```
 
 ```ruby
@@ -85,7 +85,7 @@ user = User.last.as_json.slice("id", "slack_id")
 dbg("User last", :user)
 ```
 
-![Dbg color](https://github.com/pawurb/dbg-rb/raw/main/dbg_base3.png)
+![Dbg color](https://github.com/pawurb/dbg-rb/raw/main/dbg_base.png)
 
 If it does not stand out enough, you can enable `dbg` highlighting:
 
@@ -96,7 +96,7 @@ require "dbg-rb"
 DbgRb.highlight!("🎉💔💣🕺🚀🧨🙈🤯🥳🌈🦄")
 ```
 
-![Dbg emoji](https://github.com/pawurb/dbg-rb/raw/main/dbg_emoji2.png)
+![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:
 

data/dbg-rb.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version = DbgRb::VERSION
   s.authors = ["pawurb"]
   s.email = ["contact@pawelurbanek.com"]
-  s.summary = "Simple debuging helper"
+  s.summary = "Simple debugging helper"
   s.description = "Rust-inspired, puts debugging helper, adding caller info and optional coloring."
   s.homepage = "http://github.com/pawurb/dbg-rb"
   s.files = `git ls-files`.split("\n").reject { |f| f.match?(/\.db$/) }
@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.license = "MIT"
   s.add_dependency "binding_of_caller"
   s.add_dependency "json"
+  s.add_development_dependency "ostruct"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rufo"

data/lib/dbg-rb.rb

@@ -29,15 +29,14 @@ module DbgRb
     end
 
     def dbg!(*msgs)
-      loc = caller_locations.first(3).last.to_s
-      matching_loc = loc.match(/.+(rb)\:\d+\:(in)\s/)
-      src = if !matching_loc.nil?
-          matching_loc[0][0..-5]
+      loc = caller_locations.first(3).last
+      file = if (path = loc.absolute_path)
+          path.split("/").last(2).join("/")
         else
-          loc
+          loc.label
         end
-      file, line = src.split(":")
-      file = file.split("/").last(2).join("/")
+
+      line = loc.lineno
       src = "[#{file}:#{line}]"
 
       msgs.each_with_index do |obj, i|
@@ -51,7 +50,7 @@ module DbgRb
 
               "#{obj} = #{val}"
             rescue NameError
-              ":#{obj}"
+              obj.inspect
             end
           else
             format_val(obj)
@@ -79,19 +78,35 @@ module DbgRb
       nil
     end
 
+    private
+
     def colorize(str, color_code)
       "\e[#{color_code}m#{str}\e[0m"
     end
 
     def format_val(val)
-      if val.nil?
-        "nil"
-      elsif val.is_a?(String)
-        "\"#{val}\""
-      elsif val.is_a?(Hash) || val.is_a?(Array)
-        JSON.pretty_generate(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
+    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
-        val
+        obj.inspect
       end
     end
   end

data/lib/dbg_rb/version.rb

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

data/spec/smoke_spec.rb

@@ -5,47 +5,51 @@ 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:9] \"123\"\n").to_stdout
+    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:14] b = 123\n").to_stdout
+    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:19] :c\n").to_stdout
+    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:24] #<OpenStruct a=1, b=2>\n").to_stdout
+    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:29] s = #<OpenStruct a=1, b=2>\n").to_stdout
+    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:34] s = #<OpenStruct a=1, b=2>\n[spec/smoke_spec.rb:34] \"other msg\"\n").to_stdout
+    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:38] nil\n").to_stdout
+    expect { dbg!(nil) }.to output("[spec/smoke_spec.rb:42] nil\n").to_stdout
   end
 
-  it "higlight" do
+  it "highlight" do
     DbgRb.highlight!
-    expect { dbg!("123") }.to output("!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/smoke_spec.rb:43] \"123\"\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n").to_stdout
+    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:48] 123\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\e[0m\n").to_stdout
+    expect { dbg!(123) }.to output("\e[31m!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/smoke_spec.rb:52] 123\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\e[0m\n").to_stdout
   end
 
   it "alias" do
@@ -54,11 +58,21 @@ describe DbgRb do
 
     expect {
       dbg(123)
-    }.to output("[spec/smoke_spec.rb:56] 123\n").to_stdout
+    }.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:62] b = nil\n").to_stdout
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbg-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.8
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2025-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,9 +109,8 @@ files:
 - README.md
 - Rakefile
 - dbg-rb.gemspec
-- dbg_base3.png
-- dbg_color.png
-- dbg_emoji2.png
+- dbg_base.png
+- dbg_emoji.png
 - lib/dbg-rb.rb
 - lib/dbg_rb/version.rb
 - spec/smoke_spec.rb
@@ -122,8 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: Simple debuging helper
+summary: Simple debugging helper
 test_files: []