rails-flog 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbd0cbd748320a0c504c00edbc8997475d9bf4c1
-  data.tar.gz: 0d0775de3b25676721893cf95f0ed7e366888760
+  metadata.gz: 7573566571c52550bd3a1fdaf222159101caabb3
+  data.tar.gz: 3e19ae5c1197155f93264ac7e28614bbd22596b6
 SHA512:
-  metadata.gz: 5183eb309d08dc9faa9ce44084dd8e0a36e5eb94a4e09936f0e4ab67bcd1502064b5db9d8bb8b829cfd2bd2790632b65971429b9469959b98b59e88230fecc07
-  data.tar.gz: f959260174042393c7ec135d0dc2731c8169d22d0347722f9bb01cf45e4fbf034b49f77b70b4ac3aab3c6b6c77336bad4508b64af4479f2d849d48bdf2555a50
+  metadata.gz: 1a196d239d1af127143e19eefb1e8526de7d32684baab1b301cbd4d16aacde126ef35235103cb0546b5fe6a17d5b3c4d207234c6de0d25e467032a964564e206
+  data.tar.gz: b0b4ac38af5542776ea16fe73aa28efa774e2bee3b21618044c91c25de4d54ab13541099722039f4411f20dab9417874f7a22f92c36a49502c1b60ec661f116e

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-#  - 2.1.0
+  - 2.1.0
 gemfile:
   - gemfiles/rails_3_2_x.gemfile
   - gemfiles/rails_4_0_x.gemfile

data/README.md

@@ -87,6 +87,32 @@ Or install it yourself as:
 
 Just install.
 
+## Configuration
+
+Configure in your environment file (ex. `config/environments/development.rb`)
+
+```ruby
+Flog.configure do |config|
+  # If this value is true, not format on cached query
+  config.ignore_cached_query = false
+  # If query duration is under this value, not format
+  config.query_duration_threshold = 2.0
+  # If key count of parameters is under this value, not format
+  config.params_key_count_threshold = 2
+  # If this value is true, force format in any situation
+  config.force_on_nested_params = false
+end
+```
+
+### Default value
+
+|Attribute                  |Data type |Default value |
+|:--------------------------|:---------|:-------------|
+|ignore_cached_query        |boolean   |true          |
+|query_duration_threshold   |float     |0.0           |
+|params_key_count_threshold |integer   |1             |
+|force_on_nested_params     |boolean   |true          |
+
 ## Disable temporary
 
 If you put a file to `<rails_app>/tmp` direcotry, `rails-flog` will disable format.
@@ -99,7 +125,7 @@ If you put a file to `<rails_app>/tmp` direcotry, `rails-flog` will disable form
 
 ## Supported versions
 
-- Ruby: 1.9.3, 2.0.0
+- Ruby: 1.9.3, 2.0.0, 2.1.0
 - Rails: 3.2.x, 4.0.x
 
 ## Contributing
@@ -116,3 +142,5 @@ If you put a file to `<rails_app>/tmp` direcotry, `rails-flog` will disable form
 - v1.1.0  (2013-12-02 JST):  Add feature that disables format by no-flog.txt
 - v1.1.1  (2013-12-06 JST):  Change to alias_method_change from alias for method aliasing
 - v1.2.0  (2014-01-14 JST):  Add feature that disables format partially by no-flog-sql.txt and no-flog-params.txt
+- v1.3.0  (2014-01-26 JST):  Add configuration
+

data/lib/flog.rb

@@ -1,6 +1,7 @@
 # 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

@@ -0,0 +1,30 @@
+# coding: utf-8
+module Flog
+  class Configuration
+    attr_writer :ignore_cached_query, :force_on_nested_params
+    attr_accessor :query_duration_threshold, :params_key_count_threshold
+
+    def initialize
+      @ignore_cached_query = true
+      @query_duration_threshold = 0.0
+      @params_key_count_threshold = 1
+      @force_on_nested_params = true
+    end
+
+    def ignore_cached_query?
+      !!@ignore_cached_query
+    end
+
+    def force_on_nested_params?
+      !!@force_on_nested_params
+    end
+  end
+
+  def self.config
+    @@config ||= Flog::Configuration.new
+  end
+
+  def self.configure
+    yield(config) if block_given?
+  end
+end

data/lib/flog/params_formattable.rb

@@ -2,13 +2,12 @@
 require "action_controller/log_subscriber"
 require "awesome_print"
 require "flog/payload_value_shuntable"
-require "flog/status"
 
 class ActionController::LogSubscriber
   include Flog::PayloadValueShuntable
 
   def start_processing_with_flog(event)
-    return start_processing_without_flog(event) unless Flog::Status.params_formattable?
+    return start_processing_without_flog(event) unless formattable?(event)
 
     replaced = replace_params(event.payload[:params])
 
@@ -38,4 +37,17 @@ class ActionController::LogSubscriber
     end
     replaced
   end
+
+  def formattable?(event)
+    return false unless Flog::Status.params_formattable?
+
+    if Flog.config.force_on_nested_params?
+      return true if event.payload[:params].values.any? { |value| value.is_a?(Hash) }
+    end
+
+    threshold = Flog.config.params_key_count_threshold.to_i
+    threshold += 1 if event.payload[:params].keys.include?("controller")
+    threshold += 1 if event.payload[:params].keys.include?("action")
+    event.payload[:params].keys.size > threshold
+  end
 end

data/lib/flog/sql_formattable.rb

@@ -6,7 +6,7 @@ class ActiveRecord::LogSubscriber
   include Flog::PayloadValueShuntable
 
   def sql_with_flog(event)
-    return sql_without_flog(event) unless Flog::Status.sql_formattable?
+    return sql_without_flog(event) unless formattable?(event)
 
     formatted = format_sql(event.payload[:sql])
 
@@ -29,4 +29,14 @@ class ActiveRecord::LogSubscriber
     rule.indent_string = "\t"
     AnbtSql::Formatter.new(rule).format(sql.squeeze(" "))
   end
+
+  def formattable?(event)
+    return false unless Flog::Status.sql_formattable?
+
+    if event.payload[:name] == "CACHE" && Flog.config.ignore_cached_query?
+      return false
+    end
+
+    event.duration >= Flog.config.query_duration_threshold.to_f
+  end
 end

data/lib/flog/version.rb

@@ -1,4 +1,4 @@
 # coding: utf-8
 module Flog
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/test/unit/params_formattable_test.rb

@@ -18,6 +18,12 @@ end
 
 class ParamsFormattableTest < ActionController::TestCase
   def setup
+    # default configuration
+    Flog.configure do |config|
+      config.params_key_count_threshold = 1
+      config.force_on_nested_params = true
+    end
+
     @old_logger = ActionController::Base.logger
     ActiveSupport::LogSubscriber.colorize_logging = false
     @routes = ActionDispatch::Routing::RouteSet.new
@@ -77,6 +83,44 @@ class ParamsFormattableTest < ActionController::TestCase
     end
   end
 
+  def test_parameters_log_is_not_formatted_when_key_of_parameters_count_equals_to_configured_threshold
+    Flog.configure do |config|
+      config.params_key_count_threshold = 2
+    end
+    get :show, foo: "foo_value", bar: "bar_value"
+    assert_logger do |logger|
+      assert logger.infos[1].include?(%(Parameters: {"foo"=>"foo_value", "bar"=>"bar_value"}))
+    end
+  end
+
+  def test_parameters_log_is_not_formatted_when_key_of_parameters_count_is_under_configured_threshold
+    Flog.configure do |config|
+      config.params_key_count_threshold = 3
+    end
+    get :show, foo: "foo_value", bar: "bar_value"
+    assert_logger do |logger|
+      assert logger.infos[1].include?(%(Parameters: {"foo"=>"foo_value", "bar"=>"bar_value"}))
+    end
+  end
+
+  def test_parameters_log_is_formatted_when_key_of_parameters_count_is_under_configured_threshold_but_force_on_nested_params_configuration_is_true
+    Flog.configure do |config|
+      config.params_key_count_threshold = 3
+    end
+    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]
+    end
+  end
+
   private
   def assert_logger(&block)
     if ActionController::Base.logger.errors.present?

