jobler 0.0.10 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 449bec194fa9aa9bc0a4e57ab17a5998b479c4b4
-  data.tar.gz: d97d7f6c3a7800265a5907508c29cb83275b2be4
+SHA256:
+  metadata.gz: 5cedd67bb154c2d2c93da4f460ea0d9eaa106d8017448a2b8c11476fc94fc618
+  data.tar.gz: 8c3aa61ccc372188fbdbd16395488a8e1f94a891c8ebd120fdf31efd1e1c5ed8
 SHA512:
-  metadata.gz: 3309a15edb45be132a8a171ca226bf5599df4b81559c860906f33662a2f1a3211c9a695d6b37fd133ee33106f3bad315f048e583df1884f4e6302c5e9a064720
-  data.tar.gz: 67f27819835fe30014672e4c72543e49d9e47f113cfe10f596607cbd8357e28bd4d214a7b2d643ff158f86a1a7ac7c10c1fc14612119abb2327d2854065b7e99
+  metadata.gz: b8dc4e2afb5cc0d84d4c058990323b1409ed0d8797eedc8700a5fcb02aab2740e34b824b79744d9cb1ed433bb919b2db5ca37945bf94b60e442a83e4447ab1c0
+  data.tar.gz: 5e32f79d3b67c6405eff5f729799d80a4f45b2598d8ffba677b6935183674180a8e4721ad2efab829cbce7ff639824bce9567f5ea17107c82db750173a85c283

data/README.md

@@ -162,3 +162,4 @@ You can also specify a custom value if it isn't 1:
 ## 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/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

@@ -18,7 +18,12 @@ class Jobler::JobsController < Jobler::ApplicationController
         @job.jobler.format = format
 
         @result = @job.jobler.result
-        format.html { redirect_to @result.url } if @result.is_a?(Jobler::RedirectTo)
+
+        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

@@ -45,11 +45,11 @@ private
   end
 
   def model
-    @_model ||= model_class.find(args.fetch(:model_id))
+    @model ||= model_class.find(args.fetch(:model_id))
   end
 
   def relationships
-    @_relationships ||= proc do
+    @relationships ||= begin
       result = []
 
       model_class.reflections.each_value do |reflection|
@@ -60,6 +60,6 @@ private
       end
 
       result
-    end.call
+    end
   end
 end

data/app/models/jobler/job.rb

@@ -6,7 +6,7 @@ class Jobler::Job < ActiveRecord::Base # rubocop:disable Rails/ApplicationRecord
   before_validation :set_slug
 
   def jobler
-    @_jobler ||= jobler_type.constantize.new(args: YAML.load(parameters), job: self) # rubocop:disable Security/YAMLLoad
+    @jobler ||= jobler_type.constantize.new(args: YAML.load(parameters), job: self) # rubocop:disable Security/YAMLLoad
   end
 
   def completed?
@@ -19,6 +19,7 @@ class Jobler::Job < ActiveRecord::Base # rubocop:disable Rails/ApplicationRecord
 
   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 # 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/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

@@ -2,24 +2,55 @@ class Jobler::BaseJobler
   attr_accessor :controller, :format
   attr_reader :args, :job
 
-  def initialize(args = {})
-    @args = args[:args]
-    @job = args[:job]
+  def self.before_jobling(&blk)
+    @@before_jobling ||= [] # rubocop:disable Style/ClassVars
+    @@before_jobling << blk
   end
 
-  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.after_jobling(&blk)
+    @@after_jobling ||= [] # rubocop:disable Style/ClassVars
+    @@after_jobling << blk
+  end
+
+  def initialize(args:, job:)
+    @args = args
+    @job = job
+
+    @@before_jobling ||= [] # rubocop:disable Style/ClassVars:
+    @@after_jobling ||= [] # rubocop:disable Style/ClassVars:
+  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!
@@ -52,7 +83,7 @@ class Jobler::BaseJobler
     end
 
     if update
-      job.update_attributes!(progress: new_progress)
+      job.update!(progress: new_progress)
       @_current_progress = new_progress
     end
   end
@@ -74,7 +105,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_to_string(template_path, layout: false, locals: {jobler: self}.merge(locals))
 
     if render_result.is_a?(String)
       # Rails 5 behaviour
@@ -89,10 +120,9 @@ 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
-
-    raise "No result by that name: #{args.fetch(:name)}" unless job_result
+  def temp_file_for_result(name:)
+    job_result = job.results.where(name: name).first
+    raise "No result by that name: #{name}" unless job_result
 
     temp_file = ::Tempfile.new("jobler_tempfile")
     temp_file.binmode
@@ -100,4 +130,26 @@ class Jobler::BaseJobler
     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.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

@@ -3,16 +3,22 @@ class Jobler::JobRunner < ActiveJob::Base # rubocop:disable Rails/ApplicationJob
 
   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,
@@ -24,11 +30,9 @@ class Jobler::JobRunner < ActiveJob::Base # rubocop:disable Rails/ApplicationJob
 
 private
 
-  def with_locale
+  def with_locale(&blk)
     if @job.locale?
-      I18n.with_locale(@job.locale) do
-        yield
-      end
+      I18n.with_locale(@job.locale, &blk)
     else
       yield
     end

data/lib/jobler/message.rb

@@ -0,0 +1,7 @@
+class Jobler::Message
+  attr_reader :message
+
+  def initialize(message:)
+    @message = message
+  end
+end

data/lib/jobler/version.rb

@@ -1,3 +1,3 @@
 module Jobler
-  VERSION = "0.0.10".freeze
+  VERSION = "0.0.14".freeze
 end

data/lib/jobler.rb

@@ -6,6 +6,7 @@ module Jobler
   autoload :FileDownload, "#{path}/file_download"
   autoload :JobScheduler, "#{path}/job_scheduler"
   autoload :JobRunner, "#{path}/job_runner"
+  autoload :Message, "#{path}/message"
   autoload :PageRender, "#{path}/page_render"
   autoload :RedirectTo, "#{path}/redirect_to"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jobler
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.14
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2021-10-04 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
@@ -62,6 +62,7 @@ files:
 - lib/jobler/file_download.rb
 - lib/jobler/job_runner.rb
 - lib/jobler/job_scheduler.rb
+- lib/jobler/message.rb
 - lib/jobler/page_render.rb
 - lib/jobler/redirect_to.rb
 - lib/jobler/version.rb
@@ -78,15 +79,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Generate pages or files in the background