bfs 0.7.0 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8d42e2ce3e53b671a1210c70ced9c25e96b5ca60effac77ada4868ef26d299
-  data.tar.gz: 881dd9522385bc0417cb12bf6ab492a9f772dd091042130db614b6252ec29d24
+  metadata.gz: 61e0b8f8c56a60a7d3b933aacce3e476d400389bfa991b14b3adddf3af667108
+  data.tar.gz: ab0da145b04da234825c0c418a5e5dc0fc3028627431072df04c5f2f7f45b652
 SHA512:
-  metadata.gz: abe8ef5d0579001860159f7485e0cb254d013e10575a2c5fd8b56e3ba94e3766d1b4db0f1843a3261dc50f8f30f15d16115fdabf976a441fb42a81711c4cea1a
-  data.tar.gz: 98238249263bff71a4d48677296d3e4641d788ab355fdff0a4253792884daf38356cc3823c93b6b4f1bb33de234a80f0043b0c52db75b3d0ffea718d6b510fed
+  metadata.gz: 4ba809e64dfdab6a918a807323acffd3228783d5c4c6a3ecc9712011ca742a2510e830fe7c2cbf73f2b0d900bdd9d5a9386e133c16ba3170b6be972366db0405
+  data.tar.gz: 1999418b45ed5c090b7bf578f9ea6c8964eb49538b98068c6eff583480b1682d63ef61a04a3f9183ba54f027e9bd876b618d5297795c469c43127474e808449d

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,11 +38,24 @@ 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.resolve(url)
+  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]
     raise ArgumentError, "Unable to resolve #{url}, scheme #{url.scheme} is not registered" unless rsl
@@ -49,7 +64,7 @@ module BFS
     CGI.parse(url.query.to_s).each do |key, values|
       opts[key.to_sym] = values.first
     end
-    rsl.call(url, opts)
+    rsl.call(url, opts, block)
   end
 
   def self.norm_path(path)
@@ -64,6 +79,11 @@ module BFS
     mode = mode.to_i(8) if mode.is_a?(String)
     mode & 0o000777
   end
+
+  def self.defer(obj, method)
+    owner = Process.pid
+    ObjectSpace.define_finalizer(obj, ->(*) { obj.send(method) if Process.pid == owner })
+  end
 end
 
 require 'bfs/helpers'

data/lib/bfs/blob.rb

@@ -3,12 +3,27 @@ module BFS
   class Blob
     attr_reader :path
 
+    # Behaves like new, but accepts an optional block.
+    # If a block is given, blobs are automatically closed after the block is yielded.
+    def self.open(url)
+      blob = new(url)
+      return blob unless block_given?
+
+      begin
+        yield blob
+      ensure
+        blob.close
+      end
+    end
+
     def initialize(url)
       url = url.is_a?(::URI) ? url.dup : URI.parse(url)
       @path = BFS.norm_path(url.path)
 
       url.path = '/'
       @bucket = BFS.resolve(url)
+
+      BFS.defer(self, :close)
     end
 
     # Info returns the blob info.
@@ -34,7 +49,7 @@ module BFS
 
     # Shortcut method to read the contents of the blob.
     def read(**opts)
-      open(**opts, &:read)
+      self.open(**opts, &:read)
     end
 
     # Shortcut method to write data to blob.

data/lib/bfs/bucket/abstract.rb

@@ -5,6 +5,19 @@ module BFS
     class Abstract
       attr_reader :encoding, :perm
 
+      # Behaves like new, but accepts an optional block.
+      # If a block is given, buckets are automatically closed after the block is yielded.
+      def self.open(*args, **opts)
+        bucket = new(*args, **opts)
+        return bucket unless block_given?
+
+        begin
+          yield bucket
+        ensure
+          bucket.close
+        end
+      end
+
       # Initializes a new bucket
       # @param [Hash] opts options
       # @option opts [String] :encoding Custom encoding. Default: Encoding.default_external.
@@ -18,6 +31,8 @@ module BFS
         when String
           @perm = perm.to_i(8)
         end
+
+        BFS.defer(self, :close)
       end
 
       # Lists the contents of a bucket using a glob pattern
@@ -51,7 +66,7 @@ module BFS
       # @param [String] path The path to read from.
       # @param [Hash] opts Additional options, see #open.
       def read(path, **opts)
-        open(path, **opts, &:read)
+        self.open(path, **opts, &:read)
       end
 
       # Shortcut method to write data to path
@@ -68,7 +83,7 @@ module BFS
       # @param [String] src The source path.
       # @param [String] dst The destination path.
       def cp(src, dst, **opts)
-        open(src, **opts) do |r|
+        self.open(src, **opts) do |r|
           create(dst, **opts) do |w|
             IO.copy_stream(r, w)
           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::TempWriter.new(full, encoding: encoding, perm: perm) do |temp|
+          FileUtils.mv temp, full.to_s
+        end.perform(&block)
       end
 
       # Opens an existing file for reading
@@ -102,7 +97,7 @@ module BFS
   end
 end
 
-BFS.register('file') do |url, opts|
+BFS.register('file') do |url, opts, block|
   parts = [url.host, url.path].compact
-  BFS::Bucket::FS.new File.join(*parts), **opts
+  BFS::Bucket::FS.open(File.join(*parts), **opts, &block)
 end

data/lib/bfs/bucket/in_mem.rb

@@ -7,6 +7,36 @@ module BFS
     class InMem < Abstract
       Entry = Struct.new(:io, :mtime, :content_type, :metadata)
 
+      class Writer < DelegateClass(::StringIO)
+        def initialize(encoding:, &closer)
+          @closer = closer
+
+          sio = StringIO.new
+          sio.set_encoding(encoding)
+          super sio
+        end
+
+        def close
+          close!
+          @closer&.call(self)
+        end
+
+        def close!
+          __getobj__.close
+        end
+
+        def perform(&block)
+          return self unless block
+
+          begin
+            yield self
+            close
+          ensure
+            close!
+          end
+        end
+      end
+
       def initialize(**opts)
         super(**opts.dup)
         @files = {}
@@ -43,18 +73,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/fs.rb

@@ -0,0 +1 @@
+require 'bfs/bucket/fs'

data/lib/bfs/helpers.rb

@@ -4,19 +4,33 @@ 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
+      @closer = closer
+
+      tempfile = ::Tempfile.new(File.basename(name.to_s), tempdir, **opts)
+      tempfile.chmod(perm) if perm
+      super tempfile
+    end
+
+    def perform(&block)
+      return self unless block
+
+      begin
+        yield self
+        close
+      ensure
+        close!
+      end
     end
 
     def close
       return if closed?
 
-      path = @tempfile.path
-      @tempfile.close
-      @closer&.call(path)
-      @tempfile.unlink
+      tempfile = __getobj__
+      tempfile.close
+      @closer&.call(tempfile.path)
+      true
+    ensure
+      tempfile.unlink
     end
   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

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+RSpec.describe BFS::Bucket::Abstract, core: true do
+  it 'should open with a block' do
+    sub_class = Class.new(described_class) do
+      def close
+        @closed = true
+      end
+
+      def closed?
+        @closed == true
+      end
+    end
+
+    bucket = nil
+    result = sub_class.open do |bkt|
+      expect(bkt).not_to be_closed
+      bucket = bkt
+      21
+    end
+    expect(result).to eq(21)
+    expect(bucket).to be_instance_of(sub_class)
+    expect(bucket).to be_closed
+  end
+end

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,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe BFS::TempWriter do
+RSpec.describe BFS::TempWriter, core: true do
   let(:closer) { proc {} }
   subject { described_class.new 'test', &closer }
 
@@ -19,4 +19,9 @@ RSpec.describe BFS::TempWriter do
     expect(closer).to receive(:call).with(subject.path)
     expect(subject.close).to be_truthy
   end
+
+  it 'may skip closer block' do
+    expect(closer).not_to receive(:call)
+    expect(subject.close!).to be_truthy
+  end
 end

data/spec/bfs_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+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)
+    bucket.close
+  end
+
+  it 'should resolve with block' do
+    BFS.resolve("file://#{Dir.tmpdir}") do |bucket|
+      expect(bucket).to be_instance_of(BFS::Bucket::FS)
+      expect(bucket).to receive(:close)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.5
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies: []
 description: Minimalist abstraction for bucket storage
 email: dimitrij@blacksquaremedia.com
@@ -24,11 +24,14 @@ files:
 - lib/bfs/bucket/fs.rb
 - lib/bfs/bucket/in_mem.rb
 - lib/bfs/errors.rb
+- lib/bfs/fs.rb
 - lib/bfs/helpers.rb
 - spec/bfs/blob_spec.rb
+- spec/bfs/bucket/abstract_spec.rb
 - spec/bfs/bucket/fs_spec.rb
 - spec/bfs/bucket/in_mem_spec.rb
 - spec/bfs/helpers_spec.rb
+- spec/bfs_spec.rb
 homepage: https://github.com/bsm/bfs.rb
 licenses:
 - Apache-2.0
@@ -54,6 +57,8 @@ specification_version: 4
 summary: Multi-platform cloud bucket adapter
 test_files:
 - spec/bfs/blob_spec.rb
+- spec/bfs/bucket/abstract_spec.rb
 - spec/bfs/bucket/fs_spec.rb
 - spec/bfs/bucket/in_mem_spec.rb
 - spec/bfs/helpers_spec.rb
+- spec/bfs_spec.rb