putter 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84737d110515d47bead7d513f58611599f6ea37a
-  data.tar.gz: 0740d21168f4e1560157fd2a865f3265bf855f97
+  metadata.gz: 5a525258dc08f4793f38bc5d023fc01efda81ba8
+  data.tar.gz: 61e872b2ec792cb1557608f3f329b92123b8fe03
 SHA512:
-  metadata.gz: 6875c627134ded119be4a6204916834d8f4224596fc272f4ae6332e25879436dfb222a33b6bda9a5f6e8448c8d78edb589f6c3c30639261053e61e32c07fc3bc
-  data.tar.gz: 54e9745f1e120e9185b1d80bc9655923e919b4614c393d4a18d6c389b161cdb84cc9fbe4057f13d4b3c7095f19d31046c89ca1c917f1ce753dc11618890eaaaf
+  metadata.gz: 04d82a6530661ed0cbada01906a726195e6e910941b8ae2770c1eb019069f4c1ddb4faa0d80d29052e5db1776fa95720ccb69898e2c8fcc4dd989824d3d7b1ac
+  data.tar.gz: 56152fdd9dd89ae120d75c74d7ceea04e6aef5cbbd46a5b149c85a858bd8e09be0a7d0f566c656c3fcaa3908c5429db9f95ba3577ee4de645d3a92c22f1513b5

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+### 0.2.0 - 2016-06-04
+- Convert print strategies to a single print strategy for both methods calls and results and adjust configuration accordingly.
+
+### 0.1.1 - 2016-05-29
+- Fix print strategy to put new line before debugging statements to not have a break between method calls and results.
+
+### 0.1.0 - 2016-05-29
+- Initial commit, see README.

data/CODE_OF_CONDUCT.md

@@ -35,7 +35,7 @@ This code of conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at john.dewyze@gmail.com. All
+reported by contacting a project maintainer at putter@dewyze.io. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. Maintainers are
 obligated to maintain confidentiality with regard to the reporter of an
