From: Matt Amos <zerebubuth@gmail.com>
Date: Wed, 4 Apr 2012 15:10:45 +0000 (+0100)
Subject: Better comments in application controller logic
X-Git-Tag: live~5590
X-Git-Url: https://git.openstreetmap.org/rails.git/commitdiff_plain/1f9301e2e2f4253b43268eecfa9ca917a4acb6ad

Better comments in application controller logic
---

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index d98747253..791334d2d 100644
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -113,7 +113,7 @@ class ApplicationController < ActionController::Base
 
   ##
   # require that the user is a moderator, or fill out a helpful error message
-  # and return them to the blocks index.
+  # and return them to the index for the controller this is wrapped from.
   def require_moderator
     unless @user.moderator?
       if request.get?
@@ -178,6 +178,10 @@ class ApplicationController < ActionController::Base
   # to be used as a before_filter *after* authorize. this checks that
   # the user is a moderator and, if not, returns a forbidden error.
   #
+  # NOTE: this isn't a very good way of doing it - it duplicates logic
+  # from require_moderator - but what we really need to do is a fairly
+  # drastic refactoring based on :format and respond_to? but not a 
+  # good idea to do that in this branch.
   def authorize_moderator(errormessage="Access restricted to moderators") 
     # check user is a moderator
     unless @user.moderator?