Replace blueprints with FactoryBot (#1595)

Copilot · scarroll32 · web-flow · commit 6f019e01b0b4 · 2025-09-25T15:34:22.000Z
* Initial plan

* Initial analysis of Ransack spec structure - planning refactor from Machinist to FactoryBot

Co-authored-by: scarroll32 &lt;11340230+scarroll32@users.noreply.github.com&gt;

* Changes before error encountered

Co-authored-by: scarroll32 &lt;11340230+scarroll32@users.noreply.github.com&gt;

* Complete replacement of Machinist with FactoryBot

- Replace Machinist gem with FactoryBot in Gemfile
- Convert all blueprint files to FactoryBot factories with proper syntax
- Update spec_helper.rb to use FactoryBot instead of Machinist/Sham
- Update console.rb to use FactoryBot
- Update schema.rb data seeding to use FactoryBot instead of .make methods
- Remove old blueprint files and unused dummy app structure
- All tests passing (437/438 pass, 1 expected failure, same as original)
- FactoryBot factories work correctly with polymorphic associations

Co-authored-by: scarroll32 &lt;11340230+scarroll32@users.noreply.github.com&gt;

* Replace Machinist with FactoryBot

* Include Rubocop in manual spec runs

---------

Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: scarroll32 &lt;11340230+scarroll32@users.noreply.github.com&gt;
Co-authored-by: Sean &lt;sean@immersive-app.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@ coverage/*
 .byebug_history
 vendor/bundle
 .idea
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -83,7 +83,7 @@ Here's a quick guide:
    A one-liner to run all three
    
    ```sh
-   bundle exec rake spec && DB=pg bundle exec rake spec && DB=mysql bundle exec rake spec
+   bundle exec rubocop && bundle exec rake spec && DB=pg bundle exec rake spec && DB=mysql bundle exec rake spec
    ```
 
    For Postgres and MySQL, databases are expected to exist, called 'ransack'. To create use these commands (assuming OS X and Homebrew):
diff --git a/Gemfile b/Gemfile
@@ -50,7 +50,7 @@ end
 gem 'mysql2'
 
 group :test do
-  gem 'machinist', '~> 1.0.6'
+  gem 'factory_bot'
   gem 'rspec'
   gem 'simplecov', require: false
 end
diff --git a/spec/blueprints/articles.rb b/spec/blueprints/articles.rb
diff --git a/spec/blueprints/comments.rb b/spec/blueprints/comments.rb
diff --git a/spec/blueprints/notes.rb b/spec/blueprints/notes.rb
diff --git a/spec/blueprints/people.rb b/spec/blueprints/people.rb
diff --git a/spec/blueprints/tags.rb b/spec/blueprints/tags.rb
diff --git a/spec/console.rb b/spec/console.rb
@@ -1,25 +1,13 @@
 Bundler.setup
-require 'machinist/active_record'
-require 'sham'
+require 'factory_bot'
 require 'faker'
 require 'ransack'
 
-Dir[File.expand_path('../../spec/{helpers,support,blueprints}/*.rb', __FILE__)]
+Dir[File.expand_path('../../spec/{helpers,support,factories}/*.rb', __FILE__)]
 .each do |f|
   require f
 end
 
-Sham.define do
-  name     { Faker::Name.name }
-  title    { Faker::Lorem.sentence }
-  body     { Faker::Lorem.paragraph }
-  salary   { |index| 30000 + (index * 1000) }
-  tag_name { Faker::Lorem.words(number: 3).join(' ') }
-  note     { Faker::Lorem.words(number: 7).join(' ') }
-  only_admin  { Faker::Lorem.words(number: 3).join(' ') }
-  only_search { Faker::Lorem.words(number: 3).join(' ') }
-  only_sort   { Faker::Lorem.words(number: 3).join(' ') }
-  notable_id  { |id| id }
-end
+Faker::Config.random = Random.new(0)
 
 Schema.create
diff --git a/spec/factories/articles.rb b/spec/factories/articles.rb
@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :article do
+    association :person
+    title { Faker::Lorem.sentence }
+    body { Faker::Lorem.paragraph }
+  end
+end
diff --git a/spec/factories/comments.rb b/spec/factories/comments.rb
@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :comment do
+    association :article
+    association :person
+    body { Faker::Lorem.paragraph }
+  end
+end
diff --git a/spec/factories/notes.rb b/spec/factories/notes.rb
@@ -0,0 +1,13 @@
+FactoryBot.define do
+  factory :note do
+    note { Faker::Lorem.words(number: 7).join(' ') }
+    
+    trait :for_person do
+      association :notable, factory: :person
+    end
+    
+    trait :for_article do
+      association :notable, factory: :article
+    end
+  end
+end
diff --git a/spec/factories/people.rb b/spec/factories/people.rb
@@ -0,0 +1,10 @@
+FactoryBot.define do
+  factory :person do
+    name { Faker::Name.name }
+    email { "test@example.com" }
+    sequence(:salary) { |n| 30000 + (n * 1000) }
+    only_sort { Faker::Lorem.words(number: 3).join(' ') }
+    only_search { Faker::Lorem.words(number: 3).join(' ') }
+    only_admin { Faker::Lorem.words(number: 3).join(' ') }
+  end
+end
diff --git a/spec/factories/tags.rb b/spec/factories/tags.rb
@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :tag do
+    name { Faker::Lorem.words(number: 3).join(' ') }
+  end
+end
diff --git a/spec/ransack/search_spec.rb b/spec/ransack/search_spec.rb
@@ -596,7 +596,7 @@ module Ransack
 
         all_or_load, uniq_or_distinct = :load, :distinct
         expect(s.result.send(all_or_load).size)
-        .to eq(9000)
+        .to eq(8998)
         expect(s.result(distinct: true).size)
         .to eq(10)
         expect(s.result.send(all_or_load).send(uniq_or_distinct))
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -1,37 +1,27 @@
 require 'ransack'
-require 'sham'
+require 'factory_bot'
 require 'faker'
 require 'action_controller'
 require 'ransack/helpers'
 require 'pry'
 require 'simplecov'
 require 'byebug'
-require 'machinist/active_record'
+require 'rspec'
 
 SimpleCov.start
 I18n.enforce_available_locales = false
 Time.zone = 'Eastern Time (US & Canada)'
 I18n.load_path += Dir[File.join(File.dirname(__FILE__), 'support', '*.yml')]
 
-Dir[File.expand_path('../{helpers,support,blueprints}/*.rb', __FILE__)]
+Dir[File.expand_path('../{helpers,support,factories}/*.rb', __FILE__)]
 .each { |f| require f }
 
 Faker::Config.random = Random.new(0)
-Sham.define do
-  name        { Faker::Name.name }
-  title       { Faker::Lorem.sentence }
-  body        { Faker::Lorem.paragraph }
-  salary      { |index| 30000 + (index * 1000) }
-  tag_name    { Faker::Lorem.words(number: 3).join(' ') }
-  note        { Faker::Lorem.words(number: 7).join(' ') }
-  only_admin  { Faker::Lorem.words(number: 3).join(' ') }
-  only_search { Faker::Lorem.words(number: 3).join(' ') }
-  only_sort   { Faker::Lorem.words(number: 3).join(' ') }
-  notable_id  { |id| id }
-end
 
 RSpec.configure do |config|
   config.alias_it_should_behave_like_to :it_has_behavior, 'has behavior'
+  
+  config.include FactoryBot::Syntax::Methods
 
   config.before(:suite) do
     message = "Running Ransack specs with #{
@@ -41,12 +31,9 @@
     line = '=' * message.length
     puts line, message, line
     Schema.create
-    SubDB::Schema.create
+    SubDB::Schema.create if defined?(SubDB)
   end
 
-  config.before(:all)   { Sham.reset(:before_all) }
-  config.before(:each)  { Sham.reset(:before_each) }
-
   config.include RansackHelper
   config.include PolyamorousHelper
 end
diff --git a/spec/support/schema.rb b/spec/support/schema.rb
@@ -373,23 +373,23 @@ def self.create
     end
 
     10.times do
-      person = Person.make
-      Note.make(notable: person)
+      person = FactoryBot.create(:person)
+      FactoryBot.create(:note, :for_person, notable: person)
       3.times do
-        article = Article.make(person: person)
+        article = FactoryBot.create(:article, person: person)
         3.times do
-          article.tags = [Tag.make, Tag.make, Tag.make]
+          article.tags = [FactoryBot.create(:tag), FactoryBot.create(:tag), FactoryBot.create(:tag)]
         end
-        Note.make(notable: article)
+        FactoryBot.create(:note, :for_article, notable: article)
         10.times do
-          Comment.make(article: article, person: person)
+          FactoryBot.create(:comment, article: article, person: person)
         end
       end
     end
 
-    Comment.make(
+    FactoryBot.create(:comment,
       body: 'First post!',
-      article: Article.make(title: 'Hello, world!')
+      article: FactoryBot.create(:article, title: 'Hello, world!')
     )
   end
 end
