Permalink
Browse files

Add comment markers to aid code readability.

  • Loading branch information...
1 parent 1241144 commit 4c75d855ea82d1dc167c93ec9e8de9e77c66d709 @leenookx committed Feb 26, 2011
@@ -11,16 +11,26 @@ class ApplicationController < ActionController::Base
before_filter :set_user
protected
+
+ # #####################################################
+ #
+ # #####################################################
def set_user
@user = User.find(session[:id]) if @user.nil? && session[:id]
end
+ # #####################################################
+ #
+ # #####################################################
def login_required
return true if @user
access_denied
return false
end
+ # #####################################################
+ #
+ # #####################################################
def access_denied
session[:return_to] = request.request_uri
flash[:error] = 'Oops. You need to login before you can view that page.'
@@ -3,6 +3,9 @@ class HomeController < ApplicationController
include ApplicationHelper
+ # #####################################################
+ #
+ # #####################################################
def index
@title = "Spengler - A bumpy journey into the semantic web."
end
@@ -1,11 +1,15 @@
module AvatarHelper
+ # #####################################################
# Return an image tag for the user avatar
+ # #####################################################
def avatar_tag(user)
image_tag(user.avatar.url, :border => 1)
end
+ # #####################################################
# Return an image tar for the user avatar thumbnail
+ # #####################################################
def thumbnail_tag(user)
image_tag(user.avatar.thumbnail_url, :border => 1)
end
@@ -1,5 +1,8 @@
class UserCodeSenderJob < Struct.new(:id, :ip)
+ # #####################################################
+ #
+ # #####################################################
def perform
@user = User.find(id)
@activation = Activation.find_by_user_id(id)
@@ -1,5 +1,8 @@
class UserInviteJob < Struct.new(:id, :ip)
+ # #####################################################
+ #
+ # #####################################################
def perform
invite = Invite.find( id )
user = User.find( invite.user_id )
View
@@ -2,6 +2,9 @@ class Activation < ActiveRecord::Base
include ApplicationHelper
belongs_to :user
+ # #####################################################
+ #
+ # #####################################################
def new
code = generate_unique_code
View
@@ -1,5 +1,8 @@
class AuditTrail < ActiveRecord::Base
+ # #####################################################
+ #
+ # #####################################################
def self.create_login_entry(session, ip)
a = AuditTrail.new
a.user_id = session[:id]
@@ -11,6 +14,9 @@ def self.create_login_entry(session, ip)
end
end
+ # #####################################################
+ #
+ # #####################################################
def self.create_logout_entry(session, ip)
a = AuditTrail.new
a.user_id = session[:id]
@@ -24,55 +30,79 @@ def self.create_logout_entry(session, ip)
end
end
+ # #####################################################
+ #
+ # #####################################################
def self.create_code_sent_entry(user, ip)
a = AuditTrail.new
a.user_id = user.id
a.log_entry = "Sent an activation code " + ip + "."
a.save
end
+ # #####################################################
+ #
+ # #####################################################
def self.create_failed_code_sent_entry(entry, ip)
a = AuditTrail.new
a.user_id = entry
a.log_entry = "Failed reminder requested from " + ip + "."
a.save
end
+ # #####################################################
+ #
+ # #####################################################
def self.create_avatar_entry(user)
a = AuditTrail.new
a.user_id = user.id
a.log_entry = "Avatar image change requested."
a.save
end
+ # #####################################################
+ #
+ # #####################################################
def self.create_failed_avatar_entry(user)
a = AuditTrail.new
a.user_id = user.id
a.log_entry = "Avatar image failed."
a.save
end
+ # #####################################################
+ #
+ # #####################################################
def self.create_preregistration_entry(ip_address, id)
a = AuditTrail.new
a.user_id = id
a.log_entry = "New pre-registration from " + ip_address
a.save
end
+ # #####################################################
+ #
+ # #####################################################
def self.create_registration_entry(ip_address, id)
a = AuditTrail.new
a.user_id = id
a.log_entry = "New registration from " + ip_address
a.save
end
+ # #####################################################
+ #
+ # #####################################################
def self.create_invite_sent_entry(id, ip_address)
a = AuditTrail.new
a.user_id = id
a.log_entry = "Invitation sent thanks to " + ip_address
a.save
end
+ # #####################################################
+ #
+ # #####################################################
def self.create_failed_invite_sent_entry(id, ip_address)
a = AuditTrail.new
a.user_id = id
View
@@ -10,28 +10,42 @@ class Avatar < ActiveRecord::Base
DIRECTORY = File.join("images", "avatars")
end
+ # #####################################################
+ #
+ # #####################################################
def initialize(user, image = nil)
@user = user
@image = image
end
+ # #####################################################
+ #
+ # #####################################################
def exists?
File.exists?(File.join(DIRECTORY, filename))
end
alias exist? exists?
+ # #####################################################
+ #
+ # #####################################################
def url
avatar_name = exists? ? filename : "empty_avatar.jpg"
"#{URL_STUB}/#{avatar_name}"
end
+ # #####################################################
+ #
+ # #####################################################
def thumbnail_url
thumb = exists? ? thumbnail_name : "empty_avatar_thumbnail.png"
"#{URL_STUB}/#{thumb}"
end
+ # #####################################################
# Delete the users avatar picture
+ # #####################################################
def delete
[filename, thumbnail_name].each do |name|
image = "#{DIRECTORY}/#{name}"
@@ -41,12 +55,16 @@ def delete
private
+ # #####################################################
# Return the filename of the main avatar
+ # #####################################################
def filename
"#{@user.name}.png"
end
+ # #####################################################
# Return the filename of the avatar thumbnail
+ # #####################################################
def thumbnail_name
"#{@user.name}_thumbnail.png"
end
View
@@ -1,6 +1,8 @@
class Mailer < ActionMailer::Base
-
+ # #####################################################
+ #
+ # #####################################################
def invitation(sent_at = Time.now)
subject 'Mailer#invitation'
recipients ''
@@ -9,5 +11,4 @@ def invitation(sent_at = Time.now)
body :greeting => 'Hi,'
end
-
end
@@ -1,5 +1,8 @@
class UserMailer < ActionMailer::Base
+ # #####################################################
+ #
+ # #####################################################
def activation_code(user, activation)
@subject = "Spengler account activation"
@body = {}
@@ -10,6 +13,9 @@ def activation_code(user, activation)
@from = EMAIL_CONFIG['email_from']
end
+ # #####################################################
+ #
+ # #####################################################
def invite(invite, user)
@subject = "An Invitation to join Spengler"
@body = {}

0 comments on commit 4c75d85

Please sign in to comment.