loga 2.1.2 → 2.2.0

data/lib/loga/ext/rails/rack/debug_exceptions.rb

@@ -2,7 +2,6 @@ module ActionDispatch
   class DebugExceptions
     private
 
-    def logger(_request)
-    end
+    def logger(_request); end
   end
 end

data/lib/loga/formatters/simple_formatter.rb

@@ -29,7 +29,7 @@ module Loga
       def compute_event_message(event)
         components = [event.message]
 
-        %i(type data exception).each do |attr|
+        %i[type data exception].each do |attr|
           if event.public_send(attr)
             components.push "#{attr}=#{event.public_send(attr)}"
           end

data/lib/loga/log_subscribers/action_mailer.rb

@@ -0,0 +1,59 @@
+module Loga
+  module LogSubscribers
+    # Loga::LogSubscribers::ActionMailer tracks the three
+    # mailing events: 'process', 'deliver' and 'receive', and
+    # builds a loga event instance for each particular invocation.
+    class ActionMailer < ActiveSupport::LogSubscriber
+      def deliver(event)
+        mailer     = event.payload[:mailer]
+        recipients = event.payload[:to].join(',')
+        unique_id  = event.payload[:unique_id]
+        duration   = event.duration.round(1)
+        message = "#{mailer}: Sent mail to #{recipients} in (#{duration}ms)"
+
+        loga_event = Event.new(
+          data: { mailer: mailer, unique_id: unique_id },
+          message: message,
+          type: 'action_mailer',
+        )
+
+        logger.info(loga_event)
+      end
+
+      def process(event)
+        mailer = event.payload[:mailer]
+        action = event.payload[:action]
+        unique_id = event.payload[:unique_id]
+        duration  = event.duration.round(1)
+
+        message = "#{mailer}##{action}: Processed outbound mail in (#{duration}ms)"
+
+        loga_event = Event.new(
+          data: { mailer: mailer, unique_id: unique_id, action: action },
+          message: message,
+          type: 'action_mailer',
+        )
+
+        logger.debug(loga_event)
+      end
+
+      def receive(event)
+        from      = event.payload[:from]
+        mailer    = event.payload[:mailer]
+        unique_id = event.payload[:unique_id]
+
+        loga_event = Event.new(
+          data: { mailer: mailer, unique_id: unique_id },
+          message: "Received mail #{from} in (#{event.duration.round(1)}ms)",
+          type: 'action_mailer',
+        )
+
+        logger.info(loga_event)
+      end
+
+      def logger
+        Loga.logger
+      end
+    end
+  end
+end

data/lib/loga/rack/logger.rb

@@ -63,7 +63,7 @@ module Loga
       end
 
       def compute_message
