job_notifier 1.2.3 → 2.0.0

data/app/assets/javascripts/job_notifier/notifier.js

@@ -40,6 +40,10 @@
     JobNotifier.onPendingJobsLoad = function() {
       var data = JSON.parse(this.responseText);
 
+      if (data.jobs) {
+        data = data.jobs;
+      }
+
       if(data.length === 0) {
         JobNotifier.findJobs();
         return;

data/app/models/job_notifier/job.rb

@@ -1,5 +1,5 @@
 module JobNotifier
-  class Job < ActiveRecord::Base
+  class Job < ApplicationRecord
     extend Enumerize
 
     STATUSES = [:pending, :finished, :failed]
@@ -9,7 +9,8 @@ module JobNotifier
     def self.update_feedback(job_id, data, status)
       job = JobNotifier::Job.find_by(job_id: job_id)
       return unless job
-      job.update_columns(result: data.to_s, status: status, notified: false)
+
+      job.update(result: data.to_s, status: status, notified: false)
     end
 
     def self.unnotified_by_identifier(encoded_identifier)

data/job_notifier.gemspec

@@ -17,14 +17,18 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split($/).reject { |fn| fn.start_with? "spec" }
   s.test_files = Dir["spec/**/*"]
 
-  s.add_dependency "rails", ">= 4.2.0"
-  s.add_dependency "enumerize", ">= 1.0"
+  s.add_dependency "rails", ">= 6.0"
+
   s.add_dependency "colorize", ">= 0.7.7"
+  s.add_dependency "enumerize", ">= 1.0"
   s.add_dependency "silencer", "1.0.0.rc3"
 
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "factory_bot_rails"
   s.add_development_dependency "pry"
+  s.add_development_dependency "rspec_junit_formatter"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rubocop", "~> 1.9"
+  s.add_development_dependency "rubocop-rails"
   s.add_development_dependency "sqlite3"
-  s.add_development_dependency "rspec-rails", "~> 3.4.0"
-  s.add_development_dependency "factory_girl_rails", "~> 4.6.0"
-  s.add_development_dependency "coveralls"
 end

data/lib/generators/job_notifier/install/templates/initializer.rb

@@ -2,4 +2,8 @@ JobNotifier.setup do |config|
   # If you're using an app client that is not part of rails project where Job Notifier gem was
   #  installed, you can define a custom root_url. For example: "http://app.platan.us/"
   # config.root_url = "/"
+
+  # This gem uses the polling technique to inform what's happening with your jobs. This generates
+  #  a noisy log output. If you want to silence this output
+  # config.silenced_log = false
 end

data/lib/job_notifier.rb

@@ -6,13 +6,18 @@ require "silencer"
 module JobNotifier
   extend self
 
-  attr_writer :root_url
+  attr_writer :root_url, :silenced_log
 
   def root_url
     return "/" unless @root_url
     @root_url
   end
 
+  def silenced_log
+    return false unless @silenced_log
+    @silenced_log
+  end
+
   def setup
     yield self
     require "job_notifier"

data/lib/job_notifier/engine.rb

@@ -4,7 +4,7 @@ module JobNotifier
 
     config.generators do |g|
       g.test_framework :rspec, fixture: false
-      g.fixture_replacement :factory_girl, dir: "spec/factories"
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
     end
 
     config.serve_static_files = true
@@ -20,9 +20,15 @@ module JobNotifier
         helper(JobNotifier::ApplicationHelper)
       end
 
-      Rails.application.middleware.swap(
-        Rails::Rack::Logger, Silencer::Logger, silence: [%r{\/job_notifier\/\w+\/jobs\/\w+.json}])
-      Rails.application.middleware.insert_before(Silencer::Logger, JobNotifier::Logger)
+      if JobNotifier.silenced_log
+        Rails.application.middleware.swap(
+          Rails::Rack::Logger,
+          Silencer::Logger,
+          silence: [%r{\/job_notifier\/\w+\/jobs\/\w+.json}]
+        )
+
+        Rails.application.middleware.insert_before(Silencer::Logger, JobNotifier::Logger)
+      end
     end
   end
 end

data/lib/job_notifier/error.rb

@@ -1,31 +1,31 @@
 module JobNotifier
   module Error
-    class InvalidIdentifier < Exception
+    class InvalidIdentifier < RuntimeError
       def initialize
         super("you need to pass a non blank identifier")
       end
     end
 
-    class MissingAttributes < Exception
+    class MissingAttributes < RuntimeError
       def initialize
         super("you need to execute identify_job_through method on host model")
       end
     end
 
-    class BlankAttribute < Exception
+    class BlankAttribute < RuntimeError
       def initialize(attribute)
         super("#{attribute} cant be blank")
       end
     end
 
-    class InvalidAdapter < Exception
+    class InvalidAdapter < RuntimeError
       def initialize
         file_names = JobNotifier::Adapters.names.join(", ")
         super("The adapter must be one of: #{file_names}")
       end
     end
 
-    class Validation < Exception
+    class Validation < RuntimeError
       attr_reader :error
 
       def initialize(error)

data/lib/job_notifier/logger.rb

@@ -18,6 +18,7 @@ module JobNotifier
       response.each do |resp|
         next if resp.blank?
         result = JSON.parse(resp)
+        result = result["jobs"] if result.is_a?(Hash)
         next if result.blank?
         puts build_log_msg(result)
       end

data/lib/job_notifier/notifier.rb

@@ -6,11 +6,11 @@ module JobNotifier
       def perform(*args)
         result = perform_with_feedback(*args)
         save_success_feedback(result)
-      rescue JobNotifier::Error::Validation => ex
-        save_error_feedback(ex.error)
-      rescue StandardError => ex
+      rescue JobNotifier::Error::Validation => e
+        save_error_feedback(e.error)
+      rescue StandardError => e
         save_error_feedback("unknown")
-        raise ex
+        raise e
       end
 
       def save_error_feedback(error)
@@ -27,7 +27,7 @@ module JobNotifier
           raise JobNotifier::Error::InvalidIdentifier.new if identifier.blank?
 
           JobNotifier::Job.create!(
-            identifier: identifier,
+            identifier: (identifier.to_sym == :without_owner ? nil : identifier),
             job_id: job.job_id,
             job_class: self.class.name
           )
@@ -37,4 +37,4 @@ module JobNotifier
   end
 end
 
-ActiveJob::Base.send(:include, JobNotifier::Notifier)
+ActiveJob::Base.include(JobNotifier::Notifier)

data/lib/job_notifier/version.rb

@@ -1,3 +1,3 @@
 module JobNotifier
-  VERSION = "1.2.3"
+  VERSION = "2.0.0"
 end

data/spec/dummy/Rakefile

@@ -1,6 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require_relative "config/application"
 
 Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link job_notifier_manifest.js

data/spec/dummy/app/assets/stylesheets/application.css

@@ -6,9 +6,9 @@
  * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
  * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
  *
  *= require_tree .
  *= require_self

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,5 +1,2 @@
 class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
-  protect_from_forgery with: :exception
 end

data/spec/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -1,14 +1,15 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
-  <%= csrf_meta_tags %>
-</head>
-<body <%= job_identifier_for(@current_user) %>>
+  <head>
+    <title>Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
 
-<%= yield %>
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+  </head>
 
-</body>
+  <body>
+    <%= yield %>
+  </body>
 </html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application', __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
+require_relative "../config/boot"
+require "rake"
 Rake.application.run

data/spec/dummy/bin/setup

@@ -1,29 +1,33 @@
 #!/usr/bin/env ruby
-require 'pathname'
+require "fileutils"
 
 # path to your application root.
-APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+APP_ROOT = File.expand_path('..', __dir__)
 
-Dir.chdir APP_ROOT do
-  # This script is a starting point to setup your application.
-  # Add necessary setup steps to this file:
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
 
-  puts "== Installing dependencies =="
-  system "gem install bundler --conservative"
-  system "bundle check || bundle install"
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
 
   # puts "\n== Copying sample files =="
-  # unless File.exist?("config/database.yml")
-  #   system "cp config/database.yml.sample config/database.yml"
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
   # end
 
   puts "\n== Preparing database =="
-  system "bin/rake db:setup"
+  system! 'bin/rails db:prepare'
 
   puts "\n== Removing old logs and tempfiles =="
-  system "rm -f log/*"
-  system "rm -rf tmp/cache"
+  system! 'bin/rails log:clear tmp:clear'
 
   puts "\n== Restarting application server =="
-  system "touch tmp/restart.txt"
+  system! 'bin/rails restart'
 end

data/spec/dummy/config.ru

@@ -1,4 +1,6 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment', __FILE__)
+require_relative "config/environment"
+
 run Rails.application
+Rails.application.load_server

data/spec/dummy/config/application.rb

@@ -1,31 +1,22 @@
-require File.expand_path('../boot', __FILE__)
+require_relative "boot"
 
-# Pick the frameworks you want:
-require "active_record/railtie"
-require "action_controller/railtie"
-require "action_mailer/railtie"
-require "action_view/railtie"
-require "sprockets/railtie"
-# require "rails/test_unit/railtie"
+require "rails/all"
 
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
 require "job_notifier"
 
 module Dummy
   class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
+    config.load_defaults Rails::VERSION::STRING.to_f
 
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
   end
 end