tapping_device 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83a8ec6a373e181e3125d846a7621edf426441f68177406364ce67e268774f6a
-  data.tar.gz: aa9a5f8c937a33f8d1ea18e755e6cf6971fe6db5a6c3aa87329c9394bc90e916
+  metadata.gz: 28a848cfef98c43315488230c1593aba48ef1b3ee91dc7a495a6cee7cb406771
+  data.tar.gz: 30601c6039343512d3d7c157bd0c8e5645b8005aa37a4b365458018cb477c2d2
 SHA512:
-  metadata.gz: 2343c68ade029e6323d606eb34564476051bb65ffa0631361d1c306fd47875c530ba5e2e4c164a5fe53e9b7c34d54d543a3a811855808af99c97afaa718beb47
-  data.tar.gz: d5270b82e2f8058512394f529c26f3f690f142982be36533504662468f8b23cbd981e2631cd10196505b9e0cd963e3c719e2fb24fd79d263a025bde804d6ebc1
+  metadata.gz: 2540416f3d4ece8dfb76ee567030d3f4ab9da497c9ae97e9d7418b952d7ce0552453aad33278344ce683dc89a393244d74aef20bc6c6cf9847f0198911999a20
+  data.tar.gz: b417c4c17f18a152ce0bbc4135657bc41cb90b70788b971debb4242a1d35a9189c21621420af5f5bf06e9aa76148f9a49c6e2fb786000769a193c57765de45d1

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    tapping_device (0.5.6)
+    tapping_device (0.5.7)
       activerecord (>= 5.2)
       activesupport
+      pastel
       pry
 
 GEM
@@ -21,15 +22,17 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     database_cleaner (1.7.0)
     diff-lcs (1.3)
     docile (1.3.2)
-    i18n (1.8.3)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     json (2.3.0)
     method_source (1.0.0)
-    minitest (5.14.1)
+    minitest (5.14.2)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -54,6 +57,7 @@ GEM
     simplecov-html (0.10.2)
     sqlite3 (1.4.1)
     thread_safe (0.3.6)
+    tty-color (0.5.2)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     zeitwerk (2.4.0)

data/lib/tapping_device.rb

@@ -153,6 +153,7 @@ class TappingDevice
       defined_class: tp.defined_class,
       trace: get_traces(tp),
       is_private_call?: tp.defined_class.private_method_defined?(tp.callee_id),
+      tag: options[:tag],
       tp: tp
     })
   end

data/lib/tapping_device/output/payload.rb

@@ -1,17 +1,24 @@
+require "pastel"
+
 class TappingDevice
   module Output
     class Payload < Payload
       UNDEFINED = "[undefined]"
+      PRIVATE_MARK = " (private)"
+
+      PASTEL = Pastel.new
+      PASTEL.alias_color(:orange, :bright_red, :bright_yellow)
 
       alias :raw_arguments :arguments
       alias :raw_return_value :return_value
 
       def method_name(options = {})
-        if is_private_call?
-          ":#{super(options)} (private)"
-        else
-          ":#{super(options)}"
-        end
+        name = ":#{super(options)}"
+
+        name += " [#{tag}]" if tag
+        name += PRIVATE_MARK if is_private_call?
+
+        name
       end
 
       def arguments(options = {})
@@ -22,29 +29,13 @@ class TappingDevice
         generate_string_result(raw_return_value, options[:inspect])
       end
 
-      COLOR_CODES = {
-        green: 10,
-        yellow: 11,
-        blue: 12,
-        megenta: 13,
-        cyan: 14,
-        orange: 214
-      }
-
-      COLORS = COLOR_CODES.each_with_object({}) do |(name, code), hash|
-        hash[name] = "\u001b[38;5;#{code}m"
-      end.merge(
-        reset: "\u001b[0m",
-        nocolor: ""
-      )
-
       PAYLOAD_ATTRIBUTES = {
-        method_name: {symbol: "", color: COLORS[:blue]},
-        location: {symbol: "from:", color: COLORS[:green]},
-        return_value: {symbol: "=>", color: COLORS[:megenta]},
-        arguments: {symbol: "<=", color: COLORS[:orange]},
-        ivar_changes: {symbol: "changes:\n", color: COLORS[:blue]},
-        defined_class: {symbol: "#", color: COLORS[:yellow]}
+        method_name: {symbol: "", color: :bright_blue},
+        location: {symbol: "from:", color: :green},
+        return_value: {symbol: "=>", color: :magenta},
+        arguments: {symbol: "<=", color: :orange},
+        ivar_changes: {symbol: "changes:\n", color: :blue},
+        defined_class: {symbol: "#", color: :yellow}
       }
 
       PAYLOAD_ATTRIBUTES.each do |attribute, attribute_options|
