Browse Source

Naming cops

Maarten van den Berg 6 years ago
parent
commit
0b97f48d55

+ 0 - 18
.rubocop.yml

45
 Metrics/PerceivedComplexity:
45
 Metrics/PerceivedComplexity:
46
   Max: 13
46
   Max: 13
47
 
47
 
48
-# Offense count: 1
49
-Naming/AccessorMethodName:
50
-  Exclude:
51
-    - 'app/helpers/authentication_helper.rb'
52
-
53
-# Offense count: 5
54
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
55
-# NamePrefix: is_, has_, have_
56
-# NamePrefixBlacklist: is_, has_, have_
57
-# NameWhitelist: is_a?
58
-# MethodDefinitionMacros: define_method, define_singleton_method
59
-Naming/PredicateName:
60
-  Exclude:
61
-    - 'spec/**/*'
62
-    - 'app/helpers/authentication_helper.rb'
63
-    - 'app/models/activity.rb'
64
-    - 'app/models/group.rb'
65
-
66
 # Offense count: 9
48
 # Offense count: 9
67
 # Cop supports --auto-correct.
49
 # Cop supports --auto-correct.
68
 # Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
50
 # Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.

+ 1 - 1
app/controllers/api_controller.rb

11
   protected
11
   protected
12
 
12
 
13
   def api_require_authentication!
13
   def api_require_authentication!
14
-    return if is_logged_in?
14
+    return if logged_in?
15
 
15
 
16
     head :unauthorized
16
     head :unauthorized
17
   end
17
   end

+ 1 - 1
app/controllers/authentication_controller.rb

40
   end
40
   end
41
 
41
 
42
   def login_status
42
   def login_status
43
-    render text: is_logged_in?
43
+    render text: logged_in?
44
   end
44
   end
45
 
45
 
46
   def create_password
46
   def create_password

+ 1 - 1
app/controllers/members_controller.rb

7
   # GET /members
7
   # GET /members
8
   # GET /members.json
8
   # GET /members.json
9
   def index
9
   def index
10
-    @admin = @group.is_leader?(current_person)
10
+    @admin = @group.leader?(current_person)
11
     @members = @group.members
11
     @members = @group.members
12
                      .joins(:person)
12
                      .joins(:person)
13
                      .order('members.is_leader DESC, people.first_name ASC')
13
                      .order('members.is_leader DESC, people.first_name ASC')

+ 8 - 8
app/helpers/authentication_helper.rb

43
 
43
 
44
   # Determine whether the user is logged in, and if so, disable the Session, then flush session cookies.
44
   # Determine whether the user is logged in, and if so, disable the Session, then flush session cookies.
45
   def log_out(session_broken: false)
45
   def log_out(session_broken: false)
46
-    if !session_broken && is_logged_in? && @user_session
47
-      get_user_session
46
+    if !session_broken && logged_in? && @user_session
47
+      user_session
48
 
48
 
49
       @user_session.update!(active: false)
49
       @user_session.update!(active: false)
50
     end
50
     end
57
 
57
 
58
   # Determine whether the current request is from a user with a non-expired session.
58
   # Determine whether the current request is from a user with a non-expired session.
59
   # Makes @user_session available as a side effect if the user is not.
59
   # Makes @user_session available as a side effect if the user is not.
60
-  def is_logged_in?
60
+  def logged_in?
61
     # Case 1: User has an active session inside the cookie.
61
     # Case 1: User has an active session inside the cookie.
62
     # We verify that the session hasn't expired yet.
62
     # We verify that the session hasn't expired yet.
63
     if session[:user_id] && session[:expires].to_time > DateTime.now
63
     if session[:user_id] && session[:expires].to_time > DateTime.now
64
 
64
 
65
-      get_user_session
65
+      user_session
66
 
66
 
67
       return false if !@user_session.active || @user_session.expires < Time.now
67
       return false if !@user_session.active || @user_session.expires < Time.now
68
 
68
 
74
       if cookies.signed.permanent[:remember_token] && cookies.signed.permanent[:user_id] &&
74
       if cookies.signed.permanent[:remember_token] && cookies.signed.permanent[:user_id] &&
75
          cookies.signed.permanent[:session_id]
75
          cookies.signed.permanent[:session_id]
76
 
76
 
77
-        get_user_session
77
+        user_session
78
 
78
 
79
         return false if @user_session.nil? || @user_session.remember_digest.nil?
79
         return false if @user_session.nil? || @user_session.remember_digest.nil?
80
 
80
 
94
   end
94
   end
95
 
95
 
96
   # Get the Session object representing the current user's session.
96
   # Get the Session object representing the current user's session.
97
-  def get_user_session
97
+  def user_session
98
     if @user_session
98
     if @user_session
99
       @user_session
99
       @user_session
100
     else
100
     else
107
   end
107
   end
108
 
108
 
109
   def current_user
109
   def current_user
110
-    get_user_session
110
+    user_session
111
     @user_session&.user
111
     @user_session&.user
112
   end
112
   end
113
 
113
 
116
   end
116
   end
117
 
117
 
118
   def require_login!
118
   def require_login!
119
-    unless is_logged_in?
119
+    unless logged_in?
120
       flash_message(:warning, I18n.t('authentication.login_required'))
120
       flash_message(:warning, I18n.t('authentication.login_required'))
121
       redirect_to controller: 'authentication', action: 'login_form'
121
       redirect_to controller: 'authentication', action: 'login_form'
122
       return false
122
       return false

+ 2 - 2
app/helpers/groups_helper.rb

2
   def require_membership!
2
   def require_membership!
3
     return unless require_login!
3
     return unless require_login!
4
 
4
 
5
-    return if @group.is_member?(current_person) || current_person.is_admin?
5
+    return if @group.member?(current_person) || current_person.is_admin?
6
 
6
 
7
     flash_message(:danger, I18n.t('groups.membership_required'))
7
     flash_message(:danger, I18n.t('groups.membership_required'))
8
     redirect_to dashboard_home_path
8
     redirect_to dashboard_home_path
11
   def require_leader!
11
   def require_leader!
12
     return unless require_login!
12
     return unless require_login!
13
 
13
 
14
-    return if @group.is_leader?(current_person) || current_person.is_admin?
14
+    return if @group.leader?(current_person) || current_person.is_admin?
15
 
15
 
16
     flash_message(:danger, I18n.t('groups.leadership_required'))
16
     flash_message(:danger, I18n.t('groups.leadership_required'))
17
     redirect_to dashboard_home_path
17
     redirect_to dashboard_home_path

+ 4 - 4
app/models/activity.rb

95
   end
95
   end
96
 
96
 
97
   # Determine whether the passed Person participates in the activity.
97
   # Determine whether the passed Person participates in the activity.
98
-  def is_participant?(person)
98
+  def participant?(person)
99
     Participant.exists?(
99
     Participant.exists?(
100
       activity_id: self.id,
100
       activity_id: self.id,
101
       person_id: person.id
101
       person_id: person.id
103
   end
103
   end
104
 
104
 
105
   # Determine whether the passed Person is an organizer for the activity.
105
   # Determine whether the passed Person is an organizer for the activity.
106
-  def is_organizer?(person)
106
+  def organizer?(person)
107
     Participant.exists?(
107
     Participant.exists?(
108
       person_id: person.id,
108
       person_id: person.id,
109
       activity_id: self.id,
109
       activity_id: self.id,
128
   # Determine whether the passed Person may change this activity.
128
   # Determine whether the passed Person may change this activity.
129
   def may_change?(person)
129
   def may_change?(person)
130
     person.is_admin ||
130
     person.is_admin ||
131
-      self.is_organizer?(person) ||
132
-      self.group.is_leader?(person)
131
+      self.organizer?(person) ||
132
+      self.group.leader?(person)
133
   end
133
   end
134
 
134
 
135
   # Create Participants for all People that
135
   # Create Participants for all People that

+ 2 - 2
app/models/group.rb

64
 
64
 
65
   # @return [Boolean]
65
   # @return [Boolean]
66
   #   whether the passed person is a member of the group.
66
   #   whether the passed person is a member of the group.
67
-  def is_member?(person)
67
+  def member?(person)
68
     Member.exists?(
68
     Member.exists?(
69
       person: person,
69
       person: person,
70
       group: self
70
       group: self
73
 
73
 
74
   # @return [Boolean]
74
   # @return [Boolean]
75
   #   whether the passed person is a group leader.
75
   #   whether the passed person is a group leader.
76
-  def is_leader?(person)
76
+  def leader?(person)
77
     Member.exists?(
77
     Member.exists?(
78
       person: person,
78
       person: person,
79
       group: self,
79
       group: self,

+ 1 - 1
app/views/groups/show.html.haml

17
             = @group.activities.count
17
             = @group.activities.count
18
             = t 'activities.plural'
18
             = t 'activities.plural'
19
 
19
 
20
-          - if @group.is_leader?(current_person)
20
+          - if @group.leader?(current_person)
21
             = link_to new_group_activity_path(@group), class: 'list-group-item' do
21
             = link_to new_group_activity_path(@group), class: 'list-group-item' do
22
               = t 'activities.new'
22
               = t 'activities.new'
23
 
23