sshkit 1.19.0 → 1.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b4191d45c0d732071e82c9a8eeead452366f901fd483eb016dbd97761da10d1
-  data.tar.gz: 49209aa289eb35cc906bb88fa187aa43079d3c3a0e9ed42582cbc74bb967d54f
+  metadata.gz: 1b8cc968102708cd224132592b522e059c57c29a68b7c0feced32ef905fb6f1e
+  data.tar.gz: d5a2ad7b2a09ba796ad5def0a211e793e7e27334fdf2296cc557fc92e9e92597
 SHA512:
-  metadata.gz: aa67fe84e2eda52dae94814f6c81d66a0f965e8fbffadc4238c9cc63b800ab3c24a424b0382d8d1a1431f5ecb095dda017fe076277fe165f8771d1e21d6f4d82
-  data.tar.gz: f404f7933c620ab7737c5062c45a7b536dd62f26034894588dffb132b9e027a32516c0bf5a43215d7bdf468c4ae3102d99957d7a1ef728bf2e3e7db9c1ee3dd0
+  metadata.gz: 67f29e165c1d9612f157323a638a04054688a50c0bb302620756c3590a854929fcbac166b3f9f7671f32c21de2a22c5ca2e3ba7c3edb35c8918f7fc4ddc38d1d
+  data.tar.gz: 70c0ada0ed66f2b92032f7fc9adda13f3a2bb1d31207733072772817a795f7342de7b88acee6dc154c52a14c4aaaef051c4922118a87669c433320606ea2e0e6

data/CHANGELOG.md

@@ -7,6 +7,10 @@ appear at the top.
 
   * Your contribution here!
 
+## [1.19.1][] (2019-07-02)
+
+  * [#465](https://github.com/capistrano/sshkit/pull/456): Fix a regression in 1.19.0 that prevented `~` from being used in Capistrano paths, e.g. `:deploy_to`, etc. - [@grosser](https://github.com/grosser)
+
 ## [1.19.0][] (2019-06-30)
 
   * [#455](https://github.com/capistrano/sshkit/pull/455): Ensure UUID of commands are stable in logging - [@lazyatom](https://github.com/lazyatom)
@@ -764,7 +768,8 @@ version `0.0.5`.
 
 First release.
 
-[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.19.0...HEAD
+[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.19.1...HEAD
+[1.19.1]: https://github.com/capistrano/sshkit/compare/v1.19.0...v1.19.1
 [1.19.0]: https://github.com/capistrano/sshkit/compare/v1.18.2...v1.19.0
 [1.18.2]: https://github.com/capistrano/sshkit/compare/v1.18.1...v1.18.2
 [1.18.1]: https://github.com/capistrano/sshkit/compare/v1.18.0...v1.18.1

data/lib/sshkit/backends/abstract.rb

@@ -82,9 +82,10 @@ module SSHKit
 
       def within(directory, &_block)
         (@pwd ||= []).push directory.to_s
+        escaped = Command.shellescape_except_tilde(pwd_path)
         execute <<-EOTEST, verbosity: Logger::DEBUG
-          if test ! -d #{File.join(@pwd).shellescape}
-            then echo "Directory does not exist '#{File.join(@pwd).shellescape}'" 1>&2
+          if test ! -d #{escaped}
+            then echo "Directory does not exist '#{escaped}'" 1>&2
             false
           fi
         EOTEST

data/lib/sshkit/command.rb

@@ -143,7 +143,7 @@ module SSHKit
 
     def within(&_block)
       return yield unless options[:in]
-      "cd #{options[:in].shellescape} && #{yield}"
+      "cd #{self.class.shellescape_except_tilde(options[:in])} && #{yield}"
     end
 
     def environment_hash
@@ -219,6 +219,11 @@ module SSHKit
       end
     end
 
+    # allow using home directory but escape everything else like spaces etc
+    def self.shellescape_except_tilde(file)
+      file.shellescape.gsub("\\~", "~")
+    end
+
     private
 
     def default_options

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.19.0".freeze
+  VERSION = "1.19.1".freeze
 end

data/test/unit/backends/test_abstract.rb

@@ -99,6 +99,18 @@ module SSHKit
         assert_equal '/usr/bin/env cat file', backend.executed_command.to_command
       end
 
+      def test_within_home
+        backend = ExampleBackend.new do
+          within '~/foo' do
+            execute :cat, 'file', :strip => false
+          end
+        end
+
+        backend.run
+
+        assert_equal 'cd ~/foo && /usr/bin/env cat file', backend.executed_command.to_command
+      end
+
       def test_background_logs_deprecation_warnings
         deprecation_out = ''
         SSHKit.config.deprecation_output = deprecation_out

data/test/unit/test_command.rb

@@ -84,6 +84,11 @@ module SSHKit
       assert_equal "cd /opt/sites && /usr/bin/env ls -l", c.to_command
     end
 
+    def test_working_in_home_directory
+      c = Command.new(:ls, '-l', in: "~/sites")
+      assert_equal "cd ~/sites && /usr/bin/env ls -l", c.to_command
+    end
+
     def test_working_in_a_given_weird_directory
       c = Command.new(:ls, '-l', in: "/opt/sites and stuff")
       assert_equal "cd /opt/sites\\ and\\ stuff && /usr/bin/env ls -l", c.to_command

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.19.1
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh