tapping_device 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee22ec85fa4fc7f9b96a1e13a067a581e4dc6dcd591783019c4bae8e829cda10
-  data.tar.gz: ec3805395e9dc95b31cdb30d9c867877d37aada6c5b12d2ac842e3fdbc9e563d
+  metadata.gz: 72cee52830dca423c383eb154be4d7352b187cd2bcd848af5ed8d38af0f5ad40
+  data.tar.gz: 96d64f49adfd1de6b3174c9ecdb38d0f8d7e6f03bc0b1b85a79bf3b86613e349
 SHA512:
-  metadata.gz: 59c1d8868d94bbea441a64291a77ec1783f146d584234657c8b455073b17a760cda0a035789c8d73d1b6cc9bbfb7a28f1afb619dc026ec1ac970917ca73514a1
-  data.tar.gz: 75b0ba8536f9fdf5f8bce8c990d5094881a2206763ffb8ab19ef9fe549944442a4f42b9dd26d3a2c4564cf1a43dafcb7ff4531c5281fc1488b8d0d725612693c
+  metadata.gz: a6675be23b1bbd4e0dfd6b1c4ea0ccbd39fba970af38a567928066935ab85a20003ecaf157f09f8e20223f2ec0717a72403261541d1b6836c393832c7240d35e
+  data.tar.gz: b93a1bd72210aa7f528687da0edaca7e812cb0849d7d0da8578ba8f5551a2134f6014a1f8c3b7989d750a15bdb734db1826d748de42bf4b995e3f7850cec00de

data/.github/workflows/ruby.yml

@@ -13,10 +13,12 @@ jobs:
         os: [ubuntu-latest]
     steps:
     - uses: actions/checkout@v1
+
     - name: Set up Ruby ${{ matrix.ruby_version }}
       uses: actions/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby_version }}
+
     - name: Install sqlite
       run: |
         # See https://github.community/t5/GitHub-Actions/ubuntu-latest-Apt-repository-list-issues/td-p/41122/page/2
@@ -24,10 +26,17 @@ jobs:
         sudo apt-get update
         sudo apt-get install libsqlite3-dev
 
-    - name: Build and test with Rails ${{ matrix.rails_version }}
+    - name: Build with Rails ${{ matrix.rails_version }}
       env:
         RAILS_VERSION: ${{ matrix.rails_version }}
       run: |
         gem install bundler
         bundle install --jobs 4 --retry 3
-        bundle exec rake
+
+    - name: Run test with Rails ${{ matrix.rails_version }} and publish result
+      uses: paambaati/codeclimate-action@v2.3.0
+      env:
+        CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+      with:
+        coverageCommand: bundle exec rake
+        debug: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tapping_device (0.4.6)
+    tapping_device (0.4.7)
       activerecord (>= 5.2)
 
 GEM
@@ -22,8 +22,10 @@ GEM
     concurrent-ruby (1.1.5)
     database_cleaner (1.7.0)
     diff-lcs (1.3)
+    docile (1.3.2)
     i18n (1.7.0)
       concurrent-ruby (~> 1.0)
+    json (2.3.0)
     method_source (0.9.2)
     minitest (5.13.0)
     pry (0.12.2)
@@ -43,6 +45,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sqlite3 (1.4.1)
     thread_safe (0.3.6)
     tzinfo (1.2.6)
@@ -58,6 +65,7 @@ DEPENDENCIES
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov (= 0.17.1)
   sqlite3 (>= 1.3.6)
   tapping_device!
 

data/README.md

@@ -1,6 +1,9 @@
 # TappingDevice
 
 ![](https://github.com/st0012/tapping_device/workflows/Ruby/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3e3732a6983785bccdbd/maintainability)](https://codeclimate.com/github/st0012/tapping_device/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/3e3732a6983785bccdbd/test_coverage)](https://codeclimate.com/github/st0012/tapping_device/test_coverage)
+[![Open Source Helpers](https://www.codetriage.com/st0012/tapping_device/badges/users.svg)](https://www.codetriage.com/st0012/tapping_device)
 
 ## Related Posts
 - [Debug Rails issues effectively with tapping_device](https://dev.to/st0012/debug-rails-issues-effectively-with-tappingdevice-c7c)
@@ -12,14 +15,18 @@
 	- [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)
+- [Usages](#usages)
+	- Tapping Methods
+		- [tap_init!](#tap_init)
+		- [tap_on!](#tap_on)
+		- [tap_passed!](#tap_passed)
+		- [tap_assoc!](#tap_assoc)
+		- [tap_sql!](#tap_sql)
 	- [Options](#options)
+	- [Payload](#payload-of-the-call)
 	- [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
@@ -43,7 +50,6 @@ 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 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
@@ -60,7 +66,6 @@ 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
 
 `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.
@@ -98,11 +103,9 @@ Method: each generated sql: SELECT "posts".* FROM "posts" from /PROJECT_PATH/rai
 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**
 
 ## Installation
-
 Add this line to your application’s Gemfile:
 
 ```ruby
@@ -121,93 +124,12 @@ Or install it yourself as:
 $ gem install tapping_device
 ```
 
-## Usage
-In order to use `tapping_device`, you need to include `TappingDevice::Trackable` module in where you want to track your code.
-
-### Methods
-- `tap_init!(class)` -  tracks a class’ instance initialization
-- `tap_on!(object)` - tracks any calls received by the object
-- `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
-
-### Payload of the call
-All tapping methods (start with `tap_`) takes a block and yield a `Payload` object as block argument. It responds to
-
-- `target` - the target for `tap_x` call
-- `receiver` - the receiver object
-- `method_name` - method’s name (symbol) 
-	- e.g. `:name`
-- `method_object` - the method object that’s being called. It might be `nil` in some edge cases.
-- `arguments` - arguments of the method call
-	- e.g. `{name: “Stan”, age: 25}`
-- `return_value` - return value of the method call
-- `filepath` - path to the file that performs the method call
-- `line_number` 
-- `defined_class` - in which class that defines the method being called
-- `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
-
-
-#### 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'
-  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
-```
-
-You can also set `passed_at(with_method_head: true)` to see the method’s head
+## 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.
 
-```
-Passed as 'object' in method ':initialize'
-  > def initialize(template_object, object_name, method_name, object, tag_value)
-  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
-```
+### tap_init!
 
-- `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
-- `exclude_by_paths: [/path/]` - an array of call path patterns that we want to skip. This could be very helpful when working on large project like Rails applications.
-- `filter_by_paths: [/path/]` - only contain calls from the specified paths
-
-```ruby
-tap_on!(@post, exclude_by_paths: [/active_record/]).and_print(:method_name_and_location)
-```
-
-```
-_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
-
-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_init!`
+`tap_init!(class)` -  tracks a class’ instance initialization
 
 ```ruby
 calls = []
@@ -221,7 +143,9 @@ Student.new("Jane", 23)
 puts(calls.to_s) #=> [[:initialize, {:name=>"Stan", :age=>18}], [:initialize, {:name=>"Jane", :age=>23}]]
 ```
 
-### `tap_on!`
+### tap_on!
+
+ `tap_on!(object)` - tracks any calls received by the object
 
 ```ruby
 class PostsController < ApplicationController
@@ -243,9 +167,11 @@ 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!`
+Also check the `track_as_records` option if you want to track `ActiveRecord` records.
+
+### tap_passed!
 
-This is particularly useful when debugging libraries. It saves your time from jumping between files and check which path the object will go.
+`tap_passed!(target)` tracks method calls that **takes the target as its argument**. This is particularly useful when debugging libraries. It saves your time from jumping between files and check which path the object will go.
 
 ```ruby
 class PostsController < ApplicationController
@@ -276,7 +202,9 @@ Passed as 'record_or_hash_or_array' in method ':polymorphic_method'
   at /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/actionpack-6.0.0/lib/action_dispatch/routing/polymorphic_routes.rb:139
 ```
 
-### `tap_assoc!`
+### tap_assoc!
+
+`tap_assoc!(activerecord_object)` tracks association calls on a record, like `post.comments`
 
 ```ruby
 tap_assoc!(order).and_print(:method_name_and_location)
@@ -290,7 +218,9 @@ amending_orders FROM /MY_PROJECT/app/models/order.rb:385
 amends_order FROM /MY_PROJECT/app/models/order.rb:432
 ```
 
-### `tap_sql!`
+### tap_sql!
+
+`tap_sql!(anything_that_generates_sql_queries)` tracks sql queries generated from the target
 
 ```ruby
 class PostsController < ApplicationController
@@ -324,6 +254,112 @@ Method: count generated sql: SELECT COUNT(*) FROM "posts" WHERE "posts"."user_id
 ```
 
 
+### Options
+#### with_trace_to
+It takes an integer as the number of traces we want to put into `trace`. Default is `nil`, so `trace` would be empty. 
+
+```ruby
+stan = Student.new("Stan", 18)
+tap_on!(stan, with_trace_to: 5)
+
+stan.name
+
+puts(device.calls.first.trace) #=>
+/Users/st0012/projects/tapping_device/spec/tapping_device_spec.rb:287:in `block (4 levels) in <top (required)>'
+/Users/st0012/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/gems/rspec-core-3.8.2/lib/rspec/core/example.rb:257:in `instance_exec'
+/Users/st0012/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/gems/rspec-core-3.8.2/lib/rspec/core/example.rb:257:in `block in run'
+/Users/st0012/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/gems/rspec-core-3.8.2/lib/rspec/core/example.rb:503:in `block in with_around_and_singleton_context_hooks'
+/Users/st0012/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/gems/rspec-core-3.8.2/lib/rspec/core/example.rb:460:in `block in with_around_example_hooks'
+/Users/st0012/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/gems/rspec-core-3.8.2/lib/rspec/core/hooks.rb:464:in `block in run'
+```
+
+#### track_as_records
+It makes the device to track objects as they are ActiveRecord instances. For example:
+
+```ruby
+tap_on!(@post, track_as_records: true)
+post = Post.find(@post.id) # same record but a different object
+post.title #=> this call will be recorded as well
+```
+
+#### exclude_by_paths
+It takes an array of call path patterns that we want to skip. This could be very helpful when working on large project like Rails applications.
+
+```ruby
+tap_on!(@post, exclude_by_paths: [/active_record/]).and_print(:method_name_and_location)
+```
+
+```
+_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
+
+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
+```
+
+#### filter_by_paths
+
+Like `exclude_by_paths`, but work in an opposite way.
+
+
+### Payload of The Call
+All tapping methods (start with `tap_`) takes a block and yield a `Payload` object as block argument. It responds to
+
+- `target` - the target for `tap_x` call
+- `receiver` - the receiver object
+- `method_name` - method’s name (symbol) 
+	- e.g. `:name`
+- `method_object` - the method object that’s being called. It might be `nil` in some edge cases.
+- `arguments` - arguments of the method call
+	- e.g. `{name: “Stan”, age: 25}`
+- `return_value` - return value of the method call
+- `filepath` - path to the file that performs the method call
+- `line_number` 
+- `defined_class` - in which class that defines the method being called
+- `trace` - stack trace of the call. Default is an empty array unless `with_trace_to` option is set
+- `sql` - sql that generated from the call (only present in `tap_sql!` payloads)
+- `tp` - trace point object of this call
+
+
+#### Symbols for Payload Helpers
+- `FROM` for method call’s location
+- `<=` for arguments
+- `=>` for return value
+- `@` for defined class
+
+#### Payload 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'
+  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
+```
+
+You can also set `passed_at(with_method_head: true)` to see the method’s head
+
+```
+Passed as 'object' in method ':initialize'
+  > def initialize(template_object, object_name, method_name, object, tag_value)
+  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
+```
 
 ### Advance Usages
 

data/lib/tapping_device.rb

@@ -103,11 +103,24 @@ class TappingDevice
   end
 
   def get_call_location(tp, padding: 0)
+    caller(get_trace_index(tp) + padding).first.split(":")[0..1]
+  end
+
+  def get_trace_index(tp)
     if tp.event == :c_call
-      caller(C_CALLER_START_POINT + padding)
+      C_CALLER_START_POINT
+    else
+      CALLER_START_POINT
+    end
+  end
+
+  def get_traces(tp)
+    if with_trace_to = options[:with_trace_to]
+      trace_index = get_trace_index(tp)
+      caller[trace_index..(trace_index + with_trace_to)]
     else
-      caller(CALLER_START_POINT + padding)
-    end.first.split(":")[0..1]
+      []
+    end
   end
 
   # this needs to be placed upfront so we can exclude noise before doing more work
@@ -130,7 +143,7 @@ class TappingDevice
       filepath: filepath,
       line_number: line_number,
       defined_class: tp.defined_class,
-      trace: caller[CALLER_START_POINT..(CALLER_START_POINT + options[:with_trace_to])],
+      trace: get_traces(tp),
       tp: tp
     })
   end
@@ -159,8 +172,9 @@ class TappingDevice
   end
 
   def tap_passed?(object, tp)
-    # we don't care about calls from the device instance
+    # we don't care about calls from the device instance or helper methods
     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)
@@ -196,6 +210,7 @@ class TappingDevice
     options[:with_trace_to] ||= 50
     options[:root_device] ||= self
     options[:descendants] ||= []
+    options[:track_as_records] ||= false
     options
   end
 
@@ -207,7 +222,16 @@ class TappingDevice
   end
 
   def is_from_target?(object, tp)
-    object.__id__ == tp.self.__id__
+    comparsion = tp.self
+    is_the_same_record?(object, comparsion) || object.__id__ == comparsion.__id__
+  end
+
+  def is_the_same_record?(target, comparsion)
+    return false unless options[:track_as_records]
+    if target.is_a?(ActiveRecord::Base) && comparsion.is_a?(target.class)
+      primary_key = target.class.primary_key
+      target.send(primary_key) && target.send(primary_key) == comparsion.send(primary_key)
+    end
   end
 
   def record_call!(payload)

data/lib/tapping_device/payload.rb

@@ -39,6 +39,7 @@ class TappingDevice
 
     SYMBOLS = {
       location: "FROM",
+      sql: "QUERIES",
       return_value: "=>",
       arguments: "<=",
       defined_class: "@"

data/lib/tapping_device/sql_tapping_methods.rb

@@ -18,7 +18,7 @@ class TappingDevice
         ########## Check if the call is worth recording ##########
         filepath, line_number = get_call_location(start_tp, padding: 1) # we need extra padding because of `with_trace_point_on_target`
         method = start_tp.callee_id
-        next if should_be_skipped_by_paths?(filepath) || already_recording?(method)
+        next if already_recording?(method)
 
         ########## Start the recording ##########
         # 1. Mark recording state by pushing method into @call_stack
@@ -62,8 +62,9 @@ class TappingDevice
     device = TappingDevice.new do |sql_listener_payload|
       values = sql_listener_payload.arguments[:values]
 
-      next if ["SCHEMA", "TRANSACTION"].include? values[:name]
-      next if values[:sql].match?(/SAVEPOINT/)
+      next if should_be_skipped_by_paths?(payload.filepath) ||
+        ["SCHEMA", "TRANSACTION"].include?(values[:name]) ||
+        values[:sql].match?(/SAVEPOINT/)
 
       payload[:sql] = values[:sql]
       record_call!(payload)

data/lib/tapping_device/version.rb

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

data/tapping_device.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "0.17.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-25 00:00:00.000000000 Z
+date: 2019-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
 description: tapping_device provides useful helpers to intercept method calls
 email:
 - stan001212@gmail.com