stonepath 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-08-09
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/stonepath.rb
+lib/stonepath/acl.rb
+lib/stonepath/config.rb
+lib/stonepath/controller_hooks.rb
+lib/stonepath/group.rb
+lib/stonepath/role.rb
+lib/stonepath/task.rb
+lib/stonepath/work_bench.rb
+lib/stonepath/work_item.rb
+lib/stonepath/work_owner.rb
+lib/stonepath/acl/controller.rb
+lib/stonepath/acl/role.rb
+lib/stonepath/acl/state.rb
+lib/stonepath/extensions/activerecordbase.rb
+rails_generators/stonepath/stonepath_task_generator.rb
+rails_generators/stonepath/stonepath_audit_table_generator.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_stonepath.rb

data/PostInstall.txt

@@ -0,0 +1,2 @@
+Dave Bock is Awesome.
+

data/README.rdoc

@@ -0,0 +1,58 @@
+= stonepath
+
+Wednesday, August 25th UPDATE:
+The extraction is underway, and I have to write some generators to have some stuff make sense outside the scope of a real application.
+
+I'm going to have a good article on the stomepath modeling methodology shortly.  It is written, it just needs diagrams and an editor's touch.
+
+
+Sunday, August 9th UPDATE:
+Sorry for the delay.  I just gave this talk again at eRubyCon.
+
+Some of these stateful workflow ideas are being used in a project for the
+DC Public School System, but the data store there is unconventional (a
+QuickBase database online), so the work being done on StonePath has taken a
+back seat.  I expect this project to be live again shortly, starting simply
+with some wiki entries explaining the same concepts that I outline in the
+presentation (including WorkItem, Ownership, Assignment, Task, Permissions, and
+organizational modeling with groups and roles).
+
+---
+
+This is a Stateful Workflow gem that is currently being pulled out of a 
+real-world client project.  I'm creating the repository before RailsConf 2009
+so interested people that attend my talk can watch and contribute.
+
+I'm also asking you to keep me honest - this extraction is real, but is likely
+to take a back seat to real billable client time.  If I know there is interest
+(that is, if I see followers and if they nag me), this project is likely to get
+time over others.
+
+
+
+gem install bokmann-stonepath
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,44 @@
+require 'rake'
+require 'rake/testtask'
+require 'rcov/rcovtask'
+require 'shoulda/tasks'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "stonepath"
+    gemspec.summary = "Stonepath: stateful workflow modeling for rails"
+    gemspec.description = "Stonepath: stateful workflow modeling for rails"
+    gemspec.email = "dbock@codesherpas.com"
+    gemspec.homepage = "http://github.com/bokmann/stonepath"
+    gemspec.description = "Stateful workflow modeling for Rails"
+    gemspec.authors = ["David Bock"]
+    gemspec.add_dependency('activerecord','>= 2.0.0')
+  end
+  
+    Jeweler::GemcutterTasks.new
+    
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+ 
+ 
+Rcov::RcovTask.new do |t|
+  #t.libs << "test"
+  #t.test_files = FileList['./test/**/test*.rb']
+  #t.verbose = true
+
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+  #t.rcov_opts << "--no-color"
+  #t.rcov_opts << "--save coverage.info"
+  t.rcov_opts << "-x ^/"
+end
+
+task :default => :rcov

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/stonepath/acl/controller.rb

@@ -0,0 +1,86 @@
+module StonePath
+  module ACL
+    class Controller
+
+      attr_reader :guarded_class_methods
+      attr_reader :guarded_instance_methods
+      attr_reader :states
+      attr_reader :guarded_class
+      attr_reader :method_groups
+
+
+
+      def initialize(guarded_class)
+        @guarded_class = guarded_class
+        @guarded_methods = Array.new
+        @states = Hash.new
+        @method_groups = Hash.new
+        @aliases = Array.new
+      end
+
+      def guard_method(method)
+        @guarded_methods << method
+        checked_method = checked_method_name(method)
+        unchecked_method = unchecked_method_name(method)
+
+        guarded_class.send(:define_method, checked_method) do |*args|
+          if acl.allowed?(aasm_current_state, current_user, method)
+            self.send(unchecked_method, *args)
+          elsif StonePath::Config.acl_failure_mode == :exception
+            raise "Access Violation"
+          end
+        end
+
+        # Save our needed aliases until later
+        @aliases << [unchecked_method, method]
+        @aliases << [method, checked_method]
+      end
+
+      # fix up our saved aliases
+      def fix_aliases
+        @aliases.each do |src, target|
+          guarded_class.send(:alias_method, src, target)
+        end
+      end
+
+
+      def method_group(name, methods)
+        @method_groups[name] = methods
+      end
+
+      def for_state(state_name)
+        @states[state_name] = State.new(state_name, self) if @states[state_name].nil?
+        yield @states[state_name]
+      end
+
+      def allowed?(state, user, method)
+        puts "allowed called: #{state}, #{user}, #{method}"
+        return true
+      end
+
+      private
+
+      # TODO
+      # these two methods are ugly - we need to dry up the repetition and make them work for ? methods.    
+      def checked_method_name(method)
+        method_name = method.to_s
+        if method_name.include?("=")
+          method_name.gsub!("=","")
+          return "#{method_name}_with_check="
+        else
+          return "#{method_name}_with_check"
+        end
+      end
+
+      def unchecked_method_name(method)
+        method_name = method.to_s
+        if method_name.include?("=")
+          method_name.gsub!("=","")
+          return "#{method_name}_without_check="
+        else
+          return "#{method_name}_without_check"
+        end
+      end
+    end
+  end
+end

