logged 0.1.1 → 0.3.0

data/lib/logged/formatter/raw.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logged/formatter/base'
 
 module Logged

data/lib/logged/formatter/single_key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logged/formatter/base'
 
 module Logged
@@ -5,6 +7,8 @@ module Logged
     # Single-Key formatter for logged
     class SingleKey < Base
       def initialize(key)
+        super()
+
         @key = key
       end
 

data/lib/logged/level_conversion.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Logged
   # Conversion between log level symbols and integers
   module LevelConversion

data/lib/logged/log_subscriber/action_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'logged/log_subscriber/base'
 
@@ -10,17 +12,7 @@ module Logged
       def process_action(event)
         return if ignore?(event, :info)
 
-        payload = event.payload
-
-        data = {
-          event: event.name
-        }
-
-        data.merge!(extract_request(payload))
-        data.merge!(cached_event_data)
-        data.merge!(extract_path(payload))
-        data.merge!(extract_status(payload))
-        data.merge!(extract_runtimes(payload))
+        data = process_action_data(event)
 
         data[:duration] = event.duration.to_f.round(2)
 
@@ -75,7 +67,7 @@ module Logged
 
         {
           view_runtime: view_runtime,
-          db_runtime: db_runtime
+          db_runtime:   db_runtime
         }.reject { |_k, v| v.blank? }
       end
 
@@ -91,6 +83,22 @@ module Logged
           filter:   filter
         }.reject { |_k, v| v.blank? }
       end
+
+      def process_action_data(event)
+        data = {
+          event: event.name
+        }
+
+        payload = event.payload
+
+        data.merge!(extract_request(payload))
+        data.merge!(cached_event_data)
+        data.merge!(extract_path(payload))
+        data.merge!(extract_status(payload))
+        data.merge!(extract_runtimes(payload))
+
+        data
+      end
     end
   end
 end

data/lib/logged/log_subscriber/action_mailer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logged/log_subscriber/base'
 
 module Logged
@@ -49,19 +51,31 @@ module Logged
       private
 
       def extract_mail_deliver(payload)
-        data = {
-          mailer:     (payload[:mailer] || Thread.current[:logged_action_mailer_process_mailer]),
-          action:     (payload[:action] || Thread.current[:logged_action_mailer_process_action]),
-          from:       Array(payload[:from]).join(', '),
-          to:         Array(payload[:to]).join(', '),
-          bcc:        Array(payload[:bcc]).join(', ')
-        }
+        data = mail_deliver_data(payload)
 
         Thread.current[:logged_action_mailer_process_mailer] = nil
         Thread.current[:logged_action_mailer_process_action] = nil
 
         data
       end
+
+      def mail_deliver_data(payload)
+        {
+          mailer: mail_deliver_data_thread_fallback(payload, :mailer),
+          action: mail_deliver_data_thread_fallback(payload, :action),
+          from:   mail_deliver_data_array(payload, :from),
+          to:     mail_deliver_data_array(payload, :to),
+          bcc:    mail_deliver_data_array(payload, :bcc)
+        }
+      end
+
+      def mail_deliver_data_thread_fallback(payload, key)
+        payload[key] || Thread.current["logged_action_mailer_process_#{key}".to_sym]
+      end
+
+      def mail_deliver_data_array(payload, key)
+        Array(payload[key]).join(', ')
+      end
     end
   end
 end

data/lib/logged/log_subscriber/action_view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'action_view/log_subscriber'
 require 'logged/log_subscriber/base'
 
@@ -21,8 +23,8 @@ module Logged
 
         debug(event, data)
       end
-      alias_method :render_partial, :render_template
-      alias_method :render_collection, :render_template
+      alias render_partial render_template
+      alias render_collection render_template
 
       protected
 
@@ -35,7 +37,7 @@ module Logged
       end
 
       def rails_root
-        @root ||= "#{::Rails.root}/"
+        @rails_root ||= "#{::Rails.root}/"
       end
     end
   end

data/lib/logged/log_subscriber/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record/log_subscriber'
 require 'logged/log_subscriber/base'
 
@@ -6,7 +8,7 @@ module Logged
     # Log subscriber for ActiveRecord events
     class ActiveRecord < Base
       # This query types will be ignored
-      IGNORE_PAYLOAD_NAMES = %w( SCHEMA EXPLAIN )
+      IGNORE_PAYLOAD_NAMES = %w[SCHEMA EXPLAIN].freeze
 
       component :active_record
 

data/lib/logged/log_subscriber/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/log_subscriber'
 
 module Logged
@@ -16,7 +18,7 @@ module Logged
 
       private
 
-      %w(info debug warn error fatal unknown).each do |level|
+      %w[info debug warn error fatal unknown].each do |level|
         class_eval <<-METHOD, __FILE__, __LINE__ + 1
           def #{level}(event, progname = nil, &block)
             return unless logger
@@ -33,7 +35,7 @@ module Logged
       end
 
       def component
