piko_transaction 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12be8dac1f3bdbf43a1578b6bf2d40de99db6a6d
-  data.tar.gz: be08565903cc98a3901b3beee57c8d2d9835376f
+  metadata.gz: 22c96f391920e4d74555e59e51ea8ed6281f4acc
+  data.tar.gz: 70f19c75b100b5e5e89f72d6cacfb7b041052180
 SHA512:
-  metadata.gz: a4a9b7ff9fc9107f015a0f2e35bceed5e41ea356ede169e36a3f02ab61c73bd3a8fc7ae6f49e7287b0aeb9b32d6fa4b92409164de37a7d39913a1aa356a40a63
-  data.tar.gz: 2adf4e855f2159135032b6d6b8544089759f67589594ec25caed1cccbc8bcefd31f942ee597601dc342db85837730af22e49861ae5e454e7ce01cb8975e7a99a
+  metadata.gz: 10153b9ef8b9d66691b9ce926570c2b24029c147546140ab58b8ec83c80ccc54b5e2e5eac6d53ee073e3b0d4cc3bd86d6883481c0567bad5fa67ee622f52796b
+  data.tar.gz: fa98740f073eda60cd2a98b3564f033629c7b8bb72fdc7993fa6c8f464048b3ddf5a5caea23584d243d6f7d496e03c571dd39fb2ec2ca91df19b80fb1ab0c0a0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.1.0 (2017.06.08)
+
+* add custom command
+
 ### 1.0.1 (2017.06.06)
 
 * add struct graph

data/lib/piko_transaction/custom_command.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017 Szymon Kopciewski
+#
+# This file is part of PikoTransaction.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "piko_transaction/logger"
+
+module PikoTransaction
+  class CustomCommand
+    include Logger
+
+    def initialize(do_action = nil, undo_action = nil, &alternative_do_action)
+      @do_action = do_action
+      @undo_action = undo_action
+      @alternative_do_action = alternative_do_action
+      @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
+    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
+    end
+
+    private
+
+    def terminate(msg)
+      logger.warn { msg }
+      false
+    end
+
+    def mark_as_done
+      @done = true
+    end
+
+    def mark_as_undone
+      @done = false
+    end
+
+    def can_do?
+      !@done
+    end
+
+    def can_undo?
+      @done
+    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
+    end
+
+    def choose_do_action
+      @do_action || @alternative_do_action
+    end
+
+    def execute_undo_action
+      return true unless @undo_action.respond_to? :call
+      logger.debug { "Executing undo action" }
+      @undo_action.call
+    end
+  end
+end

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 = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: piko_transaction
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Szymon Kopciewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger2r
@@ -120,6 +120,7 @@ files:
 - LICENSE
 - README.md
 - lib/piko_transaction.rb
+- lib/piko_transaction/custom_command.rb
 - lib/piko_transaction/delete_command.rb
 - lib/piko_transaction/insert_command.rb
 - lib/piko_transaction/logger.rb