database_rewinder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7eb09a5bfe857d34118e354730f3f49cb4a6fb4
+  data.tar.gz: 4c49a5891c8585ae6896b0137f34a05e397aeb9b
+SHA512:
+  metadata.gz: aaf1352df853e3894d2cb777ebf4fd90bab61659e94577f61afce4eac41585df825fdfa22df10c5bf971b5d854e81851793a63cdc18139fe8ac377f6558684fd
+  data.tar.gz: 31f04525cdb310b9bfe303f38578a94749f9a61ad7d22344460401804e2c6269bd5d032b62262610160f30dca220614f687ae37387be32a759a7a18c56287300

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log

data/Gemfile

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

data/MIT_LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Akira Matsuda
+
+MIT License
+
+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,60 @@
+# DatabaseRewinder
+
+database\_rewinder is a minimalist's tiny and ultra-fast database cleaner.
+
+## Features
+
+* Cleans up tables via DELETE SQL. No other strategies are implemented ATM
+* Supports multiple databases
+* Runs extremely fast :dash:
+
+## Why is it fast?
+
+database\_rewinder memorizes every table name into which `INSERT` SQL was performed during each test case.
+Then it executes `DELETE` SQL only against these tables when cleaning.
+So, the more you have number of tables in your database, the more benefit you will get.
+
+## Supported versions
+
+* ActiveRecord 3.2, 4.0, 4.1
+
+* Ruby 2.0, 2.1
+
+## Installation
+
+Add this line to your Gemfile's `:test` group:
+
+    gem 'database_rewinder'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Do `clean_all` in `before(:suite)`, and `clean` in `after(:each)`.
+
+```ruby
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseRewinder.clean_all
+  end
+
+  config.after :each do
+    DatabaseRewinder.clean
+  end
+end
+```
+
+### Pro Tip
+
+database\_rewinder is designed to be almost compatible with database\_cleaner.
+So the following code will probably let your existing app work under database\_rewinder without making any change on your cofiguration.
+
+```ruby
+DatabaseCleaner = DatabaseRewinder
+```
+
+## Contributing
+
+Send me your pull requests.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :noop do; end
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec => :noop)

data/database_rewinder.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "database_rewinder"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Akira Matsuda"]
+  spec.email         = ["ronnie@dio.jp"]
+  spec.description   = "A minimalist's tiny and ultra-fast database cleaner"
+  spec.summary       = "A minimalist's tiny and ultra-fast database cleaner"
+  spec.homepage      = 'https://github.com/amatsuda/database_rewinder'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/database_rewinder.rb

@@ -0,0 +1,77 @@
+require_relative 'database_rewinder/cleaner'
+require_relative 'database_rewinder/railtie'
+
+module DatabaseRewinder
+  VERSION = Gem.loaded_specs['database_rewinder'].version.to_s
+
+  class << self
+    def init
+      @cleaners, @table_names_cache, @clean_all, @only, @except = [], {}, false
+      @db_config = YAML::load(ERB.new(IO.read(Rails.root.join 'config/database.yml')).result)
+    end
+
+    def create_cleaner(connection_name)
+      config = @db_config[connection_name] or raise %Q[Database configuration named "#{connection_name}" is not configured.]
+
+      Cleaner.new(db: config['database'], connection_name: connection_name, only: @only, except: @except).tap {|c| @cleaners << c}
+    end
+
+    def [](_orm, connection: nil, **)
+      if (cl = @cleaners.detect {|c| c.connection_name == connection})
+        return cl
+      end
+
+      create_cleaner connection
+    end
+
+    def all=(v)
+      @clean_all = v
+    end
+
+    def cleaners
+      create_cleaner 'test' if @cleaners.empty?
+      @cleaners
+    end
+
+    def record_inserted_table(connection, sql)
+      database = connection.instance_variable_get(:'@config')[:database]
+      cleaner = cleaners.detect {|c| c.db == database} or return
+
+      match = sql.match(/\AINSERT INTO [`"]?([^\s`"]+)[`"]?/)
+      table = match[1] if match
+      if table
+        cleaner.inserted_tables << table unless cleaner.inserted_tables.include? table
+        cleaner.pool ||= connection.pool
+      end
+    end
+
+    def clean
+      if @clean_all
+        clean_all
+      else
+        cleaners.each {|c| c.clean}
+      end
+    end
+
+    def clean_all
+      cleaners.each {|c| c.clean_all}
+    end
+
+    # for database_cleaner compat
+    def clean_with(*args)
+      cleaners.each {|c| c.clean_with *args}
+    end
+
+    # for database_cleaner compat
+    def start; end
+    def strategy=(_strategy, only: nil, except: nil, **)
+      @only, @except = only, except
+    end
+
+    # cache AR connection.tables
+    def all_table_names(connection)
+      db = connection.instance_variable_get(:'@config')[:database]
+      @table_names_cache[db] ||= connection.tables
+    end
+  end
+end

data/lib/database_rewinder/active_record_monkey.rb

@@ -0,0 +1,17 @@
+module DatabaseRewinder
+  module InsertRecorder
+    def execute(sql, *)
+      DatabaseRewinder.record_inserted_table self, sql
+      super
+    end
+
+    def exec_query(sql, *)
+      DatabaseRewinder.record_inserted_table self, sql
+      super
+    end
+  end
+end
+
+::ActiveRecord::ConnectionAdapters::SQLite3Adapter.send :prepend, DatabaseRewinder::InsertRecorder if defined? ::ActiveRecord::ConnectionAdapters::SQLite3Adapter
+::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send :prepend, DatabaseRewinder::InsertRecorder if defined? ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.send :prepend, DatabaseRewinder::InsertRecorder if defined? ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter

data/lib/database_rewinder/cleaner.rb

@@ -0,0 +1,54 @@
+module DatabaseRewinder
+  class Cleaner
+    attr_accessor :db, :connection_name, :inserted_tables, :pool
+
+    def initialize(db: nil, connection_name: nil, only: nil, except: nil)
+      @db, @connection_name, @only, @except = db, connection_name, Array(only), Array(except)
+      reset
+    end
+
+    def clean
+      return unless pool
+      return if inserted_tables.empty?
+
+      delete_all (ar_conn = pool.connection), DatabaseRewinder.all_table_names(ar_conn) & inserted_tables
+      reset
+    end
+
+    def clean_all
+      return unless pool
+
+      delete_all (ar_conn = pool.connection), DatabaseRewinder.all_table_names(ar_conn)
+      reset
+    end
+
+    def clean_with(_strategy, only: nil, except: nil, **)
+      @only += Array(only) unless only.blank?
+      @except += Array(except) unless except.blank?
+      clean_all
+    end
+
+    # for database_cleaner compat
+    def strategy=(_strategy, only: nil, except: nil, **)
+      @only += Array(only) unless only.blank?
+      @except += Array(except) unless except.blank?
+    end
+
+    private
+    def delete_all(ar_conn, tables)
+      tables = tables & @only if @only.any?
+      tables -= @except if @except.any?
+      return if tables.empty?
+
+      ar_conn.disable_referential_integrity do
+        tables.each do |table_name|
+          ar_conn.execute "DELETE FROM #{ar_conn.quote_table_name(table_name)};"
+        end
+      end
+    end
+
+    def reset
+      @inserted_tables = []
+    end
+  end
+end

data/lib/database_rewinder/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+
+module DatabaseRewinder
+  class Railtie < ::Rails::Railtie
+    initializer 'database_rewinder', after: 'active_record.initialize_database' do
+      ActiveSupport.on_load :active_record do
+        DatabaseRewinder.init
+        require_relative 'active_record_monkey'
+      end
+    end
+  end
+end

data/spec/active_record_monkey_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'DatabaseRewinder::InsertRecorder#execute' do
+  before do
+    DatabaseRewinder.init
+    Foo.create! name: 'foo1'
+    Bar.create! name: 'bar1'
+    DatabaseRewinder.cleaners
+  end
+  subject { DatabaseRewinder.instance_variable_get(:'@cleaners').detect {|c| c.db == ':memory:'} }
+  its(:inserted_tables) { should == %w(foos bars) }
+  its(:pool) { should be }
+end

data/spec/config/database.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: ':memory:'
+  pool: 5
+  timeout: 5000

data/spec/database_rewinder_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe DatabaseRewinder do
+  before { DatabaseRewinder.init }
+
+  describe '.[]' do
+    before do
+      DatabaseRewinder.instance_variable_set :'@db_config', {'foo' => {'adapter' => 'sqlite3', 'database' => ':memory:'}}
+      DatabaseRewinder[:aho, connection: 'foo']
+    end
+    subject { DatabaseRewinder.instance_variable_get(:'@cleaners').map {|c| c.connection_name} }
+    it { should == ['foo'] }
+  end
+
+  describe '.clean' do
+    before do
+      Foo.create! name: 'foo1'
+      Bar.create! name: 'bar1'
+      DatabaseRewinder.clean
+    end
+    it 'should clean' do
+      Foo.count.should == 0
+      Bar.count.should == 0
+    end
+  end
+end

data/spec/fake_app.rb

@@ -0,0 +1,26 @@
+require 'active_record/railtie'
+
+module DatabaseRewinderTestApp
+  Application = Class.new(Rails::Application) do
+    # Rais.root
+    config.root = __dir__
+
+    config.eager_load = false
+    config.active_support.deprecation = :log
+  end.initialize!
+end
+
+
+# models
+class Foo < ActiveRecord::Base; end
+class Bar < ActiveRecord::Base; end
+class Baz < ActiveRecord::Base; end
+
+# migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:foos) {|t| t.string :name }
+    create_table(:bars) {|t| t.string :name }
+    create_table(:bazs) {|t| t.string :name }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+$LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
+$LOAD_PATH.unshift(__dir__)
+
+require 'rails'
+require 'database_rewinder'
+require 'fake_app'
+
+RSpec.configure do |config|
+  config.before :all do
+    CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? 'foos'
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: database_rewinder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: 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: rails
+  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'
+description: A minimalist's tiny and ultra-fast database cleaner
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT_LICENSE
+- README.md
+- Rakefile
+- database_rewinder.gemspec
+- lib/database_rewinder.rb
+- lib/database_rewinder/active_record_monkey.rb
+- lib/database_rewinder/cleaner.rb
+- lib/database_rewinder/railtie.rb
+- spec/active_record_monkey_spec.rb
+- spec/config/database.yml
+- spec/database_rewinder_spec.rb
+- spec/fake_app.rb
+- spec/spec_helper.rb
+homepage: https://github.com/amatsuda/database_rewinder
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A minimalist's tiny and ultra-fast database cleaner
+test_files:
+- spec/active_record_monkey_spec.rb
+- spec/config/database.yml
+- spec/database_rewinder_spec.rb
+- spec/fake_app.rb
+- spec/spec_helper.rb