tapping_device 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f08b96d9d7d45cc1f0292a69749e5e5d853167e54a1981a26ec2b3905e31bd
-  data.tar.gz: 50a7e86833462d2392150182abb75d37bde739b04f582a56dc9438f26f34cbc9
+  metadata.gz: 65b116ba192b195aca0df0f0400e8d2b0617b221c620dcaaf8eab0f16e2d85fb
+  data.tar.gz: 0cb2b12d7329f5f770bd8d1522b8ab0d5f7c1787d142d06116cf83908e136f63
 SHA512:
-  metadata.gz: 3620752c8c95e09ebd81891f73ed5d30f2ff0d6b09aba90f0c34267936d7cd01e517beef6ea61aa5648124ba6d84c221ed0a42ae21a035bf12a7eb4bbdb4cf7e
-  data.tar.gz: 2fc5bd412fbab8e6cb33c28b12b89c7a403b4f481844bcca096838119887e3321fef37d21ad3374ac88c26b0c93efc56b59691000f8d62b067c8acf690e69075
+  metadata.gz: 7192f5957a150267f71b4fe88a9eabb45f0966d5fda933e2a050f8a52e823ae338e6a3e35f24ff6f3ccef9f3b96c8fca9df300b8e3b3c4e69d29964f5ebdaa91
+  data.tar.gz: 264dd2bd5c83c1f716d272179c296a03bdf7612d2415602174432817769fa8f069612af45c0f58da722a0e499fe06bc440d3f1810bcc1a810e8c238e27fd97c5

data/.github/workflows/ruby.yml

@@ -19,6 +19,7 @@ jobs:
         ruby-version: ${{ matrix.ruby_version }}
     - name: Install sqlite
       run: |
+        sudo apt-get update
         sudo apt-get install libsqlite3-dev
 
     - name: Build and test with Rails ${{ matrix.rails_version }}

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tapping_device (0.3.0)
+    tapping_device (0.4.1)
       activerecord (>= 5.2)
 
 GEM
@@ -47,7 +47,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    zeitwerk (2.2.1)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -15,7 +15,8 @@ class PostsController < ApplicationController
   def show
     @post = Post.find(params[:id])
     tap_on!(@post) do |payload|
-      puts "Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
+      # this equals to `"Method: :#{payload[:method_name]}, line: #{payload[:filepath]}:#{payload[:line_number]}"`
+      puts(payload.method_name_and_location)
     end
   end
 end
@@ -24,9 +25,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
+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
 ```
 
 
@@ -36,16 +37,16 @@ Or you can use `tap_assoc!`. This is very useful for tracking potential n+1 quer
 
 ```ruby
 tap_assoc!(order) do |payload|
-  puts "Assoc: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
+  puts(payload.method_name_and_location)
 end
 ```
 
 ```
