activesupport-operation_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c293665f8c0a6fed23c6464851489ad4fce3b0d
+  data.tar.gz: be66a0e2e7adb67aab8f5b2d7f2fb3f96b1625fc
+SHA512:
+  metadata.gz: 02a4375c25a234b0651b2000dc57a9a142caacddacf006402a4af5723083a31069cba389f3cd77edc85bc19da6de84ff8f2cf6307263aaf65616b21764a9c115
+  data.tar.gz: 7d5be6981943762b1c7cd0f641cc3b6de940d7c36be7e54b5810838735577a35791379fb91605d8046ab415f1076d46a97aa33a0f8886594e754534ea563b131

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,29 @@
+# ActiveSupport::OperationLogger
+
+adds ActiveRecord-like logging to anything you want
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activesupport-operation_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activesupport-operation_logger
+
+## Usage
+
+```rb
+require 'active_support/operation_logger'
+
+ActiveSupport::OperationLogger.log_calls_on! MyKlass
+ActiveSupport::OperationLogger.log_calls_on! Redis::Client, event_namespace: 'redis', only: :call
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/active_support-operation_logger.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_support/operation_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activesupport-operation_logger"
+  spec.version       = ActiveSupport::OperationLogger::VERSION
+  spec.authors       = ["Josh Bodah"]
+  spec.email         = ["jb3689@yahoo.com"]
+
+  spec.summary       = %q{adds ActiveRecord-like logging to anything you want}
+  spec.homepage      = "https://github.com/jbodah/active_support-operation_logger"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_support/operation_logger"
+
+# 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

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/lib/active_support/operation_logger.rb

@@ -0,0 +1,88 @@
+require "active_support/operation_logger/version"
+require "active_support/notifications"
+require "active_support/log_subscriber"
+
+module ActiveSupport
+  module OperationLogger
+    # Provides methods that should probably be part of Ruby's stdlib
+    module MethodHelper
+      def self.public_owned_instance_methods(klass)
+        klass.public_instance_methods.select do |m|
+          klass.instance_method(m).owner == klass
+        end
+      end
+    end
+
+    # A generic factory responsible for creating modules that can be used to
+    # decorate classes with ActiveSupport::Notifications
+    module EventInstrumenterFactory
+      # @param [Class] klass
+      # @param [Array<Symbol>] methods
+      # @param [Symbol] event_namespace
+      # @return [Module] a module for prepending
+      def self.instrumenter_for(klass, methods, event_namespace)
+        Module.new do
+          methods.each do |m|
+            define_method m do |*args, &block|
+              command_str = if args.size == 1 && args.first.is_a?(Array)
+                              args.first.map(&:inspect).join(', ')
+                            else
+                              args.map(&:inspect).join(' ')
+                            end
+              ActiveSupport::Notifications.instrument("call.#{event_namespace}",
+                                                      name: "#{event_namespace.to_s.classify} #{m}",
+                                                      command: command_str) do
+                super *args, &block
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # A generic factory responsible for creating classes that can be used to
+    # create LogSubscribers that integrate with ActiveSupport::Notifications
+    # and mirror the functionality of ActiveRecord::LogSubscriber
+    module EventSubscriberFactory
+      def self.subscriber_for(klass)
+        Class.new(ActiveSupport::LogSubscriber) do
+          def initialize
+            super
+            @odd = false
+          end
+
+          def odd?
+            @odd = !@odd
+          end
+
+          def call(event)
+            name = "#{event.payload[:name]} (#{event.duration.round(1)}ms)"
+            command = event.payload[:command]
+            if odd?
+              name = color(name, ActiveSupport::LogSubscriber::CYAN, true)
+              command = color(command, nil, true)
+            else
+              name = color(name, ActiveSupport::LogSubscriber::MAGENTA, true)
+            end
+
+            debug "  #{name}  #{command}"
+          end
+        end
+      end
+    end
+
+    # Encapsulates the act of decorating classes with ActiveSupport::Notifications
+    # instrumenters and ActiveSupport::LogSubscribers
+    #
+    # TODO: @jbodah 2016-04-30: just use one shared event subscriber
+    def self.log_calls_on!(klass, only: nil, event_namespace: nil)
+      methods = only || MethodHelper.public_owned_instance_methods(klass)
+      event_namespace ||= klass.name.demodulize.underscore
+      event_namespace = event_namespace.to_sym
+
+      klass.prepend EventInstrumenterFactory.instrumenter_for(klass, methods, event_namespace)
+
+      EventSubscriberFactory.subscriber_for(klass).attach_to(event_namespace)
+    end
+  end
+end

data/lib/active_support/operation_logger/version.rb

@@ -0,0 +1,5 @@
+module ActiveSupport
+  module OperationLogger
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: activesupport-operation_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Bodah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- jb3689@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- active_support-operation_logger.gemspec
+- bin/console
+- bin/setup
+- lib/active_support/operation_logger.rb
+- lib/active_support/operation_logger/version.rb
+homepage: https://github.com/jbodah/active_support-operation_logger
+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.4.8
+signing_key: 
+specification_version: 4
+summary: adds ActiveRecord-like logging to anything you want
+test_files: []