trestle-active_job 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f05100e01298bbd87a391caf60c444f42fae34a242a478ffe59f5f5926d91c4
+  data.tar.gz: 26c2da28b2ba309385c06ce649ba7f419dbae9592bac3a7c34da41eed61589d0
+SHA512:
+  metadata.gz: 5aa48037b01cc03a0a170f9412cdfd7d5d7052a9145b82619bc488c1e896b0a9d86649c87a3054017a9cd9ae46b9c5fad2394cfa94b973c40da3a472b9147140
+  data.tar.gz: b0a7f7d78b47fe36c1f2b23105b1e41a16b106e78497613e5eb10d6f65928c516782a30cd348b5be32443b0e10045a4cf61f0ccd0624d90f316cec72fe4b1c9e

data/.gitignore

@@ -0,0 +1,59 @@
+.DS_Store
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+.idea

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+
+cache: bundler
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+rvm:
+  - 2.6.5
+
+gemfile:
+  - gemfiles/rails-5.0.gemfile
+  - gemfiles/rails-5.1.gemfile
+  - gemfiles/rails-5.2.gemfile
+  - gemfiles/rails-6.0.gemfile
+  - gemfiles/rails-6.1.gemfile
+  - gemfiles/rails-6.2.gemfile
+
+jobs:
+  include:
+    gemfile: gemfiles/rails-4.2.gemfile
+    before_install:
+      - gem install bundler -v '< 2'

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trestle-auth.gemspec
+gemspec
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Matthieu "Ezveus" Ciappara
+
+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,17 @@
+# Trestle ActiveJob (trestle-active_job)
+
+> Add an interface to Trestle to perform ActiveJobs
+
+## Getting Started
+
+These instructions assume you have a working Trestle application. To integrate trestle-active_job, first add it to your application's Gemfile:
+
+```ruby
+gem 'trestle-active_job'
+```
+
+Run `bundle install`, and then restart your Rails server.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/admin/trestle/active_job/active_job_admin.rb

@@ -0,0 +1,36 @@
+Trestle.admin(:active_job, scope: Trestle::ActiveJob, path: 'active_job') do
+  routes do
+    post :perform_job
+  end
+
+  controller do
+    before_action :fetch_jobs
+
+    def index
+    end
+
+    def perform_job
+      job = params[:job]
+
+      if @jobs.include?(job)
+        job.constantize.perform_later
+        redirect_to admin.path(:index),
+                    notice: I18n.t('perform_success', scope: 'trestle_active_job',
+                                   default:                  "'%{job_name}' is scheduled",
+                                   job_name:                 I18n.t(job, scope: 'trestle_active_job', default: job))
+      else
+        redirect_to admin.path(:index),
+                    notice: I18n.t('unknown_job', scope: 'trestle_active_job',
+                                   default:              "'%{job_name}' does not exists",
+                                   job_name:             I18n.t(job, scope: 'trestle_active_job', default: job))
+      end
+    end
+
+    private
+
+    def fetch_jobs
+      @jobs = ObjectSpace.each_object(Class).select { |c| c.ancestors.include?(ActiveJob::Base) }
+                         .map(&:to_s)
+    end
+  end
+end

data/app/assets/stylesheets/trestle/active_job.css

@@ -0,0 +1,17 @@
+.trestle-active-job-header-button {
+    float: right;
+    margin: 6px 16px;
+    font-size: 26px;
+}
+
+.trestle-active-job-grid {
+    display: grid;
+    gap: 1rem;
+    grid-template-columns: 7fr 3fr;
+    grid-template-rows: auto;
+    margin-top: 1rem;
+}
+
+.trestle-active-job-grid .trestle-active-job-name {
+    margin-left: 1rem;
+}

data/app/views/admin/trestle/active_job/active_job/index.html.erb