-Assoc: payments line: /RUBY_PATH/gems/2.6.0/gems/jsonapi-resources-0.9.10/lib/jsonapi/resource.rb:124
-Assoc: line_items line: /MY_PROJECT/app/models/line_item_container_helpers.rb:44
-Assoc: effective_line_items line: /MY_PROJECT/app/models/line_item_container_helpers.rb:110
-Assoc: amending_orders line: /MY_PROJECT/app/models/order.rb:385
-Assoc: amends_order line: /MY_PROJECT/app/models/order.rb:432
+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
 ```
 
 
@@ -118,8 +119,8 @@ In order to use `tapping_device`, you need to include `TappingDevice::Trackable`
 - `tap_assoc!(activerecord_object)` - tracks association calls on a record, like `post.comments`
 - `tap_sql!(activerecord_relation_or_model)` - tracks sql queries generated from the target
 
-### Info of the call
-All tapping methods (start with `tap_`) takes a block and yield a hash as block argument. 
+### Payload of the call
+All tapping methods (start with `tap_`) takes a block and yield a `Payload` object as block argument. The `Payload` class inherits `Hash` so we can either use it as a hash, or you can call its keys as methods.
 
 ```ruby
 {
@@ -149,6 +150,10 @@ The hash contains
 - `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]]"`
+
 
 ### Options
 - `with_trace_to: 10` - the number of traces we want to put into `trace`. Default is `nil`, so `trace` would be empty
@@ -157,22 +162,23 @@ The hash contains
 
 ```ruby
 tap_on!(@post, exclude_by_paths: [/active_record/]) do |payload|
-  puts "Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
+  # this equals to `"Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"`
+  puts(payload.method_name_and_location)
 end
 ```
 
 ```
-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
+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
 .......
 
 # 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
+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
 ```
 
 
@@ -200,7 +206,8 @@ class PostsController < ApplicationController
 
   def show
     tap_on!(@post) do |payload|
-      puts "Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
+      # this equals to `"Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"`
+      puts(payload.method_name_and_location)
     end
   end
 end
@@ -209,25 +216,25 @@ 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
+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
 ```
 
 ### `tap_assoc!`
 
 ```ruby
 tap_assoc!(order) do |payload|
-  puts "Assoc: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
+  puts(payload.method_name_and_location)
 end
 ```
 
 ```
-Assoc: payments line: /RUBY_PATH/gems/2.6.0/gems/jsonapi-resources-0.9.10/lib/jsonapi/resource.rb:124
-Assoc: line_items line: /MY_PROJECT/app/models/line_item_container_helpers.rb:44
-Assoc: effective_line_items line: /MY_PROJECT/app/models/line_item_container_helpers.rb:110
-Assoc: amending_orders line: /MY_PROJECT/app/models/order.rb:385
-Assoc: amends_order line: /MY_PROJECT/app/models/order.rb:432
+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
 ```
 
 ### `tap_sql!` (beta)

data/lib/tapping_device/payload.rb

@@ -0,0 +1,27 @@
+class TappingDevice
+  class Payload < Hash
+    ATTRS = [:receiver, :method_name, :arguments, :return_value, :filepath, :line_number, :defined_class, :trace, :tp]
+
+    ATTRS.each do |attr|
+      define_method attr do
+        self[attr]
+      end
+    end
+
+    def self.init(hash)
+      h = new
+      hash.each do |k, v|
+        h[k] = v
+      end
+      h
+    end
+
+    def method_name_and_location
+      "Method: :#{method_name}, line: #{filepath}:#{line_number}"
+    end
+
+    def method_name_and_arguments
+      "Method: :#{method_name}, argments: #{arguments.to_s}"
+    end
+  end
+end

data/lib/tapping_device/version.rb

@@ -1,3 +1,3 @@
 class TappingDevice
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/tapping_device.rb

@@ -1,5 +1,6 @@
 require "active_record"
 require "tapping_device/version"
+require "tapping_device/payload"
 require "tapping_device/trackable"
 require "tapping_device/exceptions"
 require "tapping_device/sql_tapping_methods"
@@ -152,7 +153,7 @@ class TappingDevice
   def build_yield_parameters(tp:, filepath:, line_number:)
     arguments = tp.binding.local_variables.map { |n| [n, tp.binding.local_variable_get(n)] }
 
-    {
+    Payload.init({
       receiver: tp.self,
       method_name: tp.callee_id,
       arguments: arguments,
@@ -162,7 +163,7 @@ class TappingDevice
       defined_class: tp.defined_class,
       trace: caller[CALLER_START_POINT..(CALLER_START_POINT + options[:with_trace_to])],
       tp: tp
-    }
+    })
   end
 
   def tap_init?(klass, parameters)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2019-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -130,6 +130,7 @@ files:
 - bin/setup
 - lib/tapping_device.rb
 - lib/tapping_device/exceptions.rb
+- lib/tapping_device/payload.rb
 - lib/tapping_device/sql_listener.rb
 - lib/tapping_device/sql_tapping_methods.rb
 - lib/tapping_device/trackable.rb