@@ -46,4 +46,4 @@ version 1.3.0, available at
 [http://contributor-covenant.org/version/1/3/0/][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -48,11 +48,7 @@ Service.do_stuff(object)
 Will output:
 
 ```bash
-Putter Debugging:  Object instance
------------------
-          Method:  :value
-            Args:  [:world, "!"]
-          Result:  "Hello world!"
+Putter Debugging: Object instance -- Method: :value, Args: [:world, "!"], Result: "Hello world!"
 ```
 
 #### `Putter.follow` Options
@@ -60,8 +56,8 @@ Putter Debugging:  Object instance
 ```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",  # 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
 )
 ```
 
@@ -71,17 +67,23 @@ Putter currently has 3 configuration options:
 
 ```ruby
 Putter.configure do |config|
-  # 'method_strategy' takes a block that receives three arguments with the label, method, and args array, respectively. This block will be used after each method is called, "puts" statements can be used, or any other method callbacks that are helpful.
-  # Defaults to Putter::PrintStrategy::MethodStrategy
-  config.method_strategy = Proc.new {|label, method, args| puts "Label: #{label}, Method: #{method}, Args: #{args}" }
+  # 'method_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.
+  # Defaults to Putter::PrintStrategy::Default
+  config.print_strategy = Proc.new do |label, method, args, result|
+    puts "Label: #{label}, Method: #{method}, Args: #{args}, Result: #{result}"
+  end
 
-  # 'result_strategy' takes a block that receives a single argument outputs the results of the method call
-  # Defaults to Putter::PrintStrategy::ResultStrategy
-  config.result_strategy = Proc.new {|result| puts "The result was #{result}" }
+  # 'ignore_methods_from' takes an array of class names and will ignore both class and instance methods
+  # from those classes when adding methods to the proxy and adding debug output
+  # Defaults to [Object]
+  config.ignore_methods_from = [Object, ActiveRecord::Base]
 
-  # 'print_results' determines whether or not to print the results block at all.
-  # Defaults to true.
-  config.print_results = false
+  # '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'
+  config.methods_whitelist = [:to_s]
 end
 ```
 
@@ -90,13 +92,11 @@ 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
-- Errors for when attempting to follow a `BasicObject`
-- Protected methods (so things like `inspect` don't cause stack level too deep errors
 - Checking Rails.env to double check that putter is not called in production
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/putter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dewyze/putter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/putter/configuration.rb

@@ -1,11 +1,30 @@
 module Putter
   class Configuration
-    attr_accessor :method_strategy, :print_results, :result_strategy
+    attr_accessor :print_strategy
+    attr_writer :ignore_methods_from, :methods_whitelist
 
     def initialize
-      @method_strategy = PrintStrategy::MethodStrategy
-      @result_strategy = PrintStrategy::ResultStrategy
-      @print_results = true
+      @ignore_methods_from = [Object]
+      @print_strategy = PrintStrategy::Default
+      @methods_whitelist = []
+    end
+
+    def ignore_methods_from
+      _convert_to_array(@ignore_methods_from)
+    end
+
+    def methods_whitelist
+      _convert_to_array(@methods_whitelist)
+    end
+
+    def _convert_to_array(val)
+      if val.nil?
+        []
+      elsif !val.is_a?(Array)
+        [val]
+      else
+        val
+      end
     end
   end
 end

data/lib/putter/errors.rb

@@ -0,0 +1,7 @@
+module Errors
+  class BasicObjectError < StandardError
+    def initialize(msg="Cannot follow instances of BasicObject")
+      super
+    end
+  end
+end

data/lib/putter/follower.rb

@@ -5,7 +5,11 @@ module Putter
     def initialize(obj, options={})
       @object = obj
       @proxy = MethodProxy.new
-      @object.singleton_class.send(:prepend, proxy)
+      begin
+        @object.singleton_class.send(:prepend, proxy)
+      rescue ::NoMethodError
+        ::Kernel.raise ::Putter::BasicObjectError
+      end
       _set_options(options)
     end
 
@@ -22,19 +26,33 @@ module Putter
     end
 
     def add_method(method)
-      @proxy.instance_exec(@label, _print_results?) do |label, print_results|
+      @proxy.instance_exec(@label) do |label, print_results|
         define_method(method) do |*proxy_args, &blk|
-          ::Putter.configuration.method_strategy.call label, method, proxy_args
+          args_string = proxy_args.to_s
           result = super *proxy_args, &blk
-          ::Putter.configuration.result_strategy.call result if print_results
+          ::Putter.configuration.print_strategy.call label, method, args_string, result
           result
         end
       end
     end
 
     def _add_method?(method)
-      return (@proxy_all_methods || proxied_methods.include?(method.to_s)) &&
-              !@proxy.instance_methods.include?(method)
+      return true if _is_whitelisted_method?(method)
+      return false if _is_ignored_method?(method)
+      return false if @proxy.instance_methods.include?(method)
+      return @proxy_all_methods || proxied_methods.include?(method.to_s)
+    end
+
+    def _is_ignored_method?(method)
+      ::Putter.configuration.ignore_methods_from.each do |klass|
+        return true if klass.methods.include?(method.to_sym)
+        return true if klass.instance_methods.include?(method.to_sym)
+      end
+      return false
+    end
+
+    def _is_whitelisted_method?(method)
+      ::Putter.configuration.methods_whitelist.map(&:to_sym).include?(method.to_sym)
     end
 
     def _set_label(label)
@@ -47,10 +65,6 @@ module Putter
       end
     end
 
-    def _print_results?
-      ::Putter.configuration.print_results
-    end
-
     def _set_methods(methods)
       if methods.nil?
         @proxy_all_methods = true

data/lib/putter/print_strategy.rb

@@ -2,16 +2,10 @@ require "colorize"
 
 module Putter
   module PrintStrategy
-    MethodStrategy = Proc.new do |label, method, args|
-      puts
-      puts "\tPutter Debugging:  ".colorize(:cyan) + "#{label}".colorize(:green)
-      puts "\t-----------------".colorize(:cyan)
-      puts "\t\t  Method:  ".colorize(:cyan) + ":#{method}".colorize(:green)
-      puts "\t\t    Args:  ".colorize(:cyan) + "#{args}".colorize(:green)
-    end
-
-    ResultStrategy = Proc.new do |result|
-      puts "\t\t  Result:  ".colorize(:cyan) + "#{result}".colorize(:green)
+    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
     end
   end
 end

data/lib/putter/version.rb

@@ -1,3 +1,3 @@
 module Putter
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/putter.rb

@@ -1,10 +1,13 @@
 require "putter/configuration"
+require "putter/errors"
 require "putter/follower"
 require "putter/method_proxy"
 require "putter/print_strategy"
 require "putter/version"
 
 module Putter
+  include Errors
+
   class << self
     attr_writer :configuration
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - John DeWyze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-29 00:00:00.000000000 Z
+date: 2016-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -96,6 +96,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -106,6 +107,7 @@ files:
 - bin/setup
 - lib/putter.rb
 - lib/putter/configuration.rb
+- lib/putter/errors.rb
 - lib/putter/follower.rb
 - lib/putter/method_proxy.rb
 - lib/putter/print_strategy.rb