rails-flog 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d92f9e5659c4ddc5b1cff2a221c211024678286
-  data.tar.gz: 3f436f911028bb5e1ec6edf651f77c4d4edc6b94
+  metadata.gz: aa2793786fbf497001272ed0f4efd872d07bd6bf
+  data.tar.gz: a0be8008a8f86e3cfa1c98159642cac72dff9827
 SHA512:
-  metadata.gz: dc59c520f5e43959612424651280796903b23f48277e68c7373272d5602c4fcd846efe499b0cc01a7cb92df1313017d1db7b19ec6184e68132bb6bb9fb03e46c
-  data.tar.gz: c4701cef3be35296f50ab97cfd01d782b886b8e7291f667e153fc7a7184f4457ac813695ca9bc73d92d433a250445d49a828aeb6c1217dfebf8173ef1bdbf6e6
+  metadata.gz: 55ea880d7174a20e8aabf0bfd2af712432e2734cef2174c8eb07c7978006ac55af533ddbd3c5811ec82ee588c20f2e1fb8c93b45c9545b050e87b3e9c153a789
+  data.tar.gz: 43093dfa7504fc0da76745e5e8e0e5b8c5ee29a106e2c897e619872cfd93ef62fea0ef5bf128badda3a7c9983a3cea7dafef2643607b9421bf4307bfe4f3c6a2

data/.travis.yml

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

data/README.md

@@ -89,7 +89,13 @@ Just install.
 
 ## Disable temporary
 
-If you put a file named `no-flog.txt` to `<rails_app>/tmp` direcotry, `rails-flog` will disable format.
+If you put a file to `<rails_app>/tmp` direcotry, `rails-flog` will disable format.
+
+|File name          |Feature    |
+|:------------------|:----------|
+|no-flog-sql.txt    |SQL        |
+|no-flog-params.txt |Parameters |
+|no-flog.txt        |Both       |
 
 ## Supported versions
 
@@ -109,3 +115,4 @@ If you put a file named `no-flog.txt` to `<rails_app>/tmp` direcotry, `rails-flo
 - v1.0.0  (2013-11-28 JST):  First release
 - 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

data/gemfiles/rails_4_1_x.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "rails", "~>4.1.0"
+gem "anbt-sql-formatter"
+gem "awesome_print"
+
+gemspec :path => "../"
+

data/lib/flog/params_formattable.rb

@@ -8,7 +8,7 @@ class ActionController::LogSubscriber
   include Flog::PayloadValueShuntable
 
   def start_processing_with_flog(event)
-    return start_processing_without_flog(event) unless Flog::Status.enabled?
+    return start_processing_without_flog(event) unless Flog::Status.params_formattable?
 
     replaced = replace_params(event.payload[:params])
 

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.enabled?
+    return sql_without_flog(event) unless Flog::Status.sql_formattable?
 
     formatted = format_sql(event.payload[:sql])
 

data/lib/flog/status.rb

@@ -4,11 +4,30 @@ require "rails"
 module Flog
   class Status
     SWITCH_FILE_NAME = "no-flog.txt"
+    SQL_SWITCH_FILE_NAME = "no-flog-sql.txt"
+    PARAMS_SWITCH_FILE_NAME = "no-flog-params.txt"
 
     def self.enabled?
-      !File.exist?(Rails.root.join("tmp", SWITCH_FILE_NAME).to_s)
+      !switch_file_exists?(SWITCH_FILE_NAME)
     rescue
       true
     end
+
+    def self.sql_formattable?
+      enabled? && !switch_file_exists?(SQL_SWITCH_FILE_NAME)
+    rescue
+      true
+    end
+
+    def self.params_formattable?
+      enabled? && !switch_file_exists?(PARAMS_SWITCH_FILE_NAME)
+    rescue
+      true
+    end
+
+    private
+    def self.switch_file_exists?(file_name)
+      File.exist?(Rails.root.join("tmp", file_name).to_s)
+    end
   end
 end

data/lib/flog/version.rb

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

data/test/unit/params_formattable_test.rb

@@ -69,6 +69,14 @@ class ParamsFormattableTest < ActionController::TestCase
     end
   end
 
+  def test_parameters_log_is_not_formatted_when_params_formattable_is_false
+    Flog::Status.expects(:params_formattable?).returns(false)
+    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
+
   private
   def assert_logger(&block)
     if ActionController::Base.logger.errors.present?

data/test/unit/sql_formattable_test.rb

@@ -60,6 +60,14 @@ class SqlFormattableTest < ActiveSupport::TestCase
     end
   end
 
+  def test_sql_is_not_formatted_when_sql_formattable_is_false
+    Flog::Status.expects(:sql_formattable?).returns(false)
+    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?

data/test/unit/status_test.rb

@@ -4,11 +4,12 @@ require "rails"
 class StatusTest < ActiveSupport::TestCase
   def setup
     @test_root = Pathname.new(File.expand_path(File.dirname(__FILE__) + "../../"))
-    @switch_file_path = @test_root.join("tmp", Flog::Status::SWITCH_FILE_NAME)
   end
 
   def teardown
     delete_switch_file
+    delete_sql_switch_file
+    delete_params_switch_file
   end
 
   def test_enabled_is_true_when_switch_file_does_not_exist
@@ -17,7 +18,7 @@ class StatusTest < ActiveSupport::TestCase
   end
 
   def test_enabled_is_false_when_switch_file_exists
-    Rails.expects(:root).returns(@test_root)
+    Rails.expects(:root).at_most(2).returns(@test_root)
     create_switch_file
     assert_equal false, Flog::Status.enabled?
   end
@@ -28,14 +29,106 @@ class StatusTest < ActiveSupport::TestCase
     assert Flog::Status.enabled?
   end
 
+  def test_sql_formattable_is_true_when_enable_and_sql_switch_file_does_not_exist
+    Rails.expects(:root).at_most(2).returns(@test_root)
+    delete_switch_file
+    delete_sql_switch_file
+    assert Flog::Status.sql_formattable?
+  end
+
+  def test_sql_formattable_is_false_when_enable_and_sql_switch_file_exists
+    Rails.expects(:root).at_most(2).returns(@test_root)
+    delete_switch_file
+    create_sql_switch_file
+    assert_equal false, Flog::Status.sql_formattable?
+  end
+
+  def test_sql_formattable_is_false_when_disable_and_sql_switch_file_not_exist
+    Rails.expects(:root).at_most(2).returns(@test_root)
+    create_switch_file
+    delete_sql_switch_file
+    assert_equal false, Flog::Status.sql_formattable?
+  end
+
+  def test_sql_formattable_is_true_when_error_is_raised_in_process
+    Rails.expects(:root).at_most(2).returns(nil) # For raise NoMethodError
+    create_sql_switch_file
+    assert Flog::Status.sql_formattable?
+  end
+
+  def test_sql_formattable_is_false_when_disable_and_sql_switch_file_exists
+    Rails.expects(:root).at_most(2).returns(@test_root)
+    create_switch_file
+    create_sql_switch_file
+    assert_equal false, Flog::Status.sql_formattable?
+  end
+
+  def test_params_formattable_is_true_when_enable_and_params_switch_file_does_not_exist
+    Rails.expects(:root).at_most(2).returns(@test_root)
+    delete_switch_file
+    delete_params_switch_file
+    assert Flog::Status.params_formattable?
+  end
+
+  def test_params_formattable_is_false_when_enable_and_params_switch_file_exists
+    Rails.expects(:root).at_most(2).returns(@test_root)
+    delete_switch_file
+    create_params_switch_file
+    assert_equal false, Flog::Status.params_formattable?
+  end
+
+  def test_params_formattable_is_false_when_disable_and_params_switch_file_not_exist
+    Rails.expects(:root).at_most(2).returns(@test_root)
+    create_switch_file
+    delete_params_switch_file
+    assert_equal false, Flog::Status.params_formattable?
+  end
+
+  def test_params_formattable_is_false_when_disable_and_params_switch_file_exists
+    Rails.expects(:root).at_most(2).returns(@test_root)
+    create_switch_file
+    create_params_switch_file
+    assert_equal false, Flog::Status.params_formattable?
+  end
+
+  def test_params_formattable_is_true_when_error_is_raised_in_process
+    Rails.expects(:root).at_most(2).returns(nil) # For raise NoMethodError
+    create_params_switch_file
+    assert Flog::Status.params_formattable?
+  end
+
   private
   def create_switch_file
-    File.open(@switch_file_path, "w").close
+    create_file(@test_root.join("tmp", Flog::Status::SWITCH_FILE_NAME))
   end
 
   def delete_switch_file
-    if File.exist?(@switch_file_path)
-      File.delete(@switch_file_path)
+    delete_file(@test_root.join("tmp", Flog::Status::SWITCH_FILE_NAME))
+  end
+
+  def create_sql_switch_file
+    create_file(@test_root.join("tmp", Flog::Status::SQL_SWITCH_FILE_NAME))
+  end
+
+  def delete_sql_switch_file
+    delete_file(@test_root.join("tmp", Flog::Status::SQL_SWITCH_FILE_NAME))
+  end
+
+  def create_params_switch_file
+    create_file(@test_root.join("tmp", Flog::Status::PARAMS_SWITCH_FILE_NAME))
+  end
+
+  def delete_params_switch_file
+    delete_file(@test_root.join("tmp", Flog::Status::PARAMS_SWITCH_FILE_NAME))
+  end
+
+  def create_file(file_path)
+    File.open(file_path, "w").close
+  end
+
+  def delete_file(file_path)
+    if File.exist?(file_path)
+      File.delete(file_path)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-flog
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - pinzolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-07 00:00:00.000000000 Z
+date: 2014-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,6 +138,7 @@ files:
 - Rakefile
 - gemfiles/rails_3_2_x.gemfile
 - gemfiles/rails_4_0_x.gemfile
+- gemfiles/rails_4_1_x.gemfile
 - lib/flog.rb
 - lib/flog/params_formattable.rb
 - lib/flog/payload_value_shuntable.rb