kitchen-transport-express 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9700e07ca7ddd76297069ea6c62e00bb4ed82b87f48f643be7ba41e560e9bd4
-  data.tar.gz: 94f6354276aa9ebad26add90b234a5478f9f1ba1157fe34a69297354a29523ea
+  metadata.gz: b255fcbeed01b423bd2bd8e71069501b2c0b636e3d2313ccdd48f8347106333d
+  data.tar.gz: 9696bbf314ccbda4c978cf89963e22005a18d064a359d835ccf033403d46f6b8
 SHA512:
-  metadata.gz: a6989457b293f6a59dabef6bea15684548769fbac53ded1413effadcf44bdcf797afe0560fba452378453d18ba3a5f88b16768ae6eb30876ca24cc1756fe0afa
-  data.tar.gz: 9f2a64a0eb918cdb14980d46b3e1f2dfbcb59d4631329784fd41d0835b1c353da2a36900483f0113067bec16b2fb277994e5d95d17af8823a2ce447ea36da899
+  metadata.gz: 548f04230a39e196b59fd952a4a5247bb9ee4c754d88785f61400565d7c0bd8802a1857a3c7896bb7f1a311bb63475c7416b7746768436eee60fb9cfa0b2dcc7
+  data.tar.gz: ba37810bfcdafaa6ba2973e6410c35aac5ac57bc0f9102db149829cffadea1043a4a24c509f41801eacbc6347cec41ae66907c0b79d90d95484a8bc3ea4d3707

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # kitchen-transport-express CHANGELOG
 
+## 1.3.0
+* chore: 📝 minor updates to method documentation
+* chore: 🔧 add metadata to gemspec
+
 ## 1.2.0
 * feat: 🥅 add error handling to the thread pool
 * feat: 📝🎨 add YARD tags and cleaned up class namespaces and private methods

data/kitchen-transport-express.gemspec

@@ -18,12 +18,12 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "kitchen/transport/express/version"
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop: disable Metrics/BlockLength
   spec.name          = "kitchen-transport-express"
   spec.version       = Kitchen::Transport::Express::VERSION
   spec.authors       = ["Justin Steele"]
   spec.email         = ["justin.steele@oracle.com"]
-  spec.summary       = %q{Skip the long lines in transport. 15 items or less!}
+  spec.summary       = %q{Skip the long lines in Kitchen Transport!}
   spec.description   = %q{A Test Kitchen Transport plugin that streamlines the file transfer phase to Linux hosts.}
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.homepage      = "https://github.com/justintsteele/kitchen-transport-express.git"
@@ -31,6 +31,13 @@ Gem::Specification.new do |spec|
   spec.license       = "Apache-2.0"
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.4"
+  spec.metadata = {
+    "bug_tracker_uri"   => "https://github.com/justintsteele/kitchen-transport-express/issues",
+    "changelog_uri"     => "https://github.com/justintsteele/kitchen-transport-express/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/justintsteele/kitchen-transport-express/blob/main/README.md",
+    "homepage_uri"      => "https://github.com/justintsteele/kitchen-transport-express",
+    "source_code_uri"   => "https://github.com/justintsteele/kitchen-transport-express",
+  }
   spec.add_dependency "test-kitchen"
   spec.add_dependency "ffi-libarchive"
   spec.add_dependency "concurrent-ruby"
@@ -40,4 +47,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "yard"
-end
+end  # rubocop: enable Metrics/BlockLength

data/lib/kitchen/transport/express/archiver.rb

@@ -23,10 +23,10 @@ module Kitchen
       #
       # @author Justin Steele <justin.steele@oracle.com>
       module Archiver
-        # Creates the archive locally in the Kitchen cache location
+        # Creates the archive locally in the Kitchen cache location.
         #
-        # @param path [String] the path of the top-level directory to be arvhied
-        # @return [String] the name of the archive
+        # @param path [String] the path of the top-level directory to be arvhied.
+        # @return [String] the name of the archive.
         def archive(path)
           archive_basename = ::File.basename(path) + ".tgz"
           archive_full_name = ::File.join(::File.dirname(path), archive_basename)
@@ -37,10 +37,9 @@ module Kitchen
           archive_full_name
         end
 
-        # Extracts the archive on the remote host
+        # Extracts the archive on the remote host.
         #
-        # @param session [Net::SSH::Connection::Session] The SSH session used to connect to the remote host and execute
-        #   the extract and cleanup commands
+        # @param session [Net::SSH::Connection::Session] The SSH session used to connect to the remote host and execute the extract and cleanup commands.
         def extract(session, local, remote)
           return unless local.match(/.*\.tgz/)
 
@@ -55,10 +54,10 @@ module Kitchen
 
         private
 
-        # Creats a archive of the directory provided
+        # Creats a archive of the directory provided.
         #
