rails-flog 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a916ad1e90e6cc5129639360c15c13638e014c5c3ab60ae03e5a68b38f8601e5
-  data.tar.gz: 271eab7f87be9bb46ffdb028732bd244f76b933b1fe6bda290b199050cdbee68
+  metadata.gz: 7bba2152bd153f016c66ba66cebcb387fb2e8578e1fa1ff659f885d48eba0e0a
+  data.tar.gz: 1b6784cf98e02d66808f5f087e003dd8af2f69f272845167f2dfc344ab1d0742
 SHA512:
-  metadata.gz: 5f8b98fff00f12bb337573c9fe988e65596d6ce76ffd43defc7b5651286675049741b41d6dd03f3da6216e3b68e371f2bce60b1173c8ec3175a0a91be12d98cd
-  data.tar.gz: cfe53e680ac6ed2d86eee1e30e14350bbdfe00bbb7e9910345aef5b72ee20bb9d6766870d1c7a3747014dbb2758379b7b1447c5f38ba6540e21ec95f8d8de7a5
+  metadata.gz: 4f44d36f195e11be261a0a5d7fe0c763b09f24aaafebc23b924a879da39b1f67b6bb2d68e738206f848e4db891db32089d99847f92f5326fff0471ca8fac5687
+  data.tar.gz: 7e2bc4c9af5f6134f6ef38eb72484fee8305611e25366fa9283933abf3702455b424cb0877073c89aae26ad86aa74a424ab1faa65bf90ddac03cfba719c8bc83

data/.rubocop.yml

@@ -0,0 +1,25 @@
+# Current style is easy to confirm SQL.
+Layout/SpaceBeforeComma:
+  Exclude:
+    - 'test/unit/sql_formattable_test.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*'
+
+# 80 is too restrict.
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Exclude:
+    - 'test/**/*'
+
+# This is test code not production.
+Security/Eval:
+  Exclude:
+    - 'test/unit/params_formattable_test.rb'
+
+# method having '?' suffix should return boolean, double negation is very useful.
+Style/DoubleNegation:
+  Enabled: false

data/.travis.yml

@@ -7,8 +7,17 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 gemfile:
   - gemfiles/rails_4_2_x.gemfile
   - gemfiles/rails_5_0_x.gemfile
   - gemfiles/rails_5_1_x.gemfile
   - gemfiles/rails_5_2_x.gemfile
+# FIXME: will remove on dropping Rails 4.2 support
+matrix:
+  exclude:
+    - gemfile: gemfiles/rails_4_2_x.gemfile
+      rvm: 2.6
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rails-flog.gemspec

data/README.md

@@ -101,6 +101,10 @@ Flog.configure do |config|
   config.params_key_count_threshold = 2
   # If this value is true, nested Hash parameter is formatted coercively in any situation
   config.force_on_nested_params = false
