que-view 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ced9639e99e58168c4b6e6a43c95f25e7a8dc0e44da579cc3e5bff4260afac
-  data.tar.gz: 035f401a2e5afe417100ecb908ca54e99d467a7af3822a698af734e27bfbee1c
+  metadata.gz: a54cde016dccd6207b38924f717a5aeb3ea9ccae0eef215f848c2621c8af4945
+  data.tar.gz: 0d44f6c8e723e8533c8f640b58996a2b25b7d444115c761e95879c6a91ca3331
 SHA512:
-  metadata.gz: 38a0e562ee5553257cdddffceb963b87b659cc57fd04fc8c78c0a1b6e6c7863d4c86287f0fc03e6df30bbd8823c758b0b78607c56fd39a04fb345649aad72aee
-  data.tar.gz: 7466ab6634be76c84a3587eb800f82fbe7cb355eba7914cae29cd4bcf66054ff519b14d11d3a9be3c5927eb9011486e0d78d287ff7b7ada6ca758a5d77943dc6
+  metadata.gz: 72bde7eb6e7d6a2ae64e380eedb7f8ce45eb609116a017e71dc1af0ea7acdb5df7293cfb5015474b6d0793570b9062ca735e95878ea1e65e570dd95f0ba4f3d3
+  data.tar.gz: 659f6cfb80c3bb746f2f0088638e3e6f8d7acd63cc47ab0584df44762a9b18266736fd80bb4820c0a91d0e1b12b3262f7209c7321c7cf867b3ca9f2ee7c7eae9

data/README.md

@@ -1,7 +1,16 @@
 # Que::View
 Rails engine inspired by [Que::Web](https://github.com/statianzo/que-web) for [Que](https://github.com/que-rb/que) job queue.
 SQL queries came from Que::Web, some styling from there too.
-Benefits for using this one: independent from Sinatra (que-web based on Sinatra)
+
+Benefits for using this one:
+- no Sinatra (que-web based on Sinatra),
+- no Foundation for styles,
+- no jQuery,
+- Que::Web was last updated 2 years ago.
+
+<img width="1735" alt="Снимок экрана 2024-02-21 в 15 10 35" src="https://github.com/kortirso/que-view/assets/6195394/cd2812c7-abb0-48d9-92d5-4dbef93bcd9e">
+<img width="1735" alt="Снимок экрана 2024-02-21 в 15 11 12" src="https://github.com/kortirso/que-view/assets/6195394/8af01e7f-a002-4ef1-aeff-f96fd27c639f">
+
 
 ## Installation
 
@@ -48,8 +57,10 @@ Add this line to assets/config/manifest.js
 
 - [X] rescheduling jobs
 - [X] deleting jobs
-- [ ] better styles for UI
-- [ ] rendering running jobs
+- [X] better styles for UI
+- [X] rendering running jobs
+- [ ] searching/filtering through jobs by name, queue
+- [X] pagination for jobs list page
 - [ ] tests
 
 ## License

data/app/assets/stylesheets/que/view/application.css

@@ -20,6 +20,11 @@
   font-family: 'Source Sans Pro';
 }
 
