derail_specs 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f70b380bfc02b15f03003667f83784ae59f24b110c5c2323a21c5ee02a73fddf
-  data.tar.gz: 9a6e3daf75695be63ee86f3da37359de27087ecf95e000f5e7366359a120c72b
+  metadata.gz: 90fd1d641de71a5a41d231af09190c33987e21efb49cd973fbef9671a9ef8cdb
+  data.tar.gz: 6eb5f40e29be236de49bf2625e54d04f33647f22c74862e6dd4fdf6ee891771a
 SHA512:
-  metadata.gz: 716f6b48003cba47b8d4b82643225fadae5309e6762e951540d6d4ea93f81b39340cdebf48108872f0dd557fa7d9a722348a96348c6aa737885065a3fa346805
-  data.tar.gz: a3f0eb5f552897e6b9c0f64f3059ae074c6b1434c824aae9829c0dfcf36ddbdb0768a4472bb869ed20d630c4a0cfe543c98e51b4b73a83a15410a17c25f016d3
+  metadata.gz: ba977461d31563b4d7dd4da9cf9217e4bba40b34f113170852f623d1a4a02e24963dbb64e6a9c18c7e0911824330ffe21636233446ce12c5f2efc03ce2258e0b
+  data.tar.gz: 969d0a9fa3c125ed4bcb707c3a5907616de8bd4567d081e0b8f23fc53056390fab0bc61418b72c0a27a5c7f88729573a1cbe52530169db20258c863e03161c7c

data/.rubocop.yml

@@ -1,10 +1,15 @@
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'example/db/schema.rb'
+    - 'example/bin/*'
+    - 'vendor/**/*'
+
 Style/StringLiterals:
   Enabled: false
 
-AllCops:                                                     
-  NewCops: enable
 
 Style/Documentation:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-09-15 06:26:41 UTC using RuboCop version 1.21.0.
+# on 2021-09-16 08:00:52 UTC using RuboCop version 1.21.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -18,30 +18,14 @@ Gemspec/RequiredRubyVersion:
 Metrics/AbcSize:
   Max: 34
 
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 9
-
-# Offense count: 6
+# Offense count: 4
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 20
 
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Max: 9
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'example/bin/bundle'
-
-# Offense count: 4
+# Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 198
+  Max: 127

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## [Unreleased]
 
+
+## [0.5.0] - 2021-09-17
+
+- Add before_server_start and before_server_stop initializer hooks
+
+## [0.4.0] - 2021-09-16
+
+- Add infinite server mode, which can be used by not setting a command in the config
+-
+## [0.3.0] - 2021-09-16
+
+- Add `/factory-bot/create` route to map to FactoryBot.create
+- Run `rake derail_specs:run` in Rails test environment
+
+## [0.2.1] - 2021-09-15
+
+- Fix Rails 5.2 missing method `ActiveRecord::TestFixtures.setup_shared_connection_pool`
+
 ## [0.2.0] - 2021-09-15
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    derail_specs (0.2.0)
+    derail_specs (0.5.0)
       puma (>= 3.8.0)
       railties (>= 5.2.0)
 

data/README.md

@@ -38,6 +38,12 @@ DerailSpecs.configure do |config|
 end
 ```
 
+Alternatively, if you don't set a `config.command`, the server will boot in
+*infinite* mode and will not stop until receiving an INT signal (IE Ctrl+c).
+This is good for when your test command isn't available in a rails context,
+like when you are running rails in docker, but have a test application running
+on the host machine.
+
 ## Usage
 
 To run tests, run
@@ -63,6 +69,56 @@ beforeEach(async () => {
   });
 ```
 
+### FactoryBot.create
+
+Post with a JSON array to `/factory-bot/create` with the following structure:
+
+```JSON
+["test", { "name": "Test Name", "created_at": "2011-11-11 11:11:11" }]
+````
+
+which will run:
+
+```ruby
+FactoryBot.create(:test, name: "Test Name", created_at: "2011-11-11 11:11:11")
+```
+
+Example curl:
+
+```bash
+curl -X POST \
+      -d '["test", { "name": "Test Name from Curl", "created_at": "2011-11-11 11:11:11" }]' \
+      -H 'Content-Type: application/json' \
+      127.0.0.1:3001/factory-bot/create
+```
+
+### Initializer Hooks
+
+By default, DerailSpecs doesn't run any fixtures. You can configure global fixture
+loading with initializer hooks in `config/initializers/derail_specs.rb`:
+
+```
+return unless Rails.env.test?
+
+DerailSpecs.hooks.before_server_start do
+  # Add our fixtures before the resettable transaction is started
+  fixtures_dir = Rails.root.join("spec/fixtures")
+  fixture_files = Dir.glob(fixtures_dir.join("**/*.yml")).map do |f|
+    f[(fixtures_dir.to_s.size + 1)..-5]
+  end
+
+  @fixtures = ActiveRecord::FixtureSet.create_fixtures(
+    fixtures_dir,
+    fixture_files,
+  )
+end
+
+DerailSpecs.hooks.before_server_stop do
+  @fixtures.map(&:model_class).each(&:delete_all)
+end
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/setup

