Factor error and success methods from services.

Author: cirosantilli

app/controllers/projects/branches_controller.rb

@@ -17,10 +17,8 @@ def recent
   end
 
   def create
-    result = CreateBranchService.new.execute(project,
-                                             params[:branch_name],
-                                             params[:ref],
-                                             current_user)
+    result = CreateBranchService.new(project, current_user).
+        execute(params[:branch_name], params[:ref])
     if result[:status] == :success
       @branch = result[:branch]
       redirect_to project_tree_path(@project, @branch.name)
@@ -31,7 +29,7 @@ def create
   end
 
   def destroy
-    DeleteBranchService.new.execute(project, params[:id], current_user)
+    DeleteBranchService.new(project, current_user).execute(params[:id])
     @branch_name = params[:id]
 
     respond_to do |format|

app/controllers/projects/edit_tree_controller.rb

@@ -10,7 +10,8 @@ def show
   end
 
   def update
-    result = Files::UpdateService.new(@project, current_user, params, @ref, @path).execute
+    result = Files::UpdateService.
+      new(@project, current_user, params, @ref, @path).execute
 
     if result[:status] == :success
       flash[:notice] = "Your changes have been successfully committed"

app/controllers/projects/tags_controller.rb

@@ -13,9 +13,8 @@ def index
   end
 
   def create
-    result = CreateTagService.new.execute(@project, params[:tag_name],
-                                          params[:ref], params[:message],
-                                          current_user)
+    result = CreateTagService.new(@project, current_user).
+      execute(params[:tag_name], params[:ref], params[:message])
     if result[:status] == :success
       @tag = result[:tag]
       redirect_to project_tags_path(@project)

app/services/base_service.rb

@@ -1,7 +1,7 @@
 class BaseService
   attr_accessor :project, :current_user, :params
 
-  def initialize(project, user, params)
+  def initialize(project, user, params = {})
     @project, @current_user, @params = project, user, params.dup
   end
 
@@ -32,4 +32,19 @@ def log_info message
   def system_hook_service
     SystemHooksService.new
   end
+
+  private
+
+  def error(message)
+    {
+      message: message,
+      status: :error
+    }
+  end
+
+  def success
+    {
+      status: :success
+    }
+  end
 end

app/services/create_branch_service.rb

@@ -1,5 +1,7 @@
-class CreateBranchService
-  def execute(project, branch_name, ref, current_user)
+require_relative 'base_service'
+
+class CreateBranchService < BaseService
+  def execute(branch_name, ref)
     valid_branch = Gitlab::GitRefValidator.validate(branch_name)
     if valid_branch == false
       return error('Branch name invalid')
@@ -22,17 +24,9 @@ def execute(project, branch_name, ref, current_user)
     end
   end
 
-  def error(message)
-    {
-      message: message,
-      status: :error
-    }
-  end
-
   def success(branch)
-    {
-      branch: branch,
-      status: :success
-    }
+    out = super()
+    out[:branch] = branch
+    out
   end
 end

app/services/create_tag_service.rb

@@ -1,5 +1,7 @@
-class CreateTagService
-  def execute(project, tag_name, ref, message, current_user)
+require_relative 'base_service'
+
+class CreateTagService < BaseService
+  def execute(tag_name, ref, message)
     valid_tag = Gitlab::GitRefValidator.validate(tag_name)
     if valid_tag == false
       return error('Tag name invalid')
@@ -26,17 +28,9 @@ def execute(project, tag_name, ref, message, current_user)
     end
   end
 
-  def error(message)
-    {
-      message: message,
-      status: :error
-    }
-  end
-
   def success(branch)
-    {
-      tag: branch,
-      status: :success
-    }
+    out = super()
+    out[:tag] = branch
+    out
   end
 end

app/services/delete_branch_service.rb

@@ -1,5 +1,7 @@
-class DeleteBranchService
-  def execute(project, branch_name, current_user)
+require_relative 'base_service'
+
+class DeleteBranchService < BaseService
+  def execute(branch_name)
     repository = project.repository
     branch = repository.find_branch(branch_name)
 
@@ -31,17 +33,14 @@ def execute(project, branch_name, current_user)
   end
 
   def error(message, return_code = 400)
-    {
-      message: message,
-      return_code: return_code,
-      state: :error
-    }
+    out = super(message)
+    out[:return_code] = return_code
+    out
   end
 
   def success(message)
-    {
-      message: message,
-      state: :success
-    }
+    out = super()
+    out[:message] = message
+    out
   end
 end

app/services/files/base_service.rb

@@ -10,18 +10,10 @@ def initialize(project, user, params, ref, path = nil)
 
     private
 
-    def error(message)
-      {
-        error: message,
-        status: :error
-      }
-    end
-
     def success
-      {
-        error: '',
-        status: :success
-      }
+      out = super()
+      out[:error] = ''
+      out
     end
 
     def repository

lib/api/branches.rb

@@ -80,10 +80,8 @@ class Branches < Grape::API
       #   POST /projects/:id/repository/branches
       post ":id/repository/branches" do
         authorize_push_project
-        result = CreateBranchService.new.execute(user_project,
-                                                 params[:branch_name],
-                                                 params[:ref],
-                                                 current_user)
+        result = CreateBranchService.new(user_project, current_user).
+          execute(params[:branch_name], params[:ref])
         if result[:status] == :success
           present result[:branch],
                   with: Entities::RepoObject,
@@ -102,9 +100,10 @@ class Branches < Grape::API
       #   DELETE /projects/:id/repository/branches/:branch
       delete ":id/repository/branches/:branch" do
         authorize_push_project
-        result = DeleteBranchService.new.execute(user_project, params[:branch], current_user)
+        result = DeleteBranchService.new(user_project, current_user).
+          execute(params[:branch])
 
-        if result[:state] == :success
+        if result[:status] == :success
           true
         else
           render_api_error!(result[:message], result[:return_code])

lib/api/repositories.rb

@@ -38,9 +38,8 @@ def handle_project_member_errors(errors)
       post ':id/repository/tags' do
         authorize_push_project
         message = params[:message] || nil
-        result = CreateTagService.new.execute(user_project, params[:tag_name],
-                                              params[:ref], message,
-                                              current_user)
+        result = CreateTagService.new(user_project, current_user).
+          execute(params[:tag_name], params[:ref], message)
 
         if result[:status] == :success
           present result[:tag],