hard_worker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5610742592c993b450f98d73be0108ce618772b71b8d89f948ffdaf81e40348
-  data.tar.gz: c1cf069bdc9a5ea5efc427e03db3ad894905376770ddbf2aef331c679719eb0d
+  metadata.gz: b52df482216a2a82f96d8bdaca1f10e7982cb5c897fb0488abb2294ecfa0e33a
+  data.tar.gz: 5b7368324bff956a7f31987a209f07ab685e0fdc9aed96dd4cec5e2bf20014eb
 SHA512:
-  metadata.gz: 58f838abf8e944cde55c7335a6c09e5f33125de95cb19ee95ce9c1732774a379f80ffd36a8a2c072b9d2a9c44cad882cfd96d892758a839a5e4b92e27dcbdc4b
-  data.tar.gz: 44d12718ef28aaa42bfdce9fb3dc339bfacb08820735cc861f1b54312dfb71372b8da631a4b1f89271985a8a24d090a6b63ce46faf3e37699a217e4faa745de5
+  metadata.gz: 680f5d641d281b19b5362ba5380a804582efa1d9a46be5c582f527639aea056351cc310768edeca85fc600770390f20d79198edda9856efc93aefe5beb030ec3
+  data.tar.gz: c4f544d238c9f2403fde1f88009b3c5f0d75001b5310d84c9cd97c6f1049d6e5618e08b274a1b3778feb2e83ae80a1311063d9128d0344325a9247757b92b9b2

data/.rubocop.yml

@@ -20,4 +20,7 @@ Style/AsciiComments:
   Enabled: false
 
 Style/ClassVars:
+  Enabled: false
+
+Security/YAMLLoad:
   Enabled: false

data/CHANGELOG.md

@@ -8,4 +8,9 @@ Things are almost working. You can enqueue jobs! That should be more than enough
 
 ## [0.0.2] - 2021-07-15
 
-- Bugfix: was requiring byebug. 
+- Bugfix: was requiring byebug. 
+
+## [0.0.3] - 2021-07-16
+
+- YAML Marshalled queue! So now the queue stays in memory even if restarted. Though kill and term signals still need catching.. that is not done yet. 
+- Also, now you can use classes! As long as the class has a perform-method. 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hard_worker (0.0.2)
+    hard_worker (0.0.3)
       drb
 
 GEM

data/README.md

@@ -1,12 +1,13 @@
 # Hardworker
 
-This is HardWorker, a new Ruby backend job library! It supports running procs in the background. 
-However, it does not yet support classes. So only procs. Also, you lose all jobs if you restart the process. 
+This is HardWorker, a new Ruby backend job library! It supports running procs and classes in the background. 
+ ~~Also, you lose all jobs if you restart the process.~~ It now uses YAML to load the queue into a file, which it then calls at startup to find the previous jobs. 
 
-But it uses dRuby to do the communication! Which is absolute great. No need for Redis or PostgreSQL, just Ruby standard libraries. 
+It uses dRuby to do the communication! Which is absolute great. No need for Redis or PostgreSQL, just Ruby standard libraries. 
 
 TODO LIST: 
-- Marshal the job queue into a file so you don't lose all progress
+- ~~Marshal the job queue into a file so you don't lose all progress~~
+  (Ended up using YAML)
 - Support Rails and ActiveJob
 - Have a web UI
 - Do some performance testing
@@ -26,13 +27,13 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install hardworker
+    $ gem install hard_worker
 
 ## Usage
 
 Start up HardWorker! 
 
-    $ hardworker
+    $ hard_worker
 
 Then, in another program, connect to HardWorker and give it a job to do. 
 Sample below:
@@ -47,8 +48,18 @@ class DummyWorker
   end
 end
 
+class DumDum
+  # classes need to have a perform method
+  def perform
+    5 / 4
+  end
+end
+
+# Need to start dRuby on the client side
+DRb.start_service
 dummy = DummyWorker.new
 dummy.queue.push(proc { 2 / 1 })
+dummy.queue.push(DumDum.new)
 ```
 
 
@@ -60,7 +71,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hardworker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/hardworker/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/sampokuokkanen/hard_worker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/hardworker/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -68,4 +79,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Hardworker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hardworker/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the HardWorker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hardworker/blob/master/CODE_OF_CONDUCT.md).

data/lib/hard_worker.rb

@@ -3,6 +3,7 @@
 require_relative 'hard_worker/version'
 require_relative 'hard_worker/worker'
 require 'drb'
+require 'yaml'
 
 # HardWorker is a pure Ruby job backend.
 # It has limited functionality, as it only accepts
@@ -11,9 +12,11 @@ require 'drb'
 # Loses all jobs if restarted.
 class HardWorker
   URI = 'druby://localhost:8788'
+  FILE_NAME = 'hard_worker_dump'
   @@queue = Queue.new
 
   def initialize(workers: 1, connect: false)
+    load_jobs
     @worker_list = []
     workers.times do |_i|
       @worker_list << Thread.new { Worker.new }
@@ -25,10 +28,30 @@ class HardWorker
     DRb.thread.join
   end
 
+  def load_jobs
+    jobs = YAML.load(File.binread(FILE_NAME))
+    jobs.each do |job|
+      @@queue.push(job)
+    end
+  rescue StandardError
+    # do nothing
+  end
+
   def stop_workers
     @worker_list.each do |worker|
       Thread.kill(worker)
     end
+    class_array = []
+    @@queue.size.times do |_i|
+      next if (klass_or_proc = @@queue.pop).instance_of?(Proc)
+
+      class_array << klass_or_proc
+    end
+    File.open(FILE_NAME, 'wb') { |f| f.write(YAML.dump(class_array)) }
+  end
+
+  def reset_queue!
+    @@queue = Queue.new
   end
 
   def job_list

data/lib/hard_worker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class HardWorker
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/hard_worker/worker.rb

@@ -8,9 +8,20 @@ class HardWorker
 
     def start_working
       loop do
-        pp HardWorker.fetch_job.call
+        job = HardWorker.fetch_job
+        next unless job
+
+        call_job(job)
         puts 'fetching jobs...'
       end
     end
+
+    def call_job(job)
+      if job.instance_of?(Proc)
+        pp job.call
+      else
+        pp job&.perform
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hard_worker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb