belated 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c440417194e561ef7dacc37228c9025afe230dca489d7a80f5478e8d38f75231
-  data.tar.gz: 8e2d9c85906dc9e25a201388a7a8fd155406704cd573d7a7599d3e3af9344f55
+  metadata.gz: 67777540e4d30c80208702f5724fa0e1d1cd37fcfb454b5f631f97892f6c1a47
+  data.tar.gz: 811689e8a3a180b03a42885c90441aaaada3786b23f6bc4379c78b5376da0072
 SHA512:
-  metadata.gz: ddfb739688a3efefa4c4c503c64008badd5b5befba1a96ee2d9817af7e84615429aaa888266712551e06451aae5c5b9c5c1bd5e5ac3ac0d392fb0b02470c9d34
-  data.tar.gz: 452b13016e6c1d08d6784d96e6234750eb9741b774ee1e8a9a08721d0e0d53bf49d9f9442647cec324e52e818fb230591cae136f67b88b98fabb8cf07a3ecfe5
+  metadata.gz: a02df25ac3e60f1bce4d470aceccc6208c4abe938e5b051f0ace46dc86569b316bdc13230d51a4008c36927bdcf4c57dbb843200ea8f2e2575d8570bcfca4251
+  data.tar.gz: 5ac24e84ed38c3728b5f589deb66a16722b5c3e73da3c61e83803c0574c16e8b42da99bd8148b19bd1a316765de9b552967082fa53d3ac63c1c285e3263a1a69

data/.gitignore

@@ -11,7 +11,8 @@
 .rspec_status
 .byebug_history
 /dummy/tmp/cache/
