rails-flog 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ea548e225007f44c586d46f6eb80e223a8e3811b
-  data.tar.gz: a75ec850a8e3791b4f2f989751d2e50995a16def
+SHA256:
+  metadata.gz: a916ad1e90e6cc5129639360c15c13638e014c5c3ab60ae03e5a68b38f8601e5
+  data.tar.gz: 271eab7f87be9bb46ffdb028732bd244f76b933b1fe6bda290b199050cdbee68
 SHA512:
-  metadata.gz: 7493abeb100a8b089fca0431e99fbb7e0e9b57ab5781cf7bb2d575ed0ae709add8f70c9c24be1e18cb3f857f18299129a3bcb7db1248840358af4160886bf978
-  data.tar.gz: 83f43ad891a50b08948aae9cdee9c4874abbc3c9951fa6ac01051d663a2d8245b9e50c3907f71e60d5f9caa16bb48058671b64eebc48a28df420672f4e7c6ea7
+  metadata.gz: 5f8b98fff00f12bb337573c9fe988e65596d6ce76ffd43defc7b5651286675049741b41d6dd03f3da6216e3b68e371f2bce60b1173c8ec3175a0a91be12d98cd
+  data.tar.gz: cfe53e680ac6ed2d86eee1e30e14350bbdfe00bbb7e9910345aef5b72ee20bb9d6766870d1c7a3747014dbb2758379b7b1447c5f38ba6540e21ec95f8d8de7a5

data/.gitignore

@@ -16,3 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 vendor/bundle
+
+.idea

data/.travis.yml

@@ -1,25 +1,14 @@
 language: ruby
 sudo: false
+branches:
+  only:
+    - master
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
   - 2.3
   - 2.4
+  - 2.5
 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
+  - gemfiles/rails_5_2_x.gemfile

data/README.md

@@ -126,8 +126,8 @@ Priority of this feature is higher than configurations.
 
 ## Supported versions
 
-- Ruby: 2.0.x, 2.1.x, 2.2.x
-- Rails: 3.2.x, 4.0.x, 4.1.x, 4.2.x
+- Ruby: 2.3.x, 2.4.x, 2.5.x
+- Rails: 4.2.x, 5.0.x, 5.1.x, 5.2.x
 
 ## Contributing
 
@@ -148,3 +148,4 @@ 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.

data/gemfiles/{rails_4_0_x.gemfile → rails_5_2_x.gemfile}

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

data/lib/flog/configuration.rb

@@ -1,13 +1,19 @@
+require "anbt-sql-formatter/rule"
+
 module Flog
+  ONELINE_IN_VALUES_NUM = ::AnbtSql::Rule::ONELINE_IN_VALUES_NUM
+
   class Configuration
     attr_writer :ignore_cached_query, :force_on_nested_params
-    attr_accessor :query_duration_threshold, :params_key_count_threshold
+    attr_accessor :query_duration_threshold, :params_key_count_threshold, :sql_indent, :sql_in_values_num
 
     def initialize
       @ignore_cached_query = true
       @query_duration_threshold = 0.0
       @params_key_count_threshold = 1
       @force_on_nested_params = true
+      @sql_indent = "\t"
+      @sql_in_values_num = 1
     end
 
     def ignore_cached_query?
@@ -24,6 +30,8 @@ module Flog
   end
 
   def self.configure
-    yield(config) if block_given?
+    cfg = Flog::Configuration.new
+    yield(cfg) if block_given?
+    @@config = cfg
   end
 end

data/lib/flog/sql_formattable.rb

@@ -9,22 +9,24 @@ module Flog::SqlFormattable
 
     formatted = format_sql(event.payload[:sql])
 
-    shunt_payload_value(event.payload, :sql, "\n\t#{formatted}") do
+    shunt_payload_value(event.payload, :sql, "\n#{Flog.config.sql_indent}#{formatted}") do
       super(event)
     end
   end
 
   private
+
   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
     end
-    rule.indent_string = "\t"
     AnbtSql::Formatter.new(rule).format(sql.squeeze(" "))
   end
 

data/lib/flog/version.rb

@@ -1,3 +1,3 @@
 module Flog
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/rails-flog.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "coveralls"
 
-  spec.add_dependency "rails", ">=3.2.0"
-  spec.add_dependency "anbt-sql-formatter"
+  spec.add_dependency "rails", ">=4.2.0"
+  spec.add_dependency "anbt-sql-formatter", ">=0.0.7"
   spec.add_dependency "awesome_print"
 end

data/test/unit/sql_formattable_test.rb

@@ -32,13 +32,12 @@ class SqlFormattableTest < ActiveSupport::TestCase
   def test_sql_is_formatted
     Book.where(category: "comics").to_a
     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 logs[6].start_with?(%{        "books" . "category" = })
