rails-flog 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6650571abd225e7e4de159b193338aa05d1e33da
-  data.tar.gz: 286f33b58393fa72e15228392f0ef93c8d2387e2
+  metadata.gz: ea548e225007f44c586d46f6eb80e223a8e3811b
+  data.tar.gz: a75ec850a8e3791b4f2f989751d2e50995a16def
 SHA512:
-  metadata.gz: 49ce57b4524083e836d98b099d3032bed05da5e12b113a9bc67fab3230109002e4dbabbcb1152b0e01956abcfc2bd96cec60e8e1550009801f09f1aa2dcb0d72
-  data.tar.gz: d6b9cdda04e030a197d70bb13b8e47687b5005605ef9af121012bea7182dd4b18d0bc76adf163795340c903603af6c0f3475a1f9de3c8f55741364b9787d3bae
+  metadata.gz: 7493abeb100a8b089fca0431e99fbb7e0e9b57ab5781cf7bb2d575ed0ae709add8f70c9c24be1e18cb3f857f18299129a3bcb7db1248840358af4160886bf978
+  data.tar.gz: 83f43ad891a50b08948aae9cdee9c4874abbc3c9951fa6ac01051d663a2d8245b9e50c3907f71e60d5f9caa16bb48058671b64eebc48a28df420672f4e7c6ea7

data/.travis.yml

@@ -1,11 +1,25 @@
 language: ruby
+sudo: false
 rvm:
-  - 1.9.3
   - 2.0
   - 2.1
   - 2.2
+  - 2.3
+  - 2.4
 gemfile:
   - gemfiles/rails_3_2_x.gemfile
   - gemfiles/rails_4_0_x.gemfile
   - gemfiles/rails_4_1_x.gemfile
   - gemfiles/rails_4_2_x.gemfile
+  - gemfiles/rails_5_0_x.gemfile
+  - gemfiles/rails_5_1_x.gemfile
+matrix:
+  exclude:
+    - gemfile: gemfiles/rails_5_0_x.gemfile
+      rvm: 2.0
+    - gemfile: gemfiles/rails_5_0_x.gemfile
+      rvm: 2.1
+    - gemfile: gemfiles/rails_5_1_x.gemfile
+      rvm: 2.0
+    - gemfile: gemfiles/rails_5_1_x.gemfile
+      rvm: 2.1

data/README.md

@@ -126,7 +126,7 @@ Priority of this feature is higher than configurations.
 
 ## Supported versions
 
-- Ruby: 1.9.3, 2.0.x, 2.1.x, 2.2.x
+- Ruby: 2.0.x, 2.1.x, 2.2.x
 - Rails: 3.2.x, 4.0.x, 4.1.x, 4.2.x
 
 ## Contributing
@@ -147,3 +147,4 @@ Priority of this feature is higher than configurations.
 - v1.3.1  (2014-01-27 JST):  Refactored
 - v1.3.2  (2014-04-28 JST):  Confirm with Rails 4.1
 - v1.3.3  (2015-11-16 JST):  Confirm with Rails 4.2
+- v1.4.0  (2017-10-01 JST):  Compatible for Rails 5.0 and Rails 5.1, and dropped Ruby 1.9.3 support

data/gemfiles/rails_5_0_x.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~>5.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_5_1_x.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~>5.1.0"
+
+gemspec :path => "../"

data/lib/flog.rb

@@ -1,7 +1,5 @@
-# coding: utf-8
 require "flog/version"
 require "flog/status"
 require "flog/configuration"
 require "flog/sql_formattable"
 require "flog/params_formattable"
-

data/lib/flog/configuration.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 module Flog
   class Configuration
     attr_writer :ignore_cached_query, :force_on_nested_params

data/lib/flog/params_formattable.rb

@@ -1,21 +1,18 @@
-# coding: utf-8
 require "action_controller/log_subscriber"
 require "awesome_print"
 require "flog/payload_value_shuntable"
 
-class ActionController::LogSubscriber
+module Flog::ParamsFormattable
   include Flog::PayloadValueShuntable
