bfs-scp 0.7.5 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce2b40891ff68887074207496ca807a6565c68d8d10ab4c442d0a8584a4137b8
-  data.tar.gz: c7c2fa83b17402d00f8a2b80107078266f9e92ab8225f2e0047cdfd1412509a1
+  metadata.gz: d524b38b123694cf69ceb9b14ed758047564190ef3dba78e2eccc191970f0e89
+  data.tar.gz: 8e805bf4b7f688334333a5afb4fdff89c1c78fa734812e82e1d8fe3630a45ccd
 SHA512:
-  metadata.gz: 1f69d3f9ed84f8dcd6be21633abe18ec98eed989ad71c5dfcf3134af9cd3e057ea0768a26bd402d55a3fec82616f26ad257f10cdb45d4d4c8773fc0c53a885cf
-  data.tar.gz: 5b53c05aec603396e18ac17276664d48540c675996a0238016e10d66ffdcee52e6e47069b67d464b40193a0075961fc69fab76861b766dc0c05b0e98ca7ccc21
+  metadata.gz: e3956f06a9b2f00fb526f2768cb69b767372dab35adcb2b889a08bf440a1e43f462676a72927712e7e81fe1ddebf8a49687eb3b1ffe56cd8edd96c764f76e485
+  data.tar.gz: 424781ca80c8e6302511abc854e850db438408e54dc7af3d5eea5acf12bbc8aff99722be2f633588b271613fc8b6892f1d7ab739e1d8c8e1165a42d2c340eca8

data/lib/bfs/bucket/scp.rb

@@ -42,14 +42,15 @@ module BFS
 
       # Lists the contents of a bucket using a glob pattern
       def ls(pattern = '**/*', **_opts)
-        prefix = @prefix ? abs_path(@prefix) : '/'
-        Enumerator.new do |y|
-          sh! 'find', prefix, '-type', 'f' do |out|
-            out.each_line do |line|
-              path = trim_prefix(norm_path(line.strip))
-              y << path if File.fnmatch?(pattern, path, File::FNM_PATHNAME)
-            end
-          end
+        Enumerator.new do |acc|
+          walk(pattern) {|path| acc << path }
+        end
+      end
+
+      # Iterates over the contents of a bucket using a glob pattern
+      def glob(pattern = '**/*', **_opts)
+        Enumerator.new do |acc|
+          walk(pattern, with_stat: true) {|info| acc << info }
         end
       end
 
@@ -57,9 +58,11 @@ module BFS
       def info(path, **_opts)
         full = full_path(path)
         path = norm_path(path)
-        out  = sh! 'stat', '-c', '%s;%Z;%a', full
+        out  = sh! %(stat -c '%F;%s;%Z;%a' #{Shellwords.escape full})
+
+        type, size, epoch, mode = out.strip.split(';', 4)
+        raise BFS::FileNotFound, path unless type.include?('file')
 
-        size, epoch, mode = out.strip.split(';', 3)
         BFS::FileInfo.new(path: path, size: size.to_i, mtime: Time.at(epoch.to_i), mode: BFS.norm_mode(mode))
       rescue CommandError => e
         e.status == 1 ? raise(BFS::FileNotFound, path) : raise
@@ -72,7 +75,7 @@ module BFS
         full = full_path(path)
 
         opts[:preserve] = true if perm && !opts.key?(:preserve)
-        BFS::TempWriter.new(path, encoding: encoding, perm: perm) do |temp_path|
+        BFS::Writer.new(path, encoding: encoding, perm: perm) do |temp_path|
           mkdir_p File.dirname(full)
           @client.upload!(temp_path, full, **opts)
         end.perform(&block)
@@ -93,7 +96,7 @@ module BFS
       # Deletes a file.
       def rm(path, **_opts)
         path = full_path(path)
-        sh! 'rm', '-f', path
+        sh! %(rm -f #{Shellwords.escape(path)})
       end
 
       # Copies src to dst
@@ -105,7 +108,7 @@ module BFS
         full_dst = full_path(dst)
 
         mkdir_p File.dirname(full_dst)
-        sh! 'cp', '-a', '-f', full_src, full_dst
+        sh! %(cp -a -f #{Shellwords.escape(full_src)} #{Shellwords.escape(full_dst)})
       rescue CommandError => e
         e.status == 1 ? raise(BFS::FileNotFound, src) : raise
       end
@@ -119,7 +122,7 @@ module BFS
         full_dst = full_path(dst)
 
         mkdir_p File.dirname(full_dst)
-        sh! 'mv', '-f', full_src, full_dst
+        sh! %(mv -f #{Shellwords.escape(full_src)} #{Shellwords.escape(full_dst)})
       rescue CommandError => e
         e.status == 1 ? raise(BFS::FileNotFound, src) : raise
       end
@@ -140,23 +143,47 @@ module BFS
         abs_path(super)
       end
 
+      def walk(pattern, with_stat: false)
+        prefix  = @prefix ? abs_path(@prefix) : '/'
+        command = %(find #{Shellwords.escape(prefix)} -type f)
+        command << %( -exec stat -c '%s;%Z;%a;%n' {} \\;) if with_stat
+
+        sh!(command) do |out|
+          out.each_line do |line|
+            line.strip!
+
+            if with_stat
+              size, epoch, mode, path = out.strip.split(';', 4)
+              path = trim_prefix(norm_path(path))
+              next unless File.fnmatch?(pattern, path, File::FNM_PATHNAME)
+
+              info = BFS::FileInfo.new(path: path, size: size.to_i, mtime: Time.at(epoch.to_i), mode: BFS.norm_mode(mode))
+              yield info
+            else
+              path = trim_prefix(norm_path(line))
+              yield path if File.fnmatch?(pattern, path, File::FNM_PATHNAME)
+            end
+          end
+        end
+      end
+
       def mkdir_p(path)
-        sh! 'mkdir', '-p', path
+        sh! %(mkdir -p #{Shellwords.escape(path)})
       end
 
-      def sh!(*cmd) # rubocop:disable Metrics/MethodLength
+      def sh!(command) # rubocop:disable Metrics/MethodLength
         stdout = ''
         stderr = nil
         status = 0
-        cmdstr = cmd.map {|x| Shellwords.escape(x) }.join(' ')
 
         @client.session.open_channel do |ch|
-          ch.exec(cmdstr) do |_, _success|
+          ch.exec(command) do |_, _success|
             ch.on_data do |_, data|
+              stdout << data
+
               if block_given?
-                yield data
-              else
-                stdout += data
+                pos = stdout.rindex("\n")
+                yield stdout.slice!(0..pos) if pos
               end
             end
             ch.on_extended_data do |_, _, data|
@@ -167,8 +194,14 @@ module BFS
             end
           end
         end
+
+        if block_given? && stdout.length.positive?
+          yield stdout
+          stdout.clear
+        end
+
         @client.session.loop
-        raise CommandError.new(cmdstr, status, stderr) unless status.zero?
+        raise CommandError.new(command, status, stderr) unless status.zero?
 
         stdout
       end

data/spec/bfs/bucket/scp_spec.rb

@@ -1,23 +1,25 @@
 require 'spec_helper'
 
-sandbox = { host: '127.0.0.1', opts: { port: 7022, user: 'root', password: 'root' } }.freeze
-
 RSpec.describe BFS::Bucket::SCP, scp: true do
-  context 'absolute' do
-    subject { described_class.new sandbox[:host], **sandbox[:opts].merge(prefix: SecureRandom.uuid) }
-    after   { subject.close }
+  subject { described_class.new hostname, **conn_opts }
+
+  let(:hostname) { '127.0.0.1' }
+  let(:conn_opts) { { port: 7022, user: 'root', password: 'root', prefix: prefix } }
+  let(:prefix) { SecureRandom.uuid }
+
+  after { subject.close }
 
+  context 'with absolute path' do
     it_behaves_like 'a bucket', content_type: false, metadata: false
   end
 
-  context 'relative' do
-    subject { described_class.new sandbox[:host], **sandbox[:opts].merge(prefix: "~/#{SecureRandom.uuid}") }
-    after   { subject.close }
+  context 'with relative path' do
+    let(:prefix) { "~/#{SecureRandom.uuid}" }
 
     it_behaves_like 'a bucket', content_type: false, metadata: false
   end
 
-  it 'should resolve from URL' do
+  it 'resolves from URL' do
     bucket = BFS.resolve('scp://root:root@127.0.0.1:7022')
     expect(bucket).to be_instance_of(described_class)
     expect(bucket.instance_variable_get(:@prefix)).to be_nil
@@ -29,7 +31,7 @@ RSpec.describe BFS::Bucket::SCP, scp: true do
     bucket.close
   end
 
-  it 'should handle absolute and relative paths' do
+  it 'handles absolute and relative paths' do
     abs = BFS::Blob.new("scp://root:root@127.0.0.1:7022/#{SecureRandom.uuid}/file.txt")
     abs.create {|w| w.write 'absolute' }
 
@@ -43,7 +45,7 @@ RSpec.describe BFS::Bucket::SCP, scp: true do
     rel.close
   end
 
-  it 'should support custom perms' do
+  it 'supports custom perms' do
     blob = BFS::Blob.new("scp://root:root@127.0.0.1:7022/#{SecureRandom.uuid}/file.txt")
     blob.create(perm: 0o666) {|w| w.write 'foo' }
     expect(blob.info.mode).to eq(0o666)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs-scp
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.3
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bfs
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: 0.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,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: SCP/SSH adapter for bfs