file_transactions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbdef21f6b3d981705c6a0ed618d90abbaee1e1f4d2e50f4c1233390a809584c
+  data.tar.gz: 0da72546f7cf4014ecaeb3101a169be1b7977b59d694deeaf3961c9ff0a21e1b
+SHA512:
+  metadata.gz: 8dec98fc1b74aa2187e0ac76abd6b6b4a605327c5541e5aed0a9fbebf17783c4b4c0aae19bf3314f5aa3557eaded940ed59d9dd22d8d4722e966e22f1f7ca3d8
+  data.tar.gz: f8cbfc09aaee6af0fab0d3e783eb5f7d5a2818806cc657b1f40d639d618ac6ada0150b168558f4a989d4d52036f48710034ba26259e1006061a4baa0cbdd5365

data/lib/file_transactions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "file_transactions/version"
+require 'file_transactions/error'
+require 'file_transactions/base_command'
+require 'file_transactions/change_file_command'
+require 'file_transactions/create_directory_command'
+require 'file_transactions/create_file_command'
+require 'file_transactions/delete_file_command'
+require 'file_transactions/move_file_command'
+require 'file_transactions/transaction'
+
+module FileTransactions
+  def self.transaction(&block)
+    Transaction.run(&block)
+  end
+end

data/lib/file_transactions/base_command.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module FileTransactions
+  # A Base class that all commands must inherit from.
+  #
+  # This class provides all the necessary methods/hooks to make it possible to
+  # group commands together and/or nested inside transactions (and other
+  # commands).
+  class BaseCommand
+    def self.execute(*args, &block)
+      new(*args, &block).tap { |cmd| cmd.execute }
+    end
+
+    # Execute the command. This will trigger the following methods:
+    #  * #before
+    #  * #execute!
+    #  * #after
+    def execute
+      scope = Transaction.scope
+      scope&.register self
+      prepare
+      run_before
+      run_excecute.tap { run_after }
+    rescue StandardError
+      self.failure_state = state
+      raise
+    ensure
+      Transaction.scope = scope
+    end
+
+    # Undo the changes made from a previous call to #execute. All previouly
+    # executed commands will be undone in reverse order.
+    def undo
+      raise Error, "Cannot undo #{self.class} which hasn't been executed" unless executed?
+
+      sub_commands[:after].reverse_each(&:undo)
+
+      ret = undo! unless failure_state == :before
+      sub_commands[:before].reverse_each(&:undo)
+      ret
+    end
+
+    # This registers a nested command. This method is called whever a command
+    # is executed and should not be called manually.
+    def register(command)
+      sub_commands[state] << command
+    end
+
+    # Returns true of false depending on if the commands has been executed.
+    def executed?
+      !!executed
+    end
+
+    # Returns true if the command has been unsuccessfully executed, otherwise false.
+    def failed?
+      !!failure_state
+    end
+
+    private
+
+    attr_accessor :state, :executed, :failure_state
+
+    def prepare
+      Transaction.scope = self
+      self.executed = true
+    end
+
+    def sub_commands
+      @sub_commands ||= {
+        before: [],
+        exec: [],
+        after: [],
+      }
+    end
+
+    def run_before
+      self.state = :before
+      before
+    end
+
+    def run_excecute
+      self.state = :exec
+      execute!
+    end
+
+    def run_after
+      self.state = :after
+      after
+    end
+
+    def before; end
+
+    def execute!
+      raise NotImplementedError, "#{self.clas} must implement #execute"
+    end
+
+    def undo!
+      raise NotImplementedError, "#{self.clas} must implement #undo"
+    end
+
+    def after; end
+  end
+end

data/lib/file_transactions/change_file_command.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tmpdir'
+
+module FileTransactions
+  class ChangeFileCommand < BaseCommand
+    attr_reader :name, :block
+
+    def initialize(name, &block)
+      @name = name
+      @block = block
+    end
+
+    private
+
+    def before
+      CreateFileCommand.execute(tmp_name) do
+        FileUtils.copy name, tmp_name
+      end
+    end
+
+    def execute!
+      value = block.call(name)
+      return unless value.is_a? String
+
+      File.open(name, 'w') { |f| f.write(value) }
+    end
+
+    def undo!
+      FileUtils.copy tmp_name, name
+    end
+
+    def tmp_name
+      @tmp_name ||= File.join(Dir.mktmpdir, File.basename(name))
+    end
+  end
+end

data/lib/file_transactions/create_directory_command.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module FileTransactions
+  class CreateDirectoryCommand < BaseCommand
+    attr_reader :name
+
+    # Create new command for creating directories. N
+    #
+    # ==== Attributes
+    #
+    # * +name+ - The name of the directory to be created
+    #
+    # ==== Examples
+    #
+    #  # Pass in the new directory name to ::new
+    #  cmd1 = CreateDirectoryCommand.new('directory_name')
+    #
+    #  # The new directory may be a path of multiple non exsting directories (like `mkdir -p`)
+    #  cmd2 = CreateDirectoryCommand.new('non_existing_dir1/non_existing_dir2/new_dir')
+    def initialize(name)
+      @name = name
+    end
+
+    private
+
+    def execute!
+      dir = name
+
+      until Dir.exist? dir
+        directories.unshift dir
+        dir = File.dirname dir
+      end
+
+      directories.each { |dir| Dir.mkdir dir }
+    end
+
+    def undo!
+      directories.reverse_each { |dir| Dir.unlink dir }
+    end
+
+    def directories
+      @directories ||= []
+    end
+  end
+end

data/lib/file_transactions/create_file_command.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FileTransactions
+  class CreateFileCommand < BaseCommand
+    attr_reader :name, :block
+
+    def initialize(name, &block)
+      @name = name
+      @block = block
+    end
+
+    private
+
+    def before
+      dir = File.dirname(name)
+      return if Dir.exist? dir
+      CreateDirectoryCommand.execute(dir)
+    end
+
+    def execute!
+      value = block.call(name)
+      return unless value.is_a? String
+
+      File.open(name, 'w') { |f| f.write(value) }
+    end
+
+    def undo!
+      File.unlink name
+    end
+  end
+end

data/lib/file_transactions/delete_file_command.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tmpdir'
+
+module FileTransactions
+  class DeleteFileCommand < BaseCommand
+    attr_reader :name, :block
+
+    def initialize(name)
+      @name = name
+    end
+
+    private
+
+    def before
+      CreateFileCommand.execute(tmp_name) do
+        FileUtils.copy name, tmp_name
+      end
+    end
+
+    def execute!
+      File.delete name
+    end
+
+    def undo!
+      FileUtils.copy tmp_name, name
+    end
+
+    def tmp_name
+      @tmp_name ||= File.join(Dir.mktmpdir, File.basename(name))
+    end
+  end
+end

data/lib/file_transactions/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module FileTransactions
+  class Error < StandardError; end
+  class Rollback < Error; end
+end

data/lib/file_transactions/move_file_command.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module FileTransactions
+  class MoveFileCommand < BaseCommand
+    attr_reader :from, :to
+
+    def initialize(from:, to:)
+      @from = from
+      @to = to
+    end
+
+    private
+
+    def before
+      CreateDirectoryCommand.execute(File.dirname(to))
+    end
+
+    def execute!
+      File.rename from, to
+    end
+
+    def undo!
+      File.rename to, from
+    end
+  end
+end

data/lib/file_transactions/transaction.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module FileTransactions
+  class Transaction
+    class << self
+      def run(&block)
+        new(&block).__send__(:run)
+      end
+
+      def scope=(scope)
+        Thread.current['FT.scope'] = scope
+      end
+
+      def scope
+        Thread.current['FT.scope']
+      end
+
+    end
+
+    def initialize(&block)
+      raise Error, 'A block must be given' unless block_given?
+
+      @block = block
+      @commands = []
+    end
+
+    def register(command)
+      commands << command
+    end
+
+    def rollback
+      return if backrolled?
+
+      commands.reverse_each(&:undo)
+      self.backrolled = true
+    end
+    alias undo rollback
+
+    def backrolled?
+      !!backrolled
+    end
+
+    private
+
+    attr_reader :block, :commands
+    attr_accessor :backrolled
+
+    def run
+      scope = Transaction.scope
+      scope&.register self
+      Transaction.scope = self
+      block.call
+    rescue StandardError => e
+      rollback
+      raise unless Rollback === e
+    ensure
+      Transaction.scope = scope
+    end
+  end
+end

data/lib/file_transactions/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FileTransactions
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: file_transactions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sammy Henningsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-18 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A set of file operation that can be undone or wrapped in a
+  transaction. If the transaction is rolled back then all file
+  operations will be undone.
+email:
+- sammy.henningsson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/file_transactions.rb
+- lib/file_transactions/base_command.rb
+- lib/file_transactions/change_file_command.rb
+- lib/file_transactions/create_directory_command.rb
+- lib/file_transactions/create_file_command.rb
+- lib/file_transactions/delete_file_command.rb
+- lib/file_transactions/error.rb
+- lib/file_transactions/move_file_command.rb
+- lib/file_transactions/transaction.rb
+- lib/file_transactions/version.rb
+homepage: https://github.com/sammyhenningsson/file_transactions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sammyhenningsson/file_transactions
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Transactions for file operations
+test_files: []