Format using Rubocop & add simpleCov to check code test coverage

kwatts949 · kwatts949 · commit 67a6f624e21d · 2022-12-13T09:59:10.000Z
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+coverage
diff --git a/Gemfile b/Gemfile
@@ -5,3 +5,7 @@ source 'https://rubygems.org'
 # gem "rails"
 
 gem 'rspec', '~> 3.12'
+
+# gem "simplecov"
+
+gem 'simplecov', require: false, group: :test
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -2,6 +2,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.5.0)
+    docile (1.4.0)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -15,12 +16,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
 
 PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
   rspec (~> 3.12)
+  simplecov
 
 BUNDLED WITH
    2.3.26
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <h1> Banking App <h1> 
-<h4>A tech test to practice code quality. <h4>
 <div>
+A tech test to practice code quality.
 <h5>
 <a href='https://github.com/kwatts949/banking_app/blob/main/README.md#Specification'> Specification </a> <span> · </span>
 <a href='https://github.com/kwatts949/banking_app/blob/main/README.md#Installation'> Installation </a><span> · </span>
@@ -78,6 +78,7 @@ Example output: <br>
 
 To run the tests:
 ```
+$ cd banking_app
 $ rspec
 ```
 
diff --git a/lib/account.rb b/lib/account.rb
@@ -23,17 +23,3 @@ def print_statement
     @statement.display(@transactions)
   end
 end
-
-=begin
-account = Account.new
-
-transaction_1 = Transaction.new(1000, "10-01-2023")
-transaction_2 = Transaction.new(2000, "13-01-2023")
-transaction_3 = Transaction.new(500, "14-01-2023")
-
-account.deposit(transaction_1)
-account.deposit(transaction_2)
-account.withdraw(transaction_3)
-
-account.print_statement
-=end
diff --git a/lib/statement.rb b/lib/statement.rb
@@ -24,7 +24,7 @@ def print_transactions(transactions)
   end
 
   def print_header
-    p "date || credit || debit || balance"
+    p 'date || credit || debit || balance'
   end
 
   def print_empty
diff --git a/resources/.DS_Store b/resources/.DS_Store
diff --git a/spec/account_spec.rb b/spec/account_spec.rb
@@ -9,39 +9,38 @@
   context 'making a withdrawal' do
     it 'returns an array of withdrawal objects' do
       account = Account.new
-      fake_withdrawal_1 = double(amount: 500, date: "01-12-2022", credit: nil)
-      fake_withdrawal_2 = double(amount: 700, date: "02-12-2022", credit: nil)
-      account.withdraw(fake_withdrawal_1)
-      account.withdraw(fake_withdrawal_2)
-      expect(account.transactions).to eq [fake_withdrawal_1, fake_withdrawal_2]
+      fake_withdrawal1 = double(amount: 500, date: '01-12-2022', credit: nil)
+      fake_withdrawal2 = double(amount: 700, date: '02-12-2022', credit: nil)
+      account.withdraw(fake_withdrawal1)
+      account.withdraw(fake_withdrawal2)
+      expect(account.transactions).to eq [fake_withdrawal1, fake_withdrawal2]
     end
   end
 
   context 'making a deposit' do
     it 'returns an array of deposit objects' do
       account = Account.new
-      fake_deposit_1 = double(amount: 1000, date: "01-12-2022", credit: nil)
-      fake_deposit_2 = double(amount: 700, date: "02-12-2022", credit: nil)
-      expect(fake_deposit_1).to receive(:credit=).with('true')
-      account.deposit(fake_deposit_1)
-      expect(fake_deposit_2).to receive(:credit=).with('true')
-      account.deposit(fake_deposit_2)
-      expect(account.transactions).to eq [fake_deposit_1, fake_deposit_2]
+      fake_deposit1 = double(amount: 1000, date: '01-12-2022', credit: nil)
+      fake_deposit2 = double(amount: 700, date: '02-12-2022', credit: nil)
+      expect(fake_deposit1).to receive(:credit=).with('true')
+      account.deposit(fake_deposit1)
+      expect(fake_deposit2).to receive(:credit=).with('true')
+      account.deposit(fake_deposit2)
+      expect(account.transactions).to eq [fake_deposit1, fake_deposit2]
     end
   end
 
   context 'making a deposit & withdrawal' do
     it 'returns an array of objects' do
       account = Account.new
 
-      fake_deposit_1 = double(amount: 1000, date: "01-12-2022", credit: 'true')
-      fake_withdrawal_1 = double(amount: 500, date: "01-12-2022", credit: nil)
+      fake_deposit1 = double(amount: 1000, date: '01-12-2022', credit: 'true')
+      fake_withdrawal1 = double(amount: 500, date: '01-12-2022', credit: nil)
 
-      expect(fake_deposit_1).to receive(:credit=).with('true')
-      account.deposit(fake_deposit_1)
-      account.withdraw(fake_withdrawal_1)
-      
-      expect(account.transactions).to eq [fake_deposit_1, fake_withdrawal_1]
+      expect(fake_deposit1).to receive(:credit=).with('true')
+      account.deposit(fake_deposit1)
+      account.withdraw(fake_withdrawal1)
+      expect(account.transactions).to eq [fake_deposit1, fake_withdrawal1]
     end
   end
 
@@ -50,26 +49,26 @@
       account = Account.new
       expect do
         account.print_statement
-      end.to output( "\"date || credit || debit || balance\"\n\"  ||  ||  || 0.00\"\n").to_stdout
+      end.to output("\"date || credit || debit || balance\"\n\"  ||  ||  || 0.00\"\n").to_stdout
     end
 
     it 'returns a statement with deposits and withdrawals' do
       account = Account.new
 
-      fake_deposit_1 = double(amount: 1000, date: "01-12-2022", credit: 'true')
-      fake_deposit_2 = double(amount: 2000, date: "02-12-2022", credit: 'true')
-      fake_withdrawal_1 = double(amount: 500, date: "03-12-2022", credit: nil)
+      fake_deposit1 = double(amount: 1000, date: '01-12-2022', credit: 'true')
+      fake_deposit2 = double(amount: 2000, date: '02-12-2022', credit: 'true')
+      fake_withdrawal1 = double(amount: 500, date: '03-12-2022', credit: nil)
 
-      expect(fake_deposit_1).to receive(:credit=).with('true')
-      expect(fake_deposit_2).to receive(:credit=).with('true')
+      expect(fake_deposit1).to receive(:credit=).with('true')
+      expect(fake_deposit2).to receive(:credit=).with('true')
 
-      account.deposit(fake_deposit_1)
-      account.deposit(fake_deposit_2)
-      account.withdraw(fake_withdrawal_1)
+      account.deposit(fake_deposit1)
+      account.deposit(fake_deposit2)
+      account.withdraw(fake_withdrawal1)
 
       expect do
         account.print_statement
       end.to output("\"date || credit || debit || balance\"\n\"03-12-2022 || || 500.00 || 2500.00\"\n\"02-12-2022 || 2000.00 || || 3000.00\"\n\"01-12-2022 || 1000.00 || || 1000.00\"\n").to_stdout
     end
   end
-end
+end
diff --git a/spec/integration_tests_spec.rb b/spec/integration_tests_spec.rb
@@ -11,12 +11,12 @@
     end
 
     it 'returns a multiple deposit transaction' do
-      transaction_1 = Transaction.new(500, '10-12-2022')
-      transaction_2 = Transaction.new(300, '12-12-2022')
+      transaction1 = Transaction.new(500, '10-12-2022')
+      transaction2 = Transaction.new(300, '12-12-2022')
       account = Account.new
-      account.deposit(transaction_1)
-      account.deposit(transaction_2)
-      expect(account.transactions).to eq [transaction_1, transaction_2]
+      account.deposit(transaction1)
+      account.deposit(transaction2)
+      expect(account.transactions).to eq [transaction1, transaction2]
     end
   end
 
@@ -30,12 +30,12 @@
   end
 
   it 'returns multiple withdrawal transaction' do
-    transaction_1 = Transaction.new(500, '10-12-2022')
-    transaction_2 = Transaction.new(300, '12-12-2022')
+    transaction1 = Transaction.new(500, '10-12-2022')
+    transaction2 = Transaction.new(300, '12-12-2022')
     account = Account.new
-    account.withdraw(transaction_1)
-    account.withdraw(transaction_2)
-    expect(account.transactions).to eq [transaction_1, transaction_2]
+    account.withdraw(transaction1)
+    account.withdraw(transaction2)
+    expect(account.transactions).to eq [transaction1, transaction2]
   end
 
   context 'printing a statement' do
@@ -48,41 +48,41 @@
 
     it 'returns a statement containing a deposit' do
       account = Account.new
-      transaction_1 = Transaction.new(500, '10-12-2022')
-      account.deposit(transaction_1)
+      transaction1 = Transaction.new(500, '10-12-2022')
+      account.deposit(transaction1)
       expect do
         account.print_statement
       end.to output("\"date || credit || debit || balance\"\n\"10-12-2022 || 500.00 || || 500.00\"\n").to_stdout
     end
 
     it 'returns a statement containing two deposits' do
       account = Account.new
-      transaction_1 = Transaction.new(500, '10-12-2022')
-      transaction_2 = Transaction.new(300, '12-12-2022')
-      account.deposit(transaction_1)
-      account.deposit(transaction_2)
+      transaction1 = Transaction.new(500, '10-12-2022')
+      transaction2 = Transaction.new(300, '12-12-2022')
+      account.deposit(transaction1)
+      account.deposit(transaction2)
       expect do
         account.print_statement
       end.to output("\"date || credit || debit || balance\"\n\"12-12-2022 || 300.00 || || 800.00\"\n\"10-12-2022 || 500.00 || || 500.00\"\n").to_stdout
     end
 
     it 'returns a statement containing a withdrawal' do
       account = Account.new
-      transaction_1 = Transaction.new(500, '10-12-2022')
-      account.withdraw(transaction_1)
+      transaction1 = Transaction.new(500, '10-12-2022')
+      account.withdraw(transaction1)
       expect do
         account.print_statement
       end.to output("\"date || credit || debit || balance\"\n\"10-12-2022 || || 500.00 || -500.00\"\n").to_stdout
     end
 
     it 'returns a statement containing withdrawals and deposits' do
       account = Account.new
-      transaction_1 = Transaction.new(500, '10-12-2022')
-      transaction_2 = Transaction.new(300, '12-12-2022')
-      transaction_3 = Transaction.new(100, '12-12-2022')
-      account.deposit(transaction_1)
-      account.withdraw(transaction_2)
-      account.deposit(transaction_3)
+      transaction1 = Transaction.new(500, '10-12-2022')
+      transaction2 = Transaction.new(300, '12-12-2022')
+      transaction3 = Transaction.new(100, '12-12-2022')
+      account.deposit(transaction1)
+      account.withdraw(transaction2)
+      account.deposit(transaction3)
       expect do
         account.print_statement
       end.to output("\"date || credit || debit || balance\"\n\"12-12-2022 || 100.00 || || 300.00\"\n\"12-12-2022 || || 300.00 || 200.00\"\n\"10-12-2022 || 500.00 || || 500.00\"\n").to_stdout
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -1,3 +1,11 @@
+require 'simplecov'
+require 'simplecov-console'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::Console,
+  SimpleCov::Formatter::HTMLFormatter
+])
+SimpleCov.start
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause
diff --git a/spec/statement_spec.rb b/spec/statement_spec.rb
@@ -3,46 +3,46 @@
 RSpec.describe 'Statement' do
   it 'prints an empty statement to the console' do
     statement = Statement.new
-      expect do
-        statement.display([])
-      end.to output("\"date || credit || debit || balance\"\n\"  ||  ||  || 0.00\"\n").to_stdout
+    expect do
+      statement.display([])
+    end.to output("\"date || credit || debit || balance\"\n\"  ||  ||  || 0.00\"\n").to_stdout
   end
 
   context 'deposits' do
     it 'prints a deposit transaction to the console' do
       statement = Statement.new
-      fake_deposit = double(:deposit, amount: 500, date: "01-12-2022", credit: 'true')
+      fake_deposit = double(:deposit, amount: 500, date: '01-12-2022', credit: 'true')
       expect do
         statement.display([fake_deposit])
       end.to output("\"date || credit || debit || balance\"\n\"01-12-2022 || 500.00 || || 500.00\"\n").to_stdout
     end
 
     it 'prints two deposit transactions to the console and shows the correct balance' do
       statement = Statement.new
-      fake_deposit_1 = double(:deposit, amount: 500, date: "01-12-2022", credit: 'true')
-      fake_deposit_2 = double(:deposit, amount: 800, date: "02-12-2022", credit: 'true')
-        expect do
-          statement.display([fake_deposit_1, fake_deposit_2])
-        end.to output("\"date || credit || debit || balance\"\n\"02-12-2022 || 800.00 || || 1300.00\"\n\"01-12-2022 || 500.00 || || 500.00\"\n").to_stdout
+      fake_deposit1 = double(:deposit, amount: 500, date: '01-12-2022', credit: 'true')
+      fake_deposit2 = double(:deposit, amount: 800, date: '02-12-2022', credit: 'true')
+      expect do
+        statement.display([fake_deposit1, fake_deposit2])
+      end.to output("\"date || credit || debit || balance\"\n\"02-12-2022 || 800.00 || || 1300.00\"\n\"01-12-2022 || 500.00 || || 500.00\"\n").to_stdout
     end
   end
 
   context 'withdrawals' do
     it 'prints a single withdrawal to the console' do
       statement = Statement.new
-      fake_withdrawal_1 = double(:withdrawal, amount: 500, date: "01-12-2022", credit: nil)
-        expect do
-          statement.display([fake_withdrawal_1])
-        end.to output("\"date || credit || debit || balance\"\n\"01-12-2022 || || 500.00 || -500.00\"\n").to_stdout
+      fake_withdrawal1 = double(:withdrawal, amount: 500, date: '01-12-2022', credit: nil)
+      expect do
+        statement.display([fake_withdrawal1])
+      end.to output("\"date || credit || debit || balance\"\n\"01-12-2022 || || 500.00 || -500.00\"\n").to_stdout
     end
 
     it 'prints two withdrawals to the console & displays the correct balance' do
       statement = Statement.new
-      fake_withdrawal_1 = double(:withdrawal, amount: 500, date: "01-12-2022", credit: nil)
-      fake_withdrawal_2 = double(:withdrawal, amount: 1000, date: "03-12-2022", credit: nil)
-        expect do
-          statement.display([fake_withdrawal_1, fake_withdrawal_2])
-        end.to output("\"date || credit || debit || balance\"\n\"03-12-2022 || || 1000.00 || -1500.00\"\n\"01-12-2022 || || 500.00 || -500.00\"\n").to_stdout
+      fake_withdrawal1 = double(:withdrawal, amount: 500, date: '01-12-2022', credit: nil)
+      fake_withdrawal2 = double(:withdrawal, amount: 1000, date: '03-12-2022', credit: nil)
+      expect do
+        statement.display([fake_withdrawal1, fake_withdrawal2])
+      end.to output("\"date || credit || debit || balance\"\n\"03-12-2022 || || 1000.00 || -1500.00\"\n\"01-12-2022 || || 500.00 || -500.00\"\n").to_stdout
     end
   end
 end
