level_up 0.2.0 → 0.3.0

data/CHANGELOG.txt

@@ -1,3 +1,7 @@
+== 0.3.0 Wave Race
+  * Flowcharts (svg representation of jobs) accessible from the mountable web app
+  * New GraphBuilder class to easily build and customize Graphviz graphs
+
 == 0.2.0 Hungry Beast
   * Configurable size of saved backtrace when rescuing from an error
   * Renamed 'states' into 'tasks'

data/app/assets/stylesheets/level_up/application.css.scss

@@ -62,7 +62,7 @@ header {
         -webkit-box-sizing: border-box;
         -moz-box-sizing: border-box;
         box-sizing: border-box;
-        width: 50%;
+        width: 33.33%;
 
         &:first-child {
           a.app-link {

data/app/controllers/level_up/flowcharts_controller.rb

@@ -0,0 +1,38 @@
+require_dependency 'level_up/application_controller'
+
+module LevelUp
+  class FlowchartsController < ApplicationController
+    if Configuration.http_authentication
+      http_basic_authenticate_with name: Configuration.http_login, password: Configuration.http_password
+    end
+
+    def index
+      @job_classes = LevelUp::Job.descendants.map { |klass| klass }
+    end
+
+    def show
+      @job_type = params[:id]
+      @job_class = @job_type.camelize.safe_constantize
+      if @job_class
+
+      else
+        flash.now[:alert] = "Job class not found"
+      end
+    end
+
+    respond_to :svg
+    def graphviz
+      job_type = params[:id]
+      job_class = job_type.camelize.safe_constantize
+
+      if job_class
+        builder = GraphBuilder.new(job_class)
+        graph = builder.graph
+        graph.output(:svg => "#{Rails.root}/tmp/#{job_type}.svg")
+        send_data(File.open("#{Rails.root}/tmp/#{job_type}.svg").read, filename: "#{job_type}.svg", type: 'image/svg+xml', disposition: 'inline')
+      else
+        render text: "Job class not found", status: 404
+      end
+    end
+  end
+end

data/app/controllers/level_up/jobs_controller.rb

@@ -79,38 +79,15 @@ module LevelUp
     respond_to :svg
     def graphviz
       job = Job.find params[:id]
-      g = GraphViz.new(:G, type: :digraph)
-      g[:bgcolor]= '#fafbfb'
 
-      g.node[:color] = '#111111'
-      g.node[:style] = 'filled'
-      g.node[:shape] = 'box'
-      g.node[:fillcolor] = '#666666'
-      g.node[:fontcolor] = 'white'
-      g.node[:fontname] = 'Verdana'
-      g.edge[:color] = '#000000'
-      g.edge[:arrowhead] = 'open'
-
-      tasks = {}
-      job.tasks.each do |task|
-        tasks[task] = g.add_nodes(task.to_s.humanize.downcase)
-        if task == :start
-          tasks[task][:fillcolor] = '#5db1a4'
-          tasks[task][:color] = '#048282'
-        elsif task == :end
-          tasks[task][:fillcolor] = '#b40d28'
-          tasks[task][:color] = '#600615'
-        end
-      end
-
-      job.tasks.each do |task|
-        job.transitions(task).each do |transition|
-          g.add_edges(tasks[task], tasks[transition])
-        end
+      if job
+        builder = GraphBuilder.new(job)
+        graph = builder.graph
+        graph.output(:svg => "#{Rails.root}/tmp/job_#{job.id}.svg")
+        send_data(File.open("#{Rails.root}/tmp/job_#{job.id}.svg").read, filename: "job_#{job.id}.svg", type: 'image/svg+xml', disposition: 'inline')
+      else
+        render text: "Job not found", status: 404
       end
-
-      g.output(:svg => "#{Rails.root}/tmp/job_#{job.id}.svg")
-      send_data(File.open("#{Rails.root}/tmp/job_#{job.id}.svg").read, filename: "job_#{job.id}.svg", type: 'image/svg+xml', disposition: 'inline')
     end
   end
 end

data/app/models/level_up/graph_builder.rb

@@ -0,0 +1,80 @@
+module LevelUp
+  class GraphBuilder
+    attr_accessor :target
+    attr_reader :configuration
+
+    @default_configuration = {
+      bgcolor: '#fafbfb',
+
+      node: {
+        color: '#111111',
+        style: 'filled',
+        shape: 'box',
+        fillcolor: '#666666',
+        fontcolor: 'white',
+        fontname: 'Verdana',
+
+        start: {
+          fillcolor: '#5db1a4',
+          color: '#048282'
+        },
+
+        end: {
+          fillcolor: '#b40d28',
+          color: '#600615'
+        }
+      },
+
+      edge: {
+        color: '#000000',
+        arrowhead: 'open'
+      }
+    }
+
+    class << self
+      attr_reader :default_configuration
+    end
+
+    def initialize(target, options = {})
+      @target = target
+      @configuration = self.class.default_configuration.deep_merge(options)
+    end
+
+    def graph
+      graph = GraphViz.new(:G, type: :digraph)
+
+      graph[:bgcolor] = @configuration[:bgcolor]
+
+      @configuration[:node].each do |k, v|
+        graph.node[k] = v unless v.is_a? Hash
+      end
+
+      @configuration[:edge].each do |k, v|
+        graph.edge[k] = v unless v.is_a? Hash
+      end
+
+      tasks = {}
+      @target.tasks.each do |task|
+        tasks[task] = graph.add_nodes(task.to_s.humanize.downcase)
+        if @configuration[:node].has_key? task
+          @configuration[:node][task].each do |k, v|
+            tasks[task][k] = v
+          end
+        end
+      end
+
+      @target.tasks.each do |task|
+        @target.transitions(task).each do |transition|
+          edge = graph.add_edges(tasks[task], tasks[transition])
+          if @configuration[:edge].has_key? task
+            @configuration[:edge][task].each do |k, v|
+              edge[k] = v
+            end
+          end
+        end
+      end
+
+      graph
+    end
+  end
+end

data/app/views/layouts/level_up/_header.html.erb

@@ -4,13 +4,14 @@
       <div class="grid-2">
         <h1>Level<span class="colored-part">Up</span></h1>
       </div>
-      <div class="grid-3">
+      <div class="grid-4">
         <ul>
           <li><%= link_to "Dashboard", root_path, class: "app-link" %></li>
           <li><%= link_to "Jobs", jobs_path, class: "app-link" %></li>
+          <li><%= link_to "Flowcharts", flowcharts_path, class: "app-link" %></li>
         </ul>
       </div>
-      <div class="grid-7">
+      <div class="grid-6">
         <div class="search-bar">
           <%= form_tag jobs_path, method: :get do %>
             <%= text_field_tag 'search[key_contains]', nil, placeholder: "Search for jobs by key" %>

data/app/views/level_up/flowcharts/index.html.erb

@@ -0,0 +1,36 @@
+<div class="container-12">
+  <div class="grid-12">
+    <div class="breadcrumbs">
+      <ul>
+        <li><%= link_to "Dashboard", root_path %></li> /
+        <li>Flowcharts</li>
+      </ul>
+    </div>
+  </div>
+
+  <div class="grid-12">
+    <table class="table-bordered">
+      <thead>
+        <tr>
+          <th>Type</th>
+          <th>Number of tasks</th>
+          <th>Number of transitions</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @job_classes.each do |job_class| %>
+          <tr>
+            <td><%= link_to job_class.name.underscore, flowchart_path(id: job_class.name.underscore) %></td>
+            <td><%= job_class.tasks.size %></td>
+            <td><%= job_class.schema.values.flatten.size %></td>
+          </tr>
+        <% end %>
+        <% if @job_classes.empty? %>
+          <tr>
+            <td colspan="3">No classes found</td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>

data/app/views/level_up/flowcharts/show.html.erb

@@ -0,0 +1,20 @@
+<div class="container-12">
+  <div class="grid-12">
+    <div class="breadcrumbs">
+      <ul>
+        <li><%= link_to "Dashboard", root_path %></li> /
+        <li><%= link_to "Flowcharts", flowcharts_path %></li> /
+        <li><%= @job_type %></li>
+      </ul>
+    </div>
+  </div>
+
+  <div class="grid-12">
+    <div class="simple-panel">
+      <h2>Job Flow</h2>
+      <div class="svg-graph">
+        <object id="svg-object" data="<%= graphviz_flowchart_path(id: @job_type, format: :svg) %>" type="image/svg+xml"></object>
+      </div>
+    </div>
+  </div>
+</div>

data/config/routes.rb

@@ -10,4 +10,8 @@ LevelUp::Engine.routes.draw do
       get "graphviz"
     end
   end
+
+  resources :flowcharts, only: [:index, :show] do
+    get "graphviz", on: :member
+  end
 end

data/lib/level_up/version.rb

@@ -1,3 +1,3 @@
 module LevelUp
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/dummy/config/environments/development.rb

@@ -35,7 +35,7 @@ Dummy::Application.configure do
   # Expands the lines which load the assets
   config.assets.debug = true
 
-  config.level_up.http_authentication = true
-  config.level_up.http_login = "admin"
-  config.level_up.http_password = "pwd"
+  #config.level_up.http_authentication = true
+  #config.level_up.http_login = "admin"
+  #config.level_up.http_password = "password"
 end

data/test/dummy/config/initializers/preload_sti_models.rb

@@ -0,0 +1,5 @@
+if Rails.env.development?
+  %w[account_banish account_downgrade account_upgrade].each do |job_type|
+    require_dependency File.join("app","models", "#{job_type}.rb")
+  end
+end