jobler 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8a34dc95e9f05a8e717f4e003238c90982cac21
-  data.tar.gz: 61c2b0d82a6d344784f06aee51f94eb3a46787f9
+  metadata.gz: 449bec194fa9aa9bc0a4e57ab17a5998b479c4b4
+  data.tar.gz: d97d7f6c3a7800265a5907508c29cb83275b2be4
 SHA512:
-  metadata.gz: d3a46fbed9c8c2593a48427e748760aeaa6ad6d8a9dd8c2ff9795ea271ef68f158dc4bd00ddb712c0c23bee2026116ee4ff802f93152a91e0f15f6e86c4bd13f
-  data.tar.gz: 2c54a5329bed09ada71f73e266929ea5881b89c4dfedaba04c9e927205c2d7a5ae6653eb732043c09aa480780e5c1c01ec720208933efbe647f6630a445aebcc
+  metadata.gz: 3309a15edb45be132a8a171ca226bf5599df4b81559c860906f33662a2f1a3211c9a695d6b37fd133ee33106f3bad315f048e583df1884f4e6302c5e9a064720
+  data.tar.gz: 67f27819835fe30014672e4c72543e49d9e47f113cfe10f596607cbd8357e28bd4d214a7b2d643ff158f86a1a7ac7c10c1fc14612119abb2327d2854065b7e99

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,32 @@ 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/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,12 @@ 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
+        format.html { redirect_to @result.url } if @result.is_a?(Jobler::RedirectTo)
       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 ||= proc do
+      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.call
+  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?

data/app/models/jobler/result.rb

@@ -1,5 +1,5 @@
-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
 
   validates :job, :name, presence: true
 end

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_jobler.rb

@@ -1,6 +1,12 @@
 class Jobler::BaseJobler
+  attr_accessor :controller, :format
   attr_reader :args, :job
 
+  def initialize(args = {})
+    @args = args[:args]
+    @job = args[:job]
+  end
+
   def create_result!(args)
     if args[:temp_file]
       temp_file = args.fetch(:temp_file)
@@ -56,9 +62,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}",
@@ -90,7 +94,7 @@ class Jobler::BaseJobler
 
     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

data/lib/jobler/job_runner.rb

@@ -1,4 +1,4 @@
-class Jobler::JobRunner < ActiveJob::Base
+class Jobler::JobRunner < ActiveJob::Base # rubocop:disable Rails/ApplicationJob
   queue_as :jobler
 
   def perform(job_id)

data/lib/jobler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jobler
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-16 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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
@@ -85,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Generate pages or files in the background