bfs 0.6.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e9c5b7b27a3bca8975dac3ccce6d99fc3e22a012758adf5a82baceeafd12aa7
-  data.tar.gz: 930feef7182ef50e2106e8b48f0af0cf388b8cfa8cb39d3bf6a2dc0bb556568f
+  metadata.gz: 4851ad3e633d9ba6e2e1533206f9810390ff29959d047916f32004c4432bc282
+  data.tar.gz: 9129b8d9d6a87a8a5e97bd45145b4936f07bfd27c6c088bad6797477afcbf795
 SHA512:
-  metadata.gz: 496a92c2ac19fb0fb11a4fafbf20db067df87b678dbfea6d90fdf53e8f9088c8b1f059d87a93cd2da3de6a610f033a5ed6dec2eba0cffedad31a76a518130071
-  data.tar.gz: 56991e1f1088e1b361635ba17b3c235e464bd98e587db34a28e7e7d01c3b60c692b4b508646686a008e38cd731413dfd13174e87fe9b6e135317d24558fbee39
+  metadata.gz: 015a5be095930a9f2a4b446809ac4d2684cd4c49ff3b56fc7a28b1f43b2bfe49953625092fcdced43969407d9d40e63eabc6f127fcb58d139d7de55b4b6f98d3
+  data.tar.gz: 8a3dcc158679457ba9881a29d47c0e4a1c316b040c2080bba61f80c596f20245125b1071a47c9540f65a588e94cccdf519bf0d975a38693c6b5e89ccee5c9326

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

@@ -1,4 +1,5 @@
 require 'uri'
+require 'cgi'
 
 module BFS
   class FileInfo < Hash
@@ -39,12 +40,16 @@ 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
 
-    rsl.call(url)
+    opts = {}
+    CGI.parse(url.query.to_s).each do |key, values|
+      opts[key.to_sym] = values.first
+    end
+    rsl.call(url, opts, block)
   end
 
   def self.norm_path(path)
@@ -59,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

@@ -3,11 +3,35 @@ require 'bfs'
 module BFS
   module Bucket
     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.
-      def initialize(encoding: Encoding.default_external, **_opts)
+      # @option opts [Integer] :perm optional file permissions. Default: 0600.
+      def initialize(encoding: Encoding.default_external, perm: nil, **_opts)
         @encoding = encoding
+
+        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
@@ -41,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
@@ -58,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

@@ -38,12 +38,11 @@ module BFS
       # @param [Hash] opts Additional options.
       # @option opts [String] :encoding Custom encoding.
       # @option opts [Integer] :perm Custom file permission, default: 0600.
-      def create(path, encoding: nil, perm: nil, **_opts, &block)
+      def create(path, encoding: self.encoding, perm: self.perm, **_opts, &block)
         full = @root.join(norm_path(path))
         FileUtils.mkdir_p(full.dirname.to_s)
 
-        enc  = encoding || @encoding
-        temp = BFS::TempWriter.new(full, encoding: enc, perm: perm) {|t| FileUtils.mv t, full.to_s }
+        temp = BFS::TempWriter.new(full, encoding: encoding, perm: perm) {|t| FileUtils.mv t, full.to_s }
         return temp unless block
 
         begin
@@ -103,7 +102,7 @@ module BFS
   end
 end
 
-BFS.register('file') do |url|
+BFS.register('file') do |url, opts, block|
   parts = [url.host, url.path].compact
-  BFS::Bucket::FS.new File.join(*parts)
+  BFS::Bucket::FS.open(File.join(*parts), **opts, &block)
 end

data/lib/bfs/bucket/in_mem.rb

@@ -42,11 +42,11 @@ module BFS
       # @option opts [String] :encoding Custom encoding.
       # @option opts [String] :content_type Custom content type.
       # @option opts [Hash] :metadata Metadata key-value pairs.
-      def create(path, **opts, &block)
+      def create(path, encoding: self.encoding, content_type: nil, metadata: nil, **_opts, &block)
         io = StringIO.new
-        io.set_encoding(opts.delete(:encoding) || @encoding)
+        io.set_encoding(encoding)
 
-        entry = Entry.new(io, Time.now, opts.delete(:content_type), norm_meta(opts.delete(:metadata)))
+        entry = Entry.new(io, Time.now, content_type, norm_meta(metadata))
         @files[norm_path(path)] = entry
         return io unless block
 

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/bucket/fs_spec.rb

@@ -17,7 +17,14 @@ RSpec.describe BFS::Bucket::FS do
     expect(bucket.ls.to_a).to eq(['test.txt'])
   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_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.6.2
+  version: 0.7.1
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-12 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
@@ -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.0.6
+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