@@ -5,4 +5,7 @@ set -vx
 
 bundle install
 
+cd example
+bin/setup
+
 # Do any other automated setup that you need to do here

data/example/Gemfile

@@ -11,5 +11,6 @@ gem 'sqlite3', '~> 1.4'
 
 group :development, :test do
   gem "derail_specs", path: '..'
+  gem 'factory_bot_rails'
   gem 'pry-rails'
 end

data/example/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    derail_specs (0.1.0)
+    derail_specs (0.5.0)
       puma (>= 3.8.0)
       railties (>= 5.2.0)
 
@@ -72,6 +72,11 @@ GEM
     concurrent-ruby (1.1.9)
     crass (1.0.6)
     erubi (1.10.0)
+    factory_bot (6.2.0)
+      activesupport (>= 5.0.0)
+    factory_bot_rails (6.2.0)
+      factory_bot (~> 6.2.0)
+      railties (>= 5.0.0)
     globalid (0.5.2)
       activesupport (>= 5.0)
     i18n (1.8.10)
@@ -147,6 +152,7 @@ PLATFORMS
 
 DEPENDENCIES
   derail_specs!
+  factory_bot_rails
   pry-rails
   puma (~> 5.0)
   rails (~> 6.1.4, >= 6.1.4.1)

data/example/app/models/test.rb

@@ -0,0 +1,2 @@
+class Test < ApplicationRecord
+end

data/example/db/migrate/20210916070010_create_tests.rb

@@ -0,0 +1,9 @@
+class CreateTests < ActiveRecord::Migration[6.1]
+  def change
+    create_table :tests do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/example/db/schema.rb

@@ -0,0 +1,21 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 2021_09_16_070010) do
+
+  create_table "tests", force: :cascade do |t|
+    t.string "name"
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+  end
+
+end

data/example/factories.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :test do
+    sequence(:name) { |n| "Test #{n}" }
+  end
+end

data/example/tests.sh

@@ -1,4 +1,8 @@
 #!/usr/bin/env bash
 
-curl 127.0.0.1:3001
+curl -s 127.0.0.1:3001 > /dev/null
 curl 127.0.0.1:3001/reset-transaction
+curl -X POST \
+      -d '["test", { "name": "Test Name from Curl", "created_at": "2011-11-11 11:11:11" }]' \
+      -H 'Content-Type: application/json' \
+      127.0.0.1:3001/factory-bot/create

data/lib/derail_specs/boot.rb

@@ -3,21 +3,30 @@ require_relative 'server'
 module DerailSpecs
   class Boot
     def run
+      DerailSpecs.hooks.run(:before_server_start)
       Transaction.begin
       set_exit_hooks!
 
       Server.new.tap(&:boot)
 
-      puts "Starting Tests…"
-
-      system DerailSpecs.configuration.command
+      if command.present?
+        puts "Run: #{command}"
+        system command
+      else
+        loop { sleep 60 }
+      end
     end
 
     private
 
+    def command
+      DerailSpecs.configuration.command
+    end
+
     def set_exit_hooks!
       at_exit do
         Transaction.rollback
+        DerailSpecs.hooks.run(:before_server_stop)
       end
       Signal.trap("INT") do
         puts "Exiting derail_specs…"

data/lib/derail_specs/factory_bot.rb

@@ -0,0 +1,14 @@
+begin
+  gem 'factory_bot_rails'
+  require 'factory_bot_rails'
+
+  module DerailSpecs
+    class FactoryBot
+      def self.create(factory, options = nil)
+        ::FactoryBot.create(factory, options)
+      end
+    end
+  end
+rescue Gem::LoadError
+  require_relative 'factory_bot_stub'
+end

data/lib/derail_specs/factory_bot_stub.rb

@@ -0,0 +1,8 @@
+module DerailSpecs
+  class FactoryBot
+    def self.create(*_)
+      puts "factory_bot_rails is not installed in group :test"
+      puts "Please add factory_bot_rails to your Gemfile to use this feature"
+    end
+  end
+end

data/lib/derail_specs/initializer_hooks.rb

@@ -0,0 +1,42 @@
+module DerailSpecs
+  def self.hooks
+    InitializerHooks.instance
+  end
+
+  class InitializerHooks
+    def self.instance
+      @instance ||= new
+    end
+
+    def before_server_start(&blk)
+      register(:before_server_start, blk)
+    end
+
+    def before_server_stop(&blk)
+      register(:before_server_stop, blk)
+    end
+
+    def reset!
+      @hooks = {}
+    end
+
+    def run(name)
+      return unless @hooks[name]
+      @hooks[name].each do |blk|
+        blk.call
+      end
+    end
+
+    private
+
+    def register(name, blk)
+      @hooks[name] ||= []
+      @hooks[name] << blk
+    end
+
+    def initialize
+      reset!
+    end
+  end
+end
+

data/lib/derail_specs/server/app.rb

@@ -7,6 +7,14 @@ module DerailSpecs
           [202, { "Content-Type" => "text/plain" }, ["Accepted"]]
         }
       end
+      map "/factory-bot/create" do
+        run lambda { |env|
+          body = Rack::Request.new(env).body.gets
+          object = FactoryBot.create(*JSON.parse(body))
+
+          [202, { "Content-Type" => "application/json" }, [object.to_json]]
+        }
+      end
       map "/" do
         run Rails.application
       end

data/lib/derail_specs/transaction.rb

@@ -63,7 +63,7 @@ module DerailSpecs
     end
 
     def gather_connections
-      setup_shared_connection_pool
+      setup_shared_connection_pool if ActiveRecord::VERSION::MAJOR >= 6
 
       ActiveRecord::Base.connection_handler.connection_pool_list.map(&:connection)
     end

data/lib/derail_specs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DerailSpecs
-  VERSION = "0.2.0"
+  VERSION = "0.5.0"
 end

data/lib/derail_specs.rb

@@ -7,7 +7,12 @@ module DerailSpecs
 
   def self.configuration
     @configuration ||= Struct
-                       .new(:command, :host, :port, keyword_init: true)
+                       .new(
+                         :command,
+                         :host,
+                         :port,
+                         keyword_init: true,
+                       )
                        .new(
                          host: '127.0.0.1',
                          port: 3001,
@@ -22,3 +27,5 @@ end
 require 'derail_specs/boot'
 require 'derail_specs/transaction'
 require 'derail_specs/railtie'
+require 'derail_specs/factory_bot'
+require 'derail_specs/initializer_hooks'

data/lib/generators/templates/config/initializers/derail_specs.rb

@@ -1,3 +1,5 @@
+return unless Rails.test.env?
+
 DerailSpecs.configure do |config|
   config.command = './tests.sh'
   config.host = '127.0.0.1'

data/lib/tasks/derail_specs.rake

@@ -1,5 +1,6 @@
 namespace :derail_specs do
   task run: :environment do
+    Rails.env = "test"
     DerailSpecs::Boot.new.run
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: derail_specs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Alex Piechowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -67,6 +67,7 @@ files:
 - example/Rakefile
 - example/app/controllers/application_controller.rb
 - example/app/models/application_record.rb
+- example/app/models/test.rb
 - example/app/views/layouts/application.html.erb
 - example/bin/bundle
 - example/bin/rails
@@ -94,6 +95,9 @@ files:
 - example/config/locales/en.yml
 - example/config/puma.rb
 - example/config/routes.rb
+- example/db/migrate/20210916070010_create_tests.rb
+- example/db/schema.rb
+- example/factories.rb
 - example/public/404.html
 - example/public/422.html
 - example/public/500.html
@@ -104,6 +108,9 @@ files:
 - example/tests.sh
 - lib/derail_specs.rb
 - lib/derail_specs/boot.rb
+- lib/derail_specs/factory_bot.rb
+- lib/derail_specs/factory_bot_stub.rb
+- lib/derail_specs/initializer_hooks.rb
 - lib/derail_specs/railtie.rb
 - lib/derail_specs/server.rb
 - lib/derail_specs/server/app.rb