sym 3.0.0 → 3.0.1

data/exe/keychain

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib_path = File.expand_path(File.dirname(__FILE__) + '/../lib')
+lib_path = File.expand_path("#{File.dirname(__FILE__)}/../lib")
 $LOAD_PATH << lib_path if File.exist?(lib_path) && !$LOAD_PATH.include?(lib_path)
 
 require 'sym'
@@ -9,7 +9,7 @@ require 'sym/app/keychain'
 require 'colored2'
 
 def usage
-  puts 'Usage: ' + 'keychain'.bold.blue + ' name [ add <contents> | find | delete ]'.bold.green
+  puts "Usage: #{'keychain'.bold.blue}#{' name [ add <contents> | find | delete ]'.bold.green}"
   exit 0
 end
 

data/exe/sym

@@ -3,7 +3,7 @@
 
 require_relative '../lib/ruby_warnings'
 
-lib_path = File.expand_path(File.dirname(__FILE__) + '/../lib')
+lib_path = File.expand_path("#{File.dirname(__FILE__)}/../lib")
 $LOAD_PATH << lib_path if File.exist?(lib_path) && !$LOAD_PATH.include?(lib_path)
 
 require 'sym'
@@ -13,9 +13,9 @@ require 'sym/app'
 begin
   exit ::Sym::App::CLI.new(ARGV.dup).execute
 rescue Interrupt => e
-  STDERR.flush
+  $stderr.flush
   warn "Interrupt, #{e.message}, exiting."
-  STDERR.flush
+  $stderr.flush
   exit 1
 end
 

data/lib/sym/app.rb

@@ -16,15 +16,14 @@ module Sym
   #
   module App
     class << self
-      attr_accessor :exit_code
-      attr_accessor :stdin, :stdout, :stderr
+      attr_accessor :exit_code, :stdin, :stdout, :stderr
     end
 
     self.exit_code = 0
 
-    self.stdin     = STDIN
-    self.stdout    = STDOUT
-    self.stderr    = STDERR
+    self.stdin     = $stdin
+    self.stdout    = $stdout
+    self.stderr    = $stderr
 
     def self.out
       self.stderr
@@ -44,7 +43,7 @@ module Sym
 
       lines = []
 
-      error_type    = "#{(type || exception.class.name)}"
+      error_type    = "#{type || exception.class.name}"
       error_details = (details || exception.message)
 
       operation = command ? "to #{command.class.short_name.to_s.humanize.downcase}" : ''
@@ -55,7 +54,7 @@ module Sym
         lines << exception.backtrace.join("\n").red.bold if config[:trace]
         lines << "\n"
       else
-        lines << " ✖ Sym Error #{operation}:".bold.red + (reason ? " #{reason} ".red.italic: " #{error_details}")[0..70] + ' '.normal + "\n"
+        lines << "#{" ✖ Sym Error #{operation}:".bold.red}#{(reason ? " #{reason} ".red.italic: " #{error_details}")[0..70]}#{' '.normal}\n"
         lines << "#{comments}" if comments
       end
 

data/lib/sym/app/cli.rb

@@ -58,7 +58,7 @@ module Sym
 
       attr_accessor :opts, :application, :outputs, :stdin, :stdout, :stderr, :kernel, :args
 
-      def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
+      def initialize(argv, stdin = $stdin, stdout = $stdout, stderr = $stderr, kernel = nil)
         self.args   = argv
         self.stdin  = stdin
         self.stdout = stdout
@@ -79,15 +79,13 @@ module Sym
           end
 
           # Deal with SYM_ARGS and -A
-          if opts[:sym_args]
-            if non_empty_array?(sym_args)
+          if opts[:sym_args] && non_empty_array?(sym_args)
               args << sym_args
               args.flatten!
               args.compact!
               args.delete('-A')
               args.delete('--sym-args')
               self.opts = parse(args)
-            end
           end
 
           # Disable coloring if requested, or if piping STDOUT
@@ -99,7 +97,7 @@ module Sym
         rescue StandardError => e
           log :error, "#{e.message}" if opts
           error exception: e
-          quit!(127) if stdin == STDIN
+          quit!(127) if stdin == $stdin
         end
 
         self.application = ::Sym::Application.new(self.opts, stdin, stdout, stderr, kernel)

data/lib/sym/app/cli_slop.rb

@@ -19,7 +19,7 @@ module Sym
           o.separator '      5) use -i to paste/type the key interactively'.dark
           o.separator '      6) default key file (if present) at '.dark + Sym.default_key_file.magenta.bold
           o.separator ' '
-          o.separator '       ' + key_spec + ' = -k/--key [ key | file | keychain | env variable name ]'.green.bold
+          o.separator "       #{key_spec}#{' = -k/--key [ key | file | keychain | env variable name ]'.green.bold}"
           o.separator         '                  -i/--interactive'.green.bold
           o.separator ''
           o.separator '   Encrypt/Decrypt from STDIN/file/args, to STDOUT/file:'.dark
@@ -48,7 +48,7 @@ module Sym
           o.separator 'Modes:'.yellow
           o.bool      '-e', '--encrypt',            '           encrypt mode'
           o.bool      '-d', '--decrypt',            '           decrypt mode'
-          o.string    '-t', '--edit',               '[file]  '.blue + '   edit encrypted file in an $EDITOR', default: nil
+          o.string    '-t', '--edit',               "#{'[file]  '.blue}   edit encrypted file in an $EDITOR", default: nil
           o.string    '-n', '--negate',             '[file]  '.blue + "   encrypts any regular #{'file'.green} into #{'file.enc'.green}" + "\n" +
                                      "                                    conversely decrypts #{'file.enc'.green} into #{'file'.green}."
           o.separator ' '
@@ -57,25 +57,25 @@ module Sym
           o.bool      '-p', '--password',           '           encrypt the key with a password'
 
           if Sym::App.osx?
-            o.string '-x', '--keychain',            '[key-name] '.blue + 'write the key to OS-X Keychain'
+            o.string '-x', '--keychain',            "#{'[key-name] '.blue}write the key to OS-X Keychain"
           end
 
           o.separator ' '
           o.separator 'Read existing private key from:'.yellow
-          o.string    '-k', '--key',                '[key-spec]'.blue + ' private key, key file, or keychain'
+          o.string    '-k', '--key',                "#{'[key-spec]'.blue} private key, key file, or keychain"
           o.bool      '-i', '--interactive',        '           Paste or type the key interactively'
 
           o.separator ' '
           o.separator 'Password Cache:'.yellow
           o.bool      '-c', '--cache-passwords',     '           enable password cache'
-          o.integer   '-z', '--cache-timeout',       '[seconds]'.blue + '  expire passwords after'
+          o.integer   '-z', '--cache-timeout',       "#{'[seconds]'.blue}  expire passwords after"
           o.string    '-r', '--cache-provider',      '[provider]'.blue + ' cache provider, one of ' + "#{Sym::App::Password::Providers.provider_list}"
 
           o.separator ' '
           o.separator 'Data to Encrypt/Decrypt:'.yellow
-          o.string    '-s', '--string',             '[string]'.blue + '   specify a string to encrypt/decrypt'
-          o.string    '-f', '--file',               '[file]  '.blue + '   filename to read from'
-          o.string    '-o', '--output',             '[file]  '.blue + '   filename to write to'
+          o.string    '-s', '--string',             "#{'[string]'.blue}   specify a string to encrypt/decrypt"
+          o.string    '-f', '--file',               "#{'[file]  '.blue}   filename to read from"
+          o.string    '-o', '--output',             "#{'[file]  '.blue}   filename to write to"
 
           o.separator ' '
           o.separator 'Flags:'.yellow
@@ -95,8 +95,7 @@ module Sym
                         "   user home available, you may need to force set user's home to any existing\n" +
                         "   directory using the #{'--user-home'.bold.blue} flag.\n"
 
-          o.string    '-B', '--bash-support',       '[file]'.blue + '     append bash completion & utils to a file'+ "\n" +
-            '                                    such as ~/.bash_profile or ~/.bashrc'
+          o.string    '-B', '--bash-support',       "#{'[file]'.blue}     append bash completion & utils to a file\n                                    such as ~/.bash_profile or ~/.bashrc"
           o.string    '-u', '--user-home',       '[DIR]'.blue + "      Overrides #{'${HOME}'.green} ==> supports AWS Lambda\n"
 
           o.separator ' '

data/lib/sym/app/commands/base_command.rb

@@ -50,6 +50,7 @@ module Sym
         extend Forwardable
 
         attr_accessor :application
+
         def_delegators :@application, :opts, :opts_slop, :key, :stdin, :stdout, :stderr, :kernel
 
         def initialize(application)

data/lib/sym/app/commands/bash_completion.rb

@@ -50,7 +50,7 @@ module Sym
 
         def append_completion_script(file, script)
           File.open(file, 'a') do |fd|
-            fd.write(script + "\n")
+            fd.write("#{script}\n")
           end
         end
 

data/lib/sym/app/commands/keychain_add_key.rb

@@ -13,7 +13,7 @@ module Sym
 
         def execute
           if Sym.default_key? && Sym.default_key == self.key
-            raise 'Refusing to import key specified in the default key file ' + Sym.default_key_file.italic
+            raise "Refusing to import key specified in the default key file #{Sym.default_key_file.italic}"
           end
           raise Sym::Errors::NoPrivateKeyFound.new("Unable to resolve private key from argument '#{opts[:key]}'") if self.key.nil?
           add_to_keychain_if_needed(self.key)

data/lib/sym/app/commands/show_examples.rb

@@ -16,12 +16,12 @@ module Sym
                             result:  '75ngenJpB6zL47/8Wo7Ne6JN1pnOsqNEcIqblItpfg4='.green)
 
           output << example(comment: 'generate a new key with a cached password & save to the default key file',
-                            command: 'sym -gcpqo ' + Sym.default_key_file,
-                            echo:    'New Password     : ' + '••••••••••'.green,
-                            result:  'Confirm Password : ' + '••••••••••'.green)
+                            command: "sym -gcpqo #{Sym.default_key_file}",
+                            echo:    "New Password     : #{'••••••••••'.green}",
+                            result:  "Confirm Password : #{'••••••••••'.green}")
 
           output << example(comment: 'encrypt a plain text string with default key file, and immediately decrypt it',
-                            command: 'sym -es ' + '"secret string"'.bold.yellow + ' | sym -d',
+                            command: "sym -es #{'"secret string"'.bold.yellow} | sym -d",
                             result:  'secret string'.green)
 
           output << example(comment: 'encrypt secrets file using key in the environment, and --negate option:',
@@ -35,7 +35,7 @@ module Sym
                             result:  'secret string'.green)
 
           output << example(comment: 'encrypt/decrypt sym.yml using the default key file',
-                            command: 'sym -gcq > ' + Sym.default_key_file,
+                            command: "sym -gcq > #{Sym.default_key_file}",
                             echo:    'sym -n secrets.yml',
                             result:  'sym -df secrets.yml.enc',
           )

data/lib/sym/app/input/handler.rb

@@ -6,7 +6,7 @@ module Sym
       class Handler
         attr_accessor :stdin, :stdout, :stderr, :kernel
 
-        def initialize(stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
+        def initialize(stdin = $stdin, stdout = $stdout, stderr = $stderr, kernel = nil)
           self.stdin  = stdin
           self.stdout = stdout
           self.stderr = stderr
@@ -27,7 +27,7 @@ module Sym
         end
 
         def prompt(message, color)
-          unless STDIN.isatty && STDIN.tty?
+          unless $stdin.isatty && $stdin.tty?
             raise Sym::Errors::CantReadPasswordNoTTY.new('key requires a password, however STDIN is not a TTY')
           end
           highline(message, color)

data/lib/sym/app/output/base.rb

@@ -6,7 +6,7 @@ module Sym
 
         attr_accessor :opts, :stdin, :stdout, :stderr, :kernel
 
-        def initialize(opts, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
+        def initialize(opts, stdin = $stdin, stdout = $stdout, stderr = $stderr, kernel = nil)
           self.opts   = opts
           self.stdin  = stdin
           self.stdout = stdout

data/lib/sym/app/password/providers.rb

@@ -4,9 +4,7 @@ module Sym
       module Providers
 
         class << self
-          attr_accessor :registry
-          attr_accessor :providers
-          attr_accessor :detected
+          attr_accessor :registry, :providers, :detected
 
           def register(provider_class)
             self.registry                        ||= {}

data/lib/sym/app/private_key/key_source_check.rb

@@ -16,9 +16,8 @@ module Sym
         attr_accessor :name, :reducted, :input, :output
 
         def initialize(name:,
-                       reducted: false,
-                       input: ->(detector) { detector.opts[:key] },
-                       output:)
+                       output:, reducted: false,
+                       input: ->(detector) { detector.opts[:key] })
 
           self.name     = name
           self.reducted = reducted

data/lib/sym/application.rb

@@ -31,7 +31,7 @@ module Sym
                   :password_cache,
                   :stdin, :stdout, :stderr, :kernel
 
-    def initialize(opts, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
+    def initialize(opts, stdin = $stdin, stdout = $stdout, stderr = $stderr, kernel = nil)
       self.stdin  = stdin
       self.stdout = stdout
       self.stderr = stderr
@@ -224,9 +224,9 @@ module Sym
       detect_key_source
       if args.require_key? && !self.key
         log :error, 'Unable to determine the key, which appears to be required with current args'
-        raise Sym::Errors::NoPrivateKeyFound, 'Private key is required when ' + (self.action ? self.action.to_s + 'ypting' : provided_flags.join(', '))
+        raise Sym::Errors::NoPrivateKeyFound, "Private key is required when #{self.action ? "#{self.action.to_s}ypting" : provided_flags.join(', ')}"
       end
-      log :debug, "initialize_key_source: detected key ends with [...#{(key ? key[-5..-1] : 'nil').bold.magenta}]"
+      log :debug, "initialize_key_source: detected key ends with [...#{(key ? key[-5..] : 'nil').bold.magenta}]"
       log :debug, "opts: #{self.provided_value_options.to_s.green.bold}"
       log :debug, "flags: #{self.provided_flags.to_s.green.bold}"
     end

data/lib/sym/configuration.rb

@@ -35,10 +35,6 @@ module Sym
 
     # See file +lib/sym.rb+ where these values are defined.
 
-    attr_accessor :data_cipher, :password_cipher, :private_key_cipher
-    attr_accessor :compression_enabled, :compression_level
-    attr_accessor :password_cache_default_provider, :password_cache_timeout
-    attr_accessor :password_cache_arguments
-    attr_accessor :default_key_file, :encrypted_file_extension
+    attr_accessor :data_cipher, :password_cipher, :private_key_cipher, :compression_enabled, :compression_level, :password_cache_default_provider, :password_cache_timeout, :password_cache_arguments, :default_key_file, :encrypted_file_extension
   end
 end

data/lib/sym/constants.rb

@@ -53,7 +53,7 @@ module Sym
 
     module Log
       NIL = Logger.new(nil).freeze # empty logger
-      LOG = Logger.new(STDERR).freeze
+      LOG = Logger.new($stderr).freeze
     end
   end
 end

data/lib/sym/data.rb

@@ -11,11 +11,11 @@ module Sym
   # the result of `Marshal.dump(data)` using Zlib, and then doing `#urlsafe_encode64` encoding
   # to convert it to a string,
   module Data
-    def encode(data, compress = true)
+    def encode(data, compress: true)
       Encoder.new(data, compress).data_encoded
     end
 
-    def decode(data_encoded, compress = nil)
+    def decode(data_encoded, compress: nil)
       Decoder.new(data_encoded, compress).data
     end
   end

data/lib/sym/extensions/instance_methods.rb

@@ -72,7 +72,7 @@ module Sym
         key_len = cipher.key_len
         salt    ||= OpenSSL::Random.random_bytes 16
         iter    = 20_000
-        digest  = OpenSSL::Digest::SHA256.new
+        digest  = OpenSSL::Digest.new('SHA256')
         key     = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iter, key_len, digest)
         return key, salt
       end
@@ -85,15 +85,15 @@ module Sym
                                                   iv:          iv)
 
         block.call(cipher_struct) if block