-
-  def start_processing_with_flog(event)
-    return start_processing_without_flog(event) unless formattable?(event)
+  def start_processing(event)
+    return super(event) unless formattable?(event)
 
     replaced = replace_params(event.payload[:params])
 
     shunt_payload_value(event.payload, :params, replaced) do
-      start_processing_without_flog(event)
+      super(event)
     end
   end
-  alias_method_chain :start_processing, :flog
 
   private
   def replace_params(params)
@@ -54,7 +51,11 @@ class ActionController::LogSubscriber
 
   def key_count_over?(event)
     threshold = Flog.config.params_key_count_threshold.to_i
-    params = event.payload[:params].except(*INTERNAL_PARAMS)
+    params = event.payload[:params].except(*ActionController::LogSubscriber::INTERNAL_PARAMS)
     params.keys.size > threshold
   end
 end
+
+class ActionController::LogSubscriber
+  prepend Flog::ParamsFormattable
+end

data/lib/flog/payload_value_shuntable.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 module Flog
   module PayloadValueShuntable
     def shunt_payload_value(payload, key, temp_value, &block)

data/lib/flog/sql_formattable.rb

@@ -1,20 +1,18 @@
-# coding: utf-8
 require "active_record/log_subscriber"
 require "flog/payload_value_shuntable"
 
-class ActiveRecord::LogSubscriber
+module Flog::SqlFormattable
   include Flog::PayloadValueShuntable
 
-  def sql_with_flog(event)
-    return sql_without_flog(event) unless formattable?(event)
+  def sql(event)
+    return super(event) unless formattable?(event)
 
     formatted = format_sql(event.payload[:sql])
 
     shunt_payload_value(event.payload, :sql, "\n\t#{formatted}") do
-      sql_without_flog(event)
+      super(event)
     end
   end
-  alias_method_chain :sql, :flog
 
   private
   def format_sql(sql)
@@ -39,10 +37,14 @@ class ActiveRecord::LogSubscriber
   end
 
   def ignore_by_cached_query?(event)
-    event.payload[:name] == "CACHE" && Flog.config.ignore_cached_query?
+    (event.payload[:name] == "CACHE" || event.payload[:cached]) && Flog.config.ignore_cached_query?
   end
 
   def duration_over?(event)
     event.duration >= Flog.config.query_duration_threshold.to_f
   end
 end
+
+class ActiveRecord::LogSubscriber
+  prepend Flog::SqlFormattable
+end

data/lib/flog/status.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require "rails"
 
 module Flog

data/lib/flog/version.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 module Flog
-  VERSION = "1.3.3"
+  VERSION = "1.4.0"
 end

data/test/test_helper.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require "coveralls"
 require "simplecov"
 SimpleCov.formatter = Coveralls::SimpleCov::Formatter
@@ -10,32 +9,46 @@ end
 require "flog"
 require "minitest/autorun"
 
-class TestLogger
-  attr_accessor :debugs, :infos, :errors
+unless defined?(TestLogger)
+  class TestLogger
+    attr_accessor :debugs, :infos, :errors
 
-  def initialize
-    @debugs = []
-    @infos = []
-    @errors = []
-  end
+    def initialize
+      @debugs = []
+      @infos = []
+      @errors = []
+    end
 
-  def debug?
-    true
-  end
+    def debug?
+      true
+    end
 
-  def info?
-    true
-  end
+    def info?
+      true
+    end
+
+    def debug(message)
+      @debugs += message.split("\n") if message
+    end
 
-  def debug(message)
-    @debugs += message.split("\n") if message
+    def info(message)
+      @infos += message.split("\n") if message
+    end
+
+    def error(message)
+      @errors += message.split("\n") if message
+    end
   end
