stonepath 0.2.0 → 0.3.0

data/README.rdoc

@@ -1,42 +1,20 @@
 = 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.
+State-based workflow for rails.
 
-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.
+UPDATE: The StonePath acl is being pulled out into a separate project called StoneWall.
+Update #2: Rather than reinvent a common wheel, StonePath now relies on the sentient_user gem.
 
+For more information, check out the stonepath.pdf in this same directory.  Stonepath is in real use and under active development, so improved docs will be arriving in this location shortly.
 
-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
+gem install stonepath
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 FIXME full name
+Copyright (c) 2009 David Bock
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -14,6 +14,9 @@ begin
     gemspec.description = "Stateful workflow modeling for Rails"
     gemspec.authors = ["David Bock"]
     gemspec.add_dependency('activerecord','>= 2.0.0')
+    gemspec.add_dependency('aasm','>= 2.1.3')
+    gemspec.add_dependency('sentient_user','>= 0.1.0')
+    
   end
   
     Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/stonepath/config.rb

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

data/lib/stonepath/event_logging.rb

@@ -5,7 +5,7 @@ module StonePath
       has_many :logged_events, :as => :auditable, :class_name => "EventRecord"
 
       define_method :aasm_event_fired do |event_name, old_state_name, new_state_name|
-        current_user_id = current_user && current_user.id
+        current_user_id = User.current
         self.logged_events.create(:event_name => event_name.to_s,
                                   :old_state_name => old_state_name.to_s,
                                   :new_state_name => new_state_name.to_s,

data/lib/stonepath/work_item.rb

@@ -20,27 +20,7 @@ module StonePath
           has_many tasks, :as => :workitem
         end
         
-        def stonepath_acl()
-          require File.expand_path(File.dirname(__FILE__)) + "/acl.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 if defined? self.acl
-        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 #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

data/lib/stonepath.rb

@@ -51,7 +51,6 @@ require "stonepath/config"
 # I want to move these into init.rb, but for some reason, the way rails processes the
 # init.rb chokes on load.  I suspect this is an artificial issue because of the way the
 # embedded test app works.
-load File.expand_path( File.dirname(__FILE__)) + "/stonepath/extensions/activerecordbase.rb"
 load File.expand_path( File.dirname(__FILE__)) + '/stonepath/extensions/action_view.rb'
 
 

data/test/app_root/app/controllers/application_controller.rb

@@ -1,2 +1,8 @@
 class ApplicationController < ActionController::Base
+  include SentientController
+  
+  def current_user
+    nil
+  end
+
 end

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

@@ -1,69 +1,28 @@
 class Case < ActiveRecord::Base
   include StonePath
   
-  stonepath_workitem
+  stonepath_workitem do
   
-  aasm_initial_state :pending
-
-  aasm_state :pending
-  aasm_state :in_process
-  aasm_state :completed
-
-  aasm_event :complete do
-    transitions :to => :completed, :from => :in_process
-  end
-
-  aasm_event :activate do
-    transitions :to => :in_process, :from => :pending
-  end
-  
-  owned_by :user
-  tasked_through :assignments
+    log_events
   
-  
-  
-  stonepath_acl do |acl|
-
-     acl.guard_method :save
-     acl.guard_method :name=
-     acl.guard_method :name
-     acl.guard_method :regarding=
-     acl.guard_method :regarding
+    aasm_initial_state :pending
 
-     acl.method_group :modifiers, [:save, :name=, :regarding=]
-     acl.method_group :accessors, [:name, :regarding]
+    aasm_state :pending
+    aasm_state :in_process
+    aasm_state :completed
 
-     acl.for_state :in_process do |state|
-       state.access_for_role :manager do |role|
-         role.allow_method :name
-       end
+    aasm_event :complete do
+      transitions :to => :completed, :from => :in_process
+    end
 
-       state.access_for_role :peon do |role|
-         role.deny_method :name=
-         role.deny_method :regarding=
-       end
-
-       state.access_for_role :assistant_manager do |role|
-         role.check_method_access :method_symbol do
-           return false
-         end
-       end
-     end
-
-     acl.for_state :completed do |state|
-       state.access_for_role :manager do |role|
-         role.deny_method_group :modifiers
-       end
-
-       state.access_for_role :peon do |role|
-         role.deny_method_group :modifiers
-         role.deny_method_group :accessors
-       end
-
-     end
+    aasm_event :activate do
+      transitions :to => :in_process, :from => :pending
+    end
+  
+    owned_by :user
+    tasked_through :assignments
    end
    
-
    def task_created(task)
      self.notification_method = "created"
      self.notified_id = task.id

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

@@ -0,0 +1,6 @@
+class EventRecord < ActiveRecord::Base
+  belongs_to :auditable, :polymorphic => true  
+  
+  # the user_id field will point to the id of the current_user set by the controller
+  # hack.  feel free to add our own finder here using that.
+end

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

@@ -1,6 +1,7 @@
 class User < ActiveRecord::Base
   include StonePath
-  
+  include SentientUser
+    
   stonepath_workowner
   workowner_for :case
   

data/test/app_root/config/environment.rb

@@ -3,7 +3,8 @@ require File.join(File.dirname(__FILE__), 'boot')
 Rails::Initializer.run do |config|
   
   config.gem "aasm"
-    
+  config.gem "sentient_user"
+  
   config.cache_classes = false
   config.whiny_nils = true
   config.action_controller.session = { :key => "_myapp_session", :secret => "gwirofjweroijger8924rt2zfwehfuiwehb1378rifowenfoqwphf23" }

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

@@ -4,6 +4,7 @@ class CreateCases < ActiveRecord::Migration
     create_table :cases do |t|
       t.string :name
       t.string :regarding
+      t.string :description
       t.string :aasm_state
       t.string :notification_method
       t.integer :notified_id

data/test/app_root/db/migrate/04_create_event_records.rb

@@ -0,0 +1,17 @@
+class CreateEventRecords < ActiveRecord::Migration
+  def self.up
+    create_table :event_records do |t|
+      
+      t.references :auditable, :polymorphic => true
+      t.string :event_name
+      t.string :old_state_name
+      t.string :new_state_name
+      t.integer :user_id  #This will rely on the acl controller hack
+      t.timestamps
+    end
+  end
+
+  def self.down    
+    drop_table :event_records
+  end
+end

data/test/logging_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class LoggingTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  should "not have any log entries for a new case" do
+    c = Case.create
+    assert_equal(0, c.logged_events.size)
+  end
+  
+  should "log when a transition happens" do
+    c = Case.create
+    assert_equal(0, c.logged_events.size)
+    c.activate!
+    assert_equal(1, c.logged_events.size)
+    assert_equal("activate", c.logged_events[0].event_name)
+    assert_equal("pending", c.logged_events[0].old_state_name)
+    assert_equal("in_process", c.logged_events[0].new_state_name)
+    
+    c.complete!
+    assert_equal(2, c.logged_events.size)
+    assert_equal("complete", c.logged_events[1].event_name)
+    assert_equal("in_process", c.logged_events[1].old_state_name)
+    assert_equal("completed", c.logged_events[1].new_state_name)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stonepath
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - David Bock
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-07 00:00:00 -05:00
+date: 2010-02-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: aasm
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sentient_user
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
 description: Stateful workflow modeling for Rails
 email: dbock@codesherpas.com
 executables: []
@@ -38,15 +58,9 @@ files:
 - Rakefile
 - VERSION
 - lib/stonepath.rb
-- lib/stonepath/acl.rb
-- lib/stonepath/acl/controller.rb
-- lib/stonepath/acl/role.rb
-- lib/stonepath/acl/state.rb
 - lib/stonepath/config.rb
-- lib/stonepath/controller_hooks.rb
 - lib/stonepath/event_logging.rb
 - lib/stonepath/extensions/action_view.rb
-- lib/stonepath/extensions/activerecordbase.rb
 - lib/stonepath/extensions/rails_generator_commands.rb
 - lib/stonepath/group.rb
 - lib/stonepath/role.rb
@@ -95,11 +109,11 @@ files:
 - script/destroy
 - script/generate
 - stonepath.pdf
-- test/acl_test.rb
 - test/app_root/app/controllers/application_controller.rb
 - test/app_root/app/models/assignment.rb
 - test/app_root/app/models/case.rb
 - test/app_root/app/models/custom_assignment.rb
+- test/app_root/app/models/event_record.rb
 - test/app_root/app/models/user.rb
 - test/app_root/config/boot.rb
 - test/app_root/config/database.yml
@@ -113,12 +127,14 @@ files:
 - test/app_root/db/migrate/01_create_users.rb
 - test/app_root/db/migrate/02_create_assignments.rb
 - test/app_root/db/migrate/03_create_cases.rb
+- test/app_root/db/migrate/04_create_event_records.rb
 - test/app_root/lib/console_with_fixtures.rb
 - test/app_root/log/.gitignore
 - test/app_root/script/console
 - test/custom_task_test.rb
 - test/fixtures/users.yml
 - test/group_test.rb
+- test/logging_test.rb
 - test/role_test.rb
 - test/stonepath_test.rb
 - test/task_test.rb
@@ -154,11 +170,11 @@ signing_key:
 specification_version: 3
 summary: "Stonepath: stateful workflow modeling for rails"
 test_files: 
-- test/acl_test.rb
 - test/app_root/app/controllers/application_controller.rb
 - test/app_root/app/models/assignment.rb
 - test/app_root/app/models/case.rb
 - test/app_root/app/models/custom_assignment.rb
+- test/app_root/app/models/event_record.rb
 - test/app_root/app/models/user.rb
 - test/app_root/config/boot.rb
 - test/app_root/config/environment.rb
@@ -171,9 +187,11 @@ test_files:
 - test/app_root/db/migrate/01_create_users.rb
 - test/app_root/db/migrate/02_create_assignments.rb
 - test/app_root/db/migrate/03_create_cases.rb
+- test/app_root/db/migrate/04_create_event_records.rb
 - test/app_root/lib/console_with_fixtures.rb
 - test/custom_task_test.rb
 - test/group_test.rb
+- test/logging_test.rb
 - test/role_test.rb
 - test/stonepath_test.rb
 - test/task_test.rb

data/lib/stonepath/acl/controller.rb

@@ -1,88 +0,0 @@
-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?(self, 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?(guarded_object, user, method)
-        return true if (guarded_object.nil? || user.nil? || method.nil?)
-        state = guarded_object.aasm_state
-        roles = user.respond_to?(:roles) ? user.roles : [user.role]
-        roles.each { |role| break [true] if states[state].roles[role].allowed?(guarded_object, method) }.uniq[0]
-      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

@@ -1,64 +0,0 @@
-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 allowed?(guarded_object, method_name)
-        #first, we check to see if it is a checked method.  If it is, we return whatever the check method says
-        guard = checked_methods[method_name.to_s]
-        
-        return guard.call(guarded_object) if guard
-        
-        default_answer = !(Config.acl_default_access == :deny)
-        checklist = default_answer ? denied_methods : allowed_methods
-        checklist.include?(method_name.to_s) ? !default_answer : default_answer
-      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

@@ -1,20 +0,0 @@
-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

@@ -1,3 +0,0 @@
-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/controller_hooks.rb

@@ -1,11 +0,0 @@
-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

@@ -1,7 +0,0 @@
-# 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/test/acl_test.rb

@@ -1,17 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-
-  
-class TestACL < Test::Unit::TestCase
-
-  def setup
-  end
-  
-  context "our sample rails app" do
-    
-    should "include the Group module when declared as a stonepath_group" do
-      assert true
-    end
-  
-  end
-end