\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{Ash Angell} \pdfinfo{ /Title (factorybot.pdf) /Creator (Cheatography) /Author (Ash Angell) /Subject (FactoryBot Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{5E29A3} \definecolor{LightBackground}{HTML}{F4F1F9} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{FactoryBot Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Ash Angell} via \textcolor{DarkBackground}{\uline{cheatography.com/120958/cs/21962/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}Ash Angell \\ \uline{cheatography.com/ash-angell} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 7th March, 2020.\\ Updated 8th March, 2020.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{2} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Defining factories}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{FactoryBot.define do \newline \newline \# Default \newline \# It will use the User class \newline factory :user do \newline first\_name \{ "John" \} \newline last\_name \{ "Doe" \} \newline admin \{ false \} \newline end \newline \newline \# Specifying the class \newline \# It will use the User class, instead of Admin class \newline factory :admin, class: User do \newline first\_name \{ "Admin" \} \newline last\_name \{ "User" \} \newline admin \{ true \} \newline end \newline end} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Options (transients)}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{factory :user do \newline transient do \newline upcased true \newline end \newline \newline after :create do |user, options| \newline user.name.upcase! if options.upcased \newline end \newline end \newline \newline create(user, upcased: true)} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Transient attributes will not get passed to the model, but will be available in after-create hooks.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Nested Factories}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{factory :user do \newline first\_name 'John' \newline \newline factory :sample\_user do \newline first\_name \{ Faker::Name.first\_name \} \newline end \newline end \newline \newline create :sample\_user} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Traits}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{FactoryBot.define do \newline factory :post do \newline title \{ 'An awesome post' \} \newline body \{ 'Lorem Ipsum...' \} \newline \newline trait :published do \newline status \{ :published \} \newline end \newline \newline trait :unpublished do \newline status \{ :draft \} \newline end \newline \newline trait :with\_comments do \newline after(:create) do |post| \newline create\_list :comment, 2, todo\_item: post \newline end \newline end \newline end \newline end \newline \newline \# then in your test \newline let(:post) \{ create(:post, :published) \} \newline \newline \# or even with \newline let(:post) \{ create(:post, :published, :with\_comments) \}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Trait helps you to remove duplication.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Building factories}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{\# Returns an User instance that's not saved \newline user = FactoryBot.build(:user) \newline \newline \# Returns a saved User instance \newline user = FactoryBot.create(:user) \newline \newline \# Returns a hash of attributes that can be used to build an User instance \newline attrs = \seqsplit{FactoryBot.attributes\_for(:user)} \newline \newline \# Returns an object with all defined attributes stubbed out \newline stub = \seqsplit{FactoryBot.build\_stubbed(:user)} \newline \newline \# Passing a block to any of the methods above will yield the return object \newline FactoryBot.create(:user) do |user| \newline \seqsplit{user.posts.create(attributes\_for(:post))} \newline end \newline \newline \# Overriding attributes of a factory \newline user = FactoryBot.build(:user, first\_name: "Joe") \newline user.first\_name \newline \# =\textgreater{} "Joe" \newline \newline \# No matter which build strategy is used to override attributes \newline user = FactoryBot.create(:user, first\_name: "Joe") \newline user.first\_name \newline \# =\textgreater{} "Joe"} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Associations}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{\# If the factory name is the same as the association name, it's simple \newline factory :post do \newline author \newline end \newline \newline \# You can also specify a different factory or override attributes \newline factory :post do \newline \# ... \newline association :author, factory: :user, last\_name: "Writely" \newline end \newline \newline \# Builds and saves a User and a Post \newline post = FactoryBot.create(:post) \newline post.new\_record? \# =\textgreater{} false \newline post.author.new\_record? \# =\textgreater{} false \newline \newline \# Builds and saves a User, and then builds but does not save a Post \newline post = FactoryBot.build(:post) \newline post.new\_record? \# =\textgreater{} true \newline post.author.new\_record? \# =\textgreater{} false} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Dependent attributes}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{factory :user do \newline first\_name \{ "Joe" \} \newline last\_name \{ "Blow" \} \newline email \{ "\#\{first\_name\}.\#\{last\_name\}@example.com".downcase \} \newline end} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Attributes can be based on the values of other attributes.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Aliases}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{factory :user, aliases: {[}:author, :commenter{]} do \newline first\_name \{ "John" \} \newline last\_name \{ "Doe" \} \newline date\_of\_birth \{ 18.years.ago \} \newline end \newline \newline factory :post do \newline \# instead of association :author, factory: :user \newline author \newline title \{ "How to read a book effectively" \} \newline body \{ "There are five steps involved." \} \newline end \newline \newline factory :comment do \newline \# instead of association :commenter, factory: :user \newline commenter \newline body \{ "Great article!" \} \newline end} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Aliases allow to use named associations more easily.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}