bfs 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20aaadf82c4feef66bb9f7ca3a50c2da292e5b107d69d5e055e139cea1aca352
-  data.tar.gz: aef5f242aa8e8b22cb940ac20b280650ba4d499025a5cc3efa620b8c6f375d7e
+  metadata.gz: 3de22f9cab6ba21d594854a2fcec49cc215b7c10c6f6b5b9cb1528ba6ce96b59
+  data.tar.gz: cc3b427ff41229556b7b39a9d0ad5d61afdd0439fa984aafadd0aa9635ac4664
 SHA512:
-  metadata.gz: 77722ad5d90e91f1abbaac4dfb633ad355de949c6a9e23cf383690de426666344e4431fa3a2da0490f7b065744e0786709beb8f18e1cd8ad2ade12ede3e895c7
-  data.tar.gz: dc0fe99895a120ebcf6e4d6f5cb2f62fc01d2caa62ac2a985a336e9f77bc186f0edeb3ae17899bec22753c61ba63dc09b8c8c61f209808c02202e6aa141d32c8
+  metadata.gz: 569ac3d4e157eebf08f948eab831f214a900d29a96028a703d541d3fa7de7fdcde6a2cb11413ff802c459ff163cff15feb00c3477abcae7b18d77c302255d529
+  data.tar.gz: 2804530bcc9aaf60f1b475a6948b357242dc96e15788835e34d6cc1989ec7bda8e0bd66372427ce4aa9d5b923eda5468a9c33087b716ac3ca379f391a6192f43

data/lib/bfs.rb

@@ -4,6 +4,8 @@ require 'cgi'
 module BFS
   class FileInfo < Hash
     def initialize(**attrs)
+      super(nil)
+
       update(size: 0, mtime: Time.at(0), mode: 0, metadata: {})
       update(attrs)
     end
@@ -36,10 +38,23 @@ module BFS
   def self.register(*schemes, &resolver)
     @registry ||= {}
     schemes.each do |scheme|
+      scheme = scheme.to_s
+      raise(ArgumentError, "scheme #{scheme} is already registered") if @registry.key?(scheme)
+
       @registry[scheme] = resolver
     end
   end
 
+  def self.unregister(*schemes)
+    @registry ||= {}
+    schemes.each do |scheme|
+      scheme = scheme.to_s
+      raise(ArgumentError, "scheme #{scheme} is not registered") unless @registry.key?(scheme)
+
+      @registry.delete(scheme)
+    end
+  end
+
   def self.resolve(url, &block)
     url = url.is_a?(::URI) ? url.dup : URI.parse(url)
     rsl = @registry[url.scheme]

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,14 +42,9 @@ module BFS
         full = @root.join(norm_path(path))
         FileUtils.mkdir_p(full.dirname.to_s)
 
-        temp = BFS::TempWriter.new(full, encoding: encoding, perm: perm) {|t| FileUtils.mv t, full.to_s }
-        return temp unless block
-
-        begin
-          yield temp
-        ensure
-          temp.close
-        end
+        BFS::Writer.new(full, encoding: encoding, perm: perm) do |temp|
+          FileUtils.mv temp, full.to_s
+        end.perform(&block)
       end
 
       # Opens an existing file for reading

data/lib/bfs/bucket/in_mem.rb

@@ -1,5 +1,6 @@
 require 'bfs'
 require 'stringio'
+require 'delegate'
 
 module BFS
   module Bucket
@@ -7,6 +8,21 @@ module BFS
     class InMem < Abstract
       Entry = Struct.new(:io, :mtime, :content_type, :metadata)
 
+      class Writer < DelegateClass(::StringIO)
+        include BFS::Writer::Mixin
+
+        def initialize(encoding:, &on_commit)
+          @on_commit = on_commit
+
+          sio = StringIO.new
+          sio.set_encoding(encoding)
+          super sio
+        end
+
+        alias close! close
+        alias commit_ref __getobj__
+      end
+
       def initialize(**opts)
         super(**opts.dup)
         @files = {}
