file-transaction 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c8da8359d8abcf3fe908a06823f670b66ed112faae1a0fd44fc9990ef8b9d08
+  data.tar.gz: 6f46a70a553a34c4edf7853dc3e002457f62d4123e43adf3866c2f2c6e79a366
+SHA512:
+  metadata.gz: 5183ac61f302f77b83e2e3bb09220274c8fb280c1979a8a1be9aab12e8f7667834a5214266544a95660f7fd82ac95bb9066d4428e78d0ca4775a1afa529c5727
+  data.tar.gz: 955fc9612e10a406db41fca89ff0f04503675c853cc5241c3f8918cbd68c05cff2754bceba850819fe743ebf2849fd22aeb193f963fa269ea22888cb9efe07b4

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    file-transaction (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  file-transaction!
+  pry
+  rspec
+
+BUNDLED WITH
+   2.2.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Daniel Inkpen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,24 @@
+# File transaction
+
+Copy a directory to a temp directory temporarily to perform mutations, to then copy it back.
+
+If any exceptions are raised within the block, the changes will not be copied back.
+
+# Usage
+
+``` ruby
+# Will create `a`, `b`, `c` in `/my/path`
+File.transaction("/my/path") do |dir|
+  FileUtils.touch(dir.join("a"))
+  FileUtils.touch(dir.join("b"))
+  system("echo 'c' >#{dir}/c")
+end
+
+# Will make no changes to `/my/path`
+File.transaction("/my/path") do |dir|
+  FileUtils.touch(dir.join("a"))
+  FileUtils.touch(dir.join("b"))
+  system("echo 'c' >#{dir}/c")
+  raise "Any error" # <-------------
+end
+```

data/file-transaction.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "file-transaction/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "file-transaction"
+  spec.version       = FileTransaction::VERSION
+  spec.authors       = ["Daniel Inkpen"]
+  spec.email         = ["dan2552@gmail.com"]
+
+  spec.summary       = "ActiveRecord-like transaction block for files in a directory"
+  spec.description   = "Copy a directory to a temp directory temporarily to perform mutations, to then copy it back. If any exceptions are raised within the block, the changes will not be copied back."
+  spec.homepage      = "https://github.com/Dan2552/file-transaction"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec"
+end

data/lib/file-transaction.rb

@@ -0,0 +1,54 @@
+require "pathname"
+require "fileutils"
+require "tmpdir"
+
+module FileTransaction
+  # @internal
+  #
+  # Copies all contents of a directory instead of the directory itself.
+  #
+  def self.copy_files(directory, target)
+    if files_in(target).empty?
+      FileUtils.cp_r(File.join(directory, "."), target)
+    else
+      relative_files_in(directory).each do |file|
+        FileUtils.mkdir_p(File.join(target, file.dirname))
+        begin
+          FileUtils.cp(File.join(directory, file), File.join(target, file))
+        rescue Errno::EACCES
+          FileUtils.rm_rf(File.join(target, file))
+          FileUtils.cp(File.join(directory, file), File.join(target, file))
+        end
+      end
+
+      files_for_deletion = relative_files_in(target) - relative_files_in(directory)
+
+      files_for_deletion.each do |file|
+        FileUtils.rm(File.join(target, file))
+      end
+    end
+  end
+
+  # @internal
+  #
+  def self.files_in(directory)
+    Dir.glob(File.join(directory, "**", "*"), File::FNM_DOTMATCH)
+      .reject { |file| file.end_with?(".") || file.end_with?("..") || File.directory?(file) }
+  end
+
+  def self.relative_files_in(directory)
+    files_in(directory).map { |file| Pathname.new(file).relative_path_from(directory) }
+  end
+end
+
+class File
+  def self.transaction(directory, &blk)
+    raise "#{directory} is not a directory" unless File.directory?(directory)
+
+    Dir.mktmpdir do |tmp_directory|
+      FileTransaction.copy_files(directory, tmp_directory)
+      blk.call(Pathname.new(tmp_directory))
+      FileTransaction.copy_files(tmp_directory, directory)
+    end
+  end
+end

data/lib/file-transaction/version.rb

@@ -0,0 +1,3 @@
+module FileTransaction
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: file-transaction
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Inkpen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Copy a directory to a temp directory temporarily to perform mutations,
+  to then copy it back. If any exceptions are raised within the block, the changes
+  will not be copied back.
+email:
+- dan2552@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- file-transaction.gemspec
+- lib/file-transaction.rb
+- lib/file-transaction/version.rb
+homepage: https://github.com/Dan2552/file-transaction
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: ActiveRecord-like transaction block for files in a directory
+test_files: []