activeadmin_jobs 0.1.0

data/Rakefile

@@ -0,0 +1,21 @@
+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    = 'ActiveadminJobs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

data/activeadmin_jobs.gemspec

@@ -0,0 +1,35 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "activeadmin_jobs/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "activeadmin_jobs"
+  s.version     = ActiveadminJobs::VERSION
+  s.authors     = ["Platanus", "Emilio Blanco", "Leandro Segovia"]
+  s.email       = ["rubygems@platan.us", "emilioeduardob@gmail.com", "ldlsegovia@gmail.com"]
+  s.homepage    = "https://github.com/platanus/activeadmin_jobs"
+  s.summary     = "Gem that allows you to play nice with Active Job in Active Admin providing feedback"
+  s.description = "It's a Rails engine that allows you to play nice with Active Job in Active Admin providing user feedback"
+  s.license     = "MIT"
+
+  s.files = `git ls-files`.split($/).reject { |fn| fn.start_with? "spec" }
+
+  s.add_dependency "rails", "~> 4.2", ">= 4.2.0"
+  s.add_dependency "job_notifier", "~> 1.1", ">= 1.1.1"
+  s.add_dependency "devise", "~> 3.5", ">= 3.5.0"
+  s.add_dependency "activeadmin", "~> 1.0.0.pre2"
+  s.add_dependency "activeadmin_addons", "~> 0.9", ">= 0.9.2"
+  s.add_dependency "rails-assets-growl", "~> 1.3", ">= 1.3.1"
+
+  s.add_development_dependency "pry-rails"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec-rails", "~> 3.4.0"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "selenium-webdriver"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "daemons"
+  s.add_development_dependency "delayed_job_active_record"
+  s.add_development_dependency "quiet_assets"
+end

data/app/admin/jobs.rb

@@ -0,0 +1,30 @@
+ActiveAdmin.register JobNotifier::Job, as: "Job" do
+  actions :index, :show
+
+  filter :status
+  filter :notified
+  filter :created_at
+
+  index do
+    id_column
+    tag_column :status
+    column :description
+    bool_column :notified
+    column :created_at
+    actions
+  end
+
+  show do
+    attributes_table do
+      row :id
+      tag_row :status
+      row :description
+      bool_row :notified
+      row :created_at
+    end
+
+    panel JobNotifier::Job.human_attribute_name(:result) do
+      ActiveadminJobs::JobResultRenderer.new(self).render
+    end unless resource.result.blank?
+  end
+end

data/app/assets/javascripts/activeadmin_jobs/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/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/activeadmin_jobs/base.js

@@ -0,0 +1,3 @@
+//= require growl
+//= require job_notifier/notifier
+//= require ./growl_setup

data/app/assets/javascripts/activeadmin_jobs/growl_setup.js.erb

@@ -0,0 +1,115 @@
+JobNotifier.translations = <%= I18nDictionary.translations.to_json %>;
+JobNotifier.jobsUrl = "<%= AdminHelpers.jobs_url %>";
+console.info('translations', JobNotifier.translations);
+
+JobNotifier.onNotify = function(result) {
+  DEFAULT_MESSAGES = {
+    finished: {
+      title: 'Completed Job',
+      one: '1 job was successfully completed!',
+      other: 'jobs were successfully completed!'
+    },
+    failed: {
+      title: 'Failed Job',
+      one: '1 job was completed, but it contains errors...',
+      other: 'jobs were completed, but they contains errors...'
+    }
+  };
+
+  function findTranslation(jobClass, status, key) {
+    try {
+      return JobNotifier.translations[jobClass][status][key];
+    } catch(err) {
+      console.info('Translation not found. Using default...', jobClass, status, key);
+    }
+
+    return DEFAULT_MESSAGES[status][key];
+  }
+
+  function camelToDash(str) {
+     return str.replace(/\W+/g, '_').replace(/([a-z\d])([A-Z])/g, '$1_$2').toLowerCase();
+  }
+
+  function prepareMessage(job, count) {
+    var jobClass = camelToDash(job.job_class);
+    var jobsUrl = JobNotifier.jobsUrl;
+    var msg = '';
+
+    if(count == 1) {
+      jobsUrl += '/' + job.id;
+      msg = findTranslation(jobClass, job.status, 'one');
+    } else {
+      msg = count + ' ' + findTranslation(jobClass, job.status, 'other');
+    }
+
+    var link = '<a href="' + jobsUrl + '">' + msg + '</a>';
+
+    return {
+      title: findTranslation(jobClass, job.status, 'title'),
+      message: link,
+      duration: 6000
+    };
+  }
+
+  function showPopUp(job, count) {
+    var msg = prepareMessage(job, count);
+
+    switch(job.status) {
+      case 'finished':
+        $.growl.notice(msg);
+        break;
+      case 'failed':
+        $.growl.error(msg);
+        break;
+      default:
+        console.error('Invalid job status given', job.status);
+    }
+  }
+
+  function groupJobsByClass(jobs) {
+    var groupedJobs = {};
+
+    for(i = 0; i < jobs.length; i++) {
+      var job = jobs[i];
+
+      if(job.status == 'pending') {
+        continue;
+      }
+
+      var jobClass = camelToDash(job.job_class);
+
+      if(!groupedJobs[jobClass]) {
+        groupedJobs[jobClass] = {};
+      }
+
+      if(!groupedJobs[jobClass][job.status]) {
+        groupedJobs[jobClass][job.status] = [];
+      }
+
+      groupedJobs[jobClass][job.status].push(job);
+    }
+
+    return groupedJobs;
+  }
+
+  function showMsg(jobs) {
+    if(jobs.length === 0) {
+      return;
+    }
+
+    var groupedJobs = groupJobsByClass(jobs);
+
+    for(var jobClass in groupedJobs) {
+      if(groupedJobs.hasOwnProperty(jobClass)) {
+        for(var status in groupedJobs[jobClass]) {
+          if(groupedJobs[jobClass].hasOwnProperty(status)) {
+            jobs = groupedJobs[jobClass][status];
+            showPopUp(jobs[0], jobs.length);
+          }
+        }
+      }
+    }
+  }
+
+  showMsg(result);
+};

