sql_footprint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ccd5321b9997aec9b2f17886396d7deaf6b90d82
+  data.tar.gz: 5fe7904a9e24961e73a4c8bd356987db3a6b8ff5
+SHA512:
+  metadata.gz: 6d6f53ce634d8d0dbb070b33344797c041bd5524a13aa89f577be4be60a6c965c7234f0f1389e25d2130660e969c0968384289f99c896da427e9928e78f74093
+  data.tar.gz: 2b7f935a0a5ebae662634541cfbcc1829a14e1ddca9bee909644e553e2f6b0dde4a9ad210b9736e32592c4c6e1bebe7e1b4ef16aedb1b263296a984b5c613917

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require: rubocop-rspec
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+Metrics/LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+script:
+  - bundle exec rspec
+  - bundle exec rubocop --display-cop-names
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2

data/Gemfile

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

data/README.md

@@ -0,0 +1,35 @@
+# SqlFootprint [![Build Status](https://travis-ci.org/covermymeds/sql_footprint.svg?branch=master)](https://travis-ci.org/covermymeds/sql_footprint)
+
+This gem allows you to keep a "footprint" of the sql queries that your application runs.
+It's like logging all the sql you're executing except that we remove all the value parameters
+and dedupe similar queries. This footprint should be valuable in determining if changes you've
+made will significantly change the way you're querying the database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sql_footprint', group: [:development, :test]
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Typically, you would want to run this while you're running your specs.
+For example w/ RSpec:
+```
+RSpec.configure do |config|
+  config.before(:suite) { SqlFootprint.start }
+  config.after(:suite) { SqlFootprint.stop }
+end
+```
+
+After running your specs you'll find a 'footprint.sql' file in your project.
+Adding this to your Git repository can be very useful so you can include the diff of the footprint
+as part of your code review.
+
+DO NOT run SqlFootprint in production!

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sql_footprint'
+
+# 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

data/bin/setup

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

data/lib/sql_footprint/version.rb

@@ -0,0 +1,3 @@
+module SqlFootprint
+  VERSION = '0.1.0'.freeze
+end

data/lib/sql_footprint.rb

@@ -0,0 +1,82 @@
+require 'sql_footprint/version'
+
+module SqlFootprint
+  def self.start
+    @original_logger = ActiveRecord::Base.logger
+    @logger = Logger.new
+    ActiveRecord::Base.logger = @logger
+  end
+
+  def self.stop
+    ActiveRecord::Base.logger = @original_logger
+    File.open('footprint.sql', 'w') do |f|
+      @logger.logs.each do |log|
+        f.puts log
+      end
+    end
+  end
+
+  class Logger
+    def initialize
+      @logs = []
+    end
+
+    attr_reader :logs
+
+    def error param
+      raise param
+    end
+
+    def debug text
+      if sql? text
+        sql = format_sql(text)
+        logs << sql unless logs.include?(sql)
+        logs.sort!
+      end
+    end
+
+    def debug?
+      true
+    end
+
+    private
+
+    def sql? text
+      /SQL/.match(text) ||
+        /Load\s\(/.match(text)
+    end
+
+    def format_sql text
+      strip_values(text).split("\e\[0m")
+                        .select { |t| !t.include?('SQL') }
+                        .find { |t| !/Load\s\(/.match(t) }
+                        .gsub(/\e\[1m/, '')
+                        .strip
+    end
+
+    def strip_values text
+      text = text.gsub(/\[\[.*\]\]/, '')
+      text = strip_string_values(text)
+      text = strip_integer_values(text)
+      strip_in_clause_values(text)
+    end
+
+    def strip_in_clause_values text
+      text.gsub(/\sIN\s\((.*)\)/) do |_match|
+        ' IN (values-redacted)'
+      end
+    end
+
+    def strip_integer_values text
+      text.gsub(/\s\=\s([0-9]+)/) do |_match|
+        ' = number-redacted'
+      end
+    end
+
+    def strip_string_values text
+      text.gsub(/\s\=\s\'(.*)\'/) do |_match|
+        " = 'value-redacted'"
+      end
+    end
+  end
+end

data/sql_footprint.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sql_footprint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sql_footprint'
+  spec.version       = SqlFootprint::VERSION
+  spec.authors       = ['Brandon Joyce']
+  spec.email         = ['bjoyce@covermymeds.com']
+
+  spec.summary       = 'Keeps your DB guy happy.'
+  spec.description   = 'Check your footprint file into source control'
+  spec.homepage      = 'https://github.com/covermymeds/sql_footprint'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'activerecord', '~> 4.0.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rubocop', '~> 0.37.0'
+  spec.add_development_dependency 'rubocop-rspec'
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: sql_footprint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Joyce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-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: Check your footprint file into source control
+email:
+- bjoyce@covermymeds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sql_footprint.rb
+- lib/sql_footprint/version.rb
+- sql_footprint.gemspec
+homepage: https://github.com/covermymeds/sql_footprint
+licenses: []
+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.8
+signing_key: 
+specification_version: 4
+summary: Keeps your DB guy happy.
+test_files: []
+has_rdoc: