# Hardworker

[![CodeFactor](https://www.codefactor.io/repository/github/sampokuokkanen/hard_worker/badge)](https://www.codefactor.io/repository/github/sampokuokkanen/hard_worker) [![Gem Version](https://badge.fury.io/rb/hard_worker.svg)](https://badge.fury.io/rb/hard_worker)

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. 

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~~
  (Ended up using YAML)
- ~~Support Rails~~ (Supported!)
- ~~Parse options from command line, eg. `--workers 10`~~(Done!)
- Maybe support ActiveJob?
- Have a web UI
- Do some performance testing
- Add a section telling people to use Sidekiq if they can

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'hard_worker'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install hard_worker

## Usage

Start up HardWorker! 

    $ hard_worker

Then, in another program, connect to HardWorker and give it a job to do. 
Sample below:

```ruby
class DummyWorker
  attr_accessor :queue

  def initialize
    server_uri = HardWorker::URI
    self.queue = DRbObject.new_with_uri(server_uri)
  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)
```

Hardworker runs on localhost, port 8788. Should probably make that a value you can change...

## Rails

Usage with Rails:
First, start up HardWorker. 
Then, 
```ruby
$client = HardWorker::Client.new
```

and you can use the client! 
Call 

```ruby
$client.perform_belated(job)
```
If you want to pass a job to HardWorker. 

# Settings
Configuring HardWorker:

```ruby
HardWorker.configure do |config|
  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
end
```

From command line:

$ bundle exec hard_worker --rails=true

Use Rails or not. 

$ bundle exec hard_worker --rails_path=/my_rails_project

Path to Rails project. 

$ bundle exec hard_worker --workers=10

Number of workers. 
## 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.

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).

## Contributing

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

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## 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).