Separate snippet entities into own class files

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

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

lib/api/entities.rb

@@ -128,75 +128,6 @@ module API
       end
     end
 
-    class BasicRef < Grape::Entity
-      expose :type, :name
-    end
-
-    class Branch < Grape::Entity
-      expose :name
-
-      expose :commit, using: Entities::Commit do |repo_branch, options|
-        options[:project].repository.commit(repo_branch.dereferenced_target)
-      end
-
-      expose :merged do |repo_branch, options|
-        if options[:merged_branch_names]
-          options[:merged_branch_names].include?(repo_branch.name)
-        else
-          options[:project].repository.merged_to_root_ref?(repo_branch)
-        end
-      end
-
-      expose :protected do |repo_branch, options|
-        ::ProtectedBranch.protected?(options[:project], repo_branch.name)
-      end
-
-      expose :developers_can_push do |repo_branch, options|
-        ::ProtectedBranch.developers_can?(:push, repo_branch.name, protected_refs: options[:project].protected_branches)
-      end
-
-      expose :developers_can_merge do |repo_branch, options|
-        ::ProtectedBranch.developers_can?(:merge, repo_branch.name, protected_refs: options[:project].protected_branches)
-      end
-
-      expose :can_push do |repo_branch, options|
-        Gitlab::UserAccess.new(options[:current_user], project: options[:project]).can_push_to_branch?(repo_branch.name)
-      end
-
-      expose :default do |repo_branch, options|
-        options[:project].default_branch == repo_branch.name
-      end
-    end
-
-    class TreeObject < Grape::Entity
-      expose :id, :name, :type, :path
-
-      expose :mode do |obj, options|
-        filemode = obj.mode
-        filemode = "0" + filemode if filemode.length < 6
-        filemode
-      end
-    end
-
-    class Snippet < Grape::Entity
-      expose :id, :title, :file_name, :description, :visibility
-      expose :author, using: Entities::UserBasic
-      expose :updated_at, :created_at
-      expose :project_id
-      expose :web_url do |snippet|
-        Gitlab::UrlBuilder.build(snippet)
-      end
-    end
-
-    class ProjectSnippet < Snippet
-    end
-
-    class PersonalSnippet < Snippet
-      expose :raw_url do |snippet|
-        Gitlab::UrlBuilder.build(snippet, raw: true)
-      end
-    end
-
     class IssuableEntity < Grape::Entity
       expose :id, :iid
       expose(:project_id) { |entity| entity&.project.try(:id) }

lib/api/entities/basic_ref.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class BasicRef < Grape::Entity
+      expose :type, :name
+    end
+  end
+end

lib/api/entities/branch.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class Branch < Grape::Entity
+      expose :name
+
+      expose :commit, using: Entities::Commit do |repo_branch, options|
+        options[:project].repository.commit(repo_branch.dereferenced_target)
+      end
+
+      expose :merged do |repo_branch, options|
+        if options[:merged_branch_names]
+          options[:merged_branch_names].include?(repo_branch.name)
+        else
+          options[:project].repository.merged_to_root_ref?(repo_branch)
+        end
+      end
+
+      expose :protected do |repo_branch, options|
+        ::ProtectedBranch.protected?(options[:project], repo_branch.name)
+      end
+
+      expose :developers_can_push do |repo_branch, options|
+        ::ProtectedBranch.developers_can?(:push, repo_branch.name, protected_refs: options[:project].protected_branches)
+      end
+
+      expose :developers_can_merge do |repo_branch, options|
+        ::ProtectedBranch.developers_can?(:merge, repo_branch.name, protected_refs: options[:project].protected_branches)
+      end
+
+      expose :can_push do |repo_branch, options|
+        Gitlab::UserAccess.new(options[:current_user], project: options[:project]).can_push_to_branch?(repo_branch.name)
+      end
+
+      expose :default do |repo_branch, options|
+        options[:project].default_branch == repo_branch.name
+      end
+    end
+  end
+end

lib/api/entities/personal_snippet.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class PersonalSnippet < Snippet
+      expose :raw_url do |snippet|
+        Gitlab::UrlBuilder.build(snippet, raw: true)
+      end
+    end
+  end
+end

lib/api/entities/project_snippet.rb

+# frozen_String_literal: true
+
+module API
+  module Entities
+    class ProjectSnippet < Entities::Snippet
+    end
+  end
+end

lib/api/entities/snippet.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class Snippet < Grape::Entity
+      expose :id, :title, :file_name, :description, :visibility
+      expose :author, using: Entities::UserBasic
+      expose :updated_at, :created_at
+      expose :project_id
+      expose :web_url do |snippet|
+        Gitlab::UrlBuilder.build(snippet)
+      end
+    end
+  end
+end

lib/api/entities/tree_object.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    class TreeObject < Grape::Entity
+      expose :id, :name, :type, :path
+
+      expose :mode do |obj, options|
+        filemode = obj.mode
+        filemode = "0" + filemode if filemode.length < 6
+        filemode
+      end
+    end
+  end
+end