Linter fixes and changelog (#28)

anakinj · web-flow · commit 09bad6cb527c · 2025-02-16T10:22:08.000+02:00
* Linter fixes and changelog

* Extend metadata

* fix gemspec

* Reference this pr
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -1,17 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-15 17:10:47 UTC using RuboCop version 1.72.1.
+# on 2025-02-16 07:54:09 UTC using RuboCop version 1.72.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Lint/AmbiguousOperatorPrecedence:
-  Exclude:
-    - 'spec/jwe/alg_spec.rb'
-
 # Offense count: 6
 Lint/DuplicateMethods:
   Exclude:
@@ -45,13 +39,6 @@ Style/ExpandPathArguments:
   Exclude:
     - 'jwe.gemspec'
 
-# Offense count: 34
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 Style/IfUnlessModifier:
@@ -64,19 +51,3 @@ Style/IfUnlessModifier:
 Style/PerlBackrefs:
   Exclude:
     - 'lib/jwe.rb'
-
-# Offense count: 8
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: Mode.
-Style/StringConcatenation:
-  Exclude:
-    - 'spec/jwe/alg_spec.rb'
-    - 'spec/jwe_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: WordRegex.
-# SupportedStyles: percent, brackets
-Style/WordArray:
-  EnforcedStyle: percent
-  MinSize: 7
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,14 @@
+# Changelog
+
+## [v1.0.0](https://github.com/jwt/ruby-jwe/tree/v1.0.0) (NEXT)
+
+[Full Changelog](https://github.com/jwt/ruby-jwe/compare/v0.4.0...master)
+
+**Features:**
+
+- Support Ruby 3.4 (#26)(https://github.com/jwt/ruby-jwe/pull/26)
+- Drop support for Ruby versions prior to 2.5 (#27)(https://github.com/jwt/ruby-jwe/pull/27)
+
+**Fixes and enhancements:**
+
+- Refreshed codebase (CI and linter fixes) (#27)(https://github.com/jwt/ruby-jwe/pull/27), (#28)(https://github.com/jwt/ruby-jwe/pull/28)
diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # JWE
 
 [![Build Status](https://github.com/jwt/ruby-jwe/workflows/test/badge.svg?branch=master)](https://github.com/jwt/ruby-jwe/actions)
+[![Gem Version](https://badge.fury.io/rb/jwe.svg)](https://badge.fury.io/rb/jwe)
+
 A ruby implementation of the [RFC 7516 JSON Web Encryption (JWE)](https://tools.ietf.org/html/rfc7516) standard.
 
 ## Installing
diff --git a/Rakefile b/Rakefile
@@ -1,7 +1,9 @@
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-  task default: :spec
-rescue LoadError
-  puts 'Where is RSpec?'
-end
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
diff --git a/jwe.gemspec b/jwe.gemspec
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib/', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jwe/version'
@@ -9,14 +11,19 @@ Gem::Specification.new do |s|
   s.description = 'A Ruby implementation of the RFC 7516 JSON Web Encryption (JWE) standard'
   s.authors     = ['Francesco Boffa']
   s.email       = 'fra.boffa@gmail.com'
-  s.homepage    = 'http://github.com/aomega08/jwe'
+  s.homepage    = 'https://github.com/jwt/ruby-jwe'
   s.license     = 'MIT'
 
   s.files = `git ls-files`.split("\n")
   s.require_paths = %w[lib]
 
   s.required_ruby_version = '>= 2.5.0'
-  s.metadata['rubygems_mfa_required'] = 'true'
+
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/jwt/ruby-jwe/issues',
+    'changelog_uri' => "https://github.com/jwt/ruby-jwe/blob/v#{JWE::VERSION}/CHANGELOG.md",
+    'rubygems_mfa_required' => 'true'
+  }
 
   s.add_dependency 'base64'
 end
diff --git a/lib/jwe.rb b/lib/jwe.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 require 'json'
 require 'openssl'
@@ -17,7 +19,7 @@ class BadCEK < RuntimeError; end
   class InvalidData < RuntimeError; end
 
   VALID_ALG = ['RSA1_5', 'RSA-OAEP', 'RSA-OAEP-256', 'A128KW', 'A192KW', 'A256KW', 'dir', 'ECDH-ES', 'ECDH-ES+A128KW', 'ECDH-ES+A192KW', 'ECDH-ES+A256KW', 'A128GCMKW', 'A192GCMKW', 'A256GCMKW', 'PBES2-HS256+A128KW', 'PBES2-HS384+A192KW', 'PBES2-HS512+A256KW'].freeze
-  VALID_ENC = ['A128CBC-HS256', 'A192CBC-HS384', 'A256CBC-HS512', 'A128GCM', 'A192GCM', 'A256GCM'].freeze
+  VALID_ENC = %w[A128CBC-HS256 A192CBC-HS384 A256CBC-HS512 A128GCM A192GCM A256GCM].freeze
   VALID_ZIP = ['DEF'].freeze
 
   class << self
diff --git a/lib/jwe/alg.rb b/lib/jwe/alg.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/alg/a128_kw'
 require 'jwe/alg/a192_kw'
 require 'jwe/alg/a256_kw'
diff --git a/lib/jwe/alg/a128_kw.rb b/lib/jwe/alg/a128_kw.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/alg/aes_kw'
 
 module JWE
diff --git a/lib/jwe/alg/a192_kw.rb b/lib/jwe/alg/a192_kw.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/alg/aes_kw'
 
 module JWE
diff --git a/lib/jwe/alg/a256_kw.rb b/lib/jwe/alg/a256_kw.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/alg/aes_kw'
 
 module JWE
diff --git a/lib/jwe/alg/dir.rb b/lib/jwe/alg/dir.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JWE
   module Alg
     # Direct (no-op) key encryption algorithm.
diff --git a/lib/jwe/alg/rsa15.rb b/lib/jwe/alg/rsa15.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JWE
   module Alg
     # RSA RSA with PKCS1 v1.5 algorithm.
diff --git a/lib/jwe/alg/rsa_oaep.rb b/lib/jwe/alg/rsa_oaep.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JWE
   module Alg
     # RSA-OAEP key encryption algorithm.
diff --git a/lib/jwe/base64.rb b/lib/jwe/base64.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JWE
   # Base64 for JWE is slightly different from what ruby provides.
   module Base64
diff --git a/lib/jwe/enc.rb b/lib/jwe/enc.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/a128cbc_hs256'
 require 'jwe/enc/a192cbc_hs384'
 require 'jwe/enc/a256cbc_hs512'
diff --git a/lib/jwe/enc/a128cbc_hs256.rb b/lib/jwe/enc/a128cbc_hs256.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/aes_cbc_hs'
 
 module JWE
diff --git a/lib/jwe/enc/a128gcm.rb b/lib/jwe/enc/a128gcm.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/aes_gcm'
 
 module JWE
diff --git a/lib/jwe/enc/a192cbc_hs384.rb b/lib/jwe/enc/a192cbc_hs384.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/aes_cbc_hs'
 
 module JWE
diff --git a/lib/jwe/enc/a192gcm.rb b/lib/jwe/enc/a192gcm.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/aes_gcm'
 
 module JWE
diff --git a/lib/jwe/enc/a256cbc_hs512.rb b/lib/jwe/enc/a256cbc_hs512.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/aes_cbc_hs'
 
 module JWE
diff --git a/lib/jwe/enc/a256gcm.rb b/lib/jwe/enc/a256gcm.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/aes_gcm'
 
 module JWE
diff --git a/lib/jwe/enc/aes_cbc_hs.rb b/lib/jwe/enc/aes_cbc_hs.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/cipher'
 
 module JWE
diff --git a/lib/jwe/enc/aes_gcm.rb b/lib/jwe/enc/aes_gcm.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/cipher'
 
 module JWE
diff --git a/lib/jwe/enc/cipher.rb b/lib/jwe/enc/cipher.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JWE
   module Enc
     # Helper to get OpenSSL cipher instance from a string.
diff --git a/lib/jwe/serialization/compact.rb b/lib/jwe/serialization/compact.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JWE
   # Serialization namespace.
   module Serialization
diff --git a/lib/jwe/version.rb b/lib/jwe/version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JWE
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.0'
 end
diff --git a/lib/jwe/zip.rb b/lib/jwe/zip.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/zip/def'
 
 module JWE
diff --git a/lib/jwe/zip/def.rb b/lib/jwe/zip/def.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zlib'
 
 module JWE
diff --git a/spec/jwe/alg_spec.rb b/spec/jwe/alg_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/alg/dir'
 require 'jwe/alg/rsa_oaep'
 require 'jwe/alg/rsa15'
@@ -35,7 +37,7 @@
   end
 end
 
-key_path = File.dirname(__FILE__) + '/../keys/rsa.pem'
+key_path = "#{File.dirname(__FILE__)}/../keys/rsa.pem"
 key = OpenSSL::PKey::RSA.new File.read(key_path)
 
 describe JWE::Alg::RsaOaep do
@@ -74,7 +76,7 @@
   JWE::Alg::A256kw
 ].each_with_index do |klass, i|
   describe klass do
-    let(:kek) { SecureRandom.random_bytes(16 + i * 8) }
+    let(:kek) { SecureRandom.random_bytes(16 + (i * 8)) }
     let(:cek) { SecureRandom.random_bytes(32) }
     let(:alg) { klass.new(kek) }
 
diff --git a/spec/jwe/base64_spec.rb b/spec/jwe/base64_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/base64'
 
 module JWE
diff --git a/spec/jwe/enc_spec.rb b/spec/jwe/enc_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/enc/a128cbc_hs256'
 require 'jwe/enc/a192cbc_hs384'
 require 'jwe/enc/a256cbc_hs512'
@@ -21,48 +23,48 @@
   {
     class: JWE::Enc::A128gcm,
     keylen: 16,
-    helloworld: "\"\xC6\xE4h\x8AI\x83\x90v\xAF\xE2\x11".force_encoding('BINARY'),
-    tag: "\x85|\xF7\xE1\x94\tVG\x84\xE1\xA8\x81\a\xF4\xC60".force_encoding('BINARY'),
+    helloworld: "\"\xC6\xE4h\x8AI\x83\x90v\xAF\xE2\x11".b,
+    tag: "\x85|\xF7\xE1\x94\tVG\x84\xE1\xA8\x81\a\xF4\xC60".b,
     ivlen: 12,
     iv: "\x0" * 12
   },
   {
     class: JWE::Enc::A192gcm,
     keylen: 24,
-    helloworld: "\x9F\xA4\xEC\xCCa\x86\tRO\xD7\xE3\x8D".force_encoding('BINARY'),
-    tag: "\xF6\xC0\xB8\x91A\xB1\xF0}\xD4u\xD0_\xCD\xA7\x17'".force_encoding('BINARY'),
+    helloworld: "\x9F\xA4\xEC\xCCa\x86\tRO\xD7\xE3\x8D".b,
+    tag: "\xF6\xC0\xB8\x91A\xB1\xF0}\xD4u\xD0_\xCD\xA7\x17'".b,
     ivlen: 12,
     iv: "\x0" * 12
   },
   {
     class: JWE::Enc::A256gcm,
     keylen: 32,
-    helloworld: "\xFDq\xDC\xDD\x87\x9DK\x97\x03G\x99\f".force_encoding('BINARY'),
-    tag: "\xC6\xF1\r\xDD\x14\x7Fqf,6\x0EK\x7F\x9D\x1D\t".force_encoding('BINARY'),
+    helloworld: "\xFDq\xDC\xDD\x87\x9DK\x97\x03G\x99\f".b,
+    tag: "\xC6\xF1\r\xDD\x14\x7Fqf,6\x0EK\x7F\x9D\x1D\t".b,
     ivlen: 12,
     iv: "\x0" * 12
   },
   {
     class: JWE::Enc::A128cbcHs256,
     keylen: 32,
-    helloworld: "\a\x02F\xA4m%\xDFH\xB4\xA4.\xBF:\xBF$\xE2".force_encoding('BINARY'),
-    tag: "\xDE$t\xBA\x8B\xEE\u001Df\x81\a\xC1\xBB\x98\xDFl\xF2".force_encoding('BINARY'),
+    helloworld: "\a\x02F\xA4m%\xDFH\xB4\xA4.\xBF:\xBF$\xE2".b,
+    tag: "\xDE$t\xBA\x8B\xEE\u001Df\x81\a\xC1\xBB\x98\xDFl\xF2".b,
     ivlen: 16,
     iv: "\x0" * 16
   },
   {
     class: JWE::Enc::A192cbcHs384,
     keylen: 48,
-    helloworld: "p\xFES\xF0\xB4\xCC]8\x1D\xDE\x8Dt\xE7tMh".force_encoding('BINARY'),
-    tag: "\xA8a\x04kRJ\x06`tp6\x8E\x9Ba\xE1e\xF6\xDA\"\x15\xEBk\xFDm".force_encoding('BINARY'),
+    helloworld: "p\xFES\xF0\xB4\xCC]8\x1D\xDE\x8Dt\xE7tMh".b,
+    tag: "\xA8a\x04kRJ\x06`tp6\x8E\x9Ba\xE1e\xF6\xDA\"\x15\xEBk\xFDm".b,
     ivlen: 16,
     iv: "\x0" * 16
   },
   {
     class: JWE::Enc::A256cbcHs512,
     keylen: 64,
-    helloworld: "c\xFD\\\xB9Z\xB6\xE3\xB7\xEE\xA1\xD8\xDF\xB5\xB2\xF8\xEB".force_encoding('BINARY'),
-    tag: "wC\xE3:\x91\x89W\x97\xBE\xB0\xBD\xEAo\xC66\x9F\xB82\xFDn\xA7.\u0014l\xFC2\xD7\xDFq\xB5[\xC6".force_encoding('BINARY'),
+    helloworld: "c\xFD\\\xB9Z\xB6\xE3\xB7\xEE\xA1\xD8\xDF\xB5\xB2\xF8\xEB".b,
+    tag: "wC\xE3:\x91\x89W\x97\xBE\xB0\xBD\xEAo\xC66\x9F\xB82\xFDn\xA7.\u0014l\xFC2\xD7\xDFq\xB5[\xC6".b,
     ivlen: 16,
     iv: "\x0" * 16
   }
@@ -85,7 +87,7 @@
       context 'with a valid key' do
         it 'returns the encrypted payload' do
           enc = klass.new(key, group[:iv])
-          expect(enc.encrypt(plaintext, '').force_encoding('BINARY')).to eq group[:helloworld]
+          expect(enc.encrypt(plaintext, '').b).to eq group[:helloworld]
         end
 
         it 'sets an authentication tag' do
diff --git a/spec/jwe/serialization_spec.rb b/spec/jwe/serialization_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe JWE::Serialization::Compact do
   describe '#encode' do
     it 'returns components base64ed and joined with a dot' do
diff --git a/spec/jwe/zip_spec.rb b/spec/jwe/zip_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jwe/zip/def'
 
 describe JWE::Zip do
diff --git a/spec/jwe_spec.rb b/spec/jwe_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`source 'https://rubygems.org'`
`2`	`4`
`3`	`5`	`gemspec`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'jwe/alg/a128_kw'`
`2`	`4`	`require 'jwe/alg/a192_kw'`
`3`	`5`	`require 'jwe/alg/a256_kw'`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'jwe/alg/aes_kw'`
`2`	`4`
`3`	`5`	`module JWE`