rails-flog 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2e219154b03727ea2a4b7f3fb3ae97258085dbe
-  data.tar.gz: 8e87fe2fc6ce0ed022482168d7776b3e5f8e1c24
+  metadata.gz: 57c68ce2bbb1cb74f3bde72f9f9226ecb4ddd8d3
+  data.tar.gz: 8981369d077b93a3d63a4fff554e01f7b8869487
 SHA512:
-  metadata.gz: e6510bf8585735c1ddf0af141c922ef804f295d88e7efc66975d259f285c9cbb35b0935958889647ac24cf5c107bbdc7a0da8223404cb9232aeba89bf1f38ac0
-  data.tar.gz: cbab9d2ade5b65ecd88cf05b92ddd6aaf80b52cddb09b58c3caa9be2a17b0f2a121ca28e80b966c166cfca13ffd459d6878e13d7e87caf510f88a7d00f0ec898
+  metadata.gz: 026b7737f8ec98e1f1e3749dd00e00eb728728473ba771f836d8cdc2dbb978442ddc2ac691df88be0ec7d5d0749eefe069784b6a85f9761d2777ba5edcce869a
+  data.tar.gz: 081eda06508831663a0874bb5b2be931428e55bb95afec2781ee0be8c41e97d10978851ed9016cc2c4d26a60d6e8076a03ad396ed7c97e830ac82dd6c8d50533

data/.travis.yml

@@ -3,5 +3,5 @@ rvm:
   - 1.9.3
   - 2.0.0
 gemfile:
-  - gemfiles/activemodel_3_2_x.gemfile
-  - gemfiles/activemodel_4_0_x.gemfile
+  - gemfiles/rails_3_2_x.gemfile
+  - gemfiles/rails_4_0_x.gemfile

data/README.md

@@ -13,7 +13,7 @@ rails-flog provides feature that formats parameters Hash and SQL in Rails log fi
 # Parameters
 Processing by IssuesController#create as HTML
   Parameters: {"utf8"=>"✓", "authenticity_token"=>"VYCWAsE+aAN+zSZq2H3ONNqaU8rlyfbnXLfbwDY1i10=", "issue"=>{"is_private"=>"0", "tracker_id"=>"1", "subject"=>"test ticket", "description"=>"test ticket description", "status_id"=>"1", "priority_id"=>"2", "assigned_to_id"=>"1", "parent_issue_id"=>"", "start_date"=>"2013-11-28", "due_date"=>"2013-11-29", "estimated_hours"=>"5", "done_ratio"=>"10"}, "commit"=>"Create", "project_id"=>"test"}
-  
+
 # SQL
   IssueCustomField Load (0.0ms)  SELECT "custom_fields".* FROM "custom_fields" WHERE "custom_fields"."type" IN ('IssueCustomField') AND (is_for_all = 't' OR id IN (SELECT DISTINCT cfp.custom_field_id FROM custom_fields_projects cfp WHERE cfp.project_id = 1)) ORDER BY custom_fields.position ASC
 ```
@@ -46,7 +46,7 @@ Processing by IssuesController#create as HTML
 }
 
 # SQL
-  IssueCustomField Load (0.0ms)  
+  IssueCustomField Load (0.0ms)
 	SELECT
 		"custom_fields" . *
 	FROM
@@ -87,6 +87,10 @@ Or install it yourself as:
 
 Just install.
 
+## Disable temporary
+
+If you put a file named `no-flog.txt` to `<rails_app>/tmp` direcotry, `rails-flog` will disable format.
+
 ## Supported versions
 
 - Ruby: 1.9.3, 2.0.0
@@ -100,8 +104,7 @@ Just install.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## Thanks
+## Changelog
 
-- [awesome_print](https://github.com/michaeldv/awesome_print) : Use format Hash
-- [anbt-sql-formatter](https://github.com/sonota/anbt-sql-formatter) : Use format SQL
-- [yuroyoro](http://yuroyoro.hatenablog.com/entry/2013/04/12/141648) : Inspired
+- 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

data/lib/flog.rb

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

data/lib/flog/params_formattable.rb

@@ -2,13 +2,16 @@
 require "action_controller/log_subscriber"
 require "awesome_print"
 require "flog/payload_value_shuntable"
+require "flog/status"
 
 class ActionController::LogSubscriber
-  include PayloadValueShuntable
+  include Flog::PayloadValueShuntable
 
   alias :original_start_processing :start_processing
 
   def start_processing(event)
+    return original_start_processing(event) unless Flog::Status.enabled?
+
     replaced = replace_params(event.payload[:params])
 
     shunt_payload_value(event.payload, :params, replaced) do

data/lib/flog/payload_value_shuntable.rb

@@ -1,18 +1,20 @@
 # coding: utf-8
-module PayloadValueShuntable
-  def shunt_payload_value(payload, key, temp_value, &block)
-    return unless block
+module Flog
+  module PayloadValueShuntable
+    def shunt_payload_value(payload, key, temp_value, &block)
+      return unless block
 
-    key_exists = payload.key?(key)
-    base_value = payload[key]
-    begin
-      payload[key] = temp_value
-      block.call
-    ensure
-      if key_exists
-        payload[key] = base_value
-      else
-        payload.delete(key)
+      key_exists = payload.key?(key)
+      base_value = payload[key]
+      begin
+        payload[key] = temp_value
+        block.call
+      ensure
+        if key_exists
+          payload[key] = base_value
+        else
+          payload.delete(key)
+        end
       end
     end
   end

data/lib/flog/sql_formattable.rb

@@ -3,11 +3,13 @@ require "active_record/log_subscriber"
 require "flog/payload_value_shuntable"
 
 class ActiveRecord::LogSubscriber
-  include PayloadValueShuntable
+  include Flog::PayloadValueShuntable
 
   alias :original_sql :sql
 
   def sql(event)
+    return original_sql(event) unless Flog::Status.enabled?
+
     formatted = format_sql(event.payload[:sql])
 
     shunt_payload_value(event.payload, :sql, "\n\t#{formatted}") do

data/lib/flog/status.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+require "rails"
+
+module Flog
+  class Status
+    SWITCH_FILE_NAME = "no-flog.txt"
+
+    def self.enabled?
+      !File.exist?(Rails.root.join("tmp", SWITCH_FILE_NAME).to_s)
+    rescue
+      true
+    end
+  end
+end

data/lib/flog/version.rb

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

data/rails-flog.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "mocha"
 
   spec.add_dependency "rails", ">=3.2.0"
   spec.add_dependency "anbt-sql-formatter"

data/test/test_helper.rb

@@ -10,6 +10,7 @@ end
 Bundler.require
 require "flog"
 require "test/unit"
+require "mocha/setup"
 
 class TestLogger
   attr_accessor :debugs, :infos, :errors

data/test/unit/params_formattable_test.rb

@@ -61,6 +61,14 @@ class ParamsFormattableTest < ActionController::TestCase
     end
   end
 
+  def test_parameters_log_is_not_formatted_when_enabled_is_false
+    Flog::Status.expects(:enabled?).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/payload_value_shuntable_test.rb

@@ -2,7 +2,7 @@
 require "test_helper"
 
 class TestClass
-  include PayloadValueShuntable
+  include Flog::PayloadValueShuntable
 end
 
 class PayloadValueShuntableTest < ActiveSupport::TestCase

data/test/unit/sql_formattable_test.rb

@@ -52,6 +52,14 @@ class SqlFormattableTest < ActiveSupport::TestCase
     end
   end
 
+  def test_sql_is_not_formatted_when_enabled_is_false
+    Flog::Status.expects(:enabled?).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

@@ -0,0 +1,41 @@
+# coding: utf-8
+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
+  end
+
+  def test_enabled_is_true_when_switch_file_does_not_exist
+    delete_switch_file
+    assert Flog::Status.enabled?
+  end
+
+  def test_enabled_is_false_when_switch_file_exists
+    Rails.expects(:root).returns(@test_root)
+    create_switch_file
+    assert_equal false, Flog::Status.enabled?
+  end
+
+  def test_enabled_is_true_when_error_is_raised_in_process
+    Rails.expects(:root).returns(nil) # For raise NoMethodError
+    create_switch_file
+    assert Flog::Status.enabled?
+  end
+
+  private
+  def create_switch_file
+    File.open(@switch_file_path, "w").close
+  end
+
+  def delete_switch_file
+    if File.exist?(@switch_file_path)
+      File.delete(@switch_file_path)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-flog
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - pinzolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -122,18 +136,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/activemodel_3_2_x.gemfile
-- gemfiles/activemodel_4_0_x.gemfile
+- gemfiles/rails_3_2_x.gemfile
+- gemfiles/rails_4_0_x.gemfile
 - lib/flog.rb
 - lib/flog/params_formattable.rb
 - lib/flog/payload_value_shuntable.rb
 - lib/flog/sql_formattable.rb
+- lib/flog/status.rb
 - lib/flog/version.rb
 - rails-flog.gemspec
 - test/test_helper.rb
+- test/tmp/.gitkeep
 - test/unit/params_formattable_test.rb
 - test/unit/payload_value_shuntable_test.rb
 - test/unit/sql_formattable_test.rb
+- test/unit/status_test.rb
 homepage: https://github.com/pinzolo/rails-flog
 licenses:
 - MIT
@@ -160,6 +177,8 @@ specification_version: 4
 summary: Rails log formatter for parameters and sql
 test_files:
 - test/test_helper.rb
+- test/tmp/.gitkeep
 - test/unit/params_formattable_test.rb
 - test/unit/payload_value_shuntable_test.rb
 - test/unit/sql_formattable_test.rb
+- test/unit/status_test.rb