User's blocked field refactored to use state machine

Andrew8xx8
1 parent 9a06dd4a
Showing 12 changed files with 39 additions and 32 deletions Show diff stats
app/controllers/admin/users_controller.rb
app/controllers/application_controller.rb
app/models/user.rb
app/views/admin/users/_form.html.haml
app/views/admin/users/index.html.haml
app/views/admin/users/show.html.haml
app/views/team_members/_team_member.html.haml
app/views/teams/members/_show.html.haml
db/schema.rb
lib/api/entities.rb
lib/gitlab/auth.rb
spec/models/user_spec.rb
@@ -45,7 +45,7 @@ class Admin::UsersController &lt; Admin::ApplicationController
   end
  
   def unblock
-    if admin_user.update_attribute(:blocked, false)
+    if admin_user.activate
       redirect_to :back, alert: "Successfully unblocked"
     else
       redirect_to :back, alert: "Error occured. User was not unblocked"
@@ -30,7 +30,7 @@ class ApplicationController &lt; ActionController::Base
   end
  
   def reject_blocked!
-    if current_user && current_user.blocked
+    if current_user && current_user.blocked?
       sign_out current_user
       flash[:alert] = "Your account is blocked. Retry when an admin unblock it."
       redirect_to new_user_session_path
@@ -38,7 +38,7 @@ class ApplicationController &lt; ActionController::Base
   end
  
   def after_sign_in_path_for resource
-    if resource.is_a?(User) && resource.respond_to?(:blocked) && resource.blocked
+    if resource.is_a?(User) && resource.respond_to?(:blocked?) && resource.blocked?
       sign_out resource
       flash[:alert] = "Your account is blocked. Retry when an admin unblock it."
       new_user_session_path
@@ -25,7 +25,7 @@
 #  dark_scheme            :boolean          default(FALSE), not null
 #  theme_id               :integer          default(1), not null
 #  bio                    :string(255)
-#  blocked                :boolean          default(FALSE), not null
+#  state                  :string(255)
 #  failed_attempts        :integer          default(0)
 #  locked_at              :datetime
 #  extern_uid             :string(255)
@@ -87,10 +87,27 @@ class User &lt; ActiveRecord::Base
  
   delegate :path, to: :namespace, allow_nil: true, prefix: true
  
+  state_machine :state, initial: :active do
+    after_transition any => :blocked do |user, transition|
+      # Remove user from all projects and
+      user.users_projects.find_each do |membership|
+        return false unless membership.destroy
+      end
+    end
+
+    event :block do
+      transition active: :blocked
+    end
+
+    event :activate do
+      transition blocked: :active
+    end
+  end
+
   # Scopes
   scope :admins, -> { where(admin:  true) }
-  scope :blocked, -> { where(blocked:  true) }
-  scope :active, -> { where(blocked:  false) }
+  scope :blocked, -> { with_state(:blocked) }
+  scope :active, -> { with_state(:active) }
   scope :alphabetically, -> { order('name ASC') }
   scope :in_team, ->(team){ where(id: team.member_ids) }
   scope :not_in_team, ->(team){ where('users.id NOT IN (:ids)', ids: team.member_ids) }
@@ -260,17 +277,6 @@ class User &lt; ActiveRecord::Base
     MergeRequest.cared(self)
   end
  
-  # Remove user from all projects and
-  # set blocked attribute to true
-  def block
-    users_projects.find_each do |membership|
-      return false unless membership.destroy
-    end
-
-    self.blocked = true
-    save
-  end
-
   def projects_limit_percent
     return 100 if projects_limit.zero?
     (personal_projects.count.to_f / projects_limit) * 100
@@ -61,7 +61,7 @@
         .span4
           - unless @admin_user.new_record?
             .alert.alert-error
-              - if @admin_user.blocked
+              - if @admin_user.blocked?
                 %p This user is blocked and is not able to login to GitLab
                 = link_to 'Unblock User', unblock_admin_user_path(@admin_user), method: :put, class: "btn btn-small"
               - else
@@ -53,7 +53,7 @@
               &nbsp;
               = link_to 'Edit', edit_admin_user_path(user), id: "edit_#{dom_id(user)}", class: "btn btn-small"
               - unless user == current_user
-                - if user.blocked
+                - if user.blocked?
                   = link_to 'Unblock', unblock_admin_user_path(user), method: :put, class: "btn btn-small success"
                 - else
                   = link_to 'Block', block_admin_user_path(user), confirm: 'USER WILL BE BLOCKED! Are you sure?', method: :put, class: "btn btn-small btn-remove"
@@ -3,7 +3,7 @@
     %h3.page_title
       = image_tag gravatar_icon(@admin_user.email, 90), class: "avatar s90"
       = @admin_user.name
-      - if @admin_user.blocked
+      - if @admin_user.blocked?
         %span.cred (Blocked)
       - if @admin_user.admin
         %span.cred (Admin)
@@ -20,7 +20,7 @@
           %span.label This is you!
         - if @project.namespace_owner == user
           %span.label Owner
-        - elsif user.blocked
+        - elsif user.blocked?
           %span.label Blocked
         - elsif allow_admin
           = link_to project_team_member_path(@project, user), confirm: remove_from_project_team_message(@project, user), method: :delete, class: "btn-tiny btn btn-remove" do
@@ -23,7 +23,7 @@
         %span.btn.disabled This is you!
       - if @team.owner == user
         %span.btn.disabled Owner
-      - elsif user.blocked
+      - elsif user.blocked?
         %span.btn.disabled.blocked Blocked
       - elsif allow_admin
         = link_to team_member_path(@team, user), confirm: remove_from_user_team_message(@team, user), method: :delete, class: "btn-tiny btn btn-remove", title: "Remove from team" do
@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
  
-ActiveRecord::Schema.define(:version => 20130220133245) do
+ActiveRecord::Schema.define(:version => 20130304105317) do
  
   create_table "events", :force => true do |t|
     t.string   "target_type"
@@ -261,7 +261,6 @@ ActiveRecord::Schema.define(:version =&gt; 20130220133245) do
     t.boolean  "dark_scheme",            :default => false, :null => false
     t.integer  "theme_id",               :default => 1,     :null => false
     t.string   "bio"
-    t.boolean  "blocked",                :default => false, :null => false
     t.integer  "failed_attempts",        :default => 0
     t.datetime "locked_at"
     t.string   "extern_uid"
@@ -269,10 +268,10 @@ ActiveRecord::Schema.define(:version =&gt; 20130220133245) do
     t.string   "username"
     t.boolean  "can_create_group",       :default => true,  :null => false
     t.boolean  "can_create_team",        :default => true,  :null => false
+    t.string   "state"
   end
  
   add_index "users", ["admin"], :name => "index_users_on_admin"
-  add_index "users", ["blocked"], :name => "index_users_on_blocked"
   add_index "users", ["email"], :name => "index_users_on_email", :unique => true
   add_index "users", ["extern_uid", "provider"], :name => "index_users_on_extern_uid_and_provider", :unique => true
   add_index "users", ["name"], :name => "index_users_on_name"
@@ -2,11 +2,11 @@ module Gitlab
   module Entities
     class User < Grape::Entity
       expose :id, :username, :email, :name, :bio, :skype, :linkedin, :twitter,
-             :dark_scheme, :theme_id, :blocked, :created_at, :extern_uid, :provider
+             :dark_scheme, :theme_id, :state, :created_at, :extern_uid, :provider
     end
  
     class UserBasic < Grape::Entity
-      expose :id, :username, :email, :name, :blocked, :created_at
+      expose :id, :username, :email, :name, :state, :created_at
     end
  
     class UserLogin < UserBasic
@@ -41,10 +41,12 @@ module Gitlab
         password_confirmation: password,
         projects_limit: Gitlab.config.gitlab.default_projects_limit,
       }, as: :admin)
+      @user.save!
+
       if Gitlab.config.omniauth['block_auto_created_users'] && !ldap
-        @user.blocked = true
+        @user.block
       end
-      @user.save!
+
       @user
     end
  
@@ -25,7 +25,7 @@
 #  dark_scheme            :boolean          default(FALSE), not null
 #  theme_id               :integer          default(1), not null
 #  bio                    :string(255)
-#  blocked                :boolean          default(FALSE), not null
+#  state                  :string(255)      default(FALSE), not null
 #  failed_attempts        :integer          default(0)
 #  locked_at              :datetime
 #  extern_uid             :string(255)
@@ -140,7 +140,7 @@ describe User do
  
     it "should block user" do
       user.block
-      user.blocked.should be_true
+      user.blocked?.should be_true
     end
   end
  
@@ -149,7 +149,7 @@ describe User do
       User.delete_all
       @user = create :user
       @admin = create :user, admin: true
-      @blocked = create :user, blocked: true
+      @blocked = create :user, state: :blocked
     end
  
     it { User.filter("admins").should == [@admin] }
...	...	@@ -45,7 +45,7 @@ class Admin::UsersController < Admin::ApplicationController
45	45	end
46	46
47	47	def unblock
48		- if admin_user.update_attribute(:blocked, false)
	48	+ if admin_user.activate
49	49	redirect_to :back, alert: "Successfully unblocked"
50	50	else
51	51	redirect_to :back, alert: "Error occured. User was not unblocked"
...	...
...	...	@@ -30,7 +30,7 @@ class ApplicationController < ActionController::Base
30	30	end
31	31
32	32	def reject_blocked!
33		- if current_user && current_user.blocked
	33	+ if current_user && current_user.blocked?
34	34	sign_out current_user
35	35	flash[:alert] = "Your account is blocked. Retry when an admin unblock it."
36	36	redirect_to new_user_session_path
...	...	@@ -38,7 +38,7 @@ class ApplicationController < ActionController::Base
38	38	end
39	39
40	40	def after_sign_in_path_for resource
41		- if resource.is_a?(User) && resource.respond_to?(:blocked) && resource.blocked
	41	+ if resource.is_a?(User) && resource.respond_to?(:blocked?) && resource.blocked?
42	42	sign_out resource
43	43	flash[:alert] = "Your account is blocked. Retry when an admin unblock it."
44	44	new_user_session_path
...	...
...	...	@@ -25,7 +25,7 @@
25	25	# dark_scheme :boolean default(FALSE), not null
26	26	# theme_id :integer default(1), not null
27	27	# bio :string(255)
28		-# blocked :boolean default(FALSE), not null
	28	+# state :string(255)
29	29	# failed_attempts :integer default(0)
30	30	# locked_at :datetime
31	31	# extern_uid :string(255)
...	...	@@ -87,10 +87,27 @@ class User < ActiveRecord::Base
87	87
88	88	delegate :path, to: :namespace, allow_nil: true, prefix: true
89	89
	90	+ state_machine :state, initial: :active do
	91	+ after_transition any => :blocked do \|user, transition\|
	92	+ # Remove user from all projects and
	93	+ user.users_projects.find_each do \|membership\|
	94	+ return false unless membership.destroy
	95	+ end
	96	+ end
	97	+
	98	+ event :block do
	99	+ transition active: :blocked
	100	+ end
	101	+
	102	+ event :activate do
	103	+ transition blocked: :active
	104	+ end
	105	+ end
	106	+
90	107	# Scopes
91	108	scope :admins, -> { where(admin: true) }
92		- scope :blocked, -> { where(blocked: true) }
93		- scope :active, -> { where(blocked: false) }
	109	+ scope :blocked, -> { with_state(:blocked) }
	110	+ scope :active, -> { with_state(:active) }
94	111	scope :alphabetically, -> { order('name ASC') }
95	112	scope :in_team, ->(team){ where(id: team.member_ids) }
96	113	scope :not_in_team, ->(team){ where('users.id NOT IN (:ids)', ids: team.member_ids) }
...	...	@@ -260,17 +277,6 @@ class User < ActiveRecord::Base
260	277	MergeRequest.cared(self)
261	278	end
262	279
263		- # Remove user from all projects and
264		- # set blocked attribute to true
265		- def block
266		- users_projects.find_each do \|membership\|
267		- return false unless membership.destroy
268		- end
269		-
270		- self.blocked = true
271		- save
272		- end
273		-
274	280	def projects_limit_percent
275	281	return 100 if projects_limit.zero?
276	282	(personal_projects.count.to_f / projects_limit) * 100
...	...
...	...	@@ -61,7 +61,7 @@
61	61	.span4
62	62	- unless @admin_user.new_record?
63	63	.alert.alert-error
64		- - if @admin_user.blocked
	64	+ - if @admin_user.blocked?
65	65	%p This user is blocked and is not able to login to GitLab
66	66	= link_to 'Unblock User', unblock_admin_user_path(@admin_user), method: :put, class: "btn btn-small"
67	67	- else
...	...
...	...	@@ -53,7 +53,7 @@
53	53
54	54	= link_to 'Edit', edit_admin_user_path(user), id: "edit_#{dom_id(user)}", class: "btn btn-small"
55	55	- unless user == current_user
56		- - if user.blocked
	56	+ - if user.blocked?
57	57	= link_to 'Unblock', unblock_admin_user_path(user), method: :put, class: "btn btn-small success"
58	58	- else
59	59	= link_to 'Block', block_admin_user_path(user), confirm: 'USER WILL BE BLOCKED! Are you sure?', method: :put, class: "btn btn-small btn-remove"
...	...
...	...	@@ -3,7 +3,7 @@
3	3	%h3.page_title
4	4	= image_tag gravatar_icon(@admin_user.email, 90), class: "avatar s90"
5	5	= @admin_user.name
6		- - if @admin_user.blocked
	6	+ - if @admin_user.blocked?
7	7	%span.cred (Blocked)
8	8	- if @admin_user.admin
9	9	%span.cred (Admin)
...	...
...	...	@@ -20,7 +20,7 @@
20	20	%span.label This is you!
21	21	- if @project.namespace_owner == user
22	22	%span.label Owner
23		- - elsif user.blocked
	23	+ - elsif user.blocked?
24	24	%span.label Blocked
25	25	- elsif allow_admin
26	26	= link_to project_team_member_path(@project, user), confirm: remove_from_project_team_message(@project, user), method: :delete, class: "btn-tiny btn btn-remove" do
...	...
...	...	@@ -23,7 +23,7 @@
23	23	%span.btn.disabled This is you!
24	24	- if @team.owner == user
25	25	%span.btn.disabled Owner
26		- - elsif user.blocked
	26	+ - elsif user.blocked?
27	27	%span.btn.disabled.blocked Blocked
28	28	- elsif allow_admin
29	29	= link_to team_member_path(@team, user), confirm: remove_from_user_team_message(@team, user), method: :delete, class: "btn-tiny btn btn-remove", title: "Remove from team" do
...	...
...	...	@@ -11,7 +11,7 @@
11	11	#
12	12	# It's strongly recommended to check this file into your version control system.
13	13
14		-ActiveRecord::Schema.define(:version => 20130220133245) do
	14	+ActiveRecord::Schema.define(:version => 20130304105317) do
15	15
16	16	create_table "events", :force => true do \|t\|
17	17	t.string "target_type"
...	...	@@ -261,7 +261,6 @@ ActiveRecord::Schema.define(:version => 20130220133245) do
261	261	t.boolean "dark_scheme", :default => false, :null => false
262	262	t.integer "theme_id", :default => 1, :null => false
263	263	t.string "bio"
264		- t.boolean "blocked", :default => false, :null => false
265	264	t.integer "failed_attempts", :default => 0
266	265	t.datetime "locked_at"
267	266	t.string "extern_uid"
...	...	@@ -269,10 +268,10 @@ ActiveRecord::Schema.define(:version => 20130220133245) do
269	268	t.string "username"
270	269	t.boolean "can_create_group", :default => true, :null => false
271	270	t.boolean "can_create_team", :default => true, :null => false
	271	+ t.string "state"
272	272	end
273	273
274	274	add_index "users", ["admin"], :name => "index_users_on_admin"
275		- add_index "users", ["blocked"], :name => "index_users_on_blocked"
276	275	add_index "users", ["email"], :name => "index_users_on_email", :unique => true
277	276	add_index "users", ["extern_uid", "provider"], :name => "index_users_on_extern_uid_and_provider", :unique => true
278	277	add_index "users", ["name"], :name => "index_users_on_name"
...	...
...	...	@@ -2,11 +2,11 @@ module Gitlab
2	2	module Entities
3	3	class User < Grape::Entity
4	4	expose :id, :username, :email, :name, :bio, :skype, :linkedin, :twitter,
5		- :dark_scheme, :theme_id, :blocked, :created_at, :extern_uid, :provider
	5	+ :dark_scheme, :theme_id, :state, :created_at, :extern_uid, :provider
6	6	end
7	7
8	8	class UserBasic < Grape::Entity
9		- expose :id, :username, :email, :name, :blocked, :created_at
	9	+ expose :id, :username, :email, :name, :state, :created_at
10	10	end
11	11
12	12	class UserLogin < UserBasic
...	...