-        # @param path [String] the path to the directory that will be archived
-        # @param archive_path [String] the fully qualified path to the archive that will be created
+        # @param path [String] the path to the directory that will be archived.
+        # @param archive_path [String] the fully qualified path to the archive that will be created.
         # @api private
         def create_archive(path, archive_path)
           Archive.write_open_filename(archive_path, Archive::COMPRESSION_GZIP,
@@ -67,10 +66,10 @@ module Kitchen
                                       end
         end
 
-        # Appends the content of each item in the expanded directory path
+        # Appends the content of each item in the expanded directory path.
         #
-        # @param tar [Archive::Writer] the instance of the archive class
-        # @param path [String] the path to the directory that will be archived
+        # @param tar [Archive::Writer] the instance of the archive class.
+        # @param path [String] the path to the directory that will be archived.
         # @api private
         def write_content(tar, path)
           all_files = Dir.glob("#{path}/**/*")
@@ -85,11 +84,11 @@ module Kitchen
           end
         end
 
-        # Creates the entry in the Archive for each item
+        # Creates the entry in the Archive for each item.
         #
-        # @param ent [Archive::Entry] the current entry being added to the archive
-        # @param file [String] the current file or directory being added to the archive
-        # @param path [String] the path to the directory being archived
+        # @param ent [Archive::Entry] the current entry being added to the archive.
+        # @param file [String] the current file or directory being added to the archive.
+        # @param path [String] the path to the directory being archived.
         # @api private
         def entry(ent, file, path)
           ent.pathname = file.gsub(%r{#{File.dirname(path)}/}, "")
@@ -102,8 +101,8 @@ module Kitchen
 
         # The content of the file in binary format. Directories have no content.
         #
-        # @param file [String] the path to the file
-        # @return [String] the content of the file
+        # @param file [String] the path to the file.
+        # @return [String] the content of the file.
         # @api private
         def content(file)
           File.read(file, mode: "rb")
@@ -111,17 +110,17 @@ module Kitchen
 
         # The size of the file. Directories have no size.
         #
-        # @param file [String] the path to the file
-        # @return [Integer] the size of the file
+        # @param file [String] the path to the file.
+        # @return [Integer] the size of the file.
         # @api private
         def size(file)
           content(file).size
         end
 
-        # The file permissions of the file
+        # The file permissions of the file.
         #
-        # @param file [String] the path to the file or directory
-        # @return [Integer] the mode of the file or directory
+        # @param file [String] the path to the file or directory.
+        # @return [Integer] the mode of the file or directory.
         # @api private
         def mode(file)
           f = File.stat(file)

data/lib/kitchen/transport/express/version.rb

@@ -17,7 +17,10 @@
 module Kitchen
   module Transport
     class Express
-      VERSION = "1.2.0"
+      # The version string for Kitchen Transport Express.
+      #
+      # @author Justin Steele <justin.steele@oracle.com>
+      VERSION = "1.3.0"
     end
   end
 end

data/lib/kitchen/transport/express_ssh.rb

@@ -21,15 +21,15 @@ require_relative "express/archiver"
 
 module Kitchen
   module Transport
-    # Kitchen Transport Express
+    # Kitchen Transport Express.
     #
     # @author Justin Steele <justin.steele@oracle.com>
     class Express
-      # A constant that gets prepended to debugger messages
+      # A constant that gets prepended to debugger messages.
       LOG_PREFIX = "EXPRESS"
     end
 
-    # Express SSH Transport Error class
+    # Express SSH Transport Error class.
     #
     # @author Justin Steele <justin.steele@oracle.com>
     class ExpressFailed < StandardError
@@ -38,17 +38,17 @@ module Kitchen
       end
     end
 
-    # Express SSH Transport plugin for Test Kitchen
+    # Express SSH Transport plugin for Test Kitchen.
     #
     # @author Justin Steele <justin.steele@oracle.com>
     class ExpressSsh < Kitchen::Transport::Ssh
       kitchen_transport_api_version 1
       plugin_version Express::VERSION
 
-      # Override the method in the super class to start the connection with our connection class
+      # Override the method in the super class to start the connection with our connection class.
       #
-      # @param options [Hash] connection options
-      # @return [Ssh::Connection] an instance of Kitchen::Transport::ExpressSsh::Connection
+      # @param options [Hash] connection options.
+      # @return [Ssh::Connection] an instance of Kitchen::Transport::ExpressSsh::Connection.
       def create_new_connection(options, &block)
         if @connection
           logger.debug("[#{Express::LOG_PREFIX}] Shutting previous connection #{@connection}")
@@ -59,16 +59,16 @@ module Kitchen
         @connection = self.class::Connection.new(options, &block)
       end
 
-      # Determines if the Kitchen instance is attempting a Verify stage
+      # Determines if the Kitchen instance is attempting a Verify stage.
       #
-      # @param instance [Kitchen::Instance] the instance passed in from Kitchen
+      # @param instance [Kitchen::Instance] the instance passed in from Kitchen.
       # @return [Boolean]
       def verifier_defined?(instance)
         defined?(Kitchen::Verifier::Inspec) && instance.verifier.is_a?(Kitchen::Verifier::Inspec)
       end
 
-      # Finalizes the Kitchen config by executing super and parsing the options provided by the kitchen.yml
-      # The only difference here is we layer in our ssh options so the verifier can use our transport
+      # Finalizes the Kitchen config by executing super and parsing the options provided by the kitchen.yml.
+      # The only difference here is we layer in our ssh options so the verifier can use our transport.
       # (see Kitchen::Transport::Ssh#finalize_config!)
       def finalize_config!(instance)
         super.tap do
@@ -88,15 +88,14 @@ module Kitchen
       class Connection < Kitchen::Transport::Ssh::Connection
         include Express::Archiver
 
+        # Overrides the upload method in Kitchen::Transport::Ssh::Connection.
+        # The special sauce here is that we create threaded uploads of archives of the kitchen files rather than serial file uploads.
         # (see Kitchen::Transport::Base::Connection#upload)
-        # Overrides the upload method in Kitchen::Transport::Ssh::Connection
-        # The special sauce here is that we create threaded executions of uploading our archives
         #
-        # @param locals [Array] the top-level list of directories and files to be transfered
-        # @param remote [String] the remote directory config[:kitchen_root]
-        # @raise [ExpressFailed] if any of the threads raised an exception
-        # rubocop: disable Metrics/MethodLength
-        def upload(locals, remote)
+        # @param locals [Array] the top-level list of directories and files to be transfered.
+        # @param remote [String] the remote directory (kitchen_root).
+        # @raise [ExpressFailed] if any of the threads raised an exception.
+        def upload(locals, remote) # rubocop: disable Metrics/MethodLength
           return super unless valid_remote_requirements?(remote)
 
           processed_locals = process_locals(locals)
@@ -112,14 +111,13 @@ module Kitchen
           pool.wait_for_termination
 
           raise ExpressFailed, exceptions.pop unless exceptions.empty?
-        end
-        # rubocop: enable Metrics/MethodLength
+        end # rubocop: enable Metrics/MethodLength
 
         private
 
-        # Creates the thread pool and exceptions queue
+        # Creates the thread pool and exceptions queue.
         #
-        # @param processed_locals [Array] list of files and archives to be uploaded
+        # @param processed_locals [Array] list of files and archives to be uploaded.
         # @return [Array(Concurrent::FixedThreadPool, Queue)]
         # @api private
         def thread_pool(processed_locals)
@@ -128,7 +126,7 @@ module Kitchen
 
         # Ensures the remote host has the minimum-required executables to extract the archives.
         #
-        # @param remote [String] the remote directory config[:kitchen_root]
+        # @param remote [String] the remote directory (kitchen_root).
         # @return [Boolean]
         # @api private
         def valid_remote_requirements?(remote)
@@ -144,8 +142,8 @@ module Kitchen
         # Builds an array of files we want to ship. If the top-level item is a directory, archive it and
         # add the archive name to the array.
         #
-        # @param locals [Array] the top-level list of directories and files to be transfered
-        # @return [Array] the paths to the files and archives that will be transferred
+        # @param locals [Array] the top-level list of directories and files to be transfered.
+        # @return [Array] the paths to the files and archives that will be transferred.
         # @api private
         def process_locals(locals)
           processed_locals = []
@@ -162,10 +160,10 @@ module Kitchen
 
         # Uploads the archives or files to the remote host.
         #
-        # @param local [String] a single top-level item from the upload method
-        # @param remote [String] path to remote destination
-        # @param opts [Hash] the ssh options that came in from the Kitchen instance
-        # @raise [StandardError] if the files could not be uploaded successfully
+        # @param local [String] a single top-level item from the upload method.
+        # @param remote [String] path to remote destination.
+        # @param opts [Hash] the ssh options that came in from the Kitchen instance.
+        # @raise [StandardError] if the files could not be uploaded successfully.
         # @api private
         def transfer(local, remote, opts = {})
           logger.debug("[#{Express::LOG_PREFIX}] Transferring #{local} to #{remote}")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-transport-express
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Justin Steele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-06 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -160,7 +160,11 @@ homepage: https://github.com/justintsteele/kitchen-transport-express.git
 licenses:
 - Apache-2.0
 metadata:
-  github_repo: https://github.com/justintsteele/kitchen-transport-express
+  bug_tracker_uri: https://github.com/justintsteele/kitchen-transport-express/issues
+  changelog_uri: https://github.com/justintsteele/kitchen-transport-express/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/justintsteele/kitchen-transport-express/blob/main/README.md
+  homepage_uri: https://github.com/justintsteele/kitchen-transport-express
+  source_code_uri: https://github.com/justintsteele/kitchen-transport-express
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -179,5 +183,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: Skip the long lines in transport. 15 items or less!
+summary: Skip the long lines in Kitchen Transport!
 test_files: []