tapping_device 0.4.9 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2d7b19e16c5c1f3f09d8d1abb81f8efe1238366a056457a804adf8c3ed5746
-  data.tar.gz: d683824d3c9ba64dc968d11891b2d1a5522768dbea68e604a6ed4dc04bef7488
+  metadata.gz: fbf652959b6f125f5e4ece39c59db0b8ebd55096e4aa639452de306857193bf7
+  data.tar.gz: 31d13f1f4f38b6009795e4d948ba4596428355cb03d113603b3801c307c14a18
 SHA512:
-  metadata.gz: bae37829ceac31871f11da1b9f2be3000572e65291229eb1208794e4214dc28bc55e4cc2dd44ec4a2dc1fd6cf01798509d860f132a6503b47368eadb544f172a
-  data.tar.gz: 73053c155178b21ddb93627f227f7a50130684b29c95cf0c310aedd06bcbf3ab94529a79fd73451725b7180e93ffa9e64b9d3fd7dd8e2c5125a15c8ea1500d21
+  metadata.gz: 98eae30679e7e08f7607dbd7ee457b9db9565e46ddf2859a782f2b5ce817bf014937b65f8ee0f342bb7d6dbec3afcb3aef980e396362726839c4031db03cb2e5
+  data.tar.gz: bf2d0e6e8e38466f928d57580edf745b1ee1ce18ed1ee03968dc76647b67cfb4e0feaeff0166ac7503c295c54351445344f828a0bc3878b57a74ed8a130a03cb

data/.github/workflows/ruby.yml

@@ -33,10 +33,17 @@ jobs:
         gem install bundler
         bundle install --jobs 4 --retry 3
 
-    - name: Run test with Rails ${{ matrix.rails_version }} and publish result
-      uses: paambaati/codeclimate-action@v2.3.0
+    - name: Run test with Rails ${{ matrix.rails_version }}
+      run: bundle exec rake
+
+    - name: Publish Test Coverage
+      uses: paambaati/codeclimate-action@v2.6.0
       env:
-        CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      if: ${{ env.CC_TEST_REPORTER_ID != '' }}
       with:
-        coverageCommand: bundle exec rake
+        # the coverage result should already be generated by the previous step
+        # so we don't need to provide and command in the step
+        # this is just a placeholder to avoid it run the default `yarn coverage` command
+        coverageCommand: ruby -v
         debug: true

data/.ruby-version

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

data/Gemfile.lock

@@ -1,39 +1,38 @@
 PATH
   remote: .
   specs:
-    tapping_device (0.4.9)
+    tapping_device (0.5.2)
       activerecord (>= 5.2)
-      awesome_print
+      pry
 
 GEM
   remote: https://rubygems.org/
   specs:
