From 48296b93765cffc71169e712e6a75e03119e32b7 Mon Sep 17 00:00:00 2001
From: Joshua Clayton <joshua.clayton@gmail.com>
Date: Mon, 23 Oct 2017 14:17:30 -0400
Subject: [PATCH] Deprecate factory_girl and provide upgrade instructions

---
 UPGRADE_FROM_FACTORY_GIRL.md | 48 ++++++++++++++++++++++++++++++++++++
 lib/factory_girl.rb          |  2 ++
 2 files changed, 50 insertions(+)
 create mode 100644 UPGRADE_FROM_FACTORY_GIRL.md

diff --git a/UPGRADE_FROM_FACTORY_GIRL.md b/UPGRADE_FROM_FACTORY_GIRL.md
new file mode 100644
index 000000000..08551bbc4
--- /dev/null
+++ b/UPGRADE_FROM_FACTORY_GIRL.md
@@ -0,0 +1,48 @@
+# Upgrade from factory\_girl
+
+Upgrading your codebase should involve only a few steps, and in most cases, it
+involves updating the Gemfile, factories file(s), and support file configuring
+the testing framework.
+
+## Modify your Gemfile
+
+Replace references to factory\_girl\_rails or factory\_girl with
+factory\_bot\_rails or factory\_bot. Both new gems are available starting at
+version 4.8.2.
+
+```ruby
+# Gemfile
+
+# old
+group :development, :test do
+  gem "factory_girl_rails"
+  # or
+  gem "factory_girl"
+end
+
+# new
+group :development, :test do
+  gem "factory_bot_rails"
+  # or
+  gem "factory_bot"
+end
+```
+
+## Replace All Constant References
+
+A global find-and-replace of `FactoryGirl` to `FactoryBot` across the codebase
+to replace all references with the new constant should do the trick. For
+example, on OS X:
+
+```sh
+grep -e FactoryGirl **/*.rake **/*.rb -l | xargs sed -i "" "s|FactoryGirl|FactoryBot|"
+```
+
+## Replace All Path References
+
+If you're requiring files from factory\_girl or factory\_girl\_rails directly,
+you'll have to update the paths.
+
+```sh
+grep -e factory_girl **/*.rake **/*.rb -l | xargs sed -i "" "s|factory_girl|factory_bot|"
+```
diff --git a/lib/factory_girl.rb b/lib/factory_girl.rb
index 2dc4bc18e..f37bb927d 100644
--- a/lib/factory_girl.rb
+++ b/lib/factory_girl.rb
@@ -154,3 +154,5 @@ def self.register_callback(name)
 
 FactoryGirl.register_default_strategies
 FactoryGirl.register_default_callbacks
+
+ActiveSupport::Deprecation.warn "The factory_girl gem is deprecated. Please upgrade to factory_bot. See https://github.com/thoughtbot/factory_bot/blob/v4.9.0/UPGRADE_FROM_FACTORY_GIRL.md for further instructions."