data/lib/stonepath/acl/role.rb

@@ -0,0 +1,53 @@
+module StonePath
+  module ACL
+    class Role
+      attr_reader :name
+      attr_reader :parent_state
+      attr_reader :allowed_methods
+      attr_reader :denied_methods
+      attr_reader :checked_methods
+
+      def initialize(name, parent_state)
+        @name = name
+        @parent_state = parent_state
+        @allowed_methods = Array.new
+        @denied_methods = Array.new
+        @checked_methods = Hash.new
+      end
+
+      def parent_acl
+        @parent_state.parent_acl
+      end
+
+      def deny_method(method)
+        @denied_methods << method
+      end
+
+      def allow_method(method)
+        @allowed_methods << method
+      end
+
+      def check_method_access(method, &check)
+        @checked_methods[method] = check
+      end
+
+      def deny_method_group(group)
+        parent_acl.method_groups[group].each do |method|
+          deny_method(method)
+        end
+      end
+
+      def allow_method_group(method_group)
+        parent_acl.method_groups[group].each do |method|
+          allow_method(method)
+        end
+      end
+
+      def check_method_group_access(method_group, &check)
+        parent_acl.method_groups[group].each do |method|
+          check_method_access(check)
+        end
+      end
+    end
+  end
+end

data/lib/stonepath/acl/state.rb

@@ -0,0 +1,20 @@
+module StonePath
+  module ACL
+    class State
+      attr_reader :name
+      attr_reader :roles
+      attr_reader :parent_acl
+
+      def initialize(name, parent_acl)
+        @name = name
+        @parent_acl = parent_acl
+        @roles = Hash.new
+      end
+
+      def access_for_role(role_name)
+        @roles[role_name] = Role.new(role_name, self) if @roles[role_name].nil?
+        yield @roles[role_name]
+      end
+    end
+  end
+end

data/lib/stonepath/acl.rb

@@ -0,0 +1,3 @@
+require File.expand_path(File.dirname(__FILE__)) + "/acl/controller.rb"
+require File.expand_path(File.dirname(__FILE__)) + "/acl/role.rb"
+require File.expand_path(File.dirname(__FILE__)) + "/acl/state.rb"

data/lib/stonepath/config.rb

@@ -0,0 +1,6 @@
+module StonePath
+  class Config
+    cattr_accessor :acl_failure_mode
+    cattr_accessor :acl_default_access
+  end
+end

data/lib/stonepath/controller_hooks.rb

@@ -0,0 +1,11 @@
+module StonePath
+  module ControllerHooks
+    def self.included(base)
+      base.instance_eval do
+        before_filter do |c|
+          ActiveRecord::Base.current_user = current_user
+        end 
+      end
+    end
+  end
+end

data/lib/stonepath/extensions/activerecordbase.rb

@@ -0,0 +1,7 @@
+# for the ACL stuff to work, models need to know who the current user is.
+# This adds a current_user to ActiveRecord
+unless ActiveRecord::Base.respond_to?(:current_user)
+  class ActiveRecord::Base
+    cattr_accessor :current_user
+  end
+end

data/lib/stonepath/group.rb

@@ -0,0 +1,9 @@
+module StonePath
+  module Group
+    def self.included(base)
+      base.instance_eval do
+        
+      end
+    end
+  end
+end

data/lib/stonepath/role.rb

@@ -0,0 +1,9 @@
+module StonePath
+  module Role
+    def self.included(base)
+      base.instance_eval do
+
+      end
+    end
+  end
+end

data/lib/stonepath/task.rb

