debug_logging 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2354763d5bcb6438947c4e268683c956477b812
+  data.tar.gz: 2c0c20aff357b165857f6c7794bb54e87e2b7ac3
+SHA512:
+  metadata.gz: b6312e56ce69f08fa23d1e57c24b7e10354e4f971304b6dbed74d3232cb2593d1ccff250f0e5eebc51e24edf80c60c646c8f636cdf135a7d8d1967289903334d
+  data.tar.gz: 987ea132ee891882e14a1bee41bbe47084700468767588e21eaa2a487098178613b36592d0f69e17c55fdfcad9bd1a175a0613bea9b5064bf028212fd53ab6a2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in debug_logging.gemspec
+gemspec

data/README.md

@@ -0,0 +1,96 @@
+# DebugLogging
+
+## Next Level Magic
+
+* 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+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'debug_logging'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install debug_logging
+
+## Usage
+
+Crack open the specs for usage examples.
+
+### Without Rails
+
+It just works. ;)
+Configuration can go anywhere you want.
+
+### With Rails
+
+Recommend creating `config/initializers/debug_logging.rb` with:
+```ruby
+# Showing the defaults
+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
+```
+
+```ruby
+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
+
+end
+```
+
+## Development
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pboling/debug_logging.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "debug_logging"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/debug_logging.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+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         = ["peter.boling@gmail.com"]
+
+  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      = "https://github.com/pboling/debug_logging"
+
+  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"
+end

data/lib/debug_logging/argument_printer.rb

@@ -0,0 +1,30 @@
+module DebugLogging
+  module ArgumentPrinter
+    def self.to_s(args)
+      length = 0
+      if DebugLogging.last_hash_to_s_proc && args[-1].is_a?(Hash)
+        if args.length > 1
+          add_args_ellipsis = false
+          add_last_hash_ellipsis = false
+          printed_args = args[0..(-2)].map {|x| x.inspect}.join(", ").tap {|x| add_args_ellipsis = x.length > DebugLogging.args_max_length}[0..(DebugLogging.args_max_length)]
+          printed_args << DebugLogging.ellipsis if add_args_ellipsis
+          printed_args << ", " << DebugLogging.last_hash_to_s_proc.call(args[-1]).tap {|x| add_last_hash_ellipsis = x.length > DebugLogging.last_hash_max_length}[0..(DebugLogging.last_hash_max_length)]
+          printed_args << DebugLogging.ellipsis if add_last_hash_ellipsis
+        else
+          printed_args = DebugLogging.last_hash_to_s_proc.call(args[0]).tap {|x| add_last_hash_ellipsis = x.length > DebugLogging.last_hash_max_length}[0..(DebugLogging.last_hash_max_length)]
+          printed_args << DebugLogging.ellipsis if add_last_hash_ellipsis
+        end
+      else
+        add_args_ellipsis = false
+        if args.length == 1 && args[0].is_a?(Hash)
+          # handle double splat
+          printed_args = ("**" << args.map {|x| x.inspect}.join(", ").tap {|x| add_args_ellipsis = x.length > DebugLogging.args_max_length})[0..(DebugLogging.args_max_length)]
+        else
+          printed_args = args.map {|x| x.inspect}.join(", ").tap {|x| add_args_ellipsis = x.length > DebugLogging.args_max_length}[0..(DebugLogging.args_max_length)]
+        end
+        printed_args << DebugLogging.ellipsis if add_args_ellipsis
+      end
+      "(#{printed_args})"
+    end
+  end
+end

data/lib/debug_logging/class_logger.rb

@@ -0,0 +1,26 @@
+module DebugLogging
+  module ClassLogger
+    def logged(*methods_to_log)
+      methods_to_log.each do |method_to_log|
+        # method name will always be a symbol
+        original_method = method(method_to_log)
+        (class << self; self; end).class_eval do
+          define_method(method_to_log) do |*args|
+            method_return_value = nil
+            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if DebugLogging.add_invocation_id && args
+            DebugLogging.log "#{self}.#{method_to_log}#{ArgumentPrinter.to_s(args)}#{invocation_id}"
+            if DebugLogging.class_benchmarks
+              elapsed = Benchmark.realtime do
+                method_return_value = original_method.call(*args)
+              end
+              DebugLogging.log "#{self}.#{method_to_log} completed in #{sprintf("%f", elapsed)}s#{invocation_id}"
+            else
+              method_return_value = original_method.call(*args)
+            end
+            method_return_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/debug_logging/instance_logger.rb

@@ -0,0 +1,13 @@
+module DebugLogging
+  class InstanceLogger < Module
+    def initialize(i_methods: nil)
+      @instance_methods_to_log = Array(i_methods) if i_methods
+    end
+    def included(base)
+      if @instance_methods_to_log
+        instance_method_logger = DebugLogging::InstanceLoggerModulizer.to_mod(@instance_methods_to_log)
+        base.send(:prepend, instance_method_logger)
+      end
+    end
+  end
+end

data/lib/debug_logging/instance_logger_modulizer.rb

@@ -0,0 +1,24 @@
+module DebugLogging
+  module InstanceLoggerModulizer
+    def self.to_mod(methods_to_log = [])
+      Module.new do
+        Array(methods_to_log).each do |method_to_log|
+          define_method(method_to_log.to_sym) do |*args, &block|
+            method_return_value = nil
+            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if DebugLogging.add_invocation_id && args
+            DebugLogging.log "#{self.class}##{method_to_log}#{DebugLogging::ArgumentPrinter.to_s(args)}#{invocation_id}"
+            if DebugLogging.instance_benchmarks
+              elapsed = Benchmark.realtime do
+                method_return_value = super(*args, &block)
+              end
+              DebugLogging.log "#{self.class}##{method_to_log} completed in #{sprintf("%f", elapsed)}s#{invocation_id}"
+            else
+              method_return_value = super(*args, &block)
+            end
+            method_return_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/debug_logging/version.rb

@@ -0,0 +1,3 @@
+module DebugLogging
+  VERSION = "0.1.0"
+end

data/lib/debug_logging.rb

@@ -0,0 +1,123 @@
+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"
+
+####################
+#                  #
+# Next Level Magic #
+# Classes inheriting from Module.
+# Cats and dogs sleeping together.
+#                  #
+####################
+#                  #
+# 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 manner works on Ruby 2.0+
+# NOTE: The class method manner works on Ruby 2.1+
+#                  #
+####################
+#                  #
+# USAGE (see specs)#
+#                  #
+#     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
+#
+#     end
+#                  #
+####################
+
+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
+end

data/lib/simple_debug_logging.rb

@@ -0,0 +1,54 @@
+# Simpler version of what the sibling DebugLogging library does.  Included as a bauble.
+#
+# Automatically log Class.method(arguments) as they are called at runtime!
+#
+# NOTE: For a more advanced version see the debug_logging gem
+# 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 manner of logging works on Ruby 2.0+
+# NOTE: The class method manner of logging works on Ruby 2.1+
+class SimpleDebugLogging < Module
+  def initialize(i_methods: nil)
+    @instance_methods_to_log = Array(i_methods) if i_methods
+  end
+  def included(base)
+    instance_method_logger = InstanceMethodLoggerModulizer.to_mod(@instance_methods_to_log)
+    base.send(:prepend, instance_method_logger)
+  end
+  module ClassMethodLogger
+    def logged(*methods_to_log)
+      methods_to_log.each do |method_to_log|
+        original_method = method(method_to_log)
+        (class << self; self; end).class_eval do
+          define_method(method_to_log.to_sym) do |*args|
+            method_return_value = nil
+            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if args
+            puts "#{self}.#{method_to_log}(#{args.map {|x| x.inspect}.join(", ")})#{invocation_id}"
+            elapsed = Benchmark.realtime do
+              method_return_value = original_method.call(*args)
+            end
+            puts "#{self}.#{method_to_log} ~#{args.hash}~ complete in #{elapsed}s#{invocation_id}"
+            method_return_value
+          end
+        end
+      end
+    end
+  end
+  module InstanceMethodLoggerModulizer
+    def self.to_mod(methods_to_log = [])
+      Module.new do
+        Array(methods_to_log).each do |method_to_log|
+          define_method(method_to_log.to_sym) do |*args, &block|
+            method_return_value = nil
+            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if args
+            puts "#{self.class}##{method_to_log}(#{args.map {|x| x.inspect}.join(", ")})#{invocation_id}"
+            elapsed = Benchmark.realtime do
+              method_return_value = super(*args, &block)
+            end
+            puts "#{self.class}##{method_to_log} ~#{args.hash}~ complete in #{elapsed}s#{invocation_id}"
+            method_return_value
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: debug_logging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Boling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-pending_for
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Automatically log Class.method(arguments) as they are called at runtime!
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- debug_logging.gemspec
+- lib/debug_logging.rb
+- lib/debug_logging/argument_printer.rb
+- lib/debug_logging/class_logger.rb
+- lib/debug_logging/instance_logger.rb
+- lib/debug_logging/instance_logger_modulizer.rb
+- lib/debug_logging/version.rb
+- lib/simple_debug_logging.rb
+homepage: https://github.com/pboling/debug_logging
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Drop-in debug logging useful when a call stack gets unruly
+test_files: []