+      assert_equal %{\tSELECT}       , logger.debugs[1]
+      assert_equal %{\t\t"books" . *}, logger.debugs[2]
+      assert_equal %{\tFROM}         , logger.debugs[3]
+      assert_equal %{\t\t"books"}    , logger.debugs[4]
+      assert_equal %{\tWHERE}        , logger.debugs[5]
+      assert logger.debugs[6].start_with?(%{\t\t"books" . "category" = })
     end
   end
 
@@ -81,8 +80,7 @@ class SqlFormattableTest < ActiveSupport::TestCase
       Book.where(category: "comics").to_a
     end
     assert_logger do |logger|
-      logs = logger.debugs.map { |log| log.gsub("\t", "    ") }
-      logs.each do |log|
+      logger.debugs.each do |log|
         assert_one_line_sql log if log.include?("CACHE")
       end
     end
@@ -97,8 +95,7 @@ class SqlFormattableTest < ActiveSupport::TestCase
       Book.where(category: "comics").to_a
     end
     assert_logger do |logger|
-      logs = logger.debugs.map { |log| log.gsub("\t", "    ") }
-      logs.each do |log|
+      logger.debugs.each do |log|
         assert_equal log.include?("SELECT"), false if log.include?("CACHE")
       end
     end
@@ -114,6 +111,72 @@ class SqlFormattableTest < ActiveSupport::TestCase
     end
   end
 
+  def test_2space_indent
+    Flog.configure do |config|
+      config.sql_indent = "  "
+    end
+    Book.where(category: "comics").to_a
+    assert_logger do |logger|
+      assert_equal %{  SELECT}       , logger.debugs[1]
+      assert_equal %{    "books" . *}, logger.debugs[2]
+      assert_equal %{  FROM}         , logger.debugs[3]
+      assert_equal %{    "books"}    , logger.debugs[4]
+      assert_equal %{  WHERE}        , logger.debugs[5]
+      assert logger.debugs[6].start_with?(%{    "books" . "category" = })
+    end
+  end
+
+  def test_default_in_values_num
+    Book.where(id: (1..10).to_a).to_a
+    assert_logger do |logger|
+      assert_equal %{\tSELECT}               , logger.debugs[1]
+      assert_equal %{\t\t"books" . *}        , logger.debugs[2]
+      assert_equal %{\tFROM}                 , logger.debugs[3]
+      assert_equal %{\t\t"books"}            , logger.debugs[4]
+      assert_equal %{\tWHERE}                , logger.debugs[5]
+      assert_equal %{\t\t"books" . "id" IN (}, logger.debugs[6]
+      (8..16).each do |l|
+        assert_equal 1, logger.debugs[l].count(",")
+      end
+      assert logger.debugs[17].start_with?(%{\t\t)})
+    end
+  end
+
+  def test_in_values_num_set
+    Flog.configure do |config|
+      config.sql_in_values_num = 5
+    end
+    Book.where(id: (1..10).to_a).to_a
+    assert_logger do |logger|
+      assert_equal %{\tSELECT}               , logger.debugs[1]
+      assert_equal %{\t\t"books" . *}        , logger.debugs[2]
+      assert_equal %{\tFROM}                 , logger.debugs[3]
+      assert_equal %{\t\t"books"}            , logger.debugs[4]
+      assert_equal %{\tWHERE}                , logger.debugs[5]
+      assert_equal %{\t\t"books" . "id" IN (}, logger.debugs[6]
+      assert_equal 4, logger.debugs[7].count(",")
+      assert_equal 5, logger.debugs[8].count(",")
+      assert logger.debugs[9].start_with?(%{\t\t)})
+    end
+  end
+
+  def test_oneline_in_values
+    Flog.configure do |config|
+      config.sql_in_values_num = Flog::ONELINE_IN_VALUES_NUM
+    end
+    Book.where(id: (1..10).to_a).to_a
+    assert_logger do |logger|
+      assert_equal %{\tSELECT}               , logger.debugs[1]
+      assert_equal %{\t\t"books" . *}        , logger.debugs[2]
+      assert_equal %{\tFROM}                 , logger.debugs[3]
+      assert_equal %{\t\t"books"}            , logger.debugs[4]
+      assert_equal %{\tWHERE}                , logger.debugs[5]
+      assert_equal %{\t\t"books" . "id" IN (}, logger.debugs[6]
+      assert_equal 9, logger.debugs[7].count(",")
+      assert logger.debugs[8].start_with?(%{\t\t)})
+    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.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - pinzolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: anbt-sql-formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -136,12 +136,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- 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
+- gemfiles/rails_5_2_x.gemfile
 - lib/flog.rb
 - lib/flog/configuration.rb
 - lib/flog/params_formattable.rb
@@ -176,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rails log formatter for parameters and sql

data/gemfiles/rails_3_2_x.gemfile

@@ -1,10 +0,0 @@
-source "https://rubygems.org"
-
-gem "rails", "~> 3.2.0"
-
-group :test do
-  gem "minitest", "~> 4.7.5"
-  gem "test-unit", "~> 3.0"
-end
-
-gemspec :path => "../"

data/gemfiles/rails_4_1_x.gemfile

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