@@ -0,0 +1,76 @@
+module StonePath
+  module SPTask
+    def self.included(base)
+      base.instance_eval do
+        
+        def assigns_to(workbench)
+          belongs_to :assignee, :class_name => workbench.to_s.classify
+        end
+      
+        def task_for(workitem)
+          #belongs_to :workitem, :polymorphic => true
+          belongs_to :workitem, :class_name => workitem.to_s.classify
+        end
+      
+        def audits_transitions
+          puts "#{self.class} audits transitions"
+        end
+                
+        include AASM
+
+        #we must be attached to a workitem.
+        validates_presence_of :workitem
+        
+        # We can have unassigned tasks.
+        #validates_presence_of :assignee
+        
+        aasm_initial_state :active
+
+
+        aasm_state :active, :after_enter => :notify_created
+        aasm_state :completed, :before_enter => :timestamp_complete, :after_enter => :notify_closed
+        aasm_state :expired, :after_enter => :notify_closed
+        aasm_state :cancelled, :after_enter => :notify_closed
+
+
+        aasm_event :complete do
+          transitions :to => :completed, :from => :active
+        end
+
+        aasm_event :cancel do
+          transitions :to => :cancelled, :from => [:active, :completed]
+        end
+
+        aasm_event :expire do
+          transitions :to => :expired, :from => :active
+        end
+
+        named_scope :unassigned, lambda { { :conditions => ['assignee_id IS NULL'] } }
+        named_scope :active, lambda { { :conditions => ['aasm_state in (?)', ['active']] } }
+        named_scope :overdue, lambda { { :conditions => ['aasm_state in (?) AND due_at < ?',  ['active'], Time.now] } }
+        
+        
+      end
+    end
+    
+        private
+        
+        def timestamp_complete
+          self.completed_at = Time.now
+        end
+        
+        def notify_created
+          if workitem.respond_to?(:task_created)
+            workitem.task_created(self)
+          end
+        end
+        
+        def notify_closed
+         if workitem.respond_to?(:task_closed)
+            workitem.task_closed(self)
+          end
+        end
+        
+
+  end
+end

data/lib/stonepath/work_bench.rb

@@ -0,0 +1,11 @@
+module StonePath
+  module WorkBench
+    def self.included(base)
+      base.instance_eval do
+        def workbench_for(tasks)
+          has_many tasks, :foreign_key => :assignee_id
+        end
+      end
+    end
+  end
+end

data/lib/stonepath/work_item.rb

@@ -0,0 +1,52 @@
+module StonePath
+  module WorkItem
+    def self.included(base)
+      base.instance_eval do
+        include AASM
+        
+        def owned_by(owner)
+          belongs_to :owner, :class_name => owner.to_s.classify
+        end
+        
+        def subject_of(tasks)
+          has_many tasks
+        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
+        end
+        
+        def self.define_attribute_methods_with_hook
+          define_attribute_methods_without_hook
+          acl.fix_aliases
+        end
+        
+        class << self
+          alias_method "define_attribute_methods_without_hook", "define_attribute_methods"
+          alias_method "define_attribute_methods", "define_attribute_methods_with_hook"
+        end
+      end
+      
+      def allowed?(method)
+        acl.allowed?(aasm_current_state, current_user, method)
+      end
+      
+    end
+  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

data/lib/stonepath/work_owner.rb

@@ -0,0 +1,11 @@
+module StonePath
+  module WorkOwner
+    def self.included(base)
+      base.instance_eval do
+        def workowner_for(work_items)
+          has_many work_items
+        end
+      end
+    end
+  end
+end

data/lib/stonepath.rb

@@ -0,0 +1,50 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module StonePath
+  # main hook into the framework.  From here, this should simply have methods that cause other includes to happen.
+  def self.included(base)
+  
+    base.instance_eval {
+  
+      def stonepath_workitem
+        require File.expand_path(File.dirname(__FILE__)) + "/stonepath/work_item.rb"
+        include StonePath::WorkItem
+      end
+    
+      def stonepath_task
+        require File.expand_path(File.dirname(__FILE__)) + "/stonepath/task.rb"
+        include StonePath::SPTask
+      end
+    
+      def stonepath_workbench
+        require File.expand_path(File.dirname(__FILE__)) + "/stonepath/work_bench.rb"
+        include StonePath::WorkBench
+      end
+    
+      def stonepath_group
+        require File.expand_path(File.dirname(__FILE__)) + "/stonepath/group.rb"
+        include StonePath::Group
+      end
+    
+      def stonepath_role
+        require File.expand_path(File.dirname(__FILE__)) + "/stonepath/role.rb"
+        include StonePath::Role
+      end
+      
+      def stonepath_workowner
+        require File.expand_path(File.dirname(__FILE__)) + "/stonepath/work_owner.rb"
+        include StonePath::WorkOwner
+      end
+    }
+  end
+  
+end
+
+require 'rubygems'
+require 'activerecord'
+
+load File.expand_path( File.dirname(__FILE__)) + "/stonepath/extensions/activerecordbase.rb"
+require "stonepath/config"
+
+

data/rails_generators/stonepath/stonepath_audit_table_generator.rb

@@ -0,0 +1,3 @@
+class StonepathAuditTableGenerator < Rails::Generator::Base
+
+end

data/rails_generators/stonepath/stonepath_task_generator.rb

@@ -0,0 +1,3 @@
+class StonepathTaskGenerator < Rails::Generator::Base
+
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/stonepath.rb'}"
+puts "Loading stonepath gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)