putter 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72890e1762d7aad4835c7be72838d2409ecfd101
-  data.tar.gz: 0e24d52624633980ca47e6f1a2830e037d016a99
+  metadata.gz: 7e5d9857773568b7246fa5399bdbdfad54bfbd96
+  data.tar.gz: be5caaf99f8666322b70cde787ecffac3477cad6
 SHA512:
-  metadata.gz: a575a07d97f70930a795fdfea66d6c14d4ee27a41eee406206fdde067e71f847576e04065702f2ef4611cc6d52b019c4cf32fccaf2fe18628346895de8c44be0
-  data.tar.gz: bf1e697ce25b56fd736742b3a15303547249e355c804326a04951c3f36331505b066bbdda01a0097fd01ef248687a16a48ed73c24f272c9def9d2da78a57d865
+  metadata.gz: 8dd17629db6f833c3146b0ae63219fb5479b2025474fad5ee12218a21a019a6a762e7b878144dc9ddc1106feb8b461524291b3cca74301d46f93cd655d513dd2
+  data.tar.gz: d60e579a5c7ef5d5926afca2941937fd9eb3d2f15babe8e3ecdf399a1d342b74cd8e4eef7d8158ceb7a9678c6cf63f5aac5bef9523700b96d37f3a0bc4e77740

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 # CHANGELOG
+### 0.5.0 - 2016-11-10
+- Add methods blacklist to the configuration options
+- Ensures that local method options override anything in the blacklist
+
 ### 0.4.1 - 2016-10-16
 - By default, Putter will not run in production mode in Rails, this can be allow via configuration
 - By default, Putter will ignore methods from ActiveRecord::Base if it is present

data/Gemfile.lock

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

data/README.md

@@ -60,8 +60,11 @@ Putter Debugging: Object instance ./putter/README.md:57 -- Method: :hello, Args:
 ```ruby
 Putter.follow(
   object_to_follow,
-  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
+  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. This will override
+  # any settings in the configuration blacklist
 )
 ```
 
@@ -102,7 +105,9 @@ Putter Debugging: MyObject instance 1 ./putter/README.md:97 -- Method: :hello_in
 Putter.watch(
   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
+  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. This will override
+  # any settings in the configuration blacklist
 )
 ```
 
@@ -116,6 +121,7 @@ Putter.configure do |config|
   # 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 |data|
     puts "#{data.line} - Label: #{data.label}, Method: #{data.method}, Args: #{data.args}, Result: #{data.result}"
@@ -123,17 +129,26 @@ Putter.configure do |config|
 
   # "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] or [Object, ActiveRecord::Based] if defined
   config.ignore_methods_from = [Object, ActiveRecord::Base]
 
   # "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" or "Putter.watch"
+
   # Defaults to []
   config.methods_whitelist = [:to_s]
 
+  # "methods_blacklist" takes an array of methods and will never proxy. If this is combined
+  # with the `methods_whitelist` then it will raise a `MethodConflictError`.
+
+  # Defaults to []
+  config.methods_blacklist = [:to_s]
+
   # "allow_production" takes a boolean and determines whether or not Putter will run if
   # `Rails.env == "production"`
+
   # Defaults to false
   config.allow_production = false
 end

data/lib/putter/configuration.rb

@@ -1,7 +1,7 @@
 module Putter
   class Configuration
-    attr_accessor :print_strategy, :allow_production
-    attr_writer :ignore_methods_from, :methods_whitelist
+    attr_accessor :allow_production, :methods_whitelist, :methods_blacklist, :print_strategy
+    attr_writer :ignore_methods_from
 
     def initialize
       @ignore_methods_from = [Object]
@@ -9,17 +9,28 @@ module Putter
       @print_strategy = PrintStrategy::Default
       @allow_production = false
       @methods_whitelist = []
+      @methods_blacklist = []
     end
 
     def ignore_methods_from
-      _convert_to_array(@ignore_methods_from)
+      convert_to_array(@ignore_methods_from)
     end
 
-    def methods_whitelist
-      _convert_to_array(@methods_whitelist)
+    def methods_whitelist=(methods)
+      raise ::Putter::MethodConflictError unless (@methods_blacklist & methods).empty?
+
+      @methods_whitelist = methods
     end
 
-    def _convert_to_array(val)
+    def methods_blacklist=(methods)
+      raise ::Putter::MethodConflictError unless (@methods_whitelist & methods).empty?
+
+      @methods_blacklist = methods
+    end
+
+    private
+
+    def convert_to_array(val)
       if val.nil?
         []
       elsif !val.is_a?(Array)

data/lib/putter/errors.rb

@@ -4,4 +4,10 @@ module Errors
       super
     end
   end
+
+  class MethodConflictError < StandardError
+    def initialize(msg="Methods cannot be white and blacklisted")
+      super
+    end
+  end
 end

data/lib/putter/follower.rb

@@ -30,7 +30,7 @@ module Putter
     def add_method(method)
       proxy_method_data = ProxyMethodData.new(label: @data.label, method: method)
 
-      add_putter_instance_method_to_proxy(@proxy, proxy_method_data)
+      add_putter_method_to_proxy(@proxy, proxy_method_data)
     end
   end
 end

data/lib/putter/follower_data.rb

@@ -5,18 +5,21 @@ module Putter
     def initialize(object, proxy, options)
       @proxy = proxy
       @proxied_methods = options[:methods] || []
-      _set_label(options[:label], object)
+      set_label(options[:label], object)
     end
 
     def add_method?(method)
       return false if @proxy.instance_methods.include?(method)
-      return true if _is_whitelisted_method?(method)
-      return false if _is_ignored_method?(method)
-      return true if @proxied_methods.empty?
       return true if @proxied_methods.include?(method)
+      return true if is_whitelisted_method?(method)
+      return false if is_blacklisted_method?(method)
+      return false if is_ignored_method?(method)
+      return true if @proxied_methods.empty?
     end
 
-    def _set_label(label, object)
+    private
+
+    def set_label(label, object)
       if !label.nil?
         @label = label
       elsif object.class == Class
@@ -26,11 +29,15 @@ module Putter
       end
     end
 
-    def _is_whitelisted_method?(method)
+    def is_whitelisted_method?(method)
       ::Putter.configuration.methods_whitelist.map(&:to_sym).include?(method.to_sym)
     end
 
-    def _is_ignored_method?(method)
+    def is_blacklisted_method?(method)
+      ::Putter.configuration.methods_blacklist.map(&:to_sym).include?(method.to_sym)
+    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)

data/lib/putter/method_creator.rb

@@ -1,17 +1,7 @@
 module Putter
   module MethodCreator
-    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|
+    def add_putter_method_to_proxy(proxy, data)
+      proxy.send(:instance_exec, data) do |data|
         define_method(data.method) do |*proxy_args, &blk|
           line = caller.find {|call| call.match(data.stack_trace_ignore_regex)}
           data.line = line.split(::Dir.pwd)[1]

data/lib/putter/version.rb

@@ -1,3 +1,3 @@
 module Putter
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/putter/watcher.rb

@@ -31,7 +31,7 @@ module Putter
 
       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)
+        add_putter_method_to_proxy(proxy, data)
       end
 
       proxy

data/lib/putter/watcher_data.rb

@@ -3,11 +3,11 @@ module Putter
     attr_accessor :label, :proxy_methods
 
     def initialize(options, klass)
-      @label = _set_label(options[:label], klass)
-      @proxy_methods = _set_methods(options[:methods], klass.singleton_class)
+      @label = set_label(options[:label], klass)
+      @proxy_methods = set_methods(options[:methods], klass.singleton_class)
     end
 
-    def _set_label(label, klass)
+    def set_label(label, klass)
       if !label.nil? && label != ""
         label
       else
@@ -15,9 +15,9 @@ module Putter
       end
     end
 
-    def _set_methods(methods, singleton_klass)
+    def set_methods(methods, singleton_klass)
       if methods.nil?
-        _methods_to_proxy(singleton_klass)
+        methods_to_proxy(singleton_klass)
       elsif !methods.is_a?(Array)
         [methods]
       else
@@ -25,14 +25,16 @@ module Putter
       end
     end
 
-    def _methods_to_proxy(singleton_klass)
-      ignored_methods = []
+    def methods_to_proxy(singleton_klass)
+      ignored_methods = Putter.configuration.methods_blacklist.map(&:to_sym)
 
       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]
+      whitelist = Putter.configuration.methods_whitelist.map(&:to_sym) + [:new]
+
+      singleton_klass.instance_methods - ignored_methods + whitelist
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putter
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - John DeWyze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize