active_record-mod_sql_log_subscriber 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cab5693d0baabd7697dba145864541d835fc0a82c7f89b5e078ff321b6af8147
+  data.tar.gz: 327dc2c516057842f48b4a26189705898f84e918c15101c44072d67252f4d861
+SHA512:
+  metadata.gz: 6913d322729c0f5d503475489c0ee47e3e908262f3998f1347364f2198f59a5cfd8c0e015031328eb12fdc1140b0444ad57de7477f9c775f57955dd25f85e47f
+  data.tar.gz: 12de01f66bdc5496be9fb46a3d1c994b95ea371464cf851daf1336a7bdf47a1393bfef0794ea999f7e4bcaada01afaf6cf1897c3047d178099ca8185d9df8697

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+.ruby-version
+.rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dev.ryu39@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_record-mod_sql_log_subscriber.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ryu39
+
+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,166 @@
+# ActiveRecord::ModSqlLogSubscriber
+
+An ActiveRecord::LogSubscriber which records only mod-SQL logs.
+
+The mod-SQL is shown as follows.
+
+* INSERT
+* UPDATE
+* DELETE
+* TRUNCATE
+* BEGIN
+* COMMIT
+* ROLLBACK
+* SAVEPOINT
+* RELEASE SAVEPOINT
+* ROLLBACK TO SAVEPOINT
+
+## Motivation
+
+* SQL logs are useful for trouble shooging.
+* Especialy, mod-SQL(INSERT, UPDATE, DELETE, ...) logs are very important to know what occurred in app.
+* Rails provides SQL logging feature only by settings `Rails.logger` log level to `:debug`.
+* But this settings writes a lot of `SELECT` statement SQL logs.
+  These logs are very noisy and use many disk space.
+* I want to write logs only mod-SQL(INSERT, UPDATE, DELETE, ...) and transaction SQL(BEGIN, COMMIT, ROLLBACK, ...).
+  So I create this gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record-mod_sql_log_subscriber'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_record-mod_sql_log_subscriber
+
+## Usage
+
+Create a file under`config/initializer`, configure log subscriber, 
+and attach to :active_record namespace.
+
+```
+require 'active_record/mod_sql_log_subscriber'
+
+::ActiveRecord::ModSqlLogSubscriber.configure do |config|
+  config.disable = ::ActiveRecord::Base.logger.debug? # Recommended
+end
+
+::ActiveRecord::ModSqlLogSubscriber.attach_to(:active_record)
+```
+
+Next restart your app, then your app starts to log mod-SQLs.
+
+Here is rails console examples.
+
+```
+$ rails c
+
+> ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+> user = User.find(1); nil # Do not logging
+
+> user.update_attributes(name: 'New name'); nil # Do logging
+# => "UPDATE users SET name = 'New name' WHERE id = $1  {:id=>1}"
+```
+
+## Configuration
+
+You can configure this subscriber before attaching to :active_record namespace
+
+```
+::ActiveRecord::ModSqlLogSubscriber.configure do |config|
+  config.disable = true
+  config.log_level = :warn
+  config.log_format = :json
+  # config.log_format = ->(sql, binds) { 'your code here' }
+  config.target_statements << 'merge'
+end
+
+# You must attach subscriber after configuraton.
+::ActiveRecord::ModSqlLogSubscriber.attach_to(:active_record)
+```
+
+### Enable/Disable
+
+You can make log subscriber enbaled/disabled via config. Default is enabled.
+This is useful in development/test env because duplicated sql logs are written in log in this env.
+
+```
+::ActiveRecord::ModSqlLogSubscriber.configure do |config|
+  config.disable = false # enabled
+  config.disable = true # disabled
+  
+  config.disable = ::ActiveRecord::Base.logger.debug? # Recommended
+end
+```
+
+### Log level
+
+You can change log level. Default is :info.
+
+```
+::ActiveRecord::ModSqlLogSubscriber.configure do |config|
+  config.log_level = :warn
+  # config.log_level = :error
+  # config.log_level = :fatal
+end
+```
+
+### Log format
+
+You can select log format as follows, or use a custom Proc object.
+
+* `:text` (Default)
+* `:json`
+* `:hash`
+* Proc object
+
+### Target statement
+
+You can add/change/remove target SQL statements.
+
+```
+::ActiveRecord::ModSqlLogSubscriber.configure do |config|
+  # Add MERGE SQL
+  config.target_statements << 'merge' 
+  
+  # Remove BEGIN SQL
+  config.target_stagements.delete('begin')
+  
+  # Orverwite your target statements
+  config.target_statements = %w(insert update delete)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+To release a new version, update the version number in `mod_sql_log_subscriber.r`, 
+and then run `bundle exec rake release`, which will create a git tag for the version, 
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryu39/active_record-mod_sql_log_subscriber. 
+This project is intended to be a safe, welcoming space for collaboration, 
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveRecord::ModSqlLogSubscriber project’s codebases, issue trackers, 
+chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ryu39/active_record-mod_sql_log_subscriber/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/active_record-mod_sql_log_subscriber.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record/mod_sql_log_subscriber"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record-mod_sql_log_subscriber"
+  spec.version       = ActiveRecord::ModSqlLogSubscriber::VERSION
+  spec.authors       = ["ryu39"]
+  spec.email         = ["dev.ryu39@gmail.com"]
+
+  spec.summary       = %q{An ActiveRecord::LogSubscriber which records only mod sql.}
+  spec.description   = %q{An ActiveRecord::LogSubscriber which records only mod sql.}
+  spec.homepage      = "https://github.com/ryu39/active_record-mod_sql_log_subscriber"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", '>= 5.1.5'
+  spec.add_runtime_dependency "activerecord", '>= 5.1.5'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record/mod_sql_log_subscriber"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record/mod_sql_log_subscriber.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'active_support/configurable'
+require 'active_support/log_subscriber'
+require 'active_record'
+require 'active_record/log_subscriber'
+
+module ActiveRecord
+  class ModSqlLogSubscriber < ::ActiveRecord::LogSubscriber
+    include ActiveSupport::Configurable
+
+    VERSION = "0.0.1"
+
+    config_accessor :disable, :log_level, :log_format, :target_statements
+
+    # Default values
+    self.disable = false
+    self.log_level = :info
+    self.log_format = :text
+    self.target_statements = %w(insert update delete truncate begin commit rollback savepoint release\ savepoint)
+
+    def sql(event)
+      return if self.disable
+
+      payload = event.payload
+      sql = payload[:sql]
+
+      return if sql.nil?
+      return if payload[:cached]
+      return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+      return unless target_sql_checker.match?(sql)
+
+      binds = extract_binds(payload)
+      send(self.log_level, formatter.call(sql, binds))
+    end
+
+    private
+
+    def target_sql_checker
+      @target_sql_checker ||= /\A\s*(#{self.target_statements.join('|')})/mi
+    end
+
+    def extract_binds(payload)
+      binds = {}
+      unless (payload[:binds] || []).empty?
+        casted_params = type_casted_binds(payload[:type_casted_binds])
+        payload[:binds].zip(casted_params).map do |attr, value|
+          key, val = render_bind(attr, value)
+          binds[key] = val
+        end
+      end
+      binds
+    end
+
+    def formatter
+      @formatter ||=
+        case self.log_format
+        when :text
+          ->(sql, binds) { binds.empty? ? sql : "#{sql}  #{binds.inspect}" }
+        when :json
+          -> (sql, binds) { ::JSON.generate(sql: sql, binds: binds) }
+        when :hash
+          -> (sql, binds) { { sql: sql, binds: binds } }
+        when ::Proc
+          self.log_format
+        else
+          raise "Unexpected log format: #{self.log_format}"
+        end
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: active_record-mod_sql_log_subscriber
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ryu39
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: An ActiveRecord::LogSubscriber which records only mod sql.
+email:
+- dev.ryu39@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record-mod_sql_log_subscriber.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/mod_sql_log_subscriber.rb
+homepage: https://github.com/ryu39/active_record-mod_sql_log_subscriber
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ryu39/active_record-mod_sql_log_subscriber
+  source_code_uri: https://github.com/ryu39/active_record-mod_sql_log_subscriber
+  changelog_uri: https://github.com/ryu39/active_record-mod_sql_log_subscriber
+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.7.6
+signing_key: 
+specification_version: 4
+summary: An ActiveRecord::LogSubscriber which records only mod sql.
+test_files: []