@@ -43,18 +59,9 @@ module BFS
       # @option opts [String] :content_type Custom content type.
       # @option opts [Hash] :metadata Metadata key-value pairs.
       def create(path, encoding: self.encoding, content_type: nil, metadata: nil, **_opts, &block)
-        io = StringIO.new
-        io.set_encoding(encoding)
-
-        entry = Entry.new(io, Time.now, content_type, norm_meta(metadata))
-        @files[norm_path(path)] = entry
-        return io unless block
-
-        begin
-          yield(io)
-        ensure
-          io.close
-        end
+        Writer.new(encoding: encoding) do |wio|
+          @files[norm_path(path)] = Entry.new(wio, Time.now, content_type, norm_meta(metadata))
+        end.perform(&block)
       end
 
       # Opens an existing file for reading

data/lib/bfs/helpers.rb

@@ -2,21 +2,45 @@ require 'tempfile'
 require 'delegate'
 
 module BFS
-  class TempWriter < DelegateClass(::Tempfile)
-    def initialize(name, tempdir: nil, perm: nil, **opts, &closer)
-      @closer   = closer
-      @tempfile = ::Tempfile.new(File.basename(name.to_s), tempdir, **opts)
-      @tempfile.chmod(perm) if perm
-      super @tempfile
+  class Writer < DelegateClass(::Tempfile)
+    module Mixin
+      def perform
+        return self unless block_given?
+
+        begin
+          yield self
+          commit
+        ensure
+          discard
+        end
+      end
+
+      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
+
+    def initialize(name, tempdir: nil, perm: nil, **opts, &on_commit)
+      @on_commit = on_commit
 
-      path = @tempfile.path
-      @tempfile.close
-      @closer&.call(path)
-      @tempfile.unlink
+      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/blob_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe BFS::Blob do
+RSpec.describe BFS::Blob, core: true do
   describe 'default' do
     let(:bucket) { BFS::Bucket::InMem.new }
     before       { allow(BFS).to receive(:resolve).and_return(bucket) }

data/spec/bfs/bucket/abstract_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe BFS::Bucket::Abstract do
+RSpec.describe BFS::Bucket::Abstract, core: true do
   it 'should open with a block' do
     sub_class = Class.new(described_class) do
       def close

data/spec/bfs/bucket/fs_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe BFS::Bucket::FS do
+RSpec.describe BFS::Bucket::FS, core: true do
   let(:tmpdir) { Dir.mktmpdir }
   after   { FileUtils.rm_rf tmpdir }
   subject { described_class.new(tmpdir) }
@@ -15,6 +15,7 @@ RSpec.describe BFS::Bucket::FS do
     bucket = BFS.resolve("file://#{tmpdir}")
     expect(bucket).to be_instance_of(described_class)
     expect(bucket.ls.to_a).to eq(['test.txt'])
+    bucket.close
   end
 
   it 'should support custom perms on #initialize' do

data/spec/bfs/bucket/in_mem_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
 
-RSpec.describe BFS::Bucket::InMem do
+RSpec.describe BFS::Bucket::InMem, core: true do
   it_behaves_like 'a bucket'
 end

data/spec/bfs/helpers_spec.rb

@@ -1,22 +1,28 @@
 require 'spec_helper'
 
-RSpec.describe BFS::TempWriter 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 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 on_commit block' do
+    expect(on_commit).not_to receive(:call)
+    expect(subject.discard).to be(true)
   end
 
-  it 'should exectute a closer block' do
-    expect(closer).to receive(:call).with(subject.path)
-    expect(subject.close).to be_truthy
+  it 'should not auto-commit on close' do
+    expect(on_commit).not_to receive(:call)
+    expect(subject.close).to be_nil
   end
 end

data/spec/bfs_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe BFS do
+RSpec.describe BFS, core: true do
   it 'should resolve' do
     bucket = BFS.resolve("file://#{Dir.tmpdir}")
     expect(bucket).to be_instance_of(BFS::Bucket::FS)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 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