lograge 0.3.0 → 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e83952d334c15f42c841f0ed45c8e1538e795ab
+  data.tar.gz: 581be0bc6a70dfa1abaad4bbefef0a80115f837c
+SHA512:
+  metadata.gz: f21494756b287b5d0c95594f9a285b70e2af281f9b25a19f4e2c90a4656058cadc869337f9671002af5403ffc2331b8a3e1230ba3363e0c7b861e7569f8fb30c
+  data.tar.gz: 09f4b1e38c61db6caff08c51019ffdb982f2b7ca536ea5be7edbbd9a113fb48ca3dbb041603737cedaf810cbcb85c48b9d9a166fd330de7ca0639523d53ccb3d

data/lib/lograge/formatters/cee.rb

@@ -6,4 +6,4 @@ module Lograge
       end
     end
   end
-end
+end

data/lib/lograge/formatters/graylog2.rb

@@ -3,17 +3,28 @@ module Lograge
     class Graylog2
       def call(data)
         # Cloning because we don't want to mess with the original when mutating keys.
-        my = data.clone
+        data_clone = data.clone
 
         base = {
-          :short_message => "[#{my[:status]}] #{my[:method]} #{my[:path]} (#{my[:controller]}##{my[:action]})"
+          short_message: short_message(data_clone)
         }
 
         # Add underscore to every key to follow GELF additional field syntax.
-        my.keys.each { |k| my["_#{k}".to_sym] = my[k]; my.delete(k) }
+        data_clone.keys.each do |key|
+          data_clone[underscore_prefix(key)] = data_clone[key]
+          data_clone.delete(key)
+        end
 
-        my.merge(base)
+        data_clone.merge(base)
+      end
+
+      def underscore_prefix(key)
+        "_#{key}".to_sym
+      end
+
+      def short_message(data)
+        "[#{data[:status]}] #{data[:method]} #{data[:path]} (#{data[:controller]}##{data[:action]})"
       end
     end
   end
-end
+end

data/lib/lograge/formatters/key_value.rb

@@ -1,35 +1,27 @@
 module Lograge
   module Formatters
     class KeyValue
-      LOGRAGE_FIELDS = [
-        :method, :path, :format, :controller, :action, :status, :error,
-        :duration, :view, :db, :location
-      ]
-
       def call(data)
         fields = fields_to_display(data)
 
-        event = fields.inject([]) do |message, key|
-          next message unless data.has_key?(key)
-
-          message << format(key, data[key])
-          message
-        end
-        event.join(" ")
+        event = fields.map { |key| format(key, data[key]) }
+        event.join(' ')
       end
 
       def fields_to_display(data)
-        LOGRAGE_FIELDS + (data.keys - LOGRAGE_FIELDS)
+        data.keys
       end
 
       def format(key, value)
-        # Exactly preserve the previous output
-        # Parsing this can be ambigious if the error messages contains
-        # a single quote
-        value = "'#{value}'" if key == :error
-
-        # Ensure that we always have exactly two decimals
-        value = "%.2f" % value if value.is_a? Float
+        if key == :error
+          # Exactly preserve the previous output
+          # Parsing this can be ambigious if the error messages contains
+          # a single quote
+          value = "'#{value}'"
+        else
+          # Ensure that we always have exactly two decimals
+          value = Kernel.format('%.2f', value) if value.is_a? Float
+        end
 
         "#{key}=#{value}"
       end

data/lib/lograge/formatters/l2met.rb

@@ -13,7 +13,7 @@ module Lograge
       end
 
       def format(key, value)
-        key = "measure#page.#{key}" if value.kind_of?(Float)
+        key = "measure#page.#{key}" if value.is_a?(Float)
 
         super(key, value)
       end
@@ -23,15 +23,13 @@ module Lograge
       end
 
       def modify_payload(data)
-        if data[:controller] && data[:action]
-          data[:source] = source_field(data)
-        end
+        data[:source] = source_field(data) if data[:controller] && data[:action]
 
         data
       end
 
       def source_field(data)
-        "#{data[:controller].to_s.gsub('/','-')}:#{data[:action]}"
+        "#{data[:controller].to_s.gsub('/', '-')}:#{data[:action]}"
       end
     end
   end

data/lib/lograge/formatters/lines.rb

@@ -0,0 +1,18 @@
+module Lograge
+  module Formatters
+    class Lines
+      def call(data)
+        load_dependencies
+
+        ::Lines.dump(data)
+      end
+
+      def load_dependencies
+        require 'lines'
+      rescue LoadError
+        puts 'You need to install the lines gem to use this output.'
+        raise
+      end
+    end
+  end
+end

data/lib/lograge/formatters/logstash.rb

@@ -4,15 +4,15 @@ module Lograge
       def call(data)
         load_dependencies
         event = LogStash::Event.new(data)
-  
+
         event.message = "[#{data[:status]}] #{data[:method]} #{data[:path]} (#{data[:controller]}##{data[:action]})"
         event.to_json
       end
 
       def load_dependencies
-        require "logstash-event"
+        require 'logstash-event'
       rescue LoadError
-        puts "You need to install the logstash-event gem to use the logstash output."
+        puts 'You need to install the logstash-event gem to use the logstash output.'
         raise
       end
     end

data/lib/lograge/formatters/raw.rb

@@ -6,4 +6,4 @@ module Lograge
       end
     end
   end
-end
+end

data/lib/lograge/log_subscriber.rb

@@ -11,10 +11,10 @@ module Lograge
       payload = event.payload
 
       data      = extract_request(payload)
-      data.merge! extract_status(payload)
-      data.merge! runtimes(event)
-      data.merge! location(event)
-      data.merge! custom_options(event)
+      extract_status(data, payload)
+      runtimes(data, event)
+      location(data)
+      custom_options(data, event)
 
       data = before_format(data, payload)
       formatted_message = Lograge.formatter.call(data)
@@ -26,70 +26,71 @@ module Lograge
     end
 
     def logger
-      Lograge.logger.presence or super
+      Lograge.logger.presence || super
     end
 
     private
 
     def extract_request(payload)
       {
-        :method => payload[:method],
-        :path => extract_path(payload),
-        :format => extract_format(payload),
-        :controller => payload[:params]['controller'],
-        :action => payload[:params]['action']
+        method: payload[:method],
+        path: extract_path(payload),
+        format: extract_format(payload),
+        controller: payload[:params]['controller'],
+        action: payload[:params]['action']
       }
     end
 
     def extract_path(payload)
-      payload[:path].split("?").first
+      path = payload[:path]
+      index = path.index('?')
+      index ? path[0, index] : path
     end
 
-    def extract_format(payload)
-      if ::ActionPack::VERSION::MAJOR == 3 && ::ActionPack::VERSION::MINOR == 0
+    if ::ActionPack::VERSION::MAJOR == 3 && ::ActionPack::VERSION::MINOR == 0
+      def extract_format(payload)
         payload[:formats].first
-      else
+      end
+    else
+      def extract_format(payload)
         payload[:format]
       end
     end
 
-    def extract_status(payload)
-      if payload[:status]
-        { :status => payload[:status].to_i }
-      elsif payload[:exception]
-        exception, message = payload[:exception]
-        { :status => 500, :error => "#{exception}:#{message}" }
+    def extract_status(data, payload)
+      if (status = payload[:status])
+        data[:status] = status.to_i
+      elsif (error = payload[:exception])
+        exception, message = error
+        data[:status] = 500
+        data[:error]  = "#{exception}:#{message}"
       else
-        { :status => 0 }
+        data[:status] = 0
       end
     end
 
-    def custom_options(event)
-      Lograge.custom_options(event) || {}
+    def custom_options(data, event)
+      options = Lograge.custom_options(event)
+      data.merge! options if options
     end
 
     def before_format(data, payload)
       Lograge.before_format(data, payload)
     end
 
-    def runtimes(event)
-      {
-        :duration => event.duration,
-        :view => event.payload[:view_runtime],
-        :db => event.payload[:db_runtime]
-      }.inject({}) do |runtimes, (name, runtime)|
-        runtimes[name] = runtime.to_f.round(2) if runtime
-        runtimes
-      end
+    def runtimes(data, event)
+      payload = event.payload
+      data[:duration] = event.duration.to_f.round(2)
+      data[:view]     = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
+      data[:db]       = payload[:db_runtime].to_f.round(2) if payload.key?(:db_runtime)
     end
 
-    def location(event)
-      if location = Thread.current[:lograge_location]
-        Thread.current[:lograge_location] = nil
-        { :location => location }
-      else
-        {}
-      end
+    def location(data)
+      location = Thread.current[:lograge_location]
+      return unless location
+
+      Thread.current[:lograge_location] = nil
+      data[:location] = location
     end
   end
 end

data/lib/lograge/rails_ext/rack/logger.rb

@@ -18,7 +18,7 @@ module Rails
       end
 
       # Overwrites Rails 3.0/3.1 code that logs new requests
-      def before_dispatch(env)
+      def before_dispatch(_env)
       end
     end
   end

data/lib/lograge/version.rb

@@ -1,3 +1,3 @@
 module Lograge
-  VERSION = "0.3.0"
+  VERSION = '0.3.1'
 end

data/lib/lograge.rb

@@ -4,6 +4,7 @@ require 'lograge/formatters/json'
 require 'lograge/formatters/graylog2'
 require 'lograge/formatters/key_value'
 require 'lograge/formatters/l2met'
+require 'lograge/formatters/lines'
 require 'lograge/formatters/logstash'
 require 'lograge/formatters/raw'
 require 'lograge/log_subscriber'
@@ -11,9 +12,10 @@ require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/ordered_options'
 
-
 module Lograge
-  mattr_accessor :logger
+  module_function
+
+  mattr_accessor :logger, :application, :ignore_tests
 
   # Custom options that will be appended to log line
   #
@@ -58,25 +60,25 @@ module Lograge
 
   def self.ignore_actions(actions)
     ignore(lambda do |event|
-      params = event.payload[:params]
-      Array(actions).include?("#{params['controller']}##{params['action']}")
-    end)
+             params = event.payload[:params]
+             Array(actions).include?("#{params['controller']}##{params['action']}")
+           end)
   end
 
-  def self.ignore_tests
-    @@ignore_tests ||= []
+  def ignore_tests
+    @ignore_tests ||= []
   end
 
   def self.ignore(test)
     ignore_tests.push(test) if test
   end
 
-  def self.ignore_nothing
-    @@ignore_tests = []
+  def ignore_nothing
+    @ignore_tests = []
   end
 
   def self.ignore?(event)
-    ignore_tests.any?{|ignore_test| ignore_test.call(event)}
+    ignore_tests.any? { |ignore_test| ignore_test.call(event) }
   end
 
   # Loglines are emitted with this log level
@@ -102,7 +104,7 @@ module Lograge
   end
 
   def self.unsubscribe(component, subscriber)
-    events = subscriber.public_methods(false).reject{ |method| method.to_s == 'call' }
+    events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
     events.each do |event|
       ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
         if listener.instance_variable_get('@delegate') == subscriber
@@ -113,26 +115,40 @@ module Lograge
   end
 
   def self.setup(app)
+    self.application = app
     app.config.action_dispatch.rack_cache[:verbose] = false if app.config.action_dispatch.rack_cache
-    require 'lograge/rails_ext/rack/logger'
-    Lograge.remove_existing_log_subscriptions
+
+    unless app.config.lograge.keep_original_rails_log
+      require 'lograge/rails_ext/rack/logger'
+      Lograge.remove_existing_log_subscriptions
+    end
+
+    Lograge.logger = app.config.lograge.logger
+
     Lograge::RequestLogSubscriber.attach_to :action_controller
