putter 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c10cb5a65a0e9af1fecc76056ebf982133198a53
-  data.tar.gz: 6f56fba3228d58b36946c070dadf48710ec36cd2
+  metadata.gz: 7b61e558de7dab6687ddc1e44fcb1a66ae6a4669
+  data.tar.gz: 23a571a29ea9c44223a86e9762d02d5eb13d7352
 SHA512:
-  metadata.gz: 13583a279674f58f63f03d084e3bb9b9d974b359f30ede539c7ae1d564999d1832b9a7317d5abff091dfb5e5115af81e0f6552c5cc2cbd2cb58458a82c61e284
-  data.tar.gz: 3cce9ec1a107a16c235c642af2a01b8d0c5da3f7972fd702d61d48388aa3e1e29952c10f54cab08003a3d1a26397aca8f9162993c870848e78d8c58d30a035d1
+  metadata.gz: b700661ef9567e2e9f5b19880a491f0e37f7b7fd32597e024a04c0fd18df13bf5147add15a3dc49956a92850e0eb31df52eb13b1c89d0e31d03e00978f59b5d8
+  data.tar.gz: a5c554a5f52c2181a8d39cedfbeb50950a4b3d5420c1f99cf453f08797edd4b44e25a8d307f36d1265c18d3aab53b9f30290460c2e4cd28df913bfead72d3915

data/CHANGELOG.md

@@ -1,4 +1,6 @@
 # CHANGELOG
+### 0.3.0 - 2016-07-08
+- Add `Putter.watch` ability to watch a class and instances created by that class
 
 ### 0.2.1 - 2016-06-08
 - Add missing Gemfile.lock to bundled gem.

data/README.md

@@ -24,9 +24,15 @@ Or install it yourself as:
 
 ## Usage
 
+There are two ways to use putter. `Putter.follow` and `Putter.watch`.
+
 ### Putter.follow
 
-Currently there is only one use for Putter, the `follow` method.
+`Putter.follow` will allow you to create a wrapper around an object and then you can pass that wrapped object around. The advantage to using follow is that if a method is called that doesn't exist, or a method is created at runtime, the wrapped object will intercept those calls. This works on both instances and classes. However, following a class will not result in created instances of that class being followed.
+
+Additionally, following an object will not allow you to intercept calls to a class that occurred outside the wrapped object. For that functionality, use `Putter.watch`
+
+`Putter.follow` usage:
 
 ```ruby
 class MyObject
@@ -48,7 +54,7 @@ Service.do_stuff(object)
 Will output:
 
 ```bash
-Putter Debugging: Object instance -- Method: :hello, Args: [:world, "!"], Result: "Hello world!"
+Putter Debugging: Object instance ./putter/README.md:57 -- Method: :hello, Args: [:world, "!"], Result: "Hello world!"
 ```
 
 #### `Putter.follow` Options
@@ -61,18 +67,58 @@ Putter.follow(
 )
 ```
 
