putter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b61e558de7dab6687ddc1e44fcb1a66ae6a4669
-  data.tar.gz: 23a571a29ea9c44223a86e9762d02d5eb13d7352
+  metadata.gz: 16b81ce160fb22785ce8b1bdce7822783ba85eec
+  data.tar.gz: 7bc3095434de6035e590c28a37c8d435216a5e20
 SHA512:
-  metadata.gz: b700661ef9567e2e9f5b19880a491f0e37f7b7fd32597e024a04c0fd18df13bf5147add15a3dc49956a92850e0eb31df52eb13b1c89d0e31d03e00978f59b5d8
-  data.tar.gz: a5c554a5f52c2181a8d39cedfbeb50950a4b3d5420c1f99cf453f08797edd4b44e25a8d307f36d1265c18d3aab53b9f30290460c2e4cd28df913bfead72d3915
+  metadata.gz: 8334e5bea55fae12d4e65fd35d1077069c32895f71fe26c06673b9f006a36e6693de536753d0b13f8158e89a5a4a76d3ec8c486d055389b29ac5c778fb5b373c
+  data.tar.gz: 30885b70b4ae1d78a1b74a2eaae951c91175e1879abd95e4721ed2c5dffdecc51c83f7b187108c2273ed538ea18f9a2abd728593e6e2f21bbccaa1630d4f184a

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 # CHANGELOG
+### 0.4.0 - 2016-08-16
+- Add methods option to `Putter.watch`
+- Refactor watch method to use registry
+- Refactor method creation specs
+- Update README
+
 ### 0.3.0 - 2016-07-08
 - Add `Putter.watch` ability to watch a class and instances created by that class
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    putter (0.2.1)
+    putter (0.4.0)
       colorize (~> 0)
 
 GEM

data/README.md

@@ -2,9 +2,7 @@
 
 It rhymes with gooder, not gutter.
 
-Putter is a tool for more easily implementing puts debugging. Instead of littering files with various puts statements, you can wrap an object with a follower and print out anytime a method is called on that object. This will follow the object throughout its path in the stack.
-
-For now Putter can only follow a specific the speficic object that it wraps. It currently does not watch a class to see what objects were passed to it unless that specific instance of the class is passed through the stack.
+Putter is a tool for more easily implementing puts debugging. Instead of littering files with various puts statements, you can wrap an object with a follower or watcher and print out anytime a method is called on that object. This will follow the object throughout its path in the stack.
 
 ## Installation
 
@@ -26,11 +24,11 @@ Or install it yourself as:
 
 There are two ways to use putter. `Putter.follow` and `Putter.watch`.
 
-### Putter.follow
+### `Putter.follow`
 
-`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.
+`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.
 
-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`
+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:
 
@@ -62,16 +60,16 @@ Putter Debugging: Object instance ./putter/README.md:57 -- Method: :hello, Args:
 ```ruby
 Putter.follow(
   object_to_follow,
-  label: "My object",  # Label to use after "Putter Debugging:  My object". Will be "ClassName" for classes or "ClassName instance" for instances
-  methods: ["value"],  # If the value is nil, then all methods will be watched. Otherwise, this is an array of methods to print debugging input for
+  label: "My object",  # Optional - Label to use after "Putter Debugging:  My object". Will be "ClassName" for classes or "ClassName instance" for instances
+  methods: ["my_method"],  # Optional - If array is empty, then all methods will be watched. Otherwise, this is an array of methods to print debugging input for
 )
 ```
 
-### Putter.watch
+### `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.watch` can be used on classes to follow created instances of the class or to intercept class method calls that occur throughout your application.
 
-`Putter.follow` usage:
+`Putter.watch` usage:
 
 ```ruby
 class MyObject
@@ -93,16 +91,18 @@ 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 Debugging: MyObject ./putter/README.md:96 -- Method: :hello_class, Args: ["world", "!"], Result: The class says hello world!
+Putter Debugging: MyObject ./putter/README.md:96 -- Method: :new, Args: [], Result: #<MyObject:0x0000000000>
+Putter Debugging: MyObject instance 1 ./putter/README.md:97 -- Method: :hello_instance, Args: ["world", "!"], Result: The instance says hello world!
 ```
 
-#### `Putter.follow` Options
+#### `Putter.watch` 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
+  ClassToWatch,
+  label: "My class",  # Optional - Label to use after "Putter Debugging:  My class". Will be "ClassName" for classes or "ClassName instance #" for instances
+  methods: ["my_method"],  # Optional - If array is empty, then all methods will be watched. Otherwise, this is an array of methods to print debugging input for
 )
 ```
 
@@ -112,13 +112,13 @@ Putter currently has 3 configuration options:
 
 ```ruby
 Putter.configure do |config|
-  # '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
+  # 'print_strategy' takes a block that receives a data object with the label, line,
+  # method, args string, 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, line, method, args, result|
-    puts "#{line} - Label: #{label}, Method: #{method}, Args: #{args}, Result: #{result}"
+  config.print_strategy = Proc.new do |data|
+    puts "#{data.line} - Label: #{data.label}, Method: #{data.method}, Args: #{data.args}, Result: #{data.result}"
   end
 
   # 'ignore_methods_from' takes an array of class names and will ignore both class and instance methods
@@ -128,7 +128,7 @@ Putter.configure do |config|
 
   # 'methods_whitelist' takes an array of methods and will always proxy and debug those methods
   # regardless of whether or not the class is ignored and regardless of what methods are passed
-  # in when running 'Putter.follow'
+  # in when running 'Putter.follow' or 'Putter.watch'
   config.methods_whitelist = [:to_s]
 end
 ```

data/lib/putter/follower.rb

