spy_rb 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a262963c1ed562ad509486821cf161a6240459b
-  data.tar.gz: da505c8ea44f5e4259df12ee84400b9c80c8db35
+  metadata.gz: 4256e6a05208bf9e7467ac42d7f1c5393a44ce87
+  data.tar.gz: d4a27a39240558415d0b3fc10ca3a9124d765e8d
 SHA512:
-  metadata.gz: 5e5602007b1865055cd1ffabe15e07083957b9efc1372755826691512ab34454522e7c517c44df1d86632bd4c4c6b23b1902df5c6dc585c5c036822767aa7f21
-  data.tar.gz: 99c49688320313eeb31d515fbf60fc473bd821c2548b028a92c3cf9593d2c4ef8eade41d7bc75cc45aa96a1cbfdb1d6c5201c83acf1e901db5343d1337cdf9d5
+  metadata.gz: e658ea9847acbdcb43d54526b9da0c7f2d132448f6c6c4e05874d1ee49ae4bdbf518b9d878376141684d95679cedd589caa79a95d691e72af25573bc59930bd2
+  data.tar.gz: 62e3beeb79895b0ecb3de90af60864a0b687529fb4b99b2e33c7964d801824ab350f71a9e7fc4d7d581f14929afaae5d1d0aa10072870e6295d0338da699e519

data/lib/spy/api.rb

@@ -0,0 +1,53 @@
+require 'spy/core'
+
+module Spy
+  module API
+    # Initializes a new spy instance for the method
+    #
+    # With two args:
+    # @param receiver - the receiver of the message you want to spy on
+    # @param msg - the message passed to the receiver that you want to spy on
+    def on(*args)
+      case args.length
+      when 2
+        return core.add_spy *(args << :method)
+      end
+      raise ArgumentError
+    end
+
+    # TODO docs
+    def on_any_instance(mod, msg)
+      core.add_spy(mod, msg, :instance_method)
+    end
+
+    # Stops spying on the method and restores its original functionality
+    #
+    # @param args - supports multiple signatures
+    #
+    #   Spy.restore(:all)
+    #       => stops spying on every spied message
+    #
+    #   Spy.restore(receiver, msg)
+    #       => stops spying on the given receiver and message (assumes :method)
+    #
+    #   Spy.restore(reciever, msg, method_type)
+    #       =>  stops spying on the given receiver and message of method_type
+    def restore(*args)
+      case args.length
+      when 1
+        return core.remove_all_spies if args.first == :all
+      when 2
+        return core.remove_spy *(args << :method)
+      when 3
+        return core.remove_spy *args
+      end
+      raise ArgumentError
+    end
+
+    private
+
+    def core
+      @core ||= Core.new
+    end
+  end
+end

data/lib/spy/collection/entry.rb

@@ -0,0 +1,36 @@
+module Spy
+  class Collection
+    class Entry < Struct.new(:receiver, :msg, :method_type)
+      attr_accessor :value
+
+      def key
+        "#{receiver.object_id}|#{msg}|#{method_type}"
+      end
+
+      def ==(other)
+        key == other.key
+      end
+
+      module ClassMethods
+        def parse(key)
+          new *parse_key(key)
+        end
+
+        def parse_key(key)
+          parts = key.split('|')
+          parts[0] = find_object(parts[0].to_i)
+          parts[1] = parts[1].to_sym
+          parts[2] = parts[2].to_sym
+          parts
+        end
+
+        # Looks up an object in the global ObjectSpace
+        def find_object(object_id)
+          ObjectSpace._id2ref(object_id)
+        end
+      end
+
+      extend ClassMethods
+    end
+  end
+end

data/lib/spy/collection.rb

@@ -0,0 +1,46 @@
+require 'spy/collection/entry'
+
+module Spy
+  class Collection
+    include Enumerable
+
+    def initialize
+      @store = {}
+    end
+
+    def insert(entry)
+      raise Errors::AlreadySpiedError if include?(entry)
+      @store[entry.key] = entry
+    end
+
+    def remove(entry)
+      raise Errors::MethodNotSpiedError unless include?(entry)
+      @store.delete(entry.key).value
+    end
+
+    # Removes each element from the collection and calls the block
+    # with each deleted element
+    def remove_all
+      map {|e| yield remove(e)}
+    end
+
+    def each
+      @store.keys.each {|k| yield Entry.parse(k)}
+    end
+
+    # Add a slicker interface that abstracts away Collection::Entry
+    module SpyHelper
+      def <<(spy)
+        entry = Collection::Entry.new(spy.receiver, spy.msg, spy.method_type)
+        entry.value = spy
+        insert entry
+      end
+
+      def pop(receiver, msg, method_type)
+        remove Collection::Entry.new(receiver, msg, method_type)
+      end
+    end
+
+    include SpyHelper
+  end
+end