data/app/assets/stylesheets/activeadmin_jobs/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/activeadmin_jobs/base.scss

@@ -0,0 +1,19 @@
+@import "growl";
+
+$pending-color: #e67e22;
+$failed-color: #c0392b;
+$finished-color: #27ae60;
+
+.status_tag {
+  &.pending { background: $pending-color; }
+  &.failed { background: $failed-color; }
+  &.finished { background: $finished-color; }
+}
+
+.growl {
+  a {
+    &:link, &:visited, &:hover, &:active {
+      color: #FFFFFF;
+    }
+  }
+}

data/app/controllers/activeadmin_jobs/application_controller.rb

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

data/app/helpers/activeadmin_jobs/application_helper.rb

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

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ActiveadminJobs</title>
+  <%= stylesheet_link_tag    "activeadmin_jobs/application", media: "all" %>
+  <%= javascript_include_tag "activeadmin_jobs/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/activeadmin_jobs/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/activeadmin_jobs.en.yml

@@ -0,0 +1,24 @@
+en:
+  enumerize:
+    job_notifier/job:
+      status:
+        failed: Failed
+        finished: Finished
+        pending: Pending
+  activerecord:
+    models:
+      job:
+        one: Job
+        other: Jobs
+    attributes:
+      job_notifier/job:
+        id: ID
+        identifier: Identifier
+        job_id: Job ID
+        job_class: Job Type
+        status: Status
+        result: Result
+        description: Description
+        notified: Notified?
+        created_at: Created At
+        updated_at: Updated At

data/config/locales/activeadmin_jobs.es.yml

@@ -0,0 +1,24 @@
+es:
+  enumerize:
+    job_notifier/job:
+      status:
+        failed: Con Errores
+        finished: Completo
+        pending: Pendiente
+  activerecord:
+    models:
+      job:
+        one: Proceso
+        other: Procesos
+    attributes:
+      job_notifier/job:
+        id: ID
+        identifier: Identificador
+        job_id: ID Proceso
+        job_class: Tipo
+        status: Estado
+        result: Resultado
+        description: Descripción
+        notified: Notificado?
+        created_at: Fecha de Creación
+        updated_at: Fecha de Actualización

data/config/routes.rb

@@ -0,0 +1,2 @@
+ActiveadminJobs::Engine.routes.draw do
+end

data/lib/activeadmin_jobs.rb

@@ -0,0 +1,8 @@
+require "job_notifier"
+require "devise"
+require "activeadmin"
+require "activeadmin_addons"
+require "activeadmin_jobs/engine"
+
+module ActiveadminJobs
+end

data/lib/activeadmin_jobs/activeadmin_config.rb

@@ -0,0 +1,31 @@
+module AdminHelpers
+  def self.jobs_url
+    url = ["/"]
+
+    if ActiveAdmin.application.default_namespace.present?
+      url << "#{ActiveAdmin.application.default_namespace}/"
+    end
+
+    url << "jobs"
+    url.join("")
+  end
+end
+
+ActiveAdmin.setup do |config|
+  config.load_paths += [File.join(ActiveadminJobs::Engine.root, "app", "admin")]
+end
+
+class ActiveAdmin::Views::Pages::Base
+  alias_method :original_add_classes_to_body, :add_classes_to_body
+
+  def add_classes_to_body
+    original_add_classes_to_body
+    current_user_method = ActiveAdmin.application.current_user_method
+
+    if current_user_method
+      admins_job_identifier = send(current_user_method).job_identifier
+      @body.set_attribute "data-identifier", admins_job_identifier
+      @body.set_attribute "data-root-url", "/"
+    end
+  end
+end

data/lib/activeadmin_jobs/engine.rb

@@ -0,0 +1,16 @@
+module ActiveadminJobs
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveadminJobs
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+    end
+
+    initializer "initialize" do
+      require_relative "./i18n_dictionary"
+      require_relative "./job_result_renderer"
+      require_relative "./activeadmin_config"
+      require_relative "./job_extensions"
+    end
+  end
+end

data/lib/activeadmin_jobs/i18n_dictionary.rb

@@ -0,0 +1,7 @@
+module I18nDictionary
+  def self.translations
+    I18n.backend.load_translations
+    translations = I18n.backend.send(:translations)
+    translations[I18n.locale][:activeadmin_jobs]
+  end
+end