chef-winrm-fs 1.4.2 → 1.4.4

data/lib/chef-winrm-fs/core/tmp_zip.rb

@@ -1,178 +1,176 @@
-# frozen_string_literal: true
-
-#
-# Author:: Fletcher (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2015, Fletcher Nichol
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require "delegate"
-require "pathname" unless defined?(Pathname)
-require "tempfile" unless defined?(Tempfile)
-require "zip" unless defined?(Zip)
-
-module WinRM
-  module FS
-    module Core
-      # A temporary Zip file for a given directory.
-      #
-      # @author Fletcher Nichol <fnichol@nichol.ca>
-      class TmpZip
-        # Contructs a new Zip file for the given directory.
-        #
-        # There are 2 ways to interpret the directory path:
-        #
-        # * If the directory has no path separator terminator, then the
-        #   directory basename will be used as the base directory in the
-        #   resulting zip file.
-        # * If the directory has a path separator terminator (such as `/` or
-        #   `\\`), then the entries under the directory will be added to the
-        #   resulting zip file.
-        #
-        # The following emaples assume a directory tree structure of:
-        #
-        #     src
-        #     |-- alpha.txt
-        #     |-- beta.txt
-        #     \-- sub
-        #         \-- charlie.txt
-        #
-        # @example Including the base directory in the zip file
-        #
-        #   TmpZip.new("/path/to/src")
-        #   # produces a zip file with entries:
-        #   # - src/alpha.txt
-        #   # - src/beta.txt
-        #   # - src/sub/charlie.txt
-        #
-        # @example Excluding the base directory in the zip file
-        #
-        #   TmpZip.new("/path/to/src/")
-        #   # produces a zip file with entries:
-        #   # - alpha.txt
-        #   # - beta.txt
-        #   # - sub/charlie.txt
-        #
-        # @param dir [String,Pathname,#to_s] path to the directory
-        # @param logger [#debug,#debug?] an optional logger/ui object that
-        #   responds to `#debug` and `#debug?` (default `nil`)
-        def initialize(dir, logger = nil)
-          @logger = logger || Logging.logger[self]
-          @dir = clean_dirname(dir)
-          @zip_io = Tempfile.open(["tmpzip-", ".zip"], binmode: true)
-          write_zip
-          @zip_io.close
-        end
-
-        # @return [Pathname] path to zip file
-        def path
-          Pathname.new(zip_io.path) if zip_io.path
-        end
-
-        # Unlinks (deletes) the zip file from the filesystem.
-        def unlink
-          zip_io.unlink
-        end
-
-        private
-
-        # @return [Pathname] the directory used to create the Zip file
-        # @api private
-        attr_reader :dir
-
-        # @return [#debug] the logger
-        # @api private
-        attr_reader :logger
-
-        # @return [IO] the Zip file IO
-        # @api private
-        attr_reader :zip_io
-
-        # @return [Pathname] the pathname object representing dirname that
-        # doesn't have any of those ~ in it
-        # @api private
-        def clean_dirname(dir)
-          paths = Pathname.glob(dir)
-          raise "Expected Pathname.glob(dir) to return only dir, got #{paths}" if paths.length != 1
-
-          paths.first
-        end
-
-        # @return [Array<Pathname] all recursive files under the base
-        #   directory, excluding directories
-        # @api private
-        def entries
-          Pathname.glob(dir.join("**/.*")).push(*Pathname.glob(dir.join("**/*"))).delete_if(&:directory?).sort
-        end
-
-        # (see Logging.log_subject)
-        # @api private
-        def log_subject
-          @log_subject ||= [self.class.to_s.split("::").last, path].join("::")
-        end
-
-        # Adds all file entries to the Zip output stream.
-        #
-        # @param zos [Zip::OutputStream] zip output stream
-        # @api private
-        def produce_zip_entries(zos)
-          entries.each do |entry|
-            entry_path = entry.relative_path_from(dir)
-            logger.debug "+++ Adding #{entry_path}"
-            zos.put_next_entry(
-              zip_entry(entry_path),
-              nil, nil, ::Zip::Entry::DEFLATED, Zlib::BEST_COMPRESSION
-            )
-            entry.open("rb") { |src| IO.copy_stream(src, zos) }
-          end
-          logger.debug "=== All files added."
-        end
-
-        # Writes out a temporary Zip file.
-        #
-        # @api private
-        def write_zip
-          logger.debug "Populating files"
-          Zip::OutputStream.write_buffer(NoDupIO.new(zip_io)) do |zos|
-            produce_zip_entries(zos)
-          end
-        end
-
-        def zip_entry(entry_path)
-          Zip::Entry.new(
-            zip_io.path,
-            entry_path.to_s,
-            nil, nil, nil, nil, nil, nil,
-            ::Zip::DOSTime.new(2000)
-          )
-        end
-
-        # Simple delegate wrapper to prevent `#dup` calls being made on IO
-        # objects. This is used to bypass an issue in the `Zip::Outputstream`
-        # constructor where an incoming IO is duplicated, leading to races
-        # on flushing the final stream to disk.
-        #
-        # @author Fletcher Nichol <fnichol@nichol.ca>
-        # @api private
-        class NoDupIO < SimpleDelegator
-          # @return [self] returns self and does *not* return a duplicate
-          #   object
-          def dup
-            self
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+# Author:: Fletcher (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2015, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "delegate"
+require "pathname" unless defined?(Pathname)
+require "tempfile" unless defined?(Tempfile)
+
+module WinRM
+  module FS
+    module Core
+      # A temporary Zip file for a given directory.
+      #
+      # @author Fletcher Nichol <fnichol@nichol.ca>
+      class TmpZip
+        # Contructs a new Zip file for the given directory.
+        #
+        # There are 2 ways to interpret the directory path:
+        #
+        # * If the directory has no path separator terminator, then the
+        #   directory basename will be used as the base directory in the
+        #   resulting zip file.
+        # * If the directory has a path separator terminator (such as `/` or
+        #   `\\`), then the entries under the directory will be added to the
+        #   resulting zip file.
+        #
+        # The following emaples assume a directory tree structure of:
+        #
+        #     src
+        #     |-- alpha.txt
+        #     |-- beta.txt
+        #     \-- sub
+        #         \-- charlie.txt
+        #
+        # @example Including the base directory in the zip file
+        #
+        #   TmpZip.new("/path/to/src")
+        #   # produces a zip file with entries:
+        #   # - src/alpha.txt
+        #   # - src/beta.txt
+        #   # - src/sub/charlie.txt
+        #
+        # @example Excluding the base directory in the zip file
+        #
+        #   TmpZip.new("/path/to/src/")
+        #   # produces a zip file with entries:
+        #   # - alpha.txt
+        #   # - beta.txt
+        #   # - sub/charlie.txt
+        #
+        # @param dir [String,Pathname,#to_s] path to the directory
+        # @param logger [#debug,#debug?] an optional logger/ui object that
+        #   responds to `#debug` and `#debug?` (default `nil`)
+        def initialize(dir, logger = nil)
+          require "zip" unless defined?(Zip)
+          @logger = logger || Logging.logger[self]
+          @dir = clean_dirname(dir)
+          @zip_io = Tempfile.open(["tmpzip-", ".zip"], binmode: true)
+          write_zip
+          @zip_io.close
+        end
+
+        # @return [Pathname] path to zip file
+        def path
+          Pathname.new(zip_io.path) if zip_io.path
+        end
+
+        # Unlinks (deletes) the zip file from the filesystem.
+        def unlink
+          zip_io.unlink
+        end
+
+        private
+
+        # @return [Pathname] the directory used to create the Zip file
+        # @api private
+        attr_reader :dir
+
+        # @return [#debug] the logger
+        # @api private
+        attr_reader :logger
+
+        # @return [IO] the Zip file IO
+        # @api private
+        attr_reader :zip_io
+
+        # @return [Pathname] the pathname object representing dirname that
+        # doesn't have any of those ~ in it
+        # @api private
+        def clean_dirname(dir)
+          paths = Pathname.glob(dir)
+          raise "Expected Pathname.glob(dir) to return only dir, got #{paths}" if paths.length != 1
+
+          paths.first
+        end
+
+        # @return [Array<Pathname] all recursive files under the base
+        #   directory, excluding directories
+        # @api private
+        def entries
+          Pathname.glob(dir.join("**/.*")).push(*Pathname.glob(dir.join("**/*"))).delete_if(&:directory?).sort
+        end
+
+        # (see Logging.log_subject)
+        # @api private
+        def log_subject
+          @log_subject ||= [self.class.to_s.split("::").last, path].join("::")
+        end
+
+        # Adds all file entries to the Zip output stream.
+        #
+        # @param zos [Zip::OutputStream] zip output stream
+        # @api private
+        def produce_zip_entries(zos)
+          entries.each do |entry|
+            entry_path = entry.relative_path_from(dir)
+            logger.debug "+++ Adding #{entry_path}"
+            zos.put_next_entry(zip_entry(entry_path))
+            entry.open("rb") { |src| IO.copy_stream(src, zos) }
+          end
+          logger.debug "=== All files added."
+        end
+
+        # Writes out a temporary Zip file.
+        #
+        # @api private
+        def write_zip
+          logger.debug "Populating files"
+          Zip::OutputStream.write_buffer(NoDupIO.new(zip_io)) do |zos|
+            produce_zip_entries(zos)
+          end
+        end
+
+        def zip_entry(entry_path)
+          Zip::Entry.new(
+            zip_io.path,
+            entry_path.to_s,
+            compression_method: ::Zip::Entry::DEFLATED,
+            compression_level: Zlib::BEST_COMPRESSION,
+            time: ::Zip::DOSTime.new(2000)
+          )
+        end
+
+        # Simple delegate wrapper to prevent `#dup` calls being made on IO
+        # objects. This is used to bypass an issue in the `Zip::Outputstream`
+        # constructor where an incoming IO is duplicated, leading to races
+        # on flushing the final stream to disk.
+        #
+        # @author Fletcher Nichol <fnichol@nichol.ca>
+        # @api private
+        class NoDupIO < SimpleDelegator
+          # @return [self] returns self and does *not* return a duplicate
+          #   object
+          def dup
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef-winrm-fs/exceptions.rb

@@ -1,29 +1,29 @@
-# frozen_string_literal: true
-
-#
-# Copyright 2015 Shawn Neal <sneal@sneal.net>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module WinRM
-  module FS
-    # WinRM-FS base class for errors
-    class WinRMFSError < StandardError; end
-
-    # Error that occurs when a file upload fails
-    class WinRMUploadError < WinRMFSError; end
-
-    # Error that occurs when a file download fails
-    class WinRMDownloadError < WinRMFSError; end
-  end
-end
+# frozen_string_literal: true
+
+#
+# Copyright 2015 Shawn Neal <sneal@sneal.net>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module WinRM
+  module FS
+    # WinRM-FS base class for errors
+    class WinRMFSError < StandardError; end
+
+    # Error that occurs when a file upload fails
+    class WinRMUploadError < WinRMFSError; end
+
+    # Error that occurs when a file download fails
+    class WinRMDownloadError < WinRMFSError; end
+  end
+end