database_leak_finder 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 654d5ed283dd00dbca47501ebfd87180d3b07a46
+  data.tar.gz: 1c9f861f039c88890d7e9dcdcabdce0eeb2902fb
+SHA512:
+  metadata.gz: 3b14b5be68f8aed7af6ea3a86b86148d17d77ccd6372771f194ec50c3743222f6b40fc5b3a373b9149e057814a6e231f1b9d7791ab10e087eed0160ff5e73820
+  data.tar.gz: 39315f530d1388618689de20d68940ff233a1afec76bf005e48b550397e69d2a9d55bf7fae95c860c3133e4b876cac8302c402e903b2bec60a748dff1aed2160

data/README.md

@@ -0,0 +1,32 @@
+# DatabaseLeakFinder [![Circle CI](https://circleci.com/gh/vitalinfo/database_leak_finder.svg?style=svg)](https://circleci.com/gh/vitalinfo/database_leak_finder) 
+
+Easy way to find problem in specs with uncleared DB data
+
+## Installation
+
+Add the following to your Gemfile:
+```ruby
+gem 'database_leak_finder'
+```
+
+## Usage
+
+Add this line to your `spec_helper.rb`
+```ruby
+config.include DatabaseLeakFinder
+```
+
+### Ignoring Tables
+You may have some tables that you don't want to report.
+
+Add this line to your `spec_helper.rb` before `config.include DatabaseLeakFinder`
+```ruby
+DatabaseLeakFinder.config(ignored_tables: [list of tables])
+```
+
+## 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

data/lib/database_leak_finder.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+require 'database_leak_finder/finder'
+require 'database_leak_finder/handler'
+require 'database_leak_finder/logger'
+
+module DatabaseLeakFinder
+  class << self
+    def included(base)
+      base.after(:each) do |example|
+        DatabaseLeakFinder::Handler.log_example(example)
+      end
+
+      base.after(:all) do
+        DatabaseLeakFinder::Handler.find_leaks
+      end
+
+      DatabaseLeakFinder.config({}) unless DatabaseLeakFinder::Handler.options
+    end
+
+    def config(options)
+      DatabaseLeakFinder::Handler.config(options)
+    end
+  end
+end

data/lib/database_leak_finder/finder.rb

@@ -0,0 +1,33 @@
+module DatabaseLeakFinder
+  class Finder
+    IGNORED_SYSTEM_TABLES = ['ar_internal_metadata', 'schema_migrations']
+
+    def initialize(options)
+      @ignored_tables = (options[:ignored_tables] || []) + IGNORED_SYSTEM_TABLES
+    end
+
+    def process
+      return [] unless ActiveRecord::Base.connected?
+      filtered_tables.each_with_object({}) do |table, result|
+        amount = count_for(table)
+        result[table] = amount unless amount.zero?
+        result
+      end
+    end
+
+    private
+    def count_for(table)
+      ActiveRecord::Base.connection.select_value("SELECT COUNT(*) FROM #{table}").to_i
+    rescue
+      raise StandardError, "An error occurred while try to count '#{table}'"
+    end
+
+    def filtered_tables
+      tables - @ignored_tables
+    end
+
+    def tables
+      ActiveRecord::Base.connection.data_sources
+    end
+  end
+end

data/lib/database_leak_finder/handler.rb

@@ -0,0 +1,29 @@
+module DatabaseLeakFinder
+  module Handler
+    class << self
+      attr_reader :options
+
+      def log_example(example)
+        @example = example
+      end
+
+      def find_leaks
+        leaks = finder.process
+        logger.log(@example, leaks) unless leaks.empty?
+      end
+
+      def config(options)
+        @options = options
+      end
+
+      private
+      def finder
+        @finder ||= DatabaseLeakFinder::Finder.new(@options)
+      end
+
+      def logger
+        @logger ||= DatabaseLeakFinder::Logger.new
+      end
+    end
+  end
+end

data/lib/database_leak_finder/logger.rb

@@ -0,0 +1,23 @@
+require 'highline'
+
+module DatabaseLeakFinder
+  class Logger
+    def log(example, leaks)
+      puts <<-LOG.strip_heredoc
+        \n
+        #{HighLine.color('#### Leaking Spec', :red)}
+        The spec '#{HighLine.color(spec_path_for(example), :red, :underline)}' leaves the following rows in the database:
+      LOG
+      leaks.each(&method(:log_leak))
+    end
+
+    private
+    def spec_path_for(example)
+      example.metadata[:example_group][:file_path]
+    end
+
+    def log_leak(table, count)
+      puts "     - #{HighLine.color(count.to_s, :red)} #{'row'.pluralize(count)} for the #{HighLine.color(table, :white, :underline)} table"
+    end
+  end
+end

data/lib/database_leak_finder/version.rb

@@ -0,0 +1,3 @@
+module DatabaseLeakFinder
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: database_leak_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Vital Ryabchinskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-16 00:00:00.000000000 Z
+dependencies:
+- !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: sqlite3
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: "'Easy way to find spec which doesn't clear database after execution"
+email: vital.ryabchinskiy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/database_leak_finder.rb
+- lib/database_leak_finder/finder.rb
+- lib/database_leak_finder/handler.rb
+- lib/database_leak_finder/logger.rb
+- lib/database_leak_finder/version.rb
+homepage: https://github.com/vitalinfo/database_leak_finder
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Find database leaks
+test_files: []