iostreams 1.1.0 → 1.1.1

data/lib/io_streams/pgp.rb

@@ -1,4 +1,4 @@
-require 'open3'
+require "open3"
 module IOStreams
   # Read/Write PGP/GPG file or stream.
   #
@@ -82,8 +82,8 @@ module IOStreams
   # - Tested against gnupg v1.4.21 and v2.0.30
   # - Does not work yet with gnupg v2.1. Pull Requests welcome.
   module Pgp
-    autoload :Reader, 'io_streams/pgp/reader'
-    autoload :Writer, 'io_streams/pgp/writer'
+    autoload :Reader, "io_streams/pgp/reader"
+    autoload :Writer, "io_streams/pgp/writer"
 
     class Failure < StandardError
     end
@@ -99,7 +99,7 @@ module IOStreams
       @executable = executable
     end
 
-    @executable = 'gpg'
+    @executable = "gpg"
 
     # Generate a new ultimate trusted local public and private key.
     #
@@ -122,9 +122,9 @@ module IOStreams
     #     `SecureRandom.urlsafe_base64(128)`
     #
     # See `man gpg` for the remaining options
-    def self.generate_key(name:, email:, comment: nil, passphrase:, key_type: 'RSA', key_length: 4096, subkey_type: 'RSA', subkey_length: key_length, expire_date: nil)
+    def self.generate_key(name:, email:, comment: nil, passphrase:, key_type: "RSA", key_length: 4096, subkey_type: "RSA", subkey_length: key_length, expire_date: nil)
       version_check
-      params = ''
+      params = ""
       params << "Key-Type: #{key_type}\n" if key_type
       params << "Key-Length: #{key_length}\n" if key_length
       params << "Subkey-Type: #{subkey_type}\n" if subkey_type
@@ -134,14 +134,14 @@ module IOStreams
       params << "Name-Email: #{email}\n" if email
       params << "Expire-Date: #{expire_date}\n" if expire_date
       params << "Passphrase: #{passphrase}\n" if passphrase
-      params << '%commit'
-      command = "#{executable} --batch --gen-key --no-tty --quiet"
+      params << "%commit"
+      command = "#{executable} --batch --gen-key --no-tty"
 
       out, err, status = Open3.capture3(command, binmode: true, stdin_data: params)
-      logger.debug { "IOStreams::Pgp.generate_key: #{command}\n#{err}#{out}" } if logger
+      logger&.debug { "IOStreams::Pgp.generate_key: #{command}\n#{params}\n#{err}#{out}" }
       if status.success?
         if match = err.match(/gpg: key ([0-9A-F]+)\s+/)
-          return match[1]
+          match[1]
         end
       else
         raise(Pgp::Failure, "GPG Failed to generate key: #{err}#{out}")
@@ -172,12 +172,17 @@ module IOStreams
     end
 
     # Returns [true|false] whether their is a key for the supplied email or key_id
-    def self.has_key?(email: nil, key_id: nil, private: false)
-      raise(ArgumentError, 'Either :email, or :key_id must be supplied') if email.nil? && key_id.nil?
+    def self.key?(email: nil, key_id: nil, private: false)
+      raise(ArgumentError, "Either :email, or :key_id must be supplied") if email.nil? && key_id.nil?
 
       !list_keys(email: email, key_id: key_id, private: private).empty?
     end
 
+    # Deprecated
+    def self.has_key?(**args)
+      key(**args)
+    end
+
     # Returns [Array<Hash>] the list of keys.
     #   Each Hash consists of:
     #     key_length: [Integer]
@@ -189,15 +194,16 @@ module IOStreams
     # Returns [] if no keys were found.
     def self.list_keys(email: nil, key_id: nil, private: false)
       version_check
-      cmd     = private ? '--list-secret-keys' : '--list-keys'
+      cmd     = private ? "--list-secret-keys" : "--list-keys"
       command = "#{executable} #{cmd} #{email || key_id}"
 
       out, err, status = Open3.capture3(command, binmode: true)
-      logger.debug { "IOStreams::Pgp.list_keys: #{command}\n#{err}#{out}" } if logger
-      if status.success? && out.length > 0
+      logger&.debug { "IOStreams::Pgp.list_keys: #{command}\n#{err}#{out}" }
+      if status.success? && out.length.positive?
         parse_list_output(out)
       else
         return [] if err =~ /(not found|No (public|secret) key|key not available)/i
+
         raise(Pgp::Failure, "GPG Failed calling '#{executable}' to list keys for #{email || key_id}: #{err}#{out}")
       end
     end
@@ -219,8 +225,8 @@ module IOStreams
       command = executable.to_s
 
       out, err, status = Open3.capture3(command, binmode: true, stdin_data: key)
-      logger.debug { "IOStreams::Pgp.key_info: #{command}\n#{err}#{out}" } if logger
-      if status.success? && out.length > 0
+      logger&.debug { "IOStreams::Pgp.key_info: #{command}\n#{err}#{out}" }
+      if status.success? && out.length.positive?
         # Sample Output:
         #
         #   pub  4096R/3A5456F5 2017-06-07
@@ -243,15 +249,15 @@ module IOStreams
       version_check
 
       command = "#{executable} "
-      command << '--pinentry-mode loopback ' if pgp_version.to_f >= 2.1
-      command << '--armor ' if ascii
+      command << "--pinentry-mode loopback " if pgp_version.to_f >= 2.1
+      command << "--armor " if ascii
       command << "--no-tty  --batch --passphrase"
       command << (passphrase ? " #{passphrase} " : "-fd 0 ")
       command << (private ? "--export-secret-keys #{email}" : "--export #{email}")
 
       out, err, status = Open3.capture3(command, binmode: true)
-      logger.debug { "IOStreams::Pgp.export: #{command}\n#{err}" } if logger
-      if status.success? && out.length > 0
+      logger&.debug { "IOStreams::Pgp.export: #{command}\n#{err}" }
+      if status.success? && out.length.positive?
         out
       else
         raise(Pgp::Failure, "GPG Failed reading key: #{email}: #{err}")
@@ -319,7 +325,7 @@ module IOStreams
     # Notes:
     # - If the same email address has multiple keys then only the first is currently trusted.
     def self.import_and_trust(key:)
-      raise(ArgumentError, "Key cannot be empty") if key.nil? || (key == '')
+      raise(ArgumentError, "Key cannot be empty") if key.nil? || (key == "")
 
       email = key_info(key: key).first.fetch(:email)
       raise(ArgumentError, "Recipient email cannot be extracted from supplied key") unless email
@@ -443,20 +449,28 @@ module IOStreams
         if match = line.match(/(pub|sec)\s+(\D+)(\d+)\s+(\d+-\d+-\d+)\s+(.*)/)
           # v2.2:    pub   rsa1024 2017-10-24 [SCEA]
           hash = {
-            private:    match[1] == 'sec',
+            private:    match[1] == "sec",
             key_length: match[3].to_s.to_i,
             key_type:   match[2],
-            date:       (Date.parse(match[4].to_s) rescue match[4])
+            date:       (begin
+                           Date.parse(match[4].to_s)
+                         rescue StandardError
+                           match[4]
+                         end)
           }
         elsif match = line.match(%r{(pub|sec)\s+(\d+)(.*)/(\w+)\s+(\d+-\d+-\d+)(\s+(.+)<(.+)>)?})
           # Matches: pub  2048R/C7F9D9CB 2016-10-26
           # Or:      pub  2048R/C7F9D9CB 2016-10-26 Receiver <receiver@example.org>
           hash = {
-            private:    match[1] == 'sec',
+            private:    match[1] == "sec",
             key_length: match[2].to_s.to_i,
             key_type:   match[3],
             key_id:     match[4],
-            date:       (Date.parse(match[5].to_s) rescue match[5])
+            date:       (begin
+                           Date.parse(match[5].to_s)
+                         rescue StandardError
+                           match[5]
+                         end)
           }
           # Prior to gpg v2.0.30
           if match[7]
@@ -483,7 +497,7 @@ module IOStreams
     end
 
     def self.delete_public_or_private_keys(email:, private: false)
-      keys = private ? 'secret-keys' : 'keys'
+      keys = private ? "secret-keys" : "keys"
 
       list = list_keys(email: email, private: private)
       return false if list.empty?
@@ -499,19 +513,17 @@ module IOStreams
         unless status.success?
           raise(Pgp::Failure, "GPG Failed calling #{executable} to delete #{keys} for #{email}: #{err}: #{out}")
         end
-        if out.include?('error')
-          raise(Pgp::Failure, "GPG Failed to delete #{keys} for #{email} #{err.strip}:#{out}")
-        end
+        raise(Pgp::Failure, "GPG Failed to delete #{keys} for #{email} #{err.strip}:#{out}") if out.include?("error")
       end
       true
     end
 
     def self.delete_public_or_private_keys_v1(email:, private: false)
-      keys = private ? 'secret-keys' : 'keys'
+      keys = private ? "secret-keys" : "keys"
 
       command = "for i in `#{executable} --list-#{keys} --with-colons --fingerprint #{email} | grep \"^fpr\" | cut -d: -f10`; do\n"
       command << "#{executable} --batch --no-tty --yes --delete-#{keys} \"$i\" ;\n"
-      command << 'done'
+      command << "done"
 
       out, err, status = Open3.capture3(command, binmode: true)
       logger&.debug { "IOStreams::Pgp.delete_keys: #{command}\n#{err}: #{out}" }
@@ -520,9 +532,7 @@ module IOStreams
       unless status.success?
         raise(Pgp::Failure, "GPG Failed calling #{executable} to delete #{keys} for #{email}: #{err}: #{out}")
       end
-      if out.include?('error')
-        raise(Pgp::Failure, "GPG Failed to delete #{keys} for #{email} #{err.strip}: #{out}")
-      end
+      raise(Pgp::Failure, "GPG Failed to delete #{keys} for #{email} #{err.strip}: #{out}") if out.include?("error")
 
       true
     end

data/lib/io_streams/pgp/reader.rb

@@ -1,4 +1,4 @@
-require 'open3'
+require "open3"
 
 module IOStreams
   module Pgp
@@ -24,9 +24,9 @@ module IOStreams
       def self.file(file_name, passphrase: nil)
         # Cannot use `passphrase: self.default_passphrase` since it is considered private
         passphrase ||= default_passphrase
-        raise(ArgumentError, 'Missing both passphrase and IOStreams::Pgp::Reader.default_passphrase') unless passphrase
+        raise(ArgumentError, "Missing both passphrase and IOStreams::Pgp::Reader.default_passphrase") unless passphrase
 
-        loopback = IOStreams::Pgp.pgp_version.to_f >= 2.1 ? '--pinentry-mode loopback' : ''
+        loopback = IOStreams::Pgp.pgp_version.to_f >= 2.1 ? "--pinentry-mode loopback" : ""
         command  = "#{IOStreams::Pgp.executable} #{loopback} --batch --no-tty --yes --decrypt --passphrase-fd 0 #{file_name}"
         IOStreams::Pgp.logger&.debug { "IOStreams::Pgp::Reader.open: #{command}" }
 
@@ -42,9 +42,7 @@ module IOStreams
               # Ignore broken pipe because gpg terminates early due to an error
               raise(Pgp::Failure, "GPG Failed reading from encrypted file: #{file_name}: #{stderr.read.chomp}")
             end
-          unless waith_thr.value.success?
-            raise(Pgp::Failure, "GPG Failed to decrypt file: #{file_name}: #{stderr.read.chomp}")
-          end
+          raise(Pgp::Failure, "GPG Failed to decrypt file: #{file_name}: #{stderr.read.chomp}") unless waith_thr.value.success?
 
           result
         end

data/lib/io_streams/pgp/writer.rb

@@ -1,4 +1,4 @@
-require 'open3'
+require "open3"
 
 module IOStreams
   module Pgp
@@ -81,7 +81,6 @@ module IOStreams
           end
         end
       end
-
     end
   end
 end

data/lib/io_streams/reader.rb

@@ -4,14 +4,14 @@ module IOStreams
     # and then pass that filename in for this reader.
     def self.stream(input_stream, **args, &block)
       Utils.temp_file_name("iostreams_reader") do |file_name|
-        ::File.open(file_name, 'wb') { |target| ::IO.copy_stream(input_stream, target) }
+        ::File.open(file_name, "wb") { |target| ::IO.copy_stream(input_stream, target) }
         file(file_name, **args, &block)
       end
     end
 
     # When a Writer supports streams, also allow it to simply support a file
     def self.file(file_name, original_file_name: file_name, **args, &block)
-      ::File.open(file_name, 'rb') { |file| stream(file, original_file_name: original_file_name, **args, &block) }
+      ::File.open(file_name, "rb") { |file| stream(file, original_file_name: original_file_name, **args, &block) }
     end
 
     # For processing by either a file name or an open IO stream.

data/lib/io_streams/record/writer.rb

@@ -35,9 +35,7 @@ module IOStreams
       #
       #   For all other parameters, see Tabular::Header.new
       def initialize(line_writer, columns: nil, **args)