-    Lograge.custom_options = app.config.lograge.custom_options
-    Lograge.before_format = app.config.lograge.before_format
-    Lograge.log_level = app.config.lograge.log_level || :info
-    self.support_deprecated_config(app) # TODO: Remove with version 1.0
-    Lograge.formatter = app.config.lograge.formatter || Lograge::Formatters::KeyValue.new
-    Lograge.ignore_actions(app.config.lograge.ignore_actions)
-    Lograge.ignore(app.config.lograge.ignore_custom)
+    Lograge.custom_options = lograge_config.custom_options
+    Lograge.before_format = lograge_config.before_format
+    Lograge.log_level = lograge_config.log_level || :info
+    support_deprecated_config # TODO: Remove with version 1.0
+    Lograge.formatter = lograge_config.formatter || Lograge::Formatters::KeyValue.new
+    Lograge.ignore_actions(lograge_config.ignore_actions)
+    Lograge.ignore(lograge_config.ignore_custom)
   end
 
   # TODO: Remove with version 1.0
-  def self.support_deprecated_config(app)
-    if legacy_log_format = app.config.lograge.log_format
-      ActiveSupport::Deprecation.warn 'config.lograge.log_format is deprecated. Use config.lograge.formatter instead.', caller
-      legacy_log_format = :key_value if legacy_log_format == :lograge
-      app.config.lograge.formatter = "Lograge::Formatters::#{legacy_log_format.to_s.classify}".constantize.new
-    end
+
+  def support_deprecated_config
+    return unless lograge_config.log_format
+
+    legacy_log_format = lograge_config.log_format
+    warning = 'config.lograge.log_format is deprecated. Use config.lograge.formatter instead.'
+    ActiveSupport::Deprecation.warn(warning, caller)
+    legacy_log_format = :key_value if legacy_log_format == :lograge
+    lograge_config.formatter = "Lograge::Formatters::#{legacy_log_format.to_s.classify}".constantize.new
+  end
+
+  def lograge_config
+    application.config.lograge
   end
 end
 

metadata

@@ -1,169 +1,129 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.3.1
 platform: ruby
 authors:
 - Mathias Meyer
+- Ben Lovell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2015-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 description: Tame Rails' multi-line logging into a single line per request
 email:
 - meyer@paperplanes.de
+- benjamin.lovell@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
-- CHANGES.md
-- Gemfile
-- Guardfile
-- README.md
-- Rakefile
 - lib/lograge.rb
 - lib/lograge/formatters/cee.rb
 - lib/lograge/formatters/graylog2.rb
 - lib/lograge/formatters/json.rb
 - lib/lograge/formatters/key_value.rb
 - lib/lograge/formatters/l2met.rb
+- lib/lograge/formatters/lines.rb
 - lib/lograge/formatters/logstash.rb
 - lib/lograge/formatters/raw.rb
 - lib/lograge/log_subscriber.rb
 - lib/lograge/rails_ext/rack/logger.rb
 - lib/lograge/railtie.rb
 - lib/lograge/version.rb
-- lograge.gemspec
-- spec/formatters/cee_spec.rb
-- spec/formatters/graylog2_spec.rb
-- spec/formatters/json_spec.rb
-- spec/formatters/key_value_spec.rb
-- spec/formatters/l2met_spec.rb
-- spec/formatters/logstash_spec.rb
-- spec/formatters/raw_spec.rb
-- spec/lograge_logsubscriber_spec.rb
-- spec/lograge_spec.rb
-- spec/spec_helper.rb
-- spec/support/examples.rb
 homepage: https://github.com/roidrage/lograge
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: lograge
-rubygems_version: 1.8.23
+rubyforge_project: 
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Tame Rails' multi-line logging into a single line per request
-test_files:
-- spec/formatters/cee_spec.rb
-- spec/formatters/graylog2_spec.rb
-- spec/formatters/json_spec.rb
-- spec/formatters/key_value_spec.rb
-- spec/formatters/l2met_spec.rb
-- spec/formatters/logstash_spec.rb
-- spec/formatters/raw_spec.rb
-- spec/lograge_logsubscriber_spec.rb
-- spec/lograge_spec.rb
-- spec/spec_helper.rb
-- spec/support/examples.rb
-has_rdoc: 
+test_files: []