rails-flog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2e219154b03727ea2a4b7f3fb3ae97258085dbe
+  data.tar.gz: 8e87fe2fc6ce0ed022482168d7776b3e5f8e1c24
+SHA512:
+  metadata.gz: e6510bf8585735c1ddf0af141c922ef804f295d88e7efc66975d259f285c9cbb35b0935958889647ac24cf5c107bbdc7a0da8223404cb9232aeba89bf1f38ac0
+  data.tar.gz: cbab9d2ade5b65ecd88cf05b92ddd6aaf80b52cddb09b58c3caa9be2a17b0f2a121ca28e80b966c166cfca13ffd459d6878e13d7e87caf510f88a7d00f0ec898

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - gemfiles/activemodel_3_2_x.gemfile
+  - gemfiles/activemodel_4_0_x.gemfile

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails-flog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 pinzolo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# rails-flog
+
+[![Build Status](https://secure.travis-ci.org/pinzolo/rails-flog.png)](http://travis-ci.org/pinzolo/rails-flog)
+[![Coverage Status](https://coveralls.io/repos/pinzolo/rails-flog/badge.png)](https://coveralls.io/r/pinzolo/rails-flog)
+
+rails-flog provides feature that formats parameters Hash and SQL in Rails log file.
+
+## Before and after (Sampla app: Redmine)
+
+### Before (Default)
+
+```
+# 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
+```
+
+### After (Use rails-flog)
+
+```
+# 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
+```
+
+## Installation
+
+Add this line to your application's Gemfile:  
+(Recommendation: use only `:development` and `:test` enviroment)
+
+    gem 'rails-flog', :require => "flog"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-flog
+
+## Usage
+
+Just install.
+
+## Supported versions
+
+- Ruby: 1.9.3, 2.0.0
+- Rails: 3.2.x, 4.0.x
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Thanks
+
+- [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

data/Rakefile

@@ -0,0 +1,8 @@
+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")
+end

data/gemfiles/activemodel_3_2_x.gemfile

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

data/gemfiles/activemodel_4_0_x.gemfile

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

data/lib/flog.rb

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

data/lib/flog/params_formattable.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+require "action_controller/log_subscriber"
+require "awesome_print"
+require "flog/payload_value_shuntable"
+
+class ActionController::LogSubscriber
+  include PayloadValueShuntable
+
+  alias :original_start_processing :start_processing
+
+  def start_processing(event)
+    replaced = replace_params(event.payload[:params])
+
+    shunt_payload_value(event.payload, :params, replaced) do
+      original_start_processing(event)
+    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
+      end
+    end
+    replaced
+  end
+end

data/lib/flog/payload_value_shuntable.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+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)
+      end
+    end
+  end
+end

data/lib/flog/sql_formattable.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+require "active_record/log_subscriber"
+require "flog/payload_value_shuntable"
+
+class ActiveRecord::LogSubscriber
+  include PayloadValueShuntable
+
+  alias :original_sql :sql
+
+  def sql(event)
+    formatted = format_sql(event.payload[:sql])
+
+    shunt_payload_value(event.payload, :sql, "\n\t#{formatted}") do
+      original_sql(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
+    %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
+end

data/lib/flog/version.rb

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

data/rails-flog.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-flog"
+  spec.version       = Flog::VERSION
+  spec.authors       = ["pinzolo"]
+  spec.email         = ["pinzolo@gmail.com"]
+  spec.description   = %q{This formats parameters and sql in rails log.}
+  spec.summary       = %q{Rails log formatter for parameters and sql}
+  spec.homepage      = "https://github.com/pinzolo/rails-flog"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "coveralls"
+
+  spec.add_dependency "rails", ">=3.2.0"
+  spec.add_dependency "anbt-sql-formatter"
+  spec.add_dependency "awesome_print"
+end

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+require "coveralls"
+require "simplecov"
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/bundle/'
+end
+
+Bundler.require
+require "flog"
+require "test/unit"
+
+class TestLogger
+  attr_accessor :debugs, :infos, :errors
+
+  def initialize
+    @debugs = []
+    @infos = []
+    @errors = []
+  end
+
+  def debug?
+    true
+  end
+
+  def info?
+    true
+  end
+
+  def debug(message)
+    @debugs += message.split("\n")
+  end
+
+  def info(message)
+    @infos += message.split("\n")
+  end
+
+  def error(message)
+    @errors += message.split("\n")
+  end
+end

data/test/unit/params_formattable_test.rb

@@ -0,0 +1,72 @@
+# coding: utf-8
+require "action_controller"
+require "test_helper"
+
+class TestController < ActionController::Base
+  def initialize(routes)
+    @routes = routes
+  end
+
+  def _routes
+    @routes
+  end
+
+  def show
+    render nothing: true
+  end
+end
+
+class ParamsFormattableTest < ActionController::TestCase
+  def setup
+    @old_logger = ActionController::Base.logger
+    ActiveSupport::LogSubscriber.colorize_logging = false
+    @routes = ActionDispatch::Routing::RouteSet.new
+    @routes.draw do
+        get "test/show", to: "test#show"
+      end
+    @controller = TestController.new(@routes)
+    super
+    ActionController::Base.logger = TestLogger.new
+  end
+
+  def teardown
+    super
+    ActionController::Base.logger = @old_logger
+  end
+
+  def test_parameters_log_is_formatted
+    get :show, foo: "foo_value", bar: "bar_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" => "bar_value") , logs[4]
+      assert_equal %(})                        , logs[5]
+    end
+  end
+
+  def test_colorized_on_colorize_loggin_is_true
+    ActiveSupport::LogSubscriber.colorize_logging = true
+    get :show, foo: "foo_value", bar: "bar_value"
+    assert_logger do |logger|
+      assert /\e\[(\d+;)*\d+m/.match(logger.infos.join())
+    end
+  end
+
+  def test_not_colorized_on_colorize_loggin_is_false
+    get :show, foo: "foo_value", bar: "bar_value"
+    assert_logger do |logger|
+      assert_nil /\e\[(\d+;)*\d+m/.match(logger.infos.join())
+    end
+  end
+
+  private
+  def assert_logger(&block)
+    if ActionController::Base.logger.errors.present?
+      fail ActionController::Base.logger.errors.first
+    else
+      block.call(ActionController::Base.logger)
+    end
+  end
+end

data/test/unit/payload_value_shuntable_test.rb

@@ -0,0 +1,57 @@
+# coding: utf-8
+require "test_helper"
+
+class TestClass
+  include PayloadValueShuntable
+end
+
+class PayloadValueShuntableTest < ActiveSupport::TestCase
+  def setup
+    @tester = TestClass.new
+    @payload = { foo: "foo_value", bar: "bar_value" }
+  end
+
+  def test_shunt_payload_value
+    @tester.shunt_payload_value(@payload, :foo, "new_value") do
+      assert_equal "new_value", @payload[:foo]
+    end
+  end
+
+  def test_value_of_other_key_is_not_changed
+    @tester.shunt_payload_value(@payload, :foo, "new_value") do
+      assert_equal "bar_value", @payload[:bar]
+    end
+  end
+
+  def test_restoration
+    @tester.shunt_payload_value(@payload, :foo, "new_value") do
+      assert_equal "new_value", @payload[:foo]
+    end
+    assert_equal "foo_value", @payload[:foo]
+  end
+
+  def test_ensure_restoration_on_error_raised_in_block
+    error_raised = false
+    begin
+      @tester.shunt_payload_value(@payload, :foo, "new_value") do
+        raise "error"
+      end
+    rescue => ex
+      error_raised = true
+    end
+    assert error_raised
+    assert_equal "foo_value", @payload[:foo]
+  end
+
+  def test_without_block
+    @tester.shunt_payload_value(@payload, :foo, "new_value")
+    assert_equal "foo_value", @payload[:foo]
+  end
+
+  def test_key_removed_when_give_not_exist_key
+    @tester.shunt_payload_value(@payload, :baz, "new_value") do
+      assert_equal "new_value", @payload[:baz]
+    end
+    assert_equal false, @payload.key?(:baz)
+  end
+end

data/test/unit/sql_formattable_test.rb

@@ -0,0 +1,63 @@
+# coding: utf-8
+require "active_record"
+require "test_helper"
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+ActiveRecord::Schema.define version: 0 do
+  create_table :books, force: true do |t|
+    t.string :name
+    t.string :category
+  end
+end
+
+class Book < ActiveRecord::Base; end
+
+class SqlFormattableTest < ActiveSupport::TestCase
+  def setup
+    @old_logger = ActiveRecord::Base.logger
+    ActiveSupport::LogSubscriber.colorize_logging = false
+    ActiveRecord::Base.logger = TestLogger.new
+  end
+
+  def teardown
+    ActiveRecord::Base.logger = @old_logger
+  end
+
+  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_equal %{        "books" . "category" = 'comics'}, logs[6]
+    end
+  end
+
+  def test_colorized_on_colorize_loggin_is_true
+    ActiveSupport::LogSubscriber.colorize_logging = true
+    Book.where(category: "comics").to_a
+    assert_logger do |logger|
+      assert /\e\[(\d+;)*\d+m/.match(logger.debugs.join())
+    end
+  end
+
+  def test_not_colorized_on_colorize_loggin_is_false
+    Book.where(category: "comics").to_a
+    assert_logger do |logger|
+      assert_nil /\e\[(\d+;)*\d+m/.match(logger.debugs.join())
+    end
+  end
+
+  private
+  def assert_logger(&block)
+    if ActiveRecord::Base.logger.errors.present?
+      fail ActiveRecord::Base.logger.errors.first
+    else
+      block.call(ActiveRecord::Base.logger)
+    end
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: rails-flog
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- pinzolo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: sqlite3
+  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: coveralls
+  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
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: anbt-sql-formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This formats parameters and sql in rails log.
+email:
+- pinzolo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/activemodel_3_2_x.gemfile
+- gemfiles/activemodel_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/version.rb
+- rails-flog.gemspec
+- test/test_helper.rb
+- test/unit/params_formattable_test.rb
+- test/unit/payload_value_shuntable_test.rb
+- test/unit/sql_formattable_test.rb
+homepage: https://github.com/pinzolo/rails-flog
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Rails log formatter for parameters and sql
+test_files:
+- test/test_helper.rb
+- test/unit/params_formattable_test.rb
+- test/unit/payload_value_shuntable_test.rb
+- test/unit/sql_formattable_test.rb