tapping_device 0.4.8 → 0.5.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.1
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,17 +122,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.17.1
-description: tapping_device provides useful helpers to intercept method calls
+description: tapping_device lets you understand what your Ruby objects do without
+  digging into the code
 email:
 - stan001212@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".github/workflows/gempush.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -142,11 +145,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- images/print_calls - single entry.png
+- images/print_calls.png
+- images/print_traces.png
 - lib/tapping_device.rb
 - lib/tapping_device/exceptions.rb
 - lib/tapping_device/manageable.rb
+- lib/tapping_device/output_payload.rb
 - lib/tapping_device/payload.rb
-- lib/tapping_device/sql_tapping_methods.rb
 - lib/tapping_device/trackable.rb
 - lib/tapping_device/version.rb
 - tapping_device.gemspec
@@ -175,5 +181,6 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: tapping_device provides useful helpers to intercept method calls
+summary: tapping_device lets you understand what your Ruby objects do without digging
+  into the code
 test_files: []

data/lib/tapping_device/sql_tapping_methods.rb

@@ -1,89 +0,0 @@
-class TappingDevice
-  module SqlTappingMethods
-    CALL_STACK_SKIPPABLE_METHODS = [:transaction, :tap]
-
-    # SQLListener acts like an interface for us to intercept activerecord query instrumentations
-    # this means we only need to register one subscriber no matter how many objects we want to tap on
-    class SQLListener
-      def call(name, start, finish, message_id, values);end
-    end
-    @@sql_listener = SQLListener.new
-
-    ActiveSupport::Notifications.subscribe("sql.active_record", @@sql_listener)
-
-    def tap_sql!(object)
-      @call_stack = []
-      @target ||= object
-      @trace_point = with_trace_point_on_target(object, event: [:call, :c_call]) do |start_tp|
-        ########## 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 already_recording?(method)
-
-        ########## Start the recording ##########
-        # 1. Mark recording state by pushing method into @call_stack
-        # 2. Subscribe sql instrumentations generated by activerecord
-        # 3. Record those sqls and run device callbacks
-        # 4. Start waiting for current call's return callback
-        @call_stack.push(method)
-        payload = build_payload(tp: start_tp, filepath: filepath, line_number: line_number)
-        device = tap_on_sql_instrumentation!(payload)
-
-        with_trace_point_on_target(object, event: :return) do |return_tp|
-          next unless return_tp.callee_id == method
-
-          ########## End recording ##########
-          # 1. Close itself
-          # 2. Stop our subscription on SQLListener
-          # 3. Remove current method from @call_stack
-          # 4. Stop the device if stop condition is fulfilled
-          return_tp.disable
-          device.stop!
-          @call_stack.pop
-          stop_if_condition_fulfilled(payload)
-
-          ########## Track descendant objects ##########
-          # if the method creates another Relation object
-          if return_tp.defined_class == ActiveRecord::QueryMethods
-            create_child_device.tap_sql!(return_tp.return_value)
-          end
-        end.enable
-      end
-
-      @trace_point.enable unless self.class.suspend_new
-
-      self
-    end
-  end
-
-  private
-
-  def tap_on_sql_instrumentation!(payload)
-    device = TappingDevice.new do |sql_listener_payload|
-      values = sql_listener_payload.arguments[:values]
-
-      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)
-    end
-    device.tap_on!(@@sql_listener)
-  end
-
-  # usually, AR's query methods (like `first`) will end up calling `find_by_sql`
-  # then to TappingDevice, both `first` and `find_by_sql` generates the sql
-  # but the results are duplicated, we should only consider the `first` call
-  def already_recording?(method)
-    !@call_stack.empty? || CALL_STACK_SKIPPABLE_METHODS.include?(method)
-  end
-
-  def with_trace_point_on_target(object, event:)
-    TracePoint.new(*event) do |tp|
-      if is_from_target?(object, tp)
-        yield(tp)
-      end
-    end
-  end
-end