tapping_device 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2d7b19e16c5c1f3f09d8d1abb81f8efe1238366a056457a804adf8c3ed5746
-  data.tar.gz: d683824d3c9ba64dc968d11891b2d1a5522768dbea68e604a6ed4dc04bef7488
+  metadata.gz: 23d3086bd40ed2665b040147abdbd7ca9cf2fd6e8d0e4300e0dfe8c6c14def70
+  data.tar.gz: b980e4cbf079204151b81645aa9c097254c0be1f514c2e09482ee3a4ede1ec68
 SHA512:
-  metadata.gz: bae37829ceac31871f11da1b9f2be3000572e65291229eb1208794e4214dc28bc55e4cc2dd44ec4a2dc1fd6cf01798509d860f132a6503b47368eadb544f172a
-  data.tar.gz: 73053c155178b21ddb93627f227f7a50130684b29c95cf0c310aedd06bcbf3ab94529a79fd73451725b7180e93ffa9e64b9d3fd7dd8e2c5125a15c8ea1500d21
+  metadata.gz: 4d731a0cc9436e48354a55afe094cd16ce93778876fd541702813645be21e2d77cdfa0580b93486c0a59ddf48c614df9106d752483842da5bec2bb19ee06e97a
+  data.tar.gz: 1de7093fd6b474260a7b819ddffa8839dc26ff5e5553d450084515e9ce6b1d69cb97066c69fa49f48777548e18768dd52dc8114efc5a469e63e870f3005086c2

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tapping_device (0.4.9)
+    tapping_device (0.4.10)
       activerecord (>= 5.2)
       awesome_print
 

data/README.md