@@ -28,9 +28,9 @@ module Putter
     end
 
     def add_method(method)
-      data = ProxyMethodData.new(method, @label)
+      data = ProxyMethodData.new({ label: @label, method: method})
 
-      add_putter_method_to_proxy(@proxy, :instance_exec, data)
+      add_putter_instance_method_to_proxy(@proxy, data)
     end
 
     def _add_method?(method)

data/lib/putter/method_creator.rb

@@ -1,14 +1,24 @@
 module Putter
   module MethodCreator
-    def add_putter_method_to_proxy(proxy, eval_method, data)
+    def add_putter_instance_method_to_proxy(proxy, data)
+      add_putter_method_to_proxy(proxy, data, :instance_exec)
+    end
+
+    def add_putter_class_method_to_proxy(proxy, data)
+      add_putter_method_to_proxy(proxy, data, :module_exec)
+    end
+
+    private
+
+    def add_putter_method_to_proxy(proxy, data, eval_method)
       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
+          data.line = line.split(::Dir.pwd)[1]
+          data.args = proxy_args.to_s
+          data.result = super *proxy_args, &blk
+          ::Putter.configuration.print_strategy.call data
+          data.result
         end
       end
     end

data/lib/putter/print_strategy.rb

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

data/lib/putter/proxy_method_data.rb

@@ -2,11 +2,14 @@ module Putter
   class ProxyMethodData
     STACK_TRACE_IGNORE_REGEX = /(?!.*(\.rbenv|\.rvm|\/lib\/putter\/follower))(^.*$)/
 
-    attr_reader :method, :label
+    attr_accessor :label, :line, :method, :args, :result
 
-    def initialize(method, label)
-      @method = method
-      @label = label
+    def initialize(params)
+      @label = params[:label]
+      @line = params[:line]
+      @method = params[:method]
+      @args = params[:args]
+      @result = params[:result]
     end
 
     def stack_trace_ignore_regex

data/lib/putter/version.rb

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

data/lib/putter/watcher.rb

@@ -1,11 +1,12 @@
 module Putter
-  class Watcher
+  module Watcher
     extend MethodCreator
 
-    @label = ""
+    @registry = {}
 
     def self.watch(obj, options={})
-      _set_label(options[:label], obj.name)
+      data = WatcherData.new(options, obj)
+      @registry[obj.singleton_class] = data
 
       class << obj
         prepend InstanceFollower
@@ -13,41 +14,27 @@ module Putter
       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
+    def self.registry
+      @registry
     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]
+    def self.label_for(klass)
+      @registry[klass].label
     end
 
-    def self.label
-      @label
+    def self.methods_for(klass)
+      @registry[klass].proxy_methods
     end
 
-    def self.label=(label)
-      @label = label
-    end
+    def self.class_proxy(klass)
+      proxy = MethodProxy.new
 
-    def self._set_label(label, class_name)
-      if !label.nil? && label != ""
-        @label = label
-      else
-        @label = class_name
+      Putter::Watcher.methods_for(klass).each do |method|
+        data = ProxyMethodData.new({ label: Putter::Watcher.label_for(klass), method: method })
+        add_putter_class_method_to_proxy(proxy, data)
       end
+
+      proxy
     end
   end
 end

data/lib/putter/watcher_data.rb

@@ -0,0 +1,38 @@
+module Putter
+  class WatcherData
+    attr_accessor :label, :proxy_methods
+
+    def initialize(options, klass)
+      _set_label(options[:label], klass)
+      _set_methods(options[:methods], klass)
+    end
+
+    def _set_label(label, klass)
+      if !label.nil? && label != ""
+        @label = label
+      else
+        @label = klass.name
+      end
+    end
+
+    def _set_methods(methods, klass)
+      if methods.nil?
+        @proxy_methods = _methods_to_proxy(klass.singleton_class)
+      elsif !methods.is_a?(Array)
+        @proxy_methods = [methods]
+      else
+        @proxy_methods = methods
+      end
+    end
+
+    def _methods_to_proxy(singleton_klass)
+      ignored_methods = []
+
+      Putter.configuration.ignore_methods_from.each do |klass|
+        ignored_methods += klass.methods
+      end
+
+      singleton_klass.instance_methods - ignored_methods + Putter.configuration.methods_whitelist.map(&:to_sym) + [:new]
+    end
+  end
+end

data/lib/putter.rb

@@ -6,6 +6,7 @@ require "putter/method_proxy"
 require "putter/print_strategy"
 require "putter/proxy_method_data"
 require "putter/version"
+require "putter/watcher_data"
 
 require "putter/follower"
 require "putter/watcher"

data/putter.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "putter"
   spec.version       = Putter::VERSION
   spec.authors       = ["John DeWyze"]
-  spec.email         = ["john.dewyze@gmail.com"]
+  spec.email         = ["putter@dewyze.io"]
 
   spec.description   = "Putter provides a variety of methods to easily use puts debugging. It can reveal what methods are called, the arguments that were passed in, and what the result of the method call."
   spec.summary       = "Putter makes puts debugging easy."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - John DeWyze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -84,7 +84,7 @@ description: Putter provides a variety of methods to easily use puts debugging.
   can reveal what methods are called, the arguments that were passed in, and what
   the result of the method call.
 email:
-- john.dewyze@gmail.com
+- putter@dewyze.io
 executables:
 - console
 - setup
@@ -116,6 +116,7 @@ files:
 - lib/putter/proxy_method_data.rb
 - lib/putter/version.rb
 - lib/putter/watcher.rb
+- lib/putter/watcher_data.rb
 - putter.gemspec
 homepage: https://github.com/dewyze/putter
 licenses: