Separate user related entities in own class files

changelogs/unreleased/refactoring-entities-file-2.yml

+---
+title: Refactor user entities into own class files
+merge_request: 23730
+author: Rajendra Kadam
+type: added

lib/api/entities.rb

@@ -11,69 +11,10 @@ module API
       expose :access_level
     end
 
-    class UserSafe < Grape::Entity
-      expose :id, :name, :username
-    end
-
-    class UserBasic < UserSafe
-      expose :state
-
-      expose :avatar_url do |user, options|
-        user.avatar_url(only_path: false)
-      end
-
-      expose :avatar_path, if: ->(user, options) { options.fetch(:only_path, false) && user.avatar_path }
-      expose :custom_attributes, using: 'API::Entities::CustomAttribute', if: :with_custom_attributes
-
-      expose :web_url do |user, options|
-        Gitlab::Routing.url_helpers.user_url(user)
-      end
-    end
-
-    class User < UserBasic
-      expose :created_at, if: ->(user, opts) { Ability.allowed?(opts[:current_user], :read_user_profile, user) }
-      expose :bio, :location, :public_email, :skype, :linkedin, :twitter, :website_url, :organization
-    end
-
-    class UserActivity < Grape::Entity
-      expose :username
-      expose :last_activity_on
-      expose :last_activity_on, as: :last_activity_at # Back-compat
-    end
-
-    class UserStarsProject < Grape::Entity
-      expose :starred_since
-      expose :user, using: Entities::UserBasic
-    end
-
     class Identity < Grape::Entity
       expose :provider, :extern_uid
     end
 
-    class UserPublic < User
-      expose :last_sign_in_at
-      expose :confirmed_at
-      expose :last_activity_on
-      expose :email
-      expose :theme_id, :color_scheme_id, :projects_limit, :current_sign_in_at
-      expose :identities, using: Entities::Identity
-      expose :can_create_group?, as: :can_create_group
-      expose :can_create_project?, as: :can_create_project
-      expose :two_factor_enabled?, as: :two_factor_enabled
-      expose :external
-      expose :private_profile
-    end
-
-    class UserWithAdmin < UserPublic
-      expose :admin?, as: :is_admin
-    end
-
-    class UserDetailsWithAdmin < UserWithAdmin
-      expose :highest_role
-      expose :current_sign_in_ip
-      expose :last_sign_in_ip
-    end
-
     class UserStatus < Grape::Entity
       expose :emoji
       expose :message

lib/api/entities/user.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class User < UserBasic
+      expose :created_at, if: ->(user, opts) { Ability.allowed?(opts[:current_user], :read_user_profile, user) }
+      expose :bio, :location, :public_email, :skype, :linkedin, :twitter, :website_url, :organization
+    end
+  end
+end

lib/api/entities/user_activity.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class UserActivity < Grape::Entity
+      expose :username
+      expose :last_activity_on
+      expose :last_activity_on, as: :last_activity_at # Back-compat
+    end
+  end
+end

lib/api/entities/user_basic.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class UserBasic < UserSafe
+      expose :state
+
+      expose :avatar_url do |user, options|
+        user.avatar_url(only_path: false)
+      end
+
+      expose :avatar_path, if: ->(user, options) { options.fetch(:only_path, false) && user.avatar_path }
+      expose :custom_attributes, using: 'API::Entities::CustomAttribute', if: :with_custom_attributes
+
+      expose :web_url do |user, options|
+        Gitlab::Routing.url_helpers.user_url(user)
+      end
+    end
+  end
+end

lib/api/entities/user_details_with_admin.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class UserDetailsWithAdmin < UserWithAdmin
+      expose :highest_role
+      expose :current_sign_in_ip
+      expose :last_sign_in_ip
+    end
+  end
+end

lib/api/entities/user_public.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class UserPublic < Entities::User
+      expose :last_sign_in_at
+      expose :confirmed_at
+      expose :last_activity_on
+      expose :email
+      expose :theme_id, :color_scheme_id, :projects_limit, :current_sign_in_at
+      expose :identities, using: Entities::Identity
+      expose :can_create_group?, as: :can_create_group
+      expose :can_create_project?, as: :can_create_project
+      expose :two_factor_enabled?, as: :two_factor_enabled
+      expose :external
+      expose :private_profile
+    end
+  end
+end

lib/api/entities/user_safe.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class UserSafe < Grape::Entity
+      expose :id, :name, :username
+    end
+  end
+end

lib/api/entities/user_stars_project.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class UserStarsProject < Grape::Entity
+      expose :starred_since
+      expose :user, using: Entities::UserBasic
+    end
+  end
+end

lib/api/entities/user_with_admin.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class UserWithAdmin < UserPublic
+      expose :admin?, as: :is_admin
+    end
+  end
+end