workflow_kit 0.0.1.apha

data/app/models/workflow_kit/workflow.rb

@@ -0,0 +1,20 @@
+module WorkflowKit
+  class Workflow < ActiveRecord::Base
+
+    attr_accessible :description, :name, :parameters
+
+    has_many :steps, dependent: :destroy, order: :sequence_index
+
+    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.steps.collect do |step|
+        step.execute( params )
+      end
+    end
+
+  end
+end

data/app/views/workflow_kit/workflows/_form.html.erb

@@ -0,0 +1,25 @@
+<%= form_for(@workflow) do |f| %>
+  <% if @workflow.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@workflow.errors.count, "error") %> prohibited this workflow from being saved:</h2>
+
+      <ul>
+      <% @workflow.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :name %><br />
+    <%= f.text_field :name %>
+  </div>
+  <div class="field">
+    <%= f.label :description %><br />
+    <%= f.text_area :description %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/workflow_kit/workflows/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing workflow</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @workflow %> |
+<%= link_to 'Back', workflows_path %>

data/app/views/workflow_kit/workflows/index.html.erb

@@ -0,0 +1,25 @@
+<h1>Listing workflows</h1>
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Description</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @workflows.each do |workflow| %>
+  <tr>
+    <td><%= workflow.name %></td>
+    <td><%= workflow.description %></td>
+    <td><%= link_to 'Show', workflow %></td>
+    <td><%= link_to 'Edit', edit_workflow_path(workflow) %></td>
+    <td><%= link_to 'Destroy', workflow, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Workflow', new_workflow_path %>

data/app/views/workflow_kit/workflows/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New workflow</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', workflows_path %>

data/app/views/workflow_kit/workflows/show.html.erb

@@ -0,0 +1,29 @@
+<p id="notice"><%= notice %></p>
+
+<h1>Workflow: <%=h @workflow.name %></h1>
+
+<p>
+  <b>Name:</b>
+  <%=h @workflow.name %>
+</p>
+
+<p>
+  <b>Description:</b>
+  <%=h @workflow.description %>
+</p>
+
+<h2>Steps to Execute</h2>
+
+<div class="workflow_steps">
+  <ol>
+    <% for step in @workflow.steps %>
+      <li>
+	<span class="brick-name"><%= step.brick.name %></span>
+	<span class="brick-description"><%= step.brick.description %></span>
+      </li>
+    <% end %>
+  </ol>
+</div>
+
+<%= link_to 'Edit', edit_workflow_path(@workflow) %> |
+<%= link_to 'Back', workflows_path %>

data/config/routes.rb

@@ -0,0 +1,9 @@
+WorkflowKit::Engine.routes.draw do
+
+  root to: "workflows#index"
+
+  resources :workflows do
+    put 'execute', on: :member
+  end
+  
+end

data/db/migrate/20120721135535_create_workflow_kit_workflows.rb

@@ -0,0 +1,10 @@
+class CreateWorkflowKitWorkflows < ActiveRecord::Migration
+  def change
+    create_table :workflow_kit_workflows do |t|
+      t.string :name
+      t.string :description
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20120721140135_create_workflow_kit_steps.rb

@@ -0,0 +1,11 @@
+class CreateWorkflowKitSteps < ActiveRecord::Migration
+  def change
+    create_table :workflow_kit_steps do |t|
+      t.integer :sequence_index
+      t.references :workflow
+      t.string :brick_name
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20120721140613_create_workflow_kit_parameters.rb

@@ -0,0 +1,11 @@
+class CreateWorkflowKitParameters < ActiveRecord::Migration
+  def change
+    create_table :workflow_kit_parameters do |t|
+      t.string :key
+      t.string :value
+      t.references :parameterable, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/workflow_kit_tasks.rake

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

data/lib/workflow_kit/engine.rb

@@ -0,0 +1,6 @@
+module WorkflowKit
+  class Engine < ::Rails::Engine
+    isolate_namespace WorkflowKit
+    engine_name 'workflow_kit'
+  end
+end

data/lib/workflow_kit/version.rb

@@ -0,0 +1,3 @@
+module WorkflowKit
+  VERSION = "0.0.1.apha"
+end

data/lib/workflow_kit.rb

@@ -0,0 +1,4 @@
+require "workflow_kit/engine"
+
+module WorkflowKit
+end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/workflow_kit/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/models/brick_spec.rb

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe WorkflowKit::Brick do
+
+  describe "Instance" do
+
+    before { @boil_water_brick = WorkflowKit::BoilWaterBrick.new } # in spec/support/factory.rb
+    subject { @boil_water_brick }
+    
+    it { should respond_to( :name ) }
+    it { should respond_to( :description ) }
+    
+    describe "#execute" do
+      it "should execute the brick" do
+        @boil_water_brick.execute( :aim_temperature => "100 °C" ).should ==
+          "Fill a large pot with water, put it on a cooker and wait until a temperature of 100 °C is reached."
+      end
+    end
+
+  end
+
+  describe "Class" do
+    
+    subject { WorkflowKit::Brick }
+
+    describe ".all" do
+      subject { WorkflowKit::Brick.all }
+      it "should list all inherited classes, i.e. the different kind of WorkflowBricks" do
+        subject.should == 
+          [WorkflowKit::BoilWaterBrick, WorkflowKit::BoilSpaghettiBrick, WorkflowKit::ServeSpaghettiBrick]
+      end
+    end
+
+  end
+
+end
+
+

data/spec/models/parameter_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe WorkflowKit::Parameter do
+
+  describe "Instance" do
+    
+    before { @parameter = WorkflowKit::Parameter.new }
+    subject { @parameter }
+
+    it { should respond_to( :key ) }
+    it { should respond_to( :key= ) }
+    it { should respond_to( :value ) }
+    it { should respond_to( :value= ) }
+
+    describe "#value" do
+      describe "for numbers" do
+        it "should return an integer" do
+          subject.value = "123"
+          subject.value.should be_kind_of( Integer )
+        end
+      end
+      describe "for strings" do
+        it "should return a string" do
+          subject.value = "abc"
+          subject.value.should be_kind_of( String )
+        end
+      end
+      describe "for bools" do
+        it "should return a boolean" do
+          subject.value = "true"
+          subject.value.should be_kind_of( TrueClass )
+          subject.value = "false"
+          subject.value.should be_kind_of( FalseClass ) # there is no Boolean in Ruby.
+          # see: http://stackoverflow.com/questions/3192978/why-does-ruby-have-trueclass-and-falseclass-instead-of-a-single-boolean-class
+        end
+      end
+    end
+
+    describe "#to_hash" do
+      before { @parameter = WorkflowKit::Parameter.new( key: "KEY", value: "VALUE" ) }
+      subject { @parameter.to_hash }
+      it { should == { :KEY => "VALUE" } }
+    end
+
+  end
+
+  describe "Class" do
+    
+    subject { WorkflowKit::Parameter }
+
+    describe ".to_hash( parameters )" do
+
+      before do
+        @parameters = [ WorkflowKit::Parameter.new( key: "first_key", value: "first_value" ),
+                        WorkflowKit::Parameter.new( key: "second_key", value: "second_value" ) ]
+      end
+      
+      subject { WorkflowKit::Parameter.to_hash }
+
+      it "should return a hash of parameters" do
+        WorkflowKit::Parameter.to_hash( @parameters ).should ==
+          { first_key: "first_value", second_key: "second_value" }
+      end
+
+    end
+
+  end
+
+end

data/spec/models/parameterable_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe WorkflowKit::Parameterable do
+  
+  describe "Class" do
+
+    subject { WorkflowKit::Workflow } # since this class extends WorkflowKit::Parameterable
+
+    it { should respond_to ( :has_many_parameters ) }
+
+  end
+
+  describe "Instance" do
+
+    before do 
+      @parameterable = WorkflowKit::Workflow.new # since workflows as parameterable, i.e. can have parameters
+      @parameterable.parameters = { test_key: "test_value" }
+    end
+    subject { @parameterable }
+
+    describe "#parameters" do
+      subject { @parameterable.parameters }
+      it { should be_kind_of( Array ) }
+      its( :first ) { should be_kind_of WorkflowKit::Parameter }
+      its( 'first.key' ) { should == :test_key }
+      its( 'first.value' ) { should == "test_value" }
+    end
+
+    describe "#parameters_to_hash" do
+      subject { @parameterable.parameters_to_hash }
+      it { should be_kind_of( Hash ) }
+      it { should == { test_key: "test_value" } }
+    end
+
+    describe "#parameter_hash" do
+      subject { @parameterable.parameter_hash } 
+      it { should == @parameterable.parameters_to_hash }
+    end
+
+    describe "#parameters=" do 
+      it "should transform a parameter hash into WorkflowKit::Parameter objects" do
+        @parameterable.parameters = { first_key: "first_value", second_key: "second_value" }
+        @parameterable.parameters.should be_kind_of( Array )
+        @parameterable.parameters.first.should be_kind_of( WorkflowKit::Parameter )
+        @parameterable.parameters.first.key.should == :first_key
+      end
+      it "should also accept WorkflowKit::Parameter objects" do
+        @parameterable.parameters = 
+          [ WorkflowKit::Parameter.new( key: :first_key, value: "first_value" ) ]
+        @parameterable.parameters.should be_kind_of( Array )
+        @parameterable.parameters.first.should be_kind_of( WorkflowKit::Parameter )
+        @parameterable.parameters.first.key.should == :first_key
+      end
+    end
+    
+  end
+
+end

