bfs 0.6.4 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d726d92a3fceb9313a497b3de260dde2d7ac4a26bbf7bbdcbdcd8b4b9f85225b
-  data.tar.gz: de306b8f11a3b5de6f5bfef0a5e18325c30cd92bccb9aae05c09299ffae7275b
+  metadata.gz: 6195cd2787fbdb31ce0b8af2eb251effe1b7e3389f9932c5d33162b608b76d03
+  data.tar.gz: 22e24de8c867056c68beb0d49672400915dd4247660430e0a21bdf5b132dbdbe
 SHA512:
-  metadata.gz: 5e09611641b682056651a500e17a6913004c45f0f852264cad2fa4133910d51241039370824b171c2eb49f5fee0ad60f7ea8ad9982b40539a0542f965a94d191
-  data.tar.gz: 793230a864db0e7ed4c6e01b2dad75c5a71c2fc0dbaf593003d0050f3b4b39e7d7eb679483b55cb4f107a5898e9cac7be17f1c291aa95d6e5287dad132efa69c
+  metadata.gz: 17810380ac6d3452247c63057bc06e11c5d0e831afff661638c09be8f9ea0c3ec586b39d563b46a059d979c66a1752699f2633a01d2ea8ae47357c8fbd7d2f2a
+  data.tar.gz: 9843329935c5561d2df1ac6e957168a68ce2d76033541e34288e7b6f7da898a1ca64da63508d3d79cfc9922d899958a86423056557c9159fde086cb003be5fd4

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

@@ -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,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,13 +5,34 @@ 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.
       # @option opts [Integer] :perm optional file permissions. Default: 0600.
-      def initialize(encoding: Encoding.default_external, **_opts)
+      def initialize(encoding: Encoding.default_external, perm: nil, **_opts)
         @encoding = encoding
-        @perm = perm
+
+        case perm
+        when Integer
+          @perm = perm
+        when String
+          @perm = perm.to_i(8)
+        end
+
+        BFS.defer(self, :close)
       end
 
       # Lists the contents of a bucket using a glob pattern
@@ -45,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
@@ -62,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,9 +15,17 @@ 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' do
+  it 'should support 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
     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/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.4
+  version: 0.7.3
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-07-10 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,19 +44,21 @@ 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:
   - - ">="
     - !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