resque-stages 0.0.1

data/lib/resque/server/views/_stage_job_list_table.erb

@@ -0,0 +1,46 @@
+<div class="table_container">
+  <table>
+    <tr>
+      <th><a href="<%= u("stages/stage") %>?<%=
+        { group_stage_id: group_stage_id,
+          sort:           "class_name",
+          page_size:      page_size,
+          page_num:       page_num,
+          order:          staged_group_stage.order_param("class_name", sort_by, sort_order) }.to_param %>">
+        Class
+      </a></th>
+      <th><a href="<%= u("stages/stage") %>?<%=
+        { group_stage_id: group_stage_id,
+          sort:           "status",
+          page_size:      page_size,
+          page_num:       page_num,
+          order:          staged_group_stage.order_param("status", sort_by, sort_order) }.to_param %>">
+        Status
+      </a></th>
+      <th><a href="<%= u("stages/stage") %>?<%=
+        { group_stage_id: group_stage_id,
+          sort:           "status_message",
+          page_size:      page_size,
+          page_num:       page_num,
+          order:          staged_group_stage.order_param("status_message", sort_by, sort_order) }.to_param %>">
+        Message
+      </a></th>
+      <th>Args</th>
+    </tr>
+
+    <% jobs.each do |job| %>
+      <tr>
+        <td>
+          <a href="<%= u("stages") %>/job_details?<%= { job_id: job.job_id }.to_param %>">
+            <%= job.class_name %>
+          </a>
+        </td>
+        <td><%= job.status %></td>
+        <td><%= job.status_message %></td>
+        <td>
+          <pre><code><%= "".html_safe + job.uncompressed_args.to_yaml %></code></pre>
+        </td>
+      </tr>
+    <% end %>
+  </table>
+</div>

data/lib/resque/server/views/_staged_group_list_pagination.erb

@@ -0,0 +1,67 @@
+<div class="stages_pagination_block">
+  <% total_pages = staged_group_list.num_groups / page_size %>
+  <% total_pages += 1 if staged_group_list.num_groups % page_size > 0 %>
+  <% page_num = 1 if page_num > total_pages || page_num < 1 %>
+  <% first_page = [1, page_num - 3].max %>
+  <% last_page = [total_pages, page_num + 3].min %>
+  <% last_page = page_num < 4 ? [total_pages, last_page + (4 - page_num)].min : last_page %>
+  <% first_page = page_num > total_pages - 3 ? [1, first_page + ((total_pages - page_num) - 3)].max : first_page %>
+
+  <% if total_pages > 1 %>
+    <div class="stages_prev_links">
+      <a href="<%= u("stages") %>?<%= { sort:      @sort_by,
+                                        page_size: page_size,
+                                        page_num:  1,
+                                        order:     @sort_order }.to_param %>"
+         class="stages_first_page"
+         disabled="<%= first_page > 1 %>">
+        &lt;&lt; First
+      </a>
+
+      <a href="<%= u("stages") %>?<%= { sort:      @sort_by,
+                                        page_size: page_size,
+                                        page_num:  [1, page_num - 1].max,
+                                        order:     @sort_order }.to_param %>"
+         class="stages_prev_page"
+         disabled="<%= page_num > 1 %>">
+        &lt; Prev
+      </a>
+    </div>
+
+    <div class="stages_pages">
+      <% (first_page..last_page).each do |page_number| %>
+        <% if page_number != page_num %>
+          <a href="<%= u("stages") %>?<%= { sort:      @sort_by,
+                                            page_size: page_size,
+                                            page_num:  page_number,
+                                            order:     @sort_order }.to_param %>"
+             class="stages_page">
+            <%= page_number %>
+          </a>
+        <% else %>
+          <%= page_number %>
+        <% end %>
+      <% end %>
+    </div>
+
+    <div class="stages_next_links">
+      <a href="<%= u("stages") %>?<%= { sort:      @sort_by,
+                                        page_size: page_size,
+                                        page_num:  [total_pages, page_num + 1].min,
+                                        order:     @sort_order }.to_param %>"
+         class="stages_next_page"
+         disabled="<%= page_num < last_page %>">
+        Next &gt;
+      </a>
+
+      <a href="<%= u("stages") %>?<%= { sort:      @sort_by,
+                                        page_size: page_size,
+                                        page_num:  total_pages,
+                                        order:     @sort_order }.to_param %>"
+         class="stages_last_page"
+         disabled="<%= last_page < total_pages %>">
+        Last &gt;&gt;
+      </a>
+    </div>
+  <% end %>
+</div>

