stonepath 0.6.1 → 0.6.2

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.2

data/lib/generators/stonepath/task/templates/task.rb

@@ -1,11 +1,53 @@
 class <%= class_name %> < ActiveRecord::Base
   include StonePath
   
-  stonepath_task
+  # prior to stonepath 0.6.2, this definition of task was defined as a 'default' deep
+   # inside of the code to the gem.  This created two problems:
+   #  1- users of the framework didn't realize this was their behavior to change/redefine
+   #  2- the way the reused block was defined broke in ruby 1.9.2
+   #
+   # Putting this in the generated template both solvs the 1.9.2 problem *and* makes it clear 
+   # to end users that this is your behavior to modify as you see fit.
+   #
+   # the default workflow for tasks (upon generation) is:
+   #   [active] -{complete}-> [completed]
+   #            -{expire}-> [expired]
+   #            -{cancel}-> [cancelled]
+   #
+   # you are free to modify that to suit your domain.
+   stonepath_task do
+     aasm_initial_state :active
+     aasm_state :active, :after_enter => :notify_created
+     aasm_state :completed, :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
+
+     scope :unassigned, { :conditions => ['workbench_id IS NULL'] }
+     scope :assigned, { :conditions => ['workbench_id IS NOT NULL'] }
+     scope :active, { :conditions => ['aasm_state in (?)', ['active']] }
+     scope :completed, { :conditions => ['aasm_state in (?)', ['completed']] }
+     scope :expired, { :conditions => ['aasm_state in (?)', ['expired']] }
+     scope :cancelled, { :conditions => ['aasm_state in (?)', ['cancelled']] }
+     scope :overdue, lambda { { :conditions => ['aasm_state in (?) AND due_at < ?',  ['active'], Time.now] } }
+   end
   
-  #log_events  # uncomment this if you generate the event log.
+  # You can log events on Tasks by running the event log generator and uncommenting this line.
+  #log_events
   
-  attr_accessible :workitem, :workbench, <%= attributes.map { |a| ":#{a.name}" }.join(", ") %>
+  attr_accessible :workitem, :workbench <% unless attributes.emoty? %>, <% end %> <%= attributes.map { |a| ":#{a.name}" }.join(", ") %>
   
   # you might think 'overdue' should be a state, but no, part of the stonepath
   # methodology is that states should be as free of time definition as possible.
@@ -17,7 +59,13 @@ class <%= class_name %> < ActiveRecord::Base
   #
   # so the state would be 'in process', even though it is 'overdue'.
   def overdue?
-    (Time.now > due_at) && !self.completed?
+    (Time.now > due_at) && self.active?
+  end
+  
+  private
+  
+  def timestamp_complete
+    self.completed_at = Time.now
   end
   
 end

data/lib/stonepath/task.rb

@@ -4,52 +4,7 @@
 
 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, :enter => :timestamp_complete, :after_enter => :notify_closed
-        # was:
-        #aasm_state :completed, :after_enter => [:timestamp_complete, :notify_closed]
-        # but, from investigations into AASM,
-        # persist is done after :enter but before :after_exit, etc
-        # so fields changed in :after_enter will result in a dirty object that
-        # never gets saved to the DB
-        # WD-rpw / Ashish Tonse 11-16-2010
-
-        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, { :conditions => ['workbench_id IS NULL'] }
-        named_scope :assigned, { :conditions => ['workbench_id IS NOT NULL'] }
-        named_scope :active, { :conditions => ['aasm_state in (?)', ['active']] }
-        named_scope :completed, { :conditions => ['aasm_state in (?)', ['completed']] }
-        named_scope :expired, { :conditions => ['aasm_state in (?)', ['expired']] }
-        named_scope :cancelled, { :conditions => ['aasm_state in (?)', ['cancelled']] }
-        named_scope :overdue, lambda { { :conditions => ['aasm_state in (?) AND due_at < ?',  ['active'], Time.now] } }
-      }
-    end
-    
-    
+      
     def self.included(base)
       base.instance_eval do
         include AASM
@@ -74,34 +29,8 @@ module StonePath
       end
     end
     
-    # I don't think this should really be part of Stonepath, but I'm adding it here as a comment
-    # to communicate some design intent to my fellow teammembers on a project using stonepath.
-    # For the 'timely|imminent|overdue' stuff, at the time the task is created, we would need to
-    # set and calculate the imminent_at and due_at times. These methods would then do what
-    # we need them to do.
-    # def imminent?
-    #   return false if imminent_at.nil?
-    #   imminent_at < Time.now  
-    # end
-    #
-    # we might also want this method, which would be useful in css styling
-    # def timeliness
-    #   return "overdue" if overdue?
-    #   return "imminent" if imminent?
-    #   return "timely"
-    # end
-    
-    def overdue?
-      return false if due_at.nil?
-      due_at < Time.now  
-    end
-    
     private
     
