infopark_reactor 1.8.1 → 1.8.2

data/README.md

@@ -70,6 +70,15 @@ much more efficient than the traditional method.
 
 Permissions are checked also! And your user is automatically set according to `JSESSIONID` cookie.
 
+Workflow support is provided together with comments (just pass your comment as string to the relevant method):
+
+    obj.edit!('draft version created')
+    obj.forward!('please add your text')
+    # as other user
+    obj.take!
+    obj.release!('text added and released')
+
+
 KNOWN BUGS/ISSUES
 =================
 

data/lib/reactor/permission.rb

@@ -27,7 +27,7 @@ module Reactor
       # Wraps around Reactor::Persistence::Base#release! and ensures
       # that current user has required permissions to release the object
       # @raise [Reactor::NotPermitted] user lacks neccessary permission
-      def release!
+      def release!(*args)
         ensure_permission_granted(:release)
         return super
       end
@@ -35,7 +35,7 @@ module Reactor
       # Wraps around Reactor::Persistence::Base#take! and ensures
       # that current user has required permissions to take the object
       # @raise [Reactor::NotPermitted] user lacks neccessary permission
-      def take!
+      def take!(*args)
         ensure_permission_granted(:take)
         return super
       end
@@ -43,7 +43,7 @@ module Reactor
       # Wraps around Reactor::Persistence::Base#revert! and ensures
       # that current user has required permissions to revert the object
       # @raise [Reactor::NotPermitted] user lacks neccessary permission
-      def revert!
+      def revert!(*args)
         ensure_permission_granted(:revert)
         return super
       end
@@ -51,7 +51,7 @@ module Reactor
       # Wraps around Reactor::Persistence::Base#edit! and ensures
       # that current user has required permissions to edit the object
       # @raise [Reactor::NotPermitted] user lacks neccessary permission
-      def edit!
+      def edit!(*args)
         ensure_permission_granted(:edit)
         return super
       end

data/lib/reactor/persistence.rb

@@ -28,37 +28,41 @@ module Reactor
       # 2. the object has already been released
       # 3. object is invalid
       # 4. other error occoured
-      def release
-        return release!
+      # @param comment [String] comment to leave for the next user
+      def release(comment=nil)
+        return release!(comment)
       rescue Reactor::Cm::XmlRequestError, ActiveRecord::RecordInvalid, Reactor::NotPermitted, Reactor::AlreadyReleased
         return false
       end
 
       # Removes the working version of the object,
       # if it exists
+      # @param comment [String] comment to leave for the next user
       # @return [true]
-      def revert
-        return revert!
+      def revert(comment=nil)
+        return revert!(comment)
       end
 
       # Removes the working version of the object,
       # if it exists
+      # @param comment [String] comment to leave for the next user
       # @return [true]
       # @note There is no difference between #revert and #revert!
-      def revert!
-        crul_obj.revert!
+      def revert!(comment=nil)
+        crul_obj.revert!(comment)
         reload
         return true
       end
 
       # Releases the object. Returns true on succes, can raise exceptions
+      # @param comment [String] comment to leave for the next user
       # @raise [Reactor::AlreadyReleased]
       # @raise [ActiveRecord::RecordInvalid] validations failed
       # @raise [Reactor::NotPermitted] current user lacks required permissions
-      def release!
+      def release!(comment=nil)
         run_callbacks(:release) do
           raise(Reactor::AlreadyReleased) unless self.really_edited?
-          crul_obj.release!
+          crul_obj.release!(comment)
           reload
         end
         return true
@@ -70,8 +74,9 @@ module Reactor
       # 1. user lacks the permissions
       # 2. the object has not beed edited
       # 3. other error occured
-      def take
-        take!
+      # @param comment [String] comment to leave for the next user
+      def take(comment=nil)
+        take!(comment)
         return true
       rescue Reactor::Cm::XmlRequestError, Reactor::NotPermitted, Reactor::NoWorkingVersion
         return false
@@ -79,12 +84,13 @@ module Reactor
 
       # Makes the current user the editor of the object. Returns true when
       # user is already the editor or take succeded. Raises exceptions
+      # @param comment [String] comment to leave for the next user
       # @raise [Reactor::NoWorkingVersion] there is no working version of the object
       # @raise [Reactor::NotPermitted] current user lacks required permissions
-      def take!
+      def take!(comment=nil)
         raise(Reactor::NoWorkingVersion) unless self.really_edited?
         # TODO: refactor the if condition
-        crul_obj.take! if (crul_obj.editor != Reactor::Configuration::xml_access[:username])
+        crul_obj.take!(comment) if (crul_obj.editor != Reactor::Configuration::xml_access[:username])
         # neccessary to recalculate #editor
         reload
         return true
@@ -92,10 +98,11 @@ module Reactor
 
       # Creates a working version of the object. Returns true on success or when
       # the object already has a working version. Returns false when:
+      # @param comment [String] comment to leave for the next user
       # 1. user lacks the permissions
       # 2. other error occured
-      def edit
-        edit!
+      def edit(comment=nil)
+        edit!(comment)
         return true
       rescue Reactor::Cm::XmlRequestError, Reactor::NotPermitted
         return false
@@ -103,9 +110,10 @@ module Reactor
 
       # Creates a working version of the object. Returns true on success or when
       # the object already has a working version. Raises exceptions
+      # @param comment [String] comment to leave for the next user
       # @raise [Reactor::NotPermitted] current user lacks required permissions
-      def edit!
-        crul_obj.edit! unless self.really_edited?
+      def edit!(comment=nil)
+        crul_obj.edit!(comment) unless self.really_edited?
         reload
         return true
       end

data/lib/reactor/validations.rb

@@ -22,7 +22,7 @@ module Reactor
       # Wraps around Reactor::Persistence::Base#release! and validates object
       # in :release context before release. Raises exception when invalid.
       # @raise [ActiveRecord::RecordInvalid] validations registered for :release failed
-      def release!
+      def release!(*args)
         raise(ActiveRecord::RecordInvalid.new(self)) unless valid?(:release)
         return super
       end

data/lib/reactor/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module Reactor
-  VERSION = "1.8.1"
+  VERSION = "1.8.2"
 end

data/lib/reactor/workflow.rb

@@ -15,6 +15,34 @@ module Reactor
           Empty.new(self)
         end
       end
+
+      def workflow_comments
+        Reactor::Cm::LogEntry.where(:objectId => self.id).map {|entry| Comment.new(entry) }
+      end
+    end
+
+    class Comment < Struct.new(:time, :text, :type, :object_id, :receiver, :user)
+      def initialize(log_entry)
+        super(
+          parse_time(log_entry['logTime']),
+          log_entry['logText'],
+          log_entry['logType'],
+          log_entry['objectId'],
+          log_entry['receiver'],
+          log_entry['userLogin']
+        )
+      end
+
+      def object
+        ::AbstractObj.find(self.object_id)
+      end
+
+      alias obj object
+
+      protected
+      def parse_time(time)
+        Time.from_iso(time)
+      end
     end
   end
 end

data/lib/reactor/workflow/standard.rb

@@ -21,8 +21,8 @@ module Reactor
           valid_action?(action)
         end
 
-        define_method :"#{action}!" do
-          @obj.send(:crul_obj).send(:"#{action}!")
+        define_method :"#{action}!" do |*args|
+          @obj.send(:crul_obj).send(:"#{action}!", *args)
         end
       end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: infopark_reactor
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 51
   prerelease: 
   segments: 
   - 1
   - 8
-  - 1
-  version: 1.8.1
+  - 2
+  version: 1.8.2
 platform: ruby
 authors: 
 - Tomasz Przedmojski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-19 00:00:00 +02:00
+date: 2013-07-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency