active_batch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb25cd2885f557fea859f6e816317e78312656a6
+  data.tar.gz: 7aacc6c82c3dac0e0607f0e77fc8e9543980bea4
+SHA512:
+  metadata.gz: c7795566421a69f86f759c1c0ee6067f3d8e1aa929c19e702f8d57ce0c275941eb96a41b80149490ca4fe8f35aba62b6c16d0f253e381859f8f456ddce261881
+  data.tar.gz: e2a3fa90cf85b1f3c8fd499b4ee9612a414db4c457568301cea420011d8c7473a8d3878537d45e7f57a46d952b83b0ad67232591fe636367e47bd37ac3fa252d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 adrien
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= ActiveBatch
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveBatch'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

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

@@ -0,0 +1,13 @@
+// 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.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/active_batch/batches.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/active_batch/jobs.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/active_batch/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * 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.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/active_batch/batches.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/active_batch/jobs.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/active_batch/application_controller.rb

@@ -0,0 +1,4 @@
+module ActiveBatch
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/active_batch/batches_controller.rb

@@ -0,0 +1,49 @@
+require_dependency "active_batch/application_controller"
+
+module ActiveBatch
+  class BatchesController < ApplicationController
+    before_action :set_batch, only: [:show, :destroy]
+
+    # GET /batches
+    def index
+      @batches = Batch.all
+    end
+
+    # GET /batches/1
+    def show
+    end
+
+    # GET /batches/new
+    def new
+      @batch = Batch.new
+    end
+
+    # POST /batches
+    def create
+      @batch = Batch.new(batch_params)
+
+      if @batch.save
+        redirect_to @batch, notice: 'Batch was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    # DELETE /batches/1
+    def destroy
+      @batch.destroy
+      redirect_to batches_url, notice: 'Batch was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_batch
+        @batch = Batch.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def batch_params
+        params.require(:batch).permit(:job_class, :timestamps)
+      end
+  end
+end

data/app/controllers/active_batch/work_units_controller.rb

@@ -0,0 +1,29 @@
+require_dependency "active_batch/application_controller"
+
+module ActiveBatch
+  class WorkUnitsController < ApplicationController
+    before_action :set_work_unit, only: [:show, :destroy]
+
+    # GET /jobs
+    def index
+      @work_units = WorkUnit.all
+    end
+
+    # GET /jobs/1
+    def show
+    end
+
+    # DELETE /jobs/1
+    def destroy
+      @work_unit.destroy
+      redirect_to work_units_url, notice: 'Job was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_work_unit
+        @work_unit = WorkUnit.find(params[:id])
+      end
+
+  end
+end

data/app/helpers/active_batch/application_helper.rb

@@ -0,0 +1,4 @@
+module ActiveBatch
+  module ApplicationHelper
+  end
+end

data/app/helpers/active_batch/batches_helper.rb

@@ -0,0 +1,4 @@
+module ActiveBatch
+  module BatchesHelper
+  end
+end

data/app/helpers/active_batch/jobs_helper.rb

@@ -0,0 +1,4 @@
+module ActiveBatch
+  module JobsHelper
+  end
+end

data/app/jobs/active_batch/batch_scheduler_job.rb

@@ -0,0 +1,16 @@
+module ActiveBatch
+  class BatchSchedulerJob < ActiveJob::Base
+
+    queue_as ActiveBatch.batch_scheduling_queue || :default
+
+    def perform(job_class, *args)
+      batch = Batch.create(job_class: job_class, job_id: job_id, arguments: args)
+      batch.job.each_work_unit(*args) do |*work_unit_args|
+        work_unit_job = batch.job.perform_later(*work_unit_args)
+        batch.work_units.create(job_id: work_unit_job.job_id)
+      end
+      BatchStatusCheckJob.perform_later(batch)
+      self
+    end
+  end
+end

data/app/jobs/active_batch/batch_status_check_job.rb

@@ -0,0 +1,17 @@
+module ActiveBatch
+  class BatchStatusCheckJob < ActiveJob::Base
+
+    queue_as do
+      batch = arguments.first
+      batch.job.new.queue_name
+    end
+
+    def perform(batch)
+      if batch.work_units.not_done.exists?
+        self.class.set(wait: 1.minute).perform_later(batch)
+      else
+        batch.perform_after_batch
+      end
+    end
+  end
+end

data/app/models/active_batch/batch.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module ActiveBatch
+  class Batch < ActiveRecord::Base
+    include ActiveJob::Arguments
+
+    has_many :work_units, foreign_key: 'active_batch_batches_id'
+
+    enum status: %i(open closed)
+
+    def perform_after_batch
+      job.after_batch(*arguments, work_units.map(&:work_result))
+      update!(status: :closed)
+    end
+
+    def arguments=(arguments)
+      write_attribute(:arguments, serialize(arguments).to_json)
+    end
+
+    def arguments
+      deserialize(JSON.parse(read_attribute(:arguments)))
+    end
+
+    def job
+      @job ||= job_class.constantize
+    end
+  end
+end

data/app/models/active_batch/work_unit.rb

@@ -0,0 +1,17 @@
+module ActiveBatch
+  class WorkUnit < ActiveRecord::Base
+
+    enum status: [:enqueued, :running, :done, :failed]
+
+    scope :not_done, -> { where.not(status: statuses[:done])}
+
+    belongs_to :batch, foreign_key: 'active_batch_batches_id'
+
+    def error(exception)
+      self.update!(
+          status: :failed,
+          work_result: "#{exception.message}\n#{exception.backtrace.join("\n")}"
+      )
+    end
+  end
+end

data/app/views/active_batch/batches/_form.html.erb

@@ -0,0 +1,21 @@
+<%= form_for(@batch) do |f| %>
+  <% if @batch.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@batch.errors.count, "error") %> prohibited this batch from being saved:</h2>
+
+      <ul>
+      <% @batch.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :job_class %><br>
+    <%= f.text_field :job_class %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/active_batch/batches/index.html.erb

@@ -0,0 +1,30 @@
+<p id="notice"><%= notice %></p>
+
+<h1>Listing Batches</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Job class</th>
+      <th>Created at</th>
+      <th>Status</th>
+      <th colspan="2"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @batches.each do |batch| %>
+      <tr>
+        <td><%= batch.job_class %></td>
+        <td><%= batch.created_at %></td>
+        <td><%= batch.status %></td>
+        <td><%= link_to 'Show', batch %></td>
+        <td><%= link_to 'Destroy', batch, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Batch', new_batch_path %>

data/app/views/active_batch/batches/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New Batch</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', batches_path %>

data/app/views/active_batch/batches/show.html.erb

@@ -0,0 +1,31 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Job class:</strong>
+  <%= @batch.job_class %>
+</p>
+
+<p>
+  <strong>Status</strong>
+  <%= @batch.status %>
+</p>
+
+<table>
+  <thead>
+    <tr>
+      <th>job_id</th>
+      <th>status</th>
+      <th>result</th>
+    </tr>
+  </thead>
+  <tbody>
+<% @batch.work_units.each do |work_unit| %>
+    <tr>
+      <td><%= work_unit.job_id %></td>
+      <td><%= work_unit.status %></td>
+      <td><%= work_unit.work_result %></td>
+    </tr>
+<% end %>
+  </tbody>
+</table>
+<%= link_to 'Back', batches_path %>