jobler 0.0.8 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a515f6a2b9fd3b0fbf184f612d2665c2b8934bda
-  data.tar.gz: f0384836dcf388c9d5f5bfdc60d4e524a9539792
+SHA256:
+  metadata.gz: 549a9f294ff023f7c67091e91120706db134cd9639d9f8b2d60d9860c5562788
+  data.tar.gz: '097746283982a71eeffdd1a006e2e8a6d178c5b847e6854ddae0696075da4490'
 SHA512:
-  metadata.gz: 6a7e9bd7fba0d0a0bd14d82d3075cf120a69dfe51f6986855ee4b2bfee08a6f0ba5f6add226ea0f3b47ab6d1f9cdcbc33790f907709c267f214ccb36ff8ce136
-  data.tar.gz: 501a4c6a6a5455d4e54afac0a14e891dc098bb2747882ee5c462dd9001bd4218665b1533874b4db7605603a1b34fb725348f992bbc3a89f20fb686d786f3f348
+  metadata.gz: 3204ebaef1538454ea89a42066fc498d554317f14a9dd72e03356c1c1cb58ef5aac58909246c750b17c785b4610b33cef3a7b19ab93cc3877297ae0b659025e6
+  data.tar.gz: e7ffb22951a39418e2ffd48c7f58b69b7465dbf41419583c5b49ed8ae71fbcbd15ca5dd7f58491df70ec7769c2e1dadb2416bb7ceac974910d50ef8af7617a23

data/README.md

@@ -34,7 +34,11 @@ class ApplicationJobler < Jobler::BaseJobler
 end
 ```
 
-Jobler is going to queue its jobs through the ActiveJob queue called `:jobler`, so make sure a worker is listening to that queue.
+Jobler is going to queue its jobs through the ActiveJob queue called `:jobler`, so make sure a worker is listening to that queue. This is done like this in Sidekiq:
+
+```bash
+bundle exec sidekiq --queue default --queue jobler --queue mailers
+```
 
 
 ## Usage
@@ -111,7 +115,7 @@ You should then create a controller something like this:
 ```ruby
 class JoblerJobsController < ApplicationController
   def show
-    @job = Jobler::Job.find_by!(slug: param[:id])
+    @job = Jobler::Job.find_by!(slug: params[:id])
     @result = @job.results.find_by!(name: "render")
   end
 end
@@ -119,7 +123,7 @@ end
 
 And a view in "app/views/jobler_jobs/show.html.erb":
 ```erb
-<%= @result.result.force_encoding("utf-8").html_safe
+<%= @result.result.force_encoding("utf-8").html_safe %>
 ```
 
 You should also add a route like this:
