Fix #38 Make backward compatible with Rails 4.2.

Increase test coverage.

.gitignore

@@ -1,8 +1,13 @@
-.DS_Store
+.bundle/
+*.log
+pkg/
+test/dummy/tmp/
+test/dummy/.sass-cache
 *.gem
-.idea/*
+/.idea
+tags
+*.DS_Store
 Gemfile.lock
-._test
-*.log
+/gemfiles/*.lock
 
-*.lock
+*.sqlite3

Gemfile

@@ -3,7 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'minitest'
+gem 'minitest', '~> 5.10', '!= 5.10.2'
+gem 'minitest-rails'
 gem 'minitest-reporters'
 gem 'minitest-stub_any_instance'
 gem 'awesome_print'
@@ -14,4 +15,5 @@ gem 'jdbc-sqlite3', platform: :jruby
 gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
 gem 'appraisal'
 
-gem 'rails', '~> 5.1.0'
+gem 'rails', '~> 4.2.0'
+gem 'puma'

TESTING.md

@@ -0,0 +1,26 @@
+## Installation
+
+Install all needed gems to run the tests:
+
+    appraisal install
+
+The gems are installed into the global gem list.
+The Gemfiles in the `gemfiles` folder are also re-generated.
+
+## Run Tests
+
+For all supported Rails/ActiveRecord versions:
+
+    rake
+
+Or for specific rails version:
+
+    appraisal rails_4.2 rake
+
+Or for one particular test file:
+
+    appraisal rails_5.0 ruby test/controllers/articles_controller_test.rb 
+
+Or down to one test case:
+
+    appraisal rails_5.0 ruby test/controllers/articles_controller_test.rb  -n "/shows new article/"

gemfiles/rails_4.2.gemfile

@@ -3,7 +3,8 @@
 source "https://rubygems.org"
 
 gem "rake"
-gem "minitest"
+gem "minitest", "~> 5.10", "!= 5.10.2"
+gem "minitest-rails"
 gem "minitest-reporters"
 gem "minitest-stub_any_instance"
 gem "awesome_print"
@@ -13,5 +14,6 @@ gem "jdbc-sqlite3", platform: :jruby
 gem "activerecord-jdbcsqlite3-adapter", platform: :jruby
 gem "appraisal"
 gem "rails", "~> 4.2.0"
+gem "puma"
 
 gemspec path: "../"

gemfiles/rails_5.0.gemfile

@@ -3,7 +3,8 @@
 source "https://rubygems.org"
 
 gem "rake"
-gem "minitest"
+gem "minitest", "~> 5.10", "!= 5.10.2"
+gem "minitest-rails"
 gem "minitest-reporters"
 gem "minitest-stub_any_instance"
 gem "awesome_print"
@@ -13,5 +14,6 @@ gem "jdbc-sqlite3", platform: :jruby
 gem "activerecord-jdbcsqlite3-adapter", platform: :jruby
 gem "appraisal"
 gem "rails", "~> 5.0"
+gem "puma"
 
 gemspec path: "../"

gemfiles/rails_5.1.gemfile

@@ -3,7 +3,8 @@
 source "https://rubygems.org"
 
 gem "rake"
-gem "minitest"
+gem "minitest", "~> 5.10", "!= 5.10.2"
+gem "minitest-rails"
 gem "minitest-reporters"
 gem "minitest-stub_any_instance"
 gem "awesome_print"
@@ -13,5 +14,6 @@ gem "jdbc-sqlite3", platform: :jruby
 gem "activerecord-jdbcsqlite3-adapter", platform: :jruby
 gem "appraisal"
 gem "rails", "~> 5.1.0"
+gem "puma"
 
 gemspec path: "../"

lib/rails_semantic_logger/extensions/action_controller/log_subscriber.rb

@@ -10,8 +10,11 @@ def start_processing(event)
 
     def process_action(event)
       controller_logger(event).info do
-        payload = event.payload.dup
-        payload[:params] = payload[:params].to_unsafe_h.except(*INTERNAL_PARAMS)
+        payload          = event.payload.dup
+        # According to PR https://github.com/rocketjob/rails_semantic_logger/pull/37/files
+        # payload[:params] is not always a Hash.
+        payload[:params] = payload[:params].to_unsafe_h unless payload[:params].is_a?(Hash)
+        payload[:params].except!(*INTERNAL_PARAMS)
         payload.delete(:params) if payload[:params].empty?
 
         format           = payload[:format]
@@ -43,19 +46,19 @@ def process_action(event)
     end
 
     def halted_callback(event)
-      controller_logger(event).info { "Filter chain halted as #{event.payload[:filter].inspect} rendered or redirected" }
+      controller_logger(event).info {"Filter chain halted as #{event.payload[:filter].inspect} rendered or redirected"}
     end
 
     def send_file(event)
-      controller_logger(event).info('Sent file') { {path: event.payload[:path], duration: event.duration} }
+      controller_logger(event).info('Sent file') {{path: event.payload[:path], duration: event.duration}}
     end
 
     def redirect_to(event)
-      controller_logger(event).info('Redirected to') { {location: event.payload[:location]} }
+      controller_logger(event).info('Redirected to') {{location: event.payload[:location]}}
     end
 
     def send_data(event)
-      controller_logger(event).info('Sent data') { {file_name: event.payload[:filename], duration: event.duration} }
+      controller_logger(event).info('Sent data') {{file_name: event.payload[:filename], duration: event.duration}}
     end
 
     def unpermitted_parameters(event)
@@ -69,7 +72,8 @@ def unpermitted_parameters(event)
        expire_fragment expire_page write_page).each do |method|
       class_eval <<-METHOD, __FILE__, __LINE__ + 1
         def #{method}(event)
-          return unless ActionController::Base.enable_fragment_cache_logging
+          # enable_fragment_cache_logging as of Rails 5
+          return if ActionController::Base.respond_to?(:enable_fragment_cache_logging) && !ActionController::Base.enable_fragment_cache_logging
           controller_logger(event).info do
             key_or_path = event.payload[:key] || event.payload[:path]
             {message: "#{method.to_s.humanize} \#{key_or_path}", duration: event.duration}

lib/rails_semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module RailsSemanticLogger #:nodoc
-  VERSION = '4.1.0'
+  VERSION = '4.1.1'
 end

test/controllers/articles_controller_test.rb

@@ -0,0 +1,75 @@
+require_relative "../test_helper"
+
+class ArticlesControllerTest < ActionController::TestCase
+  describe ArticlesController do
+    before do
+      # Use a mock logger that just keeps the last logged entry in an instance variable
+      SemanticLogger.default_level   = :trace
+      SemanticLogger.backtrace_level = nil
+      @mock_logger                   = MockLogger.new
+      @appender                      = SemanticLogger.add_appender(logger: @mock_logger, formatter: :raw)
+      @logger                        = SemanticLogger['Test']
+      @hash                          = {session_id: 'HSSKLEU@JDK767', tracking_number: 12345}
+
+      assert_equal [], SemanticLogger.tags
+      assert_equal 65535, SemanticLogger.backtrace_level_index
+    end
+
+    after do
+      SemanticLogger.remove_appender(@appender)
+    end
+
+    describe 'GET #new' do
+      it 'shows new article' do
+        get :new
+        assert_response :success
+      end
+    end
+
+    describe 'POST #create' do
+      describe 'with valid parameters' do
+        let(:params) do
+          {
+            article: {
+              text:  'Text1',
+              title: 'Title1'
+            }
+          }
+        end
+
+        before do
+          params = {params: self.params} if Rails.version.to_i >= 5
+          post :create, params
+        end
+
+        it 'has no errors' do
+          assert_response :success
+        end
+
+        it 'successfully logs message' do
+          SemanticLogger.flush
+          actual = @mock_logger.message
+
+          assert_equal 'Completed #create', actual[:message]
+          assert_equal 'ArticlesController', actual[:name]
+
+          assert payload = actual[:payload], actual
+          assert_equal 'create', payload[:action], payload
+          assert_equal 'ArticlesController', payload[:controller], payload
+          assert_equal 'HTML', payload[:format], payload
+          assert_equal 'POST', payload[:method], payload
+          # Only Rails 5 passes the arguments through
+          if Rails.version.to_i >= 5
+            assert_equal({"article" => {"text" => "Text1", "title" => "Title1"}}, payload[:params], payload)
+          end
+          assert_equal '/articles', payload[:path], payload
+          assert_equal 200, payload[:status], payload
+          assert_equal 'OK', payload[:status_message], payload
+          assert (payload[:view_runtime] >= 0.0), payload
+          assert (payload[:db_runtime] >= 0.0), payload
+        end
+
+      end
+    end
+  end
+end

test/controllers/welcome_controller_test.rb

@@ -0,0 +1,13 @@
+require_relative '../test_helper'
+
+class WelcomeControllerTest < ActionController::TestCase
+  describe WelcomeController do
+    before do
+      get :index
+    end
+
+    it 'should get index' do
+      assert_response :success
+    end
+  end
+end

test/dummy/app/assets/javascripts/application.js

@@ -10,6 +10,6 @@
 // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
 // GO AFTER THE REQUIRES BELOW.
 //
-//= require jquery
-//= require jquery_ujs
-//= require_tree .
+//# require jquery
+//# require jquery_ujs
+//# require_tree .

test/dummy/app/assets/javascripts/articles.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

test/dummy/app/assets/stylesheets/articles.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

test/dummy/app/assets/stylesheets/welcome.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,3 @@
 class ApplicationController < ActionController::Base
-  protect_from_forgery
+  protect_from_forgery with: :exception
 end

test/dummy/app/controllers/articles_controller.rb

@@ -0,0 +1,8 @@
+class ArticlesController < ApplicationController
+  def new
+  end
+
+  def create
+    render plain: params[:article].inspect
+  end
+end

test/dummy/app/controllers/welcome_controller.rb

@@ -0,0 +1,4 @@
+class WelcomeController < ApplicationController
+  def index
+  end
+end

test/dummy/app/helpers/articles_helper.rb

@@ -0,0 +1,2 @@
+module ArticlesHelper
+end

test/dummy/app/helpers/welcome_helper.rb

@@ -0,0 +1,2 @@
+module WelcomeHelper
+end

test/dummy/app/views/articles/new.html.erb

@@ -0,0 +1,17 @@
+<h1>New Article</h1>
+
+<%= form_for :article, url: articles_path do |f| %>
+    <p>
+      <%= f.label :title %><br>
+      <%= f.text_field :title %>
+    </p>
+
+    <p>
+      <%= f.label :text %><br>
+      <%= f.text_area :text %>
+    </p>
+
+    <p>
+      <%= f.submit %>
+    </p>
+<% end %>

test/dummy/app/views/welcome/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Welcome#index</h1>
+<p>Find me in app/views/welcome/index.html.erb</p>

test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

test/dummy/bin/puma

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'puma' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('puma', 'puma')

test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

test/dummy/bin/setup

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end