bfs 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139902b9141990300b11bbc8dbaf74d98e5a2d5c94bd0d908a4186a0cbe90e86
-  data.tar.gz: ca0f8d4823962e60c94933c9420772ca272eb1b37a986a01f6a961107d30f66a
+  metadata.gz: 13963edd5c68d92d4f5ce4ef5c3f3ef0131ddb318b36f4d7114e3e49e4a16a3b
+  data.tar.gz: b805a46a30c795dd6dc9c8761876a4af5bd73dcc117a2f7c76c8acea7a957ed9
 SHA512:
-  metadata.gz: 231594d9d7c86d32fef8c967ac4bf5e2184b219e1a495a04372e86fb4114c2391511c5f752c8f8af4238cdccb6bc8d7f51f9f98d4fe9e42bed61796b1cafb210
-  data.tar.gz: a87d958cc0aa9303f63cf786b2d995bd348db5c248f7802f39ac71a773ef93afe2f747b988b585219720bf826a7624351a07406e3cd3600df1d79fe1c04e0e7f
+  metadata.gz: cd9c768fed6d9efa36379f9151c4066931cc92267d032b1b0e920c7150b7db108acb739ecd46b5e8c5853b0ff090767b259e35b0d98b1707fa41491c3eb9dd9e
+  data.tar.gz: 123205693490cd8ee1394be308f28944d84e10098dae690cd54d3bf073710d2f538d397960b19d4d0c33ec271bdbbea3df796bd086733d57f9d28db2c52e7bd6

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.4.0'
+  s.required_ruby_version = '>= 2.5.0'
 end

data/lib/bfs/blob.rb

@@ -12,40 +12,40 @@ module BFS
     end
 
     # Info returns the blob info.
-    def info(opts={})
-      @bucket.info(path, opts)
+    def info(**opts)
+      @bucket.info(path, **opts)
     end
 
     # Creates the blob and opens it for writing.
-    def create(opts={}, &block)
-      @bucket.create(path, opts, &block)
+    def create(**opts, &block)
+      @bucket.create(path, **opts, &block)
     end
 
     # Opens the blob for reading.
     # May raise BFS::FileNotFound.
-    def open(opts={}, &block)
-      @bucket.open(path, opts, &block)
+    def open(**opts, &block)
+      @bucket.open(path, **opts, &block)
     end
 
     # Deletes the blob.
-    def rm(opts={})
-      @bucket.rm(path, opts)
+    def rm(**opts)
+      @bucket.rm(path, **opts)
     end
 
     # Shortcut method to read the contents of the blob.
-    def read(opts={})
-      open(opts, &:read)
+    def read(**opts)
+      open(**opts, &:read)
     end
 
     # Shortcut method to write data to blob.
-    def write(data, opts={})
-      create(opts) {|f| f.write data }
+    def write(data, **opts)
+      create(**opts) {|f| f.write data }
     end
 
     # Moves blob to dst.
-    def mv(dst, opts={})
+    def mv(dst, **opts)
       dst = BFS.norm_path(dst)
-      @bucket.mv(path, dst, opts)
+      @bucket.mv(path, dst, **opts)
       @path = dst
     end
 

data/lib/bfs/bucket/abstract.rb

@@ -6,33 +6,33 @@ module BFS
       # Initializes a new bucket
       # @param [Hash] opts options
       # @option opts [String] :encoding Custom encoding. Default: Encoding.default_external.
-      def initialize(opts={})
+      def initialize(**opts)
         @encoding = opts.delete(:encoding) || Encoding.default_external
       end
 
       # Lists the contents of a bucket using a glob pattern
-      def ls(_pattern='**', _opts={})
+      def ls(_pattern = '**', **_opts)
         raise 'not implemented'
       end
 
       # Info returns the info for a single file
-      def info(_path, _opts={})
+      def info(_path, **_opts)
         raise 'not implemented'
       end
 
       # Creates a new file and opens it for writing
-      def create(_path, _opts={})
+      def create(_path, **_opts)
         raise 'not implemented'
       end
 
       # Opens an existing file for reading
       # May raise BFS::FileNotFound
-      def open(_path, _opts={})
+      def open(_path, **_opts)
         raise 'not implemented'
       end
 
       # Deletes a file.
-      def rm(_path, _opts={})
+      def rm(_path, **_opts)
         raise 'not implemented'
       end
 
@@ -40,8 +40,8 @@ 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)
+      def read(path, **opts)
+        open(path, **opts, &:read)
       end
 
       # Shortcut method to write data to path
@@ -49,17 +49,17 @@ module BFS
       # @param [String] path The path to write to.
       # @param [String] data The data to write.
       # @param [Hash] opts Additional options, see #create.
-      def write(path, data, opts={})
-        create(path, opts) {|f| f.write data }
+      def write(path, data, **opts)
+        create(path, **opts) {|f| f.write data }
       end
 
       # Copies src to dst
       #
       # @param [String] src The source path.
       # @param [String] dst The destination path.
-      def cp(src, dst, opts={})
-        open(src, opts) do |r|
-          create(dst, opts) do |w|
+      def cp(src, dst, **opts)
+        open(src, **opts) do |r|
+          create(dst, **opts) do |w|
             IO.copy_stream(r, w)
           end
         end
@@ -69,7 +69,7 @@ module BFS
       #
       # @param [String] src The source path.
       # @param [String] dst The destination path.
-      def mv(src, dst, _opts={})
+      def mv(src, dst, **_opts)
         cp(src, dst)
         rm(src)
       end

data/lib/bfs/bucket/fs.rb

@@ -6,15 +6,15 @@ module BFS
   module Bucket
     # FS buckets are operating on the file system
     class FS < Abstract
-      def initialize(root, opts={})
-        super(opts.dup)
+      def initialize(root, **opts)
+        super(**opts.dup)
 
         @root = Pathname.new(root.to_s)
         @prefix = "#{@root.to_s.chomp('/')}/"
       end
 
       # Lists the contents of a bucket using a glob pattern
-      def ls(pattern='**/*', _opts={})
+      def ls(pattern = '**/*', **_opts)
         Enumerator.new do |y|
           Pathname.glob(@root.join(pattern)) do |pname|
             y << trim_prefix(pname.to_s) if pname.file?
@@ -23,7 +23,7 @@ module BFS
       end
 
       # Info returns the info for a single file
-      def info(path, _opts={})
+      def info(path, **_opts)
         full = @root.join(norm_path(path))
         path = trim_prefix(full.to_s)
         BFS::FileInfo.new(path, full.size, full.mtime, nil, {})
@@ -36,12 +36,14 @@ module BFS
       # @param [String] path The creation path.
       # @param [Hash] opts Additional options.
       # @option opts [String] :encoding Custom encoding.
-      def create(path, opts={}, &block)
+      # @option opts [Integer] :perm Custom file permission, default: 0600.
+      def create(path, **opts, &block)
         full = @root.join(norm_path(path))
         FileUtils.mkdir_p(full.dirname.to_s)
 
+        perm = opts[:perm]
         enc  = opts[:encoding] || @encoding
-        temp = BFS::TempWriter.new(full, encoding: enc) {|t| FileUtils.mv t, full.to_s }
+        temp = BFS::TempWriter.new(full, perm: perm, encoding: enc) {|t| FileUtils.mv t, full.to_s }
         return temp unless block
 
         begin
@@ -56,10 +58,10 @@ module BFS
       # @param [String] path The path to open.
       # @param [Hash] opts Additional options.
       # @option opts [String] :encoding Custom encoding.
-      def open(path, opts={}, &block)
+      def open(path, **opts, &block)
         path = norm_path(path)
         full = @root.join(path)
-        full.open(opts, &block)
+        full.open(**opts, &block)
       rescue Errno::ENOENT
         raise BFS::FileNotFound, path
       end
@@ -67,7 +69,7 @@ module BFS
       # Deletes a file.
       #
       # @param [String] path The path to delete.
-      def rm(path, _opts={})
+      def rm(path, **_opts)
         full = @root.join(norm_path(path))
         FileUtils.rm_f full.to_s
       end
@@ -76,7 +78,7 @@ module BFS
       #
       # @param [String] src The source path.
       # @param [String] dst The destination path.
-      def cp(src, dst, _opts={})
+      def cp(src, dst, **_opts)
         full_src = @root.join(norm_path(src))
         full_dst = @root.join(norm_path(dst))
         FileUtils.mkdir_p full_dst.dirname.to_s
@@ -89,7 +91,7 @@ module BFS
       #
       # @param [String] src The source path.
       # @param [String] dst The destination path.
-      def mv(src, dst, _opts={})
+      def mv(src, dst, **_opts)
         full_src = @root.join(norm_path(src))
         full_dst = @root.join(norm_path(dst))
         FileUtils.mkdir_p full_dst.dirname.to_s

