ruby-dbg 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33f3c6c9714873133b2a1ef2c27cf3082c2fc7d3f21da8bea618b736c5ec9c08
-  data.tar.gz: dd6538c2ccbece1f6cb2075fc40f3945e42a01169e760b303cb60cc1600a488f
+  metadata.gz: 0ca651aa1267afde97f2e44eb08f5671b143c3cf2c3903dbac3f3f212995230e
+  data.tar.gz: c157e4cc54e79d8f583c7ca27b3d22d7f62f26dcbd171150df7647c1c350615b
 SHA512:
-  metadata.gz: 6064bc5754ea293363bddc8206945e118ffff14aa6de73131667c7f1484b1793e30a0b8861aa30447a66badd3d1666c0ec6fb4ac2e5970672bc28a4720c9d21e
-  data.tar.gz: a4f49fb90164b6ae5402eeedf5874751365b10a39506195706b2c349adb4be7bb26d9507a59d7e84cfa35a3737a487e3f18fc41abc4bdf941d3c7043e19001b5
+  metadata.gz: 5d2b0c99545d527c6527c86dec6480e17b95b24f3ea31afe46f6bfbbdf6a1bcdc8eabf1c6e3cd53b394eac5a615887d099785b025cd6c85a8b41122740eaad09
+  data.tar.gz: f6cdb7be7f68846049582220fbd74b6176150952d3f9c345be0a7f8ad1609440c65f2a3bf180ab37ef9c8c696101e2a96cf764a8dcc55c827c1a803d1656f186

data/README.md

@@ -1,5 +1,7 @@
-# Ruby dbg!
+# Ruby dbg! [![Gem Version](https://badge.fury.io/rb/ruby-dbg.svg)](https://badge.fury.io/rb/ruby-dbg) [![GH Actions](https://github.com/pawurb/ruby-dbg/actions/workflows/ci.yml/badge.svg)](https://github.com/pawurb/ruby-dbg/actions)
 