@@ -0,0 +1,27 @@
+<%= content_for(:title, "Active jobs") %>
+
+<% if flash[:notice] %>
+  <div class="alert alert-dismissible alert-success">
+    <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+      <span aria-hidden="true">&times;</span>
+    </button>
+    <div class="text-center d-flex align-items-center justify-content-center">
+      <i class="fa fa-check-circle fa-2x margin-right-md"></i>
+      <span><%= flash[:notice] %></span>
+    </div>
+  </div>
+<% end %>
+
+<div class="trestle-active-job-grid">
+  <% @jobs.each do |job| %>
+    <div class="trestle-active-job-name">
+      <%= t(job, scope: 'trestle_active_job', default: job) %>
+    </div>
+    <div class="trestle-active-job-perform">
+      <%= form_tag admin.path(:perform_job), id: "update_#{job}_form", method: :post, class: 'form-inline mb-2', style: 'width: 100%;' do %>
+        <%= hidden_field_tag('job', job, id: "job_#{job}", class: 'form-check-input') %>
+        <%= submit_tag(t('perform', scope: 'trestle_active_job', default: 'Perform'), class: 'btn btn-success') %>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/app/views/trestle/active_job/_header.html.erb

@@ -0,0 +1 @@
+<%= link_to icon("fa fa-clock"), Trestle::ActiveJob::ActiveJobAdmin.path, class: "trestle-active-job-header-button", title: "ActiveJob", data: { toggle: "tooltip", placement: "bottom" } %>

data/config/initializers/trestle.rb

@@ -0,0 +1,9 @@
+Trestle.configure do |config|
+  config.hook("stylesheets") do
+    stylesheet_link_tag "trestle/active_job"
+  end
+
+  config.hook("view.header") do
+    render "trestle/active_job/header"
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  trestle_active_job:
+    perform: Perform
+    perform_success: "The task '%{job_name}' is scheduled"
+    unknown_job: "The task '%{job_name}' does not exists"

data/config/locales/fr.yml

@@ -0,0 +1,5 @@
+fr:
+  trestle_active_job:
+    perform: Lancer
+    perform_success: "Le job '%{job_name}' a été lancé"
+    unknown_job: "Le job '%{job_name}' n'existe pas"

data/lib/trestle/active_job/engine.rb

@@ -0,0 +1,7 @@
+module Trestle
+  module ActiveJob
+    class Engine < Rails::Engine
+      config.assets.precompile << 'trestle/active_job.css'
+    end
+  end
+end

data/lib/trestle/active_job/version.rb

@@ -0,0 +1,5 @@
+module Trestle
+  module ActiveJob
+    VERSION = '1.0.0'
+  end
+end

data/lib/trestle/active_job.rb

@@ -0,0 +1,5 @@
+require_relative 'active_job/version'
+
+require 'trestle'
+
+require_relative 'active_job/engine' if defined?(Rails)

data/trestle-active_job.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/trestle/active_job/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trestle-active_job"
+  spec.version       = Trestle::ActiveJob::VERSION
+
+  spec.authors       = ["Matthieu Ciappara"]
+  spec.email         = ["matthieu.ciappara@outlook.com"]
+
+  spec.summary       = "Add an interface to Trestle to spawn ActiveJobs"
+  spec.homepage      = "https://github.com/Ezveus/trestle-active_job.git"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Ezveus/trestle-active_job"
+
+  spec.add_dependency 'rails', '>= 5.2', '< 8'
+  spec.add_dependency "trestle", "~> 0.9.0", ">= 0.9.3"
+
+  spec.add_development_dependency "rspec-rails", "~> 4.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: trestle-active_job
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthieu Ciappara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: trestle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- matthieu.ciappara@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/admin/trestle/active_job/active_job_admin.rb
+- app/assets/stylesheets/trestle/active_job.css
+- app/views/admin/trestle/active_job/active_job/index.html.erb
+- app/views/trestle/active_job/_header.html.erb
+- config/initializers/trestle.rb
+- config/locales/en.yml
+- config/locales/fr.yml
+- lib/trestle/active_job.rb
+- lib/trestle/active_job/engine.rb
+- lib/trestle/active_job/version.rb
+- trestle-active_job.gemspec
+homepage: https://github.com/Ezveus/trestle-active_job.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Ezveus/trestle-active_job.git
+  source_code_uri: https://github.com/Ezveus/trestle-active_job
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Add an interface to Trestle to spawn ActiveJobs
+test_files: []