bfs 0.7.6 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd67ecfdb038d1809be4193caf014dfd9e8bcba4e26a4cd04da3c64e61522ddc
-  data.tar.gz: 17586a9b02836e8bdcbf4da6bc822d9c169cca9823b5817357dba1d4a5f1a072
+  metadata.gz: 5b84026761dc7be719468a7f2b76a206d21747eb2fc87811b5c9febab4054176
+  data.tar.gz: fc8438759bb6b51002b1565d812f316e71bbc5e829ded770f9f9c642acec8b73
 SHA512:
-  metadata.gz: e1ab4426da76e5a0de997d9b1f355c549197e4bd199629a37f6f787a9dcd068020c04ed190f117461490bb75d86a4070b475d481cc679005de731dacabb8fd64
-  data.tar.gz: 355cd6811da84829fad5f59927535b681c3f357968681d175c8a400f4e0b445920120daba944ea679dc965b582d65781063e2be199ffc372cda4e7df6739f89c
+  metadata.gz: 474d67a3cab3c887eb36ceba96b963ce6c6289b8042986c2a09882276e84252a68abc5e0f501b9e29616d015fbd4a31e4479fcadced45e67336e5c5a8383a9a9
+  data.tar.gz: dbb7755e5141715c2c105c0b074e607a8a28c8b12267caa878bfef79156184b942a4cf45888255cb9b0218d574e12e591edf4765f6f71af0a50b03e50d89967c

data/lib/bfs/blob.rb

@@ -32,6 +32,9 @@ module BFS
     end
 
     # Creates the blob and opens it for writing.
+    # If a block is passed the writer is automatically committed in the end.
+    # If no block is passed, you must manually call #commit to persist the
+    # result.
     def create(**opts, &block)
       @bucket.create(path, **opts, &block)
     end

data/lib/bfs/bucket/abstract.rb

@@ -40,6 +40,11 @@ module BFS
         raise 'not implemented'
       end
 
+      # Iterates over the contents of a bucket using a glob pattern
+      def glob(_pattern = '**', **_opts)
+        raise 'not implemented'
+      end
+
       # Info returns the info for a single file
       def info(_path, **_opts)
         raise 'not implemented'
@@ -107,7 +112,7 @@ module BFS
       def norm_meta(meta)
         norm = {}
         meta.each do |key, value|
-          nkey = key.to_s.downcase.split(/-/).map(&:capitalize).join('-')
+          nkey = key.to_s.downcase.split('-').map(&:capitalize).join('-')
           norm[nkey] = value
         end if meta.is_a?(Hash)
         norm

data/lib/bfs/bucket/fs.rb

@@ -15,19 +15,30 @@ module BFS
 
       # Lists the contents of a bucket using a glob pattern
       def ls(pattern = '**/*', **_opts)
-        Enumerator.new do |y|
-          Pathname.glob(@root.join(pattern)) do |pname|
-            y << trim_prefix(pname.to_s) if pname.file?
+        Enumerator.new do |acc|
+          walk(pattern) do |path, _|
+            acc << path
+          end
+        end
+      end
+
+      # Iterates over the contents of a bucket using a glob pattern
+      def glob(pattern = '**/*', **_opts)
+        Enumerator.new do |acc|
+          walk(pattern) do |path, stat|
+            acc << file_info(path, stat)
           end
         end
       end
 
       # Info returns the info for a single file
       def info(path, **_opts)
-        full = @root.join(norm_path(path))
-        path = trim_prefix(full.to_s)
-        stat = full.stat
-        BFS::FileInfo.new(path: path, size: stat.size, mtime: stat.mtime, mode: BFS.norm_mode(stat.mode))
+        norm = norm_path(path)
+        pn   = @root.join(norm)
+        stat = pn.stat
+        raise BFS::FileNotFound, path unless stat.file?
+
+        file_info(norm, stat)
       rescue Errno::ENOENT
         raise BFS::FileNotFound, path
       end
@@ -42,7 +53,7 @@ module BFS
         full = @root.join(norm_path(path))
         FileUtils.mkdir_p(full.dirname.to_s)
 
-        BFS::TempWriter.new(full, encoding: encoding, perm: perm) do |temp|
+        BFS::Writer.new(full, encoding: encoding, perm: perm) do |temp|
           FileUtils.mv temp, full.to_s
         end.perform(&block)
       end
@@ -93,6 +104,19 @@ module BFS
       rescue Errno::ENOENT
         raise BFS::FileNotFound, norm_path(src)
       end
+
+      private
+
+      def walk(pattern)
+        Pathname.glob(@root.join(pattern)) do |pn|
+          stat = pn.stat
+          yield(trim_prefix(pn.to_s), stat) if stat.file?
+        end
+      end
+
+      def file_info(path, stat)
+        BFS::FileInfo.new(path: path, size: stat.size, mtime: stat.mtime, mode: BFS.norm_mode(stat.mode))
+      end
     end
   end
 end

data/lib/bfs/bucket/in_mem.rb

@@ -1,5 +1,6 @@
 require 'bfs'
 require 'stringio'
+require 'delegate'
 
 module BFS
   module Bucket
@@ -8,34 +9,18 @@ module BFS
       Entry = Struct.new(:io, :mtime, :content_type, :metadata)
 
       class Writer < DelegateClass(::StringIO)
-        def initialize(encoding:, &closer)
-          @closer = closer
+        include BFS::Writer::Mixin
+
+        def initialize(encoding:, &on_commit)
+          @on_commit = on_commit
 
           sio = StringIO.new
           sio.set_encoding(encoding)
           super sio
         end
 
-        def close
-          super.tap do
-            @closer&.call(self)
-          end
-        end
-
-        def close!
-          __getobj__.close
-        end
-
-        def perform
-          return self unless block_given?
-
-          begin
-            yield self
-            close
-          ensure
-            close!
-          end
-        end
+        alias close! close
+        alias commit_ref __getobj__
       end
 
       def initialize(**opts)
@@ -51,8 +36,17 @@ module BFS
       # Lists the contents of a bucket using a glob pattern
       def ls(pattern = '**/*', **_opts)
         Enumerator.new do |y|
-          @files.each_key do |key|
-            y << key if File.fnmatch?(pattern, key, File::FNM_PATHNAME)
+          @files.each_key do |path|
+            y << path if File.fnmatch?(pattern, path, File::FNM_PATHNAME)
+          end
+        end
+      end
+
+      # Iterates over the contents of a bucket using a glob pattern
+      def glob(pattern = '**/*', **_opts)
+        Enumerator.new do |y|
+          @files.each_key do |path|
+            y << file_info(path) if File.fnmatch?(pattern, path, File::FNM_PATHNAME)
           end
         end
       end
@@ -62,8 +56,7 @@ module BFS
         path = norm_path(path)
         raise BFS::FileNotFound, path unless @files.key?(path)
 
-        entry = @files[path]
-        BFS::FileInfo.new(path: path, size: entry.io.size, mtime: entry.mtime, content_type: entry.content_type, metadata: entry.metadata)
+        file_info(path)
       end
 
       # Creates a new file and opens it for writing.
@@ -99,6 +92,13 @@ module BFS
       def rm(path, **_opts)
         @files.delete(norm_path(path))
       end
+
+      private
+
+      def file_info(path)
+        entry = @files[path]
+        BFS::FileInfo.new path: path, size: entry.io.size, mtime: entry.mtime, content_type: entry.content_type, metadata: entry.metadata
+      end
     end
   end
 end

data/lib/bfs/helpers.rb

@@ -2,33 +2,45 @@ require 'tempfile'
 require 'delegate'
 
 module BFS
-  class TempWriter < DelegateClass(::Tempfile)
-    def initialize(name, tempdir: nil, perm: nil, **opts, &closer)
-      @closer = closer
+  class Writer < DelegateClass(::Tempfile)
+    module Mixin
+      def perform
+        return self unless block_given?
 
-      tempfile = ::Tempfile.new(File.basename(name.to_s), tempdir, **opts)
-      tempfile.chmod(perm) if perm
-      super tempfile
-    end
-
-    def perform
-      return self unless block_given?
+        begin
+          yield self
+          commit
+        ensure
+          discard
+        end
+      end
 
-      begin
-        yield self
+      def commit
         close
+        return false if @on_commit.nil?
+
+        @on_commit.call(commit_ref)
+        true
       ensure
+        discard
+      end
+
+      def discard
+        @on_commit = nil
         close!
       end
     end
 
-    def close
-      return if closed?
+    include Mixin
 
-      super.tap do
-        @closer&.call(path)
-      end
-      unlink
+    def initialize(name, tempdir: nil, perm: nil, **opts, &on_commit)
+      @on_commit = on_commit
+
+      tempfile = ::Tempfile.new(File.basename(name.to_s), tempdir, **opts)
+      tempfile.chmod(perm) if perm
+      super tempfile
     end
+
+    alias commit_ref path
   end
 end

data/spec/bfs/blob_spec.rb

@@ -2,12 +2,15 @@ require 'spec_helper'
 
 RSpec.describe BFS::Blob, core: true do
   describe 'default' do
+    subject      { described_class.new('memtest://bucket/path/to/file.txt') }
+
     let(:bucket) { BFS::Bucket::InMem.new }
+
     before       { allow(BFS).to receive(:resolve).and_return(bucket) }
-    subject      { described_class.new('memtest://bucket/path/to/file.txt') }
+
     after        { subject.close }
 
