stonepath 0.0.3 → 0.0.4

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/stonepath/group.rb

@@ -1,3 +1,12 @@
+# This is a concept that existed in the older Journeyman workflow engine, but I'm not sure
+# that StonePath needs it.  It is proving more worthwhile to ust rely on any number of other
+# active_record models for providing group functionality, and you can see this id pretty much
+# an empty stub.
+
+# Groups were another aggregation of work much like users were.  With the general concept of
+# WorkBench, I think this will be leaving the framework soon.
+# -db!
+
 module StonePath
   module Group
     def self.included(base)

data/lib/stonepath/role.rb

@@ -1,3 +1,7 @@
+# This is a concept that existed in the older Journeyman workflow engine, but I'm not sure
+# that StonePath needs it.  It is proving more worthwhile to ust rely on any number of other
+# gems for providing role functionality, and you can see this id pretty much an empty stub.
+
 module StonePath
   module Role
     def self.included(base)

data/lib/stonepath/task.rb

@@ -1,11 +1,21 @@
+# A Task in this framework is simply a relation between a workitem and a workbench.  It has
+# some default workflow, and should be extended with whatever attributes make sense for the
+# business domain you are modeling.
+
 module StonePath
   module SPTask
     
+    # This will move from here shortly, into another class/module for containing things like this.
+    # This is the workflow definition for a default task.  This is defined this way so that users
+    # can provide their own task workflow definition as a block to the stonepath_task declaration.
+    # This lanbda is passed in if the user doesn't provide anything.
+    # It is possible that we will identify other useful options and want to provide them as config
+    # blocks in the StonePath gem.
     def self.default_config_block
       lambda {
         aasm_initial_state :active
         aasm_state :active, :after_enter => :notify_created
-        aasm_state :completed, :before_enter => :timestamp_complete, :after_enter => :notify_closed
+        aasm_state :completed, :after_enter => [:timestamp_complete, :notify_closed]
         aasm_state :expired, :after_enter => :notify_closed
         aasm_state :cancelled, :after_enter => :notify_closed
 
@@ -31,16 +41,20 @@ module StonePath
       }
     end
     
+    
     def self.included(base)
       base.instance_eval do
       
-        belongs_to :assignee, :polymorphic => true
+        # Tasks are now completely polymorphic between workbenches.
+        # as long as an activerecord model declares itself as a workbench and declares itself
+        # a workbench for the specific kind of task, everything just works.
+        belongs_to :workbench, :polymorphic => true
+        
+        # Tasks are now completely polymorphic between workitems.
+        # as long as an activerecord model declares itself as a workitem and declares itself
+        # a workitem for the specific kind of task, everything just works.
+        belongs_to :workitem, :polymorphic => true
         
-        def task_for(workitem, options={})
-          options.merge!(:class_name => workitem.to_s.classify)
-          belongs_to :workitem, options
-        end
-      
         def audits_transitions
           puts "#{self.class} audits transitions"
         end
@@ -68,7 +82,7 @@ module StonePath
     end
     
     def notify_closed
-     if workitem.respond_to?(:task_closed)
+      if workitem.respond_to?(:task_closed)
         workitem.task_closed(self)
       end
     end

data/lib/stonepath/work_bench.rb

@@ -5,7 +5,7 @@ module StonePath
         def workbench_for(tasks, options={})
           #options.merge!(:foreign_key => :assignee_id)
           #puts options
-          has_many tasks, :as => :assignee
+          has_many tasks, :as => :workbench
         end
       end
     end

data/lib/stonepath/work_item.rb

@@ -1,3 +1,7 @@
+# The WorkItem is the center of this framework.  It is the thing that has a workflow,
+# is the subject of ownership and tasks.  Tis is the place the primaey state machine will
+# exist
+
 module StonePath
   module WorkItem
     def self.included(base)
@@ -9,15 +13,12 @@ module StonePath
           belongs_to :owner, options
         end
         
-        def subject_of(tasks, options={})
-          has_many tasks, options
+        def tasked_through(tasks, options={})
+          has_many tasks, :as => :workitem
         end
         
         def stonepath_acl()
           require File.expand_path(File.dirname(__FILE__)) + "/acl.rb"
-          #require File.expand_path(File.dirname(__FILE__)) + "/acl/acl.rb"
-          #require File.expand_path(File.dirname(__FILE__)) + "/acl/acl_role.rb"
-          #require File.expand_path(File.dirname(__FILE__)) + "/acl/acl_state.rb"
           cattr_accessor :acl
           self.acl = StonePath::ACL::Controller.new(self)
           yield self.acl
@@ -31,23 +32,32 @@ module StonePath
         class << self
           alias_method "define_attribute_methods_without_hook", "define_attribute_methods"
           alias_method "define_attribute_methods", "define_attribute_methods_with_hook"
+        end    
+      end #base.instance_eval
+
+      def allowed?(method)
+        acl.allowed?(aasm_current_state, current_user, method)
+      end
+      
+      # modifies to_xml do that it includes all the possible events from this state.
+      # useful when you are using WorkItems as resources with ActiveResource
+      def to_xml_with_events
+        to_xml_without_events do |xml|
+          xml.aasm_events_for_current_state(:type=>"array") do
+            aasm_events_for_current_state.each do |e|
+              xml.aasm_event do
+                xml.name e.to_s
+              end
+            end
+          end
         end
       end
       
-      def allowed?(method)
-        acl.allowed?(aasm_current_state, current_user, method)
+      base.instance_eval do
+        alias_method_chain :to_xml, :events      
       end
       
-    end
+    end #self.included
+    
   end
-end
-
-
-# if table_exists? <workitem>_transition_log_entries
-#define  WorkItem::TransitionLogEntry
-# then for each transition method, have an after proc that
-# creates workitem_transition_log
-# workitem_id
-# transitioned_to
-# transitioned_by
-# transitioned_at
+end

data/lib/stonepath/work_owner.rb

@@ -1,3 +1,10 @@
+# every WorkItem has one and exactly one owner.  In some domains, WorkOwners and WorkBenches will
+# be the same thing, but in other domains they are separate concepts.  the owner is 'responsible'
+# for the WorkItem in a larger sense - but the WorkBenches are 'responsible' for the completion of
+# tasks associated with the WorkItem.
+#
+# This separation allows workflows where the owner assigns out work, and may oe may not be
+# responsible for the actual completion of the work.
 module StonePath
   module WorkOwner
     def self.included(base)

data/stonepath.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stonepath}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Bock"]
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
      "script/destroy",
      "script/generate",
      "stonepath.gemspec",
+     "stonepath.pdf",
      "test/acl_test.rb",
      "test/app_root/app/controllers/application_controller.rb",
      "test/app_root/app/models/assignment.rb",

data/test/app_root/app/models/assignment.rb

@@ -3,7 +3,7 @@ class Assignment < ActiveRecord::Base
   
   stonepath_task
   
-  task_for :case
+  #task_for :case
   
   audits_transitions
   

data/test/app_root/app/models/case.rb

@@ -18,7 +18,7 @@ class Case < ActiveRecord::Base
   end
   
   owned_by :user
-  subject_of :assignments
+  tasked_through :assignments
   
   
   
@@ -63,5 +63,17 @@ class Case < ActiveRecord::Base
      end
    end
    
+
+   def task_created(task)
+     self.notification_method = "created"
+     self.notified_id = task.id
+     self.save
+   end
    
+   def task_closed(task)
+     self.notification_method = "closed"
+     self.notified_id = task.id
+     self.save
+   end
+
 end

data/test/app_root/app/models/custom_assignment.rb

@@ -17,6 +17,5 @@ class CustomAssignment < ActiveRecord::Base
     end
   end
   
-  task_for :case
   
 end

data/test/app_root/db/migrate/02_create_assignments.rb

@@ -3,8 +3,12 @@ class CreateAssignments < ActiveRecord::Migration
   def self.up
     create_table :assignments do |t|
       t.string :aasm_state
-      t.integer :case_id
+      t.integer :workitem_id
+      t.string :workitem_type
+      t.integer :workbench_id
+      t.string :workbench_type
       t.datetime :completed_at
+      t.datetime :due_at
       t.timestamps
     end
   end

data/test/app_root/db/migrate/03_create_cases.rb

@@ -5,6 +5,8 @@ class CreateCases < ActiveRecord::Migration
       t.string :name
       t.string :regarding
       t.string :aasm_state
+      t.string :notification_method
+      t.integer :notified_id
       t.timestamps
     end
   end

data/test/task_test.rb

@@ -1,5 +1,7 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
+require 'flexmock/test_unit'
+
 class TaskTest < Test::Unit::TestCase
 
   def setup
@@ -38,6 +40,51 @@ class TaskTest < Test::Unit::TestCase
     assert_equal("expired", a.aasm_state)
   end
   
+  should "be overdue? if due_at is in the past" do
+     c = Case.create
+     a = c.assignments.create(:due_at => 1.week.ago)
+     assert(a.overdue?)
+   end
+   
+  should "be able to set up the relationship between a case and an assignment" do
+    c = Case.create
+    a = c.assignments.create
+    assert_equal(a, c.assignments[0])
+    assert_equal(c, c.assignments[0].workitem)
+  end
+  
+  should "be able to set up the relationship between a user (as a workbench) and an assignment" do
+    u = User.create
+    c = Case.create
+    a = c.assignments.create(:workbench => u)
+    
+    assert_equal(a, u.assignments[0])
+    assert_equal(u, a.workbench)
+  end
+  
+  # This whole event notification thing is ugly.
+  # Putting aside the ugly way I tested this, the whole AASM callback mechanism
+  # has a problem that the id isn't set after the callback from a create.
+  # Looking at the code of aasm, I cannot easily figure out why.
+  should "callback the workitem when a task is created" do
+    c = Case.create
+    cid = c.id
+    a = c.assignments.create
+    c = Case.find cid
+    assert_equal("created", c.notification_method)
+    #assert_equal(a.id, c.notified_id)
+  end
+  
+  should "callback the workitem when a task is completed" do
+    c = Case.create
+    cid = c.id
+    a = c.assignments.create
+    a.complete!
+    c = Case.find cid
+    assert_equal("closed", c.notification_method)
+    #assert_equal(a.id, c.notified_id)
+  end
+  
 end
 
 

data/test/workitem_test.rb

@@ -8,4 +8,10 @@ class WorkitemTest < Test::Unit::TestCase
   should "not do much of anything yet" do
     c = Case.new
   end
+  
+  should "contain xml for the possible events" do
+    c = Case.create
+    xml = c.to_xml
+    assert(xml.include?("<aasm_events_for_current_state type=\"array\">"))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stonepath
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - David Bock
@@ -57,6 +57,7 @@ files:
 - script/destroy
 - script/generate
 - stonepath.gemspec
+- stonepath.pdf
 - test/acl_test.rb
 - test/app_root/app/controllers/application_controller.rb
 - test/app_root/app/models/assignment.rb