data/lib/spy/collection_entry.rb

@@ -0,0 +1,34 @@
+module Spy
+  class CollectionEntry < Struct.new(:receiver, :msg, :method_type)
+    attr_accessor :value
+
+    def key
+      "#{receiver.object_id}|#{msg}|#{method_type}"
+    end
+
+    def ==(other)
+      key == other.key
+    end
+
+    module ClassMethods
+      def parse(key)
+        new *parse_key(key)
+      end
+
+      def parse_key(key)
+        parts = key.split('|')
+        parts[0] = find_object(parts[0].to_i)
+        parts[1] = parts[1].to_sym
+        parts[2] = parts[2].to_sym
+        parts
+      end
+
+      # Looks up an object in the global ObjectSpace
+      def find_object(object_id)
+        ObjectSpace._id2ref(object_id)
+      end
+    end
+
+    extend ClassMethods
+  end
+end

data/lib/spy/core.rb

@@ -0,0 +1,26 @@
+require 'spy/instance'
+require 'spy/collection'
+require 'spy/errors'
+
+module Spy
+  class Core
+    def spy_collection
+      @spy_collection ||= Collection.new
+    end
+
+    def add_spy(receiver, msg, method_type)
+      spy = Instance.new(receiver, msg, method_type)
+      spy_collection << spy
+      spy.start
+    end
+
+    def remove_spy(receiver, msg, method_type)
+      spy = spy_collection.pop(receiver, msg, method_type)
+      spy.stop
+    end
+
+    def remove_all_spies
+      spy_collection.remove_all { |spy| spy.stop }
+    end
+  end
+end

data/lib/spy/errors.rb

@@ -0,0 +1,6 @@
+module Spy
+  module Errors
+    MethodNotSpiedError = Class.new(StandardError)
+    AlreadySpiedError   = Class.new(StandardError)
+  end
+end

data/lib/spy/instance.rb

@@ -0,0 +1,54 @@
+# An instance of a spied method
+# - Holds a reference to the original method
+# - Wraps the original method
+# - Provides hooks for callbacks
+module Spy
+  class Instance
+    attr_reader :receiver, :method_type, :msg, :original, :call_count
+
+    def initialize(receiver, msg, method_type)
+      @msg = msg
+      @receiver = receiver
+      @method_type = method_type
+
+      # Cache the original method for unwrapping later
+      @original = @receiver.send(method_type, msg)
+      @call_count = 0
+      @match_args = []
+    end
+
+    def start
+      context = self
+      original.owner.instance_eval do
+        define_method context.msg do |*args|
+          if context.original.respond_to? :bind
+            result = context.original.bind(self).call(*args)
+          else
+            result = context.original.call(*args)
+          end
+          context.after_call(result, *args)
+          result
+        end
+      end
+      self
+    end
+
+    def stop
+      context = self
+      original.owner.instance_eval do
+        define_method context.msg, context.original
+      end
+      self
+    end
+
+    def after_call(result, *args)
+      return unless @match_args.empty? || @match_args == args
+      @call_count += 1
+    end
+
+    def with_args(*args)
+      @match_args = args || []
+      self
+    end
+  end
+end

data/lib/spy.rb

@@ -1,4 +1,4 @@
-require_relative 'spy/api'
+require 'spy/api'
 
 module Spy
   extend API

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spy_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Josh Bodah
@@ -20,6 +20,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/spy.rb
+- lib/spy/api.rb
+- lib/spy/collection.rb
+- lib/spy/collection/entry.rb
+- lib/spy/collection_entry.rb
+- lib/spy/core.rb
+- lib/spy/errors.rb
+- lib/spy/instance.rb
 homepage: https://github.com/jbodah/spy_rb
 licenses:
 - MIT