whenever-web 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64df975657844372895e97d3b585340e492a100e
-  data.tar.gz: 5f91b654b17c80c8d39e9111cc0dc6c9224aafd1
+  metadata.gz: 9bff8d51d0cc7b17cefe45c45cf5e4f4002ff6eb
+  data.tar.gz: 095e0103aa282daebf98852658fa82865f6dd35f
 SHA512:
-  metadata.gz: cf8ed3d7e33117f3cf59ae4b8de244b17822ba79fb1d98801435d005077475f5aa650e41f63c0e342cf06e0da934361a78e74c5fb752e1be504f5cf5479fe909
-  data.tar.gz: ad144adcf4cac3031b654122c7a94be67880ff71f72dbf8a606054de37d09da3b8c4d2876fd5f61521c9f0cd2991d5a4316b8a9cbb03feecae2ede2747361b8d
+  metadata.gz: 9a23e505e1512327fbdf029a6a3055f9a4f1d74c537f12062bc80f50f9b272da79c30568f79f944a984b72bad2df254211e6ed655d6af376bbb1b7d2815bf4c2
+  data.tar.gz: b89f2f869524a4b8211a5ffd28b4ef6f4d6b6ff7f6bd6c609af81f21a3e25bd81e491f0a0690c41b06acd38c4506de9927816dd2fad379e5b376552f320c262b

data/README.md

@@ -1,5 +1,9 @@
 # Whenever Web
 
+Whenever Web is a Rails engine, that can be easily integrated with your admin panel layout.
+
+![Whenever Web](http://i.imgur.com/d6whPlQ.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -12,27 +16,29 @@ And then execute:
 
 ## Usage
 
-Mount the engine in your `routes.rb`:
+1. Mount the engine in your `routes.rb`:
 
-```ruby
-MyApp::Application.routes.draw do
-  # ...
-  mount Whenever::Web, at: '/whenever'
-  # ...
-end
-```
+  ```ruby
+  MyApp::Application.routes.draw do
+    # ...
+    mount Whenever::Web, at: '/whenever'
+    # ...
+  end
+  ```
 
-And go to `/whenever`.
+2. Go to [localhost:3000/whenever](http://localhost:3000/whenever).
 
-You can add a link to the panel in your views:
+3. Add a link to the panel in your views:
 
-```ruby
-= link_to 'Cron Jobs', whenever_path
-```
+  ```ruby
+  = link_to 'Cron Jobs', whenever_path
+  ```
 
-You can also optionally describe the Cron jobs in `schedule.rb`:
+## Optional usage
 
-```
+Describe your Cron jobs in `schedule.rb` by using `desc` method:
+
+```ruby
 require 'whenever/web'
 
 every 1.day, at: '3:00 am' do
@@ -41,6 +47,18 @@ every 1.day, at: '3:00 am' do
 end
 ```
 
+## Custom configuration
+
+Put this into `config/initializers/whenever_web.rb`:
+
+```ruby
+# Specify your own controller base eg. 'Admin::AdminController'
+# Whenever::Web.config.parent_controller = 'Whenever::WebController'
+
+# Change default schedule file path
+# Whenever::Web.config.schedule_file = 'config/schedule.rb'
+```
+
 ## Contributing
 
 1. Fork it (http://github.com/bartoszkopinski/whenever-web/fork)

data/app/controllers/whenever/jobs_controller.rb

@@ -1,22 +1,13 @@
 module Whenever
-  class JobsController < ActionController::Base
-    before_filter :list_jobs
-    layout 'admin'
-
+  class JobsController < Web.config.parent_controller
     def index
+      @crontab = CommandLine.new.send(:read_crontab)
     end
 
     def run
-      job = @job_list.web_jobs.fetch(params[:id].to_i)
-      `#{job.command}`
-      flash[:notice] = job.command
-      redirect_to jobs_path
-    end
-
-    private
-
-    def list_jobs
-      @job_list = WebJobList.new(file: 'config/schedule.rb')
+      runner = JobRunner.new(params[:id])
+      runner.run
+      redirect_to jobs_path, notice: t('.success', command: runner.command)
     end
   end
 end

data/app/controllers/whenever/logs_controller.rb

@@ -0,0 +1,14 @@
+module Whenever
+  class LogsController < Web.config.parent_controller
+    def clear
+      log.clear
+      redirect_to jobs_path, notice: t('.success', kind: log.kind)
+    end
+
+    protected
+
+    def log
+      @log ||= Web.job_list.logs.fetch(params[:kind])
+    end
+  end
+end

data/app/controllers/whenever/web_controller.rb

@@ -0,0 +1,5 @@
+module Whenever
+  class WebController < ActionController::Base
+    layout Web.config.layout
+  end
+end

data/app/helpers/whenever/jobs_helper.rb

@@ -1,5 +1,9 @@
 module Whenever
   module JobsHelper
+    def job_list
+      @job_list ||= Web.job_list
+    end
+
     def method_missing(method, *args, &block)
       main_app.send(method, *args, &block)
     rescue NoMethodError

data/app/models/whenever/log.rb

@@ -0,0 +1,22 @@
+module Whenever
+  class Log
+    attr_reader :kind
+
+    def initialize kind, path
+      @kind = kind
+      @path = path
+    end
+
+    def name
+      "#{@kind}_log"
+    end
+
+    def tail
+      File.read(@path)
+    end
+
+    def clear
+      File.write(@path, nil)
+    end
+  end
+end

data/app/models/whenever/web_config.rb

@@ -0,0 +1,15 @@
+module Whenever
+  class WebConfig
+    attr_accessor :schedule_file, :parent_controller, :layout
+
+    def initialize
+      @schedule_file     = 'config/schedule.rb'
+      @parent_controller = 'Whenever::WebController'
+      @layout            = 'admin'
+    end
+
+    def parent_controller
+      @parent_controller.to_s.constantize
+    end
+  end
+end

data/app/models/whenever/web_job.rb

@@ -3,26 +3,31 @@ require 'whenever/patches/job'
 module Whenever
   class WebJob
     include ActionView::Helpers::DateHelper
-    attr_reader :interval, :job
+    attr_reader :interval
 
     def initialize job, interval
       @job      = job
       @interval = interval
     end
 
-    def description
-      @job.options.fetch(:description) {
-        @job.options[:task]
-      }
+    delegate :output, :at, to: :@job
+
+    def task
+      @job.options[:task]
     end
 
-    def command
-      replacements = @job.options.map{ |k, v| [":#{k}", v] }.to_h
-      @job.template.gsub(/:\w+/, replacements)
+    def description
+      @job.options.fetch(:description) { task }
     end
 
     def interval
-      distance_of_time_in_words(@interval)
+      distance_of_time_in_words(@interval).gsub('about', '')
+    rescue ArgumentError
+      @interval
+    end
+
+    def roles
+      @job.roles.join(', ')
     end
   end
 end

data/app/models/whenever/web_job_list.rb

@@ -2,22 +2,43 @@ require 'whenever/patches/job_list'
 
 module Whenever
   class WebJobList < JobList
-    attr_reader :set_variables
+    include Enumerable
+    attr_reader :set_variables, :job_types
+
+    delegate :fetch, :each, to: :web_jobs
 
     def web_jobs
-      @jobs.flat_map do |interval, jobs|
-        jobs.map do |job|
-          WebJob.new(job, interval)
+      @web_jobs ||= begin
+        @jobs.flat_map do |interval, jobs|
+          jobs.map do |job|
+            WebJob.new(job, interval)
+          end
         end
       end
     end
 
-    def error_log
-      File.read(set_variables[:output][:error])
+    def logs
+      @logs ||= fetch_logs(@set_variables[:output])
+    end
+
+    alias_method :old_job_type, :job_type
+
+    def job_type name, template
+      (@job_types ||= {})[name] = template
+      old_job_type name, template
     end
 
-    def standard_log
-      File.read(set_variables[:output][:standard])
+    protected
+
+    def fetch_logs path, kind = 'standard'
+      case path
+      when Hash
+        path.map{ |k, v| fetch_logs(v, k) }.inject(:merge)
+      when String
+        { kind.to_s => Log.new(kind, path) }
+      else
+        {}
+      end
     end
   end
 end

data/app/services/whenever/job_runner.rb

@@ -0,0 +1,25 @@
+module Whenever
+  class JobRunner
+    def initialize job_id
+      @job_id  = job_id.to_i
+    end
+
+    def run
+      `#{environment_variables} #{command}`
+    end
+
+    def command
+      web_job.output
+    end
+
+    protected
+
+    def web_job
+      @web_job ||= Web.job_list.fetch(@job_id)
+    end
+
+    def environment_variables
+      @environment_variables ||= Web.job_list.environment_variables
+    end
+  end
+end

data/app/views/whenever/jobs/index.html.erb

@@ -1,70 +1,93 @@
 <div class="panel panel-default">
-  <div class="panel-heading">
-    <div class="panel-title">
-      Settings
+  <div class="panel-heading clearfix">
+    <div class="panel-title pull-left">
+      <%= t('whenever.cron_jobs') %>
     </div>
   </div>
   <table class="table">
     <thead>
       <tr>
-        <% @job_list.set_variables.keys.each do |k| %>
-          <th><%= k.to_s.humanize %></th>
-        <% end %>
+        <th><%= t('whenever.task') %></th>
+        <th><%= t('whenever.interval') %></th>
+        <th><%= t('whenever.hour') %></th>
+        <th><%= t('whenever.roles') %></th>
+        <th><%= t('whenever.action') %></th>
       </tr>
     </thead>
     <tbody>
+      <% job_list.each_with_index do |job, i| %>
       <tr>
-        <% @job_list.set_variables.values.each do |v| %>
-          <td><%= v %></td>
-        <% end %>
+        <td><%= job.description %></td>
+        <td><%= job.interval %></td>
+        <td><%= job.at %></td>
+        <td><%= job.roles %></td>
+        <td><%= link_to t('whenever.run_now'), run_job_path(i), class: 'btn btn-danger', title: job.output %></td>
       </tr>
+      <% end %>
     </tbody>
   </table>
 </div>
+<% job_list.logs.each do |_, log| %>
+<div class="panel panel-default">
+  <div class="panel-heading clearfix">
+    <div class="panel-title pull-left">
+      <%= t("whenever.#{log.name}") %>
+    </div>
+    <div class="pull-right">
+      <%= link_to t('whenever.clear'), clear_log_path(log.kind), class: 'btn btn-xs btn-warning' %>
+    </div>
+  </div>
+  <%= text_area_tag(log.name, log.tail, rows: 15, class: 'form-control', disabled: 'disabled') %>
+</div>
+<script type="text/javascript">
+  var <%= log.name %> = document.getElementById('<%= log.name %>');
+  <%= log.name %>.scrollTop = <%= log.name %>.scrollHeight;
+</script>
+<% end %>
 <div class="panel panel-default">
-  <div class="panel-heading">
-    <div class="panel-title">
-      Cron jobs
+  <div class="panel-heading clearfix">
+    <div class="panel-title pull-left">
+      <%= t('whenever.options') %>
     </div>
   </div>
   <table class="table">
     <thead>
       <tr>
-        <th>Task</th>
-        <th>Interval</th>
-        <th>Action</th>
+        <th><%= t('whenever.settings') %></th>
+        <th></th>
       </tr>
     </thead>
     <tbody>
-      <% @job_list.web_jobs.each_with_index do |job, i| %>
-        <tr>
-          <td><%= job.description %></td>
-          <td><%= job.interval %></td>
-          <td><%= link_to 'Run now', run_job_path(i), class: 'btn btn-danger', title: job.command %></td>
-        </tr>
+      <% job_list.set_variables.each do |k, v| %>
+      <tr>
+        <td><%= k %></td>
+        <td><%= v %></td>
+      </tr>
+      <% end %>
+    <thead>
+      <tr>
+        <th><%= t('whenever.job_types') %></th>
+        <th></th>
+      </tr>
+    </thead>
+      <% job_list.job_types.each do |k, v| %>
+      <tr>
+        <td><%= k %></td>
+        <td><%= v %></td>
+      </tr>
       <% end %>
     </tbody>
   </table>
 </div>
+<% if @crontab.present? %>
 <div class="panel panel-default">
-  <div class="panel-heading">
-    <div class="panel-title">
-      Error log
+  <div class="panel-heading clearfix">
+    <div class="panel-title pull-left">
+      <%= t('whenever.cron_tab') %>
     </div>
   </div>
-  <%= text_area(:job_list, :error_log, rows: 15, class: 'form-control', disabled: 'disabled') %>
+  <pre>
+    <%= @crontab %>
+  </pre>
 </div>
-<div class="panel panel-default">
-  <div class="panel-heading">
-    <div class="panel-title">
-      Standard log
-    </div>
-  </div>
-  <%= text_area(:job_list, :standard_log, rows: 15, class: 'form-control', disabled: 'disabled') %>
-</div>
-<script type="text/javascript">
-  var error_log = document.getElementById('job_list_error_log');
-  var standard_log = document.getElementById('job_list_standard_log');
-  error_log.scrollTop = error_log.scrollHeight;
-  standard_log.scrollTop = standard_log.scrollHeight;
-</script>
+<% end %>

data/app/views/whenever/layouts/admin.html.haml

@@ -0,0 +1,8 @@
+!!!
+%html
+  %head
+  %body
+    .container
+      .row
+        = yield
+    %footer

data/config/locales/en.yml

@@ -0,0 +1,18 @@
+en:
+  whenever:
+    logs:
+      clear:
+        success: "%{kind} log cleaned!"
+    jobs:
+      run:
+        success: "Task run: %{command}"
+    action: Action
+    cron_jobs: Cron jobs
+    error_log: Error log
+    hour: Hour
+    interval: Interval
+    roles: Roles
+    run_now: Run now
+    settings: Settings
+    standard_log: Standard log
+    task: Task

data/config/routes.rb

@@ -1,4 +1,5 @@
 Whenever::Web.routes.draw do
   get '/', to: 'jobs#index', as: :jobs
   get 'job/:id/run', to: 'jobs#run', as: :run_job
+  get 'log/:kind/clear', to: 'logs#clear', as: :clear_log
 end

data/lib/whenever/patches/job.rb

@@ -2,6 +2,6 @@ require 'whenever/job'
 
 module Whenever
   class Job
-    attr_reader :options, :template
+    attr_reader :options, :template, :at, :roles
   end
 end

data/lib/whenever/patches/job_list.rb

@@ -2,6 +2,8 @@ require 'whenever/job_list'
 
 module Whenever
   class JobList
+    public :environment_variables
+
     def desc description
       @options[:description] = description
     end

data/lib/whenever/web.rb

@@ -5,7 +5,17 @@ require 'whenever/patches/job_list'
 
 module Whenever
   class Web < ::Rails::Engine
-    engine_name 'whenever'
+    engine_name self.name.deconstantize
     isolate_namespace Whenever
+
+    class << self
+      def config
+        @config ||= Whenever::WebConfig.new
+      end
+
+      def job_list
+        Whenever::WebJobList.new(file: config.schedule_file)
+      end
+    end
   end
 end

data/whenever-web.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "whenever-web"
-  spec.version       = "0.0.4"
+  spec.version       = "0.0.5"
   spec.authors       = ["Bartosz Kopinski"]
   spec.email         = ["bartosz.kopinski@gmail.pl"]
   spec.summary       = %q{Web GUI for Whenever gem}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whenever-web
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Bartosz Kopinski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,12 +78,19 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/controllers/whenever/application_controller.rb
 - app/controllers/whenever/jobs_controller.rb
+- app/controllers/whenever/logs_controller.rb
+- app/controllers/whenever/web_controller.rb
 - app/helpers/whenever/jobs_helper.rb
+- app/models/whenever/cron_tab.rb
+- app/models/whenever/log.rb
+- app/models/whenever/web_config.rb
 - app/models/whenever/web_job.rb
 - app/models/whenever/web_job_list.rb
+- app/services/whenever/job_runner.rb
 - app/views/whenever/jobs/index.html.erb
+- app/views/whenever/layouts/admin.html.haml
+- config/locales/en.yml
 - config/routes.rb
 - lib/whenever/patches/job.rb
 - lib/whenever/patches/job_list.rb
@@ -109,8 +116,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Web GUI for Whenever gem
 test_files: []
+has_rdoc: 

data/app/controllers/whenever/application_controller.rb

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