sym 2.8.5 → 2.10.0

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 require 'yard'
 require 'timeout'
 
@@ -25,14 +26,17 @@ task :build => :permissions
 
 YARD::Rake::YardocTask.new(:doc) do |t|
   t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE)
-  t.options.unshift('--title','"Sym – Symmetric Key Encryption for Your Data"')
-  t.after = ->() { exec('open doc/index.html') }
+  t.options.unshift('--title', '"Sym – Symmetric Key Encryption for Your Data"')
+  t.after = -> { exec('open doc/index.html') }
 end
 
 RSpec::Core::RakeTask.new(:spec)
 
+RuboCop::RakeTask.new
+
 task :default => :spec
 
 
 
 
+

data/codecov.yml

@@ -0,0 +1,29 @@
+codecov:
+  require_ci_to_pass: no
+
+  notify:
+    wait_for_ci: yes
+
+parsers:
+  v1:
+    include_full_missed_files: true # To use with Ruby so we see files that have NO tests written
+
+coverage:
+  range: 50..75
+  round: down
+  precision: 1
+  status:
+    project:
+      default: off
+      sym:
+        target: 70%
+        threshold: 10%
+        informational: true
+        if_not_found: success
+        if_ci_failed: error
+        paths:
+          - lib/
+flags:
+  sym:
+    paths:
+      - lib/

data/exe/keychain

@@ -32,7 +32,7 @@ puts data ? \
   Sym::App::KeyChain.new(key_name).send(action.to_sym, data) :
   Sym::App::KeyChain.new(key_name).send(action.to_sym)
 rescue StandardError => e
-  STDERR.puts "#{e.message.red}"
+  warn "#{e.message.red}"
 end
 
 