data/spec/models/step_spec.rb

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe WorkflowKit::Step do
+
+  before do
+    @workflow = create_workflow # in spec/support/factory.rb
+    @step = @workflow.steps.first
+  end
+
+  subject { @step }
+
+  it { should respond_to( :sequence_index ) }
+  it { should respond_to( :sequence_index= ) }
+  it { should respond_to( :brick_name ) }
+  it { should respond_to( :brick_name= ) }
+  it { should respond_to( :parameters ) }
+
+  describe "#workflow" do
+    subject { @step.workflow }
+    it { should == @workflow }
+  end
+
+  describe "#execute" do
+    subject { @step.execute }
+    it "should execute the step" do
+      subject.should ==
+        "Fill a large pot with water, put it on a cooker and wait until a temperature of 100 °C is reached."
+    end
+  end
+  
+  describe "#brick" do
+    subject { @step.brick }
+    it { should be_kind_of( WorkflowKit::Brick ) }
+  end
+
+end
+
+

data/spec/models/workflow_spec.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe WorkflowKit::Workflow do
+
+  before { @workflow = WorkflowKit::Factory.create_workflow } # in spec/support/factory.rb
+  subject { @workflow }
+
+  for method in [ :name, :name=, :description, :description= ]
+    it { should respond_to( method ) }
+  end
+
+  describe "#steps" do
+    subject { @workflow.steps }
+    it "should list the sequence entries" do
+      subject.count.should == 3
+    end
+    it { should be_kind_of( Array ) }
+    its( :first ) { should be_kind_of( WorkflowKit::Step ) }
+  end
+
+  describe "#execute" do
+
+    it "should produce the proper recipe" do # according to spec/support/factory.rb
+      subject.execute.join( " " ).should ==
+        "Fill a large pot with water, put it on a cooker and wait until a temperature of 100 °C is reached. " +
+        "Add spaghetti and boil them for 10 minutes. Sieve spaghetti, put them on a plate, and serve them with " +
+        "some yummy ham-cheese-cream sauce."
+    end
+
+    it "should accept a parameter hash" do
+      subject.execute( a: 1, b: 2, c: "3" ).should_not be_nil
+    end
+
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+
+require File.expand_path("../../test/dummy/config/environment", __FILE__)
+
+require 'workflow_kit'
+require 'rails/all'
+
+require 'rspec/rails'
+require 'rspec/autorun'
+
+require 'support/factory'   
+include WorkflowKit::Factory
+
+#require '../app/models/workflow_kit/parameterable'
+
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+end

data/spec/support/factory.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+module WorkflowKit
+  module Factory
+
+    def create_workflow
+      workflow = Workflow.create( name: "Cook Spaghetti",
+                                  description: "An example workflow to demonstrate how to use workflows in the `workflow_kit` gem." )
+
+      workflow.steps.create( brick_name: "BoilWaterBrick", parameters: { :aim_temperature => '100 °C' } )
+      workflow.steps.create( brick_name: "BoilSpaghettiBrick", parameters: { :time_to_boil => '10 minutes' } )
+      workflow.steps.create( brick_name: "ServeSpaghettiBrick" )
+
+      return workflow
+    end
+
+  end
+
+  class BoilWaterBrick < Brick
+    def description
+      "Fill a large pot with water, put it on a cooker " +
+        "and wait until the given temperature is reached."
+    end
+    def execute( params )
+      return self.description
+        .gsub( "the given temperature", "a temperature of " + params[ :aim_temperature ] )
+    end
+  end
+
+  class BoilSpaghettiBrick < Brick
+    def description
+      "Add spaghetti and boil them for the given time."
+    end
+    def execute( params )
+      return self.description
+        .gsub( "the given time", params[ :time_to_boil ] )
+    end
+  end
+
+  class ServeSpaghettiBrick < Brick
+    def description
+      "Sieve spaghetti, put them on a plate, and serve them with " +
+        "some yummy ham-cheese-cream sauce."
+    end
+    def execute( params )
+      return self.description
+    end
+  end
+
+end