mysql2-client-general_log 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7907d24a201269f7dfb4ae92af5ca21aad26ea88
+  data.tar.gz: 0ba19040ab8c4af8072e99f9335c6d4ae0a0a9a6
+SHA512:
+  metadata.gz: d4e06a1aea6fb7c9a2cef757775fdaa789833d9bbfce8a3cfe774de0a655d78425faf75830df556f39ba1af695694537f31f38ee00a20bb1f526a8bbcf118323
+  data.tar.gz: 0e0a1934181b98297d9f51ce6d82afebd112b2a4b796201f4daae81014778ded6c5adc42114ed9b50dfa43d506e70517e2051edd393ece287c9968e26348f301

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.7
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 ksss
+
+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,70 @@
+Mysql2::Client::GeneralLog
+===
+
+[![Build Status](https://travis-ci.org/ksss/mysql2-client-general_log.svg?branch=v0.1.0)](https://travis-ci.org/ksss/mysql2-client-general_log)
+
+A monkey patch for Mysql2.
+Stock all general logs.
+
+```ruby
+#! /usr/bin/env ruby
+
+require "mysql2/client/general_log"
+
+client = Mysql2::Client.new(config)
+client.query("SELECT * FROM users LIMIT 1")
+
+p client.general_log #=>
+# [
+#   #<struct Mysql2::Client::GeneralLog::Log
+#     sql="SELECT * FROM users LIMIT 1",
+#     backtrace=["script.rb:6:in `<main>'"],
+#     time=0.0909838349907659>
+# ]
+```
+
+## Examples
+
+### sinatra
+
+```ruby
+helpers do
+  def db
+    Thread.current[:db] ||= Mysql2::Client.new(config)
+  end
+end
+
+get '/' do
+  # ...
+end
+
+after do
+  puts db.general_log.map(&:sql)
+  puts "path:#{request.path}\tsql:#{db.general_log.length}"
+  db.general_log.clear
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql2-client-general_log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mysql2-client-general_log
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mysql2-client-general_log. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :test do
+  sh "rgot -v #{Dir.glob("lib/**/*_test.rb").join(' ')}"
+end
+
+task :default => [:test]

data/lib/mysql2/client/general_log.rb

@@ -0,0 +1,35 @@
+require "mysql2"
+require 'benchmark'
+
+module Mysql2
+  class Client
+    module GeneralLog
+      require "mysql2/client/general_log/version"
+
+      class Log < Struct.new(
+        :sql,
+        :backtrace,
+        :time,
+      ); end
+
+      attr_accessor :general_log
+
+      def initialize(opts = {})
+        @general_log = []
+        super
+      end
+
+      # dependent on Mysql2::Client#query
+      def query(sql, options={})
+        ret = nil
+        time = Benchmark.realtime do
+          ret = super
+        end
+        @general_log << Log.new(sql, caller_locations, time)
+        ret
+      end
+    end
+
+    prepend GeneralLog
+  end
+end

data/lib/mysql2/client/general_log/version.rb

@@ -0,0 +1,7 @@
+module Mysql2
+  class Client
+    module GeneralLog
+      VERSION = "0.2.1"
+    end
+  end
+end

data/lib/mysql2/client/general_log_test.rb

@@ -0,0 +1,86 @@
+require "mysql2/client/general_log"
+
+module Mysql2ClientGeneralLogTest
+  def test_main(m)
+    @client = Mysql2::Client.new(
+      host: "127.0.0.1",
+      username: "root",
+    )
+    exit m.run
+    @client.query("DROP DATABASE IF EXISTS `mysql2_client_general_log_test`")
+  end
+
+  def db_init
+    @client.query("DROP DATABASE IF EXISTS `mysql2_client_general_log_test`")
+    @client.query("CREATE DATABASE `mysql2_client_general_log_test`")
+    @client.query("USE `mysql2_client_general_log_test`")
+    @client.query(<<-SQL)
+CREATE TABLE users (
+  `id` int NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  `name` varchar(255) NOT NULL UNIQUE,
+  `password` varchar(255) NOT NULL
+);
+SQL
+    @client.query(<<-SQL)
+INSERT INTO `users` (`name`, `password`)
+       VALUES ('ksss', 'cheap-pass'),
+              ('foo', 'fooo'),
+              ('bar', 'barr')
+;
+SQL
+    @client.general_log.clear
+  end
+
+  def e(s)
+    Mysql2::Client.escape(s)
+  end
+
+  def test_init(t)
+    if !@client.general_log.kind_of?(Array)
+      t.error("initial value expect Array class got #{@client.general_log.class}")
+    end
+    if !@client.general_log.empty?
+      t.error("initial value expect [] got #{@client.general_log}")
+    end
+  end
+
+  def test_values(t)
+    db_init
+    ret = @client.query("SELECT * FROM users WHERE name = '#{e("ksss")}'").first
+    @client.query("SELECT * FROM users WHERE name = '#{e("barr")}'")
+    @client.query("SELECT * FROM users WHERE name = '#{e("foo")}'")
+
+    if @client.general_log.length != 3
+      t.error("expect log length 3 got #{@client.general_log.length}")
+    end
+    if @client.general_log.any?{|log| !log.kind_of?(Mysql2::Client::GeneralLog::Log)}
+      t.error("expect all collection item is instance of Mysql2::Client::GeneralLog::Log got #{@client.general_log.map(&:class).uniq}")
+    end
+    expect = {"id"=>1, "name"=>"ksss", "password"=>"cheap-pass"}
+    if ret != expect
+      t.error("expect query output not change from #{expect} got #{ret}")
+    end
+  end
+
+  def test_log_class(t)
+    if Mysql2::Client::GeneralLog::Log.members != [:sql, :backtrace, :time]
+      t.error("expect Mysql2::Client::GeneralLog::Log.members is [:sql, :backtrace, :time] got #{Mysql2::Client::GeneralLog::Log.members}")
+    end
+  end
+
+  def example_general_log
+    db_init
+    @client.query("SELECT * FROM users WHERE name = '#{e("ksss")}'")
+    @client.query("SELECT * FROM users WHERE name = '#{e("barr")}'")
+    @client.query("SELECT * FROM users WHERE name = '#{e("foo")}'")
+    puts @client.general_log.map{|log| log.sql}
+    puts @client.general_log.map{|log| log.backtrace.find{|c| %r{/gems/} !~ c.to_s}.to_s.gsub(/.*?:/, '')}
+    # Output:
+    # SELECT * FROM users WHERE name = 'ksss'
+    # SELECT * FROM users WHERE name = 'barr'
+    # SELECT * FROM users WHERE name = 'foo'
+    # in `example_general_log'
+    # in `example_general_log'
+    # in `example_general_log'
+  end
+end

data/mysql2-client-general_logs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+File.read('lib/mysql2/client/general_log/version.rb') =~ /.*VERSION\s*=\s*['"](.*?)['"]\s.*/
+version = $1
+
+Gem::Specification.new do |spec|
+  spec.name          = "mysql2-client-general_log"
+  spec.version       = version
+  spec.authors       = ["ksss"]
+  spec.email         = ["co000ri@gmail.com"]
+
+  spec.summary       = %q{Simple stocker general log for mysql2 gem.}
+  spec.description   = %q{Simple stocker general log for mysql2 gem.}
+  spec.homepage      = "https://github.com/ksss/mysql2-client-general_log"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "mysql2"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rgot"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: mysql2-client-general_log
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- ksss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rgot
+  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: Simple stocker general log for mysql2 gem.
+email:
+- co000ri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mysql2/client/general_log.rb
+- lib/mysql2/client/general_log/version.rb
+- lib/mysql2/client/general_log_test.rb
+- mysql2-client-general_logs.gemspec
+homepage: https://github.com/ksss/mysql2-client-general_log
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Simple stocker general log for mysql2 gem.
+test_files: []