bfs 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8d42e2ce3e53b671a1210c70ced9c25e96b5ca60effac77ada4868ef26d299
-  data.tar.gz: 881dd9522385bc0417cb12bf6ab492a9f772dd091042130db614b6252ec29d24
+  metadata.gz: 4851ad3e633d9ba6e2e1533206f9810390ff29959d047916f32004c4432bc282
+  data.tar.gz: 9129b8d9d6a87a8a5e97bd45145b4936f07bfd27c6c088bad6797477afcbf795
 SHA512:
-  metadata.gz: abe8ef5d0579001860159f7485e0cb254d013e10575a2c5fd8b56e3ba94e3766d1b4db0f1843a3261dc50f8f30f15d16115fdabf976a441fb42a81711c4cea1a
-  data.tar.gz: 98238249263bff71a4d48677296d3e4641d788ab355fdff0a4253792884daf38356cc3823c93b6b4f1bb33de234a80f0043b0c52db75b3d0ffea718d6b510fed
+  metadata.gz: 015a5be095930a9f2a4b446809ac4d2684cd4c49ff3b56fc7a28b1f43b2bfe49953625092fcdced43969407d9d40e63eabc6f127fcb58d139d7de55b4b6f98d3
+  data.tar.gz: 8a3dcc158679457ba9881a29d47c0e4a1c316b040c2080bba61f80c596f20245125b1071a47c9540f65a588e94cccdf519bf0d975a38693c6b5e89ccee5c9326

data/lib/bfs.rb

@@ -40,7 +40,7 @@ module BFS
     end
   end
 
-  def self.resolve(url)
+  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 +49,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 +64,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,26 @@ 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)
+      begin
+        yield blob
+      ensure
+        blob.close
+      end if block_given?
+      blob
+    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 +48,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,18 @@ 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)
+        begin
+          yield bucket
+        ensure
+          bucket.close
+        end if block_given?
+        bucket
+      end
+
       # Initializes a new bucket
       # @param [Hash] opts options
       # @option opts [String] :encoding Custom encoding. Default: Encoding.default_external.
@@ -18,6 +30,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 +65,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 +82,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

@@ -102,7 +102,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/fs.rb

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

data/spec/bfs/bucket/abstract_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+RSpec.describe BFS::Bucket::Abstract 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
+    sub_class.open do |bkt|
+      expect(bkt).not_to be_closed
+      bucket = bkt
+    end
+    expect(bucket).to be_instance_of(sub_class)
+    expect(bucket).to be_closed
+  end
+end

data/spec/bfs_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+RSpec.describe BFS 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.1
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-07-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
@@ -48,12 +51,14 @@ 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
 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