+### Putter.watch
+
+`Putter.watch` can be used on classes to follow created instances of the class or to intercept method calls that occur throughout your application.
+
+`Putter.follow` usage:
+
+```ruby
+class MyObject
+  def self.hello_class(arg, punc)
+    "The class says hello #{arg.to_s}#{punc}"
+  end
+
+  def hello_instance(arg, punc)
+    "An instance says hello #{arg.to_s}#{punc}"
+  end
+end
+
+Putter.watch(MyObject)
+MyObject.hello_class("world", "!")
+my_obj = MyObject.new
+my_obj.hello_instance("world", "!")
+```
+
+Will output:
+
+```bash
+Putter Debugging: Object ./putter/README.md:96 -- Method: :hello_class, Args: [:world, "!"], Result: "The class says hello world!"
+Putter Debugging: Object instance 1 ./putter/README.md:97 -- Method: :hello_instance, Args: [:world, "!"], Result: "The instance says hello world!"
+```
+
+#### `Putter.follow` Options
+
+```ruby
+Putter.watch(
+  ClassToFollow,
+  label: "My object",  # Label to use after "Putter Debugging:  My object". Will be "ClassName" for classes or "ClassName instance #" for instances
+)
+```
+
 ## Configuration
 
 Putter currently has 3 configuration options:
 
 ```ruby
 Putter.configure do |config|
-  # 'print_strategy' takes a block that receives four arguments with the label, method, args array,
-  # and result respectively. This block will be used after each method is called, it must contain
-  # puts or logger calls, to print or any other method callbacks that are helpful.
+  # 'print_strategy' takes a block that receives five arguments with the label, line,
+  # method, args array, and result respectively. This block will be used after each method
+  # is called, it must contain puts or logger calls, to print or any other method callbacks
+  # that are helpful.
   # Defaults to Putter::PrintStrategy::Default
-  config.print_strategy = Proc.new do |label, method, args, result|
-    puts "Label: #{label}, Method: #{method}, Args: #{args}, Result: #{result}"
+  config.print_strategy = Proc.new do |label, line, method, args, result|
+    puts "#{line} - Label: #{label}, Method: #{method}, Args: #{args}, Result: #{result}"
   end
 
   # 'ignore_methods_from' takes an array of class names and will ignore both class and instance methods
@@ -90,7 +136,6 @@ end
 ## Planned Features
 Feel free to open a PR to implement any of these if they are not yet added:
 
-- Ability to watch any instance of a class calling a method
 - Active Record specific printing
 - Checking Rails.env to double check that putter is not called in production
 

data/lib/putter/follower.rb

@@ -1,5 +1,7 @@
 module Putter
   class Follower < BasicObject
+    include MethodCreator
+
     attr_reader :object, :proxied_methods, :proxy
 
     def initialize(obj, options={})
@@ -26,14 +28,9 @@ module Putter
     end
 
     def add_method(method)
-      @proxy.instance_exec(@label) do |label, print_results|
-        define_method(method) do |*proxy_args, &blk|
-          args_string = proxy_args.to_s
-          result = super *proxy_args, &blk
-          ::Putter.configuration.print_strategy.call label, method, args_string, result
-          result
-        end
-      end
+      data = ProxyMethodData.new(method, @label)
+
+      add_putter_method_to_proxy(@proxy, :instance_exec, data)
     end
 
     def _add_method?(method)

data/lib/putter/instance_follower.rb

@@ -0,0 +1,11 @@
+module Putter
+  module InstanceFollower
+    @@putter_followed_instances = []
+
+    def new(*args, &blk)
+      result = super *args, &blk
+      @@putter_followed_instances << result
+      ::Putter.follow(result, label: "#{name} instance #{@@putter_followed_instances.count}")
+    end
+  end
+end

data/lib/putter/method_creator.rb

@@ -0,0 +1,16 @@
+module Putter
+  module MethodCreator
+    def add_putter_method_to_proxy(proxy, eval_method, data)
+      proxy.send(eval_method, data) do |data|
+        define_method(data.method) do |*proxy_args, &blk|
+          line = caller.find {|call| call.match(data.stack_trace_ignore_regex)}
+          line = line.split(::Dir.pwd)[1]
+          args_string = proxy_args.to_s
+          result = super *proxy_args, &blk
+          ::Putter.configuration.print_strategy.call data.label, line, data.method, args_string, result
+          result
+        end
+      end
+    end
+  end
+end

data/lib/putter/print_strategy.rb

@@ -2,10 +2,11 @@ require "colorize"
 
 module Putter
   module PrintStrategy
-    Default = Proc.new do |label, method, args, result|
-      prefix = "\tPutter Debugging: ".colorize(:cyan)
-      suffix = "#{label} -- Method: :#{method}, Args: #{args}, Result: #{result}".colorize(:green)
-      puts prefix + suffix
+    Default = Proc.new do |label, line, method, args, result|
+      prefix = "\tPutter Debugging: #{label} ".colorize(:cyan)
+      line = !line.nil? ? ".#{line} " : " "
+      suffix = "-- Method: :#{method}, Args: #{args}, Result: #{result}".colorize(:green)
+      puts prefix + line + suffix
     end
   end
 end

data/lib/putter/proxy_method_data.rb

@@ -0,0 +1,16 @@
+module Putter
+  class ProxyMethodData
+    STACK_TRACE_IGNORE_REGEX = /(?!.*(\.rbenv|\.rvm|\/lib\/putter\/follower))(^.*$)/
+
+    attr_reader :method, :label
+
+    def initialize(method, label)
+      @method = method
+      @label = label
+    end
+
+    def stack_trace_ignore_regex
+      STACK_TRACE_IGNORE_REGEX
+    end
+  end
+end

data/lib/putter/version.rb

@@ -1,3 +1,3 @@
 module Putter
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/putter/watcher.rb

@@ -0,0 +1,53 @@
+module Putter
+  class Watcher
+    extend MethodCreator
+
+    @label = ""
+
+    def self.watch(obj, options={})
+      _set_label(options[:label], obj.name)
+
+      class << obj
+        prepend InstanceFollower
+        prepend Putter::Watcher.class_proxy(self)
+      end
+    end
+
+    def self.class_proxy(klass)
+      proxy = MethodProxy.new
+
+      methods_to_proxy(klass).each do |method|
+        data = ProxyMethodData.new(method, label)
+        add_putter_method_to_proxy(proxy, :module_exec, data)
+      end
+
+      proxy
+    end
+
+    def self.methods_to_proxy(klass)
+      ignored_methods = []
+
+      Putter.configuration.ignore_methods_from.each do |klass|
+        ignored_methods += klass.methods
+      end
+
+      klass.instance_methods - ignored_methods + Putter.configuration.methods_whitelist.map(&:to_sym) + [:new]
+    end
+
+    def self.label
+      @label
+    end
+
+    def self.label=(label)
+      @label = label
+    end
+
+    def self._set_label(label, class_name)
+      if !label.nil? && label != ""
+        @label = label
+      else
+        @label = class_name
+      end
+    end
+  end
+end

data/lib/putter.rb

@@ -1,10 +1,15 @@
 require "putter/configuration"
 require "putter/errors"
-require "putter/follower"
+require "putter/instance_follower"
+require "putter/method_creator"
 require "putter/method_proxy"
 require "putter/print_strategy"
+require "putter/proxy_method_data"
 require "putter/version"
 
+require "putter/follower"
+require "putter/watcher"
+
 module Putter
   include Errors
 
@@ -16,6 +21,10 @@ module Putter
     Putter::Follower.new(obj, options)
   end
 
+  def self.watch(obj, options={})
+    Putter::Watcher.watch(obj, options)
+  end
+
   def self.configuration
     @configuration ||= Configuration.new
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - John DeWyze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -109,9 +109,13 @@ files:
 - lib/putter/configuration.rb
 - lib/putter/errors.rb
 - lib/putter/follower.rb
+- lib/putter/instance_follower.rb
+- lib/putter/method_creator.rb
 - lib/putter/method_proxy.rb
 - lib/putter/print_strategy.rb
+- lib/putter/proxy_method_data.rb
 - lib/putter/version.rb
+- lib/putter/watcher.rb
 - putter.gemspec
 homepage: https://github.com/dewyze/putter
 licenses: