kenny 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39b86e8b4853fcce4fcb7d38127b6f59321c5b17
-  data.tar.gz: c75ef30aede10e34de737316384e5d5b4badc120
+  metadata.gz: 2740dfe3834c07d205a400e43ed53ffaa70b3eb6
+  data.tar.gz: cae861c957fb393d01fd56fa408d34f4d82ff725
 SHA512:
-  metadata.gz: ba32367e5f63c0f2577cb0895ac85d8a5dc97bfc99669bc7bcb08eca0082c6bda5a383784cd2d131a3ead4c66803a6281eb08fd54cf3c327d15f4802ab8e6126
-  data.tar.gz: c66a0f075bb3369eef09529e632b71ea6d3f56b076f05e3c8286358662bcbff9b23cbde9233511a5d655e77f2e427df82a9b24e1dc84d2944442ad1f6a3a0154
+  metadata.gz: 180faaefd1c6d219bf0dd5e854dd8b2a9870103d746b83c1ecc622570777bb78762026290cf145d5837b76fdb92013122c177cdbaab1498ddbf373b93cc308e5
+  data.tar.gz: 588c0abb9b75569892e9d51dcb1691725780e6d72d7e3efb931a7a50cb9d612719bbf2441fd36c4e427cb80b7a71ae1e2c2f2e8b5fef3ad1a24bbbc649a8d7ae

data/Rakefile

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

data/lib/kenny/formatters/log_stash_formatter.rb

@@ -4,8 +4,8 @@ require 'active_support'
 
 module Kenny
   module Formatters
+    # Formats messages as LogStash::Event
     class LogStashFormatter < ::Logger::Formatter
-
       include ActiveSupport::TaggedLogging::Formatter
 
       def call(severity, time, progname, msg)
@@ -16,7 +16,7 @@ module Kenny
 
         tags = current_tags
 
-        if tags.size > 0
+        if tags.any?
           msg['type'] ||= tags.first
           msg['tags'] = tags
         end

data/lib/kenny/log_subscriber.rb

@@ -1,9 +1,9 @@
-## 
-# This class is meant to be inherited by anonymous classes, 
+##
+# This class is meant to be inherited by anonymous classes,
 # created through Kenny.define_log_subscriber_class.
 #
-# By inserting this class into the inheritance tree, 
-# we can verify in test-environment whether the LogSubscribers 
+# By inserting this class into the inheritance tree,
+# we can verify in test-environment whether the LogSubscribers
 # we created are indeed attached to the instrumentations we specified.
 module Kenny
   class LogSubscriber < ActiveSupport::LogSubscriber

data/lib/kenny/railtie.rb

@@ -5,6 +5,7 @@ require 'active_record/log_subscriber'
 require 'action_mailer/log_subscriber'
 
 module Kenny
+  # Tie to Rails application to access Rails.application.config
   class Railtie < Rails::Railtie
     config.kenny = Kenny.configs
 

data/lib/kenny/unsubscriber.rb

@@ -1,24 +1,26 @@
 ##
-# Module to unsubscribe all Rails default LogSubscribers from their events.
 module Kenny
+  # Module to unsubscribe all Rails default LogSubscribers from their events.
   module Unsubscriber
     DEFAULT_RAILS_LOG_SUBSCRIBER_CLASSES = [
-      ActionView::LogSubscriber, 
-      ActionController::LogSubscriber, 
-      ActiveRecord::LogSubscriber, 
+      ActionView::LogSubscriber,
+      ActionController::LogSubscriber,
+      ActiveRecord::LogSubscriber,
       ActionMailer::LogSubscriber
-    ]
+    ].freeze
 
     ##
     # By default, a Rails app instantiates the LogSubscribers listed above and
     # are actively listening to instrumentations listed in:
     # http://edgeguides.rubyonrails.org/active_support_instrumentation.html
-    # 
+    #
     # Unsubscribing is not recommended, unless you want to modify the output
     # to your standard rails logs (development|test|staging|production).log
-    # 
+    #
     # It would be safer to write your chosen instrumentation data to a separate file,
-    # setup by the [:logger] configuration (see Readme). In that case, the [:unsubscribe_rails_defaults]
+    # setup by the [:logger] configuration (see Readme).
+
+    # In that case, the [:unsubscribe_rails_defaults]
     # field in Kenny's config won't need to be set.
     def self.unsubscribe_from_rails_defaults
       default_rails_log_subscribers.each do |subscriber|
@@ -36,7 +38,9 @@ module Kenny
     private_class_method :default_rails_log_subscribers
 
     def self.listeners_for(event, subscriber_namespace)
-      ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{subscriber_namespace}")
+      ActiveSupport::Notifications.notifier.listeners_for(
+        "#{event}.#{subscriber_namespace}"
+      )
     end
     private_class_method :listeners_for
 

data/lib/kenny.rb

@@ -1,11 +1,10 @@
 ##
+
 # Kenny module does three things:
 # - Holds reference to the Rails application (set through Railtie)
 # - Unsubscribe all Rails' LogSubscribers from the default instrumentation channels
 # - Create LogSubscriber-classes which will be attached to the user-specified instrumentations
-
 module Kenny
-
   def self.configs
     Struct.new(
       :unsubscribe_rails_defaults,
@@ -15,19 +14,19 @@ module Kenny
   end
 
   def self.application=(app)
-    @@application = app
+    @application = app
   end
 
   def self.application
-    @@application
+    @application
   end
 
   ##
   # Define LogSubscriber-classes and Attach to user-specified instrumentations
   # if the configurations have been set.
   def self.attach_to_instrumentations
-    if @@application.config.kenny[:instrumentations]
-      @@application.config.kenny[:instrumentations].each do |instr_config|
+    if @application.config.kenny[:instrumentations]
+      @application.config.kenny[:instrumentations].each do |instr_config|
         define_log_subscriber_class(instr_config)
       end
     end
@@ -38,17 +37,17 @@ module Kenny
   # by delegating to Kenny::Unsubscriber.
   # See http://edgeguides.rubyonrails.org/active_support_instrumentation.html
   def self.unsubscribe_from_rails_defaults
-    if @@application.config.kenny[:unsubscribe_rails_defaults]
+    if @application.config.kenny[:unsubscribe_rails_defaults]
       Kenny::Unsubscriber.unsubscribe_from_rails_defaults
     end
   end
 
   ##
-  # Suppress Rails::Rack::Logger's output à la
+  # Suppress Rails::Rack::Logger's output like:
   #   Started GET "/my_path" for 10.0.2.2 at 2016-07-12 10:06:48 +0000
   def self.suppress_rack_logger
-    if @@application.config.kenny[:suppress_rack_logger]
-      require "kenny/rails_ext/rack/logger"
+    if @application.config.kenny[:suppress_rack_logger]
+      require 'kenny/rails_ext/rack/logger'
     end
   end
 
@@ -60,25 +59,23 @@ module Kenny
   # instrumentations-configs provided by the user.
   def self.define_log_subscriber_class(instr_config)
     klass = Class.new(Kenny::LogSubscriber) do |k|
-      define_method( instr_config[:name].split(".")[0], instr_config[:block] )
+      define_method(instr_config[:name].split('.')[0], instr_config[:block])
 
       if instr_config[:logger]
         # Following assignment needed as we don't want to have
         # the lambda being re-evaluated and possibly return
         # a new logger instance everytime the .logger method is invoked.
         defined_logger = instr_config[:logger]
-        define_method(:logger, lambda{defined_logger})
+        define_method(:logger, lambda { defined_logger })
       end
-
     end
-    klass.attach_to instr_config[:name].split(".")[1].to_sym
+    klass.attach_to instr_config[:name].split('.')[1].to_sym
   end
   private_class_method :define_log_subscriber_class
-
 end
 
-require "kenny/railtie"
+require 'kenny/railtie'
 
-require "kenny/formatters/log_stash_formatter"
-require "kenny/unsubscriber"
-require "kenny/log_subscriber"
+require 'kenny/formatters/log_stash_formatter'
+require 'kenny/unsubscriber'
+require 'kenny/log_subscriber'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kenny
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- Mathias Rüdiger, Alex Fong
+- Mathias Rüdiger
+- Alex Fong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,66 +67,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -144,40 +141,35 @@ dependencies:
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: logstash-event
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.02
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.02
-description: Kenny acts as a one-stop destination for defining which Rails instrumentations
-  you want to monitor and what to do when they occur.
+description: One-stop destination for defining you actionswhen specific Rails instrumentations
+  occur
 email:
-- mathias.ruediger@fromatob.com, alex.fong@fromatob.com
+- mathias.ruediger@fromatob.com
+- alex.fong@fromatob.com
 executables: []
 extensions: []
 extra_rdoc_files: []