dbg-rb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09b1254dce075461fa3f871339727687bb71c3ed3c665a402f4eb391186f3d73'
+  data.tar.gz: 534dc75a914ad52ee594a298f6be6ec7e8b44cda80ac5749dab66a28956732a9
+SHA512:
+  metadata.gz: 52ec38c67acc0cd2c8876d9168262d5d5293fb881cc2192a70cd39578ee82d4814e60bdacf48b8f5967b3e13c839c1e4bcf54bfcdaae9c4103d1562d9d38dd96
+  data.tar.gz: 2850472008c78ac1d28e1a38360c29b61bc2234c0f7f925f11a18dcc7a931b504b51595b522c36e11bce595960f28f5da59062faabd445165ca20a23ec27794b

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.3', '3.2', '3.1', '3.0', '2.7', '2.6']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Setup dependencies
+        run: |
+          gem install bundler -v 2.4.22
+          sudo apt-get update --allow-releaseinfo-change
+          bundle config set --local path 'vendor/bundle'
+          bundle install
+      - name: Run tests
+        run: |
+          bundle exec rake test

data/.gitignore

@@ -0,0 +1,8 @@
+Gemfile.lock
+.bundle/
+.ruby-version
+pkg/
+*.gem
+docker-compose.yml
+.byebug_history
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -0,0 +1,105 @@
+# 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)
+ 
+Because I wrote: 
+
+```ruby
+p '!!!!!!!!!!!!!!!'
+p msg
+p '!!!!!!!!!!!!!!!'
+```
+
+too many times already.
+ 
+`dbg!` is a minimal, [Rust inspired](https://doc.rust-lang.org/std/macro.dbg.html), *puts debugging* command for Ruby. It provides caller context and formatting helpful in everyday debugging tasks.
+
+## Installation
+
+`Gemfile`
+```ruby
+gem "dbg-rb"
+```
+
+## Usage
+
+Gem adds a global `dbg!` method that you can use for puts debugging:
+
+```ruby
+require "dbg-rb"
+
+dbg!(User.last.id)
+# [web/user_sessions_controller.rb:37] 1972
+
+```
+
+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:
+
+```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 = {
+#   "id": 160111,
+#   "team_id": 1,
+#   "pseudonym": "Anonymous-CBWE",
+#   ...
+# }
+```
+
+You can color the output:
+
+`config/initializers/dbg_rb.rb`
+```ruby
+require "dbg-rb"
+
+DbgRb.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)
+```
+
+![Dbg color](https://github.com/pawurb/dbg-rb/raw/main/dbg_base3.png)
+
+If it does not stand out enough, you can enable `dbg!` highlighting:
+
+`config/initializers/dbg_rb.rb`
+```ruby
+require "dbg-rb"
+
+DbgRb.highlight!("🎉💔💣🕺🚀🧨🙈🤯🥳🌈🦄")
+```
+
+![Dbg emoji](https://github.com/pawurb/dbg-rb/raw/main/dbg_emoji2.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

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+end
+
+desc "Run tests"
+task :default => :test

data/lib/dbg-rb.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "binding_of_caller"
+
+module DbgRb
+  @@color_code = nil
+  @@highlight = false
+
+  def self.color_code=(val)
+    @@color_code = val
+  end
+
+  def self.highlight!(wrapper = "!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
+    @@highlight = wrapper
+  end
+
+  def self.colorize(str, color_code)
+    "\e[#{color_code}m#{str}\e[0m"
+  end
+
+  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?
+        matching_loc[0][0..-5]
+      else
+        loc
+      end
+    file, line = src.split(":")
+    file = file.split("/").last(2).join("/")
+    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
+            if (val = binding.of_caller(3).local_variable_get(obj))
+              val = format_val(val)
+
+              "#{obj} = #{val}"
+            end
+          rescue NameError
+            ":#{obj}"
+          end
+        else
+          format_val(obj)
+        end
+
+      output = "#{src} #{val}"
+
+      if @@highlight
+        if first
+          output = "#{@@highlight}\n#{output}"
+        end
+
+        if last
+          output = "#{output}\n#{@@highlight}"
+        end
+      end
+
+      if @@color_code != nil
+        output = colorize(output, @@color_code)
+      end
+
+      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
+      val
+    end
+  end
+end
+
+def dbg!(*msgs)
+  DbgRb.dbg!(*msgs)
+end

data/lib/dbg_rb/version.rb

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

data/ruby-dbg.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dbg_rb/version"
+
+Gem::Specification.new do |s|
+  s.name = "dbg-rb"
+  s.version = DbgRb::VERSION
+  s.authors = ["pawurb"]
+  s.email = ["contact@pawelurbanek.com"]
+  s.summary = "Simple debuging 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$/) }
+  s.require_paths = ["lib"]
+  s.license = "MIT"
+  s.add_dependency "binding_of_caller"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rufo"
+
+  if s.respond_to?(:metadata=)
+    s.metadata = { "rubygems_mfa_required" => "true" }
+  end
+end

data/spec/smoke_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "dbg-rb"
+require "ostruct"
+
+describe DbgRb do
+  it "variable values" do
+    expect { dbg!("123") }.to output("[spec/smoke_spec.rb:9] \"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
+  end
+
+  it "missing binded variables" do
+    b = 123
+    expect { dbg!(:c) }.to output("[spec/smoke_spec.rb:19] :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
+  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
+  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
+  end
+
+  it "nil" do
+    expect { dbg!(nil) }.to output("[spec/smoke_spec.rb:38] nil\n").to_stdout
+  end
+
+  it "higlight" do
+    DbgRb.highlight!
+    expect { dbg!("123") }.to output("!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n[spec/smoke_spec.rb:43] \"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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+require_relative "../lib/dbg-rb"
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: dbg-rb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- pawurb
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-10 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: rake
+  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: rspec
+  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: rufo
+  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'
+description: Rust-inspired, puts debugging helper, adding caller info and optional
+  coloring.
+email:
+- contact@pawelurbanek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dbg_base3.png
+- dbg_color.png
+- dbg_emoji2.png
+- lib/dbg-rb.rb
+- lib/dbg_rb/version.rb
+- ruby-dbg.gemspec
+- spec/smoke_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/pawurb/dbg-rb
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Simple debuging helper
+test_files: []