-/dummy/log/
-/dummy/log/test.log
+/dummy/log/*.log
+/dummy/db
 belated_dump
 stackprof*
+history_*

data/.rspec

@@ -1,4 +1,5 @@
 --format documentation
 --color
 --require spec_helper
---profile
+--profile
+--fail-fast

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.9.0] - 2021-11-03 
+- Fix env setting bug. If you set env, it was not working... now it should work. 
+- Add rudimentary admin panel. You can see future jobs from there. 
 ## [0.8.3] - 2021-09-10
 - Add environment to the names of the pstore files. This way you won't get your development, staging, and production jobs mixed up. (I was getting my test and dev jobs mixed up)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belated (0.8.3)
+    belated (0.9.0)
       drb
       dry-configurable
       pstore
@@ -11,60 +11,60 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.4)
-      actionpack (= 6.1.4)
-      activesupport (= 6.1.4)
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.4)
-      actionpack (= 6.1.4)
-      activejob (= 6.1.4)
-      activerecord (= 6.1.4)
-      activestorage (= 6.1.4)
-      activesupport (= 6.1.4)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       mail (>= 2.7.1)
-    actionmailer (6.1.4)
-      actionpack (= 6.1.4)
-      actionview (= 6.1.4)
-      activejob (= 6.1.4)
-      activesupport (= 6.1.4)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.4)
-      actionview (= 6.1.4)
-      activesupport (= 6.1.4)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.4)
-      actionpack (= 6.1.4)
-      activerecord (= 6.1.4)
-      activestorage (= 6.1.4)
-      activesupport (= 6.1.4)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       nokogiri (>= 1.8.5)
-    actionview (6.1.4)
-      activesupport (= 6.1.4)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.4)
-      activesupport (= 6.1.4)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
       globalid (>= 0.3.6)
-    activemodel (6.1.4)
-      activesupport (= 6.1.4)
-    activerecord (6.1.4)
-      activemodel (= 6.1.4)
-      activesupport (= 6.1.4)
-    activestorage (6.1.4)
-      actionpack (= 6.1.4)
-      activejob (= 6.1.4)
-      activerecord (= 6.1.4)
-      activesupport (= 6.1.4)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       marcel (~> 1.0.0)
       mini_mime (>= 1.1.0)
-    activesupport (6.1.4)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -80,66 +80,67 @@ GEM
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
     diff-lcs (1.4.4)
-    drb (2.0.4)
-    dry-configurable (0.12.1)
+    drb (2.1.0)
+      ruby2_keywords
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
+      dry-core (~> 0.6)
     dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
     erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.10.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.1)
+    marcel (1.0.2)
     method_source (1.0.0)
-    mini_mime (1.1.0)
+    mini_mime (1.1.2)
     mini_portile2 (2.6.1)
     minitest (5.14.4)
-    nio4r (2.5.7)
-    nokogiri (1.12.3)
+    nio4r (2.5.8)
+    nokogiri (1.12.5)
       mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    nokogiri (1.12.3-x86_64-darwin)
+    nokogiri (1.12.5-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.12.3-x86_64-linux)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     pstore (0.1.1)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.4)
-      actioncable (= 6.1.4)
-      actionmailbox (= 6.1.4)
-      actionmailer (= 6.1.4)
-      actionpack (= 6.1.4)
-      actiontext (= 6.1.4)
-      actionview (= 6.1.4)
-      activejob (= 6.1.4)
-      activemodel (= 6.1.4)
-      activerecord (= 6.1.4)
-      activestorage (= 6.1.4)
-      activesupport (= 6.1.4)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       bundler (>= 1.15.0)
-      railties (= 6.1.4)
+      railties (= 6.1.4.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.4)
-      actionpack (= 6.1.4)
-      activesupport (= 6.1.4)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       method_source
       rake (>= 0.13)
       thor (~> 1.0)
@@ -160,7 +161,7 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-rails (5.0.1)
+    rspec-rails (5.0.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -169,26 +170,25 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.10.2)
-    rubocop (1.19.0)
+    rubocop (1.22.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.10.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
     rubocop-discourse (2.4.2)
       rubocop (>= 1.1.0)
       rubocop-rspec (>= 2.0.0)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    set (1.0.1)
+    set (1.0.2)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
@@ -203,11 +203,11 @@ GEM
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -123,16 +123,30 @@ client.perform_belated(job, Time.now + 1.month)
 
 The client also holds references to the jobs that are instances of `Proc` that have been pushed so that they are not collected by GC. This is because procs are passed by reference, and the client needs to keep them alive. They are removed from the list when the job is done.
 
+There is also a rudimentary admin panel: 
+1. Mount the engine routes
+```ruby
+# routes.rb
+mount Belated::Engine => '/belated'
+```
+
+Then access it at `/belated/` for job search based on id or see future jobs at `/belated/future_jobs`.
+Warning: Very rudimentary.  
+
 # Settings
 
 Configuring Belated:
 
 ```ruby
 Belated.configure do |config|
+  config.env = 'production' # Defaults to production
   config.rails = false # default is true
   config.rails_path = # './dummy' default is '.'
   config.connect = false # Connect to dRuby, default is true, useful for testing only
   config.workers = 2 # default is 1
+  config.basic_auth.user = 'user' # default is Belated
+  config.basic_auth.password = 'password' # default is Belated123
+  # Set nil for both if you don't want basic auth
 end
 ```
 
@@ -178,6 +192,7 @@ Belated::Client.test_mode_off! # Turn off inline job processing
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+On Ubuntu, if you have an SQLite install error, try `sudo apt-get install libsqlite3-dev`.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/app/controllers/belated/admin_controller.rb

@@ -0,0 +1,18 @@
+class Belated
+  # Controller in charge of admin side of Belated.
+  class AdminController < ::ActionController::Base
+    if (name = Belated.basic_auth.name) && (pass = Belated.basic_auth.password)
+      http_basic_authenticate_with name: name, password: pass
+    end
+
+    def index
+      return unless request.post?
+
+      @belated = Belated.find params[:job_id]
+    end
+
+    def future_jobs
+      @belateds = Belated.all_future_jobs
+    end
+  end
+end

data/app/views/belated/admin/future_jobs.html.erb

@@ -0,0 +1,20 @@
+<table class="table jobs">
+  <thead>
+    <th>
+      Job Name
+    </th>
+    <th>
+      Job Time
+    </th>
+  </thead>
+  <%= @belateds.each do |job| %>
+  <tr>
+    <td>
+      <%= job.job.inspect %>
+    </td>
+    <td>
+      <%= job.at %>
+    </td>
+  </tr>
+  <% end %>
+</table>

data/app/views/belated/admin/index.html.erb

@@ -0,0 +1,3 @@
+Belated Admin Panel
+
+<%= @belated.inspect %>

data/app/views/layouts/belated/admin.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>   
+<html>   
+  <head>   
+    <title>Belated</title>   
+      
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
+  </head>   
+  
+    <body>
+
+    <%= yield %>
+    </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Belated::Engine.routes.draw do
+  match '/', to: 'admin#index', via: %i[get post]
+  get '/future_jobs', to: 'admin#future_jobs'
+end

data/lib/belated/{rails.rb → engine.rb}

@@ -1,5 +1,5 @@
 class Belated
-  class Rails < ::Rails::Engine
+  class Engine < ::Rails::Engine
     isolate_namespace Belated
   end
 end

data/lib/belated/queue.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'belated/job'
 require 'belated/logging'
 require 'belated/job_wrapper'
 require 'sorted_set'
@@ -21,7 +20,7 @@ class Belated
       @queue = queue
       @mutex = Mutex.new
       self.future_jobs = future_jobs
-      self.future_jobs_db = PStore.new("future_jobs_#{Belated.environment}.pstore", true) # pass true for thread safety
+      self.future_jobs_db = PStore.new("future_jobs_#{Belated.env}.pstore", true) # pass true for thread safety
     end
 
     def enqueue_future_jobs

data/lib/belated/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Belated
-  VERSION = '0.8.3'
+  VERSION = '0.9.0'
 end

data/lib/belated/worker.rb

@@ -42,7 +42,7 @@ class Belated
       today = Time.now.strftime('%F')
       return @store if @store&.path&.include?(today)
 
-      @store = PStore.new("history_#{Belated.environment}-#{today}.pstore", true)
+      @store = PStore.new("history_#{Belated.env}-#{today}.pstore", true)
     end
   end
 end

data/lib/belated.rb

@@ -6,6 +6,7 @@ require_relative 'belated/worker'
 require 'belated/client'
 require 'belated/job_wrapper'
 require 'belated/queue'
+require 'ruby2_keywords'
 require 'drb'
 require 'dry-configurable'
 require 'logger'
@@ -23,17 +24,22 @@ class Belated
   include Logging
   include Singleton unless $TESTING
 
-  setting :rails, true
-  setting :rails_path, '.'
-  setting :workers, 1
-  setting :connect, true
-  setting :environment, 'development', reader: true
-  setting :logger, Logger.new($stdout), reader: true
-  setting :log_level, :info, reader: true
-  setting :host, 'localhost', reader: true
-  setting :port, '8788', reader: true
-  setting :heartbeat, 1, reader: true
-  setting :client_heartbeat, 5, reader: true
+  setting :rails, default: true
+  setting :rails_path, default: '.'
+  setting :workers, default: 1
+  setting :connect, default: true
+  setting :env, default: 'production', reader: true
+  setting :logger, default: Logger.new($stdout), reader: true
+  setting :log_level, default: :info, reader: true
+  setting :host, default: 'localhost', reader: true
+  setting :port, default: '8788', reader: true
+  setting :heartbeat, default: 1, reader: true
+  setting :client_heartbeat, default: 5, reader: true
+  setting :basic_auth, reader: true do
+    setting :name, default: 'Belated'
+    setting :password, default: 'Belated123'
+  end
+
   URI = "druby://#{Belated.host}:#{Belated.port}"
   @@queue = Belated::Queue.new
 
@@ -65,7 +71,6 @@ class Belated
   end
 
   def trap_signals
-    pp 'trap'
     %w[INT TERM].each do |signal|
       Signal.trap(signal) do
         @worker_list.length.times do
@@ -85,10 +90,9 @@ class Belated
   def boot_app
     return unless rails?
 
-    ENV['RAILS_ENV'] ||= Belated.config.environment
+    ENV['RAILS_ENV'] ||= Belated.env
     require File.expand_path("#{Belated.config.rails_path}/config/environment.rb")
     require 'rails/all'
-    require 'belated/rails'
     require 'active_job/queue_adapters/belated_adapter'
   end
 
@@ -130,7 +134,7 @@ class Belated
 
   def banner_and_info
     log banner
-    log "Currently running Belated version #{Belated::VERSION} in #{Belated.config.environment}"
+    log "Currently running Belated version #{Belated::VERSION} in #{Belated.env}"
     log %(Belated running #{@worker_list&.length.to_i} workers on #{URI}...)
   end
 
@@ -158,6 +162,10 @@ class Belated
       clear_queue!
     end
 
+    def all_future_jobs
+      @@queue.future_jobs
+    end
+
     def clear_queue!
       @@queue.clear
     end
@@ -175,4 +183,7 @@ class Belated
     @@queue
   end
 end
-require 'active_job/queue_adapters/belated_adapter' if defined?(::Rails)
+if defined?(::Rails)
+  require 'active_job/queue_adapters/belated_adapter'
+  require 'belated/engine'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belated
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb
@@ -115,20 +115,24 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/belated/admin_controller.rb
+- app/views/belated/admin/future_jobs.html.erb
+- app/views/belated/admin/index.html.erb
+- app/views/layouts/belated/admin.html.erb
 - belated.gemspec
 - bin/belated
 - bin/bundle
 - bin/console
 - bin/setup
+- config/routes.rb
 - lib/active_job/queue_adapters/belated_adapter.rb
 - lib/belated.rb
 - lib/belated/client.rb
+- lib/belated/engine.rb
 - lib/belated/exceptions.rb
-- lib/belated/job.rb
 - lib/belated/job_wrapper.rb
 - lib/belated/logging.rb
 - lib/belated/queue.rb
-- lib/belated/rails.rb
 - lib/belated/testing.rb
 - lib/belated/version.rb
 - lib/belated/worker.rb

data/lib/belated/job.rb

@@ -1 +0,0 @@
-Job = Struct.new(:klass, :at)