amazing_tap 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c4b473b57dcf521b113674ad0431d7da96e3478588e1462ad237ff256e56288
-  data.tar.gz: 35a26f22961d7157a546875c1620b33dafd02204326cdc3617a09cf96bc22b08
+  metadata.gz: '019dd9259e1444c65ca33a93706e9d7657e7282b834be82c770d6a8d68931b70'
+  data.tar.gz: 58d6ef4119ea94a0d37a1fe1e8a7d0036974ec75a4c72d0cb37e9959f1a00c76
 SHA512:
-  metadata.gz: d87b4f5bed0c1494deb79e5d3c587a92711ee3c955ea8ea054e0b0e3eacfe5a169c3d8d61e69311ebffb9b18cbebc0334ec26263a7a7b335b7f0dfb9ffa06a18
-  data.tar.gz: 3cafc6a035ef83800e4f5f8f8cd7f0092e6b8d04ca644418ef7fd09105114ba5dc4ab56e80e2e21074f2f26d3b7ba9738d7a787f0d2438830c4e80c4ee25919f
+  metadata.gz: 5e55b7a83f6b4bd0c292d7377d578724588baef68ce9411d21937aa529c00ea5f5faf3d46a361cf83c744909c391947a5339966d167f94afa1c82c9ef25310b9
+  data.tar.gz: ec061ac3c413bba46df4dd619b77f27bfecdaeca20267ba1d9407d9c82bad5be5f591ba9081ba1e841d89ea4f84bd050a126a3b2aa321e1f9095dbbfef7813e8

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+## [0.1.2] - 2026-08-08
+
+- `AmazingTap.show_type` global toggle for the class in headers; per-call `type:` still overrides
+
+## [0.1.1] - 2026-08-08
+
+- README overhaul: typed hash intro example with real output, per-option outputs in Usage, link to colorized terminal screenshot
+
 ## [0.1.0] - 2026-08-08
 
 First release as `amazing_tap`, forked from [tap_amazing_print](https://github.com/shu0115/tap_amazing_print) 0.1.1.

data/README.md

@@ -2,6 +2,31 @@
 
 Labeled, chain-safe debugging built on [amazing_print](https://github.com/amazing-print/amazing_print). `tapp` pretty-prints the receiver with a label inferred from the variable it was called on, plus its class and optional caller frames, then returns the receiver unchanged. Native `Object#tap` is not touched.
 
+```ruby
+require "amazing_tap"
+
+user = {
+  id: 42,
+  name: "Ada Lovelace",
+  admin: true,
+  roles: [:owner, :editor]
+}
+
+user.tapp
+# user (Hash)
+# {
+#        id: 42,
+#      name: "Ada Lovelace",
+#     admin: true,
+#     roles: [
+#         [0] :owner,
+#         [1] :editor
+#     ]
+# }
+```
+
+Output is colorized in a terminal: [screenshot](https://github.com/dportalesr/amazing_tap/blob/main/.github/tapp-intro.png)
+
 Fork of [shu0115/tap_amazing_print](https://github.com/shu0115/tap_amazing_print).
 
 ## Installation
@@ -19,23 +44,58 @@ gem install amazing_tap
 
 ## Usage
 
+Examples below use:
+
 ```ruby
-require "amazing_tap"
+user = { id: 42, name: "Ada Lovelace" }
+```
 
-user = { id: 7, name: "Ada" }
+Chained receivers are inferred as written:
 
-user.tapp
-# user (Hash)
+```ruby
+account.owner.tapp
+# account.owner (Hash)
 # {
-#       :id => 7,
-#     :name => "Ada"
+#       id: 42,
+#     name: "Ada Lovelace"
 # }
+```
+
+Explicit label instead of inference:
+
+```ruby
+user.tapp(:after_update)
+# after_update (Hash)
+# { ... }
+```
+
+Label without the class:
+
+```ruby
+user.tapp(type: false)
+# user
+# { ... }
+```
 
-account.owner.tapp             # chains inferred as written: "account.owner (Hash)"
-user.tapp(:after_update)       # explicit label instead of inference
-user.tapp(type: false)         # label without the class
-user.tapp(backtrace: true)     # appends "  from <frame>" lines for the full caller
-user.tapp(backtrace: 3)        # first 3 frames only
+Append the full caller as `from` lines:
+
+```ruby
+user.tapp(backtrace: true)
+# user (Hash)
+# { ... }
+#   from app/services/sync.rb:17:in 'Object#refresh'
+#   from app/services/sync.rb:19:in '<main>'
+```
+
+Or only the first N frames:
+
+```ruby
+user.tapp(backtrace: 3)
+# user (Hash)
+# { ... }
+#   from app/services/sync.rb:22:in 'Object#persist'
+#   from app/services/sync.rb:26:in 'Object#sync'
+#   from app/services/sync.rb:28:in '<main>'
 ```
 
 Label inference reads the receiver expression at the call site. It covers local variables, `@ivars`, `$globals`, dotted chains, and index access. When the source is not inferable (literals, parenthesized calls, multiline chains, REPL/eval), the header falls back to the class alone:
@@ -43,7 +103,7 @@ Label inference reads the receiver expression at the call site. It covers local
 ```ruby
 { a: 1 }.tapp
 # (Hash)
-# { :a => 1 }
+# { a: 1 }
 ```
 
 Long output gets a closing marker so you can tell where each dump ends:
@@ -61,6 +121,7 @@ big_list.tapp
 
 ```ruby
 AmazingTap.closing_threshold = 40   # lines before the closing "/label" appears; default 24
+AmazingTap.show_type = false        # drop the class from headers globally; per-call type: overrides
 ```
 
 Output is colorized whenever amazing_print would colorize (tty, or `AmazingPrint.force_colors!`).

data/lib/amazing_tap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AmazingTap
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/amazing_tap.rb

@@ -20,6 +20,16 @@ module AmazingTap
       @closing_threshold ||= DEFAULT_CLOSING_THRESHOLD
     end
 
+    # Global default for appending the receiver's class to the header.
+    # Per-call type: overrides it either way.
+    #
+    # @return [Boolean] defaults to true
+    attr_writer :show_type
+
+    def show_type
+      @show_type.nil? ? true : @show_type
+    end
+
     # Extracts the receiver expression preceding .tapp/.tapap on the call-site
     # line, e.g. "user" for `user.tapp` or "account.owner" for
     # `account.owner.tapp`. Inference is textual: literals, parenthesized
@@ -85,7 +95,7 @@ module AmazingTap
     #   the first N frames (Integer) after the output
     # @return [self]
     # @raise [ArgumentError] when label is neither nil nor a Symbol
-    def tapp(label = nil, type: true, backtrace: false)
+    def tapp(label = nil, type: AmazingTap.show_type, backtrace: false)
       raise ArgumentError, "label must be a Symbol" unless label.nil? || label.is_a?(Symbol)
 
       label ||= AmazingTap.infer_label(caller_locations(1, 1).first)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amazing_tap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Daniel Portales Rosado
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.18
 specification_version: 4
 summary: amazing_tap
 test_files: []