stonepath 0.0.2

data/stonepath.gemspec

@@ -0,0 +1,117 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stonepath}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Bock"]
+  s.date = %q{2009-12-17}
+  s.description = %q{Stateful workflow modeling for Rails}
+  s.email = %q{dbock@codesherpas.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "History.txt",
+     "Manifest.txt",
+     "PostInstall.txt",
+     "README.rdoc",
+     "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/extensions/activerecordbase.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",
+     "rails_generators/stonepath/stonepath_audit_table_generator.rb",
+     "rails_generators/stonepath/stonepath_task_generator.rb",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "stonepath.gemspec",
+     "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/user.rb",
+     "test/app_root/config/boot.rb",
+     "test/app_root/config/database.yml",
+     "test/app_root/config/environment.rb",
+     "test/app_root/config/environments/in_memory.rb",
+     "test/app_root/config/environments/mysql.rb",
+     "test/app_root/config/environments/postgresql.rb",
+     "test/app_root/config/environments/sqlite.rb",
+     "test/app_root/config/environments/sqlite3.rb",
+     "test/app_root/config/routes.rb",
+     "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/lib/console_with_fixtures.rb",
+     "test/app_root/log/.gitignore",
+     "test/app_root/script/console",
+     "test/fixtures/users.yml",
+     "test/group_test.rb",
+     "test/role_test.rb",
+     "test/stonepath_test.rb",
+     "test/test_helper.rb",
+     "test/workitem_test.rb",
+     "test/workowner_test.rb"
+  ]
+  s.homepage = %q{http://github.com/bokmann/stonepath}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Stonepath: stateful workflow modeling for rails}
+  s.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/user.rb",
+     "test/app_root/config/boot.rb",
+     "test/app_root/config/environment.rb",
+     "test/app_root/config/environments/in_memory.rb",
+     "test/app_root/config/environments/mysql.rb",
+     "test/app_root/config/environments/postgresql.rb",
+     "test/app_root/config/environments/sqlite.rb",
+     "test/app_root/config/environments/sqlite3.rb",
+     "test/app_root/config/routes.rb",
+     "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/lib/console_with_fixtures.rb",
+     "test/group_test.rb",
+     "test/role_test.rb",
+     "test/stonepath_test.rb",
+     "test/test_helper.rb",
+     "test/workitem_test.rb",
+     "test/workowner_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+  end
+end
+

data/test/acl_test.rb

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

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

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

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

@@ -0,0 +1,11 @@
+class Assignment < ActiveRecord::Base
+  include StonePath
+  
+  stonepath_task
+  
+  task_for :case
+  assigns_to :user
+  
+  audits_transitions
+  
+end

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

@@ -0,0 +1,67 @@
+class Case < ActiveRecord::Base
+  include StonePath
+  
+  stonepath_workitem
+  
+  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
+  subject_of :assignment
+  
+  
+  
+  stonepath_acl do |acl|
+
+     acl.guard_method :save
+     acl.guard_method :name=
+     acl.guard_method :name
+     acl.guard_method :regarding=
+     acl.guard_method :regarding
+
+     acl.method_group :modifiers, [:save, :name=, :regarding=]
+     acl.method_group :accessors, [:name, :regarding]
+
+     acl.for_state :in_process do |state|
+       state.access_for_role :manager do |role|
+         role.allow_method :name
+       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
+   end
+   
+   
+end

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

@@ -0,0 +1,10 @@
+class User < ActiveRecord::Base
+  include StonePath
+  
+  stonepath_workowner
+  workowner_for :case
+  
+  stonepath_workbench
+  workbench_for :assignments
+  
+end

data/test/app_root/config/boot.rb

@@ -0,0 +1,114 @@
+# Allow customization of the rails framework path
+RAILS_FRAMEWORK_ROOT = (ENV['RAILS_FRAMEWORK_ROOT'] || "#{File.dirname(__FILE__)}/../../../../../../vendor/rails") unless defined?(RAILS_FRAMEWORK_ROOT) 
+
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?(RAILS_FRAMEWORK_ROOT)
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_FRAMEWORK_ROOT}/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+ 
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          environment_rb = "#{RAILS_ROOT}/config/environment.rb"
+          environment_rb = "#{HELPER_RAILS_ROOT}/config/environment.rb" unless File.exists?(environment_rb)
+          File.read(environment_rb)
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/app_root/config/database.yml

