database_cleaner_seeded 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e873ae11558480f4b079d70479f7679249459b62
+  data.tar.gz: f9b377a65d1711159ae9223f10a79379c00e787f
+SHA512:
+  metadata.gz: e59a898857a331dd29464fbe0c4d8f37d822779d9258bd1cf04db3c87520187895b7cf02c2380789ba4dc5195cd8e8dcb5d38b871d9b81afda532bc3a31db278
+  data.tar.gz: b0c2fdb5a43c1039ecde219379fb852cdf8c93ed68b82310342fc63d69e71a549ed4385f96293d5905bc0e7a05e23443230e63f5529241be05bf195bbdeacb8b

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    database_cleaner_seeded (0.0.1)
+      activerecord
+      database_cleaner
+      rspec
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (5.0.0)
+      activesupport (= 5.0.0)
+    activerecord (5.0.0)
+      activemodel (= 5.0.0)
+      activesupport (= 5.0.0)
+      arel (~> 7.0)
+    activesupport (5.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.1)
+    concurrent-ruby (1.0.2)
+    database_cleaner (1.5.3)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    minitest (5.9.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner_seeded!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Michael Dawson
+
+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,88 @@
+# 'Seeded' strategy for Database Cleaner + Active Record
+
+Restore the database to a seeded state between tests, in a way that's compatible with feature tests that are run in multiple threads.
+
+## Why?
+
+The fantastic DatabaseCleaner gem provides a range of strategies for cleaning your database between RSpec tests. The gem's 'transaction' strategy is a fast way to rollback database state, and can be used to rollback your database state to a seeded baseline between tests. However, it isn't compatible with tests that run with multiple threads (e.g. using Capybara + Selenium), and so to make seed data available for these tests, you may need to run seed code before each test case.
+
+This gem allows you to restore the database to a seeded state using direct DBMS operations (using raw SQL) instead of ruby code. If you have a test suite with a large reliance on seeded data, this gem may speed up your test suite. I've seen speed benefits of up to 30% with some projects.
+
+## How?
+
+Before your feature test suite runs, a code block is run once to generate a raw seeds file. Then, before each test is run, your database is restored using direct injection of those seeds. This is usually faster than generating seeds using Ruby and inserting them individually before each test... but, because of the overhead associated with this approach, YMMV.
+
+Currently, this gem only supports MYSQL, and doesn't support database connections that require a password.
+
+To get started, add this gem to your Gemfile, point it to a method to call to call to setup your feature test seeds, and add some setup code to your `spec/rails_helper.rb` file.
+
+```ruby
+# Gemfile
+
+gem 'database_cleaner_seeded'
+```
+
+```ruby
+# spec/support/seed_data_helper.rb
+
+def seed_for_every_test
+  seed_foos
+  seed_bars
+  seed_bazzes
+end
+```
+
+```ruby
+# spec/rails_helper.rb
+
+# ...
+
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+require 'database_cleaner/active_record/seeded'
+
+include SeedDataHelper
+
+RSpec.configure do |config|
+  # ...
+
+  config.before(:suite) do
+    # Prepare the seeds file if we're running feature tests in this test run
+
+    if config.files_to_run.any? {|f| /spec\/features\//.match(f) }
+      DatabaseCleaner.prepare_with(:seeded) { seed_for_every_feature_test }
+    end
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.strategy = example.metadata[:type] == :feature ? :seeded : :transaction
+    DatabaseCleaner.cleaning { example.run }
+  end
+end
+```
+
+## Options
+
+With the above configuration, the code you run inside `DatabaseCleaner.prepare_with(:seeded)` is run each time you run your test suite with feature tests. However, depending on your requirements and the way that you run your test suite, you might like to skip seed regeneration between test runs, for faster performance. However - be warned! Use with caution - if you change your data model and don't regenerate the seeds, you might experience failures that are hard to diagnose.
+
+This gem exposes an option for you to selectively skip seed regeneration, in the form of a proc. You may also override the seeds file path (`tmp/tmp/database_cleaner_seeds.sql` by default).
+
+```ruby
+DatabaseCleaner::Seeded.configure do |config|
+  config.skip_seed_regeneration = -> { ! ENV['RESEED'] }
+  config.seeds_file_path = 'spec/fixtures/feature_test_seeds.sql'
+end
+```
+
+Using this configuration, existing seeds will be used between test suite runs. But, running `RESEED=true rspec spec/features` will force regeneration of the seeds.
+
+## Todo
+
+- Add support for other DBMSs
+- Add in some integration tests - perhaps with a mounted test application
+- Profit
+
+## Development & Feedback
+
+Have questions or encountered problems? Please use the
+[issue tracker](https://github.com/michaeldawson/database_cleaner_seeded/issues). If you would like to contribute to this project, fork this repository, then run `bundle` and `rake` to run the tests. Pull requests appreciated.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec'
+
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+
+task default: :spec

data/database_cleaner_seeded.gemspec

@@ -0,0 +1,19 @@
+require 'rake'
+
+Gem::Specification.new do |s|
+  s.name        = 'database_cleaner_seeded'
+  s.version     = '0.1.4'
+  s.date        = '2016-08-09'
+  s.summary     = 'Seed database directly between feature tests'
+  s.description = 'Provide a strategy for injecting database seeds between feature tests, using the DBMS directly.'
+  s.authors     = ['Michael Dawson']
+  s.email       = 'email.michaeldawson@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.homepage    = 'https://github.com/michaeldawson/database_cleaner_seeded'
+  s.license       = 'MIT'
+
+  s.add_dependency('database_cleaner', '>= 1.2.0')
+  s.add_dependency('activerecord', '> 3.0')
+  s.add_dependency('rspec')
+end

data/lib/database_cleaner/active_record/seeded.rb

@@ -0,0 +1,73 @@
+# -----------------------------------------------------------------------------
+#  Custom database cleaner strategy to restore the database to a seeded state
+#  for integration tests. Truncate the database, then execute a restore of
+#  seeds using the DBMS.
+# -----------------------------------------------------------------------------
+
+require 'database_cleaner/active_record/deletion'
+require 'database_cleaner/active_record/seeded/adapter/mysql'
+require 'database_cleaner/active_record/seeded/configuration'
+
+module DatabaseCleaner
+  module ActiveRecord
+    class Seeded < Deletion
+      class << self
+        attr_writer :configuration
+
+        def configure
+          yield(configuration)
+        end
+
+        def configuration
+          @configuration ||= Configuration.new
+        end
+      end
+
+      def start
+        adapter.inject_seeds_from_fixtures_file
+      end
+
+      def prepare(&seed_data_proc)
+        generate_seeds(seed_data_proc) unless skip_seeds_generation?
+        clean
+      end
+
+      private
+
+      def adapter
+        @adapter ||= Adapter::MYSQL.new(seeds_file_path)
+      end
+
+      def generate_seeds(seed_data_proc)
+        ::ActiveRecord::Base.transaction { seed_data_proc.call }
+        adapter.dump_database_to_fixtures_file
+      end
+
+      # If the user has configured the gem to skip seeds generation, return
+      # true, but only if we already have a seeds file that we can use.
+      def skip_seeds_generation?
+        raise "The option for 'skip_seed_regeneration' must be a Proc" if skip_seeds_proc && !skip_seeds_proc.respond_to?(:call)
+        skip_seeds_proc.try(:call) && File.exists?(seeds_file_path)
+      end
+
+      def seeds_file_path
+        @seeds_file_path ||= self.class.configuration.seeds_file_path
+      end
+
+      def skip_seeds_proc
+        @skip_seeds_proc ||= self.class.configuration.skip_seed_regeneration
+      end
+    end
+  end
+end
+
+module DatabaseCleaner
+  class << self
+    def prepare_with(strategy, &block)
+      connections.each do |connection|
+        connection.strategy = strategy
+        connection.strategy.prepare(&block)
+      end
+    end
+  end
+end

data/lib/database_cleaner/active_record/seeded/adapter/mysql.rb

@@ -0,0 +1,58 @@
+# -----------------------------------------------------------------------------
+#  Adapter for dumping and restoring seeds to the database using MYSQL.
+#  Currently doesn't support connections that use passwords.
+# -----------------------------------------------------------------------------
+
+require 'database_cleaner/active_record/truncation'
+
+module DatabaseCleaner
+  module ActiveRecord
+    class Seeded < Deletion # I hate this, but omitting it gives a superclass violation
+      module Adapter
+        class MYSQL
+          IGNORE_TABLES = %w(schema_migrations)
+
+          attr_reader :seeds_file_path
+
+          def initialize(seeds_file_path)
+            @seeds_file_path = seeds_file_path
+          end
+
+          def inject_seeds_from_fixtures_file
+            `mysql --user=#{user} --host=#{host} --port=#{port} --database=#{database} < #{seeds_file_path}`
+          end
+
+          def dump_database_to_fixtures_file
+            `mysqldump --user=#{user} --host=#{host} --port=#{port} --compact #{ignore_tables} --no-create-info=TRUE #{database} > #{seeds_file_path}`
+          end
+
+          private
+
+          def configuration
+            @configuration ||= ::ActiveRecord::Base.configurations['test']
+          end
+
+          def port
+            3306
+          end
+
+          def user
+            @user ||= configuration['username'] || 'root'
+          end
+
+          def host
+            @host ||= configuration['host']
+          end
+
+          def database
+            @database ||= configuration['database']
+          end
+
+          def ignore_tables
+            IGNORE_TABLES.map { |table| "--ignore-table=#{[database, table].join('.')}" }.join(' ')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/database_cleaner/active_record/seeded/configuration.rb

@@ -0,0 +1,15 @@
+module DatabaseCleaner
+  module ActiveRecord
+    class Seeded
+      class Configuration
+        DEFAULT_SEEDS_FILE_PATH = 'tmp/database_cleaner_seeds.sql'
+
+        attr_accessor :skip_seed_regeneration, :seeds_file_path
+
+        def initialize
+          @seeds_file_path = DEFAULT_SEEDS_FILE_PATH
+        end
+      end
+    end
+  end
+end

data/lib/database_cleaner_seeded.rb

@@ -0,0 +1 @@
+require 'database_cleaner/active_record/seeded'

data/spec/database_cleaner/seeded/configuration_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'database_cleaner/active_record/seeded/configuration'
+
+describe DatabaseCleaner::ActiveRecord::Seeded::Configuration do
+  let(:config) { DatabaseCleaner::ActiveRecord::Seeded::Configuration.new }
+
+  describe '#skip_seed_regeneration=' do
+    it 'default value is nil' do
+      expect(config.skip_seed_regeneration).to be_nil
+    end
+
+    it 'can set value' do
+      value = Proc.new {}
+
+      config.skip_seed_regeneration = value
+      expect(config.skip_seed_regeneration).to eq(value)
+    end
+  end
+
+  describe '#seeds_file_path=' do
+    it "default value is 'tmp/database_cleaner_seeds.sql'" do
+      expect(config.seeds_file_path).to eq('tmp/database_cleaner_seeds.sql')
+    end
+
+    it 'can set value' do
+      value = 'spec/some/other/path'
+
+      config.seeds_file_path = value
+      expect(config.seeds_file_path).to eq(value)
+    end
+  end
+end

data/spec/database_cleaner/seeded_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+module DatabaseCleaner
+  module ActiveRecord
+    describe Seeded do
+      let(:connection) { double('connection') }
+      let(:adapter) {
+        DatabaseCleaner::ActiveRecord::Seeded::Adapter::MYSQL.new('foo')
+      }
+
+      before(:each) do
+        allow(connection).to receive(:disable_referential_integrity).and_yield
+        allow(connection).to receive(:database_cleaner_view_cache).and_return([])
+        allow(::ActiveRecord::Base).to receive(:connection).and_return(connection)
+        allow(connection).to receive(:delete_table)
+        allow(DatabaseCleaner::ActiveRecord::Seeded::Adapter::MYSQL)
+          .to receive(:new).and_return(adapter)
+      end
+
+      describe '#start' do
+        it 'sends a call to the adapter to inject seeds' do
+          expect(adapter).to receive(:inject_seeds_from_fixtures_file)
+
+          Seeded.new.start
+        end
+      end
+
+      describe '#prepare' do
+        before :each do
+          allow(connection).to receive(:database_cleaner_table_cache)
+            .and_return(%w[schema_migrations shoes hats])
+          allow(adapter).to receive(:dump_database_to_fixtures_file)
+
+          allow(connection).to receive(:transaction).and_yield
+        end
+
+        it 'deletes data in all tables except for schema_migrations' do
+          expect(connection).to receive(:delete_table).with('shoes')
+          expect(connection).to receive(:delete_table).with('hats')
+
+          Seeded.new.prepare {}
+        end
+
+        it 'asks the adapter to dump the database' do
+          expect(adapter).to receive(:dump_database_to_fixtures_file)
+
+          Seeded.new.prepare {}
+        end
+
+        it 'calls the seed data proc in the method' do
+          seed_data_spy = spy(:seed_proc)
+          expect(seed_data_spy).to receive(:call)
+
+          Seeded.new.prepare { seed_data_spy.call }
+        end
+
+        context "when the 'skip_seed_regeneration' proc has been set to something that returns true" do
+          let(:file_path) { 'some/file/path' }
+
+          before :each do
+            DatabaseCleaner::ActiveRecord::Seeded.configure do |config|
+              config.skip_seed_regeneration = -> { true }
+              config.seeds_file_path = file_path
+            end
+          end
+
+          context 'and the seeds fixture file already exists' do
+            before :each do
+              allow(File).to receive(:exists?)
+                .with(file_path).and_return(true)
+            end
+
+            it "doesn't call the seed data proc in the method" do
+              seed_data_spy = spy(:seed_proc)
+              expect(seed_data_spy).not_to receive(:call)
+
+              Seeded.new.prepare { seed_data_spy.call }
+            end
+          end
+
+          context "and the seeds fixture file doesn't already exist" do
+            before :each do
+              allow(File).to receive(:exists?)
+                .with(file_path).and_return(false)
+            end
+
+            it 'still calls the seed data proc in the method' do
+              seed_data_spy = spy(:seed_proc)
+              expect(seed_data_spy).to receive(:call)
+
+              Seeded.new.prepare { seed_data_spy.call }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'active_record'
+require 'database_cleaner_seeded'
+
+Bundler.require(:default)

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: database_cleaner_seeded
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Michael Dawson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: rspec
+  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'
+description: Provide a strategy for injecting database seeds between feature tests,
+  using the DBMS directly.
+email: email.michaeldawson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- database_cleaner_seeded-0.1.2.gem
+- database_cleaner_seeded.gemspec
+- lib/database_cleaner/active_record/seeded.rb
+- lib/database_cleaner/active_record/seeded/adapter/mysql.rb
+- lib/database_cleaner/active_record/seeded/configuration.rb
+- lib/database_cleaner_seeded.rb
+- spec/database_cleaner/seeded/configuration_spec.rb
+- spec/database_cleaner/seeded_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/michaeldawson/database_cleaner_seeded
+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.4
+signing_key: 
+specification_version: 4
+summary: Seed database directly between feature tests
+test_files:
+- spec/database_cleaner/seeded/configuration_spec.rb
+- spec/database_cleaner/seeded_spec.rb
+- spec/spec_helper.rb