+![Dbg base](https://github.com/pawurb/ruby-dbg/raw/main/dbg_base3.png)
+ 
 Because I wrote: 
 
 ```ruby
@@ -19,7 +21,9 @@ too many times already.
 gem "ruby-dbg"
 ```
 
-It adds a global `dbg!` method. You can use it for puts debugging:
+## Usage
+
+Gem adds a global `dbg!` method that you can use for puts debugging:
 
 ```ruby
 require "ruby-dbg"
@@ -29,7 +33,7 @@ dbg!(User.last.id)
 
 ```
 
-It appends relevant caller file and line info to the debug output.
+It appends a caller file and line info to the debug output.
 
 You can use symbols to output local variable names together with their values:
 
@@ -45,9 +49,9 @@ dbg!(:a, :b)
 Hash values are pretty printed:
 
 ```ruby
-
-dbg!(User.last.as_json)
-# [web/users_controller.rb:10 {
+user = User.last.as_json
+dbg!(:user)
+# [web/users_controller.rb:10 user = {
 #   "id": 160111,
 #   "team_id": 1,
 #   "pseudonym": "Anonymous-CBWE",
@@ -55,31 +59,46 @@ dbg!(User.last.as_json)
 # }
 ```
 
-You can enable coloring the output:
+You can color the output:
 
 `config/initializers/ruby_dbg.rb`
 ```ruby
 require "ruby-dbg"
 
-RubyDBG.color_code = 36 # light blue
+RubyDBG.color_code = 35 
 # 31 red 
 # 32 green 
 # 33 yellow 
 # 34 blue 
 # 35 pink 
+# 36 light blue
+```
+
+```ruby
+user = User.last.as_json.slice("id", "slack_id")
+dbg!("User last", :user)
 ```
 
-![Diagnose report](https://github.com/pawurb/ruby-dbg/raw/main/dbg_color.png)
+![Dbg color](https://github.com/pawurb/ruby-dbg/raw/main/dbg_base3.png)
 
 If it does not stand out enough, you can enable `dbg!` highlighting:
 
+`config/initializers/ruby_dbg.rb`
 ```ruby
 require "ruby-dbg"
 
 RubyDBG.highlight!("🎉💔💣🕺🚀🧨🙈🤯🥳🌈🦄")
 ```
 
-![Diagnose report](https://github.com/pawurb/ruby-dbg/raw/main/dbg_emoji.png)
+![Dbg emoji](https://github.com/pawurb/ruby-dbg/raw/main/dbg_emoji2.png)
+
+You can also use `RubyDBG.dbg!(*msgs)` directly or wrap it to rename the helper method:
+
+```ruby
+def dd(*msgs)
+  RubyDBG.dbg!(*msgs)
+end
+```
 
 ## Status
 

data/lib/ruby-dbg.rb

@@ -18,7 +18,7 @@ module RubyDBG
     "\e[#{color_code}m#{str}\e[0m"
   end
 
-  def self.dbg(*objs)
+  def self.dbg!(*msgs)
     loc = caller_locations.first(2).last.to_s
     matching_loc = loc.match(/.+(rb)\:\d+\:(in)\s/)
     src = if !matching_loc.nil?
@@ -30,9 +30,9 @@ module RubyDBG
     file = file.split("/").last(2).join("/")
     src = "[#{file}:#{line}]"
 
-    objs.each_with_index do |obj, i|
+    msgs.each_with_index do |obj, i|
       first = i == 0
-      last = i == (objs.size - 1)
+      last = i == (msgs.size - 1)
 
       val = if obj.is_a?(Symbol)
           begin
@@ -45,10 +45,9 @@ module RubyDBG
             ":#{obj}"
           end
         else
-          obj
+          format_val(obj)
         end
 
-      val = format_val(val)
       output = "#{src} #{val}"
 
       if @@highlight
@@ -67,11 +66,15 @@ module RubyDBG
 
       puts output
     end
+
+    nil
   end
 
   def self.format_val(val)
     if val.nil?
       "nil"
+    elsif val.is_a?(String)
+      "\"#{val}\""
     elsif val.is_a?(Hash)
       JSON.pretty_generate(val)
     else
@@ -80,7 +83,6 @@ module RubyDBG
   end
 end
 
-def dbg!(*objs)
-  RubyDBG.dbg(*objs)
-  nil
+def dbg!(*msgs)
+  RubyDBG.dbg!(*msgs)
 end

data/lib/ruby_dbg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyDBG
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/ruby-dbg.gemspec

@@ -8,11 +8,10 @@ Gem::Specification.new do |s|
   s.version = RubyDBG::VERSION
   s.authors = ["pawurb"]
   s.email = ["contact@pawelurbanek.com"]
-  s.summary = %q{ Simple debug helper }
-  s.description = %q{ Puts debugging helper, adding file context info and optional coloring. }
+  s.summary = "Simple debuging helper"
+  s.description = "Rust-inspired, puts debugging helper, adding caller info and optional coloring."
   s.homepage = "http://github.com/pawurb/ruby-dbg"
   s.files = `git ls-files`.split("\n").reject { |f| f.match?(/\.db$/) }
-  s.test_files = s.files.grep(%r{^(spec)/})
   s.require_paths = ["lib"]
   s.license = "MIT"
   s.add_dependency "binding_of_caller"

data/spec/smoke_spec.rb

@@ -6,7 +6,7 @@ require "ostruct"
 
 describe RubyDBG do
   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:9] \"123\"\n").to_stdout
   end
 
   it "binded variables" do
@@ -29,9 +29,9 @@ describe RubyDBG do
     expect { dbg!(:s) }.to output("[spec/smoke_spec.rb:29] s = #<OpenStruct a=1, b=2>\n").to_stdout
   end
 
-  it "label case" do
+  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:34] s = #<OpenStruct a=1, b=2>\n[spec/smoke_spec.rb:34] \"other msg\"\n").to_stdout
   end
 
   it "nil" do
@@ -40,11 +40,11 @@ describe RubyDBG do
 
   it "higlight" do
     RubyDBG.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:43] \"123\"\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n").to_stdout
   end
 
   it "color_code" do
     RubyDBG.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:48] 123\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!\e[0m\n").to_stdout
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dbg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - pawurb
@@ -66,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: " Puts debugging helper, adding file context info and optional coloring. "
+description: Rust-inspired, puts debugging helper, adding caller info and optional
+  coloring.
 email:
 - contact@pawelurbanek.com
 executables: []
@@ -79,8 +80,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- dbg_base3.png
 - dbg_color.png
-- dbg_emoji.png
+- dbg_emoji2.png
 - lib/ruby-dbg.rb
 - lib/ruby_dbg/version.rb
 - ruby-dbg.gemspec
@@ -109,7 +111,5 @@ requirements: []
 rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
-summary: Simple debug helper
-test_files:
-- spec/smoke_spec.rb
-- spec/spec_helper.rb
+summary: Simple debuging helper
+test_files: []