job_packs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49ee8035b04197374e7407ea9c184f09b4d2905b
+  data.tar.gz: 0aedd2c73edbce74782468aab8e7ffc45a3e3ac9
+SHA512:
+  metadata.gz: 4805578fe535dc63450a47db1e40f474044f1586e515a06ee2a0e54c807890159e7eb45ad6d55530f711452002351d37461e1d57db0726acf03dcadf8610555d
+  data.tar.gz: 191b55e6480e950dc405a0604a5f2276a1a9c305e3fff2537d7f4d11502cd428eed46858c70fa39a5a330842760b1bb79ab8ebb325984f22f7baece26892be11

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Eduardo Lagares
+
+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.md

@@ -0,0 +1,28 @@
+# JobPacks
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'job_packs'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install job_packs
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'JobPacks'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/job_packs/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+require 'generators/job_packs/migration'
+require 'generators/job_packs/migration_helper'
+
+module JobPacks
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      include JobPacks::Generators::MigrationHelper
+      extend JobPacks::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_migration
+        migration_template 'install.rb', 'db/migrate/install_job_packs.rb'
+      end
+    end
+  end
+end

data/lib/generators/job_packs/migration.rb

@@ -0,0 +1,14 @@
+module JobPacks
+  module Generators
+    module Migration
+      def next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ::ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime('%Y%m%d%H%M%S'), format('%.14d', next_migration_number)].max
+        else
+          format('%.3d', next_migration_number)
+        end
+      end
+    end
+  end
+end

data/lib/generators/job_packs/migration_helper.rb

@@ -0,0 +1,9 @@
+module JobPacks
+  module Generators
+    module MigrationHelper
+      def migration_parent
+        Rails::VERSION::MAJOR <= 4 ? 'ActiveRecord::Migration' : "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+      end
+    end
+  end
+end

data/lib/generators/job_packs/templates/install.rb

@@ -0,0 +1,27 @@
+class <%= migration_class_name %> < <%= migration_parent %>
+  def self.up
+    create_table :job_packs, force: true do |t|
+      t.column :description, :text
+      t.column :total_items_done, :integer
+      t.column :total_items_with_error, :integer, default: 0
+      t.column :total_items_waiting, :integer, default: 0
+      t.column :total_items_running, :integer, default: 0
+      t.column :done, :boolean, default: :false
+      t.timestamps
+    end
+
+    create_table :job_pack_items, force: true do |t|
+      t.references :job_pack
+      t.column :description, :text
+      t.column :job_id, :integer
+      t.column :job_type, :string
+      t.column :status, :integer
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :job_packs
+    drop_table :job_pack_items
+  end
+end

data/lib/job_packs/callbacks.rb

@@ -0,0 +1,43 @@
+module JobPacks
+  module Callbacks
+    def success(job)
+      find_job_pack_item(job)
+      @job_pack_item.status = JobPacks::JobPackItem::DONE
+      @job_pack_item.save!
+    end
+
+    def before(job)
+      find_job_pack_item(job)
+
+      @job_pack_item.status = JobPacks::JobPackItem::RUNNING
+      @job_pack_item.save!
+    end
+
+    def error(job, _exception)
+      find_job_pack_item(job)
+      @job_pack_item.status = JobPacks::JobPackItem::ERROR
+      @job_pack_item.save!
+    end
+
+    def failure(job)
+      find_job_pack_item(job)
+      @job_pack_item.status = JobPacks::JobPackItem::ERROR
+      @job_pack_item.save!
+    end
+
+    def after(job)
+        find_job_pack_item job
+        update_pack
+    end
+
+    private
+
+    def find_job_pack_item(job)
+      @job_pack_item ||= JobPacks::JobPackItem.where(job_id: job.id, job_type: job.class.to_s).first
+    end
+
+    def update_pack
+      @job_pack_item.job_pack.refresh_status
+    end
+  end
+end

data/lib/job_packs/job_pack.rb

@@ -0,0 +1,24 @@
+module JobPacks
+  class JobPack < ::ActiveRecord::Base
+    has_many :job_pack_items
+
+    def add_item(item)
+      job_pack_items << item
+    end
+
+    def refresh_status
+      job_pack_items.each(&:refresh_job_status)
+
+      self.total_items_done = job_pack_items.done.count
+      self.total_items_with_error = job_pack_items.error.count
+      self.total_items_waiting = job_pack_items.waiting.count
+      self.total_items_running = job_pack_items.running.count
+
+      save! if changed?
+    end
+
+    def progress
+      ((total_items_done.to_f * 100) / job_pack_items.count.to_f).to_f
+    end
+  end
+end

data/lib/job_packs/job_pack_item.rb

@@ -0,0 +1,54 @@
+module JobPacks
+  class JobPackItem < ::ActiveRecord::Base
+    belongs_to :job_pack
+    belongs_to :job, polymorphic: true
+
+    WAITING = 0
+    RUNNING = 1
+    ERROR = 2
+    DONE = 3
+
+    scope :done, -> {
+      where(status: DONE)
+    }
+
+    scope :running, -> {
+      where(status: RUNNING)
+    }
+
+    scope :error, -> {
+      where(status: ERROR)
+    }
+
+    scope :waiting, -> {
+      where(status: WAITING)
+    }
+
+    attr_accessor :delayed_job
+
+    before_create :run_job_and_set_status
+
+    def refresh_job_status
+      self.status = if job
+                      if !job.locked_at.nil?
+                        RUNNING
+                      elsif !job.last_error.nil?
+                        ERROR
+                      else
+                        WAITING
+                      end
+                    else
+                      DONE
+                    end
+
+      save! if changed?
+    end
+
+    private
+
+    def run_job_and_set_status
+      self.job = Delayed::Job.enqueue delayed_job
+      self.status = WAITING
+    end
+  end
+end

data/lib/job_packs/railtie.rb

@@ -0,0 +1,4 @@
+module JobPacks
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/job_packs/version.rb

@@ -0,0 +1,3 @@
+module JobPacks
+  VERSION = '0.1.0'.freeze
+end

data/lib/job_packs.rb

@@ -0,0 +1,8 @@
+require "job_packs/railtie"
+require "job_packs/job_pack"
+require "job_packs/job_pack_item"
+require "job_packs/callbacks"
+
+module JobPacks
+  # Your code goes here...
+end

data/lib/tasks/job_packs_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :job_packs do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: job_packs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eduardo Lagares
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Run jobs in a pack and monitor them.
+email:
+- eduardo.lagares@al.go.leg.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/job_packs/install_generator.rb
+- lib/generators/job_packs/migration.rb
+- lib/generators/job_packs/migration_helper.rb
+- lib/generators/job_packs/templates/install.rb
+- lib/job_packs.rb
+- lib/job_packs/callbacks.rb
+- lib/job_packs/job_pack.rb
+- lib/job_packs/job_pack_item.rb
+- lib/job_packs/railtie.rb
+- lib/job_packs/version.rb
+- lib/tasks/job_packs_tasks.rake
+homepage: https://github.com/eduardolagares/job_packs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Job Packs and Monitor
+test_files: []