putter 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 16b81ce160fb22785ce8b1bdce7822783ba85eec
-  data.tar.gz: 7bc3095434de6035e590c28a37c8d435216a5e20
+SHA256:
+  metadata.gz: 829259ba903f7d2efbec2e69c5607b4bdf7e1207d5fefa2796f405ad37eb5933
+  data.tar.gz: f95568eebb49981fe31cdddd0c1ed62146fd4b2d09f22758562cde42673bcb02
 SHA512:
-  metadata.gz: 8334e5bea55fae12d4e65fd35d1077069c32895f71fe26c06673b9f006a36e6693de536753d0b13f8158e89a5a4a76d3ec8c486d055389b29ac5c778fb5b373c
-  data.tar.gz: 30885b70b4ae1d78a1b74a2eaae951c91175e1879abd95e4721ed2c5dffdecc51c83f7b187108c2273ed538ea18f9a2abd728593e6e2f21bbccaa1630d4f184a
+  metadata.gz: fd0dac73234966583f916c2f14da72992311ecbc17087294d857c4da8a6744e539bdff089c3097d4b0696b886141b94903c0f55161a52be591c426bb45eb5dbb
+  data.tar.gz: fbc1a92021e8efac8dac381d4c850b29fcf523cc71a5f2ac82e88f278cd523d19c484ae68f962a1e21420d6bf8e9ec1a8e88c604444096844e414ed7d56bf9e1

data/.gitignore

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

data/.ruby-version

@@ -1 +1 @@
-2.1.8
+2.7.1

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
-### 0.4.0 - 2016-08-16
+### 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
+- Do not re-define a method if it is whitelisted
+- Code cleanup and README updates
+
+### 0.4.0 - 2016-08-18
 - Add methods option to `Putter.watch`
 - Refactor watch method to use registry
 - Refactor method creation specs

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.
@@ -9,7 +13,7 @@ Putter is a tool for more easily implementing puts debugging. Instead of litteri
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'putter'
+gem "putter"
 ```
 
 And then execute:
@@ -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
 )
 ```
 
@@ -112,32 +121,42 @@ Putter currently has 3 configuration options:
 
 ```ruby
 Putter.configure do |config|
-  # 'print_strategy' takes a block that receives a data object with the label, line,
+  # "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 |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
+  # "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]
+
+  # 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
+  # "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'
+  # in when running "Putter.follow" or "Putter.watch"
+
+  # Defaults to []
   config.methods_whitelist = [:to_s]
-end
-```
 
-## Planned Features
-Feel free to open a PR to implement any of these if they are not yet added:
+  # "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"`
 
-- Active Record specific printing
-- Checking Rails.env to double check that putter is not called in production
+  # Defaults to false
+  config.allow_production = false
+end
+```
 
 ## Contributing
 

data/lib/putter.rb

@@ -1,5 +1,6 @@
 require "putter/configuration"
 require "putter/errors"
+require "putter/follower_data"
 require "putter/instance_follower"
 require "putter/method_creator"
 require "putter/method_proxy"
@@ -16,25 +17,37 @@ module Putter
 
   class << self
     attr_writer :configuration
-  end
-
-  def self.follow(obj, options={})
-    Putter::Follower.new(obj, options)
-  end
-
-  def self.watch(obj, options={})
-    Putter::Watcher.watch(obj, options)
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield configuration
-  end
 
-  def self.reset_configuration
-    @configuration = Configuration.new
+    def follow(obj, options={})
+      with_production_check do
+        Putter::Follower.new(obj, options)
+      end
+    end
+
+    def watch(obj, options={})
+      with_production_check do
+        Putter::Watcher.watch(obj, options)
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset_configuration
+      @configuration = Configuration.new
+    end
+
+    def with_production_check
+      if !configuration.allow_production && defined?(Rails) && Rails.env == "production"
+        puts "Putter cannot be run in production unless the 'allow_production' option is configured to true".colorize(:red)
+      else
+        yield
+      end
+    end
   end
 end

data/lib/putter/configuration.rb

@@ -1,23 +1,36 @@
 module Putter
   class Configuration
-    attr_accessor :print_strategy
-    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]
+      @ignore_methods_from << ActiveRecord::Base if defined?(ActiveRecord::Base)
       @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

@@ -2,7 +2,7 @@ module Putter
   class Follower < BasicObject
     include MethodCreator
 
-    attr_reader :object, :proxied_methods, :proxy
+    attr_reader :object, :proxy
 
     def initialize(obj, options={})
       @object = obj
@@ -12,11 +12,11 @@ module Putter
       rescue ::NoMethodError
         ::Kernel.raise ::Putter::BasicObjectError
       end
-      _set_options(options)
+      @data = FollowerData.new(@object, @proxy, options)
     end
 
     def method_missing(method, *args, &blk)
-      if _add_method?(method)
+      if @data.add_method?(method)
         add_method(method)
       end
 
@@ -28,52 +28,9 @@ module Putter
     end
 
     def add_method(method)
-      data = ProxyMethodData.new({ label: @label, method: method})
+      proxy_method_data = ProxyMethodData.new(label: @data.label, method: method)
 
-      add_putter_instance_method_to_proxy(@proxy, data)
-    end
-
-    def _add_method?(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)
-      if !label.nil?
-        @label = label
-      elsif @object.class == ::Class
-        @label = @object.name
-      else
-        @label = @object.class.name + " instance"
-      end
-    end
-
-    def _set_methods(methods)
-      if methods.nil?
-        @proxy_all_methods = true
-      else
-        @proxied_methods = methods.map(&:to_s)
-        @proxy_all_methods = false
-      end
-    end
-
-    def _set_options(options)
-      _set_label(options[:label])
-      _set_methods(options[:methods])
+      add_putter_method_to_proxy(@proxy, proxy_method_data)
     end
   end
 end

data/lib/putter/follower_data.rb

@@ -0,0 +1,48 @@
+module Putter
+  class FollowerData
+    attr_accessor :label
+
+    def initialize(object, proxy, options)
+      @proxy = proxy
+      @proxied_methods = options[:methods] || []
+      set_label(options[:label], object)
+    end
+
+    def add_method?(method)
+      return false if @proxy.instance_methods.include?(method)
+      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
+
+    private
+
+    def set_label(label, object)
+      if !label.nil?
+        @label = label
+      elsif object.class == Class
+        @label = object.name
+      else
+        @label = object.class.name + " instance"
+      end
+    end
+
+    def is_whitelisted_method?(method)
+      ::Putter.configuration.methods_whitelist.map(&:to_sym).include?(method.to_sym)
+    end
+
+    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)
+      end
+      return false
+    end
+  end
+end

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.0"
+  VERSION = "0.6.0"
 end

data/lib/putter/watcher.rb

@@ -30,8 +30,8 @@ module Putter
       proxy = MethodProxy.new
 
       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)
+        data = ProxyMethodData.new(label: Putter::Watcher.label_for(klass), method: method)
+        add_putter_method_to_proxy(proxy, data)
       end
 
       proxy

data/lib/putter/watcher_data.rb

@@ -3,36 +3,38 @@ module Putter
     attr_accessor :label, :proxy_methods
 
     def initialize(options, klass)
-      _set_label(options[:label], klass)
-      _set_methods(options[:methods], klass)
+      @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 = label
+        label
       else
-        @label = klass.name
+        klass.name
       end
     end
 
-    def _set_methods(methods, klass)
+    def set_methods(methods, singleton_klass)
       if methods.nil?
-        @proxy_methods = _methods_to_proxy(klass.singleton_class)
+        methods_to_proxy(singleton_klass)
       elsif !methods.is_a?(Array)
-        @proxy_methods = [methods]
+        [methods]
       else
-        @proxy_methods = methods
+        methods
       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'
 
   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.0
+  version: 0.6.0
 platform: ruby
 authors:
 - John DeWyze
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-19 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
@@ -109,6 +108,7 @@ files:
 - lib/putter/configuration.rb
 - lib/putter/errors.rb
 - lib/putter/follower.rb
+- lib/putter/follower_data.rb
 - lib/putter/instance_follower.rb
 - lib/putter/method_creator.rb
 - lib/putter/method_proxy.rb
@@ -122,7 +122,7 @@ homepage: https://github.com/dewyze/putter
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -130,16 +130,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.7'
 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.1.2
+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.0)
-      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.12.4