tapping_device 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 145b8d4cd78d7f40b318352ff3a39a6a4aa194dee91e84db5e4946c522bd59b9
-  data.tar.gz: 9978287948da8f54fc96699be31059abd8ad7d643bf05cb9c54d43bc5ff06019
+  metadata.gz: 31bb339b2993e3656c953c0c403b4145d3047722919f86ab4d0683c577379027
+  data.tar.gz: 76b0b6fab4f3998173960d3a0bce5bdc6faa8155bc49fe4ec3a0ecd0196e8feb
 SHA512:
-  metadata.gz: 7870a46e126309662fbdd4c7fea746b9bac8b4c31583061e7ed068f77c6d2d6960b84601f74172cb3bb289d615487c513468f1c18ee62f868eb4d229652e099d
-  data.tar.gz: 3b59a134c7e30ce2f5d2f1e3f6bdc6ad76b5fccac4e8092f5ae441c11858d1d3b0ad035b3e5648e0b3912b89da43633e8cc55db749662f1c0e8db8eee4b463d5
+  metadata.gz: 7641adbd68125ce2cb1a2fdb96969d09dcedc8d35b0c24fc1e0136badaca586bf7287631c3b6fecc7d3909958e0c49bd2d05d2de3b41845f680fb19165ccab1e
+  data.tar.gz: f9d685094c3f45b3e330c2725fc61bc01a9ae11cb5e486a1fec5de9a2131860cd64160e1d83753210529dc3383523d8072437e8ff285fc589b6bb6aafe5fcf5c

data/.github/workflows/gempush.yml

@@ -0,0 +1,28 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/ruby.yml

@@ -4,11 +4,12 @@ on: [push]
 
 jobs:
   test:
-    name: Test on ruby ${{ matrix.ruby_version }}
+    name: Test on ruby ${{ matrix.ruby_version }} and rails ${{ matrix.rails_version }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        ruby_version: ['2.4', '2.5', '2.6']
+        rails_version: ['5.2', '6']
+        ruby_version: ['2.5', '2.6']
         os: [ubuntu-latest]
     steps:
     - uses: actions/checkout@v1
@@ -16,8 +17,13 @@ jobs:
       uses: actions/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby_version }}
+    - name: Install sqlite
+      run: |
+        sudo apt-get install libsqlite3-dev
 
-    - name: Build and test with Rake
+    - name: Build and test with Rails ${{ matrix.rails_version }}
+      env:
+        RAILS_VERSION: ${{ matrix.rails_version }}
       run: |
         gem install bundler
         bundle install --jobs 4 --retry 3

data/Gemfile.lock

@@ -2,13 +2,29 @@ PATH
   remote: .
   specs:
     tapping_device (0.1.0)
+      activerecord (~> 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
     coderay (1.1.2)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
     method_source (0.9.2)
+    minitest (5.12.2)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -26,6 +42,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    sqlite3 (1.4.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.0)
 
 PLATFORMS
   ruby
@@ -35,6 +56,7 @@ DEPENDENCIES
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  sqlite3 (~> 1.4.1)
   tapping_device!
 
 BUNDLED WITH

data/README.md

@@ -2,17 +2,14 @@
 
 ![](https://github.com/st0012/tapping_device/workflows/Ruby/badge.svg)
 
-`tapping_device` is a gem based on Ruby’s `TracePoint` class that allows you to tap method calls of specified objects. This could be useful for debugging. For example, you can use it to see who calls you `Post` records
+`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. For example, you can use it to see who calls you `Post` records
 
 ```ruby
 class PostsController < ApplicationController
   include TappingDevice::Trackable
 
-  before_action :set_post, only: [:show, :edit, :update, :destroy]
-
-  # GET /posts/1
-  # GET /posts/1.json
   def show
+    @post = Post.find(params[:id])
     tap_on!(@post) do |payload|
       puts "Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
     end
@@ -23,12 +20,28 @@ end
 And you can see these in log:
 
 ```
-Method: name line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:5
-Method: user_id line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:10
-Method: to_param line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/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
+```
+
+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 "Assoc: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
+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
 ```
 
-**Don't use this on production**
+However, depending on the size of your application, tapping any object could **harm the performance significantly**. **Don't use this on production**
 
 
 ## Installation
@@ -55,24 +68,26 @@ $ gem install tapping_device
 In order to use `tapping_device`, you need to include `TappingDevice::Trackable` module in where you want to track your code.
 
 ### Methods
-- `tap_initialization_of!(class)` - allows you to track a class’ instance initialization
-	- shortcut - `tap_init!`
-- `tap_calls_on!(object)` - allows you to track any calls received by the object
-	- shortcut - `tap_on!`
-- `stop_tapping!(object)` - this stops tapping on the given object
-	- shortcut - `untap!`
+- `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`
+- `untap!(object)` - this stops tapping on the given object
 
 ### Info of the call
 All tapping methods (start with `tap_`) takes a block and yield a hash as block argument. 
 
 ```ruby
-tap_initialization_of!(Student) do |payload|
-  puts(payload.to_s)
-end
-
-Student.new("Stan", 18)
-
-#=> {:receiver=>#<Student:0x00007feec04d9e58 @name="Stan", @age=18>, :method_name=>:initialize, :arguments=>[[:name, "Stan"], [:age, 18]], :return_value=>18, :filepath=>"/path/spec/trackable_spec.rb", :line_number=>7, :defined_class=>Student}
+{
+  :receiver=>#<Student:0x00007fabed02aeb8 @name="Stan", @age=18, @tapping_device=[#<TracePoint:return `age'@/PROJECT_PATH/tapping_device/spec/trackable_spec.rb:17>]>, 
+  :method_name=>:age, 
+  :arguments=>[], 
+  :return_value=>18, 
+  :filepath=>"/PROJECT_PATH/tapping_device/spec/trackable_spec.rb", 
+  :line_number=>"171", 
+  :defined_class=>Student, 
+  :trace=>[], 
+  :tp=>#<TracePoint:return `age'@/PROJECT_PATH/tapping_device/spec/trackable_spec.rb:17>
+}
 ```
 
 The hash contains
@@ -85,33 +100,34 @@ The hash contains
 - `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 that’s being called
+- `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
 
 
 ### Options
-- `with_trace_to` - the number of traces we want to put into `trace`. Default is `nil`, so `trace` would be empty
-- `exclude_from_paths` - an array of call path patterns that we want to skip. This could be very helpful when working on Rails projects.
+- `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_from_paths: [/active_record/]) do |payload|
+tap_on!(@post, exclude_by_paths: [/active_record/]) do |payload|
   puts "Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
 end
 ```
 
 ```
-Method: _read_attribute line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/activerecord-5.2.0/lib/active_record/attribute_methods/read.rb:40
-Method: name line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:5
-Method: _read_attribute line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/activerecord-5.2.0/lib/active_record/attribute_methods/read.rb:40
-Method: user_id line: /Users/st0012/projects/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: /Users/st0012/projects/sample/app/views/posts/show.html.erb:5
-Method: user_id line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:10
-Method: to_param line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/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
 ```
 
 
@@ -150,11 +166,26 @@ end
 And you can see these in log:
 
 ```
-Method: name line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:5
-Method: user_id line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:10
-Method: to_param line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/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]}"
+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
+```
 
 
 ## Development
@@ -165,7 +196,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tapping_device. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/st0012/tapping_device. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/tapping_device/trackable.rb

@@ -1,3 +1,5 @@
+require "active_record"
+
 module TappingDevice
   module Trackable
     TAPPING_DEVICE = :@tapping_device
@@ -5,15 +7,16 @@ module TappingDevice
 
     def tap_initialization_of!(klass, options = {}, &block)
       raise "argument should be a class, got #{klass}" unless klass.is_a?(Class)
-      options[:condition] = -> (arguments) { arguments[:method_name] == :initialize && arguments[:defined_class] == klass }
-      options[:block] = block
-      track(klass, **options)
+      track(klass, condition: :tap_init?, block: block, **options)
+    end
+
+    def tap_association_calls!(record, options = {}, &block)
+      raise "argument should be an instance of ActiveRecord::Base" unless record.is_a?(ActiveRecord::Base)
+      track(record, condition: :tap_associations?, block: block, **options)
     end
 
     def tap_calls_on!(object, options = {}, &block)
-      options[:condition] = -> (arguments) { arguments[:receiver].object_id == object.object_id }
-      options[:block] = block
-      track(object, **options)
+      track(object, condition: :tap_on?, block: block, **options)
     end
 
     def stop_tapping!(object)
@@ -21,17 +24,22 @@ module TappingDevice
     end
 
     alias :tap_init! :tap_initialization_of!
+    alias :tap_assoc! :tap_association_calls!
     alias :tap_on! :tap_calls_on!
     alias :untap! :stop_tapping!
 
     private
 
-    def track(object, condition:, block:, with_trace_to: nil, exclude_from_paths: [])
+    def track(object, condition:, block:, with_trace_to: nil, exclude_by_paths: [], filter_by_paths: nil)
       trace_point = TracePoint.trace(:return) do |tp|
         filepath, line_number = caller(CALLER_START_POINT).first.split(":")[0..1]
 
         # this needs to be placed upfront so we can exclude noise before doing more work
-        next if exclude_from_paths.any? { |pattern| pattern.match?(filepath) }
+        next if exclude_by_paths.any? { |pattern| pattern.match?(filepath) }
+
+        if filter_by_paths
+          next unless filter_by_paths.any? { |pattern| pattern.match?(filepath) }
+        end
 
         arguments = tp.binding.local_variables.map { |n| [n, tp.binding.local_variable_get(n)] }
 
@@ -49,12 +57,35 @@ module TappingDevice
 
         yield_parameters[:trace] = caller[CALLER_START_POINT..(CALLER_START_POINT + with_trace_to)] if with_trace_to
 
-        block.call(yield_parameters) if condition.call(yield_parameters)
+        block.call(yield_parameters) if send(condition, object, yield_parameters)
       end
 
       add_tapping_device(object, trace_point)
     end
 
+    def tap_init?(klass, parameters)
+      receiver = parameters[:receiver]
+      method_name = parameters[:method_name]
+
+      if klass.ancestors.include?(ActiveRecord::Base)
+        method_name == :new && receiver.ancestors.include?(klass)
+      else
+        method_name == :initialize && receiver.is_a?(klass)
+      end
+    end
+
+    def tap_on?(object, parameters)
+      parameters[:receiver].object_id == object.object_id
+    end
+
+    def tap_associations?(object, parameters)
+      return false unless tap_on?(object, parameters)
+
+      model_class = object.class
+      associations = model_class.reflections
+      associations.keys.include?(parameters[:method_name].to_s)
+    end
+
     def get_tapping_device(object)
       object.instance_variable_get(TAPPING_DEVICE)
     end

data/lib/tapping_device/version.rb

@@ -1,3 +1,3 @@
 module TappingDevice
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/tapping_device.gemspec

@@ -26,6 +26,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  if ENV["RAILS_VERSION"].to_i >= 6
+    spec.add_dependency "activerecord", "~> #{ENV["RAILS_VERSION"]}"
+    spec.add_development_dependency "sqlite3", "~> 1.4.1"
+  else
+    spec.add_dependency "activerecord", "~> 5.2"
+    spec.add_development_dependency "sqlite3", "~> 1.3.6"
+  end
+
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2019-10-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gempush.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -111,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: tapping_device provides useful helpers to intercept method calls