+  # If this value is true, not format query
+  config.ignore_query = true
+  # If this value is true, not format parameters
+  config.ignore_params = true
 end
 ```
 
@@ -112,6 +116,8 @@ end
 |query_duration_threshold   |float     |0.0           |
 |params_key_count_threshold |integer   |1             |
 |force_on_nested_params     |boolean   |true          |
+|ignore_query               |boolean   |false         |
+|ignore_params              |boolean   |false         |
 
 ## Disable temporary
 
@@ -126,7 +132,7 @@ Priority of this feature is higher than configurations.
 
 ## Supported versions
 
-- Ruby: 2.3.x, 2.4.x, 2.5.x
+- Ruby: 2.3.x, 2.4.x, 2.5.x, 2.6.x
 - Rails: 4.2.x, 5.0.x, 5.1.x, 5.2.x
 
 ## Contributing
@@ -148,4 +154,5 @@ Priority of this feature is higher than configurations.
 - 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
-- v1.5.0  (2018-12-19 JST):  Add `sql_indenti` and `sql_in_values_num` options, and dropped eol rails versions.
+- v1.5.0  (2018-12-19 JST):  Add `sql_indent` and `sql_in_values_num` options, and dropped eol rails versions.
+- v1.6.0  (2019-07-26 JST):  Add `ignore_query` and `ignore_params` options (Thanks @mothule)

data/Rakefile

@@ -1,9 +1,11 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
 
-task :default => :test
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: :test
 
 Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = Dir.glob("test/unit/*_test.rb")
+  t.libs << 'test'
+  t.test_files = Dir.glob('test/unit/*_test.rb')
 end

data/gemfiles/rails_4_2_x.gemfile

@@ -1,6 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "rails", "~>4.2.0"
+source 'https://rubygems.org'
 
-gemspec :path => "../"
+gem 'rails', '~> 4.2.0'
 
+gemspec path: '../'

data/gemfiles/rails_5_0_x.gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "rails", "~>5.0.0"
+source 'https://rubygems.org'
 
-gemspec :path => "../"
+gem 'rails', '~>5.0.0'
+
+gemspec path: '../'

data/gemfiles/rails_5_1_x.gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "rails", "~>5.1.0"
+source 'https://rubygems.org'
 
-gemspec :path => "../"
+gem 'rails', '~>5.1.0'
+
+gemspec path: '../'

data/gemfiles/rails_5_2_x.gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "rails", "~>5.2.0"
+source 'https://rubygems.org'
 
-gemspec :path => "../"
+gem 'rails', '~>5.2.0'
+
+gemspec path: '../'

data/lib/flog.rb

@@ -1,5 +1,7 @@
-require "flog/version"
-require "flog/status"
-require "flog/configuration"
-require "flog/sql_formattable"
-require "flog/params_formattable"
+# frozen_string_literal: true
+
+require 'flog/version'
+require 'flog/status'
+require 'flog/configuration'
+require 'flog/sql_formattable'
+require 'flog/params_formattable'

data/lib/flog/configuration.rb

@@ -1,10 +1,15 @@
-require "anbt-sql-formatter/rule"
+# frozen_string_literal: true
 
+require 'anbt-sql-formatter/rule'
+
+# Flog is root module of this gem
 module Flog
   ONELINE_IN_VALUES_NUM = ::AnbtSql::Rule::ONELINE_IN_VALUES_NUM
 
+  # Configuration of this gem.
+  # Call `configure` to setup.
   class Configuration
-    attr_writer :ignore_cached_query, :force_on_nested_params
+    attr_writer :ignore_cached_query, :force_on_nested_params, :ignore_query, :ignore_params
     attr_accessor :query_duration_threshold, :params_key_count_threshold, :sql_indent, :sql_in_values_num
 
     def initialize
@@ -14,24 +19,36 @@ module Flog
       @force_on_nested_params = true
       @sql_indent = "\t"
       @sql_in_values_num = 1
+      @ignore_query = false
+      @ignore_params = false
     end
 
     def ignore_cached_query?
-      !!@ignore_cached_query
+      !!@ignore_cached_query || @ignore_query
     end
 
     def force_on_nested_params?
       !!@force_on_nested_params
     end
-  end
 
-  def self.config
-    @@config ||= Flog::Configuration.new
+    def ignore_query?
+      !!@ignore_query
+    end
+
+    def ignore_params?
+      !!@ignore_params
+    end
   end
 
-  def self.configure
-    cfg = Flog::Configuration.new
-    yield(cfg) if block_given?
-    @@config = cfg
+  class << self
+    def config
+      @config ||= Flog::Configuration.new
+    end
+
+    def configure
+      cfg = Flog::Configuration.new
+      yield(cfg) if block_given?
+      @config = cfg
+    end
   end
 end

data/lib/flog/params_formattable.rb

@@ -1,61 +1,70 @@
-require "action_controller/log_subscriber"
-require "awesome_print"
-require "flog/payload_value_shuntable"
+# frozen_string_literal: true
 
-module Flog::ParamsFormattable
-  include Flog::PayloadValueShuntable
-  def start_processing(event)
-    return super(event) unless formattable?(event)
+require 'action_controller/log_subscriber'
+require 'awesome_print'
+require 'flog/payload_value_shuntable'
 
-    replaced = replace_params(event.payload[:params])
+module Flog
+  # Overrides `inspect` method for formatting itself
+  module ParamsInspectOverridable
+    def inspect
+      "\n#{ai(plain: !ActionController::LogSubscriber.colorize_logging)}"
+    end
+  end
 
-    shunt_payload_value(event.payload, :params, replaced) do
-      super(event)
+  # Overrides `except` method for formatting ecepted params.
+  module ParamsExceptOverridable
+    def except(*keys)
+      excepted = super(*keys)
+      excepted.singleton_class.prepend(ParamsInspectOverridable)
+      excepted
     end
   end
 
-  private
-  def replace_params(params)
-    return params if params.empty? || !params.respond_to?(:ai)
-
-    replaced = params.dup
-    class << replaced
-      alias :original_except :except
-
-      def except(*keys)
-        excepted = original_except(*keys)
-        class << excepted
-          def inspect
-            "\n#{ai(plain: !ActionController::LogSubscriber.colorize_logging)}"
-          end
-        end
-        excepted
+  # ParamsFormattable enables to format request parameters in log.
+  module ParamsFormattable
+    include Flog::PayloadValueShuntable
+    def start_processing(event)
+      return super(event) unless formattable?(event)
+
+      replaced = replace_params(event.payload[:params])
+
+      shunt_payload_value(event.payload, :params, replaced) do
+        super(event)
       end
     end
-    replaced
-  end
 
-  def formattable?(event)
-    return false unless Flog::Status.params_formattable?
+    private
 
-    return true if force_format_by_nested_params?(event)
+    def replace_params(params)
+      return params if params.empty? || !params.respond_to?(:ai)
 
-    key_count_over?(event)
-  end
+      replaced = params.dup
+      replaced.singleton_class.prepend(ParamsExceptOverridable)
+      replaced
+    end
 
-  def force_format_by_nested_params?(event)
-    return false unless Flog.config.force_on_nested_params?
+    def formattable?(event)
+      return false if Flog.config.ignore_params?
+      return false unless Flog::Status.params_formattable?
 
-    event.payload[:params].values.any? { |value| value.is_a?(Hash) }
-  end
+      return true if force_format_by_nested_params?(event)
 
-  def key_count_over?(event)
-    threshold = Flog.config.params_key_count_threshold.to_i
-    params = event.payload[:params].except(*ActionController::LogSubscriber::INTERNAL_PARAMS)
-    params.keys.size > threshold
+      key_count_over?(event)
+    end
+
+    def force_format_by_nested_params?(event)
+      return false unless Flog.config.force_on_nested_params?
+
+      event.payload[:params].values.any? { |value| value.is_a?(Hash) }
+    end
+
+    def key_count_over?(event)
+      threshold = Flog.config.params_key_count_threshold.to_i
+      params = event.payload[:params].except(*ActionController::LogSubscriber::INTERNAL_PARAMS)
+      params.keys.size > threshold
+    end
   end
 end
 
-class ActionController::LogSubscriber
-  prepend Flog::ParamsFormattable
-end
+ActionController::LogSubscriber.prepend(Flog::ParamsFormattable)

data/lib/flog/payload_value_shuntable.rb

@@ -1,20 +1,33 @@
+# frozen_string_literal: true
+
 module Flog
+  # PayloadValueShuntable enables to shunt value in payload
   module PayloadValueShuntable
     def shunt_payload_value(payload, key, temp_value, &block)
       return unless block
 
-      key_exists = payload.key?(key)
+      if payload.key?(key)
+        shunt_if_key_already_exists(payload, key, temp_value, block)
+      else
+        shunt_if_key_not_exist(payload, key, temp_value, block)
+      end
+    end
+
+    def shunt_if_key_already_exists(payload, key, temp_value, block)
       base_value = payload[key]
       begin
         payload[key] = temp_value
         block.call
       ensure
-        if key_exists
-          payload[key] = base_value
-        else
-          payload.delete(key)
-        end
+        payload[key] = base_value
       end
     end
+
+    def shunt_if_key_not_exist(payload, key, temp_value, block)
+      payload[key] = temp_value
+      block.call
+    ensure
+      payload.delete(key)
+    end
   end
 end

data/lib/flog/sql_formattable.rb

@@ -1,52 +1,56 @@
-require "active_record/log_subscriber"
-require "flog/payload_value_shuntable"
+# frozen_string_literal: true
 
-module Flog::SqlFormattable
-  include Flog::PayloadValueShuntable
+require 'active_record/log_subscriber'
+require 'flog/payload_value_shuntable'
 
-  def sql(event)
-    return super(event) unless formattable?(event)
+module Flog
+  # SqlFormattable enables to format SQL log
+  module SqlFormattable
+    include Flog::PayloadValueShuntable
 
-    formatted = format_sql(event.payload[:sql])
+    def sql(event)
+      return super(event) unless formattable?(event)
 
-    shunt_payload_value(event.payload, :sql, "\n#{Flog.config.sql_indent}#{formatted}") do
-      super(event)
+      formatted = format_sql(event.payload[:sql])
+
+      shunt_payload_value(event.payload, :sql, "\n#{Flog.config.sql_indent}#{formatted}") do
+        super(event)
+      end
     end
-  end
 
-  private
+    private
 
-  def format_sql(sql)
-    return sql if sql.blank?
+    def format_sql(sql)
+      return sql if sql.blank?
 
-    require "anbt-sql-formatter/formatter"
-    rule = AnbtSql::Rule.new
-    rule.keyword = AnbtSql::Rule::KEYWORD_UPPER_CASE
-    rule.indent_string = Flog.config.sql_indent
-    rule.in_values_num = Flog.config.sql_in_values_num
-    %w(count sum).each do |function_name|
-      rule.function_names << function_name
+      require 'anbt-sql-formatter/formatter'
+      rule = AnbtSql::Rule.new
+      rule.keyword = AnbtSql::Rule::KEYWORD_UPPER_CASE
+      rule.indent_string = Flog.config.sql_indent
+      rule.in_values_num = Flog.config.sql_in_values_num
+      %w[count sum].each do |function_name|
+        rule.function_names << function_name
+      end
+      AnbtSql::Formatter.new(rule).format(sql.squeeze(' '))
     end
-    AnbtSql::Formatter.new(rule).format(sql.squeeze(" "))
-  end
 
-  def formattable?(event)
-    return false unless Flog::Status.sql_formattable?
+    def formattable?(event)
+      return false if Flog.config.ignore_query?
+      return false unless Flog::Status.sql_formattable?
 
-    return false if ignore_by_cached_query?(event)
+      return false if ignore_by_cached_query?(event)
 
-    duration_over?(event)
-  end
+      duration_over?(event)
+    end
 
-  def ignore_by_cached_query?(event)
-    (event.payload[:name] == "CACHE" || event.payload[:cached]) && Flog.config.ignore_cached_query?
-  end
+    def ignore_by_cached_query?(event)
+      (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
+    def duration_over?(event)
+      event.duration >= Flog.config.query_duration_threshold.to_f
+    end
   end
 end
 
-class ActiveRecord::LogSubscriber
-  prepend Flog::SqlFormattable
-end
+ActiveRecord::LogSubscriber.prepend(Flog::SqlFormattable)