bfs 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56981d0590fb3f90c1dfa56dd3c98f7ae762855dbad9dc6f6d687fda4e08ab37
-  data.tar.gz: 45c5c0f59d5a5d24dadf62d551047e9e4a9f75e7d94c609a9daf11f75503512c
+  metadata.gz: f63579ab84fab2e5ebe18ad08e9565c4510fbaf812a7bc71316df2b4cc9c6c3a
+  data.tar.gz: ee8adb7378ca2fddb0b476fd0ca3ea85429d5ab0afde19593b6557a0dae418b5
 SHA512:
-  metadata.gz: 7fee255b2c6024ee0152de273e93d24cb949345dc73c889e37977873729428208680e31e5c1aa38512828dc186305c7c1ca419af0759d91fe3f76442f4aafe67
-  data.tar.gz: 35b8b19811e74576b6881dd0c349768035044e55821b6d626f89537a6a49e87ac3a5d37a5e660dfad34404a8a8923eb76a78c427f29d32a999edf878f6ede9f9
+  metadata.gz: 974f6428f3dbfefa68aa9fa2497e4763ee6418fed59afe5408cee7e7166a26952d25fb754737af318c28a8ebd755a50786c04d589742cb073105139fddf4d787
+  data.tar.gz: edc36b9aab8e1aabf9846235e50546d01aac0efd5477234bd0bff5ab39b67c85e527972beaba42cfdba545b854cae531c4e02703d298113339facc368e3b605f

data/lib/bfs/bucket/abstract.rb

@@ -30,16 +30,26 @@ module BFS
       end
 
       # Shortcut method to read the contents of a file into memory
+      #
+      # @param [String] path The path to read from.
+      # @param [Hash] opts Additional options, see #open.
       def read(path, opts={})
         open(path, opts, &:read)
       end
 
       # Shortcut method to write data to path
+      #
+      # @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 }
       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|
@@ -49,6 +59,9 @@ module BFS
       end
 
       # Moves src to dst
+      #
+      # @param [String] src The source path.
+      # @param [String] dst The destination path.
       def mv(src, dst, _opts={})
         cp(src, dst)
         rm(src)

data/lib/bfs/bucket/fs.rb

@@ -30,11 +30,15 @@ module BFS
       end
 
       # Creates a new file and opens it for writing
-      def create(path, _opts={}, &block)
+      #
+      # @param [String] path The creation path.
+      # @param [Hash] opts Additional options.
+      # @option opts [String] :encoding Custom encoding.
+      def create(path, opts={}, &block)
         full = @root.join(norm_path(path))
         FileUtils.mkdir_p(full.dirname.to_s)
 
-        temp = BFS::TempWriter.new(full) {|t| FileUtils.mv t, full.to_s }
+        temp = BFS::TempWriter.new(full, opts) {|t| FileUtils.mv t, full.to_s }
         return temp unless block
 
         begin
@@ -45,6 +49,10 @@ module BFS
       end
 
       # Opens an existing file for reading
+      #
+      # @param [String] path The path to open.
+      # @param [Hash] opts Additional options.
+      # @option opts [String] :encoding Custom encoding.
       def open(path, opts={}, &block)
         path = norm_path(path)
         full = @root.join(path)
@@ -54,12 +62,17 @@ module BFS
       end
 
       # Deletes a file.
+      #
+      # @param [String] path The path to delete.
       def rm(path, _opts={})
         full = @root.join(norm_path(path))
         FileUtils.rm_f full.to_s
       end
 
       # Copies a file.
+      #
+      # @param [String] src The source path.
+      # @param [String] dst The destination path.
       def cp(src, dst, _opts={})
         full_src = @root.join(norm_path(src))
         full_dst = @root.join(norm_path(dst))
@@ -70,6 +83,9 @@ module BFS
       end
 
       # Moves a file.
+      #
+      # @param [String] src The source path.
+      # @param [String] dst The destination path.
       def mv(src, dst, _opts={})
         full_src = @root.join(norm_path(src))
         full_dst = @root.join(norm_path(dst))

data/lib/bfs/bucket/in_mem.rb

@@ -34,9 +34,17 @@ module BFS
         BFS::FileInfo.new(path, entry.io.size, entry.mtime, entry.content_type, entry.metadata)
       end
 
-      # Creates a new file and opens it for writing
+      # Creates a new file and opens it for writing.
+      #
+      # @param [String] path The creation path.
+      # @param [Hash] opts Additional options.
+      # @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)
         io = StringIO.new
+        opts[:encoding] ? io.set_encoding(opts[:encoding]) : io.binmode
+
         @files[norm_path(path)] = Entry.new(io, Time.now, opts[:content_type], opts[:metadata] || {})
         return io unless block
 

data/lib/bfs/helpers.rb

@@ -2,9 +2,11 @@ require 'tempfile'
 
 module BFS
   class TempWriter
-    def initialize(name, &closer)
+    def initialize(name, opts={}, &closer)
+      opts = opts.merge(binmode: true) unless opts[:encoding]
+
       @closer = closer
-      @tempfile = ::Tempfile.new(File.basename(name.to_s), binmode: true)
+      @tempfile = ::Tempfile.new(File.basename(name.to_s), opts)
     end
 
     def path

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2019-04-02 00:00:00.000000000 Z
 dependencies: []
 description: Minimalist abstraction for bucket storage
 email: dimitrij@blacksquaremedia.com
@@ -47,8 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Multi-platform cloud bucket adapter