@@ -57,7 +48,7 @@ class TappingDevice
           call_result = send("original_#{attribute}", options)
 
           if options[:colorize]
-            "#{color}#{call_result}#{COLORS[:reset]}"
+            PASTEL.send(color, call_result)
           else
             call_result
           end
@@ -87,7 +78,7 @@ class TappingDevice
         return unless arg_name
 
         arg_name = ":#{arg_name}"
-        arg_name = value_with_color(arg_name, :orange) if options[:colorize]
+        arg_name = PASTEL.orange(arg_name) if options[:colorize]
         msg = "Passed as #{arg_name} in '#{defined_class(options)}##{method_name(options)}' at #{location(options)}\n"
         msg += "  > #{method_head}\n" if with_method_head
         msg
@@ -109,12 +100,12 @@ class TappingDevice
           after = generate_string_result(value_changes[:after], options[:inspect])
 
           if options[:colorize]
-            ivar = "#{COLORS[:orange]}#{ivar}#{COLORS[:reset]}"
-            before = "#{COLORS[:blue]}#{before.to_s}#{COLORS[:reset]}"
-            after = "#{COLORS[:blue]}#{after.to_s}#{COLORS[:reset]}"
+            ivar = PASTEL.orange(ivar)
+            before = PASTEL.bright_blue(before.to_s)
+            after = PASTEL.bright_blue(after.to_s)
           end
 
-          "      #{ivar}: #{before.to_s} => #{after.to_s}"
+          "      #{ivar}: #{before} => #{after}"
         end.join("\n")
       end
 
@@ -130,10 +121,6 @@ class TappingDevice
 
       private
 
-      def value_with_color(value, color)
-        "#{COLORS[color]}#{value}#{COLORS[:reset]}"
-      end
-
       def generate_string_result(obj, inspect)
         case obj
         when Array

data/lib/tapping_device/payload.rb

@@ -2,7 +2,7 @@ class TappingDevice
   class Payload < Hash
     ATTRS = [
       :target, :receiver, :method_name, :method_object, :arguments, :return_value, :filepath, :line_number,
-      :defined_class, :trace, :tp, :ivar_changes, :is_private_call?
+      :defined_class, :trace, :tag, :tp, :ivar_changes, :is_private_call?
     ]
 
     ATTRS.each do |attr|

data/lib/tapping_device/trackers/initialization_tracker.rb

@@ -34,7 +34,16 @@ class TappingDevice
         method_name = tp.callee_id
 
         if @is_active_record_model
-          method_name == :new && receiver.is_a?(Class) && receiver.ancestors.include?(target)
+          # ActiveRecord redefines model classes' .new method,
+          # so instead of calling Model#initialize, it'll actually call Model.new
+          # see https://github.com/rails/rails/blob/master/activerecord/lib/active_record/inheritance.rb#L50
+          method_name == :new &&
+            receiver.is_a?(Class) &&
+            # this checks if the model class is the target class or a subclass of it
+            receiver.ancestors.include?(target) &&
+            # Model.new triggers both c_return and return events. so we should only return in 1 type of the events
+            # otherwise the callback will be triggered twice
+            tp.event == :return
         else
           method_name == :initialize && receiver.is_a?(target)
         end

data/lib/tapping_device/version.rb

@@ -1,3 +1,3 @@
 class TappingDevice
-  VERSION = "0.5.6"
+  VERSION = "0.5.7"
 end

data/tapping_device.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "pry" # for using Method#source in MutationTracker
   spec.add_dependency "activesupport"
+  spec.add_dependency "pastel"
 
   spec.add_development_dependency "sqlite3", ">= 1.3.6"
   spec.add_development_dependency "database_cleaner"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement