workflow_kit 0.0.1.apha

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in workflow_kit.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# 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'
+
+gem 'nifty-generators'
+gem 'sass-rails'

data/Gemfile.lock

@@ -0,0 +1,153 @@
+PATH
+  remote: .
+  specs:
+    workflow_kit (0.0.1.apha)
+      rails (~> 3.2.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.8)
+    arel (3.0.2)
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.4)
+      ffi (~> 1.0, >= 1.0.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    ffi (1.1.0)
+    guard (1.0.1)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.5)
+      guard (>= 0.8.4)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    jquery-rails (2.0.2)
+      railties (>= 3.2.0, < 5.0)
+      thor (~> 0.14)
+    json (1.7.3)
+    libwebsocket (0.1.4)
+      addressable
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nifty-generators (0.4.6)
+    nokogiri (1.5.5)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    rspec-rails (2.10.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.10.0)
+    rubyzip (0.9.9)
+    sass (3.1.20)
+    sass-rails (3.2.5)
+      railties (~> 3.2.0)
+      sass (>= 3.1.10)
+      tilt (~> 1.3)
+    selenium-webdriver (2.25.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  capybara
+  guard (= 1.0.1)
+  guard-rspec (= 0.5.5)
+  jquery-rails
+  nifty-generators
+  nokogiri (>= 1.5.0)
+  rake
+  rspec-rails (= 2.10.0)
+  sass-rails
+  sqlite3
+  workflow_kit!

data/Guardfile

@@ -0,0 +1,22 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sebastian Fiedlschuster
+
+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,53 @@
+# WorkflowKit
+
+This *ruby on rails gem* provides a *workflow construction kit* for rails apps. Users can arrange workflow bricks in a sequence for each workflow and add parameters. When a workflow is executed, each workflow brick executes a callback method written in ruby and passes the parameters.
+
+## Alpha State
+
+This gem is currently in alpha state. It's not production ready, yet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'workflow_kit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workflow_kit
+
+## Usage
+
+### Preparation
+
+* Include in routes
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  mount WorkflowKit::Engine => "/workflow_kit"
+end
+```
+
+* Migrate Database
+```
+rake workflow_kit:install:migrations
+rake db:migrate
+```
+
+
+TODO: Write usage instructions here
+
+## Further Reading
+* Integration of mountable engines (like this gem): http://railscasts.com/episodes/277-mountable-engines?view=asciicast 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,42 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WorkflowKit'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+#require 'rake/testtask'
+#
+#Rake::TestTask.new(:test) do |t|
+#  t.libs << 'lib'
+#  t.libs << 'test'
+#  t.pattern = 'test/**/*_test.rb'
+#  t.verbose = false
+#end
+#task :default => :test
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new( :spec )
+task default: :spec

data/app/assets/javascripts/workflow_kit/application.js

@@ -0,0 +1,15 @@
+// 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/workflow_kit/workflows.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/assets/stylesheets/workflow_kit/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/app/assets/stylesheets/workflow_kit/workflows.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/workflow_kit/application_controller.rb

@@ -0,0 +1,5 @@
+module WorkflowKit
+  class ApplicationController < ActionController::Base
+    layout 'application'
+  end
+end

data/app/controllers/workflow_kit/workflows_controller.rb

@@ -0,0 +1,96 @@
+require_dependency "workflow_kit/application_controller"
+
+module WorkflowKit
+  class WorkflowsController < ApplicationController
+    # GET /workflows
+    # GET /workflows.json
+    def index
+      @workflows = Workflow.all
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @workflows }
+      end
+    end
+  
+    # GET /workflows/1
+    # GET /workflows/1.json
+    def show
+      @workflow = Workflow.find(params[:id])
+  
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @workflow }
+      end
+    end
+  
+    # GET /workflows/new
+    # GET /workflows/new.json
+    def new
+      @workflow = Workflow.new
+  
+      respond_to do |format|
+        format.html # new.html.erb
+        format.json { render json: @workflow }
+      end
+    end
+  
+    # GET /workflows/1/edit
+    def edit
+      @workflow = Workflow.find(params[:id])
+    end
+  
+    # POST /workflows
+    # POST /workflows.json
+    def create
+      @workflow = Workflow.new(params[:workflow])
+  
+      respond_to do |format|
+        if @workflow.save
+          format.html { redirect_to @workflow, notice: 'Workflow was successfully created.' }
+          format.json { render json: @workflow, status: :created, location: @workflow }
+        else
+          format.html { render action: "new" }
+          format.json { render json: @workflow.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # PUT /workflows/1
+    # PUT /workflows/1.json
+    def update
+      @workflow = Workflow.find(params[:id])
+  
+      respond_to do |format|
+        if @workflow.update_attributes(params[:workflow])
+          format.html { redirect_to @workflow, notice: 'Workflow was successfully updated.' }
+          format.json { head :no_content }
+        else
+          format.html { render action: "edit" }
+          format.json { render json: @workflow.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # DELETE /workflows/1
+    # DELETE /workflows/1.json
+    def destroy
+      @workflow = Workflow.find(params[:id])
+      @workflow.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to workflows_url }
+        format.json { head :no_content }
+      end
+    end
+
+    # PUT /workflows/1/execute
+    def execute
+      @workflow = Workflow.find( params[ :id ] )
+      @workflow.execute
+      
+      flash[ :notice ] = I18n.t( :executed_workflow, @workflow.name )
+      redirect_to :back
+    end
+  end
+end

data/app/helpers/workflow_kit/application_helper.rb

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

data/app/helpers/workflow_kit/workflows_helper.rb

@@ -0,0 +1,4 @@
+module WorkflowKit
+  module WorkflowsHelper
+  end
+end

data/app/models/workflow_kit/brick.rb

@@ -0,0 +1,45 @@
+module WorkflowKit
+  class Brick 
+
+    @@descendants = []
+
+    def self.inherited( descendant_class )
+      @@descendants << descendant_class 
+    end
+
+    def name
+      self.class.name
+    end
+
+    def description
+    end
+
+    def execute( params )
+    end
+
+    def self.all
+      @@descendants
+    end
+
+    def self.find_by_name( brick_name )
+      class_name = "WorkflowKit::#{brick_name}" if brick_name
+      return class_name.constantize.new 
+    end
+
+  end
+
+# If uncommented, this Brick will also be visible in the application.
+# Thus, this should stay commented in production.
+#
+#  class TestBrick < Brick
+#    def description
+#      "This is a test brick of the workflow_kit."
+#    end
+#
+#    def execute( params )
+#      p "Executing TestBrick"
+#      p params
+#    end
+#  end
+
+end

data/app/models/workflow_kit/parameter.rb

@@ -0,0 +1,34 @@
+module WorkflowKit
+  class Parameter < ActiveRecord::Base
+
+    attr_accessible :key, :value
+
+    belongs_to :parameterable, polymorphic: true
+
+    def key
+      return super.to_sym unless super.kind_of? Symbol
+      return super
+    end
+
+    def value
+      v = super
+      v = v.to_i if ( not v.to_i == nil ) and ( v.to_i.to_s == v )
+      v = true if v == "true"
+      v = false if v == "false"
+      return v
+    end
+
+    def to_hash
+      return { key => value }
+    end
+
+    def self.to_hash( parameters )
+      parameter_hashes = parameters.collect do |parameter|
+        parameter.to_hash
+      end
+      merged_hash = parameter_hashes.inject { |all, h| all.merge( h ) }
+      return merged_hash
+    end
+
+  end
+end

data/app/models/workflow_kit/parameterable.rb

@@ -0,0 +1,40 @@
+
+module WorkflowKit
+
+  module Parameterable
+    def has_many_parameters
+      
+      has_many :parameters, as: :parameterable, dependent: :destroy, autosave: true
+
+      include ParameterableInstanceMethods
+
+    end
+  end
+
+  module ParameterableInstanceMethods
+
+    # returns the associated parameters as hash
+    def parameters_to_hash
+      WorkflowKit::Parameter.to_hash( parameters )
+    end
+
+    def parameter_hash
+      parameters_to_hash
+    end
+
+    def parameters=( new_parameter_hash )
+            
+      return super( new_parameter_hash ) if not new_parameter_hash.kind_of? Hash # original method
+      
+      parameters.destroy_all # delete previous parameters
+      if new_parameter_hash
+        new_parameter_hash.each do |key, value|
+          self.parameters.build( key: key, value: value )
+        end
+      end
+
+    end
+
+  end
+
+end

data/app/models/workflow_kit/step.rb

@@ -0,0 +1,27 @@
+module WorkflowKit
+
+  require 'workflow_kit/brick'
+  
+  class Step < ActiveRecord::Base
+
+    attr_accessible :sequence_index, :brick_name, :parameters
+
+    belongs_to :workflow
+
+    extend WorkflowKit::Parameterable
+    has_many_parameters
+
+
+    def execute( params = {} )
+      params = {} unless params
+      params = params.merge( self.parameters_to_hash ) if self.parameters.count > 0
+      self.brick.execute( params ) if self.brick
+    end
+
+    def brick
+      @brick = Brick.find_by_name( self.brick_name ) unless @brick
+      return @brick
+    end
+
+  end
+end