Merge pull request #735 from alphagov/change_factory_girl_to_bot

Swap factory girl to factory bot

Author: edwardkerry

Gemfile

@@ -36,7 +36,7 @@ group :development, :test do
   gem 'brakeman', '~> 4.2'
   gem 'byebug', '~> 9'
   gem 'dotenv-rails', '~> 2.2'
-  gem 'factory_girl_rails', '~> 4.0'
+  gem 'factory_bot_rails', '~> 4.0'
   gem 'govuk-lint', '~> 3.8.0'
   gem 'pry', '~> 0.10'
   gem 'pry-byebug', '~> 3.4'

Gemfile.lock

@@ -93,10 +93,10 @@ GEM
     et-orbi (1.1.2)
       tzinfo
     execjs (2.7.0)
-    factory_girl (4.8.0)
+    factory_bot (4.11.1)
       activesupport (>= 3.0.0)
-    factory_girl_rails (4.8.0)
-      factory_girl (~> 4.8.0)
+    factory_bot_rails (4.11.1)
+      factory_bot (~> 4.11.1)
       railties (>= 3.0.0)
     faraday (0.12.1)
       multipart-post (>= 1.2, < 3)
@@ -434,7 +434,7 @@ DEPENDENCIES
   elasticsearch (~> 5.0.4)
   elasticsearch-model (~> 5.0.1)
   elasticsearch-rails (~> 5.0.1)
-  factory_girl_rails (~> 4.0)
+  factory_bot_rails (~> 4.0)
   gds-sso
   govuk-lint (~> 3.8.0)
   govuk_elements_rails
@@ -476,4 +476,4 @@ RUBY VERSION
    ruby 2.5.0p0
 
 BUNDLED WITH
-   1.16.3
+   1.16.6

spec/controllers/datasets_controller_spec.rb

@@ -1,50 +1,50 @@
 require 'rails_helper'
 
 describe DatasetsController, type: :controller do
-  let(:organisation) { FactoryGirl.create(:organisation) }
-  let(:user) { FactoryGirl.create(:user, primary_organisation: organisation) }
+  let(:organisation) { FactoryBot.create(:organisation) }
+  let(:user) { FactoryBot.create(:user, primary_organisation: organisation) }
 
   before do
     sign_in_as(user)
   end
 
   it "redirects to slugged URL" do
-    dataset = FactoryGirl.create(:dataset,
+    dataset = FactoryBot.create(:dataset,
                                  name: "legit-name",
                                  organisation: organisation,
-                                 datafiles: [FactoryGirl.create(:datafile)])
+                                 datafiles: [FactoryBot.create(:datafile)])
 
     get :show, params: { uuid: dataset.uuid, name: "absolute-nonsense-name" }
 
     expect(response).to redirect_to(dataset_url(dataset.uuid, dataset.name))
   end
 
   it "returns '503 forbidden' error if a user is not allowed to view the requested dataset" do
-    another_organisation = FactoryGirl.create(:organisation)
+    another_organisation = FactoryBot.create(:organisation)
 
-    _allowed_dataset = FactoryGirl.create(:dataset,
+    _allowed_dataset = FactoryBot.create(:dataset,
                                           organisation: organisation,
-                                          datafiles: [FactoryGirl.create(:datafile)])
+                                          datafiles: [FactoryBot.create(:datafile)])
 
-    forbidden_dataset = FactoryGirl.create(:dataset,
+    forbidden_dataset = FactoryBot.create(:dataset,
                                            organisation: another_organisation,
-                                           datafiles: [FactoryGirl.create(:datafile)])
+                                           datafiles: [FactoryBot.create(:datafile)])
 
     get :show, params: { uuid: forbidden_dataset.uuid, name: forbidden_dataset.name }
 
     expect(response).to have_http_status(403)
   end
 
   it "returns '503 forbidden' error if a user is not allowed to update the requested dataset" do
-    another_organisation = FactoryGirl.create(:organisation)
+    another_organisation = FactoryBot.create(:organisation)
 
-    _allowed_dataset = FactoryGirl.create(:dataset,
+    _allowed_dataset = FactoryBot.create(:dataset,
                                           organisation: organisation,
-                                          datafiles: [FactoryGirl.create(:datafile)])
+                                          datafiles: [FactoryBot.create(:datafile)])
 
-    forbidden_dataset = FactoryGirl.create(:dataset,
+    forbidden_dataset = FactoryBot.create(:dataset,
                                            organisation: another_organisation,
-                                           datafiles: [FactoryGirl.create(:datafile)])
+                                           datafiles: [FactoryBot.create(:datafile)])
 
     get :edit, params: { uuid: forbidden_dataset.uuid, name: forbidden_dataset.name }
 

spec/factories/ckan_v26_ckan_org.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :ckan_v26_ckan_org, class: CKAN::V26::CKANOrg do
     id SecureRandom.uuid
     name "Name"

spec/factories/ckan_v26_package.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :ckan_v26_package, class: CKAN::V26::Package do
     name "Name"
     title "Title"

spec/factories/ckan_v26_resource.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :ckan_v26_resource, class: CKAN::V26::Resource do
     url "http://environment.data.gov.uk/ds/wms?SERVICE=WMS&INTERFACE=ENVIRONMENT--86ec354f-d465-11e4-b09e-f0def148f590&request=GetCapabilities"
     format "WMS"

spec/factories/datafile.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :datafile do
     dataset
     url 'http://google.com'

spec/factories/dataset.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :dataset do
     organisation
     title "Price paid for dragon glass"

spec/factories/doc.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :doc do
     dataset
     url 'http://google.com'

spec/factories/inspire_dataset.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :inspire_dataset do
     dataset_reference_date do
       "[{\"type\": \"publication\", \"value\": \"2015-12-03\"}, {\"type\": \"revision\", \"value\": \"2015-12-03\"}, {\"type\": \"creation\", \"value\": \"2006-01-01\"}]"

spec/factories/link.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :link do
     dataset
     url 'http://google.com'

spec/factories/organisation.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :organisation do
     name "land-registry"
     title "Land Registry"

spec/factories/topic.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :topic do
     name "business-and-economy"
     title "Business and Economy"

spec/factories/user.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :user do
     email '[email protected]'
     name 'Test User'

spec/features/dataset_create_spec.rb

@@ -1,10 +1,10 @@
 require "rails_helper"
 
 describe "creating datasets" do
-  let(:land) { FactoryGirl.create(:organisation, name: 'land-registry', title: 'Land Registry') }
-  let!(:user) { FactoryGirl.create(:user, primary_organisation: land) }
-  let!(:dataset) { FactoryGirl.create(:dataset, organisation: land, creator: user) }
-  let!(:topic) { FactoryGirl.create(:topic) }
+  let(:land) { FactoryBot.create(:organisation, name: 'land-registry', title: 'Land Registry') }
+  let!(:user) { FactoryBot.create(:user, primary_organisation: land) }
+  let!(:dataset) { FactoryBot.create(:dataset, organisation: land, creator: user) }
+  let!(:topic) { FactoryBot.create(:topic) }
 
   context "when the user goes through entire flow" do
     before(:each) do
@@ -135,9 +135,9 @@
 end
 
 describe "starting a new draft with invalid inputs" do
-  let(:land) { FactoryGirl.create(:organisation, name: 'land-registry', title: 'Land Registry') }
-  let!(:user) { FactoryGirl.create(:user, primary_organisation: land) }
-  let!(:topic) { FactoryGirl.create(:topic) }
+  let(:land) { FactoryBot.create(:organisation, name: 'land-registry', title: 'Land Registry') }
+  let!(:user) { FactoryBot.create(:user, primary_organisation: land) }
+  let!(:topic) { FactoryBot.create(:topic) }
 
   before(:each) do
     url = "https://test.data.gov.uk/api/3/action/package_patch"
@@ -192,9 +192,9 @@
 end
 
 describe "valid options for topic, licence and area" do
-  let(:land_registry) { FactoryGirl.create(:organisation, name: 'land-registry', title: 'Land Registry') }
-  let!(:user) { FactoryGirl.create(:user, primary_organisation: land_registry) }
-  let!(:topic) { FactoryGirl.create(:topic) }
+  let(:land_registry) { FactoryBot.create(:organisation, name: 'land-registry', title: 'Land Registry') }
+  let!(:user) { FactoryBot.create(:user, primary_organisation: land_registry) }
+  let!(:topic) { FactoryBot.create(:topic) }
 
   before(:each) do
     url = "https://test.data.gov.uk/api/3/action/package_patch"
@@ -257,9 +257,9 @@
 end
 
 describe "dataset frequency options" do
-  let(:land) { FactoryGirl.create(:organisation, name: 'land-registry', title: 'Land Registry') }
-  let!(:user) { FactoryGirl.create(:user, primary_organisation: land) }
-  let!(:dataset) { FactoryGirl.create(:dataset, organisation: land) }
+  let(:land) { FactoryBot.create(:organisation, name: 'land-registry', title: 'Land Registry') }
+  let!(:user) { FactoryBot.create(:user, primary_organisation: land) }
+  let!(:dataset) { FactoryBot.create(:dataset, organisation: land) }
 
   before(:each) do
     url = "https://test.data.gov.uk/api/3/action/package_patch"
@@ -410,9 +410,9 @@ def pick_year(year_type)
 end
 
 describe "passing the frequency page" do
-  let(:land) { FactoryGirl.create(:organisation, name: 'land-registry', title: 'Land Registry') }
-  let!(:user) { FactoryGirl.create(:user, primary_organisation: land) }
-  let!(:dataset) { FactoryGirl.create(:dataset, organisation: land, frequency: nil) }
+  let(:land) { FactoryBot.create(:organisation, name: 'land-registry', title: 'Land Registry') }
+  let!(:user) { FactoryBot.create(:user, primary_organisation: land) }
+  let!(:dataset) { FactoryBot.create(:dataset, organisation: land, frequency: nil) }
 
   before(:each) do
     url = "https://test.data.gov.uk/api/3/action/package_patch"

spec/features/dataset_index_spec.rb

@@ -1,10 +1,10 @@
 require 'rails_helper'
 
 describe "managing datasets" do
-  let(:organisation) { FactoryGirl.create(:organisation) }
-  let!(:user) { FactoryGirl.create(:user, primary_organisation: organisation) }
-  let!(:dataset_1) { FactoryGirl.create(:dataset, title: "Cats per square mile", organisation: organisation) }
-  let!(:dataset_2) { FactoryGirl.create(:dataset, title: "Dogs per square mile", organisation: organisation) }
+  let(:organisation) { FactoryBot.create(:organisation) }
+  let!(:user) { FactoryBot.create(:user, primary_organisation: organisation) }
+  let!(:dataset_1) { FactoryBot.create(:dataset, title: "Cats per square mile", organisation: organisation) }
+  let!(:dataset_2) { FactoryBot.create(:dataset, title: "Dogs per square mile", organisation: organisation) }
 
   before(:each) do
     sign_in_as(user)
@@ -48,7 +48,7 @@
   end
 
   it "paginates datasets" do
-    FactoryGirl.create(:dataset, organisation: organisation) # create a third dataset
+    FactoryBot.create(:dataset, organisation: organisation) # create a third dataset
     datasets_per_page = 2
 
     visit manage_organisation_path(per: datasets_per_page)

spec/features/log_in_spec.rb

@@ -1,8 +1,8 @@
 require 'rails_helper'
 
 describe "logging in" do
-  let(:land_registry) { FactoryGirl.create(:organisation, name: 'land-registry', title: 'Land Registry') }
-  let!(:user) { FactoryGirl.create(:user, primary_organisation: land_registry) }
+  let(:land_registry) { FactoryBot.create(:organisation, name: 'land-registry', title: 'Land Registry') }
+  let!(:user) { FactoryBot.create(:user, primary_organisation: land_registry) }
 
   it "redirects logged in users to the manage page" do
     sign_in_as(user)

spec/models/datafile_spec.rb

@@ -6,7 +6,7 @@
   ANNUALLY = 'annually'.freeze
 
   before do
-    @datafile = FactoryGirl.create(:datafile)
+    @datafile = FactoryBot.create(:datafile)
   end
 
   describe 'creation' do

spec/models/dataset_spec.rb

@@ -20,14 +20,14 @@
   end
 
   it "generates a unique slug and stores it on the name column" do
-    dataset = FactoryGirl.create(:dataset,
+    dataset = FactoryBot.create(:dataset,
                                  title: "My awesome dataset")
 
     expect(dataset.name).to eq(dataset.title.parameterize)
   end
 
   it "generates a new slug when the title has changed" do
-    dataset = FactoryGirl.create(:dataset,
+    dataset = FactoryBot.create(:dataset,
                                  uuid: 1234,
                                  title: "My awesome dataset")
 

spec/models/link_spec.rb

@@ -2,7 +2,7 @@
 
 describe Link, type: :model do
   before do
-    @link = FactoryGirl.create(:link)
+    @link = FactoryBot.create(:link)
   end
 
   describe 'creation' do

spec/spec_helper.rb

@@ -1,7 +1,7 @@
 ENV["RAILS_ENV"] = 'test'
 
 require "simplecov"
-require "factory_girl_rails"
+require "factory_bot_rails"
 require "database_cleaner"
 require "govuk_sidekiq/testing"
 require 'webmock/rspec'
@@ -14,7 +14,7 @@
 SimpleCov.start unless ENV["NO_RCOV"]
 
 RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
+  config.include FactoryBot::Syntax::Methods
   config.include WebMock::API
 
   config.order = :random