tapping_device 0.4.10 → 0.5.3

data/lib/tapping_device/trackers/method_call_tracker.rb

@@ -0,0 +1,9 @@
+class TappingDevice
+  module Trackers
+    class MethodCallTracker < TappingDevice
+      def filter_condition_satisfied?(tp)
+        is_from_target?(tp)
+      end
+    end
+  end
+end

data/lib/tapping_device/trackers/mutation_tracker.rb

@@ -0,0 +1,112 @@
+class TappingDevice
+  module Trackers
+    class MutationTracker < TappingDevice
+      def initialize(options, &block)
+        options[:hijack_attr_methods] = true
+        super
+        @snapshot_stack = []
+      end
+
+      def track(object)
+        super
+        insert_snapshot_taking_trace_point
+        self
+      end
+
+      def stop!
+        super
+        @ivar_snapshot_trace_point.disable
+      end
+
+      private
+
+      # we need to snapshot instance variables at the beginning of every method call
+      # so we can get a correct state for the later comparison
+      def insert_snapshot_taking_trace_point
+        @ivar_snapshot_trace_point = build_minimum_trace_point(event_type: :call) do
+          snapshot_instance_variables
+        end
+
+        @ivar_snapshot_trace_point.enable unless TappingDevice.suspend_new
+      end
+
+      def filter_condition_satisfied?(tp)
+        return false unless is_from_target?(tp)
+
+        if snapshot_capturing_event?(tp)
+          true
+        else
+          @latest_instance_variables = target_instance_variables
+          @instance_variables_snapshot = @snapshot_stack.pop
+
+          @latest_instance_variables != @instance_variables_snapshot
+        end
+      end
+
+      def build_payload(tp:, filepath:, line_number:)
+        payload = super
+
+        if change_capturing_event?(tp)
+          payload[:ivar_changes] = capture_ivar_changes
+        end
+
+        payload
+      end
+
+      def capture_ivar_changes
+        changes = {}
+
+        additional_keys = @latest_instance_variables.keys - @instance_variables_snapshot.keys
+        additional_keys.each do |key|
+          changes[key] = {before: Output::Payload::UNDEFINED, after: @latest_instance_variables[key]}
+        end
+
+        removed_keys = @instance_variables_snapshot.keys - @latest_instance_variables.keys
+        removed_keys.each do |key|
+          changes[key] = {before: @instance_variables_snapshot[key], after: Output::Payload::UNDEFINED}
+        end
+
+        remained_keys = @latest_instance_variables.keys - additional_keys
+        remained_keys.each do |key|
+          next if @latest_instance_variables[key] == @instance_variables_snapshot[key]
+          changes[key] = {before: @instance_variables_snapshot[key], after: @latest_instance_variables[key]}
+        end
+
+        changes
+      end
+
+      def snapshot_instance_variables
+        @snapshot_stack.push(target_instance_variables)
+      end
+
+      def target_instance_variables
+        target.instance_variables.each_with_object({}) do |ivar, hash|
+          hash[ivar] = target.instance_variable_get(ivar)
+        end
+      end
+
+      def snapshot_capturing_event?(tp)
+        tp.event == :call
+      end
+
+      def change_capturing_event?(tp)
+        !snapshot_capturing_event?(tp)
+      end
+
+      # belows are debugging helpers
+      # I'll leave them for a while in case there's a bug in the tracker
+      def print_snapshot_stack(tp)
+        puts("===== STACK - #{tp.callee_id} (#{tp.event}) =====")
+        puts(@snapshot_stack)
+        puts("================ END STACK =================")
+      end
+
+      def print_state_comparison
+        puts("###############")
+        puts(@latest_instance_variables)
+        puts(@instance_variables_snapshot)
+        puts("###############")
+      end
+    end
+  end
+end

data/lib/tapping_device/trackers/passed_tracker.rb

@@ -0,0 +1,16 @@
+class TappingDevice
+  module Trackers
+    # PassedTracker tracks calls that use the target object as an argument
+    class PassedTracker < TappingDevice
+      def filter_condition_satisfied?(tp)
+        collect_arguments(tp).values.any? do |value|
+          # during comparison, Ruby might perform data type conversion like calling `to_sym` on the value
+          # but not every value supports every conversion methods
+          target == value rescue false
+        end
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/tapping_device/version.rb

@@ -1,3 +1,3 @@
 class TappingDevice
-  VERSION = "0.4.10"
+  VERSION = "0.5.3"
 end

data/tapping_device.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["st0012"]
   spec.email         = ["stan001212@gmail.com"]
 
-  spec.summary       = %q{tapping_device provides useful helpers to intercept method calls}
-  spec.description   = %q{tapping_device provides useful helpers to intercept method calls}
+  spec.summary       = %q{tapping_device lets you understand what your Ruby objects do without digging into the code}
+  spec.description   = %q{tapping_device lets you understand what your Ruby objects do without digging into the code} 
   spec.homepage      = "https://github.com/st0012/tapping_device"
   spec.license       = "MIT"
 
@@ -32,13 +32,13 @@ Gem::Specification.new do |spec|
     spec.add_dependency "activerecord", ">= 5.2"
   end
 
-  spec.add_dependency "awesome_print"
+  spec.add_dependency "pry" # for using Method#source in MutationTracker
+  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "sqlite3", ">= 1.3.6"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.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.10
+  version: 0.5.3
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-05 00:00:00.000000000 Z
+date: 2020-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,34 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
@@ -136,19 +136,22 @@ 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"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -157,12 +160,27 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- images/print_calls - single entry.png
+- images/print_calls.png
+- images/print_mutations.png
+- images/print_traces.png
 - lib/tapping_device.rb
+- lib/tapping_device/configurable.rb
 - lib/tapping_device/exceptions.rb
 - lib/tapping_device/manageable.rb
+- lib/tapping_device/method_hijacker.rb
+- lib/tapping_device/output.rb
+- lib/tapping_device/output/file_writer.rb
+- lib/tapping_device/output/payload.rb
+- lib/tapping_device/output/stdout_writer.rb
+- lib/tapping_device/output/writer.rb
 - lib/tapping_device/payload.rb
-- lib/tapping_device/sql_tapping_methods.rb
 - lib/tapping_device/trackable.rb
+- lib/tapping_device/trackers/association_call_tracker.rb
+- lib/tapping_device/trackers/initialization_tracker.rb
+- lib/tapping_device/trackers/method_call_tracker.rb
+- lib/tapping_device/trackers/mutation_tracker.rb
+- lib/tapping_device/trackers/passed_tracker.rb
 - lib/tapping_device/version.rb
 - tapping_device.gemspec
 homepage: https://github.com/st0012/tapping_device
@@ -190,5 +208,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