Add factory bot and refine the models specs with Factory bot

Author: mkdika

Gemfile

@@ -35,7 +35,7 @@ group :development, :test do
   gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
   gem 'database_cleaner'
   gem 'factory_bot_rails'
-  gem 'faker', '1.9.1'
+  gem 'faker'
   gem 'pry'
   gem 'rubocop', '~> 0.76.0', require: false
   gem 'rubocop-performance'

Gemfile.lock

@@ -107,8 +107,8 @@ GEM
     factory_bot_rails (5.1.1)
       factory_bot (~> 5.1.0)
       railties (>= 4.2.0)
-    faker (1.9.1)
-      i18n (>= 0.7)
+    faker (2.7.0)
+      i18n (>= 1.6, < 1.8)
     ffi (1.11.3)
     font-awesome-rails (4.7.0.5)
       railties (>= 3.2, < 6.1)
@@ -338,7 +338,7 @@ DEPENDENCIES
   database_cleaner
   devise
   factory_bot_rails
-  faker (= 1.9.1)
+  faker
   font-awesome-rails
   jbuilder (~> 2.5)
   listen (>= 3.0.5, < 3.2)

README.md

@@ -17,6 +17,8 @@ This is my RoR full stack web development learning project & example, including
 - [Slim Templating 4](http://slim-lang.com/), HTML templating engine.
 - [Devise](https://github.com/plataformatec/devise), flexible authentication solution.
 - [RSpec Rails 3](https://relishapp.com/rspec/rspec-rails/v/3-9/docs), BDD and test suite.
+- [Faker](https://github.com/faker-ruby/faker), A library for generating fake data such as names, addresses, and phone numbers.
+- [Factory Bot Rails](https://github.com/thoughtbot/factory_bot_rails), a library for setting up Ruby objects as test data.
 - [Bulma CSS](https://bulma.io/), mobile first CSS framework.
 - [Postgresql 10](https://www.postgresql.org/)
 - [Peru](https://github.com/buildinspace/peru), a package manager for including other people's code in your projects.

db/schema.rb

@@ -1,15 +1,3 @@
-# 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.
-#
-# Note that this schema.rb definition is the authoritative source for your
-# database schema. If you need to create the application database on another
-# system, you should be using db:schema:load, not running all the migrations
-# from scratch. The latter is a flawed and unsustainable approach (the more migrations
-# you'll amass, the slower it'll run and the greater likelihood for issues).
-#
-# It's strongly recommended that you check this file into your version control system.
-
 ActiveRecord::Schema.define(version: 2019_11_28_134418) do
 
   # These are extensions that must be enabled in order to support this database

spec/factories/category.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :category do
+    name { Faker::Book.unique.genre }
+  end
+end

spec/factories/post.rb

@@ -0,0 +1,10 @@
+FactoryBot.define do
+  factory :post do
+    fake_title = Faker::Book.unique.title
+    title { fake_title }
+    content { "## #{fake_title}"}
+    release { false }
+    category
+    user
+  end
+end

spec/factories/tag.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :tag do
+    name { Faker::Book.unique.genre }
+  end
+end

spec/factories/user.rb

@@ -0,0 +1,16 @@
+FactoryBot.define do
+  factory :user  do
+    email { Faker::Internet.unique.email }
+    display_name { Faker::Name.name }
+    password { 'password' }
+    password_confirmation { 'password' }
+  end
+
+  trait :locked do
+    locked_at { DateTime.now }
+  end
+
+  trait :without_display_name do
+    display_name { nil }
+  end
+end

spec/models/category_spec.rb

@@ -1,7 +1,17 @@
 require 'spec_helper'
+require 'rails_helper'
 
 describe Category do
   it 'should has default columns' do
     is_expected.to have_db_column(:name).of_type(:string)
   end
+
+  describe '#paper_trail' do
+    context 'with has_paper_trail attribute' do
+      let(:dummy_data) { create :category }
+      it 'will has association with the versions table and has data' do
+        expect(dummy_data.versions.present?).to eq true
+      end
+    end
+  end
 end

spec/models/post_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'rails_helper'
 
 describe Post do
   it 'should has default columns' do
@@ -12,41 +13,46 @@
 
   it 'should has indexes' do
     is_expected.to have_db_index [:category_id]
+    is_expected.to have_db_index [:user_id]
+  end
+
+  describe '#paper_trail' do
+    context 'with has_paper_trail attribute' do
+      let(:dummy_data) { create :post }
+      it 'will has association with the versions table and has data' do
+        expect(dummy_data.versions.present?).to eq true
+      end
+    end
   end
 
   describe '#permalink' do
-    describe 'given valid title' do
+    context 'given valid title' do
+      let(:dummy_post) { create :post, title: 'Ruby is Awesome' }
       it 'will generate valid permalink' do
-        post = Post.new title: 'Ruby is Awesome', content: 'testing.'
-        expect(post.permalink).to eq 'ruby_is_awesome'
+        expect(dummy_post.permalink).to eq 'ruby_is_awesome'
       end
     end
 
-    describe 'given blank between title' do
+    context 'given blank between title' do
+      let(:dummy_post) { create :post, title: ' Ruby is Awesome    ' }
       it 'will strip blank char and generate valid permalink' do
-        post = Post.new title: ' Ruby is Awesome    ', content: 'testing.'
-        expect(post.permalink).to eq 'ruby_is_awesome'
+        expect(dummy_post.permalink).to eq 'ruby_is_awesome'
       end
     end
+  end
 
-    describe 'given valid title and generated permalink' do
-      let(:category) { Category.create name: 'Dumb'}
-      let(:user) { User.create email: '[email protected]', password: 'abc', password_confirmation: 'abc' }
-
-      after do
-        post = Post.last
-        post.destroy
-        category.destroy
-        user.destroy
+  describe '#content_to_html' do
+    context 'given valid not empty content' do
+      let(:dummy_post) { create :post, content: '### Hello' }
+      it 'will generate valid html' do
+        expect(dummy_post.content_to_html).to include '<h3>Hello</h3>'
       end
+    end
 
-      it 'will save the permalink into database correctly' do
-        post = Post.new title: 'Dummy title 123', content: 'testing', category: category, user: user
-        post.save
-        generated_permalink = 'dummy_title_123'
-        expect(post.permalink).to eq generated_permalink
-        current_data = Post.where(permalink: generated_permalink)
-        expect(current_data.present?).to eq true
+    context 'given content with html tags' do
+      let(:dummy_post) { create :post, content: '<div>hello</div>' }
+      it 'will omit the html tags and wrap it as paragraph' do
+        expect(dummy_post.content_to_html).to include '<p>hello</p>'
       end
     end
   end