Deprecate rbnacl-libsodium

See RubyCrypto/rbnacl-libsodium#29

.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.2
   DisplayCopNames: true
   Exclude:
     - 'vendor/**/*'
@@ -31,6 +31,13 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Max: 15
 
+#
+# Naming
+#
+
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
 #
 # Performance
 #
@@ -42,11 +49,14 @@ Performance/UnfreezeString:
 # Style
 #
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+Style/AccessModifierDeclarations:
+  Enabled: false
 
 Style/GlobalVars:
   Enabled: false
 
 Style/SafeNavigation:
   Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

.travis.yml

@@ -2,21 +2,20 @@ language: ruby
 cache: bundler
 
 before_install:
+  - sudo add-apt-repository -y ppa:chris-lea/libsodium
+  - sudo apt-get update -q
+  - sudo apt-get install libsodium-dev
   - gem update --system
   - gem --version
-  - gem install bundler -v 1.16.1
+  - gem install bundler -v 1.17.1
   - bundle --version
 
 rvm:
   - jruby-9.1.15.0
   - 2.2
   - 2.3
-  - 2.4.3
-  - 2.5.0
-
-env:
-  - LIBSODIUM_VERSION=1.0.0  # Minimum supported
-  - LIBSODIUM_VERSION=1.0.16 # Latest released
+  - 2.4
+  - 2.5
 
 matrix:
   fast_finish: true

Gemfile

@@ -10,9 +10,8 @@ end
 
 group :test do
   gem "coveralls", require: false
-  gem "rbnacl-libsodium", ENV["LIBSODIUM_VERSION"]
   gem "rspec"
-  gem "rubocop", "0.51.0"
+  gem "rubocop", "0.56.0"
 end
 
 group :development, :test do

README.md

@@ -101,9 +101,6 @@ Note: [Windows installation instructions are available](https://github.com/crypt
 
 ### libsodium
 
-**NOTE: Want to avoid the hassle of installing libsodium? Use the
-[rbnacl-libsodium](https://github.com/crypto-rb/rbnacl-libsodium) gem**
-
 To use RbNaCl, you will need to install libsodium:
 
 https://github.com/jedisct1/libsodium

Rakefile

@@ -2,7 +2,7 @@
 
 require "bundler/gem_tasks"
 
-Dir[File.expand_path("../tasks/**/*.rake", __FILE__)].each { |task| load task }
+Dir[File.expand_path("tasks/**/*.rake", __dir__)].each { |task| load task }
 
 task default: %w[spec rubocop]
 task ci:      %w[spec rubocop]

lib/rbnacl.rb

@@ -1,6 +1,12 @@
 # encoding: binary
 # frozen_string_literal: true
 
+if defined?(RBNACL_LIBSODIUM_GEM_LIB_PATH)
+  raise "rbnacl-libsodium is not supported by rbnacl 6.0+. "\
+        "Please remove it as a dependency and install libsodium using your system package manager. "\
+        "See https://github.com/crypto-rb/rbnacl#installation"
+end
+
 require "rbnacl/version"
 require "rbnacl/sodium"
 require "rbnacl/sodium/version"
@@ -69,9 +75,7 @@ class BadAuthenticatorError < CryptoError; end
   # Password hash functions
   require "rbnacl/password_hash"
   require "rbnacl/password_hash/scrypt"
-  if RbNaCl::Sodium::Version::ARGON2_SUPPORTED
-    require "rbnacl/password_hash/argon2"
-  end
+  require "rbnacl/password_hash/argon2" if RbNaCl::Sodium::Version::ARGON2_SUPPORTED
 
   # HMAC: SHA256/512 and SHA512256
   require "rbnacl/hmac/sha256"

lib/rbnacl/boxes/curve25519xsalsa20poly1305.rb

@@ -180,7 +180,7 @@ def nonce_bytes
       private
 
       def beforenm
-        @_key ||= begin
+        @beforenm ||= begin
           key = Util.zeros(BEFORENMBYTES)
           success = self.class.box_curve25519xsalsa20poly1305_beforenm(key, @public_key.to_s, @private_key.to_s)
           raise CryptoError, "Failed to derive shared key" unless success

lib/rbnacl/init.rb

@@ -5,11 +5,7 @@ module RbNaCl
   # Defines the libsodium init function
   module Init
     extend FFI::Library
-    if defined?(RBNACL_LIBSODIUM_GEM_LIB_PATH)
-      ffi_lib RBNACL_LIBSODIUM_GEM_LIB_PATH
-    else
-      ffi_lib "sodium"
-    end
+    ffi_lib "sodium"
 
     attach_function :sodium_init, [], :int
   end

lib/rbnacl/sodium.rb

@@ -8,11 +8,7 @@ module RbNaCl
   module Sodium
     def self.extended(klass)
       klass.extend FFI::Library
-      if defined?(RBNACL_LIBSODIUM_GEM_LIB_PATH)
-        klass.ffi_lib RBNACL_LIBSODIUM_GEM_LIB_PATH
-      else
-        klass.ffi_lib "sodium"
-      end
+      klass.ffi_lib "sodium"
     end
 
     def sodium_type(type = nil)

lib/rbnacl/test_vectors.rb

@@ -243,3 +243,4 @@ module RbNaCl
                                                 "a7ea"
   }.freeze
 end
+# rubocop:enable Metrics/ModuleLength

lib/rbnacl/util.rb

@@ -160,9 +160,7 @@ def check_hmac_key(string, _description)
     #
     # @param string [#to_str] The input string
     def check_string_validation(string)
-      unless string.respond_to? :to_str
-        raise TypeError, "can't convert #{string.class} into String with #to_str"
-      end
+      raise TypeError, "can't convert #{string.class} into String with #to_str" unless string.respond_to? :to_str
 
       string = string.to_str
 
@@ -274,7 +272,7 @@ def verify16!(one, two)
     #
     # @return [String] Tasty, tasty hexadecimal
     def bin2hex(bytes)
-      bytes.to_s.unpack("H*").first
+      bytes.to_s.unpack1("H*")
     end
 
     # Hex decodes a message

lib/rbnacl/version.rb

@@ -4,5 +4,5 @@
 # NaCl/libsodium for Ruby
 module RbNaCl
   # The library's version
-  VERSION = "5.0.0"
+  VERSION = "6.0.0.pre".freeze
 end

rbnacl.gemspec

@@ -1,7 +1,6 @@
-
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "rbnacl/version"
 
@@ -23,7 +22,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.2.6"
-  spec.platform = "jruby" if defined? JRUBY_VERSION
 
   spec.add_runtime_dependency "ffi"
 

spec/shared/hmac.rb

@@ -27,7 +27,7 @@
 
     context "#update" do
       it "returns hexdigest when produces an authenticator" do
-        expect(authenticator.update(message)).to eq mult_tag.unpack("H*").first
+        expect(authenticator.update(message)).to eq mult_tag.unpack1("H*")
       end
     end
 
@@ -39,7 +39,7 @@
 
     context "#hexdigest" do
       it "returns hex authenticator" do
-        expect(authenticator.hexdigest).to eq tag.unpack("H*").first
+        expect(authenticator.hexdigest).to eq tag.unpack1("H*")
       end
     end
   end