data/lib/bfs/bucket/in_mem.rb

@@ -7,8 +7,8 @@ module BFS
     class InMem < Abstract
       Entry = Struct.new(:io, :mtime, :content_type, :metadata)
 
-      def initialize(opts={})
-        super(opts.dup)
+      def initialize(**opts)
+        super(**opts.dup)
         @files = {}
       end
 
@@ -18,7 +18,7 @@ module BFS
       end
 
       # Lists the contents of a bucket using a glob pattern
-      def ls(pattern='**/*', _opts={})
+      def ls(pattern = '**/*', **_opts)
         Enumerator.new do |y|
           @files.each_key do |key|
             y << key if File.fnmatch?(pattern, key, File::FNM_PATHNAME)
@@ -27,7 +27,7 @@ module BFS
       end
 
       # Info returns the file info
-      def info(path, _opts={})
+      def info(path, **_opts)
         path = norm_path(path)
         raise BFS::FileNotFound, path unless @files.key?(path)
 
@@ -42,7 +42,7 @@ 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, **opts, &block)
         io = StringIO.new
         io.set_encoding(opts[:encoding] || @encoding)
 
@@ -57,7 +57,7 @@ module BFS
       end
 
       # Opens an existing file for reading
-      def open(path, _opts={}, &block)
+      def open(path, **_opts, &block)
         path = norm_path(path)
         raise BFS::FileNotFound, path unless @files.key?(path)
 
@@ -73,7 +73,7 @@ module BFS
       end
 
       # Deletes a file.
-      def rm(path, _opts={})
+      def rm(path, **_opts)
         @files.delete(norm_path(path))
       end
     end

data/lib/bfs/helpers.rb

@@ -3,9 +3,10 @@ require 'delegate'
 
 module BFS
   class TempWriter < DelegateClass(::Tempfile)
-    def initialize(name, opts={}, &closer)
+    def initialize(name, tempdir: nil, perm: nil, **opts, &closer)
       @closer   = closer
-      @tempfile = ::Tempfile.new(File.basename(name.to_s), opts)
+      @tempfile = ::Tempfile.new(File.basename(name.to_s), tempdir, **opts)
+      @tempfile.chmod(perm) if perm
       super @tempfile
     end
 

data/spec/bfs/bucket/fs_spec.rb

@@ -6,8 +6,8 @@ RSpec.describe BFS::Bucket::FS do
   subject { described_class.new(tmpdir) }
 
   it_behaves_like 'a bucket',
-    content_type: false,
-    metadata: false
+                  content_type: false,
+                  metadata: false
 
   it 'should resolve from URL' do
     File.open(File.join(tmpdir, 'test.txt'), 'wb') {|f| f.write 'TESTDATA' }
@@ -16,4 +16,11 @@ RSpec.describe BFS::Bucket::FS do
     expect(bucket).to be_instance_of(described_class)
     expect(bucket.ls.to_a).to eq(['test.txt'])
   end
+
+  it 'should support custom perms' do
+    blob = BFS::Blob.new("file://#{tmpdir}/test.txt")
+    blob.create(perm: 0o666) {|w| w.write 'foo' }
+    expect(File.stat(File.join(tmpdir, 'test.txt')).mode).to eq(0o100666)
+    blob.close
+  end
 end

data/spec/bfs/helpers_spec.rb

@@ -2,13 +2,19 @@ require 'spec_helper'
 
 RSpec.describe BFS::TempWriter do
   let(:closer) { proc {} }
-  subject { described_class.new 'test', nil, &closer }
+  subject { described_class.new 'test', &closer }
 
   it 'should behave like a File' do
     missing = ::File.public_instance_methods - subject.public_methods
     expect(missing).to be_empty
   end
 
+  it 'should support custom params' do
+    subject = described_class.new 'test', perm: 0o640, &closer
+    expect(subject.stat.mode).to eq(0o100640)
+    expect(subject.close).to be_truthy
+  end
+
   it 'should exectute a closer block' do
     expect(closer).to receive(:call).with(subject.path)
     expect(subject.close).to be_truthy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies: []
 description: Minimalist abstraction for bucket storage
 email: dimitrij@blacksquaremedia.com
@@ -41,14 +41,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.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.2
 signing_key: 
 specification_version: 4
 summary: Multi-platform cloud bucket adapter