bfs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40e2210b5438bc6bcbdb01204c8a573b674a80f94fdb5dee0cab48b989f77c5a
+  data.tar.gz: 558aab1337ec9959c8eac6c6d13c9b2fbbd2692243a1fbd0d3d5ebe9b4ef7c21
+SHA512:
+  metadata.gz: e7047002ef910561427ddd5048f52a1460e1a15ca9752ae4497f0988fcdf0117fe17aa797b9c0946d231b4a58e62e94fb8d980ea327cc82323246e174fa5af0f
+  data.tar.gz: ff34edc0f19c435a1f520750beae893934c1921330fdaa3f105231d1082f749588c47e295b2891986c7820d21e97a3be7799060b0a067a4b979cc1cf39fd7069

data/bfs.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'bfs'
+  s.version     = File.read(File.expand_path('../.version', __dir__)).strip
+  s.platform    = Gem::Platform::RUBY
+
+  s.licenses    = ['Apache-2.0']
+  s.summary     = 'Multi-platform cloud bucket adapter'
+  s.description = 'Minimalist abstraction for bucket storage'
+
+  s.authors     = ['Dimitrij Denissenko']
+  s.email       = 'dimitrij@blacksquaremedia.com'
+  s.homepage    = 'https://github.com/bsm/bfs.rb'
+
+  s.executables   = []
+  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.2.0'
+end

data/lib/bfs.rb

@@ -0,0 +1,22 @@
+require 'uri'
+
+module BFS
+  FileInfo = Struct.new(:path, :size, :mtime)
+
+  def self.register(scheme, &resolver)
+    @registry ||= {}
+    @registry[scheme] = resolver
+  end
+
+  def self.resolve(url)
+    url = URI.parse(url) unless url.is_a?(::URI)
+    rsl = @registry[url.scheme]
+    raise ArgumentError, "Unable to resolve #{url}, scheme #{url.scheme} is not registered" unless rsl
+
+    rsl.call(url)
+  end
+end
+
+require 'bfs/helpers'
+require 'bfs/bucket'
+require 'bfs/errors'

data/lib/bfs/bucket.rb

@@ -0,0 +1,7 @@
+module BFS
+  module Bucket
+    autoload :Abstract, 'bfs/bucket/abstract'
+    autoload :FS, 'bfs/bucket/fs'
+    autoload :InMem, 'bfs/bucket/in_mem'
+  end
+end

data/lib/bfs/bucket/abstract.rb

@@ -0,0 +1,64 @@
+require 'bfs'
+
+module BFS
+  module Bucket
+    class Abstract
+      # Lists the contents of a bucket using a glob pattern
+      def ls(_pattern='**', _opts={})
+        raise 'not implemented'
+      end
+
+      # Info returns the info for a single file
+      def info(_path, _opts={})
+        raise 'not implemented'
+      end
+
+      # Creates a new file and opens it for writing
+      def create(_path, _opts={})
+        raise 'not implemented'
+      end
+
+      # Opens an existing file for reading
+      # May raise BFS::FileNotFound
+      def open(_path, _opts={})
+        raise 'not implemented'
+      end
+
+      # Deletes a file.
+      def rm(_path, _opts={})
+        raise 'not implemented'
+      end
+
+      # Shortcut method to read the contents of a file into memory
+      def read(path, opts={})
+        open(path, opts, &:read)
+      end
+
+      # Shortcut method to write data to path
+      def write(path, data, opts={})
+        create(path, opts) {|f| f.write data }
+      end
+
+      # Copies src to dst
+      def cp(src, dst, opts={})
+        open(src, opts) do |r|
+          create(dst, opts) do |w|
+            IO.copy_stream(r, w)
+          end
+        end
+      end
+
+      # Moves src to dst
+      def mv(src, dst, _opts={})
+        cp(src, dst)
+        rm(src)
+      end
+
+      protected
+
+      def norm_path(path)
+        path.gsub(File::SEPARATOR, '/').sub(%r{^/+}, '')
+      end
+    end
+  end
+end

data/lib/bfs/bucket/fs.rb

@@ -0,0 +1,79 @@
+require 'bfs'
+require 'fileutils'
+require 'pathname'
+
+module BFS
+  module Bucket
+    # FS buckets are operating on the file system
+    class FS < Abstract
+      def initialize(root, _opts={})
+        @root = Pathname.new(root.to_s)
+        @prefix = "#{@root}/"
+      end
+
+      # Lists the contents of a bucket using a glob pattern
+      def ls(pattern='**/*', _opts={})
+        Pathname.glob(@root.join(pattern)).select(&:file?).map do |name|
+          name.to_s.sub(@prefix, '')
+        end
+      end
+
+      # Info returns the info for a single file
+      def info(path, _opts={})
+        name = @root.join(norm_path(path))
+        path = name.to_s.sub(@prefix, '')
+        BFS::FileInfo.new(path, name.size, name.mtime)
+      rescue Errno::ENOENT
+        raise BFS::FileNotFound, path
+      end
+
+      # Creates a new file and opens it for writing
+      def create(path, _opts={}, &block)
+        name = @root.join(norm_path(path))
+        FileUtils.mkdir_p(name.dirname.to_s)
+
+        temp = BFS::TempWriter.new(name) {|t| FileUtils.mv t, name.to_s }
+        return temp unless block
+
+        begin
+          yield temp
+        ensure
+          temp.close
+        end
+      end
+
+      # Opens an existing file for reading
+      def open(path, opts={}, &block)
+        path = norm_path(path)
+        name = @root.join(path)
+        name.open('r', opts, &block)
+      rescue Errno::ENOENT
+        raise BFS::FileNotFound, path
+      end
+
+      # Deletes a file.
+      def rm(path, _opts={})
+        name = @root.join(norm_path(path))
+        FileUtils.rm_f name.to_s
+      end
+
+      # Copies a file.
+      def cp(src, dst, _opts={})
+        src = norm_path(src)
+        dst = norm_path(dst)
+        FileUtils.cp @root.join(src).to_s, @root.join(dst).to_s
+      rescue Errno::ENOENT
+        raise BFS::FileNotFound, src
+      end
+
+      # Moves a file.
+      def mv(src, dst, _opts={})
+        src = norm_path(src)
+        dst = norm_path(dst)
+        FileUtils.mv @root.join(src).to_s, @root.join(dst).to_s
+      rescue Errno::ENOENT
+        raise BFS::FileNotFound, src
+      end
+    end
+  end
+end

data/lib/bfs/bucket/in_mem.rb

@@ -0,0 +1,65 @@
+require 'bfs'
+require 'stringio'
+
+module BFS
+  module Bucket
+    # InMem buckets are useful for tests
+    class InMem < Abstract
+      Entry = Struct.new(:io, :mtime)
+
+      def initialize
+        @files = {}
+      end
+
+      # Lists the contents of a bucket using a glob pattern
+      def ls(pattern='**/*', _opts={})
+        @files.each_key.select do |key|
+          File.fnmatch?(pattern, key, File::FNM_PATHNAME)
+        end
+      end
+
+      # Info returns the file info
+      def info(path, _opts={})
+        path = norm_path(path)
+        raise BFS::FileNotFound, path unless @files.key?(path)
+
+        entry = @files[path]
+        BFS::FileInfo.new(path, entry.io.size, entry.mtime)
+      end
+
+      # Creates a new file and opens it for writing
+      def create(path, _opts={}, &block)
+        io = StringIO.new
+        @files[norm_path(path)] = Entry.new(io, Time.now)
+        return io unless block
+
+        begin
+          yield(io)
+        ensure
+          io.close
+        end
+      end
+
+      # Opens an existing file for reading
+      def open(path, _opts={}, &block)
+        path = norm_path(path)
+        raise BFS::FileNotFound, path unless @files.key?(path)
+
+        io = @files[path].io
+        io.reopen(io.string)
+        return io unless block
+
+        begin
+          yield(io)
+        ensure
+          io.close
+        end
+      end
+
+      # Deletes a file.
+      def rm(path, _opts={})
+        @files.delete(norm_path(path))
+      end
+    end
+  end
+end

data/lib/bfs/errors.rb

@@ -0,0 +1,10 @@
+module BFS
+  class FileNotFound < StandardError
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+      super "File not found: #{path}"
+    end
+  end
+end

data/lib/bfs/helpers.rb

@@ -0,0 +1,25 @@
+require 'tempfile'
+
+module BFS
+  class TempWriter
+    def initialize(name, &closer)
+      @closer = closer
+      @tempfile = ::Tempfile.new(File.basename(name.to_s))
+    end
+
+    def path
+      @tempfile.path
+    end
+
+    def write(data)
+      @tempfile.write(data)
+    end
+
+    def close
+      path = @tempfile.path
+      @tempfile.close
+      @closer.call(path) if @closer
+      @tempfile.unlink
+    end
+  end
+end

data/spec/bfs/bucket/fs_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe BFS::Bucket::FS do
+  let(:tmpdir) { Dir.mktmpdir }
+  after   { FileUtils.rm_rf tmpdir }
+  subject { described_class.new(tmpdir) }
+
+  it_behaves_like 'a bucket'
+end

data/spec/bfs/bucket/in_mem_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe BFS::Bucket::InMem do
+  it_behaves_like 'a bucket'
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: bfs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-10 00:00:00.000000000 Z
+dependencies: []
+description: Minimalist abstraction for bucket storage
+email: dimitrij@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bfs.gemspec
+- lib/bfs.rb
+- lib/bfs/bucket.rb
+- lib/bfs/bucket/abstract.rb
+- lib/bfs/bucket/fs.rb
+- lib/bfs/bucket/in_mem.rb
+- lib/bfs/errors.rb
+- lib/bfs/helpers.rb
+- spec/bfs/bucket/fs_spec.rb
+- spec/bfs/bucket/in_mem_spec.rb
+homepage: https://github.com/bsm/bfs.rb
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Multi-platform cloud bucket adapter
+test_files:
+- spec/bfs/bucket/fs_spec.rb
+- spec/bfs/bucket/in_mem_spec.rb