-        '%{method} %{filtered_full_path} %{status} in %{duration}ms' % {
+        '%<method>s %<filtered_full_path>s %<status>d in %<duration>dms' % {
           method:             request.request_method,
           filtered_full_path: request.filtered_full_path,
           status:             data['status'],

data/lib/loga/rack/request_id.rb

@@ -3,7 +3,7 @@ require 'securerandom'
 require 'active_support/core_ext/string/access'
 require 'active_support/core_ext/object/blank'
 
-# rubocop:disable Metrics/LineLength, Lint/AssignmentInCondition
+# rubocop:disable Lint/AssignmentInCondition, Metrics/LineLength, Style/GuardClause
 module Loga
   module Rack
     # Makes a unique request id available to the action_dispatch.request_id env variable (which is then accessible through
@@ -41,4 +41,4 @@ module Loga
     end
   end
 end
-# rubocop:enable Metrics/LineLength, Lint/AssignmentInCondition, Style/GuardClause
+# rubocop:enable Lint/AssignmentInCondition, Metrics/LineLength, Style/GuardClause

data/lib/loga/railtie.rb

@@ -1,4 +1,5 @@
 require 'loga'
+require 'loga/log_subscribers/action_mailer'
 
 module Loga
   class Railtie < Rails::Railtie
@@ -153,29 +154,41 @@ module Loga
 
       def call
         ensure_subscriptions_attached
+        subscribe_to_action_mailer
         remove_log_subscriptions
       end
 
       private
 
+      def subscribe_to_action_mailer
+        LogSubscribers::ActionMailer.attach_to(:action_mailer)
+      end
+
       # Ensure LogSubscribers are attached when available
       def ensure_subscriptions_attached
         ActionView::Base       if defined?(ActionView::Base)
         ActionController::Base if defined?(ActionController::Base)
+        ActionMailer::Base     if defined?(ActionMailer::Base)
       end
 
-      # rubocop:disable Metrics/LineLength
       def remove_log_subscriptions
         ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
-          case subscriber
-          when defined?(ActionView::LogSubscriber) && ActionView::LogSubscriber
-            unsubscribe(:action_view, subscriber)
-          when defined?(ActionController::LogSubscriber) && ActionController::LogSubscriber
-            unsubscribe(:action_controller, subscriber)
-          end
+          component = log_subscription_component(subscriber)
+
+          unsubscribe(component, subscriber)
+        end
+      end
+
+      def log_subscription_component(subscriber) # rubocop:disable CyclomaticComplexity
+        case subscriber
+        when defined?(ActionView::LogSubscriber) && ActionView::LogSubscriber
+          :action_view
+        when defined?(ActionController::LogSubscriber) && ActionController::LogSubscriber
+          :action_controller
+        when defined?(ActionMailer::LogSubscriber) && ActionMailer::LogSubscriber
+          :action_mailer
         end
       end
-      # rubocop:enable Metrics/LineLength
 
       def unsubscribe(component, subscriber)
         events = subscriber
@@ -187,7 +200,7 @@ module Loga
             .listeners_for("#{event}.#{component}")
             .each do |listener|
             if listener.instance_variable_get('@delegate') == subscriber
-              ActiveSupport::Notifications.unsubscribe listener
+              ActiveSupport::Notifications.unsubscribe(listener)
             end
           end
         end

data/lib/loga/version.rb

@@ -1,3 +1,3 @@
 module Loga
-  VERSION = '2.1.2'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/loga.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'loga/version'
@@ -21,15 +21,16 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 2.3.8'
   spec.add_dependency 'rack'
 
-  spec.add_development_dependency 'appraisal', '~> 2.0.2'
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'appraisal', '~> 2.2.0'
+  spec.add_development_dependency 'bundler',   '~> 1.6'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'guard',         '~> 2.13'
+  spec.add_development_dependency 'guard-rspec',   '~> 4.7.3'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec',    '~> 3.5.0'
-  spec.add_development_dependency 'rubocop',  '~> 0.40.0'
+  spec.add_development_dependency 'rspec',    '~> 3.6.0'
+  spec.add_development_dependency 'rubocop',  '~> 0.50.0'
   spec.add_development_dependency 'timecop'
-  spec.add_development_dependency 'guard',         '~> 2.13'
-  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
-  spec.add_development_dependency 'guard-rspec',   '~> 4.7.3'
 end

data/spec/fixtures/README.md

@@ -1,11 +1,31 @@
 # Generating fixture Apps
 
 ## Rails 3.2
-`appraisal rails32 rails new spec/fixtures/rails32 --skip-gemfile --skip-git --skip-active-record --skip-sprockets --skip-javascript --skip-test-unit`
 
+```
+appraisal rails32 rails new spec/fixtures/rails32 --skip-gemfile --skip-git --skip-active-record --skip-sprockets --skip-javascript --skip-test-unit
+```
 
 ## Rails 4.0
-`appraisal rails40 rails new spec/fixtures/rails40 --skip-gemfile --skip-git --skip-keeps --skip-active-record --skip-action-view --skip-sprockets --skip-spring --skip-javascript --skip-test-unit`
+
+```
+appraisal rails40 rails new spec/fixtures/rails40 --skip-gemfile --skip-git --skip-keeps --skip-active-record --skip-action-view --skip-sprockets --skip-spring --skip-javascript --skip-test-unit
+```
+
+## Rails 4.2
+
+```
+appraisal rails42 rails new spec/fixtures/rails42 --skip-gemfile --skip-git --skip-keeps --skip-active-record --skip-action-view --skip-sprockets --skip-spring --skip-javascript --skip-test-unit
+```
 
 ## Rails 5.0
-`appraisal rails50 rails new spec/fixtures/rails50 --skip-gemfile --skip-git --skip-keeps --skip-active-record --skip-action-view --skip-sprockets --skip-spring --skip-javascript --skip-test-unit`
+
+```
+appraisal rails50 rails new spec/fixtures/rails50 --skip-gemfile --skip-git --skip-keeps --skip-active-record --skip-action-view --skip-sprockets --skip-spring --skip-javascript --skip-test-unit
+```
+
+## Rails 5.2
+
+```
+appraisal rails52 rails new spec/fixtures/rails52 --skip-gemfile --skip-git --skip-keeps --skip-active-record --skip-action-view --skip-sprockets --skip-spring --skip-javascript --skip-test-unit
+```

data/spec/fixtures/rails32.rb

@@ -0,0 +1,79 @@
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+
+Bundler.require(*Rails.groups(assets: %w[development test]))
+
+STREAM = StringIO.new unless defined?(STREAM)
+
+class Dummy < Rails::Application
+  config.filter_parameters += [:password]
+  config.secret_token = '32431967aed1c4357d311f27708a1837a938f07e0abfdefa6b8b398d7024c08c6b883ce9254cdd8573ce8e78f9dd192efff39395127811040fc695ab23677452'
+  config.session_store :cookie_store, key: '_rails32_session'
+
+  config.log_tags = [:uuid, 'TEST_TAG']
+  config.loga = {
+    device: STREAM,
+    host: 'bird.example.com',
+    service_name: 'hello_world_app',
+    service_version: '1.0',
+  }
+  config.action_mailer.delivery_method = :test
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  protect_from_forgery
+
+  def ok
+    render text: 'Hello Rails'
+  end
+
+  def error
+    nil.name
+  end
+
+  def show
+    render json: params
+  end
+
+  def create
+    render json: params
+  end
+
+  def new
+    redirect_to :ok
+  end
+
+  def update
+    @id = params[:id]
+    render '/user'
+  end
+end
+
+class FakeMailer < ActionMailer::Base
+  default from: 'notifications@example.com'
+
+  def self.send_email
+    basic_mail.deliver
+  end
+
+  def basic_mail
+    mail(
+      to: 'user@example.com',
+      subject: 'Welcome to My Awesome Site',
+      body: 'Banana muffin',
+      content_type: 'text/html',
+    )
+  end
+end
+
+Dummy.routes.append do
+  get 'ok'        => 'application#ok'
+  get 'error'     => 'application#error'
+  get 'show'      => 'application#show'
+  post 'users'    => 'application#create'
+  get 'new'       => 'application#new'
+  put 'users/:id' => 'application#update'
+end
+
+Dummy.initialize!

data/spec/fixtures/rails40.rb

@@ -0,0 +1,80 @@
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+
+Bundler.require(*Rails.groups)
+
+STREAM = StringIO.new unless defined?(STREAM)
+
+class Dummy < Rails::Application
+  config.eager_load = true
+  config.filter_parameters += [:password]
+  config.secret_key_base = '2624599ca9ab3cf3823626240138a128118a87683bf03ab8f155844c33b3cd8cbbfa3ef5e29db6f5bd182f8bd4776209d9577cfb46ac51bfd232b00ab0136b24'
+  config.session_store :cookie_store, key: '_rails40_session'
+
+  config.log_tags = [:uuid, 'TEST_TAG']
+  config.loga = {
+    device: STREAM,
+    host: 'bird.example.com',
+    service_name: 'hello_world_app',
+    service_version: '1.0',
+  }
+  config.action_mailer.delivery_method = :test
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  protect_from_forgery
+
+  def ok
+    render text: 'Hello Rails'
+  end
+
+  def error
+    nil.name
+  end
+
+  def show
+    render json: params
+  end
+
+  def create
+    render json: params
+  end
+
+  def new
+    redirect_to :ok
+  end
+
+  def update
+    @id = params[:id]
+    render '/user'
+  end
+end
+
+class FakeMailer < ActionMailer::Base
+  default from: 'notifications@example.com'
+
+  def self.send_email
+    basic_mail.deliver
+  end
+
+  def basic_mail
+    mail(
+      to: 'user@example.com',
+      subject: 'Welcome to My Awesome Site',
+      body: 'Banana muffin',
+      content_type: 'text/html',
+    )
+  end
+end
+
+Dummy.routes.append do
+  get 'ok'        => 'application#ok'
+  get 'error'     => 'application#error'
+  get 'show'      => 'application#show'
+  post 'users'    => 'application#create'
+  get 'new'       => 'application#new'
+  put 'users/:id' => 'application#update'
+end
+
+Dummy.initialize!

data/spec/fixtures/rails42.rb

@@ -0,0 +1,80 @@
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+
+Bundler.require(*Rails.groups)
+
+STREAM = StringIO.new unless defined?(STREAM)
+
+class Dummy < Rails::Application
+  config.eager_load = true
+  config.filter_parameters += [:password]
+  config.secret_key_base = '2624599ca9ab3cf3823626240138a128118a87683bf03ab8f155844c33b3cd8cbbfa3ef5e29db6f5bd182f8bd4776209d9577cfb46ac51bfd232b00ab0136b24'
+  config.session_store :cookie_store, key: '_rails42_session'
+
+  config.log_tags = [:uuid, 'TEST_TAG']
+  config.loga = {
+    device: STREAM,
+    host: 'bird.example.com',
+    service_name: 'hello_world_app',
+    service_version: '1.0',
+  }
+  config.action_mailer.delivery_method = :test
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  protect_from_forgery
+
+  def ok
+    render text: 'Hello Rails'
+  end
+
+  def error
+    nil.name
+  end
+
+  def show
+    render json: params
+  end
+
+  def create
+    render json: params
+  end
+
+  def new
+    redirect_to :ok
+  end
+
+  def update
+    @id = params[:id]
+    render '/user'
+  end
+end
+
+class FakeMailer < ActionMailer::Base
+  default from: 'notifications@example.com'
+
+  def self.send_email
+    basic_mail.deliver_now
+  end
+
+  def basic_mail
+    mail(
+      to: 'user@example.com',
+      subject: 'Welcome to My Awesome Site',
+      body: 'Banana muffin',
+      content_type: 'text/html',
+    )
+  end
+end
+
+Dummy.routes.append do
+  get 'ok'        => 'application#ok'
+  get 'error'     => 'application#error'
+  get 'show'      => 'application#show'
+  post 'users'    => 'application#create'
+  get 'new'       => 'application#new'
+  put 'users/:id' => 'application#update'
+end
+
+Dummy.initialize!