Separate entities into own class and module files

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

+---
+title: Separate entities into own class files
+merge_request: 24941
+author: Rajendra Kadam
+type: added

lib/api/entities.rb

@@ -314,130 +314,6 @@ module API
       expose :message, :starts_at, :ends_at, :color, :font, :target_path, :broadcast_type
     end
 
-    class ApplicationStatistics < Grape::Entity
-      include ActionView::Helpers::NumberHelper
-      include CountHelper
-
-      expose :forks do |counts|
-        approximate_fork_count_with_delimiters(counts)
-      end
-
-      expose :issues do |counts|
-        approximate_count_with_delimiters(counts, ::Issue)
-      end
-
-      expose :merge_requests do |counts|
-        approximate_count_with_delimiters(counts, ::MergeRequest)
-      end
-
-      expose :notes do |counts|
-        approximate_count_with_delimiters(counts, ::Note)
-      end
-
-      expose :snippets do |counts|
-        approximate_count_with_delimiters(counts, ::Snippet)
-      end
-
-      expose :ssh_keys do |counts|
-        approximate_count_with_delimiters(counts, ::Key)
-      end
-
-      expose :milestones do |counts|
-        approximate_count_with_delimiters(counts, ::Milestone)
-      end
-
-      expose :users do |counts|
-        approximate_count_with_delimiters(counts, ::User)
-      end
-
-      expose :projects do |counts|
-        approximate_count_with_delimiters(counts, ::Project)
-      end
-
-      expose :groups do |counts|
-        approximate_count_with_delimiters(counts, ::Group)
-      end
-
-      expose :active_users do |_|
-        number_with_delimiter(::User.active.count)
-      end
-    end
-
-    class ApplicationSetting < Grape::Entity
-      def self.exposed_attributes
-        attributes = ::ApplicationSettingsHelper.visible_attributes
-        attributes.delete(:performance_bar_allowed_group_path)
-        attributes.delete(:performance_bar_enabled)
-        attributes.delete(:allow_local_requests_from_hooks_and_services)
-
-        # let's not expose the secret key in a response
-        attributes.delete(:asset_proxy_secret_key)
-        attributes.delete(:eks_secret_access_key)
-
-        attributes
-      end
-
-      expose :id, :performance_bar_allowed_group_id
-      expose(*exposed_attributes)
-      expose(:restricted_visibility_levels) do |setting, _options|
-        setting.restricted_visibility_levels.map { |level| Gitlab::VisibilityLevel.string_level(level) }
-      end
-      expose(:default_project_visibility) { |setting, _options| Gitlab::VisibilityLevel.string_level(setting.default_project_visibility) }
-      expose(:default_snippet_visibility) { |setting, _options| Gitlab::VisibilityLevel.string_level(setting.default_snippet_visibility) }
-      expose(:default_group_visibility) { |setting, _options| Gitlab::VisibilityLevel.string_level(setting.default_group_visibility) }
-
-      expose(*::ApplicationSettingsHelper.external_authorization_service_attributes)
-
-      # support legacy names, can be removed in v5
-      expose :password_authentication_enabled_for_web, as: :password_authentication_enabled
-      expose :password_authentication_enabled_for_web, as: :signin_enabled
-      expose :allow_local_requests_from_web_hooks_and_services, as: :allow_local_requests_from_hooks_and_services
-    end
-
-    class Appearance < Grape::Entity
-      expose :title
-      expose :description
-
-      expose :logo do |appearance, options|
-        appearance.logo.url
-      end
-
-      expose :header_logo do |appearance, options|
-        appearance.header_logo.url
-      end
-
-      expose :favicon do |appearance, options|
-        appearance.favicon.url
-      end
-
-      expose :new_project_guidelines
-      expose :header_message
-      expose :footer_message
-      expose :message_background_color
-      expose :message_font_color
-      expose :email_header_and_footer_enabled
-    end
-
-    # deprecated old Release representation
-    class TagRelease < Grape::Entity
-      expose :tag, as: :tag_name
-      expose :description
-    end
-
-    module Releases
-      class Link < Grape::Entity
-        expose :id
-        expose :name
-        expose :url
-        expose :external?, as: :external
-      end
-
-      class Source < Grape::Entity
-        expose :format
-        expose :url
-      end
-    end
-
     class Release < Grape::Entity
       include ::API::Helpers::Presentable
 

lib/api/entities/appearance.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class Appearance < Grape::Entity
+      expose :title
+      expose :description
+
+      expose :logo do |appearance, options|
+        appearance.logo.url
+      end
+
+      expose :header_logo do |appearance, options|
+        appearance.header_logo.url
+      end
+
+      expose :favicon do |appearance, options|
+        appearance.favicon.url
+      end
+
+      expose :new_project_guidelines
+      expose :header_message
+      expose :footer_message
+      expose :message_background_color
+      expose :message_font_color
+      expose :email_header_and_footer_enabled
+    end
+  end
+end

lib/api/entities/application_setting.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class ApplicationSetting < Grape::Entity
+      def self.exposed_attributes
+        attributes = ::ApplicationSettingsHelper.visible_attributes
+        attributes.delete(:performance_bar_allowed_group_path)
+        attributes.delete(:performance_bar_enabled)
+        attributes.delete(:allow_local_requests_from_hooks_and_services)
+
+        # let's not expose the secret key in a response
+        attributes.delete(:asset_proxy_secret_key)
+        attributes.delete(:eks_secret_access_key)
+
+        attributes
+      end
+
+      expose :id, :performance_bar_allowed_group_id
+      expose(*exposed_attributes)
+      expose(:restricted_visibility_levels) do |setting, _options|
+        setting.restricted_visibility_levels.map { |level| Gitlab::VisibilityLevel.string_level(level) }
+      end
+      expose(:default_project_visibility) { |setting, _options| Gitlab::VisibilityLevel.string_level(setting.default_project_visibility) }
+      expose(:default_snippet_visibility) { |setting, _options| Gitlab::VisibilityLevel.string_level(setting.default_snippet_visibility) }
+      expose(:default_group_visibility) { |setting, _options| Gitlab::VisibilityLevel.string_level(setting.default_group_visibility) }
+
+      expose(*::ApplicationSettingsHelper.external_authorization_service_attributes)
+
+      # support legacy names, can be removed in v5
+      expose :password_authentication_enabled_for_web, as: :password_authentication_enabled
+      expose :password_authentication_enabled_for_web, as: :signin_enabled
+      expose :allow_local_requests_from_web_hooks_and_services, as: :allow_local_requests_from_hooks_and_services
+    end
+  end
+end

lib/api/entities/application_statistics.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class ApplicationStatistics < Grape::Entity
+      include ActionView::Helpers::NumberHelper
+      include CountHelper
+
+      expose :forks do |counts|
+        approximate_fork_count_with_delimiters(counts)
+      end
+
+      expose :issues do |counts|
+        approximate_count_with_delimiters(counts, ::Issue)
+      end
+
+      expose :merge_requests do |counts|
+        approximate_count_with_delimiters(counts, ::MergeRequest)
+      end
+
+      expose :notes do |counts|
+        approximate_count_with_delimiters(counts, ::Note)
+      end
+
+      expose :snippets do |counts|
+        approximate_count_with_delimiters(counts, ::Snippet)
+      end
+
+      expose :ssh_keys do |counts|
+        approximate_count_with_delimiters(counts, ::Key)
+      end
+
+      expose :milestones do |counts|
+        approximate_count_with_delimiters(counts, ::Milestone)
+      end
+
+      expose :users do |counts|
+        approximate_count_with_delimiters(counts, ::User)
+      end
+
+      expose :projects do |counts|
+        approximate_count_with_delimiters(counts, ::Project)
+      end
+
+      expose :groups do |counts|
+        approximate_count_with_delimiters(counts, ::Group)
+      end
+
+      expose :active_users do |_|
+        number_with_delimiter(::User.active.count)
+      end
+    end
+  end
+end

lib/api/entities/releases/link.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    module Releases
+      class Link < Grape::Entity
+        expose :id
+        expose :name
+        expose :url
+        expose :external?, as: :external
+      end
+    end
+  end
+end

lib/api/entities/releases/source.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    module Releases
+      class Source < Grape::Entity
+        expose :format
+        expose :url
+      end
+    end
+  end
+end

lib/api/entities/tag_release.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    # deprecated old Release representation
+    class TagRelease < Grape::Entity
+      expose :tag, as: :tag_name
+      expose :description
+    end
+  end
+end