putter 0.4.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 72890e1762d7aad4835c7be72838d2409ecfd101
-  data.tar.gz: 0e24d52624633980ca47e6f1a2830e037d016a99
+SHA256:
+  metadata.gz: 4bb34206f87355ec6413702f263574ba0ea9f45fbf01da9578af7c899d4bbe0d
+  data.tar.gz: 444c407875667ffcc61d8be7908faeb0e67cd2fc21c2b87e0db45171dc1ac0ad
 SHA512:
-  metadata.gz: a575a07d97f70930a795fdfea66d6c14d4ee27a41eee406206fdde067e71f847576e04065702f2ef4611cc6d52b019c4cf32fccaf2fe18628346895de8c44be0
-  data.tar.gz: bf1e697ce25b56fd736742b3a15303547249e355c804326a04951c3f36331505b066bbdda01a0097fd01ef248687a16a48ed73c24f272c9def9d2da78a57d865
+  metadata.gz: d928358ecf0442f8512988f46f7090e7faade53aea9e14c0419ebe2cf830a666d16bfb67a3ff5d789de9d83a7634464fe57a9134a7739c1451849b0fc257ca67
+  data.tar.gz: a2fb566c1bf2b1f99e8f8cb681a97f3968259e6e7e502341ba8dbd32b69ca127eaab24274e502d11e511da4c87270397bddc09cdc9b725c43386f99b8de284ba

data/.gitignore

@@ -7,3 +7,5 @@
 /spec/reports/
 /tmp/
 putter-*.gem
+Gemfile.lock
+vendor/

data/.ruby-version

@@ -1 +1 @@
-2.1.8
+3.0.2

data/CHANGELOG.md

@@ -1,4 +1,17 @@
 # CHANGELOG
+### 0.6.1 - 2021-08-02
+- Update required ruby version to at least 2.7
+-
+### 0.6.0 - 2021-08-02
+- Update required ruby version to 2.7
+
+### 0.5.1 - 2016-11-11
+- Add hotfix for putter running on a script in a local directory to print out the file information
+
+### 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/README.md

@@ -1,5 +1,9 @@
 # Putter
 
+### Still Maintained as of February 2020
+
+## Description
+
 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 or watcher and print out anytime a method is called on that object. This will follow the object throughout its path in the stack.
@@ -60,8 +64,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 +109,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 +125,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 +133,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,20 +1,12 @@
 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.line = caller.find {|call| call.match(data.stack_trace_ignore_regex)}
+          if data.line.include?(::Dir.pwd)
+            data.line = data.line.split(::Dir.pwd)[1]
+          end
           data.args = proxy_args.to_s
           data.result = super *proxy_args, &blk
           ::Putter.configuration.print_strategy.call data

data/lib/putter/print_strategy.rb

@@ -4,7 +4,13 @@ module Putter
   module PrintStrategy
     Default = Proc.new do |data|
       prefix = "\tPutter Debugging: #{data.label} ".colorize(:cyan)
-      line = !data.line.nil? ? ".#{data.line} " : " "
+      if data.line.nil?
+        line = " "
+      elsif data.line[0] != "/"
+        line = "./#{data.line} "
+      else
+        line = ".#{data.line} "
+      end
       suffix = "-- Method: :#{data.method}, Args: #{data.args}, Result: #{data.result}".colorize(:green)
       puts prefix + line + suffix
     end

data/lib/putter/version.rb

@@ -1,3 +1,3 @@
 module Putter
-  VERSION = "0.4.1"
+  VERSION = "0.6.1"
 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

data/putter.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/dewyze/putter"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "bin"
@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'colorize', '~> 0'
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "pry", "~> 0.10.3"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "pry", "~> 0.14.1"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putter
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.1
 platform: ruby
 authors:
 - John DeWyze
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +99,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -123,24 +122,23 @@ homepage: https://github.com/dewyze/putter
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Putter makes puts debugging easy.
 test_files: []

data/Gemfile.lock

@@ -1,45 +0,0 @@
-PATH
-  remote: .
-  specs:
-    putter (0.4.1)
-      colorize (~> 0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.1)
-    colorize (0.7.7)
-    diff-lcs (1.2.5)
-    method_source (0.8.2)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    slop (3.6.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.12)
-  pry (~> 0.10.3)
-  putter!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.13.5