Separate commit entities into own classes

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

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

lib/api/entities.rb

@@ -128,51 +128,6 @@ module API
       end
     end
 
-    class DiffRefs < Grape::Entity
-      expose :base_sha, :head_sha, :start_sha
-    end
-
-    class Commit < Grape::Entity
-      expose :id, :short_id, :created_at
-      expose :parent_ids
-      expose :full_title, as: :title
-      expose :safe_message, as: :message
-      expose :author_name, :author_email, :authored_date
-      expose :committer_name, :committer_email, :committed_date
-    end
-
-    class CommitStats < Grape::Entity
-      expose :additions, :deletions, :total
-    end
-
-    class CommitWithStats < Commit
-      expose :stats, using: Entities::CommitStats
-    end
-
-    class CommitDetail < Commit
-      expose :stats, using: Entities::CommitStats, if: :stats
-      expose :status
-      expose :project_id
-
-      expose :last_pipeline do |commit, options|
-        pipeline = commit.last_pipeline if can_read_pipeline?
-        ::API::Entities::PipelineBasic.represent(pipeline, options)
-      end
-
-      private
-
-      def can_read_pipeline?
-        Ability.allowed?(options[:current_user], :read_pipeline, object.last_pipeline)
-      end
-    end
-
-    class CommitSignature < Grape::Entity
-      expose :gpg_key_id
-      expose :gpg_key_primary_keyid, :gpg_key_user_name, :gpg_key_user_email
-      expose :verification_status
-      expose :gpg_key_subkey_id
-    end
-
     class BasicRef < Grape::Entity
       expose :type, :name
     end

lib/api/entities/commit.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class Commit < Grape::Entity
+      expose :id, :short_id, :created_at
+      expose :parent_ids
+      expose :full_title, as: :title
+      expose :safe_message, as: :message
+      expose :author_name, :author_email, :authored_date
+      expose :committer_name, :committer_email, :committed_date
+    end
+  end
+end

lib/api/entities/commit_detail.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class CommitDetail < Commit
+      expose :stats, using: Entities::CommitStats, if: :stats
+      expose :status
+      expose :project_id
+
+      expose :last_pipeline do |commit, options|
+        pipeline = commit.last_pipeline if can_read_pipeline?
+        ::API::Entities::PipelineBasic.represent(pipeline, options)
+      end
+
+      private
+
+      def can_read_pipeline?
+        Ability.allowed?(options[:current_user], :read_pipeline, object.last_pipeline)
+      end
+    end
+  end
+end

lib/api/entities/commit_signature.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class CommitSignature < Grape::Entity
+      expose :gpg_key_id
+      expose :gpg_key_primary_keyid, :gpg_key_user_name, :gpg_key_user_email
+      expose :verification_status
+      expose :gpg_key_subkey_id
+    end
+  end
+end

lib/api/entities/commit_stats.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class CommitStats < Grape::Entity
+      expose :additions, :deletions, :total
+    end
+  end
+end

lib/api/entities/commit_with_stats.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class CommitWithStats < Commit
+      expose :stats, using: Entities::CommitStats
+    end
+  end
+end

lib/api/entities/diff_refs.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class DiffRefs < Grape::Entity
+      expose :base_sha, :head_sha, :start_sha
+    end
+  end
+end