data/test/unit/sql_formattable_test.rb

@@ -15,6 +15,12 @@ class Book < ActiveRecord::Base; end
 
 class SqlFormattableTest < ActiveSupport::TestCase
   def setup
+    # default configuration
+    Flog.configure do |config|
+      config.ignore_cached_query = true
+      config.query_duration_threshold = 0.0
+    end
+
     @old_logger = ActiveRecord::Base.logger
     ActiveSupport::LogSubscriber.colorize_logging = false
     ActiveRecord::Base.logger = TestLogger.new
@@ -68,6 +74,58 @@ class SqlFormattableTest < ActiveSupport::TestCase
     end
   end
 
+  def test_sql_is_not_formatted_on_cached_query
+    Book.cache do
+      Book.where(category: "comics").to_a
+      Book.where(category: "comics").to_a
+    end
+    assert_logger do |logger|
+      logs = logger.debugs.map { |log| log.gsub("\t", "    ") }
+      assert_equal %{    SELECT}                             , logs[1]
+      assert_equal %{        "books" . *}                    , logs[2]
+      assert_equal %{    FROM}                               , logs[3]
+      assert_equal %{        "books"}                        , logs[4]
+      assert_equal %{    WHERE}                              , logs[5]
+      assert_equal %{        "books" . "category" = 'comics'}, logs[6]
+      assert logs[7].include?(%(SELECT "books".* FROM "books" WHERE "books"."category" = 'comics'))
+    end
+  end
+
+  def test_sql_is_formatted_on_cached_query_when_ignore_cached_query_configration_is_false
+    Flog.configure do |config|
+      config.ignore_cached_query = false
+    end
+    Book.cache do
+      Book.where(category: "comics").to_a
+      Book.where(category: "comics").to_a
+    end
+    assert_logger do |logger|
+      logs = logger.debugs.map { |log| log.gsub("\t", "    ") }
+      assert_equal %{    SELECT}                             , logs[1]
+      assert_equal %{        "books" . *}                    , logs[2]
+      assert_equal %{    FROM}                               , logs[3]
+      assert_equal %{        "books"}                        , logs[4]
+      assert_equal %{    WHERE}                              , logs[5]
+      assert_equal %{        "books" . "category" = 'comics'}, logs[6]
+      assert_equal %{    SELECT}                             , logs[8]
+      assert_equal %{        "books" . *}                    , logs[9]
+      assert_equal %{    FROM}                               , logs[10]
+      assert_equal %{        "books"}                        , logs[11]
+      assert_equal %{    WHERE}                              , logs[12]
+      assert_equal %{        "books" . "category" = 'comics'}, logs[13]
+    end
+  end
+
+  def test_sql_is_not_formatted_when_duration_is_under_threshold
+    Flog.configure do |config|
+      config.query_duration_threshold = 100.0
+    end
+    Book.where(category: "comics").to_a
+    assert_logger do |logger|
+      assert logger.debugs.first.include?(%(SELECT "books".* FROM "books" WHERE "books"."category" = 'comics'))
+    end
+  end
+
   private
   def assert_logger(&block)
     if ActiveRecord::Base.logger.errors.present?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-flog
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - pinzolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,6 +140,7 @@ files:
 - gemfiles/rails_4_0_x.gemfile
 - gemfiles/rails_4_1_x.gemfile
 - lib/flog.rb
+- lib/flog/configuration.rb
 - lib/flog/params_formattable.rb
 - lib/flog/payload_value_shuntable.rb
 - lib/flog/sql_formattable.rb