-    it 'should move' do
+    it 'moves' do
       expect(subject.path).to eq('path/to/file.txt')
       expect { subject.mv('/to/other/path.txt') }.to raise_error(BFS::FileNotFound)
 
@@ -16,7 +19,7 @@ RSpec.describe BFS::Blob, core: true do
       expect(subject.path).to eq('to/other/path.txt')
     end
 
-    it 'should write/read' do
+    it 'write/reads' do
       expect { subject.read }.to raise_error(BFS::FileNotFound)
       subject.write('TESTDATA', content_type: 'text/plain', metadata: { 'x-key' => 'val' })
 
@@ -36,12 +39,14 @@ RSpec.describe BFS::Blob, core: true do
   end
 
   describe 'file system' do
+    subject { described_class.new("file:///#{path}") }
+
     let(:tmpdir) { Dir.mktmpdir }
     let(:path)   { "#{tmpdir}/path/to/file.txt".sub('/', '') }
-    after   { FileUtils.rm_rf tmpdir }
-    subject { described_class.new("file:///#{path}") }
 
-    it 'should move' do
+    after { FileUtils.rm_rf tmpdir }
+
+    it 'moves' do
       expect(subject.path).to eq(path)
       expect { subject.mv("#{tmpdir}/to/other/path.txt") }.to raise_error(BFS::FileNotFound)
 
@@ -54,7 +59,7 @@ RSpec.describe BFS::Blob, core: true do
       ]
     end
 
-    it 'should write/read' do
+    it 'write/reads' do
       expect { subject.read }.to raise_error(BFS::FileNotFound)
 
       subject.write('TESTDATA', content_type: 'text/plain', metadata: { 'x-key' => 'val' })

data/spec/bfs/bucket/abstract_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe BFS::Bucket::Abstract, core: true do
-  it 'should open with a block' do
+  it 'opens with a block' do
     sub_class = Class.new(described_class) do
       def close
         @closed = true

data/spec/bfs/bucket/fs_spec.rb

@@ -1,15 +1,17 @@
 require 'spec_helper'
 
 RSpec.describe BFS::Bucket::FS, core: true do
-  let(:tmpdir) { Dir.mktmpdir }
-  after   { FileUtils.rm_rf tmpdir }
   subject { described_class.new(tmpdir) }
 
+  let(:tmpdir) { Dir.mktmpdir }
+
+  after { FileUtils.rm_rf tmpdir }
+
   it_behaves_like 'a bucket',
                   content_type: false,
                   metadata: false
 
-  it 'should resolve from URL' do
+  it 'resolves from URL' do
     File.open(File.join(tmpdir, 'test.txt'), 'wb') {|f| f.write 'TESTDATA' }
 
     bucket = BFS.resolve("file://#{tmpdir}")
@@ -18,14 +20,14 @@ RSpec.describe BFS::Bucket::FS, core: true do
     bucket.close
   end
 
-  it 'should support custom perms on #initialize' do
+  it 'supports 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
+  it 'supports 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/helpers_spec.rb

@@ -1,28 +1,29 @@
 require 'spec_helper'
 
-RSpec.describe BFS::TempWriter, core: true do
-  let(:closer) { proc {} }
-  subject { described_class.new 'test', &closer }
+RSpec.describe BFS::Writer, core: true do
+  subject { described_class.new 'test', &on_commit }
 
-  it 'should behave like a File' do
-    missing = ::File.public_instance_methods - subject.public_methods
-    expect(missing).to be_empty
-  end
+  let(:on_commit) { proc { true } }
 
-  it 'should support custom params' do
-    subject = described_class.new 'test', perm: 0o640, &closer
+  it 'supports custom params' do
+    subject = described_class.new 'test', perm: 0o640, &on_commit
     expect(subject.stat.mode).to eq(0o100640)
-    expect(subject.close).to be_truthy
+    expect(subject.commit).to be(true)
   end
 
-  it 'should execute a closer block' do
-    expect(closer).to receive(:call).with(subject.path).once
-    expect(subject.close).to be_truthy
-    expect(subject.close).to be_nil
+  it 'executes a on_commit block' do
+    expect(on_commit).to receive(:call).with(subject.path).once
+    expect(subject.commit).to be(true)
+    expect(subject.commit).to be(false)
   end
 
-  it 'may skip closer block' do
-    expect(closer).not_to receive(:call)
-    expect(subject.close!).to be_truthy
+  it 'may skip on_commit block' do
+    expect(on_commit).not_to receive(:call)
+    expect(subject.discard).to be(true)
+  end
+
+  it 'does not auto-commit on close' do
+    expect(on_commit).not_to receive(:call)
+    expect(subject.close).to be_nil
   end
 end

data/spec/bfs_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.4
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-10 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies: []
 description: Minimalist abstraction for bucket storage
 email: dimitrij@blacksquaremedia.com
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Multi-platform cloud bucket adapter