Skip to content

Commit

Permalink
Add missing YARD docs and Dashboard screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
bensheldon committed Dec 31, 2020
1 parent f6798ad commit b5243d7
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -280,4 +280,4 @@ DEPENDENCIES
yard-activesupport-concern

BUNDLED WITH
2.2.3
2.2.4
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,8 @@ GoodJob.on_thread_error = -> (exception) { Raven.capture_exception(exception) }

### Dashboard

![Dashboard UI](https://github.com/bensheldon/good_job/raw/main/SCREENSHOT.png)

_🚧 GoodJob's dashboard is a work in progress. Please contribute ideas and code on [Github](https://github.com/bensheldon/good_job/issues)._
GoodJob includes a Dashboard as a mountable `Rails::Engine`.
Expand Down
Binary file added SCREENSHOT.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion gemfiles/rails_5.2.gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -328,4 +328,4 @@ DEPENDENCIES
yard-activesupport-concern

BUNDLED WITH
2.2.3
2.2.4
2 changes: 1 addition & 1 deletion gemfiles/rails_6.0.gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -343,4 +343,4 @@ DEPENDENCIES
yard-activesupport-concern

BUNDLED WITH
2.2.3
2.2.4
2 changes: 1 addition & 1 deletion gemfiles/rails_6.1.gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -345,4 +345,4 @@ DEPENDENCIES
yard-activesupport-concern

BUNDLED WITH
2.2.3
2.2.4
2 changes: 1 addition & 1 deletion gemfiles/rails_head.gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -351,4 +351,4 @@ DEPENDENCIES
yard-activesupport-concern

BUNDLED WITH
2.2.3
2.2.4
3 changes: 3 additions & 0 deletions lib/good_job/configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ def poll_interval
).to_i
end

# Number of seconds to preserve jobs when using the +good_job cleanup_preserved_jobs+ CLI command.
# This configuration is only used when {GoodJob.preserve_job_records} is +true+.
# @return [Boolean]
def cleanup_preserved_jobs_before_seconds_ago
(
options[:before_seconds_ago] ||
Expand Down
1 change: 1 addition & 0 deletions lib/good_job/notifier.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ module GoodJob # :nodoc:
# When a message is received, the notifier passes the message to each of its recipients.
#
class Notifier
# Raised if the Database adapter does not implement LISTEN.
AdapterCannotListenError = Class.new(StandardError)

# Default Postgres channel for LISTEN/NOTIFY
Expand Down
3 changes: 3 additions & 0 deletions lib/good_job/poller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ class Poller
# @return [array<GoodJob:Poller>]
cattr_reader :instances, default: [], instance_reader: false

# Creates GoodJob::Poller from a GoodJob::Configuration instance.
# @param configuration [GoodJob::Configuration]
# @return [GoodJob::Poller]
def self.from_configuration(configuration)
GoodJob::Poller.new(poll_interval: configuration.poll_interval)
end
Expand Down
4 changes: 2 additions & 2 deletions spec/test_app/db/schema.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# of editing this file, please use the migrations feature of Active Record to
# incrementally modify your database, and then regenerate this schema definition.
#
# This file is the source Rails uses to define your schema when running `rails
# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
# This file is the source Rails uses to define your schema when running `bin/rails
# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
# be faster and is potentially less error prone than running all of your
# migrations from scratch. Old migrations may fail to apply correctly if those
# migrations use external dependencies or application code.
Expand Down

0 comments on commit b5243d7

Please sign in to comment.