@@ -0,0 +1,21 @@
+in_memory:
+  adapter: sqlite3
+  database: ":memory:"
+  verbosity: quiet
+sqlite:
+  adapter: sqlite
+  dbfile: plugin_test.sqlite.db
+sqlite3:
+  adapter: sqlite3
+  dbfile: plugin_test.sqlite3.db
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: plugin_test
+mysql:
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: plugin_test

data/test/app_root/config/environment.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  config.cache_classes = false
+  config.whiny_nils = true
+  config.action_controller.session = { :key => "_myapp_session", :secret => "gwirofjweroijger8924rt2zfwehfuiwehb1378rifowenfoqwphf23" }
+  config.plugin_locators.unshift(
+    Class.new(Rails::Plugin::Locator) do
+      def plugins
+        [Rails::Plugin.new(File.expand_path('.'))]
+      end
+    end
+  ) unless defined?(PluginTestHelper::PluginLocator)
+end

data/test/app_root/config/routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/test/app_root/db/migrate/01_create_users.rb

@@ -0,0 +1,15 @@
+class CreateUsers < ActiveRecord::Migration
+
+  def self.up
+    create_table :users do |t|
+      t.string :name
+      t.string :role
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+  
+end

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

@@ -0,0 +1,13 @@
+class CreateAssignments < ActiveRecord::Migration
+
+  def self.up
+    create_table :assignments do |t|
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :assignments
+  end
+  
+end

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

@@ -0,0 +1,15 @@
+class CreateCases < ActiveRecord::Migration
+
+  def self.up
+    create_table :cases do |t|
+      t.string :name
+      t.string :regarding
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :cases
+  end
+  
+end

data/test/app_root/lib/console_with_fixtures.rb

@@ -0,0 +1,4 @@
+# Loads fixtures into the database when running the test app via the console
+(ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(Rails.root, '../fixtures/*.{yml,csv}'))).each do |fixture_file|
+  Fixtures.create_fixtures(File.join(Rails.root, '../fixtures'), File.basename(fixture_file, '.*'))
+end

data/test/app_root/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/test/app_root/script/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+irb = 'irb'
+libs =  " -r irb/completion"
+libs << " -r test/test_helper"
+libs << " -r console_app"
+libs << " -r console_with_helpers"
+libs << " -r console_with_fixtures"
+exec "#{irb} #{libs} --simple-prompt"

data/test/fixtures/users.yml

@@ -0,0 +1,7 @@
+Dave:
+  name: David Bock
+  role: peon
+  
+Kim:
+  name: Kim MacCormack
+  role: manager

data/test/group_test.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+  
+class GroupTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  should "include the Group module when declared as a stonepath_group" do
+    assert Group.included_modules.include?(StonePath::Group)
+  end
+end
+
+
+class Group
+  include StonePath
+  
+  stonepath_group
+end

data/test/role_test.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+  
+class RoleTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  should "include the Role module when declared as a stonepath_role" do
+    assert Role.included_modules.include?(StonePath::Role)
+  end
+end
+
+
+class Role
+  include StonePath
+  
+  stonepath_role
+end

data/test/stonepath_test.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class StonepathTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  should "pass without hassle" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+# Set the default environment to sqlite3's in_memory database
+ENV['RAILS_ENV'] ||= 'in_memory'
+
+require 'rubygems'
+require 'stringio'
+require 'test/unit'
+require 'flexmock/test_unit'
+require 'AASM'
+require File.dirname(__FILE__) + '/../lib/stonepath'
+
+
+# Load the Rails environment and testing framework
+require "#{File.dirname(__FILE__)}/app_root/config/environment"
+require 'test_help'
+require 'action_view/test_case' # Load additional test classes not done automatically by < Rails 2.2.2
+
+require "shoulda"
+
+# Undo changes to RAILS_ENV
+silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
+
+# Set default fixture loading properties
+ActiveSupport::TestCase.class_eval do
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures = false
+  self.fixture_path = "#{File.dirname(__FILE__)}/fixtures"
+end
+

data/test/workitem_test.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class WorkitemTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  should "not do much of anything yet" do
+    c = Case.new
+  end
+end

data/test/workowner_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class WorkownerTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  should "include the WorkOwner module when declared as a stonepath_workowner" do
+    assert Workowner.included_modules.include?(StonePath::WorkOwner)
+  end
+  
+  should "create a new user successfully" do
+    u = User.create
+  end
+end
+
+
+class Workowner < ActiveRecord::Base
+  include StonePath
+  
+  stonepath_workowner
+  
+  workowner_for :work_items
+  
+end