+end
+
+unless defined?(COLOR_SEQ_REGEX)
+  COLOR_SEQ_REGEX = /\e\[(\d+;)*\d+m/
 
-  def info(message)
-    @infos += message.split("\n") if message
+  def remove_color_seq(log)
+    log.gsub(COLOR_SEQ_REGEX, "")
   end
 
-  def error(message)
-    @errors += message.split("\n") if message
+  def match_color_seq(log)
+    COLOR_SEQ_REGEX.match(log)
   end
 end

data/test/unit/params_formattable_test.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require "action_controller"
 require "test_helper"
 
@@ -12,7 +11,7 @@ class TestController < ActionController::Base
   end
 
   def show
-    render nothing: true
+    head :not_found
   end
 end
 
@@ -41,48 +40,51 @@ class ParamsFormattableTest < ActionController::TestCase
   end
 
   def test_parameters_log_is_formatted
-    get :show, foo: "foo_value", bar: "bar_value"
+    get_show foo: "foo_value", bar: "bar_value"
     assert_logger do |logger|
-      logs = logger.infos.map { |log| log.gsub(/\e\[(\d+;)*\d+m/, "") }
-      assert_equal %(  Parameters: )           , logs[1]
-      assert_equal %({)                        , logs[2]
-      assert_equal %(    "foo" => "foo_value",), logs[3]
-      assert_equal %(    "bar" => "bar_value") , logs[4]
-      assert_equal %(})                        , logs[5]
+      logs = logger.infos.map { |log| remove_color_seq(log) }
+      assert_equal "  Parameters: ", logs[1]
+      hash = hash_from_logs(logs, 2, 5)
+      assert_equal hash["foo"], "foo_value"
+      assert_equal hash["bar"], "bar_value"
     end
   end
 
   def test_colorized_on_colorize_loggin_is_true
     ActiveSupport::LogSubscriber.colorize_logging = true
-    get :show, foo: "foo_value", bar: "bar_value"
+    get_show foo: "foo_value", bar: "bar_value"
     assert_logger do |logger|
-      assert /\e\[(\d+;)*\d+m/.match(logger.infos.join())
+      assert match_color_seq(logger.infos.join())
     end
   end
 
   def test_not_colorized_on_colorize_loggin_is_false
     Flog::Status.stub(:enabled?, true) do
-      get :show, foo: "foo_value", bar: "bar_value"
+      get_show foo: "foo_value", bar: "bar_value"
       assert_logger do |logger|
-        assert_nil /\e\[(\d+;)*\d+m/.match(logger.infos.join())
+        assert_nil match_color_seq(logger.infos.join())
       end
     end
   end
 
   def test_parameters_log_is_not_formatted_when_enabled_is_false
     Flog::Status.stub(:enabled?, false) do
-      get :show, foo: "foo_value", bar: "bar_value"
+      get_show foo: "foo_value", bar: "bar_value"
       assert_logger do |logger|
-        assert logger.infos[1].include?(%(Parameters: {"foo"=>"foo_value", "bar"=>"bar_value"}))
+        assert logger.infos[1].include?("Parameters: {")
+        assert logger.infos[1].include?(%("foo"=>"foo_value"))
+        assert logger.infos[1].include?(%("bar"=>"bar_value"))
       end
     end
   end
 
   def test_parameters_log_is_not_formatted_when_params_formattable_is_false
     Flog::Status.stub(:params_formattable?, false) do
-      get :show, foo: "foo_value", bar: "bar_value"
+      get_show foo: "foo_value", bar: "bar_value"
       assert_logger do |logger|
-        assert logger.infos[1].include?(%(Parameters: {"foo"=>"foo_value", "bar"=>"bar_value"}))
+        assert logger.infos[1].include?("Parameters: {")
+        assert logger.infos[1].include?(%("foo"=>"foo_value"))
+        assert logger.infos[1].include?(%("bar"=>"bar_value"))
       end
     end
   end
@@ -91,9 +93,11 @@ class ParamsFormattableTest < ActionController::TestCase
     Flog.configure do |config|
       config.params_key_count_threshold = 2
     end
-    get :show, foo: "foo_value", bar: "bar_value"
+    get_show foo: "foo_value", bar: "bar_value"
     assert_logger do |logger|
-      assert logger.infos[1].include?(%(Parameters: {"foo"=>"foo_value", "bar"=>"bar_value"}))
+      assert logger.infos[1].include?("Parameters: {")
+      assert logger.infos[1].include?(%("foo"=>"foo_value"))
+      assert logger.infos[1].include?(%("bar"=>"bar_value"))
     end
   end
 
@@ -101,9 +105,11 @@ class ParamsFormattableTest < ActionController::TestCase
     Flog.configure do |config|
       config.params_key_count_threshold = 3
     end
-    get :show, foo: "foo_value", bar: "bar_value"
+    get_show foo: "foo_value", bar: "bar_value"
     assert_logger do |logger|
-      assert logger.infos[1].include?(%(Parameters: {"foo"=>"foo_value", "bar"=>"bar_value"}))
+      assert logger.infos[1].include?("Parameters: {")
+      assert logger.infos[1].include?(%("foo"=>"foo_value"))
+      assert logger.infos[1].include?(%("bar"=>"bar_value"))
     end
   end
 
@@ -111,17 +117,14 @@ class ParamsFormattableTest < ActionController::TestCase
     Flog.configure do |config|
       config.params_key_count_threshold = 3
     end
-    get :show, foo: "foo_value", bar: { prop: "prop_value", attr: "attr_value" }
+    get_show foo: "foo_value", bar: { prop: "prop_value", attr: "attr_value" }
     assert_logger do |logger|
-      logs = logger.infos.map { |log| log.gsub(/\e\[(\d+;)*\d+m/, "") }
-      assert_equal %(  Parameters: )                 , logs[1]
-      assert_equal %({)                              , logs[2]
-      assert_equal %(    "foo" => "foo_value",)      , logs[3]
-      assert_equal %(    "bar" => {)                 , logs[4]
-      assert_equal %(        "prop" => "prop_value",), logs[5]
-      assert_equal %(        "attr" => "attr_value") , logs[6]
-      assert_equal %(    })                          , logs[7]
-      assert_equal %(})                              , logs[8]
+      logs = logger.infos.map { |log| remove_color_seq(log) }
+      assert_equal "  Parameters: ", logs[1]
+      hash = hash_from_logs(logs, 2, 8)
+      assert_equal hash["foo"], "foo_value"
+      assert_equal hash["bar"]["prop"], "prop_value"
+      assert_equal hash["bar"]["attr"], "attr_value"
     end
   end
 
@@ -133,4 +136,16 @@ class ParamsFormattableTest < ActionController::TestCase
       block.call(ActionController::Base.logger)
     end
   end
+
+  def get_show(params)
+    if Gem::Version.new(Rails.version) >= Gem::Version.new("5.0.0")
+      get :show, params: params
+    else
+      get :show, params
+    end
+  end
+
+  def hash_from_logs(logs, start, finish)
+    eval(start.upto(finish).reduce("") { |s, n| s + logs[n] })
+  end
 end

data/test/unit/payload_value_shuntable_test.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require "test_helper"
 
 class TestClass
@@ -36,7 +35,7 @@ class PayloadValueShuntableTest < ActiveSupport::TestCase
       @tester.shunt_payload_value(@payload, :foo, "new_value") do
         raise "error"
       end
-    rescue => ex
+    rescue
       error_raised = true
     end
     assert error_raised

data/test/unit/sql_formattable_test.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require "active_record"
 require "test_helper"
 
@@ -47,14 +46,14 @@ class SqlFormattableTest < ActiveSupport::TestCase
     ActiveSupport::LogSubscriber.colorize_logging = true
     Book.where(category: "comics").to_a
     assert_logger do |logger|
-      assert /\e\[(\d+;)*\d+m/.match(logger.debugs.join())
+      assert match_color_seq(logger.debugs.join())
     end
   end
 
   def test_not_colorized_on_colorize_loggin_is_false
     Book.where(category: "comics").to_a
     assert_logger do |logger|
-      assert_nil /\e\[(\d+;)*\d+m/.match(logger.debugs.join())
+      assert_nil match_color_seq(logger.debugs.join())
     end
   end
 

data/test/unit/status_test.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require "rails"
 require "test_helper"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-flog
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - pinzolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-16 00:00:00.000000000 Z
+date: 2017-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,6 +140,8 @@ files:
 - gemfiles/rails_4_0_x.gemfile
 - gemfiles/rails_4_1_x.gemfile
 - gemfiles/rails_4_2_x.gemfile
+- gemfiles/rails_5_0_x.gemfile
+- gemfiles/rails_5_1_x.gemfile
 - lib/flog.rb
 - lib/flog/configuration.rb
 - lib/flog/params_formattable.rb
@@ -174,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Rails log formatter for parameters and sql