@@ -129,6 +133,33 @@ Rails.application.routes.draw do
 end
 ```
 
+# Progress bar
+
+In order to utilize the progress bar and return some feedback on the progress to the user, you can implement a couple of calls to do that:
+
+```ruby
+class MyJobler < ApplicationJobler
+  def execute!
+    progress_total collection.size
+    
+    collection.find_each do |model|
+      increment_progress!
+    end
+  end
+end
+```
+
+You can also call it from a view, if you a doing a render like this:
+```erb
+<% jobler.increment_progress! %>
+```
+
+You can also specify a custom value if it isn't 1:
+```erb
+<% jobler.increment_progress!(value: 5.0) %>
+```
+
 ## License
 
 This project rocks and uses MIT-LICENSE.
+

data/Rakefile

@@ -14,7 +14,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 
 load "rails/tasks/statistics.rake"

data/app/assets/javascripts/jobler/application.js

@@ -1,3 +1,2 @@
-//= require jquery
 //= require jobler/timeago
 //= require jobler/jobs

data/app/controllers/jobler/downloads_controller.rb

@@ -4,7 +4,11 @@ class Jobler::DownloadsController < Jobler::ApplicationController
     @result = @job.jobler.result
 
     if @result.is_a?(Jobler::FileDownload)
-      send_file @result.temp_file.path, disposition: "attachment", filename: @result.file_name
+      if @result.url.present?
+        redirect_to @result.url
+      else
+        send_file @result.temp_file.path, disposition: "attachment", filename: @result.file_name
+      end
     else
       flash[:error] = "The result wasn't a file download"
       redirect_to :back

data/app/controllers/jobler/jobs_controller.rb

@@ -1,7 +1,6 @@
 class Jobler::JobsController < Jobler::ApplicationController
   def show
     @job = Jobler::Job.find_by!(slug: params[:id])
-    @result = @job.jobler.result if @job.completed?
 
     respond_to do |format|
       format.json do
@@ -14,8 +13,17 @@ class Jobler::JobsController < Jobler::ApplicationController
         }
       end
 
-      if @result.is_a?(Jobler::RedirectTo)
-        format.html { redirect_to @result.url }
+      if @job.completed?
+        @job.jobler.controller = self
+        @job.jobler.format = format
+
+        @result = @job.jobler.result
+
+        if @result.is_a?(Jobler::RedirectTo)
+          format.html { redirect_to @result.url }
+        else
+          format.html
+        end
       else
         format.html
       end

data/app/joblers/jobler/models/destroyer_jobler.rb

@@ -0,0 +1,65 @@
+class Jobler::Models::DestroyerJobler < Jobler::BaseJobler
+  def execute!
+    calculate_numbers
+
+    model_class.transaction do
+      destroy_relationships
+      model.destroy!
+    end
+  end
+
+  def result
+    format.html { controller.redirect_to args.fetch(:redirect_to) }
+  end
+
+private
+
+  def calculate_numbers
+    Rails.logger.debug "Calculate numbers"
+
+    @total = 0
+    relationships.each do |relationship|
+      Rails.logger.debug "Calculate size for #{relationship}"
+      @total += model.__send__(relationship).size
+    end
+
+    progress_total @total
+
+    Rails.logger.debug "Done calculating numbers: #{@total}"
+  end
+
+  def destroy_relationships
+    Rails.logger.debug "Destroying relationships"
+    relationships.each do |relationship|
+      Rails.logger.debug "Destroying #{relationship}"
+      model.__send__(relationship).find_each do |sub_model|
+        Rails.logger.debug "Destroying #{sub_model.id}"
+        sub_model.destroy!
+        increment_progress!
+      end
+    end
+  end
+
+  def model_class
+    @model_class ||= args.fetch(:model).constantize
+  end
+
+  def model
+    @model ||= model_class.find(args.fetch(:model_id))
+  end
+
+  def relationships
+    @relationships ||= begin
+      result = []
+
+      model_class.reflections.each_value do |reflection|
+        next unless reflection.is_a?(ActiveRecord::Reflection::HasManyReflection)
+        next unless reflection.options[:dependent] == :destroy
+
+        result << reflection.name
+      end
+
+      result
+    end
+  end
+end

data/app/models/jobler/job.rb

@@ -1,15 +1,12 @@
-class Jobler::Job < ActiveRecord::Base
-  has_many :results, class_name: "Jobler::Result", dependent: :destroy
+class Jobler::Job < ActiveRecord::Base # rubocop:disable Rails/ApplicationRecord
+  has_many :results, class_name: "Jobler::Result", dependent: :destroy, inverse_of: :job
 
   validates :jobler_type, :slug, :state, presence: true
 
   before_validation :set_slug
 
   def jobler
-    user_jobler = jobler_type.constantize.new
-    user_jobler.instance_variable_set(:@args, YAML.load(parameters)) # rubocop:disable Security/YAMLLoad
-    user_jobler.instance_variable_set(:@job, self)
-    user_jobler
+    @jobler ||= jobler_type.constantize.new(args: YAML.load(parameters), job: self) # rubocop:disable Security/YAMLLoad
   end
 
   def completed?
@@ -22,6 +19,7 @@ class Jobler::Job < ActiveRecord::Base
 
   def to_param
     raise "No slug" unless slug?
+
     slug
   end
 

data/app/models/jobler/result.rb

@@ -1,5 +1,7 @@
-class Jobler::Result < ActiveRecord::Base
-  belongs_to :job, class_name: "Jobler::Job"
+class Jobler::Result < ActiveRecord::Base # rubocop:disable Rails/ApplicationRecord
+  belongs_to :job, class_name: "Jobler::Job", inverse_of: :results
+
+  has_one_attached :file
 
   validates :job, :name, presence: true
 end

data/app/views/jobler/jobs/show.html.erb

@@ -4,7 +4,11 @@
 
 <% if @job.completed? %>
   <% if @result.is_a?(Jobler::FileDownload) %>
-    <%= link_to "Download", download_path(@job) %>
+    <% if @result.url.present? %>
+      <%= link_to "Download", @result.url %>
+    <% else %>
+      <%= link_to "Download", download_path(@job) %>
+    <% end %>
   <% elsif @result.is_a?(Jobler::PageRender) %>
     <%= @result.body.html_safe %>
   <% end %>

data/app/views/layouts/jobler/application.html.erb

@@ -3,13 +3,15 @@
 <head>
   <title>Jobler</title>
 
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />
   <%= stylesheet_link_tag "jobler/application", media: "all" %>
-  <%= stylesheet_link_tag "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css", integrity: "sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u", crossorigin: "anonymous" %>
 
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js" integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4=" crossorigin="anonymous"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-ujs/1.2.2/rails.min.js" integrity="sha256-BbyWhCn0G+F6xbWJ2pcI5LnnpsnpSzyjJNVtl7ABp+M=" crossorigin="anonymous"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-timeago/1.6.0/jquery.timeago.min.js" integrity="sha256-JAdlnMiYFZRwqQqgiYwLjSkV94QtVzcbvasQMm05THk=" crossorigin="anonymous"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
   <%= javascript_include_tag "jobler/application" %>
-  <%= javascript_include_tag "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js", integrity: "sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa", crossorigin: "anonymous" %>
-  <%= javascript_include_tag "https://use.fontawesome.com/de02b76735.js" %>
-  <%= javascript_include_tag "https://cdnjs.cloudflare.com/ajax/libs/jquery-timeago/1.5.4/jquery.timeago.min.js" %>
 
   <%= csrf_meta_tags %>
 </head>

data/db/migrate/20170130220604_create_jobs.rb

@@ -1,4 +1,4 @@
-class CreateJobs < ActiveRecord::Migration
+class CreateJobs < ActiveRecord::Migration[5.1]
   def change
     create_table :jobler_jobs do |t|
       t.string :jobler_type, null: false

data/db/migrate/20170130220734_create_jobler_results.rb

@@ -1,4 +1,4 @@
-class CreateJoblerResults < ActiveRecord::Migration
+class CreateJoblerResults < ActiveRecord::Migration[5.1]
   def change
     create_table :jobler_results do |t|
       t.belongs_to :job, index: true, null: false

data/db/migrate/20170203161045_add_locale_to_jobs.rb

@@ -1,4 +1,4 @@
-class AddLocaleToJobs < ActiveRecord::Migration
+class AddLocaleToJobs < ActiveRecord::Migration[5.1]
   def change
     add_column :jobler_jobs, :locale, :string
   end

data/db/migrate/20170206100737_add_error_message_and_error_backtrace_to_jobs.rb

@@ -1,4 +1,4 @@
-class AddErrorMessageAndErrorBacktraceToJobs < ActiveRecord::Migration
+class AddErrorMessageAndErrorBacktraceToJobs < ActiveRecord::Migration[5.1]
   def change
     add_column :jobler_jobs, :error_message, :text
     add_column :jobler_jobs, :error_type, :string

data/db/migrate/20170206104246_add_slug_to_jobs.rb

@@ -1,4 +1,4 @@
-class AddSlugToJobs < ActiveRecord::Migration
+class AddSlugToJobs < ActiveRecord::Migration[5.1]
   def change
     add_column :jobler_jobs, :slug, :string
     add_index :jobler_jobs, :slug, unique: true

data/db/migrate/20170217082955_add_host_protocol_and_port_to_jobler_jobs.rb

@@ -1,4 +1,4 @@
-class AddHostProtocolAndPortToJoblerJobs < ActiveRecord::Migration
+class AddHostProtocolAndPortToJoblerJobs < ActiveRecord::Migration[5.1]
   def change
     add_column :jobler_jobs, :host, :string
     add_column :jobler_jobs, :protocol, :string

data/lib/jobler/base_controller.rb

@@ -1,2 +1,2 @@
-class Jobler::BaseController < ActionController::Base
+class Jobler::BaseController < ActionController::Base # rubocop:disable Rails/ApplicationController
 end

data/lib/jobler/base_jobler.rb

@@ -1,19 +1,53 @@
 class Jobler::BaseJobler
+  attr_accessor :controller, :format
   attr_reader :args, :job
 
-  def create_result!(args)
-    if args[:temp_file]
-      temp_file = args.fetch(:temp_file)
-      temp_file.close unless temp_file.closed?
-      content = File.read(temp_file.path)
+  def self.before_jobling(&blk)
+    @@before_jobling ||= [] # rubocop:disable Style/ClassVars
+    @@before_jobling << blk
+  end
+
+  def self.after_jobling(&blk)
+    @@after_jobling ||= [] # rubocop:disable Style/ClassVars
+    @@after_jobling << blk
+  end
+
+  def initialize(args:, job:)
+    @args = args
+    @job = job
+  end
+
+  def call_before_callbacks
+    @@before_jobling&.each do |before_callback|
+      instance_eval(&before_callback)
+    end
+  end
+
+  def call_after_callbacks
+    @@after_jobling&.each do |after_callback|
+      instance_eval(&after_callback)
+    end
+  end
+
+  def create_result!(content: nil, name:, result: nil, temp_file: nil, save_in_database: false)
+    jobler_result = job.results.new(name: name)
+
+    if content && !temp_file
+      temp_file = Tempfile.new(name)
+      temp_file.write(content)
+      temp_file.close
+    end
+
+    if result
+      jobler_result.result = result
     else
-      content = args.fetch(:content)
+      raise "No tempfile could be found" unless temp_file
+
+      handle_file(jobler_result: jobler_result, save_in_database: save_in_database, temp_file: temp_file)
     end
 
-    job.results.create!(
-      name: args.fetch(:name),
-      result: content
-    )
+    jobler_result.save!
+    jobler_result
   end
 
   def execute!
@@ -46,7 +80,7 @@ class Jobler::BaseJobler
     end
 
     if update
-      job.update_attributes!(progress: new_progress)
+      job.update!(progress: new_progress)
       @_current_progress = new_progress
     end
   end
@@ -56,9 +90,7 @@ class Jobler::BaseJobler
   end
 
   def render(template_path, locals = {})
-    if template_path.is_a?(Symbol)
-      template_path = "joblers/#{jobler_name}/#{template_path}"
-    end
+    template_path = "joblers/#{jobler_name}/#{template_path}" if template_path.is_a?(Symbol)
 
     request = ActionDispatch::Request.new(
       "HTTP_HOST" => "#{job.host}:#{job.port}",
@@ -70,7 +102,7 @@ class Jobler::BaseJobler
     controller.request = request
     controller.response = ActionDispatch::Response.new
 
-    render_result = controller.render(template_path, formats: Mime::EXTENSION_LOOKUP.keys, layout: false, locals: {jobler: self}.merge(locals))
+    render_result = controller.render(template_path, layout: false, locals: {jobler: self}.merge(locals))
 
     if render_result.is_a?(String)
       # Rails 5 behaviour
@@ -85,15 +117,37 @@ class Jobler::BaseJobler
     raise NoMethodError, "You should define the 'result' method on #{self.class.name}"
   end
 
-  def temp_file_for_result(args)
-    job_result = job.results.where(name: args.fetch(:name)).first
+  def temp_file_for_result(name:)
+    job_result = job.results.where(name: name).first
+    raise "No result by that name: #{name}" unless job_result
 
-    raise "No result by that name: #{args.fetch(:name)}" unless job_result
-
-    temp_file = Tempfile.new
+    temp_file = ::Tempfile.new("jobler_tempfile")
     temp_file.binmode
     temp_file.write(job_result.result)
     temp_file.close
     temp_file
   end
+
+  def url_for_result(name:)
+    job_result = job.results.where(name: name).first
+    raise "No result by that name: #{name}" unless job_result
+
+    Rails.application.routes.url_helpers.rails_blob_path(job_result.file.attachment, only_path: true)
+  end
+
+private
+
+  def handle_file(jobler_result:, save_in_database:, temp_file:)
+    if save_in_database
+      temp_file = temp_file
+      temp_file.close unless temp_file.closed?
+      content = File.read(temp_file.path)
+      jobler_result.result = content
+    else
+      jobler_result.file.attach(
+        filename: File.basename(temp_file.path),
+        io: File.open(temp_file.path)
+      )
+    end
+  end
 end

data/lib/jobler/file_download.rb

@@ -1,8 +1,12 @@
 class Jobler::FileDownload
-  attr_reader :file_name, :temp_file
+  attr_reader :file_name, :temp_file, :url
 
-  def initialize(args)
-    @file_name = args.fetch(:file_name)
-    @temp_file = args.fetch(:temp_file)
+  def initialize(file_name: nil, temp_file: nil, url: nil)
+    raise "Temp file or URL should be given" if !temp_file && !url
+    raise "No filename given with temp-file" if temp_file && file_name.blank?
+
+    @file_name = file_name
+    @temp_file = temp_file
+    @url = url
   end
 end

data/lib/jobler/job_runner.rb

@@ -1,18 +1,24 @@
-class Jobler::JobRunner < ActiveJob::Base
+class Jobler::JobRunner < ActiveJob::Base # rubocop:disable Rails/ApplicationJob
   queue_as :jobler
 
   def perform(job_id)
     @job = Jobler::Job.find(job_id)
-    @job.update_attributes!(started_at: Time.zone.now, state: "started")
+    @job.update!(started_at: Time.zone.now, state: "started")
 
     begin
       with_locale do
-        @job.jobler.execute!
+        @job.jobler.call_before_callbacks
+
+        begin
+          @job.jobler.execute!
+        ensure
+          @job.jobler.call_after_callbacks
+        end
       end
 
-      @job.update_attributes!(ended_at: Time.zone.now, progress: 1.0, state: "completed")
+      @job.update!(ended_at: Time.zone.now, progress: 1.0, state: "completed")
     rescue Exception => e # rubocop:disable Lint/RescueException
-      @job.update_attributes!(
+      @job.update!(
         ended_at: Time.zone.now,
         error_message: e.message,
         error_type: e.class.name,

data/lib/jobler/version.rb

@@ -1,3 +1,3 @@
 module Jobler
-  VERSION = "0.0.8".freeze
+  VERSION = "0.0.13".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jobler
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.13
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 6.0.0
 description: Generate pages or files in the background
 email:
 - kaspernj@gmail.com
@@ -43,6 +43,7 @@ files:
 - app/controllers/jobler/downloads_controller.rb
 - app/controllers/jobler/jobs_controller.rb
 - app/helpers/jobler/application_helper.rb
+- app/joblers/jobler/models/destroyer_jobler.rb
 - app/models/jobler/job.rb
 - app/models/jobler/result.rb
 - app/views/jobler/jobs/show.html.erb
@@ -84,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Generate pages or files in the background