amazing_tap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c4b473b57dcf521b113674ad0431d7da96e3478588e1462ad237ff256e56288
+  data.tar.gz: 35a26f22961d7157a546875c1620b33dafd02204326cdc3617a09cf96bc22b08
+SHA512:
+  metadata.gz: d87b4f5bed0c1494deb79e5d3c587a92711ee3c955ea8ea054e0b0e3eacfe5a169c3d8d61e69311ebffb9b18cbebc0334ec26263a7a7b335b7f0dfb9ffa06a18
+  data.tar.gz: 3cafc6a035ef83800e4f5f8f8cd7f0092e6b8d04ca644418ef7fd09105114ba5dc4ab56e80e2e21074f2f26d3b7ba9738d7a787f0d2438830c4e80c4ee25919f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [Unreleased]
+
+## [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.
+
+- `tapp` prints the receiver via amazing_print with a header line and returns it; label inferred from the receiver expression at the call site, `tapp(:label)` to set it explicitly
+- Header includes the receiver's class; disable with `type: false`; class-only header when inference fails
+- `backtrace: true` appends caller frames, `backtrace: N` limits to N frames
+- Output longer than `AmazingTap.closing_threshold` lines (default 24, globally configurable) ends with a `/label` marker
+- Header and markers colorized under the same conditions as amazing_print output
+- `tapap` kept as alias of `tapp`; native `Object#tap` untouched

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at s.matsumoto0115@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 shu0115
+
+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,81 @@
+# amazing_tap
+
+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.
+
+Fork of [shu0115/tap_amazing_print](https://github.com/shu0115/tap_amazing_print).
+
+## Installation
+
+```ruby
+# Gemfile
+gem "amazing_tap", group: :development
+```
+
+Or standalone:
+
+```console
+gem install amazing_tap
+```
+
+## Usage
+
+```ruby
+require "amazing_tap"
+
+user = { id: 7, name: "Ada" }
+
+user.tapp
+# user (Hash)
+# {
+#       :id => 7,
+#     :name => "Ada"
+# }
+
+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
+```
+
+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:
+
+```ruby
+{ a: 1 }.tapp
+# (Hash)
+# { :a => 1 }
+```
+
+Long output gets a closing marker so you can tell where each dump ends:
+
+```ruby
+big_list.tapp
+# big_list (Array)
+# [
+#   ... more than 24 lines ...
+# ]
+# /big_list
+```
+
+### Configuration
+
+```ruby
+AmazingTap.closing_threshold = 40   # lines before the closing "/label" appears; default 24
+```
+
+Output is colorized whenever amazing_print would colorize (tty, or `AmazingPrint.force_colors!`).
+
+### tapap
+
+`tapap` is an alias of `tapp`.
+
+## Development
+
+```console
+bundle install
+bundle exec rspec
+```
+
+## License
+
+MIT. See [LICENSE.txt](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/amazing_tap/version.rb

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

data/lib/amazing_tap.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative "amazing_tap/version"
+require 'amazing_print'
+
+module AmazingTap
+  class Error < StandardError; end
+
+  DEFAULT_CLOSING_THRESHOLD = 24
+
+  RECEIVER_PATTERN = /([\w@$.\[\]!?]+)\s*\.\s*tap(?:p|ap)\b/
+
+  class << self
+    # Printed output longer than this many lines gets a closing "/label" line.
+    #
+    # @return [Integer] line count threshold, DEFAULT_CLOSING_THRESHOLD unless set
+    attr_writer :closing_threshold
+
+    def closing_threshold
+      @closing_threshold ||= DEFAULT_CLOSING_THRESHOLD
+    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
+    # calls, multiline chains, or unreadable sources (eval, REPL) yield nil.
+    #
+    # @param location [Thread::Backtrace::Location] the tapp call site
+    # @return [String, nil] the receiver expression, or nil when not inferable
+    def infer_label(location)
+      path = location.path
+      return nil unless path && File.readable?(path)
+
+      line = File.readlines(path)[location.lineno - 1]
+      line && line[RECEIVER_PATTERN, 1]
+    end
+
+    # Prints a header line (label and/or class) followed by the ap-formatted
+    # object, then optional caller frames. Output longer than
+    # .closing_threshold lines is closed with a "/label" line so long dumps
+    # stay identifiable. Colorized under the same conditions amazing_print
+    # colorizes its output.
+    #
+    # @param object [Object] the object to print
+    # @param label [Symbol, String, nil] label for the header; nil prints a
+    #   class-only header (or none with type: false)
+    # @param callers [Array<String>] backtrace of the tapp call site
+    # @param type [Boolean] append the object's class to the header
+    # @param backtrace [Boolean, Integer] print all caller frames (true) or the
+    #   first N frames (Integer) after the object
+    # @return [void]
+    def print_labeled(object, label, callers:, type: true, backtrace: false)
+      colorize = AmazingPrint::Inspector.new.colorize?
+
+      header = []
+      header << (colorize ? AmazingPrint::Colors.yellow(label.to_s) : label.to_s) if label
+      if type
+        type_text = "(#{object.class})"
+        header << (colorize ? AmazingPrint::Colors.whiteish(type_text) : type_text)
+      end
+      puts header.join(" ") unless header.empty?
+
+      body = object.ai
+      puts body
+
+      frames = backtrace == true ? callers : callers.first(backtrace || 0)
+      frames.each { |frame| puts "  from #{frame}" }
+
+      return unless label && body.lines.length + frames.length > closing_threshold
+
+      closing = "/#{label}"
+      puts colorize ? AmazingPrint::Colors.yellow(closing) : closing
+    end
+  end
+
+  module ObjectExtension
+    # Prints the receiver via amazing_print with a labeled header, then
+    # returns it, so calls chain safely. Without an explicit label, the label
+    # is inferred from the receiver expression at the call site; when
+    # inference fails the header shows only the class.
+    #
+    # @param label [Symbol, nil] explicit label; nil infers from the call site
+    # @param type [Boolean] append the receiver's class to the header
+    # @param backtrace [Boolean, Integer] print all caller frames (true) or
+    #   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)
+      raise ArgumentError, "label must be a Symbol" unless label.nil? || label.is_a?(Symbol)
+
+      label ||= AmazingTap.infer_label(caller_locations(1, 1).first)
+      AmazingTap.print_labeled(self, label, callers: caller, type: type, backtrace: backtrace)
+      self
+    end
+    alias tapap tapp
+  end
+end
+
+class Object
+  include AmazingTap::ObjectExtension
+end

data/sig/amazing_tap.rbs

@@ -0,0 +1,4 @@
+module AmazingTap
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: amazing_tap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Portales Rosado
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  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: 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'
+description: 'Labeled tap debugging via amazing_print: obj.tap(:label) with type,
+  backtrace and closing markers'
+email:
+- dportalesr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/amazing_tap.rb
+- lib/amazing_tap/version.rb
+- sig/amazing_tap.rbs
+homepage: https://github.com/dportalesr/amazing_tap
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dportalesr/amazing_tap
+  source_code_uri: https://github.com/dportalesr/amazing_tap
+  changelog_uri: https://github.com/dportalesr/amazing_tap/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: amazing_tap
+test_files: []