workflowable 1.0

data/db/migrate/20140406195941_create_workflowable_workflows.rb

@@ -0,0 +1,25 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+class CreateWorkflowableWorkflows < ActiveRecord::Migration
+  def change
+    create_table :workflowable_workflows do |t|
+      t.string :name
+      t.integer :initial_stage
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140407170846_create_workflowable_stages.rb

@@ -0,0 +1,25 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+class CreateWorkflowableStages < ActiveRecord::Migration
+  def change
+    create_table :workflowable_stages do |t|
+      t.string :name
+      t.references :workflow, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140407184821_rename_workflow_initial_stage_to_initial_stage_id.rb

@@ -0,0 +1,20 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+class RenameWorkflowInitialStageToInitialStageId < ActiveRecord::Migration
+  def change
+    rename_column :workflowable_workflows, :initial_stage, :initial_stage_id
+  end
+end

data/db/migrate/20140407191620_create_workflowable_stage_next_steps.rb

@@ -0,0 +1,25 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+class CreateWorkflowableStageNextSteps < ActiveRecord::Migration
+  def change
+    create_table :workflowable_stage_next_steps do |t|
+      t.integer :current_stage_id
+      t.integer :next_stage_id
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140407193057_create_workflowable_stage_actions.rb

@@ -0,0 +1,26 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+class CreateWorkflowableStageActions < ActiveRecord::Migration
+  def change
+    create_table :workflowable_stage_actions do |t|
+      t.references :stage, index: true
+      t.references :action, index: true
+      t.string :event
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140407194247_create_workflowable_actions.rb

@@ -0,0 +1,26 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+class CreateWorkflowableActions < ActiveRecord::Migration
+  def change
+    create_table :workflowable_actions do |t|
+      t.string :name
+      t.text :options
+      t.string :action_plugin
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140408164900_create_workflowable_workflow_actions.rb

@@ -0,0 +1,25 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+class CreateWorkflowableWorkflowActions < ActiveRecord::Migration
+  def change
+    create_table :workflowable_workflow_actions do |t|
+      t.references :workflow, index: true
+      t.references :action, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140708173311_add_order_to_action.rb

@@ -0,0 +1,20 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+class AddOrderToAction < ActiveRecord::Migration
+  def change
+    add_column :workflowable_actions, :position, :integer
+  end
+end

data/db/migrate/20140818062426_add_position_to_stage_action.rb

@@ -0,0 +1,20 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+class AddPositionToStageAction < ActiveRecord::Migration
+  def change
+    add_column :workflowable_stage_actions, :position, :integer
+  end
+end

data/lib/tasks/workflowable_tasks.rake

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

data/lib/workflowable.rb

@@ -0,0 +1,26 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+#require 'workflow/workflowable'
+require 'rails'
+require "workflowable/engine"
+require "workflowable/model_additions"
+require "workflowable/railtie" if defined? Rails
+
+module Workflowable
+
+
+
+end

data/lib/workflowable/actions/action.rb

@@ -0,0 +1,76 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+module Workflowable
+    module Actions
+        class Action
+            NAME = ""
+            OPTIONS = {}
+
+            def initialize(options={}, workflow=nil, object=nil, current_stage=nil, next_stage=nil, user=nil)
+                options ||={}
+                @options = options.with_indifferent_access
+                @workflow = workflow
+                @object = object
+                @current_stage = current_stage
+                @next_stage = next_stage
+                @user = user
+
+                errors = validate_options
+
+                if(errors.present?)
+                    return errors
+                end
+
+            end
+
+            def run
+
+            end
+
+            def self.autocomplete(field_type=nil, value=nil, options={}, workflow=nil, object=nil, current_stage=nil, next_stage=nil, user=nil)
+            end
+
+            def self.name
+                return self::NAME
+            end
+
+            def self.options(options={}, workflow=nil, object=nil, current_stage=nil, next_stage=nil, user=nil)
+
+                return self::OPTIONS.with_indifferent_access.deep_merge(options)
+            end
+
+            def validate_options
+                errors = []
+                current_options = self.class.options(@options, @workflow, @object, @current_stage, @next_stage, @user)
+                begin
+
+                    @options.assert_valid_keys(current_options.keys)
+                rescue ArgumentError=>e
+                    errors << "#{e.message} for action: #{self.class.name}\n"
+                end
+
+                missing_keys = current_options.reject{|k,v| v[:required] != true }.keys - @options.reject{|k,v| v[:value].blank? }.keys
+
+                missing_keys.each do |k|
+                    errors <<  "#{k} is required\n"
+                end
+
+                return errors.blank? ? nil : errors
+            end
+
+        end
+    end
+end

