bfs 0.6.5 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42c7ec0b9c8599e48be9756f29d10f2f023cac4ed533567ce3e25f3b9ccdcbfc
-  data.tar.gz: 2d63d874378606434e6311491c80b5993a21da95d465ec71c526e80faa2aa989
+  metadata.gz: c790272a036559149178dadb5932e424a90bbc535f842a298516457051912310
+  data.tar.gz: 9f673793872f84f34f4cd95fb396cac88d44d7fc338ac20888149303584790f1
 SHA512:
-  metadata.gz: 05f54cb6d54163291b5c4ba7df49d3bb358aa9ac524d2b73492265a67635b864be8fd710a0f5a7eca10c7420d8060fe64483e28d5b135a4e1272bb11000ce8cf
-  data.tar.gz: a4d43696270f615cd187952a88949b3e45fd3cfd0ad34a52d5cb2d8e52c1d50dba250d03a8bcb2f4ff85f1b12894ddcf464078555da98b0a13e3c8f962588a0d
+  metadata.gz: 53547ee9f745695a72196d8eb3d9b09054ea2d6cc106993bce0fe22d563e31cb67f450edc28424de2d9aa6b7f72126235dcd5a31c179b5c15c27ed739da21214
+  data.tar.gz: b6e0927840f82b058d2662e8b29e33fe9a6697b4219cf451c0ce49cb778e79070ce684ab8bc37e4f9dd2756898275fa872cd29d3dd20e175487649a216794f5b

data/bfs.gemspec

@@ -15,5 +15,5 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 2.5.0'
+  s.required_ruby_version = '>= 2.6.0'
 end

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

@@ -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/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 }
 

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.6.5
+  version: 0.7.4
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-10-26 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
@@ -41,7 +44,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -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