bfs 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd67ecfdb038d1809be4193caf014dfd9e8bcba4e26a4cd04da3c64e61522ddc
-  data.tar.gz: 17586a9b02836e8bdcbf4da6bc822d9c169cca9823b5817357dba1d4a5f1a072
+  metadata.gz: 3de22f9cab6ba21d594854a2fcec49cc215b7c10c6f6b5b9cb1528ba6ce96b59
+  data.tar.gz: cc3b427ff41229556b7b39a9d0ad5d61afdd0439fa984aafadd0aa9635ac4664
 SHA512:
-  metadata.gz: e1ab4426da76e5a0de997d9b1f355c549197e4bd199629a37f6f787a9dcd068020c04ed190f117461490bb75d86a4070b475d481cc679005de731dacabb8fd64
-  data.tar.gz: 355cd6811da84829fad5f59927535b681c3f357968681d175c8a400f4e0b445920120daba944ea679dc965b582d65781063e2be199ffc372cda4e7df6739f89c
+  metadata.gz: 569ac3d4e157eebf08f948eab831f214a900d29a96028a703d541d3fa7de7fdcde6a2cb11413ff802c459ff163cff15feb00c3477abcae7b18d77c302255d529
+  data.tar.gz: 2804530bcc9aaf60f1b475a6948b357242dc96e15788835e34d6cc1989ec7bda8e0bd66372427ce4aa9d5b923eda5468a9c33087b716ac3ca379f391a6192f43

data/lib/bfs/blob.rb

@@ -32,6 +32,9 @@ module BFS
     end
 
     # Creates the blob and opens it for writing.
+    # If a block is passed the writer is automatically committed in the end.
+    # If no block is passed, you must manually call #commit to persist the
+    # result.
     def create(**opts, &block)
       @bucket.create(path, **opts, &block)
     end

data/lib/bfs/bucket/fs.rb

@@ -42,7 +42,7 @@ module BFS
         full = @root.join(norm_path(path))
         FileUtils.mkdir_p(full.dirname.to_s)
 
-        BFS::TempWriter.new(full, encoding: encoding, perm: perm) do |temp|
+        BFS::Writer.new(full, encoding: encoding, perm: perm) do |temp|
           FileUtils.mv temp, full.to_s
         end.perform(&block)
       end

data/lib/bfs/bucket/in_mem.rb

@@ -1,5 +1,6 @@
 require 'bfs'
 require 'stringio'
+require 'delegate'
 
 module BFS
   module Bucket
@@ -8,34 +9,18 @@ module BFS
       Entry = Struct.new(:io, :mtime, :content_type, :metadata)
 
       class Writer < DelegateClass(::StringIO)
-        def initialize(encoding:, &closer)
-          @closer = closer
+        include BFS::Writer::Mixin
+
+        def initialize(encoding:, &on_commit)
+          @on_commit = on_commit
 
           sio = StringIO.new
           sio.set_encoding(encoding)
           super sio
         end
 
-        def close
-          super.tap do
-            @closer&.call(self)
-          end
-        end
-
-        def close!
-          __getobj__.close
-        end
-
-        def perform
-          return self unless block_given?
-
-          begin
-            yield self
-            close
-          ensure
-            close!
-          end
-        end
+        alias close! close
+        alias commit_ref __getobj__
       end
 
       def initialize(**opts)

data/lib/bfs/helpers.rb

@@ -2,33 +2,45 @@ require 'tempfile'
 require 'delegate'
 
 module BFS
-  class TempWriter < DelegateClass(::Tempfile)
-    def initialize(name, tempdir: nil, perm: nil, **opts, &closer)
-      @closer = closer
+  class Writer < DelegateClass(::Tempfile)
+    module Mixin
+      def perform
+        return self unless block_given?
 
-      tempfile = ::Tempfile.new(File.basename(name.to_s), tempdir, **opts)
-      tempfile.chmod(perm) if perm
-      super tempfile
-    end
-
-    def perform
-      return self unless block_given?
+        begin
+          yield self
+          commit
+        ensure
+          discard
+        end
+      end
 
-      begin
-        yield self
+      def commit
         close
+        return false if @on_commit.nil?
+
+        @on_commit.call(commit_ref)
+        true
       ensure
+        discard
+      end
+
+      def discard
+        @on_commit = nil
         close!
       end
     end
 
-    def close
-      return if closed?
+    include Mixin
 
-      super.tap do
-        @closer&.call(path)
-      end
-      unlink
+    def initialize(name, tempdir: nil, perm: nil, **opts, &on_commit)
+      @on_commit = on_commit
+
+      tempfile = ::Tempfile.new(File.basename(name.to_s), tempdir, **opts)
+      tempfile.chmod(perm) if perm
+      super tempfile
     end
+
+    alias commit_ref path
   end
 end

data/spec/bfs/helpers_spec.rb

@@ -1,28 +1,28 @@
 require 'spec_helper'
 
-RSpec.describe BFS::TempWriter, core: true do
-  let(:closer) { proc {} }
-  subject { described_class.new 'test', &closer }
-
-  it 'should behave like a File' do
-    missing = ::File.public_instance_methods - subject.public_methods
-    expect(missing).to be_empty
-  end
+RSpec.describe BFS::Writer, core: true do
+  let(:on_commit) { proc { true } }
+  subject { described_class.new 'test', &on_commit }
 
   it 'should support custom params' do
-    subject = described_class.new 'test', perm: 0o640, &closer
+    subject = described_class.new 'test', perm: 0o640, &on_commit
     expect(subject.stat.mode).to eq(0o100640)
-    expect(subject.close).to be_truthy
+    expect(subject.commit).to be(true)
   end
 
-  it 'should execute a closer block' do
-    expect(closer).to receive(:call).with(subject.path).once
-    expect(subject.close).to be_truthy
-    expect(subject.close).to be_nil
+  it 'should execute a on_commit block' do
+    expect(on_commit).to receive(:call).with(subject.path).once
+    expect(subject.commit).to be(true)
+    expect(subject.commit).to be(false)
   end
 
-  it 'may skip closer block' do
-    expect(closer).not_to receive(:call)
-    expect(subject.close!).to be_truthy
+  it 'may skip on_commit block' do
+    expect(on_commit).not_to receive(:call)
+    expect(subject.discard).to be(true)
+  end
+
+  it 'should not auto-commit on close' do
+    expect(on_commit).not_to receive(:call)
+    expect(subject.close).to be_nil
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-10 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies: []
 description: Minimalist abstraction for bucket storage
 email: dimitrij@blacksquaremedia.com
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Multi-platform cloud bucket adapter