data/lib/workflowable/engine.rb

@@ -0,0 +1,47 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+require 'rubygems'
+require 'rails'
+require 'jquery-rails'
+require 'jbuilder'
+require 'nested_form'
+
+
+module Workflowable
+  class Engine < ::Rails::Engine
+    isolate_namespace Workflowable
+
+
+    config.to_prepare do
+      Dir[File.dirname(__FILE__)+ "/actions/*.rb"].each {|file| require file }
+      Dir[Rails.root + "lib/workflowable/actions/*.rb"].each {|file| require file } if Rails.root
+    end
+
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, :dir => 'spec/support/factories'
+    end
+
+  end
+end
+
+
+
+
+
+
+#ActiveRecord::Base.send :include, Workflowable::Workflow

data/lib/workflowable/model_additions.rb

@@ -0,0 +1,152 @@
+#     Copyright 2014 Netflix, Inc.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+
+require 'active_record/railtie'
+require 'active_support/core_ext'
+
+module Workflowable
+  module ModelAdditions
+    #extend ActiveSupport::Concern
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_workflowable
+        include Workflowable::ModelAdditions::LocalInstanceMethods
+        class_eval do
+          attr_accessor :workflow_options
+          attr_accessor :current_user
+
+          belongs_to :workflow, :class_name => "Workflowable::Workflow"
+          belongs_to :stage, :class_name => "Workflowable::Stage"
+          before_save :set_default_stage
+
+        end
+      end
+    end
+
+    module LocalInstanceMethods
+
+
+
+
+      def next_step_options(next_step, options={}, user=nil, unspecified_only=false)
+        options ||= {}
+
+        if(user.nil? && defined? current_user)
+          user = current_user
+        end
+
+
+
+        if(stage)
+          next_stage = stage.next_steps.find_by_id(next_step)
+        else
+          next_stage = workflow.stages.find_by_id(next_step)
+        end
+
+        if(next_stage)
+          next_stage_options = {}
+          next_stage_options[:global] = workflow.workflow_action_options(options[:global], self, self.stage, next_stage, user)
+          next_stage_options[:before] = next_stage.run_before_options(options[:before], self, self.stage, user)
+          next_stage_options[:after] = stage.run_after_options(options[:after], self, next_stage, user) if stage
+          return next_stage_options
+
+        else
+          return nil
+        end
+
+      end
+
+
+
+      def validate_actions(stage_id, options={}, user=nil)
+        options ||= {}
+        errors=[]
+
+        if(user.nil? && defined? current_user)
+          user = current_user
+        end
+
+        if(stage)
+          new_stage = stage.next_steps.find_by_id(stage_id)
+        else
+          new_stage = workflow.stages.find_by_id(stage_id)
+        end
+
+        if(new_stage)
+          workflow_errors = workflow.validate_action_options(options[:global], self, self.stage, new_stage, user)
+          after_errors = stage.present? ?  stage.validate_after_actions(options[:after], self, new_stage, user) : nil
+          before_errors = new_stage.validate_before_actions(options[:before], self, self.stage, user)
+          errors << workflow_errors if workflow_errors.present?
+          errors << after_errors if after_errors.present?
+          errors << before_errors if before_errors.present?
+
+          if(errors.present?)
+            return errors
+          end
+          return nil
+        else
+          return errors + ["Could not identify next stage"]
+        end
+
+      end
+
+      def set_stage(stage_id, options={}, user=nil)
+        options ||= {}
+        errors=[]
+        if(user.nil? && defined? current_user)
+          user = current_user
+        end
+
+        errors = validate_actions(stage_id, options, user)
+
+        if(errors.present?)
+          return errors
+        end
+
+        if(stage)
+          new_stage = stage.next_steps.find_by_id(stage_id)
+        else
+          new_stage = workflow.stages.find_by_id(stage_id)
+        end
+
+        if(new_stage)
+
+          workflow.run_workflow_actions(options[:global], self, self.stage, new_stage, user)
+          stage.run_after_actions(options[:after], self, new_stage, user) if stage
+          new_stage.run_before_actions(options[:before], self, self.stage, user)
+          update_attributes(stage_id: new_stage.id)
+          return true
+        end
+      end
+
+
+
+      private
+
+      def set_default_stage
+        self.set_stage(workflow.initial_stage_id, self.workflow_options) if (workflow && workflow.initial_stage_id && self.stage.blank?)
+        #self.stage_id = workflow.initial_stage_id
+
+      end
+
+
+
+    end
+  end
+end