-    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)
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    awesome_print (1.8.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
     database_cleaner (1.7.0)
     diff-lcs (1.3)
     docile (1.3.2)
-    i18n (1.8.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
     json (2.3.0)
-    method_source (0.9.2)
-    minitest (5.14.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.0.4)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -54,9 +53,9 @@ GEM
     simplecov-html (0.10.2)
     sqlite3 (1.4.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.2.2)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -64,8 +63,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   database_cleaner
-  pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   simplecov (= 0.17.1)
   sqlite3 (>= 1.3.6)

data/README.md

@@ -6,459 +6,241 @@
 [![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)
-- [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)
-    - [Track Calls that Generates SQL Queries](#track-calls-that-generates-sql-queries)
-- [Installation](#installation)
-- [Usages](#usages)
-    - Tracing Helpers
-        - [print_traces](#print_traces)
-        - [print_calls_in_detail](#print_calls_in_detail)
-    - 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 of this gem is to make debugging Rails applications easier.  Here are some sample usages:
+`TappingDevice` makes the objects tell you what they do, so you don't need to track them yourself.
 
-### Print Object’s Traces
-
-Let your objects report to you, so you don’t need to guess how they work!
-
-```ruby
-class OrdersController < ApplicationController
-  include TappingDevice::Trackable
+#### Contact Tracing For Objects
 
-  def create
-    @cart = Cart.find(order_params[:cart_id])
-    print_traces(@cart, exclude_by_paths: [/gems/])
-    @order = OrderCreationService.new.perform(@cart)
-  end
-```
+The concept is very simple. It's basically like [contact tracing](https://en.wikipedia.org/wiki/Contact_tracing) for your Ruby objects. You can use 
 
-```
-Passed as 'cart' in 'OrderCreationService#perform' at /Users/st0012/projects/tapping_device-demo/app/controllers/orders_controller.rb:10
-Passed as 'cart' in 'OrderCreationService#validate_cart' at /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:8
-Called :reserved_until FROM /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:18
-Called :errors FROM /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:9
-Passed as 'cart' in 'OrderCreationService#apply_discount' at /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:10
-Called :apply_discount FROM /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:24
-……
-```
+- `print_calls(object)` to see what the object does
+- `print_traces(object)` to see how the object interacts with other objects (like used as an argument)
+- `print_mutations(object)` to see what actions changed the object's state (instance variables)
 
-(Also see [print_calls_in_detail](#print_calls_in_detail))
+Still sounds vague? Let's see some examples:
 
-### Track Calls that Generates SQL Queries
+### `print_calls` - Track Method Calls
 
-`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.
+In [Discourse](https://github.com/discourse/discourse), it uses the `Guardian` class for authorization (like policy objects). It's barely visible in controller actions, but it does many checks under the hood. Now, let's say we want to know what the `Guardian` would do when a user creates a post; here's the controller action:
 
 ```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]}")
+  def create
+    @manager_params = create_params
+    @manager_params[:first_post_checks] = !is_api?
+
+    manager = NewPostManager.new(current_user, @manager_params)
+
+    if is_api?
+      memoized_payload = DistributedMemoizer.memoize(signature_for(@manager_params), 120) do
+        result = manager.perform
+        MultiJson.dump(serialize_data(result, NewPostResultSerializer, root: false))
+      end
+
+      parsed_payload = JSON.parse(memoized_payload)
+      backwards_compatible_json(parsed_payload, parsed_payload['success'])
+    else
+      result = manager.perform
+      json = serialize_data(result, NewPostResultSerializer, root: false)
+      backwards_compatible_json(json, result.success?)
     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**
+As you can see, it doesn't even exist in the controller action, which makes tracking it by reading code very hard to do.
 
-## Installation
-Add this line to your application's Gemfile:
+But with `TappingDevice`. You can use `print_calls` to show what method calls the object performs
 
 ```ruby
-gem 'tapping_device', group: :development
-```
-
-And then execute:
-
-```
-$ bundle
+  def create
+    # you can retrieve the current guardian object by calling guardian in the controller
+    print_calls(guardian)
+    @manager_params = create_params
+   
+    # .....
 ```
 
-Or install it yourself as:
+Now, if you execute the code, like via tests:
 
+```shell
+$ rspec spec/requests/posts_controller_spec.rb:603
 ```
-$ 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
+You can get all the method calls it performs with basically everything you need to know
 
-It prints the object's trace. It's like mounting a GPS tracker + a spy camera on your object, so you can inspect your program through the object's eyes.
+<img src="https://github.com/st0012/tapping_device/blob/master/images/print_calls.png" alt="image of print_calls output" width="50%">
 
-```ruby
-class OrdersController < ApplicationController
-  include TappingDevice::Trackable
+Let's take a closer look at each entry. Everyone of them contains the method call's
+- method name 
+- method source class/module
+- call site
+- arguments
+- return value
 
-  def create
-    @cart = Cart.find(order_params[:cart_id])
-    print_traces(@cart, exclude_by_paths: [/gems/])
-    @order = OrderCreationService.new.perform(@cart)
-  end
-```
+![explanation of individual entry](https://github.com/st0012/tapping_device/blob/master/images/print_calls%20-%20single%20entry.png)
 
-```
-Passed as 'cart' in 'OrderCreationService#perform' at /Users/st0012/projects/tapping_device-demo/app/controllers/orders_controller.rb:10
-Passed as 'cart' in 'OrderCreationService#validate_cart' at /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:8
-Called :reserved_until FROM /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:18
-Called :errors FROM /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:9
-Passed as 'cart' in 'OrderCreationService#apply_discount' at /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:10
-Called :apply_discount FROM /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:24
-……
-```
+These are the information you'd have to look up one by one manually (probably with many debug code writing). Now you can get all of them in just one line of code.
 
-### print_calls_in_detail
 
-It prints the object's calls in detail (including call location, arguments, and return value). It's useful for observing an object's behavior when debugging.
+### `print_traces` - See The Object's Traces
 
-#### Options
-- `awesome_print:` - will print calls in prettier format if set to `true`. Default is `false`
+If you're not interested in what an object does, but what it interacts with other parts of the program, e.g., used as arguments. You can use the `print_traces` helper. Let's see how `Discourse` uses the `manager` object when creating a post
 
 ```ruby
-class OrdersController < ApplicationController
-  include TappingDevice::Trackable
-
   def create
-    @cart = Cart.find(order_params[:cart_id])
-    service = OrderCreationService.new
-    print_calls_in_detail(service)
-    @order = service.perform(@cart)
-  end
-```
+    @manager_params = create_params
+    @manager_params[:first_post_checks] = !is_api?
+   
+    manager = NewPostManager.new(current_user, @manager_params)
 
-```
-:validate_cart # OrderCreationService
-  <= {:cart=>#<Cart id: 1, total: 10, customer_id: 1, promotion_id: nil, reserved_until: nil, created_at: "2020-01-05 09:48:28", updated_at: "2020-01-05 09:48:28">}
-  => nil
-  FROM /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:8
-:apply_discount # OrderCreationService
-  <= {:cart=>#<Cart id: 1, total: 5, customer_id: 1, promotion_id: 1, reserved_until: nil, created_at: "2020-01-05 09:48:28", updated_at: "2020-01-05 09:48:28">, :promotion=>#<Promotion id: 1, amount: 0.5e1, customer_id: nil, created_at: "2020-01-05 09:48:28", updated_at: "2020-01-05 09:48:28">}
-  => true
-  FROM /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:10
-:create_order # OrderCreationService
-  <= {:cart=>#<Cart id: 1, total: 5, customer_id: 1, promotion_id: 1, reserved_until: nil, created_at: "2020-01-05 09:48:28", updated_at: "2020-01-05 09:48:28">}
-  => #<Order:0x00007f9ebcb17f08>
-  FROM /Users/st0012/projects/tapping_device-demo/app/services/order_creation_service.rb:11
-:perform # OrderCreationService
-  <= {:cart=>#<Cart id: 1, total: 5, customer_id: 1, promotion_id: 1, reserved_until: nil, created_at: "2020-01-05 09:48:28", updated_at: "2020-01-05 09:48:28">, :promotion=>#<Promotion id: 1, amount: 0.5e1, customer_id: nil, created_at: "2020-01-05 09:48:28", updated_at: "2020-01-05 09:48:28">}
-  => #<Order:0x00007f9ebcb17f08>
-  FROM /Users/st0012/projects/tapping_device-demo/app/controllers/orders_controller.rb:11
+    print_traces(manager)
+    # .....
 ```
 
-The output's order might look strange. This is because `tapping_device` needs to wait for the call to return in order to have its return value.
+And after running the test case
 
-### tap_init!
-
-`tap_init!(class)` -  tracks a class’ instance initialization
+```shell
+$ rspec spec/requests/posts_controller_spec.rb:603
+```
 
-```ruby
-calls = []
-tap_init!(Student) do |payload|
-  calls << [payload[:method_name], payload[:arguments]]
-end
+You will see that it performs 2 calls: `perform` and `perform_create_post`. And it's also used as `manager` argument in various of calls of the `NewPostManager` class.
 
-Student.new("Stan", 18)
-Student.new("Jane", 23)
+![image of print_traces output](https://github.com/st0012/tapping_device/blob/master/images/print_traces.png)
 
-puts(calls.to_s) #=> [[:initialize, {:name=>"Stan", :age=>18}], [:initialize, {:name=>"Jane", :age=>23}]]
-```
+### `print_mutations` - Display All State Changes At Once
 
-### tap_on!
+Another thing that often bothers developers in debugging is to track an object's internal state changes. And `tapping_device` allows you to see all state changes with just one line of code. Let me keep using [Discourse](https://github.com/discourse/discourse) to demonstrate it. 
 
- `tap_on!(object)` - tracks any calls received by the object.
+When updating a post, it uses an object called `PostRevisor` to revise it:
 
 ```ruby
-class PostsController < ApplicationController
-  include TappingDevice::Trackable
-
-  before_action :set_post, only: [:show, :edit, :update, :destroy]
-
-  def show
-    tap_on!(@post).and_print(:method_name_and_location)
+# app/controllers/posts_controller.rb
+class PostsController
+  def update
+    # ......
+    revisor = PostRevisor.new(post, topic)
+    revisor.revise!(current_user, changes, opts)
+    # ......
   end
 end
 ```
 
-And you can see these in log:
-
-```
-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
-```
-
-Also check the `track_as_records` option if you want to track `ActiveRecord` records.
-
-### tap_passed!
-
-`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.
+In the `PostReviser#revise!`, it uses many instance variables to track different information:
 
 ```ruby
-class PostsController < ApplicationController
-  include TappingDevice::Trackable
-  # GET /posts/new
-  def new
-    @post = Post.new
-
-    tap_passed!(@post) do |payload|
-      puts(payload.passed_at(with_method_head: true))
-    end
-  end
-end
-```
-
-```
-Passed as 'record' in method ':polymorphic_mapping'
-  > def polymorphic_mapping(record)
-  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:131
-Passed as 'klass' in method ':get_method_for_class'
-  > def get_method_for_class(klass)
-  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:269
-Passed as 'record' in method ':handle_model'
-  > def handle_model(record)
-  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:227
-Passed as 'record_or_hash_or_array' in method ':polymorphic_method'
-  > def self.polymorphic_method(recipient, record_or_hash_or_array, action, type, options)
-  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
-```
+  # lib/post_revisor.rb
+  def revise!(editor, fields, opts = {})
+    @editor = editor
+    @fields = fields.with_indifferent_access
+    @opts = opts
 
-### tap_assoc!
+    @topic_changes = TopicChanges.new(@topic, editor)
+    
+    # ......
 
-`tap_assoc!(activerecord_object)` tracks association calls on a record, like `post.comments`
+    @revised_at = @opts[:revised_at] || Time.now
+    @last_version_at = @post.last_version_at || Time.now
 
-```ruby
-tap_assoc!(order).and_print(:method_name_and_location)
-```
+    @version_changed = false
+    @post_successfully_saved = true
 
-```
-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
+    @validate_post = true
+    # ......
+  end
 ```
 
-### tap_sql!
+Tracking the changes of that many instance variables can be a painful task, especially when we want to know the values before and after certain method call. This is why I created `print_mutations` to save us from this. 
 
-`tap_sql!(anything_that_generates_sql_queries)` tracks sql queries generated from the target
+Like other helpers, you only need 1 line of code
 
 ```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
+# app/controllers/posts_controller.rb
+class PostsController
+  def update
+    # ......
+    revisor = PostRevisor.new(post, topic)
+    print_mutations(revisor)
+    revisor.revise!(current_user, changes, opts)
+    # ......
   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 then you'll see all the state changes:
 
-```
-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
-```
+<img src="https://github.com/st0012/tapping_device/blob/master/images/print_mutations.png" alt="image of print_mutations output" width="50%">
 
+Now you can see what method changes which states. And more importantly, you get to see all the sate changes at once!
 
-### 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. 
+**You can try these examples on [my fork of discourse](https://github.com/st0012/discourse/tree/demo-for-tapping-device)**
 
-```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:
+## Installation
+Add this line to your application's Gemfile:
 
 ```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
+gem 'tapping_device', group: :development
 ```
 
-#### exclude_by_paths
-It takes an array of call path patterns that we want to skip. This could be very helpful when working on a large project like Rails applications.
+And then execute:
 
-```ruby
-tap_on!(@post, exclude_by_paths: [/active_record/]).and_print(:method_name_and_location)
 ```
-
+$ bundle
 ```
-_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
-```
+Or install it directly:
 
-#### filter_by_paths
-
-Like `exclude_by_paths`, but work in the opposite way.
-
-
-### Payload of The Call
-All tapping methods (start with `tap_`) takes a block and yield a `Payload` object as a 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
+$ gem install tapping_device
 ```
 
-You can also set `passed_at(with_method_head: true)` to see the method's head.
+**Depending on the size of your application, `TappingDevice` could harm the performance significantly.  So make sure you don't put it inside the production group**
 
-```
-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` 
+### Advance Usages & Options 
 
+#### Add Conditions With `.with`
+
+Sometimes we don't need to know all the calls or traces of an object; we just want some of them. In those cases, we can chain the helpers with `.with` to filter the calls/traces.
+
+```ruby
+# only prints calls with name matches /foo/
+print_calls(object).with do |payload|
+  payload.method_name.to_s.match?(/foo/)
+end
 ```
-initialize @ Student
-  <= {:name=>"Stan", :age=>25}
-  => 25
-  FROM /Users/st0012/projects/tapping_device/spec/payload_spec.rb:7
-```
 
-### Advance Usages
+#### `colorize: false`
+
+By default `print_calls` and `print_traces` colorize their output. If you don't want the colors, you can use `colorize: false` to disable it.
 
-Tapping methods introduced above like `tap_on!` are designed for simple use cases. They're actually short for
 
 ```ruby
-device = TappingDevice.new { # tapping action }
-device.tap_on!(object)
+print_calls(object, colorize: false)
 ```
 
-And if you want to do some more configurations like stopping them manually or setting stop condition, you must have a `TappingDevie` instance. You can either get them like the above code or save the return value of `tap_*!` method calls.
 
-#### Stop tapping
+#### `inspect: true`
 
-Once you have a `TappingDevice` instance in hand, you will be able to stop the tapping by
-1. Manually calling `device.stop!`
-2. Setting stop condition with `device.stop_when`, like
+As you might have noticed, all the objects are converted into strings with `#to_s` instead of `#inspect`.  This is because when used on some Rails objects, `#inspect` can generate a significantly larger string than `#to_s`. For example:
 
-```ruby
-device.stop_when do |payload|
-  device.calls.count >= 10 # stop after gathering 10 calls’ data
-end
+``` ruby
+post.to_s #=> #<Post:0x00007f89a55201d0>
+post.inspect #=> #<Post id: 649, user_id: 3, topic_id: 600, post_number: 1, raw: "Hello world", cooked: "<p>Hello world</p>", created_at: "2020-05-24 08:07:29", updated_at: "2020-05-24 08:07:29", reply_to_post_number: nil, reply_count: 0, quote_count: 0, deleted_at: nil, off_topic_count: 0, like_count: 0, incoming_link_count: 0, bookmark_count: 0, score: nil, reads: 0, post_type: 1, sort_order: 1, last_editor_id: 3, hidden: false, hidden_reason_id: nil, notify_moderators_count: 0, spam_count: 0, illegal_count: 0, inappropriate_count: 0, last_version_at: "2020-05-24 08:07:29", user_deleted: false, reply_to_user_id: nil, percent_rank: 1.0, notify_user_count: 0, like_score: 0, deleted_by_id: nil, edit_reason: nil, word_count: 2, version: 1, cook_method: 1, wiki: false, baked_at: "2020-05-24 08:07:29", baked_version: 2, hidden_at: nil, self_edits: 0, reply_quoted: false, via_email: false, raw_email: nil, public_version: 1, action_code: nil, image_url: nil, locked_by_id: nil, image_upload_id: nil>
 ```
 
-#### Device states & Managing Devices
 
-Each `TappingDevice` instance can have 3 states:
+### Lower-Level Helpers
+`print_calls` and `print_traces` aren't the only helpers you can get from `TappingDevice`. They are actually built on top of other helpers, which you can use as well. To know more about them, please check [this page](https://github.com/st0012/tapping_device/wiki/Advance-Usages)
 
-- `Initial` - means the instance is initialized but hasn't tapped on anything.
-- `Enabled` - means the instance is tapping on something (has called `tap_*` methods).
-- `Disabled` - means the instance has been disabled. It will no longer receive any call info.
 
-When debugging, we may create many device instances and tap objects in several places. Then it'll be quite annoying to manage their states. So `TappingDevice` has several class methods that allows you to manage all `TappingDevice` instances:
+### Related Blog 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)
 
-- `TappingDevice.devices` - Lists all registered devices with `initial` or `enabled` state. Note that any instance that's been stopped will be removed from the list.
-- `TappingDevice.stop_all!` - Stops all registered devices and remove them from the `devices` list.
-- `TappingDevice.suspend_new!` - Suspends any device instance from changing their state from `initial` to `enabled`. Which means any  `tap_*` calls after it will no longer work. 
-- `TappingDevice.reset!` - Cancels `suspend_new` (if called) and stops/removes all created devices. Useful to reset the environment between test cases.
 
 ## Development
-
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
@@ -474,3 +256,4 @@ The gem is available as open-source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the TappingDevice project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tapping_device/blob/master/CODE_OF_CONDUCT.md).
+