data/lib/resque/server/views/_staged_group_list_table.erb

@@ -0,0 +1,44 @@
+<div class="table_container">
+  <table>
+    <tr>
+      <th><a href="<%= u("stages") %>?<%=
+        { sort:      "description",
+          page_size: page_size,
+          page_num:  page_num,
+          order:     staged_group_list.order_param("description", sort_by, sort_order) }.to_param %>">
+        Description
+      </a></th>
+      <th><a href="<%= u("stages") %>?<%=
+        { sort:      "num_stages",
+          page_size: page_size,
+          page_num:  page_num,
+          order:     staged_group_list.order_param("num_stages", sort_by, sort_order) }.to_param %>">
+        Num Stages
+      </a></th>
+      <th><a href="<%= u("stages") %>?<%=
+        { sort:      "created_at",
+          page_size: page_size,
+          page_num:  page_num,
+          order:     staged_group_list.order_param("created_at", sort_by, sort_order) }.to_param %>">
+        Created
+      </a></th>
+    </tr>
+
+    <% groups.each do |group| %>
+      <tr>
+        <td>
+          <a href="<%= u("stages") %>/group_stages_list?<%= { group_id: group.group_id }.to_param %>">
+            <%= group.description.presence || "&nbsp;&nbsp;&nbsp;".html_safe %>
+          </a>
+        </td>
+        <td>
+          <%= group.num_stages.to_i %>
+        </td>
+        <td>
+          <%= time_ago_in_words(group.created_at) %> ago
+          (<%= group.created_at %>)
+        </td>
+      </tr>
+    <% end %>
+  </table>
+</div>

data/lib/resque/server/views/group_stages_list.erb

@@ -0,0 +1,58 @@
+<link href="<%= u("stages/public/stages.css") %>" media="screen" rel="stylesheet" type="text/css">
+
+<% group = Resque::Plugins::Stages::StagedGroup.new(@group_id) %>
+
+<h1>
+  <%= group.description %>
+</h1>
+
+<p>
+  <a href="<%= u("stages") %>">
+    Groups
+  </a>
+</p>
+
+<p>
+  Num stages in this group = <%= group.num_stages %>
+</p>
+
+<% if group.num_stages > 0 %>
+  <h1>Stages</h1>
+
+  <% stages = group.paged_stages(@page_num, @page_size) %>
+
+  <div class="stages_reset"/>
+
+  <%= erb(File.read(Resque::StagesServer.erb_path("_group_stages_list_pagination.erb")),
+          locals: { group:     group,
+                    group_id:  @group_id,
+                    page_num:  @page_num,
+                    page_size: @page_size }) %>
+
+  <%= erb(File.read(Resque::StagesServer.erb_path("_group_stages_list_table.erb")),
+          locals: { stages: stages, show_class: false }) %>
+
+  <%= erb(File.read(Resque::StagesServer.erb_path("_group_stages_list_pagination.erb")),
+          locals: { group:     group,
+                    group_id:  @group_id,
+                    page_num:  @page_num,
+                    page_size: @page_size }) %>
+
+  <br/>
+<% end %>
+
+<form method="POST" action="<%= u("stages/initiate_group") %>?<%=
+  { group_id: group.group_id }.to_param %>">
+  <input type="submit" name="" value="Initiate Group"/>
+</form>
+<form method="POST" action="<%= u("stages/delete_group") %>?<%= { group_id: group.group_id }.to_param %>">
+  <input type="submit" name="" value="Delete"/>
+</form>
+
+<div class="stages_reset"/>
+<br/>
+<div>
+  <p>
+    Stages v<%= Resque::Plugins::Stages::VERSION %>
+  </p>
+</div>

data/lib/resque/server/views/groups.erb

@@ -0,0 +1,40 @@
+<link href="<%= u("stages/public/stages.css") %>" media="screen" rel="stylesheet" type="text/css">
+
+<h1>Staged Groups</h1>
+
+<% staged_group_list = Resque::Plugins::Stages::StagedGroupList.new %>
+
+<div class="stages_reset"/>
+
+<%= erb(File.read(Resque::StagesServer.erb_path("_staged_group_list_pagination.erb")),
+        locals: { staged_group_list: staged_group_list, page_num: @page_num, page_size: @page_size }) %>
+
+<%= erb(File.read(Resque::StagesServer.erb_path("_staged_group_list_table.erb")),
+        locals: { groups:            staged_group_list.paginated_groups(@sort_by, @sort_order, @page_num, @page_size),
+                  staged_group_list: staged_group_list,
+                  sort_by:           @sort_by,
+                  sort_order:        @sort_order,
+                  page_num:          @page_num,
+                  page_size:         @page_size }) %>
+
+<%= erb(File.read(Resque::StagesServer.erb_path("_staged_group_list_pagination.erb")),
+        locals: { staged_group_list: staged_group_list, page_num: @page_num, page_size: @page_size }) %>
+
+<br/>
+
+<div>
+  <form method="POST" action="<%= u("stages/delete_all_groups") %>">
+    <input type="submit" name="" value="Delete All Groups"/>
+  </form>
+  <form method="POST" action="<%= u("stages/cleanup_jobs") %>">
+    <input type="submit" name="" value="Cleanup Jobs"/>
+  </form>
+  <form method="POST" action="<%= u("stages/purge_all") %>">
+    <input type="submit" name="" value="Purge"/>
+  </form>
+</div>
+<div class="stages_reset"/>
+<br/>
+<div>
+  Stages v<%= Resque::Plugins::Stages::VERSION %>
+</div>

data/lib/resque/server/views/job_details.erb

@@ -0,0 +1,91 @@
+<link href="<%= u("stages/public/stages.css") %>" media="screen" rel="stylesheet" type="text/css">
+
+<% job_details = Resque::Plugins::Stages::StagedJob.new(@job_id) %>
+
+<h1>
+  <%= job_details.class_name %>
+</h1>
+
+<p>
+  <a href="<%= u("stages") %>">
+    Groups
+  </a>
+  |
+  <% if job_details.staged_group_stage&.staged_group %>
+    <a href="<%= u("stages/group_stages_list") %>?<%= { group_id: job_details.staged_group_stage.staged_group.group_id }.to_param %>">
+      <%= job_details.staged_group_stage.staged_group&.description %>
+    </a>
+  <% end %>
+  |
+  <% if job_details.staged_group_stage %>
+    <a href="<%= u("stages/stage") %>?<%= { group_stage_id: job_details.staged_group_stage.group_stage_id }.to_param %>">
+      <%= job_details.staged_group_stage.number %>
+    </a>
+  <% end %>
+</p>
+
+<div class="table_container">
+  <table>
+    <tr>
+      <td>
+        Enqueued
+      </td>
+      <td>
+        <%= time_ago_in_words(job_details.queue_time) %> ago
+        (<%= job_details.queue_time %>)
+      </td>
+    </tr>
+    <tr>
+      <td>
+        Status
+      </td>
+      <td>
+        <%= job_details.status %>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        Class
+      </td>
+      <td>
+        <%= job_details.class_name %>
+      </td>
+    </tr>
+    </tr>
+    <tr>
+      <td>
+        Params
+      </td>
+      <td>
+        <pre><code><%= "".html_safe + job_details.uncompressed_args.to_yaml %></code></pre>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        Message
+      </td>
+      <td>
+        <%= job_details.status_message %>
+      </td>
+    </tr>
+  </table>
+</div>
+
+<br/>
+
+<% if job_details.pending? %>
+  <form method="POST" action="<%= u("stages/queue_job") %>?<%= { job_id: @job_id }.to_param %>">
+    <input type="submit" name="" value="Queue Job"/>
+  </form>
+<% end %>
+
+<form method="POST" action="<%= u("stages/delete_job") %>?<%= { job_id: @job_id }.to_param %>">
+  <input type="submit" name="" value="Delete Job"/>
+</form>
+
+<div class="stages_reset"/>
+
+<br/>
+<div>
+  Stages v<%= Resque::Plugins::Stages::VERSION %>
+</div>

data/lib/resque/server/views/stage.erb

@@ -0,0 +1,64 @@
+<link href="<%= u("stages/public/stages.css") %>" media="screen" rel="stylesheet" type="text/css">
+
+<% staged_group_stage = Resque::Plugins::Stages::StagedGroupStage.new(params[:group_stage_id]) %>
+
+<h1>Stage <%= staged_group_stage.number %></h1>
+
+<p>
+  <a href="<%= u("stages") %>">
+    Groups
+  </a>
+  |
+  <% if staged_group_stage.staged_group %>
+    <a href="<%= u("stages/group_stages_list") %>?<%= { group_id: staged_group_stage.staged_group.group_id }.to_param %>">
+      <%= staged_group_stage.staged_group&.description %>
+    </a>
+  <% end %>
+</p>
+
+<div class="table_container">
+  <table>
+    <tr>
+      <td>Num jobs</td>
+      <td><%= staged_group_stage.num_jobs %></td>
+    </tr>
+    <tr>
+      <td>Status</td>
+      <td><%= staged_group_stage.status %></td>
+    </tr>
+  </table>
+</div>
+
+<div class="stages_reset"/>
+
+<%= erb(File.read(Resque::StagesServer.erb_path("_stage_job_list_pagination.erb")),
+        locals: { staged_group_stage: staged_group_stage, page_num: @page_num, page_size: @page_size }) %>
+
+<%= erb(File.read(Resque::StagesServer.erb_path("_stage_job_list_table.erb")),
+        locals: { jobs:               staged_group_stage.paginated_jobs(@sort_by, @sort_order, @page_num, @page_size),
+                  staged_group_stage: staged_group_stage,
+                  group_stage_id:     params[:group_stage_id],
+                  sort_by:            @sort_by,
+                  sort_order:         @sort_order,
+                  page_num:           @page_num,
+                  page_size:          @page_size }) %>
+
+<%= erb(File.read(Resque::StagesServer.erb_path("_stage_job_list_pagination.erb")),
+        locals: { staged_group_stage: staged_group_stage, page_num: @page_num, page_size: @page_size }) %>
+
+<br/>
+
+<div>
+  <form method="POST" action="<%= u("stages/initiate_stage") %>?<%= { group_stage_id: staged_group_stage.group_stage_id }.to_param %>">
+    <input type="submit" name="" value="Initiate"/>
+  </form>
+  <form method="POST" action="<%= u("stages/delete_stage") %>?<%= { group_stage_id: staged_group_stage.group_stage_id }.to_param %>">
+    <input type="submit" name="" value="Delete"/>
+  </form>
+</div>
+
+<div class="stages_reset"/>
+<br/>
+<div>
+  Stages v<%= Resque::Plugins::Stages::VERSION %>
+</div>