-        unless line_writer.respond_to?(:<<)
-          raise(ArgumentError, 'Stream must be a IOStreams::Line::Writer or implement #<<')
-        end
+        raise(ArgumentError, "Stream must be a IOStreams::Line::Writer or implement #<<") unless line_writer.respond_to?(:<<)
 
         @tabular     = IOStreams::Tabular.new(columns: columns, **args)
         @line_writer = line_writer
@@ -47,7 +45,7 @@ module IOStreams
       end
 
       def <<(hash)
-        raise(ArgumentError, '#<< only accepts a Hash argument') unless hash.is_a?(Hash)
+        raise(ArgumentError, "#<< only accepts a Hash argument") unless hash.is_a?(Hash)
 
         if @tabular.header?
           # Extract header from the keys from the first row when not supplied above.

data/lib/io_streams/row/writer.rb

@@ -1,4 +1,4 @@
-require 'csv'
+require "csv"
 module IOStreams
   module Row
     # Example:
@@ -37,9 +37,7 @@ module IOStreams
       #
       #   For all other parameters, see Tabular::Header.new
       def initialize(line_writer, columns: nil, **args)
-        unless line_writer.respond_to?(:<<)
-          raise(ArgumentError, 'Stream must be a IOStreams::Line::Writer or implement #<<')
-        end
+        raise(ArgumentError, "Stream must be a IOStreams::Line::Writer or implement #<<") unless line_writer.respond_to?(:<<)
 
         @tabular     = IOStreams::Tabular.new(columns: columns, **args)
         @line_writer = line_writer
@@ -50,7 +48,7 @@ module IOStreams
 
       # Supply a hash or an array to render
       def <<(array)
-        raise(ArgumentError, 'Must supply an Array') unless array.is_a?(Array)
+        raise(ArgumentError, "Must supply an Array") unless array.is_a?(Array)
 
         if @tabular.header?
           # If header (columns) was not supplied as an argument, assume first line is the header.

data/lib/io_streams/stream.rb

@@ -4,7 +4,7 @@ module IOStreams
     attr_writer :builder
 
     def initialize(io_stream)
-      raise(ArgumentError, 'io_stream cannot be nil') if io_stream.nil?
+      raise(ArgumentError, "io_stream cannot be nil") if io_stream.nil?
       raise(ArgumentError, "io_stream must not be a string: #{io_stream.inspect}") if io_stream.is_a?(String)
 
       @io_stream = io_stream
@@ -266,7 +266,7 @@ module IOStreams
     #   IOStreams.path(".profile").extension        #=> ""
     #   IOStreams.path(".profile.sh").extension     #=> "sh"
     def extension
-      extname&.sub(/^\./, '')
+      extname&.sub(/^\./, "")
     end
 
     private
@@ -280,7 +280,7 @@ module IOStreams
     end
 
     def line_reader(embedded_within: nil, **args)
-      embedded_within = '"' if embedded_within.nil? && builder.file_name&.include?('.csv')
+      embedded_within = '"' if embedded_within.nil? && builder.file_name&.include?(".csv")
 
       stream_reader { |io| yield IOStreams::Line::Reader.new(io, embedded_within: embedded_within, **args) }
     end
@@ -304,19 +304,19 @@ module IOStreams
     end
 
     def line_writer(**args, &block)
-      return block.call(io_stream) if io_stream && io_stream.is_a?(IOStreams::Line::Writer)
+      return block.call(io_stream) if io_stream&.is_a?(IOStreams::Line::Writer)
 
       writer { |io| IOStreams::Line::Writer.stream(io, **args, &block) }
     end
 
     def row_writer(delimiter: $/, **args, &block)
-      return block.call(io_stream) if io_stream && io_stream.is_a?(IOStreams::Row::Writer)
+      return block.call(io_stream) if io_stream&.is_a?(IOStreams::Row::Writer)
 
       line_writer(delimiter: delimiter) { |io| IOStreams::Row::Writer.stream(io, **args, &block) }
     end
 
     def record_writer(delimiter: $/, **args, &block)
-      return block.call(io_stream) if io_stream && io_stream.is_a?(IOStreams::Record::Writer)
+      return block.call(io_stream) if io_stream&.is_a?(IOStreams::Record::Writer)
 
       line_writer(delimiter: delimiter) { |io| IOStreams::Record::Writer.stream(io, **args, &block) }
     end

data/lib/io_streams/symmetric_encryption/reader.rb

@@ -3,9 +3,7 @@ module IOStreams
     class Reader < IOStreams::Reader
       # read from a file/stream using Symmetric Encryption
       def self.stream(input_stream, **args, &block)
-        unless defined?(SymmetricEncryption)
-          Utils.load_soft_dependency('symmetric-encryption', '.enc streaming')
-        end
+        Utils.load_soft_dependency("symmetric-encryption", ".enc streaming") unless defined?(SymmetricEncryption)
 
         ::SymmetricEncryption::Reader.open(input_stream, **args, &block)
       end

data/lib/io_streams/symmetric_encryption/writer.rb

@@ -5,9 +5,7 @@ module IOStreams
       # By default the output stream is compressed.
       # If the input_stream is already compressed consider setting compress: false.
       def self.stream(input_stream, compress: true, **args, &block)
-        unless defined?(SymmetricEncryption)
-          Utils.load_soft_dependency('symmetric-encryption', '.enc streaming')
-        end
+        Utils.load_soft_dependency("symmetric-encryption", ".enc streaming") unless defined?(SymmetricEncryption)
 
         ::SymmetricEncryption::Writer.open(input_stream, compress: compress, **args, &block)
       end
@@ -15,9 +13,7 @@ module IOStreams
       # Write to stream using Symmetric Encryption
       # By default the output stream is compressed unless the file_name extension indicates the file is already compressed.
       def self.file(file_name, compress: nil, **args, &block)
-        unless defined?(SymmetricEncryption)
-          Utils.load_soft_dependency('symmetric-encryption', '.enc streaming')
-        end
+        Utils.load_soft_dependency("symmetric-encryption", ".enc streaming") unless defined?(SymmetricEncryption)
 
         ::SymmetricEncryption::Writer.open(file_name, compress: compress, **args, &block)
       end

data/lib/io_streams/tabular.rb

@@ -28,20 +28,20 @@ module IOStreams
   #   tabular.render({"third"=>"3", "first_field"=>"1" })
   #   # => "1,,3"
   class Tabular
-    autoload :Header, 'io_streams/tabular/header'
+    autoload :Header, "io_streams/tabular/header"
 
     module Parser
-      autoload :Array, 'io_streams/tabular/parser/array'
-      autoload :Base, 'io_streams/tabular/parser/base'
-      autoload :Csv, 'io_streams/tabular/parser/csv'
-      autoload :Fixed, 'io_streams/tabular/parser/fixed'
-      autoload :Hash, 'io_streams/tabular/parser/hash'
-      autoload :Json, 'io_streams/tabular/parser/json'
-      autoload :Psv, 'io_streams/tabular/parser/psv'
+      autoload :Array, "io_streams/tabular/parser/array"
+      autoload :Base, "io_streams/tabular/parser/base"
+      autoload :Csv, "io_streams/tabular/parser/csv"
+      autoload :Fixed, "io_streams/tabular/parser/fixed"
+      autoload :Hash, "io_streams/tabular/parser/hash"
+      autoload :Json, "io_streams/tabular/parser/json"
+      autoload :Psv, "io_streams/tabular/parser/psv"
     end
 
     module Utility
-      autoload :CSVRow, 'io_streams/tabular/utility/csv_row'
+      autoload :CSVRow, "io_streams/tabular/utility/csv_row"
     end
 
     attr_reader :format, :header, :parser
@@ -132,6 +132,7 @@ module IOStreams
     #   register_format(:csv, IOStreams::Tabular::Parser::Csv)
     def self.register_format(format, parser)
       raise(ArgumentError, "Invalid format #{format.inspect}") unless format.nil? || format.to_s =~ /\A\w+\Z/
+
       @formats[format.nil? ? nil : format.to_sym] = parser
     end
 
@@ -143,6 +144,7 @@ module IOStreams
     #   register_extension(:xls)
     def self.deregister_format(format)
       raise(ArgumentError, "Invalid format #{format.inspect}") unless format.to_s =~ /\A\w+\Z/
+
       @formats.delete(format.to_sym)
     end
 
@@ -163,7 +165,7 @@ module IOStreams
     # Returns the parser to use with tabular for the supplied file_name
     def self.parser_class_for_file_name(file_name)
       format = nil
-      file_name.to_s.split('.').reverse_each do |ext|
+      file_name.to_s.split(".").reverse_each do |ext|
         if @formats.include?(ext.to_sym)
           format = ext.to_sym
           break