@@ -7,9 +7,11 @@
 [![Open Source Helpers](https://www.codetriage.com/st0012/tapping_device/badges/users.svg)](https://www.codetriage.com/st0012/tapping_device)
 
 ## Related Posts
+- [Optimize Your Debugging Process With Object-Oriented Tracing and tapping_device](http://bit.ly/object-oriented-tracing) 
 - [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)
     - [Print Object’s Traces](print-objects-traces)
@@ -30,7 +32,9 @@
     - [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 of this gem is to make debugging Rails applications easier.  Here are some sample usages:
+`tapping_device` is a debugging tool built based on a concept called `object-oriented tracing` and on top of Ruby's `TracePoint` class. It allows you to inspect an object’s behavior, and thus build the program’s execution path for later debugging. Here’s a post to explain how to use `object-oriented tracing` and this gem to improve your debugging workflow: [Optimize Your Debugging Process With Object-Oriented Tracing and tapping_device](http://bit.ly/object-oriented-tracing).
+
+Sample usage:
 
 ### Print Object’s Traces
 
@@ -38,8 +42,6 @@ Let your objects report to you, so you don’t need to guess how they work!
 
 ```ruby
 class OrdersController < ApplicationController
-  include TappingDevice::Trackable
-
   def create
     @cart = Cart.find(order_params[:cart_id])
     print_traces(@cart, exclude_by_paths: [/gems/])
@@ -59,42 +61,6 @@ Called :apply_discount FROM /Users/st0012/projects/tapping_device-demo/app/servi
 
 (Also see [print_calls_in_detail](#print_calls_in_detail))
 
-### Track Calls that Generates SQL Queries
-
-`tap_sql!` method helps you track which method calls to generate SQL queries. This is particularly helpful when tracking calls created from a reused `ActiveRecord::Relation` object.
-
-```ruby
-class PostsController < ApplicationController
-  def index
-    # simulate current_user
-    @current_user = User.last
-    # reusable ActiveRecord::Relation
-    @posts = Post.all
-
-    tap_sql!(@posts) do |payload|
-      puts("Method: #{payload[:method_name]} generated sql: #{payload[:sql]} from #{payload[:filepath]}:#{payload[:line_number]}")
-    end
-  end
-end
-```
-
-```erb
-<h1>Posts (<%= @posts.count %>)</h1>
-......
-  <% @posts.each do |post| %>
-    ......
-  <% end %>
-......
-<p>Posts created by you: <%= @posts.where(user: @current_user).count %></p>
-```
-
-And the output would be
-
-```
-Method: count generated sql: SELECT COUNT(*) FROM "posts" from /PROJECT_PATH/rails-6-sample/app/views/posts/index.html.erb:3
-Method: each generated sql: SELECT "posts".* FROM "posts" from /PROJECT_PATH/rails-6-sample/app/views/posts/index.html.erb:16
-Method: count generated sql: SELECT COUNT(*) FROM "posts" WHERE "posts"."user_id" = ? from /PROJECT_PATH/rails-6-sample/app/views/posts/index.html.erb:31
-```
 
 However, depending on the size of your application, tapping any object could **harm the performance significantly**. **Don't use this on production**
 
@@ -118,7 +84,6 @@ $ gem install tapping_device
 ```
 
 ## Usages
-In order to use `tapping_device`, you need to include `TappingDevice::Trackable` module in where you want to track your code and call the following helpers.
 
 ### print_traces
 
@@ -126,8 +91,6 @@ It prints the object's trace. It's like mounting a GPS tracker + a spy camera on
 
 ```ruby
 class OrdersController < ApplicationController
-  include TappingDevice::Trackable
-
   def create
     @cart = Cart.find(order_params[:cart_id])
     print_traces(@cart, exclude_by_paths: [/gems/])
@@ -154,8 +117,6 @@ It prints the object's calls in detail (including call location, arguments, and
 
 ```ruby
 class OrdersController < ApplicationController
-  include TappingDevice::Trackable
-
   def create
     @cart = Cart.find(order_params[:cart_id])
     service = OrderCreationService.new
@@ -207,8 +168,6 @@ puts(calls.to_s) #=> [[:initialize, {:name=>"Stan", :age=>18}], [:initialize, {:
 
 ```ruby
 class PostsController < ApplicationController
-  include TappingDevice::Trackable
-
   before_action :set_post, only: [:show, :edit, :update, :destroy]
 
   def show
@@ -233,7 +192,6 @@ Also check the `track_as_records` option if you want to track `ActiveRecord` rec
 
 ```ruby
 class PostsController < ApplicationController
-  include TappingDevice::Trackable
   # GET /posts/new
   def new
     @post = Post.new

data/lib/tapping_device.rb

@@ -30,7 +30,10 @@ class TappingDevice
 
   def tap_init!(klass)
     raise "argument should be a class, got #{klass}" unless klass.is_a?(Class)
-    track(klass, condition: :tap_init?)
+    track(klass, condition: :tap_init?) do |payload|
+      payload[:return_value] = payload[:receiver]
+      payload[:receiver] = klass
+    end
   end
 
   def tap_on!(object)
@@ -81,7 +84,7 @@ class TappingDevice
 
   private
 
-  def track(object, condition:)
+  def track(object, condition:, &payload_block)
     @target = object
     @trace_point = TracePoint.new(options[:event_type]) do |tp|
       if send(condition, object, tp)
@@ -89,7 +92,7 @@ class TappingDevice
 
         next if should_be_skipped_by_paths?(filepath)
 
-        payload = build_payload(tp: tp, filepath: filepath, line_number: line_number)
+        payload = build_payload(tp: tp, filepath: filepath, line_number: line_number, &payload_block)
 
         record_call!(payload)
 
@@ -130,15 +133,12 @@ class TappingDevice
   end
 
   def build_payload(tp:, filepath:, line_number:)
-    arguments = {}
-    tp.binding.local_variables.each { |name| arguments[name] = tp.binding.local_variable_get(name) }
-
-    Payload.init({
+    payload = Payload.init({
       target: @target,
       receiver: tp.self,
       method_name: tp.callee_id,
       method_object: get_method_object_from(tp.self, tp.callee_id),
-      arguments: arguments,
+      arguments: collect_arguments(tp),
       return_value: (tp.return_value rescue nil),
       filepath: filepath,
       line_number: line_number,
@@ -146,6 +146,10 @@ class TappingDevice
       trace: get_traces(tp),
       tp: tp
     })
+
+    yield(payload) if block_given?
+
+    payload
   end
 
   def tap_init?(klass, tp)
@@ -176,15 +180,7 @@ class TappingDevice
     return false if is_from_target?(self, tp)
     return false if tp.defined_class == TappingDevice::Trackable || tp.defined_class == TappingDevice
 
-    method_object = get_method_object_from(tp.self, tp.callee_id)
-    return false unless method_object.is_a?(Method)
-    # if a no-arugment method is called, tp.binding.local_variables will be those local variables in the same scope
-    # so we need to make sure the method takes arguments, then we can be sure that the locals are arguments
-    return false unless method_object && method_object.arity.to_i > 0
-
-    argument_values = tp.binding.local_variables.map { |name| tp.binding.local_variable_get(name) }
-
-    argument_values.any? do |value|
+    collect_arguments(tp).values.any? do |value|
       # during comparison, Ruby might perform data type conversion like calling `to_sym` on the value
       # but not every value supports every conversion methods
       object == value rescue false
@@ -204,6 +200,19 @@ class TappingDevice
     nil
   end
 
+  def collect_arguments(tp)
+    parameters =
+      if RUBY_VERSION.to_f >= 2.6
+        tp.parameters
+      else
+        get_method_object_from(tp.self, tp.callee_id)&.parameters || []
+      end.map { |parameter| parameter[1] }
+
+    tp.binding.local_variables.each_with_object({}) do |name, args|
+      args[name] = tp.binding.local_variable_get(name) if parameters.include?(name)
+    end
+  end
+
   def process_options(options)
     options[:filter_by_paths] ||= []
     options[:exclude_by_paths] ||= []

data/lib/tapping_device/payload.rb

@@ -66,6 +66,7 @@ class TappingDevice
           from: #{location}
           <= #{arguments_output}
           => #{return_value_output}
+
       MSG
     end
   end

data/lib/tapping_device/trackable.rb

@@ -33,3 +33,5 @@ class TappingDevice
     end
   end
 end
+
+include TappingDevice::Trackable

data/lib/tapping_device/version.rb

@@ -1,3 +1,3 @@
 class TappingDevice
-  VERSION = "0.4.9"
+  VERSION = "0.4.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.10
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,6 +147,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile