Merge branch 'refactoring-entities-file-14' into 'master'

Separate 5 classess into own class files

See merge request gitlab-org/gitlab!24745

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

+---
+title: Separate 5 classes into own entities files
+merge_request: 24745
+author: Rajendra Kadam
+type: added

lib/api/entities.rb

@@ -129,86 +129,6 @@ module API
       end
     end
 
-    class PushEventPayload < Grape::Entity
-      expose :commit_count, :action, :ref_type, :commit_from, :commit_to, :ref,
-             :commit_title, :ref_count
-    end
-
-    class Event < Grape::Entity
-      expose :project_id, :action_name
-      expose :target_id, :target_iid, :target_type, :author_id
-      expose :target_title
-      expose :created_at
-      expose :note, using: Entities::Note, if: ->(event, options) { event.note? }
-      expose :author, using: Entities::UserBasic, if: ->(event, options) { event.author }
-
-      expose :push_event_payload,
-        as: :push_data,
-        using: PushEventPayload,
-        if: -> (event, _) { event.push_action? }
-
-      expose :author_username do |event, options|
-        event.author&.username
-      end
-    end
-
-    class ProjectGroupLink < Grape::Entity
-      expose :id, :project_id, :group_id, :group_access, :expires_at
-    end
-
-    class Todo < Grape::Entity
-      expose :id
-      expose :project, using: Entities::ProjectIdentity, if: -> (todo, _) { todo.project_id }
-      expose :group, using: 'API::Entities::NamespaceBasic', if: -> (todo, _) { todo.group_id }
-      expose :author, using: Entities::UserBasic
-      expose :action_name
-      expose :target_type
-
-      expose :target do |todo, options|
-        todo_options = options.fetch(todo.target_type, {})
-        todo_target_class(todo.target_type).represent(todo.target, todo_options)
-      end
-
-      expose :target_url do |todo, options|
-        todo_target_url(todo)
-      end
-
-      expose :body
-      expose :state
-      expose :created_at
-
-      def todo_target_class(target_type)
-        # false as second argument prevents looking up in module hierarchy
-        # see also https://gitlab.com/gitlab-org/gitlab-foss/issues/59719
-        ::API::Entities.const_get(target_type, false)
-      end
-
-      def todo_target_url(todo)
-        target_type = todo.target_type.underscore
-        target_url = "#{todo.resource_parent.class.to_s.underscore}_#{target_type}_url"
-
-        Gitlab::Routing
-          .url_helpers
-          .public_send(target_url, todo.resource_parent, todo.target, anchor: todo_target_anchor(todo)) # rubocop:disable GitlabSecurity/PublicSend
-      end
-
-      def todo_target_anchor(todo)
-        "note_#{todo.note_id}" if todo.note_id?
-      end
-    end
-
-    class NamespaceBasic < Grape::Entity
-      expose :id, :name, :path, :kind, :full_path, :parent_id, :avatar_url
-
-      expose :web_url do |namespace|
-        if namespace.user?
-          Gitlab::Routing.url_helpers.user_url(namespace.owner)
-        else
-          namespace.web_url
-        end
-      end
-    end
-
     class Namespace < NamespaceBasic
       expose :members_count_with_descendants, if: -> (namespace, opts) { expose_members_count_with_descendants?(namespace, opts) } do |namespace, _|
         namespace.users_with_descendants.count

lib/api/entities/event.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class Event < Grape::Entity
+      expose :project_id, :action_name
+      expose :target_id, :target_iid, :target_type, :author_id
+      expose :target_title
+      expose :created_at
+      expose :note, using: Entities::Note, if: ->(event, options) { event.note? }
+      expose :author, using: Entities::UserBasic, if: ->(event, options) { event.author }
+
+      expose :push_event_payload,
+        as: :push_data,
+        using: Entities::PushEventPayload,
+        if: -> (event, _) { event.push_action? }
+
+      expose :author_username do |event, options|
+        event.author&.username
+      end
+    end
+  end
+end

lib/api/entities/namespace_basic.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class NamespaceBasic < Grape::Entity
+      expose :id, :name, :path, :kind, :full_path, :parent_id, :avatar_url
+
+      expose :web_url do |namespace|
+        if namespace.user?
+          Gitlab::Routing.url_helpers.user_url(namespace.owner)
+        else
+          namespace.web_url
+        end
+      end
+    end
+  end
+end

lib/api/entities/project_group_link.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class ProjectGroupLink < Grape::Entity
+      expose :id, :project_id, :group_id, :group_access, :expires_at
+    end
+  end
+end

lib/api/entities/push_event_payload.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class PushEventPayload < Grape::Entity
+      expose :commit_count, :action, :ref_type, :commit_from, :commit_to, :ref,
+             :commit_title, :ref_count
+    end
+  end
+end

lib/api/entities/todo.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class Todo < Grape::Entity
+      expose :id
+      expose :project, using: Entities::ProjectIdentity, if: -> (todo, _) { todo.project_id }
+      expose :group, using: 'API::Entities::NamespaceBasic', if: -> (todo, _) { todo.group_id }
+      expose :author, using: Entities::UserBasic
+      expose :action_name
+      expose :target_type
+
+      expose :target do |todo, options|
+        todo_options = options.fetch(todo.target_type, {})
+        todo_target_class(todo.target_type).represent(todo.target, todo_options)
+      end
+
+      expose :target_url do |todo, options|
+        todo_target_url(todo)
+      end
+
+      expose :body
+      expose :state
+      expose :created_at
+
+      def todo_target_class(target_type)
+        # false as second argument prevents looking up in module hierarchy
+        # see also https://gitlab.com/gitlab-org/gitlab-foss/issues/59719
+        ::API::Entities.const_get(target_type, false)
+      end
+
+      def todo_target_url(todo)
+        target_type = todo.target_type.underscore
+        target_url = "#{todo.resource_parent.class.to_s.underscore}_#{target_type}_url"
+
+        Gitlab::Routing
+          .url_helpers
+          .public_send(target_url, todo.resource_parent, todo.target, anchor: todo_target_anchor(todo)) # rubocop:disable GitlabSecurity/PublicSend
+      end
+
+      def todo_target_anchor(todo)
+        "note_#{todo.note_id}" if todo.note_id?
+      end
+    end
+  end
+end