Merge pull request #18 from calebowens/add-bullet

Install bullet gem and update readme

Author: Caleb-T-Owens

Gemfile

@@ -77,6 +77,8 @@ group :development do
 
   # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
   # gem "spring"
+
+  gem "bullet"
 end
 
 group :test do

Gemfile.lock

@@ -106,6 +106,9 @@ GEM
     bootsnap (1.18.3)
       msgpack (~> 1.2)
     builder (3.2.4)
+    bullet (7.1.6)
+      activesupport (>= 3.0.0)
+      uniform_notifier (~> 1.11)
     capybara (3.40.0)
       addressable
       matrix
@@ -334,6 +337,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
+    uniform_notifier (1.16.0)
     validates_email_format_of (1.7.2)
       i18n
     web-console (4.2.1)
@@ -358,6 +362,7 @@ PLATFORMS
 DEPENDENCIES
   bcrypt (~> 3.1.7)
   bootsnap
+  bullet
   capybara
   cuprite
   dartsass-rails (~> 0.5.0)

config/environments/development.rb

@@ -65,4 +65,10 @@
   config.middleware.use(JsRoutes::Middleware)
 
   config.web_console.permissions = "0.0.0.0/0"
+
+  config.after_initialize do
+    Bullet.enable = true
+    Bullet.alert = true
+    Bullet.rails_logger = true
+  end
 end

readme.md

@@ -1,5 +1,16 @@
 # README
 
+## Production Readyness
+
+There are two goals for this project
+1. To try and build a starting point which I can use to put together a project in a very short amount of time.
+2. To try and answer some of the "what ifs" that I end up thinking about at my day job, but would be wholly
+   inapropriate to implement in a work setting due to their "unrailsy" nature
+
+While this is a project that I'm using in apps that I hope will serve real customers, and I'm putting a reasonable
+effort into mantaining this. Given the fact that there are experiemental code structure choises and dev builds
+importmaps, caution is advised!
+
 ## Development environment setup
 
 ### Pre-Commit Hooks
@@ -60,6 +71,7 @@ Everyone should have pre-commit hooks setup!
     omniauth, or replace with another authentication system.
 - Caching
   - [Solid Cache](https://github.com/rails/solid_cache)
+- N+1 catching via [Bullet](https://github.com/flyerhzm/bullet)
 
 ## Style
 
@@ -110,13 +122,17 @@ class Authentication::Pages::LoginController < ApplicationController
     validates_presence_of :email
     validates_presence_of :password
 
+    validate :ensure_user_exists # Must run last for security
+
     def user
       @user ||= User.from_login_details(email:, password:)
     end
 
     def ensure_user_exists
+      return unless errors.blank?
+
       if user.nil?
-        errors.add :email, :no_user, message: "The email and password provided did not match our records"
+        errors.add :email, :no_user, message: "and password provided did not match our records"
       end
     end
   end
@@ -156,11 +172,7 @@ class Authentication::Pages::LoginController < ApplicationController
   def submit
     ViewContext.form_object = FormObject.new(user_params)
 
-    if ViewContext.form_object.validations_passed?
-      ViewContext.form_object.ensure_user_exists
-    end
-
-    if ViewContext.form_object.validations_passed?
+    if ViewContext.form_object.valid?
       ViewContext.form_object.user.add_to_session(session)
 
       redirect_to dashboard_home_path, status: :see_other
@@ -181,5 +193,3 @@ class Authentication::Pages::LoginController < ApplicationController
   end
 end
 ```
-
-