bfs 0.7.3 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6195cd2787fbdb31ce0b8af2eb251effe1b7e3389f9932c5d33162b608b76d03
-  data.tar.gz: 22e24de8c867056c68beb0d49672400915dd4247660430e0a21bdf5b132dbdbe
+  metadata.gz: 20fe1fe66fa9d9d5bc0bbee1e912a505eed9a19bfc26bfc7c7d4a37aa7cb11bc
+  data.tar.gz: 6ed8b53369f1cdd1258ff371599b29658b0232f5c05f4c6b1425120520d7e0a2
 SHA512:
-  metadata.gz: 17810380ac6d3452247c63057bc06e11c5d0e831afff661638c09be8f9ea0c3ec586b39d563b46a059d979c66a1752699f2633a01d2ea8ae47357c8fbd7d2f2a
-  data.tar.gz: 9843329935c5561d2df1ac6e957168a68ce2d76033541e34288e7b6f7da898a1ca64da63508d3d79cfc9922d899958a86423056557c9159fde086cb003be5fd4
+  metadata.gz: 50d32db0f8b0014c06bdacd7f418dc26bca5bc1aae773d45128b2fc9cd02990a36833b05a0957972df0fb52a12f1258385ec2f5987bff7de07afa47f381208f8
+  data.tar.gz: 6654baa91816121fbea28ea73f854f47b5477325a5c2f1c5e588a81fcab9df60659cbbf760dac48f75e3456bc08af966f807706e1f694470602ef26956ad1fa5

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

@@ -2,12 +2,15 @@ require 'spec_helper'
 
 RSpec.describe BFS::Blob, core: true do
   describe 'default' do
+    subject      { described_class.new('memtest://bucket/path/to/file.txt') }
+
     let(:bucket) { BFS::Bucket::InMem.new }
+
     before       { allow(BFS).to receive(:resolve).and_return(bucket) }
-    subject      { described_class.new('memtest://bucket/path/to/file.txt') }
+
     after        { subject.close }
 
-    it 'should move' do
+    it 'moves' do
       expect(subject.path).to eq('path/to/file.txt')
       expect { subject.mv('/to/other/path.txt') }.to raise_error(BFS::FileNotFound)
 
@@ -16,7 +19,7 @@ RSpec.describe BFS::Blob, core: true do
       expect(subject.path).to eq('to/other/path.txt')
     end
 
-    it 'should write/read' do
+    it 'write/reads' do
       expect { subject.read }.to raise_error(BFS::FileNotFound)
       subject.write('TESTDATA', content_type: 'text/plain', metadata: { 'x-key' => 'val' })
 
@@ -36,12 +39,14 @@ RSpec.describe BFS::Blob, core: true do
   end
 
   describe 'file system' do
+    subject { described_class.new("file:///#{path}") }
+
     let(:tmpdir) { Dir.mktmpdir }
     let(:path)   { "#{tmpdir}/path/to/file.txt".sub('/', '') }
-    after   { FileUtils.rm_rf tmpdir }
-    subject { described_class.new("file:///#{path}") }
 
-    it 'should move' do
+    after { FileUtils.rm_rf tmpdir }
+
+    it 'moves' do
       expect(subject.path).to eq(path)
       expect { subject.mv("#{tmpdir}/to/other/path.txt") }.to raise_error(BFS::FileNotFound)
 
@@ -54,7 +59,7 @@ RSpec.describe BFS::Blob, core: true do
       ]
     end
 
-    it 'should write/read' do
+    it 'write/reads' do
       expect { subject.read }.to raise_error(BFS::FileNotFound)
 
       subject.write('TESTDATA', content_type: 'text/plain', metadata: { 'x-key' => 'val' })

data/spec/bfs/bucket/abstract_spec.rb

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

data/spec/bfs/bucket/fs_spec.rb

@@ -1,15 +1,17 @@
 require 'spec_helper'
 
 RSpec.describe BFS::Bucket::FS, core: true do
-  let(:tmpdir) { Dir.mktmpdir }
-  after   { FileUtils.rm_rf tmpdir }
   subject { described_class.new(tmpdir) }
 
+  let(:tmpdir) { Dir.mktmpdir }
+
+  after { FileUtils.rm_rf tmpdir }
+
   it_behaves_like 'a bucket',
                   content_type: false,
                   metadata: false
 
-  it 'should resolve from URL' do
+  it 'resolves from URL' do
     File.open(File.join(tmpdir, 'test.txt'), 'wb') {|f| f.write 'TESTDATA' }
 
     bucket = BFS.resolve("file://#{tmpdir}")
@@ -18,14 +20,14 @@ RSpec.describe BFS::Bucket::FS, core: true do
     bucket.close
   end
 
-  it 'should support custom perms on #initialize' do
+  it 'supports custom perms on #initialize' do
     blob = BFS::Blob.new("file://#{tmpdir}/test.txt?perm=0666")
     blob.create {|w| w.write 'foo' }
     expect(blob.info.mode).to eq(0o666)
     blob.close
   end
 
-  it 'should support custom perms on #create' do
+  it 'supports custom perms on #create' do
     blob = BFS::Blob.new("file://#{tmpdir}/test.txt")
     blob.create(perm: 0o666) {|w| w.write 'foo' }
     expect(blob.info.mode).to eq(0o666)

data/spec/bfs/helpers_spec.rb

@@ -1,22 +1,29 @@
 require 'spec_helper'
 
-RSpec.describe BFS::TempWriter, core: true do
-  let(:closer) { proc {} }
-  subject { described_class.new 'test', &closer }
+RSpec.describe BFS::Writer, core: true do
+  subject { described_class.new 'test', &on_commit }
 
-  it 'should behave like a File' do
-    missing = ::File.public_instance_methods - subject.public_methods
-    expect(missing).to be_empty
-  end
+  let(:on_commit) { proc { true } }
 
-  it 'should support custom params' do
-    subject = described_class.new 'test', perm: 0o640, &closer
+  it 'supports custom params' do
+    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 'executes 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 'does 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,14 +1,14 @@
 require 'spec_helper'
 
 RSpec.describe BFS, core: true do
-  it 'should resolve' do
-    bucket = BFS.resolve("file://#{Dir.tmpdir}")
+  it 'resolves' do
+    bucket = described_class.resolve("file://#{Dir.tmpdir}")
     expect(bucket).to be_instance_of(BFS::Bucket::FS)
     bucket.close
   end
 
-  it 'should resolve with block' do
-    BFS.resolve("file://#{Dir.tmpdir}") do |bucket|
+  it 'resolves with block' do
+    described_class.resolve("file://#{Dir.tmpdir}") do |bucket|
       expect(bucket).to be_instance_of(BFS::Bucket::FS)
       expect(bucket).to receive(:close)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.1
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies: []
 description: Minimalist abstraction for bucket storage
 email: dimitrij@blacksquaremedia.com