data/exe/sym

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+# vim: ft=ruby
+
+require_relative '../lib/ruby_warnings'
 
 lib_path = File.expand_path(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH << lib_path if File.exist?(lib_path) && !$LOAD_PATH.include?(lib_path)
@@ -6,12 +9,12 @@ $LOAD_PATH << lib_path if File.exist?(lib_path) && !$LOAD_PATH.include?(lib_path
 require 'sym'
 require 'sym/app'
 
-#ARGV.any?{ |a| a =~ /^-/ } ?
+# ARGV.any?{ |a| a =~ /^-/ } ?
 begin
   exit ::Sym::App::CLI.new(ARGV.dup).execute
 rescue Interrupt => e
   STDERR.flush
-  STDERR.puts "Interrupt, #{e.message}, exiting."
+  warn "Interrupt, #{e.message}, exiting."
   STDERR.flush
   exit 1
 end

data/lib/ruby_warnings.rb

@@ -0,0 +1,7 @@
+ruby_version = RbConfig::CONFIG['MAJOR'].to_i * 10 + RbConfig::CONFIG['MINOR'].to_i
+if ruby_version >= 27
+  Warning[:deprecated] = false
+  ENV['RUBYOPT'] = '-W:no-deprecated'
+else
+  ENV['RUBYOPT']="-W0"
+end

data/lib/sym.rb

@@ -21,17 +21,11 @@ Sym::Configuration.configure do |config|
   # When nil is selected, providers are auto-detected.
   config.password_cache_default_provider = nil
   config.password_cache_arguments        = {
-    drb:       {
-      opts: {
-        uri: 'druby://127.0.0.1:24924'
-      }
-    },
     memcached: {
       args: %w(127.0.0.1:11211),
       opts: { namespace:  'sym',
               compress:   true,
-              expires_in: config.password_cache_timeout
-      }
+              expires_in: config.password_cache_timeout}
 
     }
   }

data/lib/sym/app.rb

@@ -66,7 +66,7 @@ module Sym
       self.exit_code = 1
     end
 
-    def self.is_osx?
+    def self.osx?
       Gem::Platform.local.os.eql?('darwin')
     end
 

data/lib/sym/app/args.rb

@@ -12,7 +12,7 @@ module Sym
 
       def initialize(opts)
         self.opts             = opts
-        self.selected_options = opts.keys.reject { |k| !opts[k] }
+        self.selected_options = opts.keys.select { |k| opts[k] }
       end
 
       def specify_key?
@@ -33,10 +33,11 @@ module Sym
       end
 
       def provided_options
-        opts.to_hash.keys.reject { |k| !opts[k] }
+        opts.to_hash.keys.select { |k| opts[k] }
       end
 
       private
+
       def do?(list)
         !(list & selected_options).empty?
       end

data/lib/sym/app/cli.rb

@@ -60,7 +60,6 @@ module Sym
 
 
       def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
-
         self.stdin  = stdin
         self.stdout = stdout
         self.stderr = stderr
@@ -140,7 +139,7 @@ module Sym
       private
 
       def log(*args)
-        Sym::App.log(*args, **(opts.to_hash))
+        Sym::App.log(*args, **opts.to_hash)
       end
 
       def error(hash)

data/lib/sym/app/cli_slop.rb

@@ -55,7 +55,7 @@ module Sym
           o.separator 'Create a new private key:'.yellow
           o.bool      '-g', '--generate',           '           generate a new private key'
           o.bool      '-p', '--password',           '           encrypt the key with a password'
-          if Sym::App.is_osx?
+          if Sym::App.osx?
             o.string '-x', '--keychain',            '[key-name] '.blue + 'write the key to OS-X Keychain'
           end
 

data/lib/sym/app/commands.rb

@@ -37,7 +37,7 @@ module Sym
         # Sort commands based on the #dependencies array, which itself is sorted
         # based on command dependencies.
         def sorted_commands
-          @sorted_commands ||= self.commands.to_a.sort_by{|klass| dependencies.index(klass.short_name) }
+          @sorted_commands ||= self.commands.to_a.sort_by{ |klass| dependencies.index(klass.short_name) }
           @sorted_commands
         end
 

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

@@ -73,7 +73,7 @@ module Sym
         end
 
         def add_to_keychain_if_needed(key)
-          if opts[:keychain] && Sym::App.is_osx?
+          if opts[:keychain] && Sym::App.osx?
             Sym::App::KeyChain.new(opts[:keychain], opts).add(key)
           else
             key

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

@@ -15,7 +15,7 @@ module Sym
           file = opts[:bash_support]
 
           out = ''
-          Sym::Constants::Bash::Config.each_pair do |key, config|
+          Sym::Constants::Bash::CONFIG.each_pair do |key, config|
             script_name = key.to_s
 
             # This removes the old version of this file.
@@ -43,7 +43,7 @@ module Sym
           out << "\nPlease reload your terminal session to activate bash completion\n"
           out << "and other installed BASH utilities.\n"
           out << "\nAlternatively, just type #{"source #{file}".bold.green} to reload BASH.\n"
-          out << "Also — go ahead and try running #{"sym -h".bold.blue} and #{"symit -h".bold.blue}.\n"
+          out << "Also — go ahead and try running #{'sym -h'.bold.blue} and #{'symit -h'.bold.blue}.\n"
         end
 
         private

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

@@ -48,7 +48,7 @@ module Sym
         end
 
         def timestamp
-          @timestamp ||= Time.now.to_a.select { |d| d.is_a?(Fixnum) }.map { |d| '%02d' % d }[0..-3].reverse.join
+          @timestamp ||= Time.now.to_a.select { |d| d.is_a?(Integer) }.map { |d| '%02d' % d }[0..-3].reverse.join
         end
 
         def process(code)

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

@@ -16,10 +16,10 @@ module Sym
           the_key = self.key
 
           if opts[:password]
-             encrypted_key, password = encrypt_with_password(the_key)
-             add_password_to_the_cache(encrypted_key, password)
-             the_key = encrypted_key
-           end
+            encrypted_key, password = encrypt_with_password(the_key)
+            add_password_to_the_cache(encrypted_key, password)
+            the_key = encrypted_key
+          end
 
           add_to_keychain_if_needed(the_key)
 

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

@@ -56,7 +56,7 @@ Diff:
 # (c) 2016 Konstantin Gredeskoul.  All rights reserved.'.green.bold)
 
 
-          if Sym::App.is_osx?
+          if Sym::App.osx?
           output << example(comment: 'generate a new password-encrypted key, save it to your Keychain:',
                             command: 'sym -gpcx staging.key')
 

data/lib/sym/app/keychain.rb

@@ -39,11 +39,13 @@ module Sym
         self.key_name = key_name
         self.opts     = opts
         self.class.validate!
-        stderr_off
+        opts[:trace] ? stderr_on : stderr_off
       end
 
       def add(password)
-        execute command(:add, "-U -w '#{password}' ")
+        delete rescue nil
+        sleep 0.1
+        execute command(:add, " -T /usr/bin/security -w '#{password}' ")
       end
 
       def find
@@ -56,10 +58,14 @@ module Sym
 
       def execute(command)
         command += ' 2>/dev/null' if stderr_disabled
-        puts "> #{command.yellow.green}" if opts[:verbose]
+        puts "> #{command.yellow}" if opts[:verbose]
         output = `#{command}`
         result = $?
-        raise Sym::Errors::KeyChainCommandError.new("Command error: #{result}, command: #{command}") unless result.success?
+        unless result.success?
+          warn "> ERROR running command:\n>   $ #{output.red}" if !stderr_disabled && opts[:verbose]
+          raise Sym::Errors::KeyChainCommandError.new("Command error: #{result}, command: #{command}")
+        end
+
         output.chomp
       rescue Errno::ENOENT => e
         raise Sym::Errors::KeyChainCommandError.new("Command error: #{e.message}, command: #{command}")
@@ -80,16 +86,16 @@ module Sym
         out << extras if extras
         out = out.join
         # Do not actually ever run these commands on non MacOSX
-        out = "echo Run this –\"#{out}\", on #{Sym::App.this_os}?\nAre you sure?" unless Sym::App.is_osx?
+        out = "echo Run this –\"#{out}\", on #{Sym::App.this_os}?\nAre you sure?" unless Sym::App.osx?
         out
       end
 
       def base_command(action)
         [
-          "security #{action}-#{self.class.sub_section} ",
-          "-a '#{self.class.user}' ",
-          "-D '#{self.class.kind}' ",
-          "-s '#{self.key_name}' "
+          "/usr/bin/security #{action}-#{self.class.sub_section} ",
+          "-a #{self.class.user} ",
+          "-D #{self.class.kind} ",
+          "-s #{self.key_name} "
         ]
       end
     end

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

@@ -7,7 +7,8 @@ module Sym
         required_option :quiet
 
         def output_proc
-          ->(*) { ; }
+          ->(*) do
+          end
         end
       end
     end

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

@@ -36,7 +36,7 @@ module Sym
           self.enabled = opts[:enabled]
           self.verbose = opts[:verbose]
           self.timeout = opts[:timeout] || ::Sym::Configuration.config.password_cache_timeout
-          self.provider = Providers.provider(opts[:provider], opts[:provider_opts] || {})
+          self.provider = Providers.provider(opts[:provider], **(opts[:provider_opts] || {}))
           self.enabled = false unless self.provider
           self
         end

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

@@ -15,7 +15,7 @@ module Sym
             self.providers << provider_class
           end
 
-          # Detect first instance that is "alive?" and return it.
+          # Detect first instance tht is "alive?" and return it.
           def detect
             self.detected ||= self.providers.inject(nil) do |instance, provider_class|
               instance || (p = provider_class.new; p.alive? ? p : nil)
@@ -38,7 +38,7 @@ module Sym
 
           def provider_from_argument(p, **opts, &block)
             case p
-              when String, Symbol
+            when String, Symbol
                 provider_class_name = "#{p.to_s.capitalize}Provider"
                 Sym::App::Password::Providers.const_defined?(provider_class_name) ?
                   Sym::App::Password::Providers.const_get(provider_class_name).new(**opts, &block) :
@@ -53,4 +53,3 @@ end
 
 # Order is important — they are tried in this order for auto detect
 require 'sym/app/password/providers/memcached_provider'
-require 'sym/app/password/providers/drb_provider'

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

@@ -31,10 +31,10 @@ module Sym
             rescue ::OpenSSL::Cipher::CipherError => e
               input_handler.puts 'Invalid password. Please try again.'
 
-              if ((retries += 1) < 3)
+              if (retries += 1) < 3
                 retry
               else
-                raise(Sym::Errors::InvalidPasswordProvidedForThePrivateKey.new('Invalid password.'))
+                raise(Sym::Errors::WrongPasswordForKey.new('Invalid password.'))
               end
             end
           else

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

@@ -23,11 +23,10 @@ module Sym
         # procs on a given string.
         def read!
           KeySourceCheck::CHECKS.each do |source_check|
-            if result = source_check.detect(self) rescue nil
-              if key_ = normalize_key(result.key)
-                key_source_ = result.to_s
-                return key_, key_source_
-              end
+            next unless result = source_check.detect(self) rescue nil
+            if key_ = normalize_key(result.key)
+              key_source_ = result.to_s
+              return key_, key_source_
             end
           end
           nil
@@ -51,8 +50,6 @@ module Sym
             rescue
               nil
             end
-          else
-            nil
           end
         end
       end

data/lib/sym/application.rb

@@ -32,7 +32,6 @@ module Sym
                   :stdin, :stdout, :stderr, :kernel
 
     def initialize(opts, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = nil)
-
       self.stdin  = stdin
       self.stdout = stdout
       self.stderr = stderr
@@ -115,12 +114,8 @@ module Sym
     end
 
     def process_output(result)
-      unless result.is_a?(Hash)
-        self.output.call(result)
-        result
-      else
-        result
-      end
+      self.output.call(result) unless result.is_a?(Hash)
+      result
     end
 
     private
@@ -182,7 +177,7 @@ module Sym
       args[:verbose]  = opts[:verbose]
       args[:provider] = opts[:cache_provider] if opts[:cache_provider]
 
-      self.password_cache = Sym::App::Password::Cache.instance.configure(args)
+      self.password_cache = Sym::App::Password::Cache.instance.configure(**args)
     end
 
     def process_edit_option
@@ -207,7 +202,7 @@ module Sym
     end
 
     def initialize_action
-      self.action = if opts[:encrypt] then
+      self.action = if opts[:encrypt]
                       :encr
                     elsif opts[:decrypt]
                       :decr
@@ -217,7 +212,7 @@ module Sym
     # If we are encrypting or decrypting, and no data has been provided, check if we
     # should read from STDIN
     def initialize_data_source
-      if self.action && opts[:string].nil? && opts[:file].nil? && !(self.stdin.tty?)
+      if self.action && opts[:string].nil? && opts[:file].nil? && !self.stdin.tty?
         opts[:file] = '-'
       end
     end

data/lib/sym/constants.rb

@@ -5,12 +5,12 @@ module Sym
 
       BASH_FILES = Dir.glob("#{File.expand_path('../../../bin', __FILE__)}/sym.*.bash").freeze
 
-      Config = {}
+      CONFIG = {}
 
       class << self
         def register_bash_files!
           BASH_FILES.each do |bash_file|
-            register_bash_extension bash_file, Config
+            register_bash_extension bash_file, CONFIG
           end
         end
 
@@ -21,7 +21,7 @@ module Sym
           home_file   = "#{Dir.home}/.#{source_file}"
 
           hash[source_file.gsub(/sym\./, '').gsub(/\.bash/, '').to_sym] = {
-              dest:   home_file,
+            dest:   home_file,
               source: bash_file,
               script: "[[ -f #{home_file} ]] && source #{home_file}"
           }
@@ -37,7 +37,7 @@ module Sym
     end
 
     ENV_ARGS_VARIABLE_NAME = 'SYM_ARGS'.freeze
-    SYM_KEY_FILE           = "#{ENV['HOME']}/.sym.key"
+    SYM_KEY_FILE           = "#{Dir.home}/.sym.key".freeze
 
   end
 end