yawl_rails 0.1.0

data/.gitignore

@@ -0,0 +1,12 @@
+.bundle/
+log/*.log
+pkg/
+spec/test_app/db/*.sqlite3
+spec/test_app/db/*.sqlite3-journal
+spec/test_app/log/*.log
+spec/test_app/tmp/
+spec/test_app/.sass-cache
+*.gem
+Gemfile.lock
+.env
+*.swp

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in yawl_rails.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ricardo Chimal, Jr.
+
+MIT License
+
+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,11 @@
+# Yawl Rails
+
+This is the UI and Rails integration component of [yawl](https://github.com/ricardochimal/yawl)
+
+## Migrations
+
+`yawl_rails` automatically sets the schema file to be in sql format because of the `json` column used in `yawl`
+
+```
+config.active_record.schema_format = :sql
+```

data/Rakefile

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

data/app/assets/javascripts/yawl_rails/processes.js

@@ -0,0 +1,44 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+var YawlProcess = {
+  url : null,
+
+  updateStepState : function() {
+    $.ajax(YawlProcess.url, {
+      success: YawlProcess.updateStepsBody
+    });
+  },
+
+  updateStepsBody : function(r, s, x) {
+    $("#steps tbody").html(r);
+    YawlProcess.updateStepProgress();
+
+    var pctCompleted = YawlProcess.stepPctCompleted();
+    if (pctCompleted != 100) {
+      setTimeout(YawlProcess.updateStepState, 5000);
+    }
+  },
+
+  updateStepProgress : function() {
+    var pctCompleted = YawlProcess.stepPctCompleted();
+    $("#process-progress").css("width", pctCompleted + "%");
+    if (pctCompleted == 100) {
+      $("#process-progress").parent().removeClass("progress-striped active");
+      $("#process-progress").addClass("bar-success");
+    }
+  },
+
+  stepPctCompleted : function() {
+    var total = $(".step").size();
+    var completed = $(".step-state").filter(function() { return $(this).html() == "completed" }).size();
+    return Math.round(completed / total * 100.0);
+  },
+
+  init : function() {
+    $(document).ready(function() {
+      YawlProcess.updateStepProgress();
+      setTimeout(YawlProcess.updateStepState, 5000);
+    });
+  }
+};

data/app/controllers/yawl_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module YawlRails
+  class ApplicationController < ::YawlRails.parent_controller.constantize
+  end
+end

data/app/controllers/yawl_rails/processes_controller.rb

@@ -0,0 +1,42 @@
+require_dependency "yawl_rails/application_controller"
+
+module YawlRails
+  class ProcessesController < ApplicationController
+    def index
+      @processes = ::Yawl::Process.order(:id).reverse
+
+      respond_to do |format|
+        format.html
+        format.json { render :json => @processes }
+      end
+    end
+
+    def show
+      @process = ::Yawl::Process.first(:id => params[:id])
+
+      respond_to do |format|
+        format.html
+        format.json { render :json => @process.to_hash.merge(:steps => @process.steps.map(&:to_hash)) }
+      end
+    end
+
+    def restart
+      @process = ::Yawl::Process.first(:id => params[:id])
+      @process.start_first_unfinished_step
+
+      respond_to do |format|
+        format.html { redirect_to yawl_process_path(@process.id), :status => 303 }
+        format.json { render :json => @process.to_hash, :location => yawl_process_url(@process.id) }
+      end
+    end
+
+    def steps
+      @process = ::Yawl::Process.first(:id => params[:id])
+
+      respond_to do |format|
+        format.html { render :partial => "step_rows" }
+        format.json { render :json => @process.to_hash.merge(:steps => @process.steps.map(&:to_hash)) }
+      end
+    end
+  end
+end

data/app/controllers/yawl_rails/steps_controller.rb

@@ -0,0 +1,15 @@
+require_dependency "yawl_rails/application_controller"
+
+module YawlRails
+  class StepsController < ApplicationController
+    def show
+      @process = ::Yawl::Process.first(:id => params[:process_id])
+      @step = @process.steps_dataset.first(:id => params[:id])
+
+      respond_to do |format|
+        format.html
+        format.json { render :json => @step.to_hash.merge(:attempts => @step.attempts.map(&:to_hash)) }
+      end
+    end
+  end
+end

data/app/helpers/yawl_rails/application_helper.rb

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

data/app/helpers/yawl_rails/processes_helper.rb

@@ -0,0 +1,10 @@
+require 'pp'
+
+module YawlRails
+  module ProcessesHelper
+    def pretty_print_hash(hash)
+      PP.pp(hash, out='')
+      out
+    end
+  end
+end

data/app/views/yawl_rails/processes/_show_inline_js.html.haml

@@ -0,0 +1,5 @@
+= javascript_include_tag "yawl_rails/processes"
+
+:javascript
+  YawlProcess.url = "#{steps_yawl_process_path(@process.id)}";
+  YawlProcess.init();

data/app/views/yawl_rails/processes/_step_rows.html.haml

@@ -0,0 +1,12 @@
+- @process.steps.each do |step|
+  %tr.step{:id => "step-#{step.seq}"}
+    %td= link_to step.seq, yawl_process_step_path(@process.id, step.id)
+    %td
+      = step.name
+      - if step.state == "failed" && @process.current?
+        = link_to "<i class='icon-refresh icon-white'></i> Retry".html_safe, restart_yawl_process_path(@process.id), :method => :post, :class => "btn btn-mini btn-primary"
+    %td.step-state= step.state
+    %td= step.attempts.count
+    %td
+      - if step.attempts.count > 0
+        = "%.1fs" % step.duration

data/app/views/yawl_rails/processes/index.html.haml

@@ -0,0 +1,19 @@
+%h2 Recent Processes
+
+- if @processes.count == 0
+  %p No processes yet.
+- else
+  %table#processes.table
+    %thead
+      %tr
+        %th #
+        %th Desired State
+        %th State
+        %th Started at
+    %tbody
+      - @processes.each do |p|
+        %tr{:id => "process-#{p.name}"}
+          %td= link_to p.name, yawl_process_path(p.id)
+          %td= p.desired_state
+          %td= p.state
+          %td= p.created_at

data/app/views/yawl_rails/processes/show.html.haml

@@ -0,0 +1,31 @@
+%h1= "Process #{@process.name}"
+
+%dl.dl-horizontal
+  %dt Request ID
+  %dd= @process.request_id || "-"
+
+  %dt Config
+  %dd
+    %pre
+      = preserve do
+        = pretty_print_hash(@process.config)
+
+  %dt State
+  %dd= @process.state
+
+
+.progress.progress-striped.active
+  .bar#process-progress{:style => "width: 0%;"}
+
+%table#steps.table
+  %thead
+    %tr
+      %th #
+      %th Name
+      %th State
+      %th Attempts
+      %th Duration
+  %tbody
+    = render 'step_rows'
+
+= render 'show_inline_js'

data/app/views/yawl_rails/steps/show.html.haml

@@ -0,0 +1,17 @@
+%h1= link_to "Process #{@process.name}", yawl_process_path(@process.id)
+
+%h2= "Step #{@step.seq}: #{@step.name}"
+
+- if @step.attempts.count == 0
+  %p No attempts yet.
+- else
+  - @step.attempts.reverse.each do |attempt|
+    %h3= "Attempt at #{attempt.started_at}"
+    - if attempt.completed_at
+      %p= "Completed at #{attempt.completed_at}"
+      %pre.pre-scrollable.step-output
+        = preserve do
+          - attempt.output.lines.each do |line|
+            = line
+    - else
+      %p Not completed yet.

data/bin/rails

@@ -0,0 +1,8 @@
+#!/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/yawl_rails/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,11 @@
+YawlRails::Engine.routes.draw do
+  scope as: 'yawl' do
+    resources :processes, :only => [:index, :show] do
+      member do
+        post :restart
+        get :steps
+      end
+      resources :steps, :only => [:show]
+    end
+  end
+end

data/db/migrate/20140225002136_setup_yawl.rb

@@ -0,0 +1,11 @@
+require "yawl/setup"
+
+class SetupYawl < ActiveRecord::Migration
+  def up
+    Yawl::Setup.create!
+  end
+
+  def down
+    Yawl::Setup.destroy!
+  end
+end

data/lib/tasks/yawl_rails_tasks.rake

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

data/lib/yawl/process_active_record.rb

@@ -0,0 +1,12 @@
+require "yawl/process"
+
+module Yawl
+  class Process < Sequel::Model
+    def object
+      return unless values[:object_id] && object_type
+
+      klass = object_type.constantize
+      klass.find(values[:object_id])
+    end
+  end
+end

data/lib/yawl/rails.rb

@@ -0,0 +1,2 @@
+require "yawl"
+require "yawl/process_active_record"

data/lib/yawl_rails/engine.rb

@@ -0,0 +1,24 @@
+require "haml"
+
+module YawlRails
+  class Engine < ::Rails::Engine
+    isolate_namespace YawlRails
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.template_engine :haml
+    end
+
+    config.active_record.schema_format = :sql
+
+    initializer "yawl_rails.append_migrations" do |app|
+      unless app.root.to_s.match root.to_s
+        app.config.paths["db/migrate"] += config.paths["db/migrate"].expanded
+      end
+    end
+
+    initializer "yawl_rails.setup_yawl" do |app|
+      require "yawl/rails"
+    end
+  end
+end

data/lib/yawl_rails/version.rb

@@ -0,0 +1,3 @@
+module YawlRails
+  VERSION = "0.1.0"
+end

data/lib/yawl_rails.rb

@@ -0,0 +1,8 @@
+require "yawl_rails/engine"
+
+module YawlRails
+  extend self
+
+  mattr_accessor :parent_controller
+  self.parent_controller = '::ApplicationController'
+end

data/spec/controllers/yawl_rails/processes_controller_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module YawlRails
+  describe ProcessesController do
+    describe "GET #index" do
+      it "renders the right template" do
+        get :index, use_route: :yawl_rails
+
+        expect(response).to be_success
+        expect(response).to render_template("index")
+      end
+
+      it "loads all yawl processes into @processes" do
+        @p1 = ::Yawl::Process.insert(:desired_state => "test1")
+        @p2 = ::Yawl::Process.insert(:desired_state => "test1")
+
+        get :index, use_route: :yawl_rails
+
+        assigns(:processes).map(&:id).should match_array([@p2, @p1])
+      end
+    end
+  end
+end

data/spec/controllers/yawl_rails/steps_controller_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module YawlRails
+  describe StepsController do
+    before(:each) do
+      @process_id = Yawl::Process.insert(:desired_state => "testing")
+      @step_id = Yawl::Step.insert(:process_id => @process_id, :name => "step1", :seq => 1)
+    end
+
+    describe "GET #show" do
+      it "renders the right template" do
+        get :show, :process_id => @process_id, :id => @step_id, :use_route => :yawl_rails
+
+        expect(response).to be_success
+        expect(response).to render_template("show")
+      end
+
+      it "assigns @step" do
+        get :show, :process_id => @process_id, :id => @step_id, :use_route => :yawl_rails
+
+        assigns(:step).id.should eq(@step_id)
+      end
+    end
+  end
+end

data/spec/helpers/yawl_rails/processes_helper_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+# Specs in this file have access to a helper object that includes
+# the ProcessesHelper. For example:
+#
+# describe ProcessesHelper do
+#   describe "string concat" do
+#     it "concats two strings with spaces" do
+#       expect(helper.concat_strings("this","that")).to eq("this that")
+#     end
+#   end
+# end
+module YawlRails
+  describe ProcessesHelper do
+    it "pretty prints the hash" do
+      helper.pretty_print_hash({"test" => "1235678910", "test2" => "456xxxxxxxxxxxx", "hash" => { "x" => "y", "a" => "b"}}).should eq("{\"test\"=>\"1235678910\",\n \"test2\"=>\"456xxxxxxxxxxxx\",\n \"hash\"=>{\"x\"=>\"y\", \"a\"=>\"b\"}}\n")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+ENV['RAILS_ENV'] ||= 'test'
+ENV['DATABASE_URL'] = 'postgres://localhost/yawl-rails-test'
+
+require File.expand_path("../test_app/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+
+  config.around(:each) do |example|
+    Yawl::DB.transaction(:rollback => :always) do
+      example.run
+    end
+  end
+end

data/spec/test_app/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/test_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+TestApp::Application.load_tasks

data/spec/test_app/app/assets/javascripts/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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/test_app/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/test_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/test_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>TestApp</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/test_app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/test_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/test_app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/test_app/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "yawl_rails"
+
+module TestApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+