bfs 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13963edd5c68d92d4f5ce4ef5c3f3ef0131ddb318b36f4d7114e3e49e4a16a3b
-  data.tar.gz: b805a46a30c795dd6dc9c8761876a4af5bd73dcc117a2f7c76c8acea7a957ed9
+  metadata.gz: ff8d42e2ce3e53b671a1210c70ced9c25e96b5ca60effac77ada4868ef26d299
+  data.tar.gz: 881dd9522385bc0417cb12bf6ab492a9f772dd091042130db614b6252ec29d24
 SHA512:
-  metadata.gz: cd9c768fed6d9efa36379f9151c4066931cc92267d032b1b0e920c7150b7db108acb739ecd46b5e8c5853b0ff090767b259e35b0d98b1707fa41491c3eb9dd9e
-  data.tar.gz: 123205693490cd8ee1394be308f28944d84e10098dae690cd54d3bf073710d2f538d397960b19d4d0c33ec271bdbbea3df796bd086733d57f9d28db2c52e7bd6
+  metadata.gz: abe8ef5d0579001860159f7485e0cb254d013e10575a2c5fd8b56e3ba94e3766d1b4db0f1843a3261dc50f8f30f15d16115fdabf976a441fb42a81711c4cea1a
+  data.tar.gz: 98238249263bff71a4d48677296d3e4641d788ab355fdff0a4253792884daf38356cc3823c93b6b4f1bb33de234a80f0043b0c52db75b3d0ffea718d6b510fed

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,7 +1,37 @@
 require 'uri'
+require 'cgi'
 
 module BFS
-  FileInfo = Struct.new(:path, :size, :mtime, :content_type, :metadata)
+  class FileInfo < Hash
+    def initialize(**attrs)
+      update(size: 0, mtime: Time.at(0), mode: 0, metadata: {})
+      update(attrs)
+    end
+
+    def path
+      fetch(:path, nil)
+    end
+
+    def size
+      fetch(:size, 0)
+    end
+
+    def content_type
+      fetch(:content_type, nil)
+    end
+
+    def mtime
+      fetch(:mtime, Time.at(0))
+    end
+
+    def mode
+      fetch(:mode, 0)
+    end
+
+    def metadata
+      fetch(:metadata, {})
+    end
+  end
 
   def self.register(*schemes, &resolver)
     @registry ||= {}
@@ -15,7 +45,11 @@ module BFS
     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)
   end
 
   def self.norm_path(path)
@@ -25,6 +59,11 @@ module BFS
     path.sub!(%r{/+$}, '')
     path
   end
+
+  def self.norm_mode(mode)
+    mode = mode.to_i(8) if mode.is_a?(String)
+    mode & 0o000777
+  end
 end
 
 require 'bfs/helpers'

data/lib/bfs/bucket/abstract.rb

@@ -3,11 +3,21 @@ require 'bfs'
 module BFS
   module Bucket
     class Abstract
+      attr_reader :encoding, :perm
+
       # Initializes a new bucket
       # @param [Hash] opts options
       # @option opts [String] :encoding Custom encoding. Default: Encoding.default_external.
-      def initialize(**opts)
-        @encoding = opts.delete(:encoding) || Encoding.default_external
+      # @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
       end
 
       # Lists the contents of a bucket using a glob pattern

data/lib/bfs/bucket/fs.rb

@@ -26,7 +26,8 @@ module BFS
       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, {})
+        stat = full.stat
+        BFS::FileInfo.new(path: path, size: stat.size, mtime: stat.mtime, mode: BFS.norm_mode(stat.mode))
       rescue Errno::ENOENT
         raise BFS::FileNotFound, path
       end
@@ -37,13 +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, **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)
 
-        perm = opts[:perm]
-        enc  = opts[:encoding] || @encoding
-        temp = BFS::TempWriter.new(full, perm: perm, encoding: enc) {|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|
   parts = [url.host, url.path].compact
-  BFS::Bucket::FS.new File.join(*parts)
+  BFS::Bucket::FS.new File.join(*parts), **opts
 end

data/lib/bfs/bucket/in_mem.rb

@@ -32,7 +32,7 @@ module BFS
         raise BFS::FileNotFound, path unless @files.key?(path)
 
         entry = @files[path]
-        BFS::FileInfo.new(path, entry.io.size, entry.mtime, entry.content_type, entry.metadata)
+        BFS::FileInfo.new(path: path, size: entry.io.size, mtime: entry.mtime, content_type: entry.content_type, metadata: entry.metadata)
       end
 
       # Creates a new file and opens it for writing.
@@ -42,11 +42,12 @@ 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[:encoding] || @encoding)
+        io.set_encoding(encoding)
 
-        @files[norm_path(path)] = Entry.new(io, Time.now, opts[:content_type], norm_meta(opts[:metadata]))
+        entry = Entry.new(io, Time.now, content_type, norm_meta(metadata))
+        @files[norm_path(path)] = entry
         return io unless block
 
         begin

data/spec/bfs/blob_spec.rb

@@ -21,7 +21,14 @@ RSpec.describe BFS::Blob do
       subject.write('TESTDATA', content_type: 'text/plain', metadata: { 'x-key' => 'val' })
 
       info = subject.info
-      expect(info).to eq(BFS::FileInfo.new('path/to/file.txt', 8, info.mtime, 'text/plain', 'X-Key' => 'val'))
+      expect(info).to eq(
+        path: 'path/to/file.txt',
+        size: 8,
+        mtime: info.mtime,
+        content_type: 'text/plain',
+        mode: 0,
+        metadata: { 'X-Key' => 'val' },
+      )
       expect(info.mtime).to be_within(1).of(Time.now)
 
       expect(subject.read).to eq('TESTDATA')
@@ -54,7 +61,13 @@ RSpec.describe BFS::Blob do
       expect(subject.read).to eq('TESTDATA')
 
       info = subject.info
-      expect(info).to eq(BFS::FileInfo.new(path, 8, info.mtime, nil, {}))
+      expect(info).to eq(
+        path: path,
+        size: 8,
+        mtime: info.mtime,
+        mode: 0o600,
+        metadata: {},
+      )
       expect(info.mtime).to be_within(1).of(Time.now)
 
       expect(Pathname.glob("#{tmpdir}/**/*").select(&:file?).map(&:to_s)).to eq [

data/spec/bfs/bucket/fs_spec.rb

@@ -17,10 +17,17 @@ 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(File.stat(File.join(tmpdir, 'test.txt')).mode).to eq(0o100666)
+    expect(blob.info.mode).to eq(0o666)
     blob.close
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies: []
 description: Minimalist abstraction for bucket storage
 email: dimitrij@blacksquaremedia.com
@@ -41,7 +41,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:
   - - ">="