sequel_query_limit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e683803757e1d70033db910195911a1595bba93
+  data.tar.gz: 74d998162745cf681bc2c942b2ec9ef32f46c626
+SHA512:
+  metadata.gz: e8768b642efdfda37b6bfbf0320e10ca04303c3792bd2759dd1407a23b305e0844eb01687411cc55a7703dd4df8f0652a112d47f315ae55f5f0d7478dc5d7a33
+  data.tar.gz: 9120fe3ae3f92746fc6d031dc83ee059e0052fc15b017200990751be46e922380402c1804b70365712b93dfab1f3268a65e1fc49284475d874c2170976bce9bd

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kondratenko Denis (dikond)
+
+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,66 @@
+## What this is about?
+
+You have probably heard of N+1 queries problem. In the rails community, there are a [bullet](https://github.com/flyerhzm/bullet) and [rspec-sqlimit](https://github.com/nepalez/rspec-sqlimit) gems that help to detect this kind of queries. `sequel_query_limit` is a [Sequel](https://github.com/jeremyevans/sequel) extension that pursuits the very much similar goal as `rspec-sqlimit` does. Maybe a little more :)
+
+
+## Usage
+
+#### With RSpec
+
+```ruby
+module SqlSpecHelper
+  def self.included(base)
+    base.before(:each) { QueryLimit::Listener::Global.watch }
+    base.after(:each)  { QueryLimit::Listener::Global.analyze(np1: true, reset: true) }
+    base.after(:all)   { QueryLimit::Listener::Global.die }
+  end
+end
+
+RSpec.configure do |config|
+  config.include SqlSpecHelper, watch: :np1
+end
+
+RSpec.describe 'analyzer', watch: :np1 do
+  it 'analyzes queries that has been run' do
+    collection = Models::Company.limit(10).all
+    App::Companies::Serializer.for_collection.new(collection).to_hash
+    expect(true).to eq true
+  end
+end
+```
+
+Using this technique you can check individual examples for N+1 quries withouth wrapping everything into `DB.with_query_limit` block.
+
+
+#### `#with_query_limit`
+
+Maybe useful for ad-hoc testing via console. This also can be used in tests.
+
+```ruby
+DB.with_query_limit(/SELECT/, max: 3) do
+  collection = Models::Company.limit(10).all
+  App::Companies::Serializer.for_collection.new(collection).to_hash
+end
+```
+
+This will return result of your query if it's not exceeding specified `max` limit. Otherwise, it will raise an exception with captured sql queries.
+
+## TODO
+
+- Add configuration option for what to do when query exceeds a limit (raise exception or run a callback)
+- Add configuration option for what to do when N+1 problem found
+- Add RSpec matchers
+- Add option to limit by query execution time
+- Add ability to pass custom sql backrace formatter
+- Add ability to analyze on the fly
+
+
+## Contributing
+
+Bug reports and pull requests are welcome!
+
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/query_limit/analyzer.rb

@@ -0,0 +1,30 @@
+module QueryLimit
+  class Analyzer
+    MATCHER = %r{\A(SELECT\s.*\sFROM\s.*\sWHERE\s)(.*)\z}
+
+    def initialize(stack)
+      @stack = stack
+    end
+
+    attr_reader :stack
+
+    def analyze_np1
+      grp = stack.group_by { |entry| entry.sql.match(MATCHER)&.captures&.at(1) }
+      diff = grp.values.find { |entries| entries.size > 1 }
+
+      tell_the_story(diff.first.sql, diff.first.stacktrace) if diff
+    end
+
+    private
+
+    def tell_the_story(query, stacktrace)
+      puts
+      puts 'Possible N+1 query has been detected'
+      puts
+      puts "#{query}"
+      puts
+      puts stacktrace.reject { |s| s.include? 'gem' }.map { |s| "    #{s}"}.join("\n")
+      puts
+    end
+  end
+end

data/lib/query_limit/errors.rb

@@ -0,0 +1,5 @@
+module QueryLimit
+  module Errors
+    class ExceedingMaxError < StandardError; end
+  end
+end

data/lib/query_limit/listener.rb

@@ -0,0 +1,52 @@
+require_relative 'analyzer'
+
+module QueryLimit
+  class Listener
+    class Entry < Struct.new(:sql, :stacktrace); end
+
+    attr_reader :stack
+
+    def initialize
+      @stack = []
+    end
+
+    def sequel_query(sql, stacktrace)
+      @stack << Entry.new(sql, stacktrace)
+    end
+
+    class Global
+      VAR_NAME = 'query_limit_spy'.freeze
+
+      class << self
+        def watch
+          self.spy = Listener.new if spy.nil?
+          Wisper.subscribe(spy, on: :sequel_query)
+        end
+
+        def sleep
+          Wisper.unsubscribe(spy)
+        end
+
+        def die
+          Wisper.unsubscribe(spy)
+          self.spy = nil
+        end
+
+        def analyze(np1: true, reset: false)
+          Analyzer.new(spy.stack).analyze_np1 if np1
+          self.spy = Listener.new if reset
+        end
+
+        private
+
+        def spy=(value)
+          Thread.current.thread_variable_set(VAR_NAME, value)
+        end
+
+        def spy
+          Thread.current.thread_variable_get(VAR_NAME)
+        end
+      end
+    end
+  end
+end

data/lib/query_limit/sequel_extension.rb

@@ -0,0 +1,22 @@
+require 'wisper'
+require_relative 'listener'
+require_relative 'errors'
+
+module QueryLimit
+  module SequelExtension
+    include Wisper::Publisher
+
+    def log_connection_yield(sql, conn, args = nil)
+      broadcast(:sequel_query, sql, caller)
+      super
+    end
+
+    def with_query_limit(pattern, max:)
+      listener = QueryLimit::Listener.new
+
+      Wisper.subscribe(listener, on: :sequel_query) { yield }
+
+      raise QueryLimit::Errors::ExceedingMaxError if listener.stack.grep(pattern).size > max
+    end
+  end
+end

data/lib/query_limit/version.rb

@@ -0,0 +1,3 @@
+module QueryLimit
+  VERSION = '0.0.1'.freeze
+end

data/lib/query_limit.rb

@@ -0,0 +1,2 @@
+require 'query_limit/version'
+require 'sequel/extensions/query_limit'

data/lib/sequel/extensions/query_limit.rb

@@ -0,0 +1,7 @@
+require_relative '../../query_limit/sequel_extension'
+
+module Sequel
+  module Extensions
+    Sequel::Database.register_extension(:query_limit, QueryLimit::SequelExtension)
+  end
+end

data/sequel_query_limit.gemspec

@@ -0,0 +1,25 @@
+require './lib/query_limit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sequel_query_limit'
+  spec.version       = QueryLimit::VERSION
+  spec.authors       = 'dikond'
+  spec.email         = 'di.kondratenko@gmail.com'
+
+  spec.summary       = 'Helps to watch for N+1 queries in Sequel'
+  spec.homepage      = 'https://github.com/dikond/sequel_query_limit'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_runtime_dependency     'sequel', '~> 4.0', '>= 4.0.0'
+  spec.add_runtime_dependency     'wisper', '~> 2.0', '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/spec/sequel_query_limit_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+RSpec.describe SequelQueryLimit do
+  it "has a version number" do
+    expect(SequelQueryLimit::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "sequel_query_limit"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: sequel_query_limit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- dikond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: di.kondratenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/query_limit.rb
+- lib/query_limit/analyzer.rb
+- lib/query_limit/errors.rb
+- lib/query_limit/listener.rb
+- lib/query_limit/sequel_extension.rb
+- lib/query_limit/version.rb
+- lib/sequel/extensions/query_limit.rb
+- sequel_query_limit.gemspec
+- spec/sequel_query_limit_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dikond/sequel_query_limit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Helps to watch for N+1 queries in Sequel
+test_files:
+- spec/sequel_query_limit_spec.rb
+- spec/spec_helper.rb