tapping_device 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89e8a71fd5423c54c59b6b46f672e228aa72e413173a79885c92ea5c5839c8b6
-  data.tar.gz: 83960e79383e8f892e060f892be301a54744c177f36219d3a24828e734d0ffb3
+  metadata.gz: ee22ec85fa4fc7f9b96a1e13a067a581e4dc6dcd591783019c4bae8e829cda10
+  data.tar.gz: ec3805395e9dc95b31cdb30d9c867877d37aada6c5b12d2ac842e3fdbc9e563d
 SHA512:
-  metadata.gz: b3917a20a5f63ba529bf5834b09d5446ecde966fb033e682460fcad47be6861912bfc4d908c2d16b0e5d567a179a469a7e173adb196acdf6a217a44fee05a579
-  data.tar.gz: 53998f52cbfbe390e047237236dc26646803b0a0d59428e4d73d85319fb820a27e64832082ee0a328f87f514f7de6cbc4f9d08737dfe44ee644b798a87fb6d10
+  metadata.gz: 59c1d8868d94bbea441a64291a77ec1783f146d584234657c8b455073b17a760cda0a035789c8d73d1b6cc9bbfb7a28f1afb619dc026ec1ac970917ca73514a1
+  data.tar.gz: 75b0ba8536f9fdf5f8bce8c990d5094881a2206763ffb8ab19ef9fe549944442a4f42b9dd26d3a2c4564cf1a43dafcb7ff4531c5281fc1488b8d0d725612693c

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    tapping_device (0.4.5)
+    tapping_device (0.4.6)
       activerecord (>= 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2)