-    def timestamp_complete
-      self.completed_at = Time.now
-    end
-    
     def notify_created
       if workitem.respond_to?(:task_created)
         workitem.task_created(self)

data/lib/stonepath/work_item.rb

@@ -41,7 +41,9 @@ module StonePath
       end
       
       base.instance_eval do
-        alias_method_chain :to_xml, :events      
+        unless method_defined? :to_xml_without_events
+          alias_method_chain :to_xml, :events
+        end
       end
       
     end #self.included

data/lib/stonepath.rb

@@ -18,8 +18,7 @@ module StonePath
       def stonepath_task(&config_block)
         require File.expand_path(File.dirname(__FILE__)) + "/stonepath/task.rb"
         include StonePath::SPTask
-        config_block ||= StonePath::SPTask.default_config_block
-        instance_eval &config_block
+        instance_eval &config_block if config_block
       end
     
       def stonepath_workbench

data/stonepath.gemspec

@@ -0,0 +1,140 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stonepath}
+  s.version = "0.6.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Bock"]
+  s.date = %q{2011-01-30}
+  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/generators/stonepath.rb",
+    "lib/generators/stonepath/event_log/event_log_generator.rb",
+    "lib/generators/stonepath/event_log/templates/create_event_records.rb",
+    "lib/generators/stonepath/event_log/templates/event_record.rb",
+    "lib/generators/stonepath/events_scaffold/events_scaffold_generator.rb",
+    "lib/generators/stonepath/task/USAGE",
+    "lib/generators/stonepath/task/task_generator.rb",
+    "lib/generators/stonepath/task/templates/migration.rb",
+    "lib/generators/stonepath/task/templates/task.rb",
+    "lib/generators/stonepath/workitem_model/templates/migration.rb",
+    "lib/generators/stonepath/workitem_model/templates/model.rb",
+    "lib/generators/stonepath/workitem_model/workitem_model_generator.rb",
+    "lib/generators/stonepath/workitem_scaffold/templates/model.rb",
+    "lib/generators/stonepath/workitem_scaffold/workitem_scaffold_generator.rb",
+    "lib/stonepath.rb",
+    "lib/stonepath/config.rb",
+    "lib/stonepath/dot.rb",
+    "lib/stonepath/event_logging.rb",
+    "lib/stonepath/extensions/action_view.rb",
+    "lib/stonepath/extensions/rails_generator_commands.rb",
+    "lib/stonepath/railtie.rb",
+    "lib/stonepath/task.rb",
+    "lib/stonepath/work_bench.rb",
+    "lib/stonepath/work_item.rb",
+    "lib/stonepath/work_owner.rb",
+    "lib/tasks/stonepath.rake",
+    "rails/init.rb",
+    "script/console",
+    "script/destroy",
+    "script/generate",
+    "stonepath.gemspec",
+    "stonepath.pdf",
+    "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",
+    "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/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/logging_test.rb",
+    "test/stonepath_test.rb",
+    "test/task_test.rb",
+    "test/test_helper.rb",
+    "test/workitem_test.rb",
+    "test/workowner_test.rb"
+  ]
+  s.homepage = %q{http://github.com/bokmann/stonepath}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Stonepath: stateful workflow modeling for rails}
+  s.test_files = [
+    "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",
+    "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/db/migrate/04_create_event_records.rb",
+    "test/app_root/lib/console_with_fixtures.rb",
+    "test/custom_task_test.rb",
+    "test/logging_test.rb",
+    "test/stonepath_test.rb",
+    "test/task_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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<aasm>, [">= 2.2.0"])
+      s.add_runtime_dependency(%q<sentient_user>, [">= 0.3.2"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_dependency(%q<aasm>, [">= 2.2.0"])
+      s.add_dependency(%q<sentient_user>, [">= 0.3.2"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+    s.add_dependency(%q<aasm>, [">= 2.2.0"])
+    s.add_dependency(%q<sentient_user>, [">= 0.3.2"])
+  end
+end
+

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: stonepath
 version: !ruby/object:Gem::Version 
-  hash: 5
   prerelease: false
   segments: 
   - 0
   - 6
-  - 1
-  version: 0.6.1
+  - 2
+  version: 0.6.2
 platform: ruby
 authors: 
 - David Bock
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-24 00:00:00 -05:00
+date: 2011-01-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 3
         - 0
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 2
         - 2
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 0
         - 3
@@ -111,6 +107,7 @@ files:
 - script/console
 - script/destroy
 - script/generate
+- stonepath.gemspec
 - stonepath.pdf
 - test/app_root/app/controllers/application_controller.rb
 - test/app_root/app/models/assignment.rb
@@ -156,7 +153,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -165,7 +161,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"