/.bundle/

/.yardoc

/Gemfile.lock

/_yardoc/

/coverage/

/doc/

/pkg/

/spec/reports/

/tmp/

--format documentation

sudo: false

language: ruby

rvm:

- 2.1

- 2.2

- 2.3

- 2.4.0

before_install: gem install bundler -v 1.14.6

source 'https://rubygems.org'

Classes inheriting from Module.

Cats and dogs sleeping together.

Yet this gem monkey patches nothing.

100% clean.

0% obtrusive.

100% tested.

50% Ruby 2.0+ compatible.

100% Ruby 2.1+ compatible.

10g Monosodium glutamate.

NOTE: The manner this is made to work for class methods is totally different than the way this is made to work for instance methods.

NOTE: The instance method logging works on Ruby 2.0+

NOTE: The class method logging works on Ruby 2.1+

Add this line to your application's Gemfile:

gem 'debug_logging'

And then execute:

$ bundle

Or install it yourself as:

$ gem install debug_logging

Crack open the specs for usage examples.

It just works. ;)

Configuration can go anywhere you want.

Recommend creating `config/initializers/debug_logging.rb` with:

DebugLogging.logger = Logger.new(STDOUT) # you probably want to override to be the Rails.logger

DebugLogging.log_level = :debug # at what level do the messages created by this gem sent at?

DebugLogging.last_hash_to_s_proc = nil # e.g. ->(hash) { "#{hash.keys}" }

DebugLogging.last_hash_max_length = 1_000

DebugLogging.args_max_length = 1_000

DebugLogging.instance_benchmarks = false

DebugLogging.class_benchmarks = false

DebugLogging.add_invocation_id = true # invocation id allows you to identify a method call uniquely in a log

DebugLogging.ellipsis = " ✂️ …".freeze

class Car

# For instance methods:

# Option 1: specify the exact method(s) to add logging to

include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])

extend DebugLogging::ClassLogger

logged def self.make; new; end

def self.design(*args); new; end

def self.safety(*args); new; end

logged :design, :safety

def drive(speed); speed; end

def stop; 0; end

# For instance methods:

# Option 2: add logging to all instance methods defined above (but *not* defined below)

include DebugLogging::InstanceLogger.new(i_methods: self.instance_methods(false))

def will_not_be_logged; false; end

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

require "bundler/gem_tasks"

require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task :default => :spec

require "bundler/setup"

require "debug_logging"

require "irb"

set -euo pipefail

IFS=$'\n\t'

set -vx

bundle install

lib = File.expand_path('../lib', __FILE__)

$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

require 'debug_logging/version'

Gem::Specification.new do |spec|

spec.name = "debug_logging"

spec.version = DebugLogging::VERSION

spec.authors = ["Peter Boling"]

spec.email = ["[email protected]"]

spec.summary = %q{Drop-in debug logging useful when a call stack gets unruly}

spec.description = %q{Automatically log Class.method(arguments) as they are called at runtime!}

spec.homepage = "TODO: Put your gem's website or public repo URL here."

# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

# to allow pushing to a single host or delete this section to allow pushing to any host.

if spec.respond_to?(:metadata)

spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"

else

raise "RubyGems 2.0 or newer is required to protect against " \

"public gem pushes."

end

spec.files = `git ls-files -z`.split("\x0").reject do |f|

f.match(%r{^(test|spec|features)/})

end

spec.bindir = "exe"

spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

spec.require_paths = ["lib"]

spec.add_development_dependency "rspec-pending_for"

spec.add_development_dependency "bundler", "~> 1.14"

spec.add_development_dependency "rake", "~> 10.0"

spec.add_development_dependency "rspec", "~> 3.0"

require "logger"

require "debug_logging/version"

require "debug_logging/argument_printer"

require "debug_logging/instance_logger_modulizer"

require "debug_logging/instance_logger"

require "debug_logging/class_logger"

module DebugLogging

def self.config_reset

@@logger = nil

@@log_level = :debug

@@last_hash_to_s_proc = nil

@@last_hash_max_length = 1_000

@@args_max_length = 1_000

@@instance_benchmarks = false

@@class_benchmarks = false

@@add_invocation_id = true

@@ellipsis = " ✂️ …".freeze

end

def self.logger

@@logger ||= Logger.new(STDOUT)

end

def self.logger=(logger)

@@logger = logger

end

def self.log_level

@@log_level || :debug

end

def self.log_level=(log_level)

@@log_level = log_level

end

def self.last_hash_to_s_proc

@@last_hash_to_s_proc

end

def self.last_hash_to_s_proc=(last_hash_to_s_proc)

@@last_hash_to_s_proc = last_hash_to_s_proc

end

def self.last_hash_max_length

@@last_hash_max_length || 1_000

end

def self.last_hash_max_length=(last_hash_max_length)

@@last_hash_max_length = last_hash_max_length

end

def self.args_max_length

@@args_max_length || 1_000

end

def self.args_max_length=(args_max_length)

@@args_max_length = args_max_length

end

def self.instance_benchmarks

@@instance_benchmarks

end

def self.instance_benchmarks=(instance_benchmarks)

require "benchmark" if instance_benchmarks

@@instance_benchmarks = instance_benchmarks

end

def self.class_benchmarks

@@class_benchmarks

end

def self.class_benchmarks=(class_benchmarks)

require "benchmark" if class_benchmarks

@@class_benchmarks = class_benchmarks

end

def self.add_invocation_id

@@add_invocation_id

end

def self.add_invocation_id=(add_invocation_id)

@@add_invocation_id = add_invocation_id

end

def self.ellipsis

@@ellipsis

end

def self.ellipsis=(ellipsis)

@@ellipsis = ellipsis

end

def self.log(message)

logger.send(log_level, message)

end

config_reset # setup defaults