-      activesupport (= 6.0.2)
-    activerecord (6.0.2)
-      activemodel (= 6.0.2)
-      activesupport (= 6.0.2)
-    activesupport (6.0.2)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activesupport (6.0.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -45,7 +45,7 @@ GEM
     rspec-support (3.8.2)
     sqlite3 (1.4.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
     zeitwerk (2.2.2)
 

data/README.md

@@ -2,10 +2,27 @@
 
 ![](https://github.com/st0012/tapping_device/workflows/Ruby/badge.svg)
 
+## Related Posts
+- [Debug Rails issues effectively with tapping_device](https://dev.to/st0012/debug-rails-issues-effectively-with-tappingdevice-c7c)
+- [Want to know more about your Rails app? Tap on your objects!](https://dev.to/st0012/want-to-know-more-about-your-rails-app-tap-on-your-objects-bd3)
+
+## Table of Content
+- [Introduction](#introduction)
+	- [Track Method Calls](#track-method-calls)
+	- [Track Association Calls](#track-association-calls)
+	- [Track Calls that Generates SQL Queries](#track-calls-that-generates-sql-queries)
+- [Installation](#installation)
+- [Usages](#usage)
+	- [Methods](#methods)
+	- [Payload](#payload-of-the-call)
+	- [Options](#options)
+	- [Advance Usages](#advance-usages)
+
+## Introduction
 
 `tapping_device` is a gem built on top of Ruby’s `TracePoint` class that allows you to tap method calls of specified objects. The purpose for this gem is to make debugging Rails applications easier.  Here are some sample usages:
 
-### Track method calls
+### Track Method Calls
 
 ```ruby
 class PostsController < ApplicationController
@@ -13,10 +30,7 @@ class PostsController < ApplicationController
 
   def show
     @post = Post.find(params[:id])
-    tap_on!(@post) do |payload|
-      # this equals to `"Method: :#{payload[:method_name]}, line: #{payload[:filepath]}:#{payload[:line_number]}"`
-      puts(payload.method_name_and_location)
-    end
+    tap_on!(@post).and_print(:method_name_and_location)
   end
 end
 ```
@@ -24,32 +38,30 @@ end
 And you can see these in log:
 
 ```
-Method: :name, line: /PROJECT_PATH/sample/app/views/posts/show.html.erb:5
-Method: :user_id, line: /PROJECT_PATH/sample/app/views/posts/show.html.erb:10
-Method: :to_param, line: /RUBY_PATH/gems/2.6.0/gems/actionpack-5.2.0/lib/action_dispatch/routing/route_set.rb:236
+name FROM /PROJECT_PATH/sample/app/views/posts/show.html.erb:5
+user_id FROM /PROJECT_PATH/sample/app/views/posts/show.html.erb:10
+to_param FROM /RUBY_PATH/gems/2.6.0/gems/actionpack-5.2.0/lib/action_dispatch/routing/route_set.rb:236
 ```
 
 
-### Track ActiveRecord records’ association calls
+### Track Association Calls
 
 Or you can use `tap_assoc!`. This is very useful for tracking potential n+1 query calls, here’s a sample from my work
 
 ```ruby
-tap_assoc!(order) do |payload|
-  puts(payload.method_name_and_location)
-end
+tap_assoc!(order).and_print(:method_name_and_location)
 ```
 
 ```
-Method: :payments, line: /RUBY_PATH/gems/2.6.0/gems/jsonapi-resources-0.9.10/lib/jsonapi/resource.rb:124
-Method: :line_items, line: /MY_PROJECT/app/models/line_item_container_helpers.rb:44
-Method: :effective_line_items, line: /MY_PROJECT/app/models/line_item_container_helpers.rb:110
-Method: :amending_orders, line: /MY_PROJECT/app/models/order.rb:385
-Method: :amends_order, line: /MY_PROJECT/app/models/order.rb:432
+payments FROM /RUBY_PATH/gems/2.6.0/gems/jsonapi-resources-0.9.10/lib/jsonapi/resource.rb:124
+line_items FROM /MY_PROJECT/app/models/line_item_container_helpers.rb:44
+effective_line_items FROM /MY_PROJECT/app/models/line_item_container_helpers.rb:110
+amending_orders FROM /MY_PROJECT/app/models/order.rb:385
+amends_order FROM /MY_PROJECT/app/models/order.rb:432
 ```
 
 
-### Track calls that generates sql queries!
+### Track Calls that Generates SQL Queries
 
 `tap_sql!` method helps you track which method calls generate sql queries. This is particularly helpful when tracking calls created from a reused `ActiveRecord::Relation` object.
 
@@ -135,9 +147,18 @@ All tapping methods (start with `tap_`) takes a block and yield a `Payload` obje
 - `trace` - stack trace of the call. Default is an empty array unless `with_trace_to` option is set
 - `tp` - trace point object of this call
 
-#### Some useful helpers
-- `method_name_and_location` - `"Method: :initialize, line: /PROJECT_PATH/tapping_device/spec/payload_spec.rb:7"`
-- `method_name_and_arguments` - `"Method: :initialize, argments: {:name=>\"Stan\", :age=>25}"`
+
+#### Symbols for helpers
+- `FROM` for method call’s location
+- `<=` for arguments
+- `=>` for return value
+- `@` for defined class
+
+#### Helpers
+- `method_name_and_location` - `initialize FROM /PROJECT_PATH/tapping_device/spec/payload_spec.rb:7`
+- `method_name_and_arguments` - `initialize <= {:name=>\"Stan\", :age=>25}`
+- `method_name_and_return_value` - `ten => 10`
+- `method_name_and_defined_class` - `initialize @ Student`
 - `passed_at` - 
 ```
 Passed as 'object' in method ':initialize'
@@ -152,6 +173,15 @@ Passed as 'object' in method ':initialize'
   at /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/actionview-6.0.0/lib/action_view/helpers/tags/label.rb:60
 ```
 
+- `detail_call_info` 
+
+```
+initialize @ Student
+  <= {:name=>"Stan", :age=>25}
+  => 25
+  FROM /Users/st0012/projects/tapping_device/spec/payload_spec.rb:7
+```
+
 
 ### Options
 - `with_trace_to: 10` - the number of traces we want to put into `trace`. Default is `nil`, so `trace` would be empty
@@ -159,24 +189,21 @@ Passed as 'object' in method ':initialize'
 - `filter_by_paths: [/path/]` - only contain calls from the specified paths
 
 ```ruby
-tap_on!(@post, exclude_by_paths: [/active_record/]) do |payload|
-  # this equals to `"Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"`
-  puts(payload.method_name_and_location)
-end
+tap_on!(@post, exclude_by_paths: [/active_record/]).and_print(:method_name_and_location)
 ```
 
 ```
-Method: :_read_attribute, line: /RUBY_PATH/gems/2.6.0/gems/activerecord-5.2.0/lib/active_record/attribute_methods/read.rb:40
-Method: :name, line: /PROJECT_PATH/sample/app/views/posts/show.html.erb:5
-Method: :_read_attribute, line: /RUBY_PATH/gems/2.6.0/gems/activerecord-5.2.0/lib/active_record/attribute_methods/read.rb:40
-Method: :user_id, line: /PROJECT_PATH/sample/app/views/posts/show.html.erb:10
+_read_attribute FROM  /RUBY_PATH/gems/2.6.0/gems/activerecord-5.2.0/lib/active_record/attribute_methods/read.rb:40
+name FROM  /PROJECT_PATH/sample/app/views/posts/show.html.erb:5
+_read_attribute FROM  /RUBY_PATH/gems/2.6.0/gems/activerecord-5.2.0/lib/active_record/attribute_methods/read.rb:40
+user_id FROM  /PROJECT_PATH/sample/app/views/posts/show.html.erb:10
 .......
 
 # versus
 
-Method: :name, line: /PROJECT_PATH/sample/app/views/posts/show.html.erb:5
-Method: :user_id, line: /PROJECT_PATH/sample/app/views/posts/show.html.erb:10
-Method: :to_param, line: /RUBY_PATH/gems/2.6.0/gems/actionpack-5.2.0/lib/action_dispatch/routing/route_set.rb:236
+name FROM  /PROJECT_PATH/sample/app/views/posts/show.html.erb:5
+user_id FROM  /PROJECT_PATH/sample/app/views/posts/show.html.erb:10
+to_param FROM  /RUBY_PATH/gems/2.6.0/gems/actionpack-5.2.0/lib/action_dispatch/routing/route_set.rb:236
 ```
 
 
@@ -203,10 +230,7 @@ class PostsController < ApplicationController
   before_action :set_post, only: [:show, :edit, :update, :destroy]
 
   def show
-    tap_on!(@post) do |payload|
-      # this equals to `"Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"`
-      puts(payload.method_name_and_location)
-    end
+    tap_on!(@post).and_print(:method_name_and_location)
   end
 end
 ```
@@ -214,9 +238,9 @@ end
 And you can see these in log:
 
 ```
-Method: :name, line: /PROJECT_PATH/sample/app/views/posts/show.html.erb:5
-Method: :user_id, line: /PROJECT_PATH/sample/app/views/posts/show.html.erb:10
-Method: :to_param, line: /RUBY_PATH/gems/2.6.0/gems/actionpack-5.2.0/lib/action_dispatch/routing/route_set.rb:236
+name FROM /PROJECT_PATH/sample/app/views/posts/show.html.erb:5
+user_id FROM /PROJECT_PATH/sample/app/views/posts/show.html.erb:10
+to_param FROM /RUBY_PATH/gems/2.6.0/gems/actionpack-5.2.0/lib/action_dispatch/routing/route_set.rb:236
 ```
 
 ### `tap_passed!`
@@ -255,17 +279,15 @@ Passed as 'record_or_hash_or_array' in method ':polymorphic_method'
 ### `tap_assoc!`
 
 ```ruby
-tap_assoc!(order) do |payload|
-  puts(payload.method_name_and_location)
-end
+tap_assoc!(order).and_print(:method_name_and_location)
 ```
 
 ```
-Method: :payments, line: /RUBY_PATH/gems/2.6.0/gems/jsonapi-resources-0.9.10/lib/jsonapi/resource.rb:124
-Method: :line_items, line: /MY_PROJECT/app/models/line_item_container_helpers.rb:44
-Method: :effective_line_items, line: /MY_PROJECT/app/models/line_item_container_helpers.rb:110
-Method: :amending_orders, line: /MY_PROJECT/app/models/order.rb:385
-Method: :amends_order, line: /MY_PROJECT/app/models/order.rb:432
+payments FROM /RUBY_PATH/gems/2.6.0/gems/jsonapi-resources-0.9.10/lib/jsonapi/resource.rb:124
+line_items FROM /MY_PROJECT/app/models/line_item_container_helpers.rb:44
+effective_line_items FROM /MY_PROJECT/app/models/line_item_container_helpers.rb:110
+amending_orders FROM /MY_PROJECT/app/models/order.rb:385
+amends_order FROM /MY_PROJECT/app/models/order.rb:432
 ```
 
 ### `tap_sql!`

data/lib/tapping_device/payload.rb

@@ -37,12 +37,26 @@ class TappingDevice
       "#{filepath}:#{line_number}"
     end
 
-    def method_name_and_location
-      "Method: :#{method_name}, line: #{location}"
+    SYMBOLS = {
+      location: "FROM",
+      return_value: "=>",
+      arguments: "<=",
+      defined_class: "@"
+    }
+
+    SYMBOLS.each do |name, symbol|
+      define_method "method_name_and_#{name}" do
+        "#{method_name} #{symbol} #{send(name)}"
+      end
     end
 
-    def method_name_and_arguments
-      "Method: :#{method_name}, argments: #{arguments.to_s}"
+    def detail_call_info
+      <<~MSG
+      #{method_name_and_defined_class}
+        <= #{arguments}
+        => #{return_value || "nil"}
+        FROM #{location}
+      MSG
     end
   end
 end

data/lib/tapping_device/version.rb

@@ -1,3 +1,3 @@
 class TappingDevice
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

data/lib/tapping_device.rb

@@ -21,6 +21,7 @@ class TappingDevice
 
   def initialize(options = {}, &block)
     @block = block
+    @output_block = nil
     @options = process_options(options)
     @calls = []
     @disabled = false
@@ -45,6 +46,10 @@ class TappingDevice
     track(record, condition: :tap_associations?)
   end
 
+  def and_print(payload_method)
+    @output_block = -> (payload) { puts(payload.send(payload_method)) }
+  end
+
   def set_block(&block)
     @block = block
   end
@@ -208,6 +213,8 @@ class TappingDevice
   def record_call!(payload)
     return if @disabled
 
+    @output_block.call(payload) if @output_block
+
     if @block
       root_device.calls << @block.call(payload)
     else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-15 00:00:00.000000000 Z
+date: 2019-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord