Putter

gem "putter"

class MyObject
  def hello(arg, punc)
    "Hello #{arg.to_s}#{punc}"
  end
end

module Service
  def self.do_stuff(obj)
    obj.hello(:world, "!")
  end
end

object = Putter.follow(MyObject.new)
Service.do_stuff(object)

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. This will override
  # any settings in the configuration denylist
)

class MyObject
  def self.hello_class(arg, punc)
    "The class says hello #{arg.to_s}#{punc}"
  end

  def hello_instance(arg, punc)
    "An instance says hello #{arg.to_s}#{punc}"
  end
end

Putter.watch(MyObject)
MyObject.hello_class("world", "!")
my_obj = MyObject.new
my_obj.hello_instance("world", "!")

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. This will override
  # any settings in the configuration denylist
)

Putter.configure do |config|
  # "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
  # 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_allowlist" 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_allowlist = [:to_s]

  # "methods_denylist" takes an array of methods and will never proxy. If this is combined
  # with the `methods_allowlist` then it will raise a `MethodConflictError`.

  # Defaults to []
  config.methods_denylist = [: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