-        self.class.instance_variable_get('@component')
+        self.class.instance_variable_get(:@component)
       end
 
       def ignore?(event, log_level = nil)

data/lib/logged/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'logged/tagged_logging'
 
@@ -7,6 +9,7 @@ module Logged
     include TaggedLogging
 
     attr_reader :loggers, :component
+    attr_writer :enabled
 
     def initialize(loggers, component, formatter)
       @loggers   = loggers
@@ -33,9 +36,9 @@ module Logged
         add_to_logger(level, event, data, logger, options)
       end
     end
-    alias_method :log, :add
+    alias log add
 
-    %w(info debug warn error fatal unknown).each do |level|
+    %w[info debug warn error fatal unknown].each do |level|
       class_eval <<-METHOD, __FILE__, __LINE__ + 1
         def #{level}?
           @loggers.keys.any? { |l| l.#{level}? }
@@ -48,7 +51,7 @@ module Logged
     end
 
     def close
-      @loggers.keys.each do |logger|
+      @loggers.each_key do |logger|
         logger.close if logger.respond_to?(:close)
       end
     end
@@ -63,10 +66,6 @@ module Logged
       @enabled
     end
 
-    def enabled=(enable)
-      @enabled = !!enable
-    end
-
     def enable!
       self.enabled = true
     end

data/lib/logged/rack/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'action_dispatch'
 
@@ -14,10 +16,10 @@ module Logged
 
         request = ActionDispatch::Request.new(env)
 
-        if loggers.length > 0
-          loggers_tagged(loggers, request) { @app.call(env) }
-        else
+        if loggers.empty?
           @app.call(env)
+        else
+          loggers_tagged(loggers, request) { @app.call(env) }
         end
       ensure
         Thread.current[:logged_request_env] = nil
@@ -33,10 +35,10 @@ module Logged
         logger = loggers.shift
         tags   = tags_for_component(logger.component, request)
 
-        if loggers.length > 0
-          tagged_block(logger, tags) { loggers_tagged(loggers, request, &block) }
+        if loggers.empty?
+          tagged_block(logger, tags, &block)
         else
-          tagged_block(logger, tags) { block.call }
+          tagged_block(logger, tags) { loggers_tagged(loggers, request, &block) }
         end
       end
 

data/lib/logged/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/railtie'
 require 'logged/configuration'
 

data/lib/logged/subscriptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Logged
   # Railtie for logged
   module Subscriptions
@@ -31,9 +33,7 @@ module Logged
 
       events.each do |event|
         ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
-          if listener.instance_variable_get('@delegate') == subscriber
-            ActiveSupport::Notifications.unsubscribe listener
-          end
+          ActiveSupport::Notifications.unsubscribe listener if listener.instance_variable_get(:@delegate) == subscriber
         end
       end
     end

data/lib/logged/tagged_logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Logged
   # Tagged logging support
   module TaggedLogging

data/lib/logged/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Logged
   # Version
-  VERSION = '0.1.1'
+  VERSION = '0.3.0'
 end

data/lib/logged.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logged/version'
 require 'logged/level_conversion'
 require 'logged/logger'
@@ -16,7 +18,7 @@ module Logged
   extend Logged::Subscriptions
 
   # special keys which not represent a component
-  CONFIG_KEYS = Configuration::DEFAULT_VALUES.keys + [:loggers, :disable_rails_logging]
+  CONFIG_KEYS = Configuration::DEFAULT_VALUES.keys + %i[loggers disable_rails_logging]
 
   mattr_accessor :app, :config
 
@@ -61,7 +63,7 @@ module Logged
 
       @component_loggers[key] = Logger.new(loggers, component, formatter)
     end
-    alias_method :'[]', :logger_by_component
+    alias [] logger_by_component
 
     # loggers for component
     def loggers_for(component)

data/logged.gemspec

@@ -1,17 +1,19 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'logged/version'
 
 Gem::Specification.new do |spec|
-  rails_version      = '>= 4.0', '< 5.1'
+  rails_version      = '>= 5.0', '< 8.0'
 
   spec.name          = 'logged'
   spec.version       = Logged::VERSION
   spec.authors       = ['Florian Schwab']
   spec.email         = ['me@ydkn.de']
-  spec.summary       = %q(Better logging for rails)
-  spec.homepage      = 'https://github.com/ydkn/logged'
+  spec.summary       = 'Better logging for rails'
+  spec.homepage      = 'https://gitlab.com/ydkn/logged'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,9 +21,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler',      '~> 1.12'
-  spec.add_development_dependency 'rake',         '~> 10.5'
-  spec.add_development_dependency 'rspec',        '~> 3.5'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rails'
   spec.add_development_dependency 'rails',        rails_version
   spec.add_development_dependency 'actionpack',   rails_version
   spec.add_development_dependency 'actionview',   rails_version

data/spec/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logged.gemspec
+gemspec path: '..'
+
+gem 'railties', "~> #{ENV.fetch('RSPEC_RAILS_VERSION')}"