Module: Workbench::SessionsHelper

Included in:
ApplicationController
Defined in:
app/helpers/workbench/sessions_helper.rb

Overview

These are controller methods.

Instance Method Summary (collapse)

Instance Method Details

- (Boolean) administers_projects?

Returns:

  • (Boolean)


86
87
88
# File 'app/helpers/workbench/sessions_helper.rb', line 86

def administers_projects?
  sessions_signed_in? && (is_administrator? || sessions_current_user.administers_projects? )
end


167
168
169
# File 'app/helpers/workbench/sessions_helper.rb', line 167

def administration_link
  sessions_current_user.is_administrator? ? link_to('Administration', administration_path) : nil
end

- (Object) authorize_project_selection(user, project)



99
100
101
# File 'app/helpers/workbench/sessions_helper.rb', line 99

def authorize_project_selection(user, project)
  project.project_members.where(user: user, project: project) 
end

- (Boolean) can_administer_projects?

User is some project_administrator or administrator

Returns:

  • (Boolean)


128
129
130
# File 'app/helpers/workbench/sessions_helper.rb', line 128

def can_administer_projects?
  redirect_to root_url, notice: "Please sign in as a project administrator or administrator." unless administers_projects?
end

Parameters:

  • (String)
  • (String)


145
146
147
148
149
150
151
# File 'app/helpers/workbench/sessions_helper.rb', line 145

def favorite_page_link(kind, name)
  if favorites?(kind, name)
    link_to('Unfavorite page', unfavorite_page_path(kind: kind, name: name), method: :post, remote: true, id: "unfavorite_link_#{kind}-#{name}", class: :unfavorite_link, title: 'Remove to favorite')
  else
    link_to('Favorite page', favorite_page_path(kind: kind, name: name), method: :post, remote: true, id: "favorite_link_#{kind}-#{name}", class: :favourite_link, title: 'Add to favorite.')
  end
end

- (Boolean) favorites?(kind, name)

Parameters:

  • (String)
  • (String)

Returns:

  • (Boolean)


159
160
161
# File 'app/helpers/workbench/sessions_helper.rb', line 159

def favorites?(kind, name)
  has_hub_favorites? && sessions_current_user.hub_favorites[sessions_current_project_id.to_s][kind].include?(name)
end

- (Boolean) has_hub_favorites?

Returns:

  • (Boolean)


153
154
155
# File 'app/helpers/workbench/sessions_helper.rb', line 153

def has_hub_favorites?
  sessions_current_user.hub_favorites[sessions_current_project_id.to_s] ? true : false
end

- (Boolean) is_administrator?

Authorization methods

Returns:

  • (Boolean)


76
77
78
# File 'app/helpers/workbench/sessions_helper.rb', line 76

def is_administrator?
  sessions_signed_in? && sessions_current_user.is_administrator?
end

- (Boolean) is_project_administrator?

Can be optimized to just look at ProjectMembers likely

Returns:

  • (Boolean)


81
82
83
84
# File 'app/helpers/workbench/sessions_helper.rb', line 81

def is_project_administrator?
  sessions_signed_in? && sessions_project_selected? && 
  sessions_current_project.project_members.exists?(is_project_administrator: true, user_id: sessions_current_user_id) 
end

- (Boolean) is_project_member?(user, project)

Returns:

  • (Boolean)


95
96
97
# File 'app/helpers/workbench/sessions_helper.rb', line 95

def is_project_member?(user, project)
  project.project_members.include?(user) 
end

- (Boolean) is_superuser?

A superuser is an administrator or a person who is a project_administrator IN THE CURRENTLY SELECTED PROJECT

Returns:

  • (Boolean)


91
92
93
# File 'app/helpers/workbench/sessions_helper.rb', line 91

def is_superuser?
  sessions_signed_in? && ( is_administrator? || is_project_administrator? )
end


163
164
165
# File 'app/helpers/workbench/sessions_helper.rb', line 163

def project_settings_link
  (sessions_project_selected? && is_superuser?) ? link_to('Project', project_path(sessions_current_project)) : nil
end

- (Object) require_administrator_sign_in



115
116
117
# File 'app/helpers/workbench/sessions_helper.rb', line 115

def 
  redirect_to root_url, notice: "Please sign in as an administrator." unless is_administrator? 
end

- (Object) require_project_administrator_sign_in



119
120
121
# File 'app/helpers/workbench/sessions_helper.rb', line 119

def 
  redirect_to root_url, notice: "Please sign in as a project administrator." unless is_project_administrator? 
end

- (Object) require_project_selection



107
108
109
# File 'app/helpers/workbench/sessions_helper.rb', line 107

def require_project_selection
  redirect_to root_url, notice: "Please select a project." unless sessions_current_project
end

- (Object) require_sign_in



103
104
105
# File 'app/helpers/workbench/sessions_helper.rb', line 103

def 
  redirect_to root_url, notice: "Please sign in." unless sessions_signed_in?
end

- (Object) require_sign_in_and_project_selection



111
112
113
# File 'app/helpers/workbench/sessions_helper.rb', line 111

def 
  redirect_to root_url, notice: "Whoa there, sign in and select a project first." unless sessions_signed_in? && sessions_project_selected?
end

- (Object) require_superuser_sign_in



123
124
125
# File 'app/helpers/workbench/sessions_helper.rb', line 123

def 
  redirect_to root_url, notice: "Please sign in as a project administrator or administrator." unless is_superuser?
end

TODO: make this a non-controller method



134
135
136
137
138
139
140
141
# File 'app/helpers/workbench/sessions_helper.rb', line 134

def session_header_links
  [
    project_settings_link, 
    administration_link,
    link_to('Account', sessions_current_user),
    link_to('Sign out', signout_path, method: :delete, id: 'sign_out')
  ]
end

- (Object) sessions_clear_selected_project



71
72
73
# File 'app/helpers/workbench/sessions_helper.rb', line 71

def sessions_clear_selected_project
  session[:project_id] = nil
end

- (Object) sessions_current_project



58
59
60
61
62
63
64
# File 'app/helpers/workbench/sessions_helper.rb', line 58

def sessions_current_project
 return nil unless sessions_current_project_id
 if @sessions_current_project.nil? || @sessions_current_project.id != sessions_current_project_id  
   @sessions_current_project = Project.find(sessions_current_project_id)
 end
   @sessions_current_project
end

- (Object) sessions_current_project_id



54
55
56
# File 'app/helpers/workbench/sessions_helper.rb', line 54

def sessions_current_project_id
  session[:project_id]
end

- (Object) sessions_current_project_id=(project_id)



50
51
52
# File 'app/helpers/workbench/sessions_helper.rb', line 50

def sessions_current_project_id=(project_id)
  session[:project_id] = project_id
end

- (Object) sessions_current_user Also known as: current_user



13
14
15
# File 'app/helpers/workbench/sessions_helper.rb', line 13

def sessions_current_user
  @sessions_current_user ||= User.find_by(remember_token: User.encrypt(cookies[:remember_token]))
end

- (Object) sessions_current_user=(user)



9
10
11
# File 'app/helpers/workbench/sessions_helper.rb', line 9

def sessions_current_user=(user)
  @sessions_current_user = user
end

- (Object) sessions_current_user_id



19
20
21
# File 'app/helpers/workbench/sessions_helper.rb', line 19

def sessions_current_user_id
  sessions_current_user ? sessions_current_user.id : nil
end

- (Boolean) sessions_project_selected?

Project methods

Returns:

  • (Boolean)


46
47
48
# File 'app/helpers/workbench/sessions_helper.rb', line 46

def sessions_project_selected?
  !sessions_current_project_id.nil?
end

- (Object) sessions_select_project(project)



66
67
68
69
# File 'app/helpers/workbench/sessions_helper.rb', line 66

def sessions_select_project(project)
 self.sessions_current_project_id = project.id 
 sessions_current_project
end

- (Object) sessions_sign_in(user, request)



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'app/helpers/workbench/sessions_helper.rb', line 23

def (user, request)
  remember_token = User.secure_random_token
  cookies.permanent[:remember_token] = remember_token

  user.update_columns(
    remember_token: User.encrypt(remember_token),
    sign_in_count: (user. + 1), 
    last_sign_in_at: user.,
    current_sign_in_at: Time.now,
    last_sign_in_ip: user., 
    current_sign_in_ip: request.ip
  )

  self.sessions_current_user = user
end

- (Object) sessions_sign_out



39
40
41
42
43
# File 'app/helpers/workbench/sessions_helper.rb', line 39

def sessions_sign_out
  self.sessions_current_user = nil
  sessions_clear_selected_project
  cookies.delete(:remember_token)
end

- (Boolean) sessions_signed_in?

User methods

Returns:

  • (Boolean)


5
6
7
# File 'app/helpers/workbench/sessions_helper.rb', line 5

def sessions_signed_in?
  !sessions_current_user.nil?
end