+html, body {
+  padding: 0;
+  margin: 0;
+}
+
 .row {
   display: flex;
   flex-direction: row;
@@ -48,11 +53,11 @@ table th {
 }
 
 table tbody tr:nth-of-type(2n), table tbody tr:hover {
-  background: #DDD;
+  background: #EEE;
 }
 
 table tbody tr:nth-of-type(2n):hover {
-  background: #CCC;
+  background: #DDD;
 }
 
 table p {
@@ -114,3 +119,76 @@ table p {
   padding: .25rem .5rem;
   margin-right: .5rem;
 }
+
+.pagination {
+  margin: 1rem auto;
+}
+
+.pagination .pagination-link {
+  margin: 0 .5rem 0 0;
+  padding: .25rem .5rem;
+  background: #fde68a;
+  border: 1px solid #fcd34d;
+  border-radius: .25rem;
+  text-decoration: none;
+}
+
+.pagination .pagination-link.disabled {
+  background: #fef3c7;
+}
+
+.pagination .total-pages {
+  margin: 0 .5rem 0 0;
+  padding: .25rem .5rem;
+}
+
+.navigation {
+  display: flex;
+  padding: .5rem 1rem;
+  background: #52525b;
+  color: #fff;
+}
+
+.navigation h1 {
+  margin: 0 2rem 0 0;
+}
+
+.navigation h1 a {
+  text-decoration: none;
+  color: #fff;
+}
+
+.navigation .navigation-section {
+  flex: 1;
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.navigation .navigation-section ul {
+  margin: 0;
+  padding: 0;
+  list-style: none;
+  display: flex;
+}
+
+.navigation .navigation-section ul.version li {
+  margin-left: 1rem;
+}
+
+.navigation .navigation-section ul li a {
+  display: inline-block;
+  padding: .5rem;
+  text-decoration: none;
+  color: #fff;
+}
+
+.navigation .navigation-section ul li.active a {
+  text-decoration: underline;
+}
+
+@media screen and (max-width: 768px) {
+  .row {
+    flex-direction: column;
+  }
+}

data/app/controllers/que/view/jobs_controller.rb

@@ -9,7 +9,7 @@ module Que
 
       def index
         @jobs = find_jobs(params[:status])
-        @jobs_amount = find_jobs_amount(params[:status])
+        paginate
       end
 
       def show; end
@@ -48,6 +48,19 @@ module Que
 
       private
 
+      def paginate
+        return if %w[failing scheduled].exclude?(params[:status])
+        return unless @jobs.any?
+
+        @pagination = Que::View::Pagination.new(
+          params: {
+            page: page,
+            per_page: params[:per_page] || PER_PAGE,
+            count: find_jobs_total_amount(params[:status])
+          }
+        )
+      end
+
       def find_job
         @job = ::Que::View.fetch_job(params[:id])[0]
         return if @job
@@ -57,13 +70,14 @@ module Que
 
       def find_jobs(status)
         case status&.to_sym
+        when :running then ::Que::View.fetch_running_jobs(search)
         when :failing then ::Que::View.fetch_failing_jobs(PER_PAGE, offset, search)
         when :scheduled then ::Que::View.fetch_scheduled_jobs(PER_PAGE, offset, search)
         else []
         end
       end
 
-      def find_jobs_amount(status)
+      def find_jobs_total_amount(status)
         ::Que::View.fetch_dashboard_stats(search)[0][status&.to_sym]
       end
 
@@ -96,13 +110,13 @@ module Que
         sanitised
       end
 
-      def page
-        (params[:page] || 1).to_i
-      end
-
       def offset
         (page - 1) * PER_PAGE
       end
+
+      def page
+        (params[:page] || 1).to_i
+      end
     end
   end
 end

data/app/views/layouts/que/view/application.html.erb

@@ -7,6 +7,27 @@
     <%= stylesheet_link_tag 'que/view/application', media: 'all' %>
   </head>
   <body>
+    <nav class="navigation" role="navigation">
+      <h1><%= link_to 'Que View', root_path %></h1>
+      <section class="navigation-section">
+        <ul>
+          <li class="<%= 'active' if params[:status] == 'running' %>">
+            <%= link_to 'Running', jobs_path(status: 'running') %>
+          </li>
+          <li class="<%= 'active' if params[:status] == 'scheduled' %>">
+            <%= link_to 'Scheduled', jobs_path(status: 'scheduled') %>
+          </li>
+          <li class="<%= 'active' if params[:status] == 'failing' %>">
+            <%= link_to 'Failing', jobs_path(status: 'failing') %>
+          </li>
+        </ul>
+        <ul class="version">
+          <li>Que <%= Que::VERSION %></li>
+          <li>Que View <%= Que::View::VERSION %></li>
+          <li><%= Time.now.utc.strftime("%Y-%m-%d %H:%M:%S") %></li>
+        </ul>
+      </section>
+    </nav>
     <%= yield %>
   </body>
 </html>

data/app/views/que/view/jobs/index.html.erb

@@ -1,13 +1,32 @@
-<div class="row">
-  <% if @jobs.size.positive? %>
+<% if @jobs.any? %>
+  <% if @pagination %>
+    <div class="row pagination">
+      <% if @pagination.previous_page? %>
+        <%= link_to 'First', jobs_path(status: params[:status], page: 1), class: 'pagination-link' %>
+        <%= link_to '< Previous', jobs_path(status: params[:status], page: @pagination.previous_page), class: 'pagination-link' %>
+      <% else %>
+        <p class="pagination-link disabled">First</p>
+        <p class="pagination-link disabled">&#60; Previous</p>
+      <% end %>
+      <p class="total-pages"><%= "Page #{@pagination.page} of #{@pagination.total_pages}" %></p>
+      <% if @pagination.next_page? %>
+        <%= link_to 'Next >', jobs_path(status: params[:status], page: @pagination.next_page), class: 'pagination-link' %>
+        <%= link_to 'Last', jobs_path(status: params[:status], page: @pagination.total_pages), class: 'pagination-link' %>
+      <% else %>
+        <p class="pagination-link disabled">Next &#62;</p>
+        <p class="pagination-link disabled">Last </p>
+      <% end %>
+    </div>
+  <% end %>
+  <div class="row">
     <table cellspacing="0">
       <thead>
         <tr>
           <th>ID</th>
           <th>Run at</th>
           <th>Job</th>
-          <th>Arguments</th>
           <th>Queue</th>
+          <th>Arguments</th>
           <% if params[:status] == 'failing' %>
             <th>Failures</th>
             <th>Error</th>
@@ -21,7 +40,7 @@
         <% @jobs.each do |job| %>
           <tr>
             <td><%= link_to job[:id], job_path(job[:id]) %></td>
-            <td><%= job[:run_at].utc %></td>
+            <td><%= job[:run_at].strftime("%Y-%m-%d %H:%M:%S") %></td>
             <td><%= humanized_job_class(job) %></td>
             <td><%= job[:queue] %></td>
             <td>
@@ -34,20 +53,24 @@
               <td><%= format_error(job) %></td>
             <% end %>
             <% if %w[failing scheduled].include?(params[:status]) %>
-              <td class="actions">
-                <%= button_to 'Run', job_path(job[:id]), class: 'btn-danger', method: :patch, onclick: "return confirm('Are you sure you wish to reschedule job?')" %>
-                <%= button_to 'Delete', job_path(job[:id]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete job?')" %>
+              <td>
+                <div class="actions">
+                  <%= button_to 'Run', job_path(job[:id]), class: 'btn-danger', method: :patch, onclick: "return confirm('Are you sure you wish to reschedule job?')" %>
+                  <%= button_to 'Delete', job_path(job[:id]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete job?')" %>
+                </div>
               </td>
             <% end %>
           </tr>
         <% end %>
       </tbody>
     </table>
-  <% else %>
+  </div>
+<% else %>
+  <div class="row">
     <p>No jobs found</p>
-  <% end %>
-</div>
-<% if %w[failing scheduled].include?(params[:status]) && @jobs_amount.positive? %>
+  </div>
+<% end %>
+<% if @pagination&.count&.positive? %>
   <div class="row">
     <%= button_to 'Run All', reschedule_all_jobs_path(status: params[:status]), class: 'btn-danger', method: :post, onclick: "return confirm('Are you sure you wish to reschedule all jobs?')" %>
     <%= button_to 'Delete All', destroy_all_jobs_path(status: params[:status]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete all jobs?')" %>

data/app/views/que/view/jobs/show.html.erb

@@ -20,7 +20,7 @@
       </tr>
       <tr>
         <th>Run at</th>
-        <td><%= @job[:run_at].utc %></td>
+        <td><%= @job[:run_at].strftime("%Y-%m-%d %H:%M:%S") %></td>
       </tr>
       <tr>
         <th>Failures</th>

data/lib/que/view/dsl.rb

@@ -8,6 +8,10 @@ module Que
         execute(fetch_dashboard_stats_sql(...))
       end
 
+      def fetch_running_jobs(...)
+        Que.job_states
+      end
+
       def fetch_failing_jobs(...)
         execute(fetch_failing_jobs_sql(...))
       end

data/lib/que/view/pagination.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Que
+  module View
+    class Pagination
+      attr_reader :page, :count, :per_page
+
+      def initialize(params: {})
+        @page = params[:page]
+        @count = params[:count]
+        @per_page = params[:per_page]
+      end
+
+      def offset
+        return 0 if page == 1
+
+        per_page * (page.to_i - 1)
+      end
+
+      def next_page
+        page + 1 unless last_page?
+      end
+
+      def next_page?
+        page < total_pages
+      end
+
+      def previous_page
+        page - 1 unless first_page?
+      end
+
+      def previous_page?
+        page > 1
+      end
+
+      def last_page?
+        page == total_pages
+      end
+
+      def first_page?
+        page == 1
+      end
+
+      def total_pages
+        (count / per_page.to_f).ceil
+      end
+    end
+  end
+end

data/lib/que/view/version.rb

@@ -2,6 +2,6 @@
 
 module Que
   module View
-    VERSION = '0.2.3'
+    VERSION = '0.3.0'
   end
 end

data/lib/que/view.rb

@@ -6,13 +6,14 @@ require 'que/view/version'
 require 'que/view/engine'
 require 'que/view/configuration'
 require 'que/view/dsl'
+require 'que/view/pagination'
 
 module Que
   module View
     extend self
     extend Forwardable
 
-    # Public: Configure emailbutler.
+    # Public: Configure que view.
     #
     #   Que::View.configure do |config|
     #   end
@@ -26,15 +27,15 @@ module Que
       @configuration ||= Configuration.new
     end
 
-    # Public: Default per thread emailbutler instance if configured.
+    # Public: Default per thread que view instance if configured.
     # Returns Que::View::DSL instance.
     def instance
       Thread.current[:que_view_instance] ||= DSL.new
     end
 
     # Public: All the methods delegated to instance. These should match the interface of Que::View::DSL.
-    def_delegators :instance,
-                   :fetch_dashboard_stats, :fetch_failing_jobs, :fetch_scheduled_jobs, :fetch_job,
+    def_delegators :instance, :fetch_dashboard_stats,
+                   :fetch_running_jobs, :fetch_failing_jobs, :fetch_scheduled_jobs, :fetch_job,
                    :delete_failing_jobs, :delete_scheduled_jobs, :delete_job,
                    :reschedule_scheduled_jobs, :reschedule_failing_jobs, :reschedule_job
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-view
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: que
@@ -175,6 +175,7 @@ files:
 - lib/que/view/configuration.rb
 - lib/que/view/dsl.rb
 - lib/que/view/engine.rb
+- lib/que/view/pagination.rb
 - lib/que/view/version.rb
 homepage: https://github.com/kortirso/que-view
 licenses: