piko_transaction 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2a5c353c83ff13ddda8d02da3472d26817097f3
-  data.tar.gz: bd2b2647b33ac8b31909d2362bc41c821280b8e2
+  metadata.gz: 1fb92d89b2652b73d375601b371f4e455bb288a2
+  data.tar.gz: 2aedbe5d5503fd358d82bc407a8f5f572d14c066
 SHA512:
-  metadata.gz: 74bb0c9fd14f7feaf3cee6f36725a7e6ceb47a300ab822153c834c4bf994d4375775c9db875b26bb33c5022880ef78ef1ba8890b5ebfe816bac9fdcd05036518
-  data.tar.gz: 54f72334b93ebe20e88f6ffe72ada7328f6f4c12f1923eae165aa7c4f33c667ea96c1b9ffbb910748d6b791bb9d2922d73dbd6e9974812a19ed76508fe817abc
+  metadata.gz: d007f9c884d25c6028e8e790239be5d2b2886970963d9df4b91cab56e0927dd4cab49f628d20cfb8675b988a92e457e5aa387b96f9be42ee3976f6745628f6af
+  data.tar.gz: 29a8c4244b32c2e9de4f03b724116bee83472b5bc2630391bd74e82eef1128a2f76f8393d365eecd588983c4cb9500e22cbfc43dd624470fe8ab3636e656a6b4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 3.0.0 (2017.06.13)
+
+* allow to register success and failure observers in commands
+* commands and transactions have names
+* improved logger
+
 ### 2.1.0 (2017.06.08)
 
 * add transaction holder class

data/lib/piko_transaction/custom_command.rb

@@ -24,30 +24,48 @@ module PikoTransaction
     include Logger
 
     def initialize(do_action = nil, undo_action = nil, &alternative_do_action)
-      @do_action = do_action
+      @name = nil
+      @do_action = choose_do_action(do_action, alternative_do_action)
       @undo_action = undo_action
-      @alternative_do_action = alternative_do_action
+      @success_callbacks = []
+      @failure_callbacks = []
       @done = false
     end
 
     def do
-      return terminate("Command already done") unless can_do?
-      return terminate("Can not execute 'do' action") unless execute_do_action
-      mark_as_done
-      true
+      execute_do_action ? call_success_callbacks : call_failure_callbacks
     end
 
     def undo
-      return terminate("Can not undo command") unless can_undo?
-      return terminate("Can not execute 'undo' action") unless execute_undo_action
-      mark_as_undone
-      true
+      execute_undo_action
+    end
+
+    def to_s
+      format "[%s]", @name || "custom_cmd"
+    end
+
+    def name(value)
+      @name = value.to_s
+    end
+
+    def add_success_callback(callback)
+      @success_callbacks << callback if callback.respond_to?(:call)
+      logger.debug { format "%s Registered success callbacks: %i", to_s, @success_callbacks.count }
+    end
+
+    def add_failure_callback(callback)
+      @failure_callbacks << callback if callback.respond_to?(:call)
+      logger.debug { format "%s Registered failure callbacks: %i", to_s, @failure_callbacks.count }
     end
 
     private
 
+    def choose_do_action(action, alternative_action)
+      action || alternative_action
+    end
+
     def terminate(msg)
-      logger.warn { msg }
+      logger.warn { format "%s %s", to_s, msg }
       false
     end
 
@@ -57,6 +75,7 @@ module PikoTransaction
 
     def mark_as_undone
       @done = false
+      true
     end
 
     def can_do?
@@ -68,20 +87,60 @@ module PikoTransaction
     end
 
     def execute_do_action
-      action = choose_do_action
-      return terminate("Bad 'do' action") unless action.respond_to? :call
-      logger.debug { "Executing do action" }
-      action.call
+      return terminate("Command already done") unless can_do?
+      return terminate("'Do' action do not responds to :call") unless \
+        callable_action?(@do_action)
+      return terminate("'Do' action returns false") unless safe_call_do_action
+      mark_as_done
     end
 
-    def choose_do_action
-      @do_action || @alternative_do_action
+    def safe_call_do_action
+      logger.info { format "%s Executing custom 'do' action", to_s }
+      return safe_call_action(@do_action) unless @do_action.nil?
+      logger.warn { format "%s Nothing to 'do'", to_s }
+      true
+    end
+
+    def safe_call_action(action)
+      action.call ? true : false
+    rescue => e
+      logger.fatal { format "%s %s - %s", to_s, e.class.name, e.message }
+      false
+    end
+
+    def callable_action?(action)
+      action.nil? || action.respond_to?(:call)
     end
 
     def execute_undo_action
-      return true unless @undo_action.respond_to? :call
-      logger.debug { "Executing undo action" }
-      @undo_action.call
+      return terminate("Can not undo command") unless can_undo?
+      return terminate("'Undo' action do not responds to :call") unless \
+        callable_action?(@undo_action)
+      return terminate("'Undo' action returns false") unless safe_call_undo_action
+      mark_as_undone
+    end
+
+    def safe_call_undo_action
+      logger.debug { format "%s Executing custom 'undo' action", to_s }
+      return safe_call_action(@undo_action) unless @undo_action.nil?
+      logger.warn { format "%s Nothing to 'undo'", to_s }
+      true
+    end
+
+    def call_success_callbacks
+      @success_callbacks.each_with_index do |callback, i|
+        logger.debug { format "%s Run %i success callback", to_s, i + 1 }
+        callback.call
+      end
+      true
+    end
+
+    def call_failure_callbacks
+      @failure_callbacks.each_with_index do |callback, i|
+        logger.debug { format "%s Run %i failure callback", to_s, i + 1 }
+        callback.call
+      end
+      false
     end
   end
 end

data/lib/piko_transaction/delete_command.rb

@@ -24,32 +24,47 @@ module PikoTransaction
     include Logger
 
     def initialize(document_id, collection, &success_action)
+      @name = nil
       @document_id = document_id
       @collection = collection
       @success_action = success_action
+      @success_callbacks = []
+      @failure_callbacks = []
       @deleted_doc = nil
       @done = false
     end
 
     def do
-      return terminate("Command already done") unless can_do?
-      return terminate("Can not delete document") unless remove_document
-      call_success_action
-      mark_as_done
-      true
+      add_success_callback @success_action
+      remove_document ? call_success_callbacks : call_failure_callbacks
     end
 
     def undo
-      return terminate("Can not undo command") unless can_undo?
-      return terminate("Can not restore document") unless store_document
-      mark_as_undone
-      true
+      store_document
+    end
+
+    def to_s
+      format "[%s]", @name || "delete_cmd"
+    end
+
+    def name(value)
+      @name = value.to_s
+    end
+
+    def add_success_callback(callback)
+      @success_callbacks << callback if callback.respond_to?(:call)
+      logger.debug { format "%s Registered success callbacks: %s", to_s, @success_callbacks.count }
+    end
+
+    def add_failure_callback(callback)
+      @failure_callbacks << callback if callback.respond_to?(:call)
+      logger.debug { format "%s Registered failure callbacks: %s", to_s, @failure_callbacks.count }
     end
 
     private
 
     def terminate(msg)
-      logger.warn { msg }
+      logger.warn { format "%s %s", to_s, msg }
       false
     end
 
@@ -59,6 +74,7 @@ module PikoTransaction
 
     def mark_as_undone
       @done = false
+      true
     end
 
     def can_do?
@@ -70,19 +86,43 @@ module PikoTransaction
     end
 
     def remove_document
-      logger.info { format "Doing command with %s", @document_id }
+      return terminate("Command already done") unless can_do?
+      return terminate("Error during deleting document") unless delete_document_from_collection
+      mark_as_done
+    end
+
+    def delete_document_from_collection
+      logger.info do
+        format "%s Deleting document '%s' from '%s'", to_s, @document_id, @collection.to_s
+      end
       @collection.find_and_delete_document(@document_id) { |doc| @deleted_doc = doc }
     end
 
     def store_document
-      logger.info { format "Restoring document: %s", @deleted_doc }
+      return terminate("Can not undo without do") unless can_undo?
+      return terminate("Error durind restoring document") unless insert_document_into_collection
+      mark_as_undone
+    end
+
+    def insert_document_into_collection
+      logger.info { format "%s Restoring document %s in %s", to_s, @deleted_doc, @collection.to_s }
       @collection.insert_document(@deleted_doc)
     end
 
-    def call_success_action
-      return unless @success_action.is_a?(Proc)
-      logger.debug { format "Executting callback with: %s", @deleted_doc }
-      @success_action.call(@deleted_doc)
+    def call_success_callbacks
+      @success_callbacks.each_with_index do |callback, i|
+        logger.debug { format "%s Run %i success callback with: %s", to_s, i + 1, @deleted_doc }
+        callback.call(@deleted_doc)
+      end
+      true
+    end
+
+    def call_failure_callbacks
+      @failure_callbacks.each_with_index do |callback, i|
+        logger.debug { format "%s Run %i failure callback", to_s, i + 1 }
+        callback.call
+      end
+      false
     end
   end
 end

data/lib/piko_transaction/insert_command.rb

@@ -24,32 +24,47 @@ module PikoTransaction
     include Logger
 
     def initialize(document, collection, &success_action)
+      @name = nil
       @document = document
       @collection = collection
       @success_action = success_action
+      @success_callbacks = []
+      @failure_callbacks = []
       @inserted_id = nil
       @done = false
     end
 
     def do
-      return terminate("Command already done") unless can_do?
-      return terminate("Can not store document") unless store_document
-      call_success_action
-      mark_as_done
-      true
+      add_success_callback @success_action
+      store_document ? call_success_callbacks : call_failure_callbacks
     end
 
     def undo
-      return terminate("Can not undo command") unless can_undo?
-      return terminate("Can not delete document") unless remove_document
-      mark_as_undone
-      true
+      remove_document
+    end
+
+    def to_s
+      format "[%s]", @name || "insert_cmd"
+    end
+
+    def name(value)
+      @name = value.to_s
+    end
+
+    def add_success_callback(callback)
+      @success_callbacks << callback if callback.respond_to?(:call)
+      logger.debug { format "%s Registered success callbacks: %i", to_s, @success_callbacks.count }
+    end
+
+    def add_failure_callback(callback)
+      @failure_callbacks << callback if callback.respond_to?(:call)
+      logger.debug { format "%s Registered failure callbacks: %i", to_s, @failure_callbacks.count }
     end
 
     private
 
     def terminate(msg)
-      logger.warn { msg }
+      logger.warn { format "%s %s", to_s, msg }
       false
     end
 
@@ -59,6 +74,7 @@ module PikoTransaction
 
     def mark_as_undone
       @done = false
+      true
     end
 
     def can_do?
@@ -70,19 +86,43 @@ module PikoTransaction
     end
 
     def store_document
-      logger.info { format "Inserting %s into '%s'", @document, @collection.to_s }
+      return terminate("Command already done") unless can_do?
+      return terminate("Error during inserting document") unless insert_document_into_collection
+      mark_as_done
+    end
+
+    def insert_document_into_collection
+      logger.info { format "%s Inserting %s into '%s'", to_s, @document, @collection.to_s }
       @collection.insert_document(@document) { |doc_id| @inserted_id = doc_id }
     end
 
     def remove_document
-      logger.info { format "Undoing command for document: %s", @inserted_id }
+      return terminate("Can not undo without do") unless can_undo?
+      return terminate("Error during withdrawing document") unless delete_document_from_collection
+      mark_as_undone
+    end
+
+    def delete_document_from_collection
+      logger.info do
+        format "%s Withdrawing document '%s' from '%s'", to_s, @inserted_id, @collection.to_s
+      end
       @collection.delete_document(@inserted_id)
     end
 
-    def call_success_action
-      return unless @success_action.is_a?(Proc)
-      logger.debug { format "Executting callback with: %s", @inserted_id }
-      @success_action.call(@inserted_id)
+    def call_success_callbacks
+      @success_callbacks.each_with_index do |callback, i|
+        logger.debug { format "%s Run %i success callback with: %s", to_s, i + 1, @inserted_id }
+        callback.call(@inserted_id)
+      end
+      true
+    end
+
+    def call_failure_callbacks
+      @failure_callbacks.each_with_index do |callback, i|
+        logger.debug { format "%s Run %i failure callback", to_s, i + 1 }
+        callback.call
+      end
+      false
     end
   end
 end

data/lib/piko_transaction/transaction.rb

@@ -23,41 +23,47 @@ module PikoTransaction
   class Transaction
     include Logger
 
-    def initialize
+    def initialize(name = nil)
+      @name = name
       @commands = []
       @done = []
       yield self if block_given?
     end
 
     def add(command)
-      logger.debug { format "Add command: %s", command.class.name }
       @commands << command
+      logger.debug do
+        format "%s Added command: %s, total: %i", to_s, command.to_s, @commands.count
+      end
     end
 
     def do
-      logger.info { format "Start transaction with commands: %s", @commands.count }
+      logger.info { format "%s Start transaction with commands: %s", to_s, @commands.count }
       return true if run_commands
       terminate_and_undo
     end
 
     def undo
-      logger.info { format "Rolling back transaction with commands: %s", @done.count }
+      logger.info { format "%s Rolling back transaction with commands: %s", to_s, @done.count }
       undo_done_commands
     end
 
+    def to_s
+      format "[%s]", @name || "tr"
+    end
+
     private
 
     def terminate_and_undo
-      logger.error { "Could not finalize transaction!" }
+      logger.error { format "%s Could not finalize transaction!", to_s }
       undo_done_commands
       false
     end
 
     def run_commands
-      @commands.each do |cmd|
-        logger.debug { format "Do: %s", cmd.class.name }
-        unless cmd.do
-          logger.error { "Command execution failed" }
+      @commands.each_with_index do |cmd, i|
+        unless doing_command(cmd, i)
+          logger.warn { format "%s Command %s failed", to_s, cmd.to_s }
           return false
         end
         @done << cmd
@@ -65,14 +71,24 @@ module PikoTransaction
       true
     end
 
+    def doing_command(cmd, i)
+      logger.debug { format "%s Running %i command: %s", to_s, i + 1, cmd.to_s }
+      cmd.do
+    end
+
     def undo_done_commands
-      @done.reverse.each do |cmd|
-        logger.debug { format "Undo: %s", cmd.class.name }
-        unless cmd.undo
-          logger.fatal { "Can not undo command" }
+      @done.each_with_index.reverse_each do |cmd, i|
+        unless undoing_command(cmd, i)
+          logger.fatal { format "%s Can not undo command: %s", to_s, cmd.to_s }
           break
         end
+        @done.delete(cmd)
       end
     end
+
+    def undoing_command(cmd, i)
+      logger.debug { format "%s Undoing %i command: %s", to_s, i + 1, cmd.to_s }
+      cmd.undo
+    end
   end
 end

data/lib/piko_transaction/transaction_holder.rb

@@ -31,7 +31,7 @@ module PikoTransaction
     def method_missing(method_name, *args, &block)
       logger.debug { format "Looking for transaction '%s'", method_name }
       return super unless valid_method_name?(method_name)
-      @transactions[method_name] ||= Transaction.new
+      @transactions[method_name] ||= Transaction.new method_name
     end
 
     private

data/lib/piko_transaction/version.rb

@@ -18,5 +18,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module PikoTransaction
-  VERSION = "2.1.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: piko_transaction
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Szymon Kopciewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2017-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger2r