data/lib/resque/stages_server.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+require "resque"
+require "resque/server"
+require "resque-stages"
+require "action_view/helpers/output_safety_helper"
+require "action_view/helpers/capture_helper"
+require "action_view/helpers/date_helper"
+
+# rubocop:disable Metrics/ModuleLength
+
+module Resque
+  # Extends Resque Web Based UI.
+  # Structure has been borrowed from ResqueHistory.
+  module StagesServer
+    include ActionView::Helpers::DateHelper
+
+    class << self
+      def erb_path(filename)
+        File.join(File.dirname(__FILE__), "server", "views", filename)
+      end
+
+      def public_path(filename)
+        File.join(File.dirname(__FILE__), "server", "public", filename)
+      end
+
+      def included(base)
+        add_page_views(base)
+        add_button_callbacks(base)
+        add_static_files(base)
+      end
+
+      private
+
+      def add_page_views(base)
+        groups_list(base)
+        group_stages_list(base)
+        stage_jobs_list(base)
+        job_details(base)
+      end
+
+      def groups_list(base)
+        stages_key_params(base)
+
+        base.class_eval do
+          get "/stages" do
+            set_stages_key_params
+
+            erb File.read(Resque::StagesServer.erb_path("groups.erb"))
+          end
+        end
+      end
+
+      def stages_key_params(base)
+        base.class_eval do
+          def set_stages_key_params
+            @sort_by    = params[:sort] || "description"
+            @sort_order = params[:order] || "asc"
+            @page_num   = (params[:page_num] || 1).to_i
+            @page_size  = (params[:page_size] || 20).to_i
+          end
+        end
+      end
+
+      def group_stages_list(base)
+        group_stages_list_params(base)
+
+        base.class_eval do
+          get "/stages/group_stages_list" do
+            set_group_stages_list_params_params
+
+            erb File.read(Resque::StagesServer.erb_path("group_stages_list.erb"))
+          end
+        end
+      end
+
+      def group_stages_list_params(base)
+        base.class_eval do
+          def set_group_stages_list_params_params
+            @group_id  = params[:group_id]
+            @page_num  = (params[:page_num] || 1).to_i
+            @page_size = (params[:page_size] || 20).to_i
+          end
+        end
+      end
+
+      def stage_jobs_list(base)
+        stage_jobs_key_params(base)
+
+        base.class_eval do
+          get "/stages/stage" do
+            set_stage_jobs_key_params
+
+            erb File.read(Resque::StagesServer.erb_path("stage.erb"))
+          end
+        end
+      end
+
+      def stage_jobs_key_params(base)
+        base.class_eval do
+          def set_stage_jobs_key_params
+            @group_stage_id = params[:group_stage_id]
+            @sort_by        = params[:sort] || "status"
+            @sort_order     = params[:order] || "desc"
+            @page_num       = (params[:page_num] || 1).to_i
+            @page_size      = (params[:page_size] || 20).to_i
+          end
+        end
+      end
+
+      def job_details(base)
+        base.class_eval do
+          get "/stages/job_details" do
+            @job_id = params[:job_id]
+
+            erb File.read(Resque::StagesServer.erb_path("job_details.erb"))
+          end
+        end
+      end
+
+      def add_static_files(base)
+        base.class_eval do
+          get %r{/stages/public/([a-z_]+\.[a-z]+)} do
+            send_file Resque::StagesServer.public_path(params[:captures]&.first)
+          end
+        end
+      end
+
+      def add_button_callbacks(base)
+        purge_all(base)
+        cleanup_jobs(base)
+        delete_all_groups(base)
+        initiate_group(base)
+        delete_group(base)
+        initiate_stage(base)
+        delete_stage(base)
+        queue_job(base)
+        delete_job(base)
+      end
+
+      def purge_all(base)
+        base.class_eval do
+          post "/stages/purge_all" do
+            Resque::Plugins::Stages::Cleaner.purge_all
+
+            redirect u("stages")
+          end
+        end
+      end
+
+      def cleanup_jobs(base)
+        base.class_eval do
+          post "/stages/cleanup_jobs" do
+            Resque::Plugins::Stages::Cleaner.cleanup_jobs
+
+            redirect u("stages")
+          end
+        end
+      end
+
+      def delete_all_groups(base)
+        base.class_eval do
+          post "/stages/delete_all_groups" do
+            Resque::Plugins::Stages::StagedGroupList.new.delete_all
+
+            redirect u("stages")
+          end
+        end
+      end
+
+      def initiate_group(base)
+        base.class_eval do
+          post "/stages/initiate_group" do
+            Resque::Plugins::Stages::StagedGroup.new(params[:group_id]).initiate
+
+            redirect u("stages")
+          end
+        end
+      end
+
+      def delete_group(base)
+        base.class_eval do
+          post "/stages/delete_group" do
+            Resque::Plugins::Stages::StagedGroup.new(params[:group_id]).delete
+
+            redirect u("stages")
+          end
+        end
+      end
+
+      def initiate_stage(base)
+        base.class_eval do
+          post "/stages/initiate_stage" do
+            Resque::Plugins::Stages::StagedGroupStage.new(params[:group_stage_id]).initiate
+
+            redirect u("stages")
+          end
+        end
+      end
+
+      def delete_stage(base)
+        base.class_eval do
+          post "/stages/delete_stage" do
+            Resque::Plugins::Stages::StagedGroupStage.new(params[:group_stage_id]).delete
+
+            redirect u("stages")
+          end
+        end
+      end
+
+      def queue_job(base)
+        base.class_eval do
+          post "/stages/queue_job" do
+            Resque::Plugins::Stages::StagedJob.new(params[:job_id]).enqueue_job
+
+            redirect u("stages")
+          end
+        end
+      end
+
+      def delete_job(base)
+        base.class_eval do
+          post "/stages/delete_job" do
+            Resque::Plugins::Stages::StagedJob.new(params[:job_id]).delete
+
+            redirect u("stages")
+          end
+        end
+      end
+    end
+
+    Resque::Server.tabs << "Stages"
+  end
+end
+
+Resque::Server.class_eval do
+  include Resque::StagesServer
+end
+
+# rubocop:enable Metrics/ModuleLength