-
+ 
         encrypted_data = update_cipher(cipher_struct.cipher, data)
         arguments      = { encrypted_data: encrypted_data,
                            iv:             cipher_struct.iv,
                            cipher_name:    cipher_struct.cipher.name,
                            salt:           cipher_struct.salt,
                            compress:       !compression_enabled }
-        wrapper_struct = WrapperStruct.new(arguments)
-        encode(wrapper_struct, false)
+        wrapper_struct = WrapperStruct.new(**arguments)
+        encode(wrapper_struct, compress: false)
       end
 
       # Expects key to be a base64 encoded key data
@@ -109,7 +109,7 @@ module Sym
 
       def encode_incoming_data(data)
         compression_enabled = !data.respond_to?(:size) || (data.size > 100 && encryption_config.compression_enabled)
-        data                = encode(data, compression_enabled)
+        data                = encode(data, compress: compression_enabled)
         [data, compression_enabled]
       end
 

data/lib/sym/extensions/stdlib.rb

@@ -13,8 +13,8 @@ class Object
   unless self.methods.include?(:present?)
     def present?
       return false if self.nil?
-      if self.is_a?(String)
-        return false if self == ''
+      if self.is_a?(String) && (self == '')
+        return false
       end
       true
     end

data/lib/sym/version.rb

@@ -1,5 +1,5 @@
 module Sym
-  VERSION     = '3.0.0'
+  VERSION     = '3.0.1'
   DESCRIPTION = <<~eof
 
      Sym is a ruby library (gem) that offers both the command line interface 

data/sym.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.6'
   spec.post_install_message = <<~EOF
     
     Thank you for installing Sym! 
@@ -60,7 +60,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'relaxed-rubocop'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec-its'
-  spec.add_development_dependency 'rubocop', '0.81.0'
+  spec.add_development_dependency 'rubocop' # , '0.81.0'
+  spec.add_development_dependency 'rubocop-rspec' # , '0.81.0'
+  spec.add_development_dependency 'rubocop-rake' # , '0.81.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'codecov'
   spec.add_development_dependency 'yard'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sym
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-15 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -196,16 +196,44 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -294,12 +322,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.adoc
+- README.pdf
 - Rakefile
 - SYM-CLI.md
 - bin/changelog
@@ -388,14 +418,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.8
 signing_key:
 specification_version: 4
 summary: Dead-simple and easy to use encryption library on top of OpenSSL, offering